RouteConfig::buildActionName() - Code Metrics - Inspection of "OCS routes to appframework (#24886)" - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a84fba...e8b4d4 )

by Thomas

created 2016-10-11 22:13 UTC

RouteConfig::buildActionName() A

↳ Parent: RouteConfig

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * @author Bernhard Posselt <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Patrick Paysant <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Robin McCorkell <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 * @author Thomas Müller <[email protected]>
 *
 * @copyright Copyright (c) 2016, ownCloud GmbH.
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\AppFramework\Routing;

use OC\AppFramework\DependencyInjection\DIContainer;
use OCP\Route\IRouter;

/**
 * Class RouteConfig
 * @package OC\AppFramework\routing
 */
class RouteConfig {
	/** @var DIContainer */
	private $container;
	/** @var IRouter */
	private $router;
	/** @var array */
	private $routes;
	/** @var string */
	private $appName;

	/**
	 * @param \OC\AppFramework\DependencyInjection\DIContainer $container
	 * @param \OCP\Route\IRouter $router
	 * @param $routes
	 * @internal param $appName
	 */
	public function __construct(DIContainer $container, IRouter $router, $routes) {
		$this->routes = $routes;
		$this->container = $container;
		$this->router = $router;
		$this->appName = $container['AppName'];
	}

	/**
	 * The routes and resource will be registered to the \OCP\Route\IRouter
	 */
	public function register() {

		// parse simple
		$this->processSimpleRoutes($this->routes);

		// parse resources
		$this->processResources($this->routes);

		/*
		 * OCS routes go into a different collection
		 */
		$oldCollection = $this->router->getCurrentCollection();
		$this->router->useCollection($oldCollection.'.ocs');

		// parse ocs simple routes
		$this->processOCS($this->routes);

		$this->router->useCollection($oldCollection);
	}

	private function processOCS(array $routes) {
		$ocsRoutes = isset($routes['ocs']) ? $routes['ocs'] : [];
		foreach ($ocsRoutes as $ocsRoute) {
			$name = $ocsRoute['name'];
			$postFix = '';

			if (isset($ocsRoute['postfix'])) {
				$postFix = $ocsRoute['postfix'];
			}

			$url = $ocsRoute['url'];
			$verb = isset($ocsRoute['verb']) ? strtoupper($ocsRoute['verb']) : 'GET';

			$split = explode('#', $name, 2);
			if (count($split) != 2) {
				throw new \UnexpectedValueException('Invalid route name');
			}
			$controller = $split[0];
			$action = $split[1];

			$controllerName = $this->buildControllerName($controller);
			$actionName = $this->buildActionName($action);

			// register the route
			$handler = new RouteActionHandler($this->container, $controllerName, $actionName);

			$router = $this->router->create('ocs.'.$this->appName.'.'.$controller.'.'.$action . $postFix, $url)
				->method($verb)
				->action($handler);

			// optionally register requirements for route. This is used to
			// tell the route parser how url parameters should be matched
			if(array_key_exists('requirements', $ocsRoute)) {
				$router->requirements($ocsRoute['requirements']);
			}

			// optionally register defaults for route. This is used to
			// tell the route parser how url parameters should be default valued
			if(array_key_exists('defaults', $ocsRoute)) {
				$router->defaults($ocsRoute['defaults']);
			}
		}
	}

