RoutingServiceProvider::sanitizeRouteName() - Code Metrics - Inspection of "Make it so that method can be a string" - marcojanssen/silex-routing-service-provider - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

by Miles

created 2016-01-03 12:42 UTC

RoutingServiceProvider::sanitizeRouteName() A

↳ Parent: RoutingServiceProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	3

Metric	Value
c	4
b	0
f	3
dl	0
loc	13
rs	9.4286
cc	2
eloc	6
nc	2
nop	1

<?php
namespace MJanssen\Provider;

use InvalidArgumentException;
use Silex\Application;
use Silex\Controller;
use Silex\Route;
use Silex\ServiceProviderInterface;

/**
 * Class RoutingServiceProvider
 * @package MJanssen\Provider
 */
class RoutingServiceProvider implements ServiceProviderInterface
{
    /**
     * @var
     */
    protected $appRoutingKey;

    /**
     * @param string $appRoutingKey
     */
    public function __construct($appRoutingKey = 'config.routes')
    {
        $this->appRoutingKey = $appRoutingKey;
    }

    /**
     * @param Application $app
     * @throws \InvalidArgumentException
     */
    public function register(Application $app)
    {
        if (isset($app[$this->appRoutingKey])) {
            if (is_array($app[$this->appRoutingKey])) {
                $this->addRoutes($app, $app[$this->appRoutingKey]);
            } else {
                throw new InvalidArgumentException('config.routes must be of type Array');
            }
        }
    }

    /**
     * @param Application $app
     * @codeCoverageIgnore
     */
    public function boot(Application $app)
    {
    }

    /**
     * Adds all routes
     *
     * @param Application $app
     * @param $routes
     */
    public function addRoutes(Application $app, $routes)
    {
        foreach ($routes as $name => $route) {

            if (is_numeric($name)) {
                $name = '';
            }

            $this->addRoute($app, $route, $name);
        }
    }

    /**
     * Adds a route, a given route-name (for named routes) and all of its methods
     *
     * @param Application $app
     * @param array $route
     * @throws InvalidArgumentException
     */
    public function addRoute(Application $app, array $route, $name = '')
    {
        if (isset($route['method']) && is_string($route['method'])) {
            $route['method'] = array($route['method']);
        }

        $this->validateRoute($route);

        if (array_key_exists('name', $route)) {
            $name = $route['name'];
        }

        $controller = $app->match(
            $route['pattern'],
            $route['controller'])
            ->bind(
                $this->sanitizeRouteName($name)
            )->method(
                join('|', array_map('strtoupper', $route['method']))
            );

        $supportedProperties = array('value', 'assert', 'convert', 'before', 'after');
        foreach ($supportedProperties AS $property) {
            if (isset($route[$property])) {
                $this->addActions($controller, $route[$property], $property);
            }
        }

        if (isset($route['scheme'])) {
            if ('https' === $route['scheme']) {
                $controller->requireHttps();
            }
        }
    }

