MathEnv::isSmallerThanOrEqual() - Code Metrics - Inspection of "math env" - mattwellss/sphpeme - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#17)

by Matthew

created 2017-12-27 04:19 UTC

MathEnv::isSmallerThanOrEqual() A

↳ Parent: MathEnv

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php
declare(strict_types=1);

namespace Sphpeme\Env;

/**
 * @SuppressWarnings(PHPMD.ShortVariableName)
 */
class MathEnv implements EnvInterface
{
    use MappedEnvTrait;

    const INVALID_ARG_REQUIRES_NUMERIC = 'All arguments must be numeric';
    const INVALID_ARG_TYPE_PRED_MATCH = 'Supplied arguments do not match the first';

    const MAPPING = [
        '+' => 'add',
        '-' => 'subtract',
        '*' => 'multiply',
        '/' => 'divide',
        '>' => 'isGreaterThan',
        '>=' => 'isGreaterThanOrEqual',
        '<' => 'isSmallerThan',
        '<=' => 'isSmallerThanOrEqual',
        '=' => 'isEqual',
        'number?' => 'isNumber',
        'integer?' => 'isInteger',
        'real?' => 'isReal',
        'complex?' => 'isComplex',
        'exact?' => 'isExact',
        'inexact?' => 'isInexact',
        'positive?' => 'isPositive',
        'negative?' => 'isNegative',
        'odd?' => 'isOdd',
        'even?' => 'isEven',
    ];

    /** @var float */
    public $pi = M_PI;

