Enforcement::isFulfilled() - Code Metrics - Inspection of "Updates and added assure" - Dgame/php-ensurance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 60648a...356503 )

by Randy

created 2017-11-22 11:53 UTC

Enforcement::isFulfilled() A

↳ Parent: Enforcement

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Dgame\Ensurance\Enforcement;

use AssertionError;
use Dgame\Ensurance\Exception\EnsuranceException;
use Throwable;

/**
 * Class Enforcement
 * @package Dgame\Ensurance\Enforcement
 */
final class Enforcement
{
    /**
     * @var bool
     */
    private $condition;
    /**
     * @var null|Throwable
     */
    private $throwable;

    /**
     * Enforcement constructor.
     *
     * @param bool        $condition
     * @param string|null $message
     */
    public function __construct(bool $condition, string $message = null)
    {
        $this->condition = $condition;
        if ($message !== null) {
            $this->setThrowMessage($message);
        }
    }

    /**
     * @throws Throwable
     */
    public function __destruct()
    {
        if (!$this->isFulfilled()) {
            throw $this->getThrowable();
        }
    }

    /**
     * Enforce approvement of the Enforcement
     */
    final public function approve()

    {
        $this->condition = true;
    }

    /**
     * @return bool
     */
    final public function isFulfilled(): bool

    {
        return $this->condition;
    }

    /**
     * @return bool
     */
    final public function hasThrowable(): bool

    {
        return $this->throwable !== null;
    }

    /**
     * @return Throwable
     */
    private function getThrowable(): Throwable
    {
        return $this->throwable ?? $this->emplaceThrowable('Assertion failed');
    }

    /**
     * @param string $message
     *
     * @return Throwable
     */
    private function emplaceThrowable(string $message): Throwable
    {
        return new EnsuranceException($message);
    }

    /**
     * @param string|Throwable $throwable
     * @param array            ...$args
     */

    final public function orThrow($throwable, ...$args)

    {
        if ($throwable instanceof Throwable) {
            $this->setThrowable($throwable);
        } else {
            $this->setThrowMessage((string) $throwable, ...$args);
        }
    }

    /**
     * @param string $message
     * @param array  ...$args
     */

    final public function setThrowMessage(string $message, ...$args)

    {
        if (!empty($args)) {
            $args    = array_map(function ($arg) {

                return !is_string($arg) ? var_export($arg, true) : $arg;
            }, $args);
            $message = sprintf($message, ...$args);

        }

        $throwable = $this->emplaceThrowable($message);

        $this->setThrowable($throwable);
    }

    /**
     * @param Throwable $throwable
     */
    final public function setThrowable(Throwable $throwable)

    {
        $this->throwable = $throwable;
    }
}

1			<?php
2
3			namespace Dgame\Ensurance\Enforcement;
4
5			use AssertionError;
6			use Dgame\Ensurance\Exception\EnsuranceException;
7			use Throwable;
8
9			/**
10			* Class Enforcement
11			* @package Dgame\Ensurance\Enforcement
12			*/
13			final class Enforcement
14			{
15			/**
16			* @var bool
17			*/
18			private $condition;
19			/**
20			* @var null\|Throwable
21			*/
22			private $throwable;
23
24			/**
25			* Enforcement constructor.
26			*
27			* @param bool $condition
28			* @param string\|null $message
29			*/
30			public function __construct(bool $condition, string $message = null)
31			{
32			$this->condition = $condition;
33			if ($message !== null) {
34			$this->setThrowMessage($message);
35			}
36			}
37
38			/**
39			* @throws Throwable
40			*/
41			public function __destruct()
42			{
43			if (!$this->isFulfilled()) {
44			throw $this->getThrowable();
45			}
46			}
47
48			/**
49			* Enforce approvement of the Enforcement
50			*/
51			final public function approve()
			0 ignored issues – show Coding Style introduced 2017-11-22 11:54 UTC by Report Bug Copy Issue Report Unnecessary FINAL modifier in FINAL class Loading history...
52			{
53			$this->condition = true;
54			}
55
56			/**
57			* @return bool
58			*/
59			final public function isFulfilled(): bool
			0 ignored issues – show Coding Style introduced 2017-11-22 11:54 UTC by Report Bug Copy Issue Report Unnecessary FINAL modifier in FINAL class Loading history...
60			{
61			return $this->condition;
62			}
63
64			/**
65			* @return bool
66			*/
67			final public function hasThrowable(): bool
			0 ignored issues – show Coding Style introduced 2017-11-22 11:54 UTC by Report Bug Copy Issue Report Unnecessary FINAL modifier in FINAL class Loading history...
68			{
69			return $this->throwable !== null;
70			}
71
72			/**
73			* @return Throwable
74			*/
75			private function getThrowable(): Throwable
76			{
77			return $this->throwable ?? $this->emplaceThrowable('Assertion failed');
78			}
79
80			/**
81			* @param string $message
82			*
83			* @return Throwable
84			*/
85			private function emplaceThrowable(string $message): Throwable
86			{
87			return new EnsuranceException($message);
88			}
89
90			/**
91			* @param string\|Throwable $throwable
92			* @param array ...$args
93			*/
			0 ignored issues – show Documentation introduced 2017-11-22 11:54 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$args` a bit more specific; maybe use `array[]`. Loading history...
94			final public function orThrow($throwable, ...$args)
			0 ignored issues – show Coding Style introduced 2017-11-22 11:54 UTC by Report Bug Copy Issue Report Unnecessary FINAL modifier in FINAL class Loading history...
95			{
96			if ($throwable instanceof Throwable) {
97			$this->setThrowable($throwable);
98			} else {
99			$this->setThrowMessage((string) $throwable, ...$args);
100			}
101			}
102
103			/**
104			* @param string $message
105			* @param array ...$args
106			*/
			0 ignored issues – show Documentation introduced 2017-04-30 20:50 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$args` a bit more specific; maybe use `array[]`. Loading history...
107			final public function setThrowMessage(string $message, ...$args)
			0 ignored issues – show Coding Style introduced 2017-11-22 11:54 UTC by Report Bug Copy Issue Report Unnecessary FINAL modifier in FINAL class Loading history...
108			{
109			if (!empty($args)) {
110			$args = array_map(function ($arg) {
			0 ignored issues – show Coding Style introduced 2017-04-30 20:50 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$args`. This often makes code more readable. Loading history...
111			return !is_string($arg) ? var_export($arg, true) : $arg;
112			}, $args);
113			$message = sprintf($message, ...$args);
			0 ignored issues – show Coding Style introduced 2017-04-30 20:50 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$message`. This often makes code more readable. Loading history...
114			}
115
116			$throwable = $this->emplaceThrowable($message);
117
118			$this->setThrowable($throwable);
119			}
120
121			/**
122			* @param Throwable $throwable
123			*/
124			final public function setThrowable(Throwable $throwable)
			0 ignored issues – show Coding Style introduced 2017-11-22 11:54 UTC by Report Bug Copy Issue Report Unnecessary FINAL modifier in FINAL class Loading history...
125			{
126			$this->throwable = $throwable;
127			}
128			}

Dgame / php-ensurance

Push — master ( 60648a...356503 )

Enforcement::isFulfilled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like