AbstractQuantity::create() - Code Metrics - Inspection of "added Quantity implementation and test" - hiqdev/php-units - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 72a657...653b9d )

by Andrii

created 2017-03-31 12:33 UTC

AbstractQuantity::create() A

↳ Parent: AbstractQuantity

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes

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

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

/**
 * Quantity with Unit.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
abstract class AbstractQuantity implements QuantityInterface
{
    /**
     * @var UnitInterface
     */
    private $unit;

    /**
     * @var float|int|string
     */
    private $quantity;

    /**
     * @var UnitInterface $unit
     * @var float|int|string $quantity
     */
    private function __construct(UnitInterface $unit, $quantity)
    {
        $this->unit = $unit;
        $this->quantity = $quantity;
    }

    /**
     * Creates quantity with same unit.
     * Optimized to return this if same quantity.
     * @var float|int|string $quantity
     */
    final protected function create($quantity)
    {
        return $this->quantity === $quantity ? $this : new static($this->unit, $quantity);
    }

    /**
     * {@inheritdoc}
     */
    private function getCalculator()
    {
        return $this->unit->getCalculator();
    }

    /**
     * {@inheritdoc}
     */
    final public function getQuantity()
    {
        return $this->quantity;
    }

    /**
     * {@inheritdoc}
     */
    final public function getUnit()
    {
        return $this->unit;
    }

    /**
     * {@inheritdoc}
     */
    final public function compare(QuantityInterface $other)
    {
        $arg = $other->convert($this->unit);

        return $this->getCalculator()->compare($this->quantity, $arg->quantity);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
    }

    /**
     * {@inheritdoc}
     */
    final public function equals(QuantityInterface $other)
    {
        return $this->compare($other) === 0;
    }

    /**
     * {@inheritdoc}
     */
    final public function isConvertible(UnitInterface $unit)
    {
        return $this->unit->isConvertible($unit);
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());
}
    }

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

        return $this->create($res);
    }

    /**
     * {@inheritdoc}
     */
    final public function add(QuantityInterface $addend)

    {
        $arg = $addend->convert($this->unit);
        $res = $this->getCalculator()->add($this->quantity, $arg);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $this->create($res);
    }

    /**
     * {@inheritdoc}
     */
    final public function subtract(QuantityInterface $subtrahend)

    {
        $arg = $subtrahend->convert($this->unit);
        $res = $this->getCalculator()->subtract($this->quantity, $arg);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $this->create($res);
    }

    /**
     * {@inheritdoc}
     */
    final public function multiply($multiplier)
    {
        $res = $this->getCalculator()->multiply($this->quantity, $multiplier);

        return $this->create($res);
    }

    /**
     * {@inheritdoc}
     */
    final public function divide($divisor)
    {
        $res = $this->getCalculator()->divide($this->quantity, $divisor);

        return $this->create($res);
    }

    /**
     * {@inheritdoc}
     */
    final public function ceil()
    {
        $res = $this->getCalculator()->ceil($this->quantity);

        return $this->create($res);
    }

    /**
     * {@inheritdoc}
     */
    final public function floor()
    {
        $res = $this->getCalculator()->floor($this->quantity);

        return $this->create($res);
    }

    /**
     * {@inheritdoc}
     */
    final public function round($roundingMode)
    {
        $res = $this->getCalculator()->round($this->quantity, $roundingMode);

        return $this->create($res);
    }

    /**
     * {@inheritdoc}
     */
    final public function absolute()
    {
        $res = $this->getCalculator()->absolute($this->quantity);

        return $this->create($res);
    }

    final public static function __callStatic($unit, $args)
    {
        return new static(static::findUnit($unit), $args[0]);
    }

    /**
     * Returns unit for given unit name.
     * The only function to change in child classes.
     * XXX Should be defined as abstract but `abstract static` is not supported in PHP5.
     * @param string $name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return UnitInterface
     * @throws InvalidConfigException
     */
    protected static function findUnit($unit)
    {
        throw new InvalidConfigException('getUnit method must be redefined');
    }
}


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;
12
13			/**
14			* Quantity with Unit.
15			*
16			* @author Andrii Vasyliev <[email protected]>
17			*/
18			abstract class AbstractQuantity implements QuantityInterface
19			{
20			/**
21			* @var UnitInterface
22			*/
23			private $unit;
24
25			/**
26			* @var float\|int\|string
27			*/
28			private $quantity;
29
30			/**
31			* @var UnitInterface $unit
32			* @var float\|int\|string $quantity
33			*/
34	6		private function __construct(UnitInterface $unit, $quantity)
35			{
36	6		$this->unit = $unit;
37	6		$this->quantity = $quantity;
38	6		}
39
40			/**
41			* Creates quantity with same unit.
42			* Optimized to return this if same quantity.
43			* @var float\|int\|string $quantity
44			*/
45	3		final protected function create($quantity)
46			{
47	3		return $this->quantity === $quantity ? $this : new static($this->unit, $quantity);
48			}
49
50			/**
51			* {@inheritdoc}
52			*/
53	2		private function getCalculator()
54			{
55	2		return $this->unit->getCalculator();
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61	2		final public function getQuantity()
62			{
63	2		return $this->quantity;
64			}
65
66			/**
67			* {@inheritdoc}
68			*/
69	1		final public function getUnit()
70			{
71	1		return $this->unit;
72			}
73
74			/**
75			* {@inheritdoc}
76			*/
77	2		final public function compare(QuantityInterface $other)
78			{
79	2		$arg = $other->convert($this->unit);
80
81	2		return $this->getCalculator()->compare($this->quantity, $arg->quantity);
			0 ignored issues – show Bug introduced 2017-03-31 12:35 UTC by Report Bug Copy Issue Report Accessing `quantity` on the interface `hiqdev\php\units\QuantityInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
82			}
83
84			/**
85			* {@inheritdoc}
86			*/
87	1		final public function equals(QuantityInterface $other)
88			{
89	1		return $this->compare($other) === 0;
90			}
91
92			/**
93			* {@inheritdoc}
94			*/
95	1		final public function isConvertible(UnitInterface $unit)
96			{
97	1		return $this->unit->isConvertible($unit);
			0 ignored issues – show Bug Best Practice introduced 2017-03-31 12:35 UTC by Report Bug Copy Issue Report The return type of `return $this->unit->isConvertible($unit);` (`boolean`) is incompatible with the return type declared by the interface `hiqdev\php\units\QuantityInterface::isConvertible` of type `hiqdev\php\units\QuantityInterface`. 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...
98			}
99
100			/**
101			* {@inheritdoc}
102			*/
103	3		final public function convert(UnitInterface $unit)
104			{
105	3		$res = $this->unit->convert($unit, $this->quantity);
106
107	3		return $this->create($res);
108			}
109
110			/**
111			* {@inheritdoc}
112			*/
113		View Code Duplication	final public function add(QuantityInterface $addend)
			0 ignored issues – show Duplication introduced 2017-03-31 12:35 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...
114			{
115			$arg = $addend->convert($this->unit);
116			$res = $this->getCalculator()->add($this->quantity, $arg);
			0 ignored issues – show Documentation introduced 2017-03-31 12:35 UTC by Report Bug Copy Issue Report `$arg` is of type `object<hiqdev\php\units\QuantityInterface>`, but the function expects a `integer\|double\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
117
118			return $this->create($res);
119			}
120
121			/**
122			* {@inheritdoc}
123			*/
124		View Code Duplication	final public function subtract(QuantityInterface $subtrahend)
			0 ignored issues – show Duplication introduced 2017-03-31 12:35 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...
125			{
126			$arg = $subtrahend->convert($this->unit);
127			$res = $this->getCalculator()->subtract($this->quantity, $arg);
			0 ignored issues – show Documentation introduced 2017-03-31 12:35 UTC by Report Bug Copy Issue Report `$arg` is of type `object<hiqdev\php\units\QuantityInterface>`, but the function expects a `integer\|double\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
128
129			return $this->create($res);
130			}
131
132			/**
133			* {@inheritdoc}
134			*/
135			final public function multiply($multiplier)
136			{
137			$res = $this->getCalculator()->multiply($this->quantity, $multiplier);
138
139			return $this->create($res);
140			}
141
142			/**
143			* {@inheritdoc}
144			*/
145			final public function divide($divisor)
146			{
147			$res = $this->getCalculator()->divide($this->quantity, $divisor);
148
149			return $this->create($res);
150			}
151
152			/**
153			* {@inheritdoc}
154			*/
155			final public function ceil()
156			{
157			$res = $this->getCalculator()->ceil($this->quantity);
158
159			return $this->create($res);
160			}
161
162			/**
163			* {@inheritdoc}
164			*/
165			final public function floor()
166			{
167			$res = $this->getCalculator()->floor($this->quantity);
168
169			return $this->create($res);
170			}
171
172			/**
173			* {@inheritdoc}
174			*/
175			final public function round($roundingMode)
176			{
177			$res = $this->getCalculator()->round($this->quantity, $roundingMode);
178
179			return $this->create($res);
180			}
181
182			/**
183			* {@inheritdoc}
184			*/
185			final public function absolute()
186			{
187			$res = $this->getCalculator()->absolute($this->quantity);
188
189			return $this->create($res);
190			}
191
192	6		final public static function __callStatic($unit, $args)
193			{
194	6		return new static(static::findUnit($unit), $args[0]);
195			}
196
197			/**
198			* Returns unit for given unit name.
199			* The only function to change in child classes.
200			* XXX Should be defined as abstract but `abstract static` is not supported in PHP5.
201			* @param string $name
			0 ignored issues – show Bug introduced 2017-03-31 12:35 UTC by Report Bug Copy Issue Report There is no parameter named `$name`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
202			* @return UnitInterface
203			* @throws InvalidConfigException
204			*/
205			protected static function findUnit($unit)
206			{
207			throw new InvalidConfigException('getUnit method must be redefined');
208			}
209			}
210

hiqdev / php-units

Push — master ( 72a657...653b9d )

AbstractQuantity::create() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like