    /**
     * Sum the args
     *
     * @param int[]|float[] $args
     * @return int|float
     * @throws \InvalidArgumentException
     */
    public function add(...$args)
    {
        array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);
        return array_sum($args);
    }

    /**
     * Subtract the args
     *
     * @param int[]|float[] $args
     * @return int|float
     * @throws \InvalidArgumentException
     */
    public function subtract(...$args)

    {
        array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);

        $arg = $args[0];
        $args = \array_slice($args, 1);

        return $arg - array_sum($args);
    }

    /**
     * Multiply the args
     *
     * @param int[]|float[] $args
     * @return int|float
     * @throws \InvalidArgumentException
     */
    public function multiply(...$args)
    {
        array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);
        return array_product($args);
    }

    /**
     * Divide the args
     *
     * @param int[]|float[] $args
     * @return int|float
     * @throws \InvalidArgumentException
     */
    public function divide(...$args)

    {
        array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);

        $arg = $args[0];
        $args = \array_slice($args, 1);

        return $arg / array_product($args);
    }

    /**
     * Returns true if $a is greater than $b, otherwise false
     *
     * @SuppressWarnings(PHPMD.ShortVariable)
     * @param int|float $a
     * @param int|float $b
     * @return bool
     */
    public function isGreaterThan($a, $b): bool
    {
        array_reduce([$a, $b], [$this, 'enforcePredicate'], [$this, 'isNumber']);
        return $a > $b;
    }

    /**
     * Returns true if $a is greater than or equal to $b, otherwise false
     *
     * @SuppressWarnings(PHPMD.ShortVariable)
     * @param int|float $a
     * @param int|float $b
     * @return bool
     */
    public function isGreaterThanOrEqual($a, $b): bool
    {
        array_reduce([$a, $b], [$this, 'enforcePredicate'], [$this, 'isNumber']);
        return $a >= $b;
    }

    /**
     * Returns true if $a is smaller than or equal to $b, otherwise false
     *
     * @SuppressWarnings(PHPMD.ShortVariable)
     * @param int|float $a
     * @param int|float $b
     * @return bool
     */
    public function isSmallerThanOrEqual($a, $b): bool
    {
        array_reduce([$a, $b], [$this, 'enforcePredicate'], [$this, 'isNumber']);
        return $a <= $b;
    }

    /**
     * Returns true if $a is smaller than $b, otherwise false
     *
     * @SuppressWarnings(PHPMD.ShortVariable)
     * @param int|float $a
     * @param int|float $b
     * @return bool
     */
    public function isSmallerThan($a, $b): bool
    {
        array_reduce([$a, $b], [$this, 'enforcePredicate'], [$this, 'isNumber']);
        return $a < $b;
    }

    /**
     * @param int[]|float[] ...$args
     * @return bool
     * @throws \InvalidArgumentException
     */
    public function isEqual(...$args): bool
    {
        array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);

        $arg = $args[0];
        $args = \array_slice($args, 1);

        foreach ($args as $other) {
            if ($arg != $other) {
                return false;
            }
        }

        return true;
    }

    /**
     * @param mixed $num
     * @return bool
     */
    public function isNumber($num): bool
    {
        return !\is_string($num) && is_numeric($num);
    }

    /**
     * Scheme's rules for integerness are slightly different than PHP's:
     *  An integer can be a "float" but it must have `.0`
     *
     * @param mixed $num
     * @return bool
     */
    public function isInteger($num): bool
    {
        return \is_int($num) ?: $this->isNumber($num) && $num == (int)$num;
    }

    /**
     * Not implemented yet.
     * Requires complex number support
     *
     * @param $num
     * @return bool
     * @throws \Error
     * @SuppressWarnings(PHPMD)
     */
    public function isComplex($num): bool

    {
        throw new \Error('Not implemented');

        return false;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
    }

    /**
     * Not implemented yet.
     * Requires complex number support
     *
     * @param $num
     * @return bool
     * @throws \Error
     * @SuppressWarnings(PHPMD)
     */
    public function isReal($num): bool

    {
        throw new \Error('Not implemented');

        return false;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
    }

    /**
     * @param $num
     * @return bool
     * @throws \InvalidArgumentException
     */
    public function isExact($num): bool
    {
        $this->enforcePredicate([$this, 'isNumber'], $num);

        return !\is_float($num);
    }

    /**
     * @param $num
     * @return bool
     * @throws \InvalidArgumentException
     */
    public function isInexact($num): bool
    {
        return !$this->isExact($num);
    }

    /**
     * @param $num
     * @return bool
     * @throws \InvalidArgumentException
     */
    public function isZero($num): bool
    {
        $this->enforcePredicate([$this, 'isNumber'], $num);

        return $num == 0;
    }

    /**
     * @param $num
     * @return bool
     * @throws \InvalidArgumentException
     */
    public function isPositive($num): bool
    {
        $this->enforcePredicate([$this, 'isNumber'], $num);

        return $num > 0;
    }

    /**
     * @param $num
     * @return bool
     * @throws \InvalidArgumentException
     */
    public function isNegative($num): bool
    {
        return !$this->isPositive($num);
    }

    /**
     * @param $num
     * @return bool
     * @throws \InvalidArgumentException
     */
    public function isOdd($num): bool
    {
        $this->enforcePredicate([$this, 'isNumber'], $num);

        return $num % 2 != 0;
    }

    /**
     * @param $num
     * @return bool
     * @throws \InvalidArgumentException
     */
    public function isEven($num): bool
    {
        return !$this->isOdd($num);
    }

    /**
     * @param int[]|float[] ...$args
     * @return int|float
     * @throws \InvalidArgumentException
     */
    public function max(...$args)
    {
        array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);

        return max(...$args);
    }

    /**
     * @param int[]|float[] ...$args
     * @return int|float
     * @throws \InvalidArgumentException
     */
    public function min(...$args)
    {
        array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);

        return min(...$args);
    }

    /**
     * @param int|float $arg
     * @return int|float
     */
    public function abs($arg)
    {
        $this->enforcePredicate([$this, 'isNumber'], $arg);

        return abs($arg);
    }

    /**
     * Used as the callback to array_reduce, with the "carry" argument being the predicate to enforce
     *
     * @param callable $pred
     * @param $thingToCheck
     * @return callable
     * @throws \InvalidArgumentException
     * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
     */
    private function enforcePredicate(callable $pred, $thingToCheck): callable
    {
        if (!$pred($thingToCheck)) {
            throw new \InvalidArgumentException(static::INVALID_ARG_REQUIRES_NUMERIC);
        }

        return $pred;
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace Sphpeme\Env;
5
6			/**
7			* @SuppressWarnings(PHPMD.ShortVariableName)
8			*/
9			class MathEnv implements EnvInterface
10			{
11			use MappedEnvTrait;
12
13			const INVALID_ARG_REQUIRES_NUMERIC = 'All arguments must be numeric';
14			const INVALID_ARG_TYPE_PRED_MATCH = 'Supplied arguments do not match the first';
15
16			const MAPPING = [
17			'+' => 'add',
18			'-' => 'subtract',
19			'*' => 'multiply',
20			'/' => 'divide',
21			'>' => 'isGreaterThan',
22			'>=' => 'isGreaterThanOrEqual',
23			'<' => 'isSmallerThan',
24			'<=' => 'isSmallerThanOrEqual',
25			'=' => 'isEqual',
26			'number?' => 'isNumber',
27			'integer?' => 'isInteger',
28			'real?' => 'isReal',
29			'complex?' => 'isComplex',
30			'exact?' => 'isExact',
31			'inexact?' => 'isInexact',
32			'positive?' => 'isPositive',
33			'negative?' => 'isNegative',
34			'odd?' => 'isOdd',
35			'even?' => 'isEven',
36			];
37
38			/** @var float */
39			public $pi = M_PI;
40
41			/**
42			* Sum the args
43			*
44			* @param int[]\|float[] $args
45			* @return int\|float
46			* @throws \InvalidArgumentException
47			*/
48	1		public function add(...$args)
49			{
50	1		array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);
51	1		return array_sum($args);
52			}
53
54			/**
55			* Subtract the args
56			*
57			* @param int[]\|float[] $args
58			* @return int\|float
59			* @throws \InvalidArgumentException
60			*/
61	1	View Code Duplication	public function subtract(...$args)
			1 ignored issue – show Duplication introduced 2017-12-27 04:28 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...
62			{
63	1		array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);
64
65	1		$arg = $args[0];
66	1		$args = \array_slice($args, 1);
67
68	1		return $arg - array_sum($args);
69			}
70
71			/**
72			* Multiply the args
73			*
74			* @param int[]\|float[] $args
75			* @return int\|float
76			* @throws \InvalidArgumentException
77			*/
78	1		public function multiply(...$args)
79			{
80	1		array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);
81	1		return array_product($args);
82			}
83
84			/**
85			* Divide the args
86			*
87			* @param int[]\|float[] $args
88			* @return int\|float
89			* @throws \InvalidArgumentException
90			*/
91	1	View Code Duplication	public function divide(...$args)
			1 ignored issue – show Duplication introduced 2017-12-27 04:28 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...