    /**
     * Validates the given methods. Only get, put, post, delete, options, head
     * are allowed
     *
     * @param array $methods
     */
    protected function validateMethods(Array $methods)
    {
        $availableMethods = array('get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'purge', 'options', 'trace', 'connect');
        foreach (array_map('strtolower', $methods) as $method) {
            if (!in_array($method, $availableMethods)) {
                throw new InvalidArgumentException('Method "' . $method . '" is not valid, only the following methods are allowed: ' . join(', ', $availableMethods));
            }
        }
    }

    /**
     * Validates the given $route Array
     *
     * @param $route
     * @throws \InvalidArgumentException
     */
    protected function validateRoute($route)
    {
        if (!isset($route['pattern']) || !isset($route['method']) || !isset($route['controller'])) {
            throw new InvalidArgumentException('Required parameter (pattern/method/controller) is not set.');
        }

        $arrayParameters = array('method', 'assert', 'value');

        foreach ($arrayParameters as $parameter) {
            if (isset($route[$parameter]) && !is_array($route[$parameter])) {
                throw new InvalidArgumentException(sprintf(
                    '%s is not of type Array (%s)',
                    $parameter, gettype($route[$parameter])
                ));
            }
        }

        $this->validateMethods($route['method']);
    }


    /**
     * Sanitizes the routeName for named route:
     *
     * - replaces '/', ':', '|', '-' with '_'
     * - removes special characters
     *
     *  Algorithm copied from \Silex\Controller->generateRouteName
     *  see: https://github.com/silexphp/Silex/blob/1.2/src/Silex/Controller.php
     *
     * @param string $routeName
     * @return string
     */
    protected function sanitizeRouteName($routeName)
    {
        if (empty($routeName)) {
            //If no routeName is specified,
            //we set an empty route name to force the default route name e.g. "GET_myRouteName"
            return '';
        }

        $routeName = str_replace(array('/', ':', '|', '-'), '_', $routeName);
        $routeName = preg_replace('/[^a-z0-9A-Z_.]+/', '', $routeName);

        return $routeName;
    }

    /**
     * @param Controller $controller
     * @param $actions
     * @param $type
     * @throws \InvalidArgumentException
     */
    protected function addActions(Controller $controller, $actions, $type)
    {
        if (!is_array($actions)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Action %s is not of type Array (%s)',
                    $type, gettype($actions)
                )
            );
        }

        foreach ($actions as $name => $value) {
            switch ($type) {
                case 'after':
                    $this->addBeforeAfterMiddleware($controller, $type, $value);
                    break;
                case 'before':
                    $this->addBeforeAfterMiddleware($controller, $type, $value);
                    break;
                default:
                    $this->addAction($controller, $name, $value, $type);
                    break;
            }
        }
    }

    /**
     * @param Controller $controller
     * @param $name
     * @param $value
     * @param $type
     */
    protected function addAction(Controller $controller, $name, $value, $type)
    {
        call_user_func_array(array($controller, $type), array($name, $value));
    }

    protected function isClosure($param)
    {
        return is_object($param) && ($param instanceof \Closure);
    }

    /**
     * Adds a middleware (before/after)
     *
     * @param Controller $controller
     * @param string $type | 'before' or 'after'
     * @param $value
     */
    protected function addBeforeAfterMiddleware(Controller $controller, $type, $value)
    {
        $supportedMWTypes = ['before', 'after'];

        if (!in_array($type, $supportedMWTypes)) {
            throw new \UnexpectedValueException(
                sprintf(
                    'type %s not supported',
                    $type
                )
            );
        }

        if ($this->isClosure($value)) {
            //When a closure is provided, we will just load it as a middleware type
            $controller->$type($value);
        } else {
            //In this case a yaml/xml configuration was used
            $this->addMiddlewareFromConfig($controller, $type, $value);
        }
    }

    /**
     * Adds a before/after middleware by its configuration
     *
     * @param Controller $controller
     * @param $type
     * @param $value
     */
    protected function addMiddlewareFromConfig(Controller $controller, $type, $value)
    {
        if (!is_string($value) || strpos($value, '::') === FALSE) {
            throw new InvalidArgumentException(
                sprintf(
                    '%s is no valid Middleware callback. Please provide the following syntax: NamespaceName\SubNamespaceName\ClassName::methodName',
                    $value
                )
            );
        }

        list($class, $method) = explode('::', $value, 2);

        if ($class && $method) {

            if (!method_exists($class, $method)) {
                throw new \BadMethodCallException(sprintf('Method "%s::%s" does not exist.', $class, $method));
            }

            $controller->$type([new $class, $method]);
        }
    }
}


