EntityQueryEntities - Code Metrics - Inspection of "Allow loading of entity revisions." - drupal-graphql/graphql - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 8.x-3.x (#496)

by Sebastian

created 2018-02-09 10:34 UTC

EntityQueryEntities A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	93
Duplicated Lines	6.45 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
dl	6
loc	93
rs	10
c	0
b	0
f	0
wmc	10
lcom	1
cbo	3

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
A	create()	0	9	1
A	resolveValues()	0	13	3
A	resolveFromEntityIds()	0	6	1
A	resolveFromRevisionIds()	0	8	1
A	resolveEntities()	6	13	3

How to fix Duplicated Code

<?php

namespace Drupal\graphql_core\Plugin\GraphQL\Fields\EntityQuery;

use Drupal\Core\DependencyInjection\DependencySerializationTrait;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\Query\QueryInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\graphql\GraphQL\Buffers\EntityBuffer;
use Drupal\graphql\GraphQL\Cache\CacheableValue;
use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Youshido\GraphQL\Execution\ResolveInfo;

/**
 * Retrieve the entity result set of an entity query.
 *
 * @GraphQLField(
 *   id = "entity_query_entities",
 *   secure = true,
 *   name = "entities",
 *   type = "[Entity]",
 *   parents = {"EntityQueryResult"}
 * )
 */
class EntityQueryEntities extends FieldPluginBase implements ContainerFactoryPluginInterface {

  use DependencySerializationTrait;

  /**
   * The entity buffer service.
   *
   * @var \Drupal\graphql\GraphQL\Buffers\EntityBuffer
   */
  protected $entityBuffer;

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(
    array $configuration,
    $pluginId,
    $pluginDefinition,
    EntityTypeManagerInterface $entityTypeManager,
    EntityBuffer $entityBuffer
  ) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->entityBuffer = $entityBuffer;
    $this->entityTypeManager = $entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
    return new static(
      $configuration,
      $pluginId,
      $pluginDefinition,
      $container->get('entity_type.manager'),
      $container->get('graphql.buffer.entity')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function resolveValues($value, array $args, ResolveInfo $info) {
    if ($value instanceof QueryInterface) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
      $type = $value->getEntityTypeId();
      $result = $value->execute();

      if ($value->hasTag('revisions')) {
        return $this->resolveFromRevisionIds($type, array_keys($result));
      }

      // If this is a revision query, the version ids are the array keys.
      return $this->resolveFromEntityIds($type, array_values($result));
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
  }

  protected function resolveFromEntityIds($type, $ids) {
    $resolve = $this->entityBuffer->add($type, $ids);
    return function($value, array $args, ResolveInfo $info) use ($resolve) {

      return $this->resolveEntities($resolve());
    };
  }

  protected function resolveFromRevisionIds($type, $ids) {
    $storage = $this->entityTypeManager->getStorage($type);
    $entities = array_map(function ($id) use ($storage) {
      return $storage->loadRevision($id);
    }, $ids);

    return $this->resolveEntities($entities);
  }

  protected function resolveEntities(array $entities) {
    /** @var \Drupal\Core\Entity\EntityInterface $entity */
    foreach ($entities as $entity) {
      $access = $entity->access('view', NULL, TRUE);

      if ($access->isAllowed()) {

        yield $entity->addCacheableDependency($access);
      }
      else {
        yield new CacheableValue(NULL, [$access]);
      }
    }
  }

}


1		<?php
2
3		namespace Drupal\graphql_core\Plugin\GraphQL\Fields\EntityQuery;
4
5		use Drupal\Core\DependencyInjection\DependencySerializationTrait;
6		use Drupal\Core\Entity\EntityTypeManagerInterface;
7		use Drupal\Core\Entity\Query\QueryInterface;
8		use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
9		use Drupal\graphql\GraphQL\Buffers\EntityBuffer;
10		use Drupal\graphql\GraphQL\Cache\CacheableValue;
11		use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
12		use Symfony\Component\DependencyInjection\ContainerInterface;
13		use Youshido\GraphQL\Execution\ResolveInfo;
14
15		/**
16		* Retrieve the entity result set of an entity query.
17		*
18		* @GraphQLField(
19		* id = "entity_query_entities",
20		* secure = true,
21		* name = "entities",
22		* type = "[Entity]",
23		* parents = {"EntityQueryResult"}
24		* )
25		*/
26		class EntityQueryEntities extends FieldPluginBase implements ContainerFactoryPluginInterface {
		0 ignored issues – show Bug introduced 2018-02-04 18:20 UTC by Report Bug Copy Issue Report There is one abstract method `getPluginDefinition` in this class; you could implement it, or declare this class as abstract. Loading history...
27		use DependencySerializationTrait;
28
29		/**
30		* The entity buffer service.
31		*
32		* @var \Drupal\graphql\GraphQL\Buffers\EntityBuffer
33		*/
34		protected $entityBuffer;
35
36		/**
37		* The entity type manager service.
38		*
39		* @var \Drupal\Core\Entity\EntityTypeManagerInterface
40		*/
41		protected $entityTypeManager;
42
43		/**
44		* {@inheritdoc}
45		*/
46		public function __construct(
47		array $configuration,
48		$pluginId,
49		$pluginDefinition,
50		EntityTypeManagerInterface $entityTypeManager,
51		EntityBuffer $entityBuffer
52		) {
53		parent::__construct($configuration, $pluginId, $pluginDefinition);
54		$this->entityBuffer = $entityBuffer;
55		$this->entityTypeManager = $entityTypeManager;
56		}
57
58		/**
59		* {@inheritdoc}
60		*/
61		public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
62		return new static(
63		$configuration,
64		$pluginId,
65		$pluginDefinition,
66		$container->get('entity_type.manager'),
67		$container->get('graphql.buffer.entity')
68		);
69		}
70
71		/**
72		* {@inheritdoc}
73		*/
74		public function resolveValues($value, array $args, ResolveInfo $info) {
75		if ($value instanceof QueryInterface) {
		0 ignored issues – show Bug introduced 2017-10-17 14:57 UTC by Report Bug Copy Issue Report The class `Drupal\Core\Entity\Query\QueryInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
76		$type = $value->getEntityTypeId();
77		$result = $value->execute();
78
79		if ($value->hasTag('revisions')) {
80		return $this->resolveFromRevisionIds($type, array_keys($result));
81		}
82
83		// If this is a revision query, the version ids are the array keys.
84		return $this->resolveFromEntityIds($type, array_values($result));
		0 ignored issues – show Bug Best Practice introduced 2018-02-04 18:20 UTC by Report Bug Copy Issue Report The return type of `return $this->resolveFro...array_values($result));` (`Closure`) is incompatible with the return type of the parent method `Drupal\graphql\Plugin\Gr...uginBase::resolveValues` of type `Generator`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
85		}
86		}
87
88		protected function resolveFromEntityIds($type, $ids) {
89		$resolve = $this->entityBuffer->add($type, $ids);
90		return function($value, array $args, ResolveInfo $info) use ($resolve) {
		0 ignored issues – show Unused Code introduced 2018-01-23 14:46 UTC by Report Bug Copy Issue Report The parameter `$value` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2018-01-23 14:46 UTC by Report Bug Copy Issue Report The parameter `$args` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2018-01-23 17:24 UTC by Report Bug Copy Issue Report The parameter `$info` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
91		return $this->resolveEntities($resolve());
92		};
93		}
94
95		protected function resolveFromRevisionIds($type, $ids) {
96		$storage = $this->entityTypeManager->getStorage($type);
97		$entities = array_map(function ($id) use ($storage) {
98		return $storage->loadRevision($id);
99		}, $ids);
100
101		return $this->resolveEntities($entities);
102		}
103
104		protected function resolveEntities(array $entities) {
105		/** @var \Drupal\Core\Entity\EntityInterface $entity */
106		foreach ($entities as $entity) {
107		$access = $entity->access('view', NULL, TRUE);
108
109	View Code Duplication	if ($access->isAllowed()) {
		0 ignored issues – show Duplication introduced 2018-02-08 11:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
110		yield $entity->addCacheableDependency($access);
111		}
112		else {
113		yield new CacheableValue(NULL, [$access]);
114		}
115		}
116		}
117
118		}
119

drupal-graphql / graphql

Pull Request — 8.x-3.x (#496)

EntityQueryEntities A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like