	/**
	 * Creates one route base on the give configuration
	 * @param array $routes
	 * @throws \UnexpectedValueException
	 */
	private function processSimpleRoutes($routes)
	{
		$simpleRoutes = isset($routes['routes']) ? $routes['routes'] : [];
		foreach ($simpleRoutes as $simpleRoute) {
			$name = $simpleRoute['name'];
			$postfix = '';

			if (isset($simpleRoute['postfix'])) {
				$postfix = $simpleRoute['postfix'];
			}

			$url = $simpleRoute['url'];
			$verb = isset($simpleRoute['verb']) ? strtoupper($simpleRoute['verb']) : 'GET';

			$split = explode('#', $name, 2);
			if (count($split) != 2) {
				throw new \UnexpectedValueException('Invalid route name');
			}
			$controller = $split[0];
			$action = $split[1];

			$controllerName = $this->buildControllerName($controller);
			$actionName = $this->buildActionName($action);

			// register the route
			$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
			$router = $this->router->create($this->appName.'.'.$controller.'.'.$action . $postfix, $url)
							->method($verb)
							->action($handler);

			// optionally register requirements for route. This is used to
			// tell the route parser how url parameters should be matched
			if(array_key_exists('requirements', $simpleRoute)) {
				$router->requirements($simpleRoute['requirements']);
			}

			// optionally register defaults for route. This is used to
			// tell the route parser how url parameters should be default valued
			if(array_key_exists('defaults', $simpleRoute)) {
				$router->defaults($simpleRoute['defaults']);
			}
		}
	}

	/**
	 * For a given name and url restful routes are created:
	 *  - index
	 *  - show
	 *  - new
	 *  - create
	 *  - update
	 *  - destroy
	 *
	 * @param array $routes
	 */
	private function processResources($routes)
	{
		// declaration of all restful actions
		$actions = [
			['name' => 'index', 'verb' => 'GET', 'on-collection' => true],
			['name' => 'show', 'verb' => 'GET'],
			['name' => 'create', 'verb' => 'POST', 'on-collection' => true],
			['name' => 'update', 'verb' => 'PUT'],
			['name' => 'destroy', 'verb' => 'DELETE'],
		];

		$resources = isset($routes['resources']) ? $routes['resources'] : [];
		foreach ($resources as $resource => $config) {

			// the url parameter used as id to the resource
			foreach($actions as $action) {
				$url = $config['url'];
				$method = $action['name'];
				$verb = isset($action['verb']) ? strtoupper($action['verb']) : 'GET';
				$collectionAction = isset($action['on-collection']) ? $action['on-collection'] : false;
				if (!$collectionAction) {
					$url = $url . '/{id}';
				}
				if (isset($action['url-postfix'])) {
					$url = $url . '/' . $action['url-postfix'];
				}

				$controller = $resource;

				$controllerName = $this->buildControllerName($controller);
				$actionName = $this->buildActionName($method);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

				$routeName = $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);

				$this->router->create($routeName, $url)->method($verb)->action(
					new RouteActionHandler($this->container, $controllerName, $actionName)
				);
			}
		}
	}

	/**
	 * Based on a given route name the controller name is generated
	 * @param string $controller
	 * @return string
	 */
	private function buildControllerName($controller)
	{
		return $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
	}

	/**
	 * Based on the action part of the route name the controller method name is generated
	 * @param string $action
	 * @return string
	 */
	private function buildActionName($action) {
		return $this->underScoreToCamelCase($action);
	}

	/**
	 * Underscored strings are converted to camel case strings
	 * @param string $str
	 * @return string
	 */
	private function underScoreToCamelCase($str) {
		$pattern = "/_[a-z]?/";
		return preg_replace_callback(
			$pattern,
			function ($matches) {
				return strtoupper(ltrim($matches[0], "_"));
			},
			$str);
	}
}