92			{
93	1		array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);
94
95	1		$arg = $args[0];
96	1		$args = \array_slice($args, 1);
97
98	1		return $arg / array_product($args);
99			}
100
101			/**
102			* Returns true if $a is greater than $b, otherwise false
103			*
104			* @SuppressWarnings(PHPMD.ShortVariable)
105			* @param int\|float $a
106			* @param int\|float $b
107			* @return bool
108			*/
109	1		public function isGreaterThan($a, $b): bool
110			{
111	1		array_reduce([$a, $b], [$this, 'enforcePredicate'], [$this, 'isNumber']);
112	1		return $a > $b;
113			}
114
115			/**
116			* Returns true if $a is greater than or equal to $b, otherwise false
117			*
118			* @SuppressWarnings(PHPMD.ShortVariable)
119			* @param int\|float $a
120			* @param int\|float $b
121			* @return bool
122			*/
123	1		public function isGreaterThanOrEqual($a, $b): bool
124			{
125	1		array_reduce([$a, $b], [$this, 'enforcePredicate'], [$this, 'isNumber']);
126	1		return $a >= $b;
127			}
128
129			/**
130			* Returns true if $a is smaller than or equal to $b, otherwise false
131			*
132			* @SuppressWarnings(PHPMD.ShortVariable)
133			* @param int\|float $a
134			* @param int\|float $b
135			* @return bool
136			*/
137	1		public function isSmallerThanOrEqual($a, $b): bool
138			{
139	1		array_reduce([$a, $b], [$this, 'enforcePredicate'], [$this, 'isNumber']);
140	1		return $a <= $b;
141			}
142
143			/**
144			* Returns true if $a is smaller than $b, otherwise false
145			*
146			* @SuppressWarnings(PHPMD.ShortVariable)
147			* @param int\|float $a
148			* @param int\|float $b
149			* @return bool
150			*/
151	1		public function isSmallerThan($a, $b): bool
152			{
153	1		array_reduce([$a, $b], [$this, 'enforcePredicate'], [$this, 'isNumber']);
154	1		return $a < $b;
155			}
156
157			/**
158			* @param int[]\|float[] ...$args
159			* @return bool
160			* @throws \InvalidArgumentException
161			*/
162	1		public function isEqual(...$args): bool
163			{
164	1		array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);
165
166	1		$arg = $args[0];
167	1		$args = \array_slice($args, 1);
168
169	1		foreach ($args as $other) {
170	1		if ($arg != $other) {
171	1		return false;
172			}
173			}
174
175	1		return true;
176			}
177
178			/**
179			* @param mixed $num
180			* @return bool
181			*/
182	21		public function isNumber($num): bool
183			{
184	21		return !\is_string($num) && is_numeric($num);
185			}
186
187			/**
188			* Scheme's rules for integerness are slightly different than PHP's:
189			* An integer can be a "float" but it must have `.0`
190			*
191			* @param mixed $num
192			* @return bool
193			*/
194	1		public function isInteger($num): bool
195			{
196	1		return \is_int($num) ?: $this->isNumber($num) && $num == (int)$num;
197			}
198
199			/**
200			* Not implemented yet.
201			* Requires complex number support
202			*
203			* @param $num
204			* @return bool
205			* @throws \Error
206			* @SuppressWarnings(PHPMD)
207			*/
208	2		public function isComplex($num): bool
			0 ignored issues – show Unused Code introduced 2017-12-27 04:28 UTC by Report Bug Copy Issue Report The parameter `$num` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
