Breadcrumbs - 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

Breadcrumbs A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
dl	0
loc	74
rs	10
c	0
b	0
f	0
wmc	5
lcom	1
cbo	2

3 Methods

Rating	Name	Size	Complexity
A	create()	10	1
A	__construct()	13	1
A	resolveValues()	15	3

<?php

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

use Drupal\Core\Breadcrumb\BreadcrumbManager;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Routing\RouteMatchInterface;
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;

/**
 * Retrieve the breadcrumbs.
 *
 * TODO: Move this to `InternalUrl` (breaking change).
 *
 * @GraphQLField(
 *   id = "breadcrumb",
 *   secure = true,
 *   name = "breadcrumb",
 *   type = "Link",
 *   multi = true,
 *   parents = {"Url"},
 * )
 */
class Breadcrumbs extends FieldPluginBase implements ContainerFactoryPluginInterface {


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

  /**
   * The breadcrumb manager service.
   *
   * @var \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface
   */
  protected $breadcrumbManager;

  /**
   * The current route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

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

  /**
   * {@inheritdoc}
   */
  public function __construct(
    array $configuration,
    $pluginId,
    $pluginDefinition,
    SubRequestBuffer $subRequestBuffer,
    BreadcrumbManager $breadcrumbManager,
    RouteMatchInterface $routeMatch
  ) {
    $this->subRequestBuffer = $subRequestBuffer;
    $this->breadcrumbManager = $breadcrumbManager;

    $this->routeMatch = $routeMatch;
    parent::__construct($configuration, $pluginId, $pluginDefinition);
  }

  /**
   * {@inheritdoc}
   */
  protected function resolveValues($value, array $args, ResolveInfo $info) {
    if ($value instanceof Url) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
      $resolve = $this->subRequestBuffer->add($value, function () {
        $links = $this->breadcrumbManager->build($this->routeMatch)->getLinks();
        return $links;
      });

      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());
}
        $links = $resolve();
        foreach ($links as $link) {
          yield $link;
        }
      };
    }
  }

}


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

Breadcrumbs A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			namespace Drupal\graphql_core\Plugin\GraphQL\Fields\Breadcrumbs;
4
5			use Drupal\Core\Breadcrumb\BreadcrumbManager;
6			use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
7			use Drupal\Core\Routing\RouteMatchInterface;
8			use Drupal\Core\Url;
9			use Drupal\graphql\GraphQL\Buffers\SubRequestBuffer;
10			use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
11			use Symfony\Component\DependencyInjection\ContainerInterface;
12			use Youshido\GraphQL\Execution\ResolveInfo;
13
14			/**
15			* Retrieve the breadcrumbs.
16			*
17			* TODO: Move this to `InternalUrl` (breaking change).
18			*
19			* @GraphQLField(
20			* id = "breadcrumb",
21			* secure = true,
22			* name = "breadcrumb",
23			* type = "Link",
24			* multi = true,
25			* parents = {"Url"},
26			* )
27			*/
28			class Breadcrumbs extends FieldPluginBase implements ContainerFactoryPluginInterface {
			0 ignored issues – show Bug introduced 2018-01-23 09: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...
29
30			/**
31			* The subrequest buffer service.
32			*
33			* @var \Drupal\graphql\GraphQL\Buffers\SubRequestBuffer
34			*/
35			protected $subRequestBuffer;
36
37			/**
38			* The breadcrumb manager service.
39			*
40			* @var \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface
41			*/
42			protected $breadcrumbManager;
43
44			/**
45			* The current route match.
46			*
47			* @var \Drupal\Core\Routing\RouteMatchInterface
48			*/
49			protected $routeMatch;
50
51			/**
52			* {@inheritdoc}
53			*/
54			public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
55			return new static(
56			$configuration,
57			$pluginId,
58			$pluginDefinition,
59			$container->get('graphql.buffer.subrequest'),
60			$container->get('breadcrumb'),
61			$container->get('current_route_match')
62			);
63			}
64
65			/**
66			* {@inheritdoc}
67			*/
68			public function __construct(
69			array $configuration,
70			$pluginId,
71			$pluginDefinition,
72			SubRequestBuffer $subRequestBuffer,
73			BreadcrumbManager $breadcrumbManager,
74			RouteMatchInterface $routeMatch
75			) {
76			$this->subRequestBuffer = $subRequestBuffer;
77			$this->breadcrumbManager = $breadcrumbManager;
			0 ignored issues – show Documentation Bug introduced 2017-10-17 14:57 UTC by Report Bug Copy Issue Report It seems like `$breadcrumbManager` of type `object<Drupal\Core\Breadcrumb\BreadcrumbManager>` is incompatible with the declared type `object<Drupal\Core\Bread...dcrumbBuilderInterface>` of property `$breadcrumbManager`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
78			$this->routeMatch = $routeMatch;
79			parent::__construct($configuration, $pluginId, $pluginDefinition);
80			}
81
82			/**
83			* {@inheritdoc}
84			*/
85			protected function resolveValues($value, array $args, ResolveInfo $info) {
86			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...
87			$resolve = $this->subRequestBuffer->add($value, function () {
88			$links = $this->breadcrumbManager->build($this->routeMatch)->getLinks();
89			return $links;
90			});
91
92			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 $link); } };` (`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...
93			$links = $resolve();
94			foreach ($links as $link) {
95			yield $link;
96			}
97			};
98			}
99			}
100
101			}
102

drupal-graphql / graphql

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

Breadcrumbs A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like