Generator::__construct() - Code Metrics - Inspection of "Coloring response codes" - ublaboo/api-docu - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0cabc3...46ad02 )

by Pavel

created 2016-07-31 09:44 UTC

Generator::__construct() A

↳ Parent: Generator

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php

/**
 * @copyright   Copyright (c) 2016 ublaboo <[email protected]>
 * @author      Pavel Janda <[email protected]>
 * @package     Ublaboo
 */

namespace Ublaboo\ApiDocu;

use Nette;
use Nette\Application\Request;
use Nette\Application\IRouter;
use Ublaboo\ApiRouter\ApiRoute;
use Tracy\Debugger;

class Generator extends Nette\Object
{

	/**
	 * @var Nette\Application\UI\ITemplateFactory
	 */
	private $templateFactory;

	/**
	 * @var Nette\Http\Request
	 */
	private $httpRequest;

	/**
	 * @var string
	 */
	private $api_dir;


	/**
	 * @param string                                $api_dir
	 * @param Nette\Application\UI\ITemplateFactory $templateFactory
	 * @param Nette\Http\Request                    $httpRequest
	 */
	public function __construct(
		$api_dir,
		Nette\Application\UI\ITemplateFactory $templateFactory,
		Nette\Http\Request $httpRequest
	) {
		$this->api_dir = $api_dir;
		$this->templateFactory = $templateFactory;
		$this->httpRequest = $httpRequest;
	}


	/**
	 * @param  IRouter $router
	 * @return void
	 */
	public function generateAll(IRouter $router)
	{
		$sections = $this->splitRoutesIntoSections($router);

		if (!file_exists($this->api_dir) && !is_dir($this->api_dir)) {
			mkdir($this->api_dir);
		}

		/**
		 * Create index.html
		 */
		$this->generateIndex($sections);

		/**
		 * Create *.html for each defined ApiRoute
		 */
		foreach ($sections as $section_name => $routes) {
			if (is_array($routes)) {
				foreach ($routes as $file_name => $route) {
					$this->generateOne($route, $sections, "$section_name.$file_name");
				}
			} else {
				$this->generateOne($routes, $sections, $section_name);
			}
		}

		$this->generateSuccess();
	}


	/**
	 * @param  ApiRoute $route
	 * @param  Request  $request
	 * @return void
	 */
	public function generateTarget(ApiRoute $route, Request $request)
	{
		$template = $this->createTemplate('api_docu_matched.latte');

		$template->setParameters([
			'route'       => $route,
			'request'     => $request,
			'httpRequest' => $this->httpRequest
		]);

		if (class_exists('Tracy\Debugger')) {
			Debugger::$productionMode = TRUE;
		}

		echo (string) $template;
	}


	/**
	 * @param  ApiRoute $route
	 * @param  array    $sections
	 * @param  string   $file_name
	 * @return void
	 */
	public function generateOne(ApiRoute $route, $sections, $file_name)
	{
		$template = $this->createTemplate('api_docu_one.latte');

		$template->setParameters([
			'route'       => $route,
			'sections'    => $sections
		]);

		file_put_contents("{$this->api_dir}/{$file_name}.html", (string) $template);
	}


	/**
	 * @param  array $sections
	 * @return void
	 */
	public function generateIndex($sections)
	{
		$template = $this->createTemplate('api_docu_index.latte');

		$template->setParameters([
			'sections' => $sections
		]);

		file_put_contents("{$this->api_dir}/index.html", (string) $template);
	}


	/**
	 * @return void
	 */
	public function generateSuccess()
	{
		$template = $this->createTemplate('api_docu_success.latte');

		$template->setParameters([
			'apiDir' => $this->api_dir
		]);

		if (class_exists('Tracy\Debugger')) {
			Debugger::$productionMode = TRUE;
		}

		echo (string) $template;
	}


	/**
	 * @param  string
	 * @return Nette\Application\UI\ITemplate
	 */
	public function createTemplate($which)
	{
		$template = $this->templateFactory->createTemplate();

		$template->addFilter(NULL, 'Ublaboo\ApiDocu\TemplateFilters::common');

		$template->setFile(__DIR__ . '/templates/' . $which);

		if ($template instanceof Nette\Application\UI\ITemplate) {
			$template->base_dir = __DIR__ . '/templates';
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
		}

		$template->addFilter('routeMaskStyles', function($mask) {
			return str_replace(['<', '>'], ['<span class="apiDocu-mask-param">&lt;', '&gt;</span>'], $mask);
		});

		$template->addFilter('apiDocuResponseCode', function($code) {
			if ($code >= 200 && $code <= 202) {
				return "<span class=\"apiDocu-code-success\">{$code}</span>";
			} else if ($code >= 300 && $code < 500) {
				return "<span class=\"apiDocu-code-warning\">{$code}</span>";
			} else if ($code >= 500) {
				return "<span class=\"apiDocu-code-error\">{$code}</span>";
			}

			return "<span class=\"apiDocu-code-other\">{$code}</span>";
		});

		return $template;
	}


