ApiDocs::isExcluded() - Code Metrics - Inspection of "Exclude list of routes/classes" - Cherry-Pie/ApiDocs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dc98f7...630443 )

by Yaro

created 2017-08-31 09:36 UTC

ApiDocs::isExcluded() A

↳ Parent: ApiDocs

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	2
eloc	4
nc	2
nop	1

<?php 

namespace Yaro\ApiDocs;

use ReflectionClass;
use Illuminate\Routing\Router;
use Illuminate\Contracts\Config\Repository as Config;
use Yaro\ApiDocs\Blueprint;

class ApiDocs
{
    
    private $router;
    private $config;
    
    public function __construct(Router $router, Config $config)
    {
        $this->router = $router;
        $this->config = $config;
    } // end __construct

    public function show()
    {
        $endpoints = $this->getEndpoints();
        $endpoints = $this->getSortedEndpoints($endpoints);
        
        return view('apidocs::docs', compact('endpoints'));
    } // end show

    public function blueprint()
    {
        $blueprint = app()->make(Blueprint::class);
        $blueprint->setEndpoints($this->getEndpoints());
        
        return $blueprint;
    } // end blueprint
    
    private function getEndpoints()
    {
        $endpoints = [];
        
        foreach ($this->router->getRoutes() as $route) {
            if (!$this->isPrefixedRoute($route) || $this->isClosureRoute($route) || $this->isExcluded($route)) {
                continue;
            }
            
            $actionController = explode("@", $this->getRouteParam($route, 'action.controller'));
            $class  = $actionController[0];
            $method = $actionController[1];
            
            if (!class_exists($class) || !method_exists($class, $method)) {
                continue;
            }
            
            list($title, $description, $params) = $this->getRouteDocBlock($class, $method);
            $key = $this->generateEndpointKey($class);
            
            $endpoints[$key][] = [
                'hash'    => $this->generateHashForUrl($key, $route, $method),
                'uri'     => $this->getRouteParam($route, 'uri'),
                'name'    => $method,
                'methods' => $this->getRouteParam($route, 'methods'),
                'docs' => [
                    'title'       => $title, 
                    'description' => trim($description), 
                    'params'      => $params,
                    'uri_params'  => $this->getUriParams($route),
                ],
            ];
        }
        
        return $endpoints;
    } // end getEndpoints
    
    private function isExcluded($route)
    {
        $uri = $this->getRouteParam($route, 'uri');
        $actionController = $this->getRouteParam($route, 'action.controller');
        
        return $this->isExcludedClass($actionController) || $this->isExcludedRoute($uri);
    } // end isExcluded
    
    private function isExcludedRoute($uri)
    {
        foreach ($this->config->get('yaro.apidocs.exclude.routes', []) as $pattern) {
            if (str_is($pattern, $uri)) {
                return true;
            }
        }
        
        return false;
    } // end isExcludedRoute
    
    private function isExcludedClass($actionController)
    {
        foreach ($this->config->get('yaro.apidocs.exclude.classes', []) as $pattern) {
            if (str_is($pattern, $actionController)) {
                return true;
            }
        }
        
        return false;
    } // end isExcludedClass
    
    private function isPrefixedRoute($route)
    {
        $prefix = $this->config->get('yaro.apidocs.prefix', 'api');
        $regexp = '~^'. preg_quote($prefix) .'~';
        
        return preg_match($regexp, $this->getRouteParam($route, 'uri'));
    } // end isPrefixedRoute
    
    private function isClosureRoute($route)
    {
        $action = $this->getRouteParam($route, 'action.uses');
        
        return is_object($action);
    } // end isClosureRoute
    
