RootUnit::getCanon() - Code Metrics - Inspection of "added JsonSerializable to AbstractQuantity" - hiqdev/php-units - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2ec02e...6482c3 )

by Andrii

created 2017-06-06 09:59 UTC

RootUnit::getCanon() A

↳ Parent: RootUnit

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/**
 * PHP Units of Measure Library.
 *
 * @link      https://github.com/hiqdev/php-units
 * @package   php-units
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\php\units\tree;

use hiqdev\php\units\calculators\PhpCalculator;
use hiqdev\php\units\exceptions\NotConvertibleException;
use hiqdev\php\units\UnitInterface;

/**
 * Root unit in tree.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
class RootUnit implements UnitInterface
{
    /**
     * @var TreeConverter
     */
    protected $tree;

    /**
     * @var string
     */
    protected $name;

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return $this->name;
    }

    public function getParent()
    {
        return $this;
    }

    public function getRoot()
    {
        return $this;
    }

    public function getFactor()
    {
        return null;
    }

    public function getMeasure()
    {
        return $this->name;
    }

    /**
     * @param TreeConverter $tree
     * @param string $name
     */
    public function __construct(TreeConverter $tree, $name)
    {
        $this->tree = $tree;
        $this->name = $name;
    }

    protected $calculator;

    /**
     * Returns calculator for this unit.
     * Units can have different calculators.
     * @return CalculatorInterface
     */
    public function getCalculator()
    {
        if ($this->calculator === null) {
            $this->calculator = new PhpCalculator();
        }

        return $this->calculator;
    }

    /**
     * {@inheritdoc}
     */
    public function equals(UnitInterface $other)
    {
        return $this->getName() === $other->getName() || $this->isAlias($other);
    }

    public function isAlias(UnitInterface $other)
    {
        $node = $this->getNode($other);

        return $this === $node->getCanon() || $node === $this->getCanon();
    }

    public function getCanon()
    {
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function assertConvertible(UnitInterface $other)
    {
        if (!$this->isConvertible($other)) {
            throw new InvalidArgumentException('not convertible unit: ' . $other->getName());
        }
    }

    /**
     * {@inheritdoc}
     */
    final public function isConvertible(UnitInterface $other)
    {
        return $this->getMeasure() === $other->getMeasure();
    }

    /**
     * {@inheritdoc}
     */
    public function convert(UnitInterface $other, $quantity)
    {
        $other = $this->getNode($other);

        if ($this->equals($other)) {
            return $quantity;
        }

        if ($other->equals($this->getParent())) {
            return $this->multiplyByFactor($quantity);
        }

        if ($this->equals($other->getParent())) {
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            return $other->divideByFactor($quantity);
        }

        throw new NotConvertibleException('not yet implemented: ' . $this->getName() . ' -> ' . $other->getName());
    }

    public function multiplyByFactor($quantity)

    {
        if (empty($this->factor)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            throw new NotConvertibleException('method not yet implement: ' . $this->getName());
        }

        return $this->getCalculator()->multiply($quantity, $this->factor);
    }

    public function divideByFactor($quantity)

    {
        if (empty($this->factor)) {
            throw new NotConvertibleException('method not yet implement: ' . $this->getName());
        }

        return $this->getCalculator()->divide($quantity, $this->factor);
    }

    public function getNode(UnitInterface $unit)
    {
        return $this->tree->getNode($unit);
    }
}


