Reflection::__construct() - Code Metrics - Inspection of "A little more improvements" - railt/reflection - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( dbe410...b8c007 )

by Kirill

created 2018-07-21 02:34 UTC

Reflection::__construct() A

↳ Parent: Reflection

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	6
cts	6
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php
/**
 * This file is part of Railt package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Railt\Reflection;

use Railt\Reflection\Contracts\Definition\TypeDefinition;
use Railt\Reflection\Contracts\Dictionary;
use Railt\Reflection\Contracts\Document as DocumentInterface;
use Railt\Reflection\Contracts\Reflection as ReflectionInterface;
use Railt\Reflection\Dictionary\ProxyDictionary;
use Railt\Reflection\Dictionary\SimpleDictionary;
use Railt\Reflection\Exception\ReflectionException;
use Railt\Reflection\Stack\ProvidesCallStack;
use Railt\Reflection\Stdlib\GraphQLDocument;

/**
 * Class Reflection
 */
class Reflection extends ProxyDictionary implements ReflectionInterface
{
    /**
     * @var array|DocumentInterface[]
     */
    protected $documents = [];

    /**
     * Reflection constructor.
     * @param Dictionary|null $parent
     * @throws ReflectionException
     */
    public function __construct(Dictionary $parent = null)
    {
        parent::__construct($parent ?? new SimpleDictionary());

        $this->wrap(function () {
            $this->boot();
        });
    }

    /**
     * @param \Closure $then
     * @return mixed
     * @throws ReflectionException
     */
    private function wrap(\Closure $then)
    {
        try {
            return $then();
        } catch (ReflectionException $e) {
            $parent = $this->getParentDictionary();

            if ($parent instanceof ProvidesCallStack) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                $e = $e->withCallStack($parent->getCallStack());

            }

            throw $e;
        }
    }

    /**
     * @return void
     * @throws Exception\TypeConflictException
     */
    private function boot(): void
    {
        $this->addDocument(new GraphQLDocument($this));
    }

    /**
     * @param DocumentInterface $document
     */
    public function addDocument(DocumentInterface $document): void
    {
        $this->documents[$document->getName()] = $document;
    }

    /**
     * @return iterable
     */
    public function getDocuments(): iterable
    {
        return \array_values($this->documents);
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());
}
    }

    /**
     * @param TypeDefinition $type
     * @return Dictionary
     */
    public function add(TypeDefinition $type): Dictionary
    {
        $this->addDocument($type->getDocument());

        return parent::add($type);
    }
}


1		<?php
2		/**
3		* This file is part of Railt package.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*/
8		declare(strict_types=1);
9
10		namespace Railt\Reflection;
11
12		use Railt\Reflection\Contracts\Definition\TypeDefinition;
13		use Railt\Reflection\Contracts\Dictionary;
14		use Railt\Reflection\Contracts\Document as DocumentInterface;
15		use Railt\Reflection\Contracts\Reflection as ReflectionInterface;
16		use Railt\Reflection\Dictionary\ProxyDictionary;
17		use Railt\Reflection\Dictionary\SimpleDictionary;
18		use Railt\Reflection\Exception\ReflectionException;
19		use Railt\Reflection\Stack\ProvidesCallStack;
20		use Railt\Reflection\Stdlib\GraphQLDocument;
21
22		/**
23		* Class Reflection
24		*/
25		class Reflection extends ProxyDictionary implements ReflectionInterface
26		{
27		/**
28		* @var array\|DocumentInterface[]
29		*/
30		protected $documents = [];
31
32		/**
33		* Reflection constructor.
34		* @param Dictionary\|null $parent
35		* @throws ReflectionException
36		*/
37	9	public function __construct(Dictionary $parent = null)
38		{
39	9	parent::__construct($parent ?? new SimpleDictionary());
40
41	9	$this->wrap(function () {
42	9	$this->boot();
43	9	});
44	9	}
45
46		/**
47		* @param \Closure $then
48		* @return mixed
49		* @throws ReflectionException
50		*/
51	9	private function wrap(\Closure $then)
52		{
53		try {
54	9	return $then();
55		} catch (ReflectionException $e) {
56		$parent = $this->getParentDictionary();
57
58		if ($parent instanceof ProvidesCallStack) {
		0 ignored issues – show Bug introduced 2018-07-21 02:36 UTC by Report Bug Copy Issue Report The class `Railt\Reflection\Stack\ProvidesCallStack` 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...
59		$e = $e->withCallStack($parent->getCallStack());
		0 ignored issues – show Bug introduced 2018-07-21 02:36 UTC by Report Bug Copy Issue Report The method `withCallStack()` does not seem to exist on `object<Railt\Reflection\...on\ReflectionException>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
60		}
61
62		throw $e;
63		}
64		}
65
66		/**
67		* @return void
68		* @throws Exception\TypeConflictException
69		*/
70	9	private function boot(): void
71		{
72	9	$this->addDocument(new GraphQLDocument($this));
73	9	}
74
75		/**
76		* @param DocumentInterface $document
77		*/
78	17	public function addDocument(DocumentInterface $document): void
79		{
80	17	$this->documents[$document->getName()] = $document;
81	17	}
82
83		/**
84		* @return iterable
85		*/
86	4	public function getDocuments(): iterable
87		{
88	4	return \array_values($this->documents);
		0 ignored issues – show Bug Best Practice introduced 2018-07-17 01:05 UTC by Report Bug Copy Issue Report The return type of `return \array_values($this->documents);` (`array`) is incompatible with the return type declared by the interface `Railt\Reflection\Contrac...eflection::getDocuments` of type `Railt\Reflection\Contrac...on\Contracts\Document[]`. 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...
89		}
90
91		/**
92		* @param TypeDefinition $type
93		* @return Dictionary
94		*/
95	17	public function add(TypeDefinition $type): Dictionary
96		{
97	17	$this->addDocument($type->getDocument());
98
99	17	return parent::add($type);
100		}
101		}
102

railt / reflection

Push — master ( dbe410...b8c007 )

Reflection::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like