	/********************************************************************************
	 *                                   INTERNAL                                   *
	 ********************************************************************************/


	private function splitRoutesIntoSections(IRouter $router)
	{
		$routes = [];
		$sections = [];
		$file_name = 1;

		if ($router instanceof ApiRoute) {
			$routes = [$router];
		} else if ($router instanceof \IteratorAggregate) {
			$routes = $this->getApiRoutesFromIterator($router);
		}

		foreach ($routes as $route) {
			if ($route->getSection()) {
				if (empty($sections[$route->getSection()])) {
					$sections[$route->getSection()] = [];
				}

				$sections[$route->getSection()][$file_name++] = $route;
			} else {
				$sections[$file_name++] = $route;
			}
		}

		return $sections;
	}


	/**
	 * Recursively flatten \IteratorAggregate (probably Nette\Application\Routers\RouteList)
	 * @param  \IteratorAggregate $i
	 * @return array
	 */
	private function getApiRoutesFromIterator(\IteratorAggregate $i)
	{
		$return = [];

		foreach ($i as $router) {
			if ($router instanceof ApiRoute) {
				$return[] = $router;
			} else if ($router instanceof \IteratorAggregate) {
				$routes = $this->getApiRoutesFromIterator($router);

				foreach ($routes as $route) {
					$return[] = $route;
				}
			}
		}

		return $return;
	}

}


