EnsuranceTrait::either() - Code Metrics - Dgame/php-ensurance - Measure and Improve Code Quality continuously with Scrutinizer

EnsuranceTrait::either() A
last analyzed 2019-08-02 16:06 UTC

↳ Parent: EnsuranceTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Dgame\Ensurance;

use Dgame\Ensurance\Exception\EnsuranceException;
use Dgame\Type\Type;
use Dgame\Type\TypeFactory;
use Exception;
use Throwable;

/**
 * Trait EnsuranceTrait
 * @package Dgame\Ensurance
 */
trait EnsuranceTrait
{
    /**
     * @var mixed
     */
    private $value;
    /**
     * @var bool
     */
    private $ensured = true;
    /**
     * @var Throwable|null
     */
    private $throwable;

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

    /**
     * @param callable $callback
     *
     * @return self
     */
    final public function is(callable $callback): self
    {
        try {
            $result = (bool) $callback($this->value);
        } catch (Throwable $t) {
            $result = false;
        }

        return $this->ensure($result);
    }

    /**
     * @param string $type
     *
     * @return self
     * @throws Exception
     */
    final public function isTypeOf(string $type): self
    {
        $type = Type::import($type);


        return $this->ensure(TypeFactory::expression($this->value)->isSame($type));
    }

    /**
     * @param mixed $value
     *
     * @return mixed
     */
    final public function then($value)
    {
        return $this->disregardThrowable()->isEnsured() ? $value : $this->value;
    }

    /**
     * @param mixed $value
     *
     * @return mixed
     */
    final public function else($value)
    {
        return $this->disregardThrowable()->isEnsured() ? $this->value : $value;
    }

    /**
     * @param mixed $value
     *
     * @return Either
     */
    final public function either($value): Either
    {
        return new Either($value, $this->disregardThrowable()->isEnsured());
    }

    /**
     * @param mixed $default
     *
     * @return mixed
     */
    final public function get($default = null)
    {
        return $this->value ?? $default;
    }

    /**
     * @param bool $condition
     *
     * @return self
     */
    final protected function ensure(bool $condition): self
    {
        $this->ensured = $condition;

        return $this;
    }

    /**
     * @return bool
     */
    final public function isEnsured(): bool
    {
        return $this->ensured;
    }

    /**
     * @return self
     */
    final public function disregardThrowable(): self
    {
        $this->throwable = null;

        return $this;
    }

    /**
     * @return Throwable|null
     */
    final public function releaseThrowable(): ?Throwable
    {
        try {
            return $this->throwable;
        } finally {
            $this->disregardThrowable();
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        }
    }

    /**
     * @param EnsuranceInterface $ensurance
     *
     * @return self
     */
    final public function transferEnsurance(EnsuranceInterface $ensurance): self
    {
        $this->value = $ensurance->get();
        $this->ensure($ensurance->isEnsured());

        $throwable = $ensurance->releaseThrowable();
        if ($throwable !== null) {
            $this->orThrowWith($throwable);
        }

        return $this;
    }

    /**
     * @param string $message
     * @param mixed  ...$args
     *
     * @return self
     */

    final public function orThrow(string $message, ...$args): self
    {
        if (!$this->isEnsured()) {
            $this->orThrowWith(new EnsuranceException(format($message, ...$args), $this->throwable));
        }

        return $this;
    }

    /**
     * @return bool
     */
    final public function hasThrowable(): bool
    {
        return $this->throwable !== null;
    }

    /**
     * @param Throwable $throwable
     *
     * @return self
     * @deprecated Use "orThrowWith" instead
     *
     */
    final public function setThrowable(Throwable $throwable): self
    {
        return $this->orThrowWith($throwable);
    }

    /**
     * @param Throwable $throwable
     *
     * @return self
     */
    final public function orThrowWith(Throwable $throwable): self
    {
        if (!$this->isEnsured()) {
            $this->throwable = $throwable;
        }

        return $this;
    }

    /**
     * @return Throwable|null
     */
    final public function getThrowable(): ?Throwable
    {
        return $this->throwable;
    }
}


