functions.php ➔ enforce() - Code Metrics - Dgame/php-ensurance - Measure and Improve Code Quality continuously with Scrutinizer

functions.php ➔ enforce() A
last analyzed 2019-08-02 16:06 UTC

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Dgame\Ensurance;

use AssertionError;
use Throwable;

/**
 * @param mixed $value
 *
 * @return Ensurance
 * @throws Throwable
 */
function ensure($value): Ensurance
{
    return new Ensurance($value);
}

/**
 * @param bool        $condition
 * @param string|null $message
 *
 * @return BooleanEnsurance
 * @throws Throwable
 */
function enforce(bool $condition, string $message = null): BooleanEnsurance
{
    $error = new AssertionError($message ?? 'Assertion failed');


    return ensure($condition)->isTrue()->orThrowWith($error);
}

/**
 * @param string $message
 * @param mixed  ...$args
 *
 * @return string
 */
function format(string $message, ...$args): string
{
    if (empty($args)) {
        return $message;
    }

    foreach ($args as &$arg) {
        if (is_array($arg) || is_object($arg)) {
            $arg = print_r($arg, true);
        }
    }

    return sprintf($message, ...$args);
}


1		<?php
2
3		namespace Dgame\Ensurance;
4
5		use AssertionError;
6		use Throwable;
7
8		/**
9		* @param mixed $value
10		*
11		* @return Ensurance
12	57	* @throws Throwable
13		*/
14		function ensure($value): Ensurance
15		{
16		return new Ensurance($value);
17		}
18
19		/**
20		* @param bool $condition
21		* @param string\|null $message
22	3	*
23		* @return BooleanEnsurance
24		* @throws Throwable
25		*/
26		function enforce(bool $condition, string $message = null): BooleanEnsurance
27		{
28		$error = new AssertionError($message ?? 'Assertion failed');
		0 ignored issues – show Unused Code introduced 2017-11-22 11:54 UTC by Report Bug Copy Issue Report The call to `AssertionError::__construct()` has too many arguments starting with `$message ?? 'Assertion failed'`. 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...
29
30		return ensure($condition)->isTrue()->orThrowWith($error);
31		}
32
33		/**
34		* @param string $message
35		* @param mixed ...$args
36		*
37		* @return string
38		*/
39		function format(string $message, ...$args): string
40		{
41		if (empty($args)) {
42		return $message;
43		}
44
45		foreach ($args as &$arg) {
46		if (is_array($arg) \|\| is_object($arg)) {
47		$arg = print_r($arg, true);
48		}
49		}
50
51		return sprintf($message, ...$args);
52		}
53

Dgame / php-ensurance

functions.php ➔ enforce() A last analyzed 2019-08-02 16:06 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

functions.php ➔ enforce() A
last analyzed 2019-08-02 16:06 UTC