RouteMatcher - Code Metrics - Inspection of "Enhance test suite." - canax/router - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 976b6b...f8fb73 )

by Mikael

created 2018-08-09 10:30 UTC

RouteMatcher A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	213
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	28
lcom	1
cbo	0
dl	0
loc	213
ccs	0
cts	72
cp	0
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	checkPartAsArgument()	19	5
A	checkPartMatchingType()	23	5
A	typeConvertArgument()	11	2
A	matchPart()	19	4
A	matchRequestMethod()	10	3
B	match()	47	9

<?php

namespace Anax\Route;

use Anax\Commons\ContainerInjectableInterface;
use Anax\Route\Exception\ConfigurationException;

/**
 * Matching a incoming path to see it it matches a route.
 */
class RouteMatcher
{
    /**
     * @var null|array   $arguments     arguments for the callback, extracted
     *                                  from path
     * @var string       $methodMatched the matched method.
     * @var string       $pathMatched   the matched path.
     */
    public $arguments = [];
    public $methodMatched;
    public $pathMatched;



    /**
     * Check if part of route is a argument and optionally match type
     * as a requirement {argument:type}.
     *
     * @param string $rulePart   the rule part to check.
     * @param string $queryPart  the query part to check.
     * @param array  &$args      add argument to args array if matched
     *
     * @return boolean
     */
    private function checkPartAsArgument($rulePart, $queryPart, &$args)
    {
        if (substr($rulePart, -1) == "}"
            && !is_null($queryPart)
        ) {
            $part = substr($rulePart, 1, -1);
            $pos = strpos($part, ":");
            $type = null;
            if ($pos !== false) {
                $type = substr($part, $pos + 1);
                if (! $this->checkPartMatchingType($queryPart, $type)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    return false;
                }
            }
            $args[] = $this->typeConvertArgument($queryPart, $type);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            return true;
        }
        return false;
    }



    /**
     * Check if value is matching a certain type of values.
     *
     * @param string $value   the value to check.
     * @param array  $type    the expected type to check against.
     *
     * @return boolean
     */
    private function checkPartMatchingType($value, $type)
    {
        switch ($type) {
            case "digit":
                return ctype_digit($value);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case "hex":
                return ctype_xdigit($value);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case "alpha":
                return ctype_alpha($value);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case "alphanum":
                return ctype_alnum($value);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            default:
                return false;
        }
    }



    /**
     * Check if value is matching a certain type and do type
     * conversion accordingly.
     *
     * @param string $value   the value to check.
     * @param array  $type    the expected type to check against.
     *
     * @return boolean
     */
    private function typeConvertArgument($value, $type)
    {
        switch ($type) {
            case "digit":
                return (int) $value;
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            default:
                return $value;
        }
    }



    /**
     * Match part of rule and query.
     *
     * @param string $rulePart   the rule part to check.
     * @param string $queryPart  the query part to check.
     * @param array  &$args      add argument to args array if matched
     *
     * @return boolean
     */
    private function matchPart($rulePart, $queryPart, &$args)
    {
        $match = false;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $first = isset($rulePart[0]) ? $rulePart[0] : '';
        switch ($first) {
            case '*':
                $match = true;
                break;

            case '{':
                $match = $this->checkPartAsArgument($rulePart, $queryPart, $args);
                break;

            default:
                $match = ($rulePart == $queryPart);
                break;
        }
        return $match;
    }



    /**
     * Check if the request method matches.
     *
     * @param string $method    as request method.
     * @param string $supported as request methods that are valid.
     *
     * @return boolean true if request method matches
     */
    private function matchRequestMethod(
        string $method = null,
        array $supported = null
    ) {
        if ($supported && !in_array($method, $supported)) {
            return false;
        }

        return true;
    }