1			<?php
2
3			namespace Dgame\Ensurance;
4
5			use Dgame\Ensurance\Exception\EnsuranceException;
6			use Dgame\Type\Type;
7			use Dgame\Type\TypeFactory;
8			use Exception;
9			use Throwable;
10
11			/**
12			* Trait EnsuranceTrait
13			* @package Dgame\Ensurance
14			*/
15			trait EnsuranceTrait
16			{
17			/**
18			* @var mixed
19			*/
20			private $value;
21			/**
22			* @var bool
23			*/
24			private $ensured = true;
25			/**
26			* @var Throwable\|null
27			*/
28			private $throwable;
29
30			/**
31			* @throws Throwable
32			*/
33			public function __destruct()
34			{
35			if ($this->throwable !== null) {
36			throw $this->throwable;
37			}
38			}
39
40			/**
41			* @param callable $callback
42			*
43			* @return self
44			*/
45			final public function is(callable $callback): self
46			{
47			try {
48			$result = (bool) $callback($this->value);
49			} catch (Throwable $t) {
50			$result = false;
51			}
52
53			return $this->ensure($result);
54			}
55
56			/**
57			* @param string $type
58			*
59			* @return self
60			* @throws Exception
61			*/
62			final public function isTypeOf(string $type): self
63			{
64			$type = Type::import($type);
			0 ignored issues – show Coding Style introduced 2018-05-10 08:34 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$type`. This often makes code more readable. Loading history...
65
66			return $this->ensure(TypeFactory::expression($this->value)->isSame($type));
67			}
68
69			/**
70			* @param mixed $value
71			*
72			* @return mixed
73			*/
74			final public function then($value)
75			{
76			return $this->disregardThrowable()->isEnsured() ? $value : $this->value;
77			}
78
79			/**
80			* @param mixed $value
81			*
82			* @return mixed
83			*/
84			final public function else($value)
85			{
86			return $this->disregardThrowable()->isEnsured() ? $this->value : $value;
87			}
88
89			/**
90			* @param mixed $value
91			*
92			* @return Either
93			*/
94			final public function either($value): Either
95			{
96			return new Either($value, $this->disregardThrowable()->isEnsured());
97			}
98
99			/**
100			* @param mixed $default
101			*
102			* @return mixed
103			*/
104			final public function get($default = null)
105			{
106			return $this->value ?? $default;
107			}
108
109			/**
110			* @param bool $condition
111			*
112			* @return self
113			*/
114			final protected function ensure(bool $condition): self
115			{
116			$this->ensured = $condition;
117
118			return $this;
119			}
120
121			/**
122			* @return bool
123			*/
124			final public function isEnsured(): bool
125			{
126			return $this->ensured;
127			}
128
129			/**
130			* @return self
131			*/
132			final public function disregardThrowable(): self
133			{
134			$this->throwable = null;
135
136			return $this;
137			}
138
139			/**
140			* @return Throwable\|null
141			*/
142			final public function releaseThrowable(): ?Throwable
143			{
144			try {
145			return $this->throwable;
146			} finally {
147			$this->disregardThrowable();
			0 ignored issues – show Unused Code introduced 2018-03-30 15:48 UTC by Report Bug Copy Issue Report `$this->disregardThrowable();` 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...
148			}
149			}
150
151			/**
152			* @param EnsuranceInterface $ensurance
153			*
154			* @return self
155			*/
156			final public function transferEnsurance(EnsuranceInterface $ensurance): self
157			{
158			$this->value = $ensurance->get();
159			$this->ensure($ensurance->isEnsured());
160
161			$throwable = $ensurance->releaseThrowable();
162			if ($throwable !== null) {
163			$this->orThrowWith($throwable);
164			}
165
166			return $this;
167			}
168
169			/**
170			* @param string $message
171			* @param mixed ...$args
172			*
173			* @return self
174			*/
			0 ignored issues – show Documentation introduced 2018-03-30 15:48 UTC by Report Bug Copy Issue Report Consider making the type for parameter `$args` a bit more specific; maybe use `array`. Loading history...
175			final public function orThrow(string $message, ...$args): self
176			{
177			if (!$this->isEnsured()) {
178			$this->orThrowWith(new EnsuranceException(format($message, ...$args), $this->throwable));
179			}
180
181			return $this;
182			}
183
184			/**
185			* @return bool
186			*/
187			final public function hasThrowable(): bool
188			{
189			return $this->throwable !== null;
190			}
191
192			/**
193			* @param Throwable $throwable
194			*
195			* @return self
196			* @deprecated Use "orThrowWith" instead
197			*
198			*/
199			final public function setThrowable(Throwable $throwable): self
200			{
201			return $this->orThrowWith($throwable);
202			}
203
204			/**
205			* @param Throwable $throwable
206			*
207			* @return self
208			*/
209			final public function orThrowWith(Throwable $throwable): self
210			{
211			if (!$this->isEnsured()) {
212			$this->throwable = $throwable;
213			}
214
215			return $this;
216			}
217
218			/**
219			* @return Throwable\|null
220			*/
221			final public function getThrowable(): ?Throwable
222			{
223			return $this->throwable;
224			}
225			}
226

Dgame / php-ensurance

EnsuranceTrait::either() A last analyzed 2019-08-02 16:06 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

EnsuranceTrait::either() A
last analyzed 2019-08-02 16:06 UTC