1		<?php
2		/**
3		* @author Bernhard Posselt <[email protected]>
4		* @author Morris Jobke <[email protected]>
5		* @author Patrick Paysant <[email protected]>
6		* @author Robin Appelman <[email protected]>
7		* @author Robin McCorkell <[email protected]>
8		* @author Roeland Jago Douma <[email protected]>
9		* @author Thomas Müller <[email protected]>
10		*
11		* @copyright Copyright (c) 2016, ownCloud GmbH.
12		* @license AGPL-3.0
13		*
14		* This code is free software: you can redistribute it and/or modify
15		* it under the terms of the GNU Affero General Public License, version 3,
16		* as published by the Free Software Foundation.
17		*
18		* This program is distributed in the hope that it will be useful,
19		* but WITHOUT ANY WARRANTY; without even the implied warranty of
20		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21		* GNU Affero General Public License for more details.
22		*
23		* You should have received a copy of the GNU Affero General Public License, version 3,
24		* along with this program. If not, see <http://www.gnu.org/licenses/>
25		*
26		*/
27
28		namespace OC\AppFramework\Routing;
29
30		use OC\AppFramework\DependencyInjection\DIContainer;
31		use OCP\Route\IRouter;
32
33		/**
34		* Class RouteConfig
35		* @package OC\AppFramework\routing
36		*/
37		class RouteConfig {
38		/** @var DIContainer */
39		private $container;
40		/** @var IRouter */
41		private $router;
42		/** @var array */
43		private $routes;
44		/** @var string */
45		private $appName;
46
47		/**
48		* @param \OC\AppFramework\DependencyInjection\DIContainer $container
49		* @param \OCP\Route\IRouter $router
50		* @param $routes
51		* @internal param $appName
52		*/
53		public function __construct(DIContainer $container, IRouter $router, $routes) {
54		$this->routes = $routes;
55		$this->container = $container;
56		$this->router = $router;
57		$this->appName = $container['AppName'];
58		}
59
60		/**
61		* The routes and resource will be registered to the \OCP\Route\IRouter
62		*/
63		public function register() {
64
65		// parse simple
66		$this->processSimpleRoutes($this->routes);
67
68		// parse resources
69		$this->processResources($this->routes);
70
71		/*
72		* OCS routes go into a different collection
73		*/
74		$oldCollection = $this->router->getCurrentCollection();
75		$this->router->useCollection($oldCollection.'.ocs');
76
77		// parse ocs simple routes
78		$this->processOCS($this->routes);
79
80		$this->router->useCollection($oldCollection);
81		}
82
83	View Code Duplication	private function processOCS(array $routes) {
84		$ocsRoutes = isset($routes['ocs']) ? $routes['ocs'] : [];
85		foreach ($ocsRoutes as $ocsRoute) {
86		$name = $ocsRoute['name'];
87		$postFix = '';
88
89		if (isset($ocsRoute['postfix'])) {
90		$postFix = $ocsRoute['postfix'];
91		}
92
93		$url = $ocsRoute['url'];
94		$verb = isset($ocsRoute['verb']) ? strtoupper($ocsRoute['verb']) : 'GET';
95
96		$split = explode('#', $name, 2);
97		if (count($split) != 2) {
98		throw new \UnexpectedValueException('Invalid route name');
99		}
100		$controller = $split[0];
101		$action = $split[1];
102
103		$controllerName = $this->buildControllerName($controller);
104		$actionName = $this->buildActionName($action);
105
106		// register the route
107		$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
108
109		$router = $this->router->create('ocs.'.$this->appName.'.'.$controller.'.'.$action . $postFix, $url)
110		->method($verb)
111		->action($handler);
112
113		// optionally register requirements for route. This is used to
114		// tell the route parser how url parameters should be matched
115		if(array_key_exists('requirements', $ocsRoute)) {
116		$router->requirements($ocsRoute['requirements']);
117		}
118
119		// optionally register defaults for route. This is used to
120		// tell the route parser how url parameters should be default valued
121		if(array_key_exists('defaults', $ocsRoute)) {
122		$router->defaults($ocsRoute['defaults']);
123		}
124		}
125		}
126
127		/**
128		* Creates one route base on the give configuration
129		* @param array $routes
130		* @throws \UnexpectedValueException
131		*/
132	View Code Duplication	private function processSimpleRoutes($routes)
133		{
134		$simpleRoutes = isset($routes['routes']) ? $routes['routes'] : [];
135		foreach ($simpleRoutes as $simpleRoute) {
136		$name = $simpleRoute['name'];
137		$postfix = '';
138
139		if (isset($simpleRoute['postfix'])) {
140		$postfix = $simpleRoute['postfix'];
141		}
142
143		$url = $simpleRoute['url'];
144		$verb = isset($simpleRoute['verb']) ? strtoupper($simpleRoute['verb']) : 'GET';
145
146		$split = explode('#', $name, 2);
147		if (count($split) != 2) {
148		throw new \UnexpectedValueException('Invalid route name');
149		}
150		$controller = $split[0];
151		$action = $split[1];
152
153		$controllerName = $this->buildControllerName($controller);
154		$actionName = $this->buildActionName($action);
155
156		// register the route
157		$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
158		$router = $this->router->create($this->appName.'.'.$controller.'.'.$action . $postfix, $url)
159		->method($verb)
160		->action($handler);
161
162		// optionally register requirements for route. This is used to
163		// tell the route parser how url parameters should be matched
164		if(array_key_exists('requirements', $simpleRoute)) {
165		$router->requirements($simpleRoute['requirements']);
166		}
167
168		// optionally register defaults for route. This is used to
169		// tell the route parser how url parameters should be default valued
170		if(array_key_exists('defaults', $simpleRoute)) {
171		$router->defaults($simpleRoute['defaults']);
172		}
173		}
174		}
175
176		/**
177		* For a given name and url restful routes are created:
178		* - index
179		* - show
180		* - new
181		* - create
182		* - update
183		* - destroy
184		*
185		* @param array $routes
186		*/
187		private function processResources($routes)
188		{
189		// declaration of all restful actions
190		$actions = [
191		['name' => 'index', 'verb' => 'GET', 'on-collection' => true],
192		['name' => 'show', 'verb' => 'GET'],
193		['name' => 'create', 'verb' => 'POST', 'on-collection' => true],
194		['name' => 'update', 'verb' => 'PUT'],
195		['name' => 'destroy', 'verb' => 'DELETE'],
196		];
197
198		$resources = isset($routes['resources']) ? $routes['resources'] : [];
199		foreach ($resources as $resource => $config) {
200
201		// the url parameter used as id to the resource
202		foreach($actions as $action) {
203		$url = $config['url'];
204		$method = $action['name'];
205		$verb = isset($action['verb']) ? strtoupper($action['verb']) : 'GET';
206		$collectionAction = isset($action['on-collection']) ? $action['on-collection'] : false;
207		if (!$collectionAction) {
208		$url = $url . '/{id}';
209		}
210		if (isset($action['url-postfix'])) {
211		$url = $url . '/' . $action['url-postfix'];
212		}
213
214		$controller = $resource;
215
216		$controllerName = $this->buildControllerName($controller);
217		$actionName = $this->buildActionName($method);
		0 ignored issues – show Bug introduced 2016-04-22 13:57 UTC by Report Bug Copy Issue Report It seems like `$method` defined by `$action['name']` on line `204` can also be of type `boolean`; however, `OC\AppFramework\Routing\...nfig::buildActionName()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
218
219		$routeName = $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
220
221		$this->router->create($routeName, $url)->method($verb)->action(
222		new RouteActionHandler($this->container, $controllerName, $actionName)
223		);
224		}
225		}
226		}
227
228		/**
229		* Based on a given route name the controller name is generated
230		* @param string $controller
231		* @return string
232		*/
233		private function buildControllerName($controller)
234		{
235		return $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
236		}
237
238		/**
239		* Based on the action part of the route name the controller method name is generated
240		* @param string $action
241		* @return string
242		*/
243		private function buildActionName($action) {
244		return $this->underScoreToCamelCase($action);
245		}
246
247		/**
248		* Underscored strings are converted to camel case strings
249		* @param string $str
250		* @return string
251		*/
252		private function underScoreToCamelCase($str) {
253		$pattern = "/_[a-z]?/";
254		return preg_replace_callback(
255		$pattern,
256		function ($matches) {
257		return strtoupper(ltrim($matches[0], "_"));
258		},
259		$str);
260		}
261		}
262

owncloud / core

Push — master ( a84fba...e8b4d4 )

RouteConfig::buildActionName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like