    /**
     * Check if the route matches a query and request method.
     *
     * @param string $path            of the current route being matched.
     * @param string $query           to match against
     * @param array  $methodSupported as supported request method
     * @param string $method          as request method
     *
     * @return boolean true if query matches the route
     */
    public function match(
        string $path = null,
        string $query,
        array $methodSupported = null,
        string $method = null
    ) {
        $this->arguments = [];
        $this->methodMatched = null;
        $this->pathMatched = null;

        if (!$this->matchRequestMethod($method, $methodSupported)) {
            return false;
        }

        // If any/default */** route, match anything
        if (is_null($path)
            || in_array($path, ["*", "**"])
        ) {
            $this->methodMatched = $method;
            $this->pathMatched = $query;
            return true;
        }

        // Check all parts to see if they matches
        $ruleParts  = explode('/', $path);
        $queryParts = explode('/', $query);
        $ruleCount = max(count($ruleParts), count($queryParts));
        $args = [];

        for ($i = 0; $i < $ruleCount; $i++) {
            $rulePart  = isset($ruleParts[$i])  ? $ruleParts[$i]  : null;
            $queryPart = isset($queryParts[$i]) ? $queryParts[$i] : null;

            if ($rulePart === "**") {
                break;
            }

            if (!$this->matchPart($rulePart, $queryPart, $args)) {
                return false;
            }
        }

        $this->arguments = $args;
        $this->methodMatched = $method;
        $this->pathMatched = $query;
        return true;
    }
}