1			<?php
2
3			/**
4			* @copyright Copyright (c) 2016 ublaboo <[email protected]>
5			* @author Pavel Janda <[email protected]>
6			* @package Ublaboo
7			*/
8
9			namespace Ublaboo\ApiDocu;
10
11			use Nette;
12			use Nette\Application\Request;
13			use Nette\Application\IRouter;
14			use Ublaboo\ApiRouter\ApiRoute;
15			use Tracy\Debugger;
16
17			class Generator extends Nette\Object
18			{
19
20			/**
21			* @var Nette\Application\UI\ITemplateFactory
22			*/
23			private $templateFactory;
24
25			/**
26			* @var Nette\Http\Request
27			*/
28			private $httpRequest;
29
30			/**
31			* @var string
32			*/
33			private $api_dir;
34
35
36			/**
37			* @param string $api_dir
38			* @param Nette\Application\UI\ITemplateFactory $templateFactory
39			* @param Nette\Http\Request $httpRequest
40			*/
41			public function __construct(
42			$api_dir,
43			Nette\Application\UI\ITemplateFactory $templateFactory,
44			Nette\Http\Request $httpRequest
45			) {
46			$this->api_dir = $api_dir;
47			$this->templateFactory = $templateFactory;
48			$this->httpRequest = $httpRequest;
49			}
50
51
52			/**
53			* @param IRouter $router
54			* @return void
55			*/
56			public function generateAll(IRouter $router)
57			{
58			$sections = $this->splitRoutesIntoSections($router);
59
60			if (!file_exists($this->api_dir) && !is_dir($this->api_dir)) {
61			mkdir($this->api_dir);
62			}
63
64			/**
65			* Create index.html
66			*/
67			$this->generateIndex($sections);
68
69			/**
70			* Create *.html for each defined ApiRoute
71			*/
72			foreach ($sections as $section_name => $routes) {
73			if (is_array($routes)) {
74			foreach ($routes as $file_name => $route) {
75			$this->generateOne($route, $sections, "$section_name.$file_name");
76			}
77			} else {
78			$this->generateOne($routes, $sections, $section_name);
79			}
80			}
81
82			$this->generateSuccess();
83			}
84
85
86			/**
87			* @param ApiRoute $route
88			* @param Request $request
89			* @return void
90			*/
91			public function generateTarget(ApiRoute $route, Request $request)
92			{
93			$template = $this->createTemplate('api_docu_matched.latte');
94
95			$template->setParameters([
96			'route' => $route,
97			'request' => $request,
98			'httpRequest' => $this->httpRequest
99			]);
100
101			if (class_exists('Tracy\Debugger')) {
102			Debugger::$productionMode = TRUE;
103			}
104
105			echo (string) $template;
106			}
107
108
109			/**
110			* @param ApiRoute $route
111			* @param array $sections
112			* @param string $file_name
113			* @return void
114			*/
115			public function generateOne(ApiRoute $route, $sections, $file_name)
116			{
117			$template = $this->createTemplate('api_docu_one.latte');
118
119			$template->setParameters([
120			'route' => $route,
121			'sections' => $sections
122			]);
123
124			file_put_contents("{$this->api_dir}/{$file_name}.html", (string) $template);
125			}
126
127
128			/**
129			* @param array $sections
130			* @return void
131			*/
132			public function generateIndex($sections)
133			{
134			$template = $this->createTemplate('api_docu_index.latte');
135
136			$template->setParameters([
137			'sections' => $sections
138			]);
139
140			file_put_contents("{$this->api_dir}/index.html", (string) $template);
141			}
142
143
144			/**
145			* @return void
146			*/
147			public function generateSuccess()
148			{
149			$template = $this->createTemplate('api_docu_success.latte');
150
151			$template->setParameters([
152			'apiDir' => $this->api_dir
153			]);
154
155			if (class_exists('Tracy\Debugger')) {
156			Debugger::$productionMode = TRUE;
157			}
158
159			echo (string) $template;
160			}
161
162
163			/**
164			* @param string
165			* @return Nette\Application\UI\ITemplate
166			*/
167			public function createTemplate($which)
168			{
169			$template = $this->templateFactory->createTemplate();
170
171			$template->addFilter(NULL, 'Ublaboo\ApiDocu\TemplateFilters::common');
172
173			$template->setFile(__DIR__ . '/templates/' . $which);
174
175			if ($template instanceof Nette\Application\UI\ITemplate) {
176			$template->base_dir = __DIR__ . '/templates';
			0 ignored issues – show Bug introduced 2016-03-08 22:03 UTC by Report Bug Copy Issue Report Accessing `base_dir` on the interface `Nette\Application\UI\ITemplate` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
177			}
178
179			$template->addFilter('routeMaskStyles', function($mask) {
180			return str_replace(['<', '>'], ['<span class="apiDocu-mask-param"><', '></span>'], $mask);
181			});
182
183			$template->addFilter('apiDocuResponseCode', function($code) {
184			if ($code >= 200 && $code <= 202) {
185			return "<span class=\"apiDocu-code-success\">{$code}</span>";
186			} else if ($code >= 300 && $code < 500) {
187			return "<span class=\"apiDocu-code-warning\">{$code}</span>";
188			} else if ($code >= 500) {
189			return "<span class=\"apiDocu-code-error\">{$code}</span>";
190			}
191
192			return "<span class=\"apiDocu-code-other\">{$code}</span>";
193			});
194
195			return $template;
196			}
197
198
199			/********************************************************************************
200			* INTERNAL *
201			********************************************************************************/
202
203
204			private function splitRoutesIntoSections(IRouter $router)
205			{
206			$routes = [];
207			$sections = [];
208			$file_name = 1;
209
210			if ($router instanceof ApiRoute) {
211			$routes = [$router];
212			} else if ($router instanceof \IteratorAggregate) {
213			$routes = $this->getApiRoutesFromIterator($router);
214			}
215
216			foreach ($routes as $route) {
217			if ($route->getSection()) {
218			if (empty($sections[$route->getSection()])) {
219			$sections[$route->getSection()] = [];
220			}
221
222			$sections[$route->getSection()][$file_name++] = $route;
223			} else {
224			$sections[$file_name++] = $route;
225			}
226			}
227
228			return $sections;
229			}
230
231
232			/**
233			* Recursively flatten \IteratorAggregate (probably Nette\Application\Routers\RouteList)
234			* @param \IteratorAggregate $i
235			* @return array
236			*/
237			private function getApiRoutesFromIterator(\IteratorAggregate $i)
238			{
239			$return = [];
240
241			foreach ($i as $router) {
242			if ($router instanceof ApiRoute) {
243			$return[] = $router;
244			} else if ($router instanceof \IteratorAggregate) {
245			$routes = $this->getApiRoutesFromIterator($router);
246
247			foreach ($routes as $route) {
248			$return[] = $route;
249			}
250			}
251			}
252
253			return $return;
254			}
255
256			}
257

ublaboo / api-docu

Push — master ( 0cabc3...46ad02 )

Generator::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like