BlocksByRegion::resolveValues() - Code Metrics - Inspection of "Adding buffer for sub requests." - drupal-graphql/graphql - Measure and Improve Code Quality continuously with Scrutinizer

Completed

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

by Sebastian

created 2018-01-24 13:34 UTC

BlocksByRegion::resolveValues() B

↳ Parent: BlocksByRegion

Complexity

Conditions	5
Paths	2

Size

Total Lines	38
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	24
nc	2
nop	3
dl	0
loc	38
rs	8.439
c	0
b	0
f	0

<?php

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

use Drupal\block\Entity\Block;
use Drupal\block_content\Plugin\Block\BlockContentBlock;
use Drupal\Core\Condition\ConditionInterface;
use Drupal\Core\Entity\EntityRepositoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Theme\ThemeManagerInterface;
use Drupal\Core\Url;
use Drupal\graphql\GraphQL\Buffers\SubRequestBuffer;
use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Youshido\GraphQL\Execution\ResolveInfo;

/**
 * List all blocks within a theme region.
 *
 * TODO: Move this to `InternalUrl` (breaking change).
 *
 * @GraphQLField(
 *   id = "blocks_by_region",
 *   secure = true,
 *   name = "blocksByRegion",
 *   type = "Entity",
 *   parents = {"Url", "Root"},
 *   multi = true,
 *   arguments = {
 *     "region" = "String"
 *   }
 * )
 */
class BlocksByRegion extends FieldPluginBase implements ContainerFactoryPluginInterface {


  /**
   * The theme manager.
   *
   * @var \Drupal\Core\Theme\ThemeManagerInterface
   */
  protected $themeManager;

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

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

  /**
   * The subrequest buffer service.
   *
   * @var \Drupal\graphql\GraphQL\Buffers\SubRequestBuffer
   */
  protected $subRequestBuffer;

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

  /**
   * {@inheritdoc}
   */
  public function __construct(
    array $configuration,
    $pluginId,
    $pluginDefinition,
    SubRequestBuffer $subRequestBuffer,
    ThemeManagerInterface $themeManager,
    EntityTypeManagerInterface $entityTypeManager,
    EntityRepositoryInterface $entityRepository
  ) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->subRequestBuffer = $subRequestBuffer;
    $this->themeManager = $themeManager;
    $this->entityTypeManager = $entityTypeManager;
    $this->entityRepository = $entityRepository;
  }

  /**
   * {@inheritdoc}
   */
  protected function resolveValues($value, array $args, ResolveInfo $info) {
    if ($value instanceof Url) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
      $activeTheme = $this->themeManager->getActiveTheme();
      $blockStorage = $this->entityTypeManager->getStorage('block');
      $blocks = $blockStorage->loadByProperties([
        'theme' => $activeTheme->getName(),
        'region' => $args['region'],
      ]);

      $resolve = $this->subRequestBuffer->add($value, function () use ($blocks) {
        $blocks = array_filter($blocks, function (Block $block) {
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)
          return array_reduce(iterator_to_array($block->getVisibilityConditions()), function($value, ConditionInterface $condition) {
            return $value && (!$condition->isNegated() == $condition->evaluate());
          }, TRUE);
        });

        uasort($blocks, '\Drupal\Block\Entity\Block::sort');

        return $blocks;
      });

      return function ($value, array $args, ResolveInfo $info) use ($resolve) {
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());
}
        $blocks = array_map(function(Block $block) {
          $plugin = $block->getPlugin();
          if ($plugin instanceof BlockContentBlock) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $this->entityRepository->loadEntityByUuid('block_content', $plugin->getDerivativeId());
          }
          else {
            return $block;
          }
        }, $resolve());

        foreach ($blocks as $block) {
          yield $block;
        }
      };
    }
  }
}