1			<?php
2
3			namespace Anax\Route;
4
5			use Anax\Commons\ContainerInjectableInterface;
6			use Anax\Route\Exception\ConfigurationException;
7
8			/**
9			* Matching a incoming path to see it it matches a route.
10			*/
11			class RouteMatcher
12			{
13			/**
14			* @var null\|array $arguments arguments for the callback, extracted
15			* from path
16			* @var string $methodMatched the matched method.
17			* @var string $pathMatched the matched path.
18			*/
19			public $arguments = [];
20			public $methodMatched;
21			public $pathMatched;
22
23
24
25			/**
26			* Check if part of route is a argument and optionally match type
27			* as a requirement {argument:type}.
28			*
29			* @param string $rulePart the rule part to check.
30			* @param string $queryPart the query part to check.
31			* @param array &$args add argument to args array if matched
32			*
33			* @return boolean
34			*/
35			private function checkPartAsArgument($rulePart, $queryPart, &$args)
36			{
37			if (substr($rulePart, -1) == "}"
38			&& !is_null($queryPart)
39			) {
40			$part = substr($rulePart, 1, -1);
41			$pos = strpos($part, ":");
42			$type = null;
43			if ($pos !== false) {
44			$type = substr($part, $pos + 1);
45			if (! $this->checkPartMatchingType($queryPart, $type)) {
			0 ignored issues – show Documentation introduced 2017-06-27 09:15 UTC by Report Bug Copy Issue Report `$type` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Bug Best Practice introduced 2017-03-13 17:07 UTC by Report Bug Copy Issue Report The expression `$this->checkPartMatchingType($queryPart, $type)` of type `boolean\|null` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
46			return false;
47			}
48			}
49			$args[] = $this->typeConvertArgument($queryPart, $type);
			0 ignored issues – show Documentation introduced 2017-06-27 15:04 UTC by Report Bug Copy Issue Report `$type` is of type `string\|null`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
50			return true;
51			}
52			return false;
53			}
54
55
56
57			/**
58			* Check if value is matching a certain type of values.
59			*
60			* @param string $value the value to check.
61			* @param array $type the expected type to check against.
62			*
63			* @return boolean
64			*/
65			private function checkPartMatchingType($value, $type)
66			{
67			switch ($type) {
68			case "digit":
69			return ctype_digit($value);
70			break;
			0 ignored issues – show Unused Code introduced 2017-03-13 17:07 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
71
72			case "hex":
73			return ctype_xdigit($value);
74			break;
			0 ignored issues – show Unused Code introduced 2017-04-24 07:31 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
75
76			case "alpha":
77			return ctype_alpha($value);
78			break;
			0 ignored issues – show Unused Code introduced 2017-04-24 07:28 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
79
80			case "alphanum":
81			return ctype_alnum($value);
82			break;
			0 ignored issues – show Unused Code introduced 2017-03-13 17:07 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
83
84			default:
85			return false;
86			}
87			}
88
89
90
91			/**
92			* Check if value is matching a certain type and do type
93			* conversion accordingly.
94			*
95			* @param string $value the value to check.
96			* @param array $type the expected type to check against.
97			*
98			* @return boolean
99			*/
100			private function typeConvertArgument($value, $type)
101			{
102			switch ($type) {
103			case "digit":
104			return (int) $value;
105			break;
			0 ignored issues – show Unused Code introduced 2017-06-27 09:15 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
106
107			default:
108			return $value;
109			}
110			}
111
112
113
114			/**
115			* Match part of rule and query.
116			*
117			* @param string $rulePart the rule part to check.
118			* @param string $queryPart the query part to check.
119			* @param array &$args add argument to args array if matched
120			*
121			* @return boolean
122			*/
123			private function matchPart($rulePart, $queryPart, &$args)
124			{
125			$match = false;
			0 ignored issues – show Unused Code introduced 2017-03-03 15:59 UTC by Report Bug Copy Issue Report `$match` 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...
126			$first = isset($rulePart[0]) ? $rulePart[0] : '';
127			switch ($first) {
128			case '*':
129			$match = true;
130			break;
131
132			case '{':
133			$match = $this->checkPartAsArgument($rulePart, $queryPart, $args);
134			break;
135
136			default:
137			$match = ($rulePart == $queryPart);
138			break;
139			}
140			return $match;
141			}
142
143
144
145			/**
146			* Check if the request method matches.
147			*
148			* @param string $method as request method.
149			* @param string $supported as request methods that are valid.
150			*
151			* @return boolean true if request method matches
152			*/
153			private function matchRequestMethod(
154			string $method = null,
155			array $supported = null
156			) {
157			if ($supported && !in_array($method, $supported)) {
158			return false;
159			}
160
161			return true;
162			}
163
164
165
166			/**
167			* Check if the route matches a query and request method.
168			*
169			* @param string $path of the current route being matched.
170			* @param string $query to match against
171			* @param array $methodSupported as supported request method
172			* @param string $method as request method
173			*
174			* @return boolean true if query matches the route
175			*/
176			public function match(
177			string $path = null,
178			string $query,
179			array $methodSupported = null,
180			string $method = null
181			) {
182			$this->arguments = [];
183			$this->methodMatched = null;
184			$this->pathMatched = null;
185
186			if (!$this->matchRequestMethod($method, $methodSupported)) {
187			return false;
188			}
189
190			// If any/default /* route, match anything
191			if (is_null($path)
192			\|\| in_array($path, ["", "*"])
193			) {
194			$this->methodMatched = $method;
195			$this->pathMatched = $query;
196			return true;
197			}
198
199			// Check all parts to see if they matches
200			$ruleParts = explode('/', $path);
201			$queryParts = explode('/', $query);
202			$ruleCount = max(count($ruleParts), count($queryParts));
203			$args = [];
204
205			for ($i = 0; $i < $ruleCount; $i++) {
206			$rulePart = isset($ruleParts[$i]) ? $ruleParts[$i] : null;
207			$queryPart = isset($queryParts[$i]) ? $queryParts[$i] : null;
208
209			if ($rulePart === "**") {
210			break;
211			}
212
213			if (!$this->matchPart($rulePart, $queryPart, $args)) {
214			return false;
215			}
216			}
217
218			$this->arguments = $args;
219			$this->methodMatched = $method;
220			$this->pathMatched = $query;
221			return true;
222			}
223			}
224

canax / router

Push — master ( 976b6b...f8fb73 )

RouteMatcher A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Duplication Side-by-Side

Filter issues like