    private function getRouteDocBlock($class, $method)
    {
        $reflector = new ReflectionClass($class);
        
        $title = implode(' ', $this->splitCamelCaseToWords($method));
        $title = ucfirst(strtolower($title));
        $description = '';
        $params = [];
            
        $docs = explode("\n", $reflector->getMethod($method)->getDocComment());
        $docs = array_filter($docs);
        if (!$docs) {

            return [$title, $description, $params];
        }
        
        $docs = $this->filterDocBlock($docs);
        
        $title = array_shift($docs);
        
        $checkForLongDescription = true;
        foreach ($docs as $line) {
            if ($checkForLongDescription && !preg_match('~^@\w+~', $line)) {
                $description .= trim($line) .' ';
            } elseif (preg_match('~^@\w+~', $line)) {
                $checkForLongDescription = false;
                if (preg_match('~^@param~', $line)) {
                    $paramChunks = $this->getParamChunksFromLine($line);
                    
                    $paramType = array_shift($paramChunks);
                    $paramName = substr(array_shift($paramChunks), 1);
                    $params[$paramName] = [
                        'type'        => $paramType,
                        'name'        => $paramName,
                        'description' => implode(' ', $paramChunks),
                    ];
                }
            }
        }
        
        return [$title, $description, $params];
    } // end getRouteDocBlock
    
    private function getParamChunksFromLine($line)
    {
        $paramChunks = explode(' ', $line);
        $paramChunks = array_filter($paramChunks, function($val) {
            return $val !== '';
        });
        unset($paramChunks[0]);
        
        return $paramChunks;
    } // end getParamChunksFromLine
    
    private function filterDocBlock($docs)
    {
        foreach ($docs as &$line) {
            $line = preg_replace('~\s*\*\s*~', '', $line);
            $line = preg_replace('~^/$~', '', $line);
        }
        $docs = array_values(array_filter($docs));
        
        return $docs;
    } // end filterDocBlock
    
    private function generateEndpointKey($class)
    {
        $disabledNamespaces = $this->config->get('yaro.apidocs.disabled_namespaces', []);
        
        $chunks = explode('\\', $class);
        foreach ($chunks as $index => $chunk) {
            if (in_array($chunk, $disabledNamespaces)) {
                unset($chunks[$index]);
                continue;
            }
            
            $chunk = preg_replace('~Controller$~', '', $chunk);
            if ($chunk) {
                $chunk = $this->splitCamelCaseToWords($chunk);
                $chunks[$index] = implode(' ', $chunk);
            }
        }
           
        return implode('.', $chunks);
    } // end generateEndpointKey
    
    private function getSortedEndpoints($endpoints)
    {
        ksort($endpoints);

        $sorted = array();
        foreach ($endpoints as $key => $val) {
            $this->ins($sorted, explode('.', $key), $val);
        }
        
        return $sorted;
    } // end getSortedEndpoints
    
    private function getUriParams($route)
    {
        preg_match_all('~{(\w+)}~', $this->getRouteParam($route, 'uri'), $matches);
        
        return isset($matches[1]) ? $matches[1] : [];
    } // end getUriParams
    
    private function generateHashForUrl($key, $route, $method)
    {
        $path = preg_replace('~\s+~', '-', $key);
        $httpMethod = $this->getRouteParam($route, 'methods.0');
        $classMethod = implode('-', $this->splitCamelCaseToWords($method));
        
        $hash = $path .'::'. $httpMethod .'::'. $classMethod;
        
        return strtolower($hash);
    } // end generateHashForUrl
    
    private function splitCamelCaseToWords($chunk)
    {
        $splitCamelCaseRegexp = '/(?#! splitCamelCase Rev:20140412)
            # Split camelCase "words". Two global alternatives. Either g1of2:
              (?<=[a-z])      # Position is after a lowercase,
              (?=[A-Z])       # and before an uppercase letter.
            | (?<=[A-Z])      # Or g2of2; Position is after uppercase,
              (?=[A-Z][a-z])  # and before upper-then-lower case.
            /x';
            
        return preg_split($splitCamelCaseRegexp, $chunk);
    } // end splitCamelCaseToWords
    
    private function getRouteParam($route, $param)
    {
        $route = (array) $route;
        $prefix = chr(0).'*'.chr(0);
        
        return array_get(
            $route, 
            $prefix.$param, 
            array_get($route, $param)
        );
    } // end getRouteParam
    
    private function ins(&$ary, $keys, $val) 
    {
        $keys ? 
            $this->ins($ary[array_shift($keys)], $keys, $val) :
            $ary = $val;
    } // end ins
    
}


