GenericNameProvider::inferName() - Code Metrics - Inspection of "Add implementation of Generics" - spaark/composite-utils - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

by Emily

created 2017-02-26 14:36 UTC

GenericNameProvider::inferName() B

↳ Parent: GenericNameProvider

Complexity

Conditions	7
Paths	7

Size

Total Lines	18
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	7.9295

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	18
ccs	11
cts	15
cp	0.7332
rs	8.2222
c	1
b	0
f	0
cc	7
eloc	14
nc	7
nop	1
crap	7.9295

<?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\Exception\PropertyNotWritableException;
use Spaark\CompositeUtils\Exception\PropertyNotReadableException;

/**
 * Used to retrieve the classname for an AbstractType
 */
class GenericNameProvider
{
    const BASE = 'Spaark\CompositeUtils\Generic\\';

    /**
     * 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 'boolean';
            case IntegerType::class:
                return 'int';
            case FloatType::class:
                return 'float';
            case MixedType::class:
                return 'mixed';
            case StringType::class:
                return 'string';
        }
    }

    /**
     * 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 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\Exception\PropertyNotWritableException;
26		use Spaark\CompositeUtils\Exception\PropertyNotReadableException;
27
28		/**
29		* Used to retrieve the classname for an AbstractType
30		*/
31		class GenericNameProvider
32		{
33		const BASE = 'Spaark\CompositeUtils\Generic\\';
34
35		/**
36		* Infers the serialized name of the given AbstractType
37		*
38		* @param AbstractType $reflect
39		* @return string
40		*/
41	1	public function inferName(AbstractType $reflect)
42		{
43	1	switch (get_class($reflect))
44		{
45	1	case ObjectType::class:
46	1	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...
47	1	case BooleanType::class:
48		return 'boolean';
49	1	case IntegerType::class:
50	1	return 'int';
51	1	case FloatType::class:
52		return 'float';
53	1	case MixedType::class:
54		return 'mixed';
55	1	case StringType::class:
56	1	return 'string';
57		}
58		}
59
60		/**
61		* Infers the serialized name of the given ObjectType
62		*
63		* @param ObjectType $reflect
64		* @return string
65		*/
66	1	protected function inferObjectName(ObjectType $reflect)
67		{
68	1	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...
69		{
70	1	return $reflect->classname;
71		}
72		else
73		{
74	1	$items = [];
75	1	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...
76		{
77	1	$items[] = $this->inferName($generic);
78		}
79
80	1	return self::BASE . $reflect->classname
81	1	. '_g' . implode('_c', $items) . '_e';
82		}
83		}
84		}
85

spaark / composite-utils

Pull Request — master (#4)

GenericNameProvider::inferName() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like