ServiceTask::collectServices() - Code Metrics - Inspection of "Ide helper" - burzum/cakephp-service-layer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#5)

by mark

created 2018-05-05 02:38 UTC

ServiceTask::collectServices() B

↳ Parent: ServiceTask

Complexity

Conditions	5
Paths	7

Size

Total Lines	24
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes

Metric	Value
dl	0
loc	24
ccs	0
cts	14
cp	0
rs	8.5125
c	0
b	0
f	0
cc	5
eloc	14
nc	7
nop	0
crap	30

<?php
namespace Burzum\Cake\Generator\Task;

use Cake\Core\App;
use Cake\Core\Plugin;
use Cake\Filesystem\Folder;
use IdeHelper\Generator\Task\TaskInterface;

class ServiceTask implements TaskInterface {

	/**
	 * @var array
	 */
	protected $aliases = [
		'\Burzum\Cake\Service\ServiceAwareTrait::loadService(0)',
		'\ServiceAwareTrait::loadService(0)',
	];

	/**
	 * Buffer
	 *
	 * @var array|null
	 */
	protected static $services;

	/**
	 * @return void
	 */
	public static function clearBuffer() {
		static::$services = null;
	}

	/**
	 * @return array
	 */
	public function collect() {
		$map = [];

		$services = $this->collectServices();
		foreach ($services as $service => $className) {
			$map[$service] = '\\' . $className . '::class';
		}

		$result = [];
		foreach ($this->aliases as $alias) {
			$result[$alias] = $map;
		}

		return $result;
	}

	/**
	 * @return string[]
	 */
	protected function collectServices() {
		if (static::$services !== null) {
			return static::$services;
		}

		$services = [];

		$folders = App::path('Service');
		foreach ($folders as $folder) {
			$services = $this->addServices($services, $folder);
		}

		$plugins = Plugin::loaded();
		foreach ($plugins as $plugin) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			$folders = App::path('Service', $plugin);
			foreach ($folders as $folder) {
				$services = $this->addServices($services, $folder, $plugin);
			}
		}

		static::$services = $services;

		return $services;
	}

	/**
	 * @param array $services
	 * @param string $folder
	 * @param string|null $plugin
	 *
	 * @return string[]
	 */
	protected function addServices(array $services, $folder, $plugin = null) {
		$folderContent = (new Folder($folder))->read(Folder::SORT_NAME, true);

		foreach ($folderContent[1] as $file) {
			preg_match('/^(.+)Service\.php$/', $file, $matches);
			if (!$matches) {

				continue;
			}
			$service = $matches[1];
			if ($plugin) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
				$service = $plugin . '.' . $service;
			}

			$className = App::className($service, 'Service', 'Service');
			if (!$className) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
				continue;
			}

			$services[$service] = $className;
		}

		return $services;
	}

}


1			<?php
2			namespace Burzum\Cake\Generator\Task;
3
4			use Cake\Core\App;
5			use Cake\Core\Plugin;
6			use Cake\Filesystem\Folder;
7			use IdeHelper\Generator\Task\TaskInterface;
8
9			class ServiceTask implements TaskInterface {
10
11			/**
12			* @var array
13			*/
14			protected $aliases = [
15			'\Burzum\Cake\Service\ServiceAwareTrait::loadService(0)',
16			'\ServiceAwareTrait::loadService(0)',
17			];
18
19			/**
20			* Buffer
21			*
22			* @var array\|null
23			*/
24			protected static $services;
25
26			/**
27			* @return void
28			*/
29			public static function clearBuffer() {
30			static::$services = null;
31			}
32
33			/**
34			* @return array
35			*/
36			public function collect() {
37			$map = [];
38
39			$services = $this->collectServices();
40			foreach ($services as $service => $className) {
41			$map[$service] = '\\' . $className . '::class';
42			}
43
44			$result = [];
45			foreach ($this->aliases as $alias) {
46			$result[$alias] = $map;
47			}
48
49			return $result;
50			}
51
52			/**
53			* @return string[]
54			*/
55			protected function collectServices() {
56			if (static::$services !== null) {
57			return static::$services;
58			}
59
60			$services = [];
61
62			$folders = App::path('Service');
63			foreach ($folders as $folder) {
64			$services = $this->addServices($services, $folder);
65			}
66
67			$plugins = Plugin::loaded();
68			foreach ($plugins as $plugin) {
			0 ignored issues – show Bug introduced 2018-05-05 02:46 UTC by Report Bug Copy Issue Report The expression `$plugins` of type `boolean\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
69			$folders = App::path('Service', $plugin);
70			foreach ($folders as $folder) {
71			$services = $this->addServices($services, $folder, $plugin);
72			}
73			}
74
75			static::$services = $services;
76
77			return $services;
78			}
79
80			/**
81			* @param array $services
82			* @param string $folder
83			* @param string\|null $plugin
84			*
85			* @return string[]
86			*/
87			protected function addServices(array $services, $folder, $plugin = null) {
88			$folderContent = (new Folder($folder))->read(Folder::SORT_NAME, true);
89
90			foreach ($folderContent[1] as $file) {
91			preg_match('/^(.+)Service\.php$/', $file, $matches);
92			if (!$matches) {
			0 ignored issues – show Bug Best Practice introduced 2018-05-05 02:46 UTC by Report Bug Copy Issue Report The expression `$matches` of type `string[]` 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...
93			continue;
94			}
95			$service = $matches[1];
96			if ($plugin) {
			0 ignored issues – show Bug Best Practice introduced 2018-05-05 02:46 UTC by Report Bug Copy Issue Report The expression `$plugin` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
97			$service = $plugin . '.' . $service;
98			}
99
100			$className = App::className($service, 'Service', 'Service');
101			if (!$className) {
			0 ignored issues – show Bug Best Practice introduced 2018-05-05 02:46 UTC by Report Bug Copy Issue Report The expression `$className` of type `string\|false` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
102			continue;
103			}
104
105			$services[$service] = $className;
106			}
107
108			return $services;
109			}
110
111			}
112

burzum / cakephp-service-layer

Pull Request — master (#5)

ServiceTask::collectServices() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like