209			{
210	2		throw new \Error('Not implemented');
			0 ignored issues – show Unused Code introduced 2017-12-27 04:28 UTC by Report Bug Copy Issue Report The call to `Error::__construct()` has too many arguments starting with `'Not implemented'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
211			return false;
			0 ignored issues – show Unused Code introduced 2017-12-27 04:28 UTC by Report Bug Copy Issue Report `return false;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
212			}
213
214			/**
215			* Not implemented yet.
216			* Requires complex number support
217			*
218			* @param $num
219			* @return bool
220			* @throws \Error
221			* @SuppressWarnings(PHPMD)
222			*/
223			public function isReal($num): bool
			0 ignored issues – show Unused Code introduced 2017-12-27 04:28 UTC by Report Bug Copy Issue Report The parameter `$num` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
224			{
225			throw new \Error('Not implemented');
			0 ignored issues – show Unused Code introduced 2017-12-27 04:28 UTC by Report Bug Copy Issue Report The call to `Error::__construct()` has too many arguments starting with `'Not implemented'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
226			return false;
			0 ignored issues – show Unused Code introduced 2017-12-27 04:28 UTC by Report Bug Copy Issue Report `return false;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
227			}
228
229			/**
230			* @param $num
231			* @return bool
232			* @throws \InvalidArgumentException
233			*/
234	2		public function isExact($num): bool
235			{
236	2		$this->enforcePredicate([$this, 'isNumber'], $num);
237
238	2		return !\is_float($num);
239			}
240
241			/**
242			* @param $num
243			* @return bool
244			* @throws \InvalidArgumentException
245			*/
246	1		public function isInexact($num): bool
247			{
248	1		return !$this->isExact($num);
249			}
250
251			/**
252			* @param $num
253			* @return bool
254			* @throws \InvalidArgumentException
255			*/
256	1		public function isZero($num): bool
257			{
258	1		$this->enforcePredicate([$this, 'isNumber'], $num);
259
260	1		return $num == 0;
261			}
262
263			/**
264			* @param $num
265			* @return bool
266			* @throws \InvalidArgumentException
267			*/
268	2		public function isPositive($num): bool
269			{
270	2		$this->enforcePredicate([$this, 'isNumber'], $num);
271
272	2		return $num > 0;
273			}
274
275			/**
276			* @param $num
277			* @return bool
278			* @throws \InvalidArgumentException
279			*/
280	1		public function isNegative($num): bool
281			{
282	1		return !$this->isPositive($num);
283			}
284
285			/**
286			* @param $num
287			* @return bool
288			* @throws \InvalidArgumentException
289			*/
290	2		public function isOdd($num): bool
291			{
292	2		$this->enforcePredicate([$this, 'isNumber'], $num);
293
294	2		return $num % 2 != 0;
295			}
296
297			/**
298			* @param $num
299			* @return bool
300			* @throws \InvalidArgumentException
301			*/
302	1		public function isEven($num): bool
303			{
304	1		return !$this->isOdd($num);
305			}
306
307			/**
308			* @param int[]\|float[] ...$args
309			* @return int\|float
310			* @throws \InvalidArgumentException
311			*/
312	1		public function max(...$args)
313			{
314	1		array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);
315
316	1		return max(...$args);
317			}
318
319			/**
320			* @param int[]\|float[] ...$args
321			* @return int\|float
322			* @throws \InvalidArgumentException
323			*/
324	1		public function min(...$args)
325			{
326	1		array_reduce($args, [$this, 'enforcePredicate'], [$this, 'isNumber']);
327
328	1		return min(...$args);
329			}
330
331			/**
332			* @param int\|float $arg
333			* @return int\|float
334			*/
335	1		public function abs($arg)
336			{
337	1		$this->enforcePredicate([$this, 'isNumber'], $arg);
338
339	1		return abs($arg);
340			}
341
342			/**
343			* Used as the callback to array_reduce, with the "carry" argument being the predicate to enforce
344			*
345			* @param callable $pred
346			* @param $thingToCheck
347			* @return callable
348			* @throws \InvalidArgumentException
349			* @SuppressWarnings(PHPMD.UnusedPrivateMethod)
350			*/
351	19		private function enforcePredicate(callable $pred, $thingToCheck): callable
352			{
353	19		if (!$pred($thingToCheck)) {
354	16		throw new \InvalidArgumentException(static::INVALID_ARG_REQUIRES_NUMERIC);
355			}
356
357	19		return $pred;
358			}
359			}
360

mattwellss / sphpeme

GitHub Access Token became invalid

Pull Request — master (#17)

MathEnv::isSmallerThanOrEqual() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like