GenericNameProvider::inferGenericName() - Code Metrics - Inspection of "Merge pull request #6 from spaark/feature/generic-..." - spaark/composite-utils - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b0bc39...c39dfb )

by Emily

created 2017-03-11 15:56 UTC

GenericNameProvider::inferGenericName() A

↳ Parent: GenericNameProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	5
cts	5
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	1
crap	2

<?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\Service;

use Spaark\CompositeUtils\Model\Reflection\Type\ObjectType;
use Spaark\CompositeUtils\Model\Reflection\Type\AbstractType;
use Spaark\CompositeUtils\Model\Reflection\Type\BooleanType;
use Spaark\CompositeUtils\Model\Reflection\Type\FloatType;
use Spaark\CompositeUtils\Model\Reflection\Type\MixedType;
use Spaark\CompositeUtils\Model\Reflection\Type\IntegerType;
use Spaark\CompositeUtils\Model\Reflection\Type\CollectionType;
use Spaark\CompositeUtils\Model\Reflection\Type\StringType;
use Spaark\CompositeUtils\Model\Reflection\Type\GenericType;
use Spaark\CompositeUtils\Model\Generic\GenericContext;
use Spaark\CompositeUtils\Exception\MissingContextException;
use Spaark\CompositeUtils\Traits\AutoConstructTrait;
use Spaark\CompositeUtils\Model\ClassName;

/**
 * Used to retrieve the classname for an AbstractType
 */
class GenericNameProvider
{
    use AutoConstructTrait;

    const BASE = 'Spaark\CompositeUtils\Generic\\';

    /**
     * @var GenericContext
     * @construct optional
     */
    protected $context;

    /**
     * Infers the serialized name of the given AbstractType
     *
     * @param AbstractType $reflect
     * @return string
     */
    public function inferName(AbstractType $reflect)
    {
        switch (get_class($reflect))
        {
            case ObjectType::class:
                return $this->inferObjectName($reflect);

            case BooleanType::class:
                return 'bool';
            case IntegerType::class:
                return 'int';
            case FloatType::class:
                return 'float';
            case MixedType::class:
                return '';
            case StringType::class:
                return 'string';
            case GenericType::class:
                return $this->inferGenericName($reflect);

        }

        throw new \DomainException
        (
            'Unknown type: ' . get_class($reflect)
        );
    }