1			<?php
2			namespace MJanssen\Provider;
3
4			use InvalidArgumentException;
5			use Silex\Application;
6			use Silex\Controller;
7			use Silex\Route;
8			use Silex\ServiceProviderInterface;
9
10			/**
11			* Class RoutingServiceProvider
12			* @package MJanssen\Provider
13			*/
14			class RoutingServiceProvider implements ServiceProviderInterface
15			{
16			/**
17			* @var
18			*/
19			protected $appRoutingKey;
20
21			/**
22			* @param string $appRoutingKey
23			*/
24			public function __construct($appRoutingKey = 'config.routes')
25			{
26			$this->appRoutingKey = $appRoutingKey;
27			}
28
29			/**
30			* @param Application $app
31			* @throws \InvalidArgumentException
32			*/
33			public function register(Application $app)
34			{
35			if (isset($app[$this->appRoutingKey])) {
36			if (is_array($app[$this->appRoutingKey])) {
37			$this->addRoutes($app, $app[$this->appRoutingKey]);
38			} else {
39			throw new InvalidArgumentException('config.routes must be of type Array');
40			}
41			}
42			}
43
44			/**
45			* @param Application $app
46			* @codeCoverageIgnore
47			*/
48			public function boot(Application $app)
49			{
50			}
51
52			/**
53			* Adds all routes
54			*
55			* @param Application $app
56			* @param $routes
57			*/
58			public function addRoutes(Application $app, $routes)
59			{
60			foreach ($routes as $name => $route) {
61
62			if (is_numeric($name)) {
63			$name = '';
64			}
65
66			$this->addRoute($app, $route, $name);
67			}
68			}
69
70			/**
71			* Adds a route, a given route-name (for named routes) and all of its methods
72			*
73			* @param Application $app
74			* @param array $route
75			* @throws InvalidArgumentException
76			*/
77			public function addRoute(Application $app, array $route, $name = '')
78			{
79			if (isset($route['method']) && is_string($route['method'])) {
80			$route['method'] = array($route['method']);
81			}
82
83			$this->validateRoute($route);
84
85			if (array_key_exists('name', $route)) {
86			$name = $route['name'];
87			}
88
89			$controller = $app->match(
90			$route['pattern'],
91			$route['controller'])
92			->bind(
93			$this->sanitizeRouteName($name)
94			)->method(
95			join('\|', array_map('strtoupper', $route['method']))
96			);
97
98			$supportedProperties = array('value', 'assert', 'convert', 'before', 'after');
99			foreach ($supportedProperties AS $property) {
100			if (isset($route[$property])) {
101			$this->addActions($controller, $route[$property], $property);
102			}
103			}
104
105			if (isset($route['scheme'])) {
106			if ('https' === $route['scheme']) {
107			$controller->requireHttps();
108			}
109			}
110			}
111
112			/**
113			* Validates the given methods. Only get, put, post, delete, options, head
114			* are allowed
115			*
116			* @param array $methods
117			*/
118			protected function validateMethods(Array $methods)
119			{
120			$availableMethods = array('get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'purge', 'options', 'trace', 'connect');
121			foreach (array_map('strtolower', $methods) as $method) {
122			if (!in_array($method, $availableMethods)) {
123			throw new InvalidArgumentException('Method "' . $method . '" is not valid, only the following methods are allowed: ' . join(', ', $availableMethods));
124			}
125			}
126			}
127
128			/**
129			* Validates the given $route Array
130			*
131			* @param $route
132			* @throws \InvalidArgumentException
133			*/
134			protected function validateRoute($route)
135			{
136			if (!isset($route['pattern']) \|\| !isset($route['method']) \|\| !isset($route['controller'])) {
137			throw new InvalidArgumentException('Required parameter (pattern/method/controller) is not set.');
138			}
139
140			$arrayParameters = array('method', 'assert', 'value');
141
142			foreach ($arrayParameters as $parameter) {
143			if (isset($route[$parameter]) && !is_array($route[$parameter])) {
144			throw new InvalidArgumentException(sprintf(
145			'%s is not of type Array (%s)',
146			$parameter, gettype($route[$parameter])
147			));
148			}
149			}
150
151			$this->validateMethods($route['method']);
152			}
153
154
155			/**
156			* Sanitizes the routeName for named route:
157			*
158			* - replaces '/', ':', '\|', '-' with '_'
159			* - removes special characters
160			*
161			* Algorithm copied from \Silex\Controller->generateRouteName
162			* see: https://github.com/silexphp/Silex/blob/1.2/src/Silex/Controller.php
163			*
164			* @param string $routeName
165			* @return string
166			*/
167			protected function sanitizeRouteName($routeName)
168			{
169			if (empty($routeName)) {
170			//If no routeName is specified,
171			//we set an empty route name to force the default route name e.g. "GET_myRouteName"
172			return '';
173			}
174
175			$routeName = str_replace(array('/', ':', '\|', '-'), '_', $routeName);
176			$routeName = preg_replace('/[^a-z0-9A-Z_.]+/', '', $routeName);
177
178			return $routeName;
179			}
180
181			/**
182			* @param Controller $controller
183			* @param $actions
184			* @param $type
185			* @throws \InvalidArgumentException
186			*/
187			protected function addActions(Controller $controller, $actions, $type)
188			{
189			if (!is_array($actions)) {
190			throw new InvalidArgumentException(
191			sprintf(
192			'Action %s is not of type Array (%s)',
193			$type, gettype($actions)
194			)
195			);
196			}
197
198			foreach ($actions as $name => $value) {
199			switch ($type) {
200			case 'after':
201			$this->addBeforeAfterMiddleware($controller, $type, $value);
202			break;
203			case 'before':
204			$this->addBeforeAfterMiddleware($controller, $type, $value);
205			break;
206			default:
207			$this->addAction($controller, $name, $value, $type);
208			break;
209			}
210			}
211			}
212
213			/**
214			* @param Controller $controller
215			* @param $name
216			* @param $value
217			* @param $type
218			*/
219			protected function addAction(Controller $controller, $name, $value, $type)
220			{
221			call_user_func_array(array($controller, $type), array($name, $value));
222			}
223
224			protected function isClosure($param)
225			{
226			return is_object($param) && ($param instanceof \Closure);
227			}
228
229			/**
230			* Adds a middleware (before/after)
231			*
232			* @param Controller $controller
233			* @param string $type \| 'before' or 'after'
234			* @param $value
235			*/
236			protected function addBeforeAfterMiddleware(Controller $controller, $type, $value)
237			{
238			$supportedMWTypes = ['before', 'after'];
239
240			if (!in_array($type, $supportedMWTypes)) {
241			throw new \UnexpectedValueException(
242			sprintf(
243			'type %s not supported',
244			$type
245			)
246			);
247			}
248
249			if ($this->isClosure($value)) {
250			//When a closure is provided, we will just load it as a middleware type
251			$controller->$type($value);
252			} else {
253			//In this case a yaml/xml configuration was used
254			$this->addMiddlewareFromConfig($controller, $type, $value);
255			}
256			}
257
258			/**
259			* Adds a before/after middleware by its configuration
260			*
261			* @param Controller $controller
262			* @param $type
263			* @param $value
264			*/
265			protected function addMiddlewareFromConfig(Controller $controller, $type, $value)
266			{
267			if (!is_string($value) \|\| strpos($value, '::') === FALSE) {
268			throw new InvalidArgumentException(
269			sprintf(
270			'%s is no valid Middleware callback. Please provide the following syntax: NamespaceName\SubNamespaceName\ClassName::methodName',
271			$value
272			)
273			);
274			}
275
276			list($class, $method) = explode('::', $value, 2);
277
278			if ($class && $method) {
279
280			if (!method_exists($class, $method)) {
281			throw new \BadMethodCallException(sprintf('Method "%s::%s" does not exist.', $class, $method));
282			}
283
284			$controller->$type([new $class, $method]);
285			}
286			}
287			}
288

marcojanssen / silex-routing-service-provider

Pull Request — master (#10)

RoutingServiceProvider::sanitizeRouteName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like