AbstractNormalizableCommandResolverException::cleanPropertyPath() - Code Metrics - Inspection of "Move project to ammit-php/ammit" - ammit-php/ammit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d57f97...544bed )

by Guillaume

created 2018-03-10 13:05 UTC

cleanPropertyPath() A

↳ Parent: AbstractNormalizableCommandResolverException

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

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

<?php
declare(strict_types = 1);

namespace AmmitPhp\Ammit\UI\Resolver\Exception;

use AmmitPhp\Ammit\UI\Resolver\NormalizableInterface;

abstract class AbstractNormalizableCommandResolverException extends \InvalidArgumentException implements NormalizableInterface
{
    const SOURCE_RAW = null;
    const SOURCE_ATTRIBUTE = 'pointer';
    const SOURCE_PARAMETER = 'parameter';

    /** @var string */
    private $propertyPath;

    /** @var string|null */
    private $source;

    /**
     * @inheritDoc
     */
    public function __construct(string $message, string $propertyPath = null, string $source = null)
    {
        parent::__construct($message, 0);

        $this->propertyPath = self::cleanPropertyPath($propertyPath);
        $this->source = $source;
    }

    /**
     * From raw value directly injected
     */
    public static function fromRaw(string $message, string $propertyPath = null): AbstractNormalizableCommandResolverException
    {
        return new static(
            $message,
            self::cleanPropertyPath($propertyPath),
            self::SOURCE_RAW
        );
    }

    /**
     * From query string parameter ($_GET)
     */
    public static function fromParameter(string $message, string $propertyPath = null): AbstractNormalizableCommandResolverException
    {
        return new static(
            $message,
            self::cleanPropertyPath($propertyPath),
            self::SOURCE_PARAMETER
        );
    }

    /**
     * From attribute parameter ($_POST)
     */
    public static function fromAttribute(string $message, string $propertyPath = null): AbstractNormalizableCommandResolverException
    {
        return new static($message,
            self::cleanPropertyPath($propertyPath),
            self::SOURCE_ATTRIBUTE
        );
    }

    public function getPropertyPath(): string
    {
        return $this->propertyPath;
    }

    /**
     * @return null|string
     */
    public function getSource()
    {
        return $this->source;
    }

    /**
     * @inheritdoc
     * Normalize the Exception into a ready to be JSON encoded array
     * Example for Attribute $_POST:
     * {
     *     "status": "406",
     *     "source": { "pointer": "/data/attributes/firstName" },
     *     "title": "Invalid Attribute",
     *     "detail": "Array does not contain an element with key firstName"
     * }
     *
     * Example for parameter $_GET
     * {
     *     "status": "406",
     *     "source": { "parameter": "firstName" },
     *     "title":  "Invalid Query Parameter",
     *     "detail": "Array does not contain an element with key firstName"
     *     }
     */
    public function normalize(): array
    {
        return [
            'status' => 406,
            'source' => $this->createSourceNode(
                $this->propertyPath,
                $this->source
            ),
            'title' => $this->createTitleNode($this->source),
            'detail' => $this->getMessage(),
        ];
    }

    private function createSourceNode(string $propertyPath, string $source = null): array
    {
        if (self::SOURCE_ATTRIBUTE === $source) {
            return [
                'pointer' => '/data/attributes/' . $propertyPath
            ];
        }

        return [
            'parameter' => $propertyPath
        ];
    }

    private function createTitleNode(string $source = null): string
    {
        if (self::SOURCE_PARAMETER === $source) {
            return 'Invalid Query Parameter';
        }

        if (self::SOURCE_RAW === $source) {
            return 'Invalid Parameter';
        }

        return 'Invalid Attribute';
    }