1			<?php
2			/**
3			* PHP Units of Measure Library.
4			*
5			* @link https://github.com/hiqdev/php-units
6			* @package php-units
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2017, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hiqdev\php\units\tree;
12
13			use hiqdev\php\units\calculators\PhpCalculator;
14			use hiqdev\php\units\exceptions\NotConvertibleException;
15			use hiqdev\php\units\UnitInterface;
16
17			/**
18			* Root unit in tree.
19			*
20			* @author Andrii Vasyliev <[email protected]>
21			*/
22			class RootUnit implements UnitInterface
23			{
24			/**
25			* @var TreeConverter
26			*/
27			protected $tree;
28
29			/**
30			* @var string
31			*/
32			protected $name;
33
34			/**
35			* {@inheritdoc}
36			*/
37	9		public function getName()
38			{
39	9		return $this->name;
40			}
41
42	1		public function getParent()
43			{
44	1		return $this;
45			}
46
47	1		public function getRoot()
48			{
49	1		return $this;
50			}
51
52			public function getFactor()
53			{
54			return null;
55			}
56
57			public function getMeasure()
58			{
59			return $this->name;
60			}
61
62			/**
63			* @param TreeConverter $tree
64			* @param string $name
65			*/
66	4		public function __construct(TreeConverter $tree, $name)
67			{
68	4		$this->tree = $tree;
69	4		$this->name = $name;
70	4		}
71
72			protected $calculator;
73
74			/**
75			* Returns calculator for this unit.
76			* Units can have different calculators.
77			* @return CalculatorInterface
78			*/
79	6		public function getCalculator()
80			{
81	6		if ($this->calculator === null) {
82	2		$this->calculator = new PhpCalculator();
83	2		}
84
85	6		return $this->calculator;
86			}
87
88			/**
89			* {@inheritdoc}
90			*/
91	7		public function equals(UnitInterface $other)
92			{
93	7		return $this->getName() === $other->getName() \|\| $this->isAlias($other);
94			}
95
96	7		public function isAlias(UnitInterface $other)
97			{
98	7		$node = $this->getNode($other);
99
100	7		return $this === $node->getCanon() \|\| $node === $this->getCanon();
101			}
102
103	6		public function getCanon()
104			{
105	6		return $this;
106			}
107
108			/**
109			* {@inheritdoc}
110			*/
111			public function assertConvertible(UnitInterface $other)
112			{
113			if (!$this->isConvertible($other)) {
114			throw new InvalidArgumentException('not convertible unit: ' . $other->getName());
115			}
116			}
117
118			/**
119			* {@inheritdoc}
120			*/
121	2		final public function isConvertible(UnitInterface $other)
122			{
123	2		return $this->getMeasure() === $other->getMeasure();
124			}
125
126			/**
127			* {@inheritdoc}
128			*/
129	6		public function convert(UnitInterface $other, $quantity)
130			{
131	6		$other = $this->getNode($other);
132
133	6		if ($this->equals($other)) {
134	3		return $quantity;
135			}
136
137	6		if ($other->equals($this->getParent())) {
138	6		return $this->multiplyByFactor($quantity);
139			}
140
141	5		if ($this->equals($other->getParent())) {
			0 ignored issues – show Bug introduced 2017-03-29 15:25 UTC by Report Bug Copy Issue Report It seems like `$other->getParent()` can be `null`; however, `equals()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
142	5		return $other->divideByFactor($quantity);
143			}
144
145			throw new NotConvertibleException('not yet implemented: ' . $this->getName() . ' -> ' . $other->getName());
146			}
147
148	6	View Code Duplication	public function multiplyByFactor($quantity)
			0 ignored issues – show Duplication introduced 2017-03-29 15:25 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
149			{
150	6		if (empty($this->factor)) {
			0 ignored issues – show Bug introduced 2017-03-29 15:25 UTC by Report Bug Copy Issue Report The property `factor` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
151			throw new NotConvertibleException('method not yet implement: ' . $this->getName());
152			}
153
154	6		return $this->getCalculator()->multiply($quantity, $this->factor);
155			}
156
157	5	View Code Duplication	public function divideByFactor($quantity)
			0 ignored issues – show Duplication introduced 2017-03-29 15:25 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
158			{
159	5		if (empty($this->factor)) {
160			throw new NotConvertibleException('method not yet implement: ' . $this->getName());
161			}
162
163	5		return $this->getCalculator()->divide($quantity, $this->factor);
164			}
165
166	7		public function getNode(UnitInterface $unit)
167			{
168	7		return $this->tree->getNode($unit);
169			}
170			}
171

hiqdev / php-units

Push — master ( 2ec02e...6482c3 )

RootUnit::getCanon() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like