GenericCompositeGenerator - Code Metrics - Inspection of "Merge branch 'feature/property-access-with-generic..." - spaark/composite-utils - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 499778...79f24a )

by Emily

created 2017-03-18 22:20 UTC

GenericCompositeGenerator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	8
c	1
b	0
f	0
lcom	1
cbo	6
dl	0
loc	112
ccs	44
cts	44
cp	1
rs	10

4 Methods

Rating	Name	Size	Complexity
A	createObject()	12	2
B	generateClassCode()	27	2
B	generateMethodCode()	27	3
A	createClass()	4	1

<?php
/**
 * This file is part of the Composite Utils package.
 *
 * (c) Emily Shepherd <[email protected]>
 *
 * For the full copyright and license information, please view the
 * LICENSE.md file that was distributed with this source code.
 *
 * @package spaark/composite-utils
 * @author Emily Shepherd <[email protected]>
 * @license MIT
 */

namespace Spaark\CompositeUtils\Factory\Reflection;

use Spaark\CompositeUtils\Model\Reflection\ReflectionComposite;
use Spaark\CompositeUtils\Model\Reflection\ReflectionMethod;
use Spaark\CompositeUtils\Model\Reflection\Type\BooleanType;
use Spaark\CompositeUtils\Model\Reflection\Type\CollectionType;
use Spaark\CompositeUtils\Model\Reflection\Type\IntegerType;
use Spaark\CompositeUtils\Model\Reflection\Type\MixedType;
use Spaark\CompositeUtils\Model\Reflection\Type\ObjectType;
use Spaark\CompositeUtils\Model\Reflection\Type\StringType;
use Spaark\CompositeUtils\Model\Reflection\Type\GenericType;
use Spaark\CompositeUtils\Model\Generic\GenericContext;
use Spaark\CompositeUtils\Model\ClassName;
use Spaark\CompositeUtils\Service\RawPropertyAccessor;
use Spaark\CompositeUtils\Service\GenericNameProvider;
use Spaark\CompositeUtils\Traits\AutoConstructPropertyAccessTrait;

/**
 * Generates the code for a generic class
 */
class GenericCompositeGenerator
{
    use AutoConstructPropertyAccessTrait;

    /**
     * @var ReflectionComposite
     * @construct required
     */
    protected $reflect;

    /**
     * @var GenericNameProvider
     */
    protected $nameProvider;

    /**
     * @var ?ClassName
     * @readable
     */
    protected $generatedClassName;