    private static function cleanPropertyPath(string $propertyPath = null): string
    {
        if (null === $propertyPath) {
            return $propertyPath = '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        }

        return $propertyPath;
    }
}


1		<?php
2		declare(strict_types = 1);
3
4		namespace AmmitPhp\Ammit\UI\Resolver\Exception;
5
6		use AmmitPhp\Ammit\UI\Resolver\NormalizableInterface;
7
8		abstract class AbstractNormalizableCommandResolverException extends \InvalidArgumentException implements NormalizableInterface
9		{
10		const SOURCE_RAW = null;
11		const SOURCE_ATTRIBUTE = 'pointer';
12		const SOURCE_PARAMETER = 'parameter';
13
14		/** @var string */
15		private $propertyPath;
16
17		/** @var string\|null */
18		private $source;
19
20		/**
21		* @inheritDoc
22		*/
23		public function __construct(string $message, string $propertyPath = null, string $source = null)
24		{
25	1	parent::__construct($message, 0);
26
27	1	$this->propertyPath = self::cleanPropertyPath($propertyPath);
28	1	$this->source = $source;
29	1	}
30
31		/**
32		* From raw value directly injected
33		*/
34		public static function fromRaw(string $message, string $propertyPath = null): AbstractNormalizableCommandResolverException
35		{
36		return new static(
37		$message,
38		self::cleanPropertyPath($propertyPath),
39		self::SOURCE_RAW
40		);
41		}
42
43		/**
44		* From query string parameter ($_GET)
45		*/
46		public static function fromParameter(string $message, string $propertyPath = null): AbstractNormalizableCommandResolverException
47		{
48		return new static(
49		$message,
50		self::cleanPropertyPath($propertyPath),
51		self::SOURCE_PARAMETER
52		);
53		}
54
55		/**
56		* From attribute parameter ($_POST)
57		*/
58		public static function fromAttribute(string $message, string $propertyPath = null): AbstractNormalizableCommandResolverException
59		{
60		return new static($message,
61		self::cleanPropertyPath($propertyPath),
62		self::SOURCE_ATTRIBUTE
63		);
64		}
65
66		public function getPropertyPath(): string
67		{
68	1	return $this->propertyPath;
69		}
70
71		/**
72		* @return null\|string
73		*/
74		public function getSource()
75		{
76		return $this->source;
77		}
78
79		/**
80		* @inheritdoc
81		* Normalize the Exception into a ready to be JSON encoded array
82		* Example for Attribute $_POST:
83		* {
84		* "status": "406",
85		* "source": { "pointer": "/data/attributes/firstName" },
86		* "title": "Invalid Attribute",
87		* "detail": "Array does not contain an element with key firstName"
88		* }
89		*
90		* Example for parameter $_GET
91		* {
92		* "status": "406",
93		* "source": { "parameter": "firstName" },
94		* "title": "Invalid Query Parameter",
95		* "detail": "Array does not contain an element with key firstName"
96		* }
97		*/
98		public function normalize(): array
99		{
100		return [
101	1	'status' => 406,
102	1	'source' => $this->createSourceNode(
103	1	$this->propertyPath,
104	1	$this->source
105		),
106	1	'title' => $this->createTitleNode($this->source),
107	1	'detail' => $this->getMessage(),
108		];
109		}
110
111		private function createSourceNode(string $propertyPath, string $source = null): array
112		{
113	1	if (self::SOURCE_ATTRIBUTE === $source) {
114		return [
115	1	'pointer' => '/data/attributes/' . $propertyPath
116		];
117		}
118
119		return [
120		'parameter' => $propertyPath
121		];
122		}
123
124		private function createTitleNode(string $source = null): string
125		{
126	1	if (self::SOURCE_PARAMETER === $source) {
127		return 'Invalid Query Parameter';
128		}
129
130	1	if (self::SOURCE_RAW === $source) {
131		return 'Invalid Parameter';
132		}
133
134	1	return 'Invalid Attribute';
135		}
136
137		private static function cleanPropertyPath(string $propertyPath = null): string
138		{
139	1	if (null === $propertyPath) {
140	1	return $propertyPath = '';
		0 ignored issues – show Unused Code introduced 2018-03-10 13:02 UTC by Report Bug Copy Issue Report `$propertyPath` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
141		}
142
143	1	return $propertyPath;
144		}
145		}
146

ammit-php / ammit

Push — master ( d57f97...544bed )

cleanPropertyPath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like