1			<?php
2
3			namespace Yaro\ApiDocs;
4
5			use ReflectionClass;
6			use Illuminate\Routing\Router;
7			use Illuminate\Contracts\Config\Repository as Config;
8			use Yaro\ApiDocs\Blueprint;
9
10			class ApiDocs
11			{
12
13			private $router;
14			private $config;
15
16			public function __construct(Router $router, Config $config)
17			{
18			$this->router = $router;
19			$this->config = $config;
20			} // end __construct
21
22			public function show()
23			{
24			$endpoints = $this->getEndpoints();
25			$endpoints = $this->getSortedEndpoints($endpoints);
26
27			return view('apidocs::docs', compact('endpoints'));
28			} // end show
29
30			public function blueprint()
31			{
32			$blueprint = app()->make(Blueprint::class);
33			$blueprint->setEndpoints($this->getEndpoints());
34
35			return $blueprint;
36			} // end blueprint
37
38			private function getEndpoints()
39			{
40			$endpoints = [];
41
42			foreach ($this->router->getRoutes() as $route) {
43			if (!$this->isPrefixedRoute($route) \|\| $this->isClosureRoute($route) \|\| $this->isExcluded($route)) {
44			continue;
45			}
46
47			$actionController = explode("@", $this->getRouteParam($route, 'action.controller'));
48			$class = $actionController[0];
49			$method = $actionController[1];
50
51			if (!class_exists($class) \|\| !method_exists($class, $method)) {
52			continue;
53			}
54
55			list($title, $description, $params) = $this->getRouteDocBlock($class, $method);
56			$key = $this->generateEndpointKey($class);
57
58			$endpoints[$key][] = [
59			'hash' => $this->generateHashForUrl($key, $route, $method),
60			'uri' => $this->getRouteParam($route, 'uri'),
61			'name' => $method,
62			'methods' => $this->getRouteParam($route, 'methods'),
63			'docs' => [
64			'title' => $title,
65			'description' => trim($description),
66			'params' => $params,
67			'uri_params' => $this->getUriParams($route),
68			],
69			];
70			}
71
72			return $endpoints;
73			} // end getEndpoints
74
75			private function isExcluded($route)
76			{
77			$uri = $this->getRouteParam($route, 'uri');
78			$actionController = $this->getRouteParam($route, 'action.controller');
79
80			return $this->isExcludedClass($actionController) \|\| $this->isExcludedRoute($uri);
81			} // end isExcluded
82
83			private function isExcludedRoute($uri)
84			{
85			foreach ($this->config->get('yaro.apidocs.exclude.routes', []) as $pattern) {
86			if (str_is($pattern, $uri)) {
87			return true;
88			}
89			}
90
91			return false;
92			} // end isExcludedRoute
93
94			private function isExcludedClass($actionController)
95			{
96			foreach ($this->config->get('yaro.apidocs.exclude.classes', []) as $pattern) {
97			if (str_is($pattern, $actionController)) {
98			return true;
99			}
100			}
101
102			return false;
103			} // end isExcludedClass
104
105			private function isPrefixedRoute($route)
106			{
107			$prefix = $this->config->get('yaro.apidocs.prefix', 'api');
108			$regexp = '~^'. preg_quote($prefix) .'~';
109
110			return preg_match($regexp, $this->getRouteParam($route, 'uri'));
111			} // end isPrefixedRoute
112
113			private function isClosureRoute($route)
114			{
115			$action = $this->getRouteParam($route, 'action.uses');
116
117			return is_object($action);
118			} // end isClosureRoute
119
120			private function getRouteDocBlock($class, $method)
121			{
122			$reflector = new ReflectionClass($class);
123
124			$title = implode(' ', $this->splitCamelCaseToWords($method));
125			$title = ucfirst(strtolower($title));
126			$description = '';
127			$params = [];
128
129			$docs = explode("\n", $reflector->getMethod($method)->getDocComment());
130			$docs = array_filter($docs);
131			if (!$docs) {
			0 ignored issues – show Bug Best Practice introduced 2017-07-18 12:27 UTC by Report Bug Copy Issue Report The expression `$docs` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
132			return [$title, $description, $params];
133			}
134
135			$docs = $this->filterDocBlock($docs);
136
137			$title = array_shift($docs);
138
139			$checkForLongDescription = true;
140			foreach ($docs as $line) {
141			if ($checkForLongDescription && !preg_match('~^@\w+~', $line)) {
142			$description .= trim($line) .' ';
143			} elseif (preg_match('~^@\w+~', $line)) {
144			$checkForLongDescription = false;
145			if (preg_match('~^@param~', $line)) {
146			$paramChunks = $this->getParamChunksFromLine($line);
147
148			$paramType = array_shift($paramChunks);
149			$paramName = substr(array_shift($paramChunks), 1);
150			$params[$paramName] = [
151			'type' => $paramType,
152			'name' => $paramName,
153			'description' => implode(' ', $paramChunks),
154			];
155			}
156			}
157			}
158
159			return [$title, $description, $params];
160			} // end getRouteDocBlock
161
162			private function getParamChunksFromLine($line)
163			{
164			$paramChunks = explode(' ', $line);
165			$paramChunks = array_filter($paramChunks, function($val) {
166			return $val !== '';
167			});
168			unset($paramChunks[0]);
169
170			return $paramChunks;
171			} // end getParamChunksFromLine
172
173			private function filterDocBlock($docs)
174			{
175			foreach ($docs as &$line) {
176			$line = preg_replace('~\s\\s*~', '', $line);
177			$line = preg_replace('~^/$~', '', $line);
178			}
179			$docs = array_values(array_filter($docs));
180
181			return $docs;
182			} // end filterDocBlock
183
184			private function generateEndpointKey($class)
185			{
186			$disabledNamespaces = $this->config->get('yaro.apidocs.disabled_namespaces', []);
187
188			$chunks = explode('\\', $class);
189			foreach ($chunks as $index => $chunk) {
190			if (in_array($chunk, $disabledNamespaces)) {
191			unset($chunks[$index]);
192			continue;
193			}
194
195			$chunk = preg_replace('~Controller$~', '', $chunk);
196			if ($chunk) {
197			$chunk = $this->splitCamelCaseToWords($chunk);
198			$chunks[$index] = implode(' ', $chunk);
199			}
200			}
201
202			return implode('.', $chunks);
203			} // end generateEndpointKey
204
205			private function getSortedEndpoints($endpoints)
206			{
207			ksort($endpoints);
208
209			$sorted = array();
210			foreach ($endpoints as $key => $val) {
211			$this->ins($sorted, explode('.', $key), $val);
212			}
213
214			return $sorted;
215			} // end getSortedEndpoints
216
217			private function getUriParams($route)
218			{
219			preg_match_all('~{(\w+)}~', $this->getRouteParam($route, 'uri'), $matches);
220
221			return isset($matches[1]) ? $matches[1] : [];
222			} // end getUriParams
223
224			private function generateHashForUrl($key, $route, $method)
225			{
226			$path = preg_replace('~\s+~', '-', $key);
227			$httpMethod = $this->getRouteParam($route, 'methods.0');
228			$classMethod = implode('-', $this->splitCamelCaseToWords($method));
229
230			$hash = $path .'::'. $httpMethod .'::'. $classMethod;
231
232			return strtolower($hash);
233			} // end generateHashForUrl
234
235			private function splitCamelCaseToWords($chunk)
236			{
237			$splitCamelCaseRegexp = '/(?#! splitCamelCase Rev:20140412)
238			# Split camelCase "words". Two global alternatives. Either g1of2:
239			(?<=[a-z]) # Position is after a lowercase,
240			(?=[A-Z]) # and before an uppercase letter.
241			\| (?<=[A-Z]) # Or g2of2; Position is after uppercase,
242			(?=[A-Z][a-z]) # and before upper-then-lower case.
243			/x';
244
245			return preg_split($splitCamelCaseRegexp, $chunk);
246			} // end splitCamelCaseToWords
247
248			private function getRouteParam($route, $param)
249			{
250			$route = (array) $route;
251			$prefix = chr(0).'*'.chr(0);
252
253			return array_get(
254			$route,
255			$prefix.$param,
256			array_get($route, $param)
257			);
258			} // end getRouteParam
259
260			private function ins(&$ary, $keys, $val)
261			{
262			$keys ?
263			$this->ins($ary[array_shift($keys)], $keys, $val) :
264			$ary = $val;
265			} // end ins
266
267			}
268

Cherry-Pie / ApiDocs

Push — master ( dc98f7...630443 )

ApiDocs::isExcluded() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like