    /**
     * Infers the serialized name of the given GenericType
     *
     * @param GenericType $reflect
     * @return string
     * @throws Exception
     */
    protected function inferGenericName(GenericType $reflect)
    {
        if (!$this->context)
        {
            throw new MissingContextException();
        }

        return $this->inferName
        (
            $this->context->getGenericType($reflect->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.");
        }
    }

}
        );
    }

    /**
     * Infers the serialized name of the given ObjectType
     *
     * @param ObjectType $reflect
     * @return string
     */
    protected function inferObjectName(ObjectType $reflect)
    {
        if ($reflect->generics->empty())
<?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 $reflect->classname;
        }
        else
        {
            $items = [];
            foreach ($reflect->generics as $generic)
<?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.");
        }
    }

}
            {
                $items[] = $this->inferName($generic);
            }

            return new ClassName
            (
                  self::BASE . $reflect->classname
                . '_g' . implode('_c', $items) . '_e'
            );
        }
    }
}


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\Service;
16
17		use Spaark\CompositeUtils\Model\Reflection\Type\ObjectType;
18		use Spaark\CompositeUtils\Model\Reflection\Type\AbstractType;
19		use Spaark\CompositeUtils\Model\Reflection\Type\BooleanType;
20		use Spaark\CompositeUtils\Model\Reflection\Type\FloatType;
21		use Spaark\CompositeUtils\Model\Reflection\Type\MixedType;
22		use Spaark\CompositeUtils\Model\Reflection\Type\IntegerType;
23		use Spaark\CompositeUtils\Model\Reflection\Type\CollectionType;
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\Exception\MissingContextException;
28		use Spaark\CompositeUtils\Traits\AutoConstructTrait;
29		use Spaark\CompositeUtils\Model\ClassName;
30
31		/**
32		* Used to retrieve the classname for an AbstractType
33		*/
34		class GenericNameProvider
35		{
36		use AutoConstructTrait;
37
38		const BASE = 'Spaark\CompositeUtils\Generic\\';
39
40		/**
41		* @var GenericContext
42		* @construct optional
43		*/
44		protected $context;
45
46		/**
47		* Infers the serialized name of the given AbstractType
48		*
49		* @param AbstractType $reflect
50		* @return string
51		*/
52	10	public function inferName(AbstractType $reflect)
53		{
54	10	switch (get_class($reflect))
55		{
56	10	case ObjectType::class:
57	3	return $this->inferObjectName($reflect);
		0 ignored issues – show Compatibility introduced 2017-02-26 14:39 UTC by Report Bug Copy Issue Report `$reflect` of type `object<Spaark\CompositeU...tion\Type\AbstractType>` is not a sub-type of `object<Spaark\CompositeU...ection\Type\ObjectType>`. It seems like you assume a child class of the class `Spaark\CompositeUtils\Mo...ction\Type\AbstractType` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
58	10	case BooleanType::class:
59	1	return 'bool';
60	9	case IntegerType::class:
61	2	return 'int';
62	8	case FloatType::class:
63	1	return 'float';
64	7	case MixedType::class:
65	1	return '';
66	6	case StringType::class:
67	3	return 'string';
68	4	case GenericType::class:
69	3	return $this->inferGenericName($reflect);
		0 ignored issues – show Compatibility introduced 2017-03-11 13:21 UTC by Report Bug Copy Issue Report `$reflect` of type `object<Spaark\CompositeU...tion\Type\AbstractType>` is not a sub-type of `object<Spaark\CompositeU...ction\Type\GenericType>`. It seems like you assume a child class of the class `Spaark\CompositeUtils\Mo...ction\Type\AbstractType` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
70		}
71
72	1	throw new \DomainException
73		(
74	1	'Unknown type: ' . get_class($reflect)
75		);
76		}
77
78		/**
79		* Infers the serialized name of the given GenericType
80		*
81		* @param GenericType $reflect
82		* @return string
83		* @throws Exception
84		*/
85	3	protected function inferGenericName(GenericType $reflect)
86		{
87	3	if (!$this->context)
88		{
89	1	throw new MissingContextException();
90		}
91
92	2	return $this->inferName
93		(
94	2	$this->context->getGenericType($reflect->name)
		0 ignored issues – show Documentation introduced 2017-03-11 13:21 UTC by Report Bug Copy Issue Report The property `$name` is declared protected in `Spaark\CompositeUtils\Mo...ection\Type\GenericType`. 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...
95		);
96		}
97
98		/**
99		* Infers the serialized name of the given ObjectType
100		*
101		* @param ObjectType $reflect
102		* @return string
103		*/
104	3	protected function inferObjectName(ObjectType $reflect)
105		{
106	3	if ($reflect->generics->empty())
		0 ignored issues – show Documentation introduced 2017-02-26 14:39 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...
107		{
108	3	return $reflect->classname;
109		}
110		else
111		{
112	2	$items = [];
113	2	foreach ($reflect->generics as $generic)
		0 ignored issues – show Documentation introduced 2017-02-26 14:39 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...
114		{
115	2	$items[] = $this->inferName($generic);
116		}
117
118	2	return new ClassName
119		(
120	2	self::BASE . $reflect->classname
121	2	. '_g' . implode('_c', $items) . '_e'
122		);
123		}
124		}
125		}
126

spaark / composite-utils

Push — master ( b0bc39...c39dfb )

GenericNameProvider::inferGenericName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like