    /**
     * Creates an ObjectType from the given list of generics
     *
     * @param AbstractType[] $generics
     */
    private function createObject(...$generics) : ObjectType
    {
        $object = new ObjectType($this->reflect->classname);
        $i = 0;

        foreach ($this->reflect->generics as $name => $value)
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        {
            $object->generics[] = $generics[$i++] ?? $value;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        return $object;
    }

    /**
     * Generate class code for the given generics
     *
     * @param AbstractType[] $generics
     * @return string
     */
    public function generateClassCode(...$generics) : string
    {
        $object = $this->createObject(...$generics);
        $this->nameProvider = new GenericNameProvider
        (
            new GenericContext($object, $this->reflect)
        );
        $class = $this->nameProvider->inferName($object);
        $this->generatedClassName = $class;
        $originalClass = $this->reflect->classname;
        $i = 0;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        $code =
              'namespace ' . $class->namespace . ';'
            . 'class ' . $class->classname . ' '
            .     'extends \\' . $originalClass
            . '{';

        foreach ($this->reflect->methods as $method)
        {
            $code .= $this->generateMethodCode($method);
        }

        $code .= '}';

        return $code;
    }

    /**
     * Generates the method code for the current class being generated
     *
     * @param ReflectionMethod $method
     * @return string
     */
    public function generateMethodCode(ReflectionMethod $method)
        : string
    {
        $params = [];
        $newParams = [];
        $paramNames = [];
        foreach ($method->parameters as $i => $param)
        {
            $paramNames[] = $name = ' $' . $param->name;
            $params[] = $method->nativeParameters[$i] . $name;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $newParams[] =
                $this->nameProvider->inferName($param->type) . $name;
        }

        return
              ($method->scope === 'static' ? 'static ' : '')
            . 'function ' . $method->name
            . '(' . implode(',', $params) . '){'
            . '__generic_' . $method->name
            . '(' . implode(',', $paramNames) . ');}'
            . "\n"
            . 'function __generic_' . $method->name
            . '(' . implode(',', $newParams) . '){'
            . 'parent::' . $method->name
            . '(' . implode(',', $paramNames) . ');}'
            . "\n";
    }

    public function createClass(...$generics)
    {
        eval($this->generateClassCode(...$generics));
    }
}


1		<?php
2		/**
3		* This file is part of the Composite Utils package.
4		*
5		* (c) Emily Shepherd <[email protected]>
6		*
7		* For the full copyright and license information, please view the
8		* LICENSE.md file that was distributed with this source code.
9		*
10		* @package spaark/composite-utils
11		* @author Emily Shepherd <[email protected]>
12		* @license MIT
13		*/
14
15		namespace Spaark\CompositeUtils\Factory\Reflection;
16
17		use Spaark\CompositeUtils\Model\Reflection\ReflectionComposite;
18		use Spaark\CompositeUtils\Model\Reflection\ReflectionMethod;
19		use Spaark\CompositeUtils\Model\Reflection\Type\BooleanType;
20		use Spaark\CompositeUtils\Model\Reflection\Type\CollectionType;
21		use Spaark\CompositeUtils\Model\Reflection\Type\IntegerType;
22		use Spaark\CompositeUtils\Model\Reflection\Type\MixedType;
23		use Spaark\CompositeUtils\Model\Reflection\Type\ObjectType;
24		use Spaark\CompositeUtils\Model\Reflection\Type\StringType;
25		use Spaark\CompositeUtils\Model\Reflection\Type\GenericType;
26		use Spaark\CompositeUtils\Model\Generic\GenericContext;
27		use Spaark\CompositeUtils\Model\ClassName;
28		use Spaark\CompositeUtils\Service\RawPropertyAccessor;
29		use Spaark\CompositeUtils\Service\GenericNameProvider;
30		use Spaark\CompositeUtils\Traits\AutoConstructPropertyAccessTrait;
31
32		/**
33		* Generates the code for a generic class
34		*/
35		class GenericCompositeGenerator
36		{
37		use AutoConstructPropertyAccessTrait;
38
39		/**
40		* @var ReflectionComposite
41		* @construct required
42		*/
43		protected $reflect;
44
45		/**
46		* @var GenericNameProvider
47		*/
48		protected $nameProvider;
49
50		/**
51		* @var ?ClassName
52		* @readable
53		*/
54		protected $generatedClassName;
55
56		/**
57		* Creates an ObjectType from the given list of generics
58		*
59		* @param AbstractType[] $generics
60		*/
61	6	private function createObject(...$generics) : ObjectType
62		{
63	6	$object = new ObjectType($this->reflect->classname);
64	6	$i = 0;
65
66	6	foreach ($this->reflect->generics as $name => $value)
		0 ignored issues – show Documentation introduced 2017-03-10 20:06 UTC by Report Bug Copy Issue Report The property `$generics` is declared protected in `Spaark\CompositeUtils\Mo...ion\ReflectionComposite`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
67		{
68	6	$object->generics[] = $generics[$i++] ?? $value;
		0 ignored issues – show Documentation introduced 2017-03-10 20:06 UTC by Report Bug Copy Issue Report The property `$generics` is declared protected in `Spaark\CompositeUtils\Mo...lection\Type\ObjectType`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
69		}
70
71	6	return $object;
72		}
73
74		/**
75		* Generate class code for the given generics
76		*
77		* @param AbstractType[] $generics
78		* @return string
79		*/
80	6	public function generateClassCode(...$generics) : string
81		{
82	6	$object = $this->createObject(...$generics);
83	6	$this->nameProvider = new GenericNameProvider
84		(
85	6	new GenericContext($object, $this->reflect)
86		);
87	6	$class = $this->nameProvider->inferName($object);
88	6	$this->generatedClassName = $class;
89	6	$originalClass = $this->reflect->classname;
90	6	$i = 0;
		0 ignored issues – show Unused Code introduced 2017-03-10 20:06 UTC by Report Bug Copy Issue Report `$i` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
91
92		$code =
93	6	'namespace ' . $class->namespace . ';'
94	6	. 'class ' . $class->classname . ' '
95	6	. 'extends \\' . $originalClass
96	6	. '{';
97
98	6	foreach ($this->reflect->methods as $method)
99		{
100	6	$code .= $this->generateMethodCode($method);
101		}
102
103	6	$code .= '}';
104
105	6	return $code;
106		}
107
108		/**
109		* Generates the method code for the current class being generated
110		*
111		* @param ReflectionMethod $method
112		* @return string
113		*/
114	6	public function generateMethodCode(ReflectionMethod $method)
115		: string
116		{
117	6	$params = [];
118	6	$newParams = [];
119	6	$paramNames = [];
120	6	foreach ($method->parameters as $i => $param)
121		{
122	6	$paramNames[] = $name = ' $' . $param->name;
123	6	$params[] = $method->nativeParameters[$i] . $name;
		0 ignored issues – show Documentation introduced 2017-03-11 13:21 UTC by Report Bug Copy Issue Report The property `$nativeParameters` is declared protected in `Spaark\CompositeUtils\Mo...ection\ReflectionMethod`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
124	6	$newParams[] =
125	6	$this->nameProvider->inferName($param->type) . $name;
126		}
127
128		return
129	6	($method->scope === 'static' ? 'static ' : '')
130	6	. 'function ' . $method->name
131	6	. '(' . implode(',', $params) . '){'
132	6	. '__generic_' . $method->name
133	6	. '(' . implode(',', $paramNames) . ');}'
134		. "\n"
135	6	. 'function __generic_' . $method->name
136	6	. '(' . implode(',', $newParams) . '){'
137	6	. 'parent::' . $method->name
138	6	. '(' . implode(',', $paramNames) . ');}'
139	6	. "\n";
140		}
141
142	4	public function createClass(...$generics)
143		{
144	4	eval($this->generateClassCode(...$generics));
145	4	}
146		}
147

spaark / composite-utils

Push — master ( 499778...79f24a )

GenericCompositeGenerator A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Duplication Side-by-Side

Filter issues like