EntityQueryEntities - Code Metrics - Inspection of "Fix language handling and add language switch link..." - drupal-graphql/graphql - Measure and Improve Code Quality continuously with Scrutinizer

Completed

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

by Sebastian

created 2018-02-13 10:37 UTC

EntityQueryEntities A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	164
Duplicated Lines	17.68 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
dl	29
loc	164
rs	10
c	0
b	0
f	0
wmc	13
lcom	1
cbo	3

6 Methods

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

How to fix Duplicated Code

<?php

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

use Drupal\Core\DependencyInjection\DependencySerializationTrait;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityRepositoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\Query\QueryInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\TypedData\TranslatableInterface;
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"},
 *   arguments = {
 *     "language" = "LanguageId"
 *   }
 * )
 */
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;

  /**
   * The entity repository service.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {

    return new static(
      $configuration,
      $pluginId,
      $pluginDefinition,
      $container->get('entity_type.manager'),
      $container->get('entity.repository'),
      $container->get('graphql.buffer.entity')
    );
  }

  /**
   * EntityQueryEntities constructor.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $pluginId
   *   The plugin id.
   * @param mixed $pluginDefinition
   *   The plugin definition array.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager service.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entityRepository
   *   The entity repository service.
   * @param \Drupal\graphql\GraphQL\Buffers\EntityBuffer $entityBuffer
   *   The entity buffer service.
   */
  public function __construct(

    array $configuration,
    $pluginId,
    $pluginDefinition,
    EntityTypeManagerInterface $entityTypeManager,
    EntityRepositoryInterface $entityRepository,
    EntityBuffer $entityBuffer
  ) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->entityTypeManager = $entityTypeManager;
    $this->entityRepository = $entityRepository;
    $this->entityBuffer = $entityBuffer;
  }

  /**
   * {@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), $args, $info);
      }

      // If this is a revision query, the version ids are the array keys.
      return $this->resolveFromEntityIds($type, array_values($result), $args, $info);
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());
}
    }
  }

  /**
   * Resolves entities lazily through the entity buffer.
   *
   * @param string $type
   *   The entity type.
   * @param array $ids
   *   The entity ids to load.
   * @param array $args
   *   The field arguments array.
   * @param \Youshido\GraphQL\Execution\ResolveInfo $info
   *   The resolve info object.
   *
   * @return \Closure
   *   The deferred resolver.
   */
  protected function resolveFromEntityIds($type, $ids, array $args, ResolveInfo $info) {
    $resolve = $this->entityBuffer->add($type, $ids);
    return function($value, array $args, ResolveInfo $info) use ($resolve) {
      return $this->resolveEntities($resolve(), $args, $info);
    };
  }

  /**
   * Resolves entity revisions.
   *
   * @param string $type
   *   The entity type.
   * @param array $ids
   *   The entity revision ids to load.
   * @param array $args
   *   The field arguments array.
   * @param \Youshido\GraphQL\Execution\ResolveInfo $info
   *   The resolve info object.
   *
   * @return \Generator
   *   The resolved revisions.
   */
  protected function resolveFromRevisionIds($type, $ids, array $args, ResolveInfo $info) {
    $storage = $this->entityTypeManager->getStorage($type);
    $entities = array_map(function ($id) use ($storage) {
      return $storage->loadRevision($id);
    }, $ids);

    return $this->resolveEntities($entities, $args, $info);
  }

  /**
   * Resolves entity objects and checks view permissions.
   *
   * @param array $entities
   *   The entities to resolve.
   * @param array $args
   *   The field arguments array.
   * @param \Youshido\GraphQL\Execution\ResolveInfo $info
   *   The resolve info object.
   *
   * @return \Generator
   *   The resolved entities.
   */
  protected function resolveEntities(array $entities, array $args, ResolveInfo $info) {
    /** @var \Drupal\Core\Entity\EntityInterface $entity */
    foreach ($entities as $entity) {
      // Translate the entity if it is translatable and a language was given.
      if (!empty($args['language']) && $entity instanceof TranslatableInterface && $entity->isTranslatable()) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
        $language = $args['language'];
        $entity = $this->entityRepository->getTranslationFromContext($entity, $language);
      }

      $access = $entity->access('view', NULL, TRUE);
      if ($access->isAllowed()) {

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

}


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

EntityQueryEntities A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1		<?php
2
3		namespace Drupal\graphql_core\Plugin\GraphQL\Fields\EntityQuery;
4
5		use Drupal\Core\DependencyInjection\DependencySerializationTrait;
6		use Drupal\Core\Entity\EntityInterface;
7		use Drupal\Core\Entity\EntityRepositoryInterface;
8		use Drupal\Core\Entity\EntityTypeManagerInterface;
9		use Drupal\Core\Entity\Query\QueryInterface;
10		use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
11		use Drupal\Core\TypedData\TranslatableInterface;
12		use Drupal\graphql\GraphQL\Buffers\EntityBuffer;
13		use Drupal\graphql\GraphQL\Cache\CacheableValue;
14		use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
15		use Symfony\Component\DependencyInjection\ContainerInterface;
16		use Youshido\GraphQL\Execution\ResolveInfo;
17
18		/**
19		* Retrieve the entity result set of an entity query.
20		*
21		* @GraphQLField(
22		* id = "entity_query_entities",
23		* secure = true,
24		* name = "entities",
25		* type = "[Entity]",
26		* parents = {"EntityQueryResult"},
27		* arguments = {
28		* "language" = "LanguageId"
29		* }
30		* )
31		*/
32		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...
33		use DependencySerializationTrait;
34
35		/**
36		* The entity buffer service.
37		*
38		* @var \Drupal\graphql\GraphQL\Buffers\EntityBuffer
39		*/
40		protected $entityBuffer;
41
42		/**
43		* The entity type manager service.
44		*
45		* @var \Drupal\Core\Entity\EntityTypeManagerInterface
46		*/
47		protected $entityTypeManager;
48
49		/**
50		* The entity repository service.
51		*
52		* @var \Drupal\Core\Entity\EntityRepositoryInterface
53		*/
54		protected $entityRepository;
55
56		/**
57		* {@inheritdoc}
58		*/
59	View Code Duplication	public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
		0 ignored issues – show Duplication introduced 2017-10-17 14:57 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
60		return new static(
61		$configuration,
62		$pluginId,
63		$pluginDefinition,
64		$container->get('entity_type.manager'),
65		$container->get('entity.repository'),
66		$container->get('graphql.buffer.entity')
67		);
68		}
69
70		/**
71		* EntityQueryEntities constructor.
72		*
73		* @param array $configuration
74		* The plugin configuration array.
75		* @param string $pluginId
76		* The plugin id.
77		* @param mixed $pluginDefinition
78		* The plugin definition array.
79		* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
80		* The entity type manager service.
81		* @param \Drupal\Core\Entity\EntityRepositoryInterface $entityRepository
82		* The entity repository service.
83		* @param \Drupal\graphql\GraphQL\Buffers\EntityBuffer $entityBuffer
84		* The entity buffer service.
85		*/
86	View Code Duplication	public function __construct(
		0 ignored issues – show Duplication introduced 2018-02-13 10:41 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
87		array $configuration,
88		$pluginId,
89		$pluginDefinition,
90		EntityTypeManagerInterface $entityTypeManager,
91		EntityRepositoryInterface $entityRepository,
92		EntityBuffer $entityBuffer
93		) {
94		parent::__construct($configuration, $pluginId, $pluginDefinition);
95		$this->entityTypeManager = $entityTypeManager;
96		$this->entityRepository = $entityRepository;
97		$this->entityBuffer = $entityBuffer;
98		}
99
100		/**
101		* {@inheritdoc}
102		*/
103		public function resolveValues($value, array $args, ResolveInfo $info) {
104		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...
105		$type = $value->getEntityTypeId();
106		$result = $value->execute();
107
108		if ($value->hasTag('revisions')) {
109		return $this->resolveFromRevisionIds($type, array_keys($result), $args, $info);
110		}
111
112		// If this is a revision query, the version ids are the array keys.
113		return $this->resolveFromEntityIds($type, array_values($result), $args, $info);
		0 ignored issues – show Bug Best Practice introduced 2018-02-13 10:41 UTC by Report Bug Copy Issue Report The return type of `return $this->resolveFro...result), $args, $info);` (`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...
114		}
115		}
116
117		/**
118		* Resolves entities lazily through the entity buffer.
119		*
120		* @param string $type
121		* The entity type.
122		* @param array $ids
123		* The entity ids to load.
124		* @param array $args
125		* The field arguments array.
126		* @param \Youshido\GraphQL\Execution\ResolveInfo $info
127		* The resolve info object.
128		*
129		* @return \Closure
130		* The deferred resolver.
131		*/
132		protected function resolveFromEntityIds($type, $ids, array $args, ResolveInfo $info) {
133		$resolve = $this->entityBuffer->add($type, $ids);
134		return function($value, array $args, ResolveInfo $info) use ($resolve) {
135		return $this->resolveEntities($resolve(), $args, $info);
136		};
137		}
138
139		/**
140		* Resolves entity revisions.
141		*
142		* @param string $type
143		* The entity type.
144		* @param array $ids
145		* The entity revision ids to load.
146		* @param array $args
147		* The field arguments array.
148		* @param \Youshido\GraphQL\Execution\ResolveInfo $info
149		* The resolve info object.
150		*
151		* @return \Generator
152		* The resolved revisions.
153		*/
154		protected function resolveFromRevisionIds($type, $ids, array $args, ResolveInfo $info) {
155		$storage = $this->entityTypeManager->getStorage($type);
156		$entities = array_map(function ($id) use ($storage) {
157		return $storage->loadRevision($id);
158		}, $ids);
159
160		return $this->resolveEntities($entities, $args, $info);
161		}
162
163		/**
164		* Resolves entity objects and checks view permissions.
165		*
166		* @param array $entities
167		* The entities to resolve.
168		* @param array $args
169		* The field arguments array.
170		* @param \Youshido\GraphQL\Execution\ResolveInfo $info
171		* The resolve info object.
172		*
173		* @return \Generator
174		* The resolved entities.
175		*/
176		protected function resolveEntities(array $entities, array $args, ResolveInfo $info) {
177		/** @var \Drupal\Core\Entity\EntityInterface $entity */
178		foreach ($entities as $entity) {
179		// Translate the entity if it is translatable and a language was given.
180		if (!empty($args['language']) && $entity instanceof TranslatableInterface && $entity->isTranslatable()) {
		0 ignored issues – show Bug introduced 2018-02-13 10:41 UTC by Report Bug Copy Issue Report The class `Drupal\Core\TypedData\TranslatableInterface` 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...
181		$language = $args['language'];
182		$entity = $this->entityRepository->getTranslationFromContext($entity, $language);
183		}
184
185		$access = $entity->access('view', NULL, TRUE);
186	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...
187		yield $entity->addCacheableDependency($access);
188		}
189		else {
190		yield new CacheableValue(NULL, [$access]);
191		}
192		}
193		}
194
195		}
196

drupal-graphql / graphql

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

EntityQueryEntities A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like