RouteFactory::makeRoute() - Code Metrics - Inspection of "add controller to list all available resources" - Innmind/RestServerBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( dd6a23...99c8cd )

by Baptiste

created 2016-07-02 15:55 UTC

RouteFactory::makeRoute() C

↳ Parent: RouteFactory

Complexity

Conditions	9
Paths	9

Size

Total Lines	52
Code Lines	41

Duplication

Lines	10
Ratio	19.23 %

Code Coverage

Tests	42
CRAP Score	9

Importance

Changes

Metric	Value
dl	10
loc	52
ccs	42
cts	42
cp	1
rs	6.5703
c	0
b	0
f	0
cc	9
eloc	41
nc	9
nop	2
crap	9

How to fix Long Method

<?php
declare(strict_types = 1);

namespace Innmind\Rest\ServerBundle\Routing;

use Innmind\Rest\Server\Action;
use Innmind\Http\Message\MethodInterface;
use Innmind\Immutable\StringPrimitive as Str;
use Symfony\Component\Routing\Route;

final class RouteFactory
{
    /**
     * Make a route name
     *
     * @param string $path Path to resource definition
     * @param Action $action
     *
     * @return string
     */
    public function makeName(string $path, Action $action): string
    {
        return (string) (new Str($path))
            ->prepend('innmind_rest_server.')
            ->append('.')
            ->append((string) $action);
    }

    /**
     * Make a route
     *
     * @param string $path Path to resource definition
     * @param Action $action
     *
     * @return Route
     */
    public function makeRoute(string $path, Action $action): Route
    {
        $name = $path;
        $path = (new Str($path))->replace('.', '/')->append('/');
        $condition = '';

        switch ((string) $action) {
            case Action::GET:
                $path = $path->append('{identity}');
            case Action::LIST:
                $method = MethodInterface::GET;
                break;
            case Action::CREATE:
                $method = MethodInterface::POST;
                break;
            case Action::UPDATE:
                $method = MethodInterface::PUT;
                $path = $path->append('{identity}');
                break;
            case Action::REMOVE:
                $method = MethodInterface::DELETE;
                $path = $path->append('{identity}');
                break;
            case Action::LINK:

                $method = MethodInterface::LINK;
                $path = $path->append('{identity}');
                $condition = 'request.headers.has(\'Link\')';
                break;
            case Action::UNLINK:

                $method = MethodInterface::UNLINK;
                $path = $path->append('{identity}');
                $condition = 'request.headers.has(\'Link\')';
                break;
            case Action::OPTIONS:
                $method = MethodInterface::OPTIONS;
                break;
        }

        return new Route(
            (string) $path,
            [
                '_innmind_resource' => $name,
                '_innmind_action' => (string) $action,
            ],
            [],
            [],
            '',
            [],
            $method,
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            $condition
        );
    }
}


1			<?php
2			declare(strict_types = 1);
3
4			namespace Innmind\Rest\ServerBundle\Routing;
5
6			use Innmind\Rest\Server\Action;
7			use Innmind\Http\Message\MethodInterface;
8			use Innmind\Immutable\StringPrimitive as Str;
9			use Symfony\Component\Routing\Route;
10
11			final class RouteFactory
12			{
13			/**
14			* Make a route name
15			*
16			* @param string $path Path to resource definition
17			* @param Action $action
18			*
19			* @return string
20			*/
21	3		public function makeName(string $path, Action $action): string
22			{
23	3		return (string) (new Str($path))
24	3		->prepend('innmind_rest_server.')
25	3		->append('.')
26	3		->append((string) $action);
27			}
28
29			/**
30			* Make a route
31			*
32			* @param string $path Path to resource definition
33			* @param Action $action
34			*
35			* @return Route
36			*/
37	11		public function makeRoute(string $path, Action $action): Route
38			{
39	11		$name = $path;
40	11		$path = (new Str($path))->replace('.', '/')->append('/');
41	11		$condition = '';
42
43	11		switch ((string) $action) {
44	11		case Action::GET:
45	3		$path = $path->append('{identity}');
46	10		case Action::LIST:
47	4		$method = MethodInterface::GET;
48	4		break;
49	9		case Action::CREATE:
50	3		$method = MethodInterface::POST;
51	3		break;
52	8		case Action::UPDATE:
53	3		$method = MethodInterface::PUT;
54	3		$path = $path->append('{identity}');
55	3		break;
56	7		case Action::REMOVE:
57	3		$method = MethodInterface::DELETE;
58	3		$path = $path->append('{identity}');
59	3		break;
60	6	View Code Duplication	case Action::LINK:
			1 ignored issue – show Duplication introduced 2016-07-02 16:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
61	3		$method = MethodInterface::LINK;
62	3		$path = $path->append('{identity}');
63	3		$condition = 'request.headers.has(\'Link\')';
64	3		break;
65	5	View Code Duplication	case Action::UNLINK:
			1 ignored issue – show Duplication introduced 2016-07-02 16:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
66	3		$method = MethodInterface::UNLINK;
67	3		$path = $path->append('{identity}');
68	3		$condition = 'request.headers.has(\'Link\')';
69	3		break;
70	4		case Action::OPTIONS:
71	4		$method = MethodInterface::OPTIONS;
72	4		break;
73			}
74
75	11		return new Route(
76	11		(string) $path,
77			[
78	11		'_innmind_resource' => $name,
79	11		'_innmind_action' => (string) $action,
80			],
81	11		[],
82	11		[],
83	11		'',
84	11		[],
85			$method,
			1 ignored issue – show Bug introduced 2016-07-02 16:01 UTC by Report Bug Copy Issue Report The variable `$method` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
86			$condition
87			);
88			}
89			}
90

Innmind / RestServerBundle

Push — develop ( dd6a23...99c8cd )

RouteFactory::makeRoute() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like