1			<?php
2
3			namespace Drupal\graphql_core\Plugin\GraphQL\Fields\Blocks;
4
5			use Drupal\block\Entity\Block;
6			use Drupal\block_content\Plugin\Block\BlockContentBlock;
7			use Drupal\Core\Condition\ConditionInterface;
8			use Drupal\Core\Entity\EntityRepositoryInterface;
9			use Drupal\Core\Entity\EntityTypeManagerInterface;
10			use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
11			use Drupal\Core\Theme\ThemeManagerInterface;
12			use Drupal\Core\Url;
13			use Drupal\graphql\GraphQL\Buffers\SubRequestBuffer;
14			use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
15			use Symfony\Component\DependencyInjection\ContainerInterface;
16			use Youshido\GraphQL\Execution\ResolveInfo;
17
18			/**
19			* List all blocks within a theme region.
20			*
21			* TODO: Move this to `InternalUrl` (breaking change).
22			*
23			* @GraphQLField(
24			* id = "blocks_by_region",
25			* secure = true,
26			* name = "blocksByRegion",
27			* type = "Entity",
28			* parents = {"Url", "Root"},
29			* multi = true,
30			* arguments = {
31			* "region" = "String"
32			* }
33			* )
34			*/
35			class BlocksByRegion extends FieldPluginBase implements ContainerFactoryPluginInterface {
			0 ignored issues – show Bug introduced 2018-01-24 13:40 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...
36
37			/**
38			* The theme manager.
39			*
40			* @var \Drupal\Core\Theme\ThemeManagerInterface
41			*/
42			protected $themeManager;
43
44			/**
45			* The entity type manager.
46			*
47			* @var \Drupal\Core\Entity\EntityTypeManagerInterface
48			*/
49			protected $entityTypeManager;
50
51			/**
52			* The entity repository.
53			*
54			* @var \Drupal\Core\Entity\EntityRepositoryInterface
55			*/
56			protected $entityRepository;
57
58			/**
59			* The subrequest buffer service.
60			*
61			* @var \Drupal\graphql\GraphQL\Buffers\SubRequestBuffer
62			*/
63			protected $subRequestBuffer;
64
65			/**
66			* {@inheritdoc}
67			*/
68			public static function create(
69			ContainerInterface $container,
70			array $configuration,
71			$pluginId,
72			$pluginDefinition
73			) {
74			return new static(
75			$configuration,
76			$pluginId,
77			$pluginDefinition,
78			$container->get('graphql.buffer.subrequest'),
79			$container->get('theme.manager'),
80			$container->get('entity_type.manager'),
81			$container->get('entity.repository')
82			);
83			}
84
85			/**
86			* {@inheritdoc}
87			*/
88			public function __construct(
89			array $configuration,
90			$pluginId,
91			$pluginDefinition,
92			SubRequestBuffer $subRequestBuffer,
93			ThemeManagerInterface $themeManager,
94			EntityTypeManagerInterface $entityTypeManager,
95			EntityRepositoryInterface $entityRepository
96			) {
97			parent::__construct($configuration, $pluginId, $pluginDefinition);
98			$this->subRequestBuffer = $subRequestBuffer;
99			$this->themeManager = $themeManager;
100			$this->entityTypeManager = $entityTypeManager;
101			$this->entityRepository = $entityRepository;
102			}
103
104			/**
105			* {@inheritdoc}
106			*/
107			protected function resolveValues($value, array $args, ResolveInfo $info) {
108			if ($value instanceof Url) {
			0 ignored issues – show Bug introduced 2018-01-24 13:40 UTC by Report Bug Copy Issue Report The class `Drupal\Core\Url` 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...
109			$activeTheme = $this->themeManager->getActiveTheme();
110			$blockStorage = $this->entityTypeManager->getStorage('block');
111			$blocks = $blockStorage->loadByProperties([
112			'theme' => $activeTheme->getName(),
113			'region' => $args['region'],
114			]);
115
116			$resolve = $this->subRequestBuffer->add($value, function () use ($blocks) {
117			$blocks = array_filter($blocks, function (Block $block) {
			0 ignored issues – show Bug introduced 2018-01-24 13:40 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$blocks`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
118			return array_reduce(iterator_to_array($block->getVisibilityConditions()), function($value, ConditionInterface $condition) {
119			return $value && (!$condition->isNegated() == $condition->evaluate());
120			}, TRUE);
121			});
122
123			uasort($blocks, '\Drupal\Block\Entity\Block::sort');
124
125			return $blocks;
126			});
127
128			return function ($value, array $args, ResolveInfo $info) use ($resolve) {
			0 ignored issues – show Bug Best Practice introduced 2018-01-24 13:40 UTC by Report Bug Copy Issue Report The return type of `return function ($value,...yield $block); } };` (`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... Unused Code introduced 2018-01-24 13:40 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-24 13:40 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-24 13:40 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...
129			$blocks = array_map(function(Block $block) {
130			$plugin = $block->getPlugin();
131			if ($plugin instanceof BlockContentBlock) {
			0 ignored issues – show Bug introduced 2017-10-17 14:57 UTC by Report Bug Copy Issue Report The class `Drupal\block_content\Plu...Block\BlockContentBlock` 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...
132			return $this->entityRepository->loadEntityByUuid('block_content', $plugin->getDerivativeId());
133			}
134			else {
135			return $block;
136			}
137			}, $resolve());
138
139			foreach ($blocks as $block) {
140			yield $block;
141			}
142			};
143			}
144			}
145			}
146

drupal-graphql / graphql

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

BlocksByRegion::resolveValues() B

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Change not visible in outer-scope

Change visible in outer-scope

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like