ResourceProvider::parseEntity() - Code Metrics - Inspection of "Add if else flag. Add suppression flag. Resolve #4..." - m1/Vars - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 777b8c...ce01dd )

by Miles

created 2015-12-18 22:30 UTC

ResourceProvider::parseEntity() B

↳ Parent: ResourceProvider

Complexity

Conditions	5
Paths	5

Size

Total Lines	19
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	5

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	19
ccs	12
cts	12
cp	1
rs	8.8571
cc	5
eloc	10
nc	5
nop	1
crap	5

<?php

/**
 * This file is part of the m1\vars library
 *
 * (c) m1 <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package     m1/vars
 * @version     0.3.0
 * @author      Miles Croxford <[email protected]>
 * @copyright   Copyright (c) Miles Croxford <[email protected]>
 * @license     http://github.com/m1/vars/blob/master/LICENSE
 * @link        http://github.com/m1/vars/blob/master/README.MD Documentation
 */

namespace M1\Vars\Resource;

use M1\Vars\Loader\DirectoryLoader;
use M1\Vars\Traits\ResourceFlagsTrait;
use M1\Vars\Vars;

/**
 * Vars Resource Provider to separate the different formats of config (array/file/dir) into one resource
 *
 * @since 0.1.0
 */
class ResourceProvider extends AbstractResource
{
    use ResourceFlagsTrait;

    /**
     * The configuration entity -- could be a file, array or dir
     *
     * @var array|string
     */
    private $entity;

    /**
     * If the import was not relative then the content will be stored in this array
     *
     * @var array
     */
    private $parent_content = array();

    /**
     * Are dirs wanting to be recursively searched
     *
     * @var bool
     */
    private $recursive;

    /**
     * Is the import relative
     *
     * @var bool
     */
    private $relative;

    /**
     * Suppress file not found exceptions
     *
     * @var bool
     */
    private $suppress_file_exceptions = false;

    /**
     * The parent Vars class
     *
     * @var \M1\Vars\Vars
     */
    public $vars;

    /**
     * The ResourceProvider constructor creates the content from the entity
     *
     * @param \M1\Vars\Vars $vars      The calling Vars class
     * @param string|array  $entity    The configuration entity
     * @param bool          $relative  Is the entity relative to the calling entity or class
     * @param bool          $recursive If entity a dir, do you want to recursively check directories
     *
     * @throws \InvalidArgumentException If the entity passed is not a string or array
     */
    public function __construct(Vars $vars, $entity, $relative = true, $recursive = true)
    {
        if (!is_string($entity) && !is_array($entity)) {
            throw new \InvalidArgumentException('You can only pass strings or arrays as Resources');
        }

        $this->vars = $vars;
        $this->entity = $entity;
        $this->relative = $relative;
        $this->recursive = $recursive;

        $this->createContent($entity);
    }

    /**
     * Creates the content from the entity
     *
     * @param string|array $entity The configuration entity
     */
    private function createContent($entity)
    {
        $type = gettype($entity);
        $resources = $this->processEntity($entity, $type);

        if ($resources && !empty($resources)) {
            foreach ($resources as $resource) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                if ($type === "string") {
                    $this->vars->pathsLoadedCheck($resource);

                    if ($this->vars->cache->checkCache()) {
                        return;
                    }

                    if ($this->vars->resourceImported($resource)) {
                        continue;
                    }

                    $pos = $this->vars->addResource($resource);
                    $resource = new FileResource($this, $resource);
                    $this->vars->updateResource($resource, $pos);
                } else {
                    $resource = new ResourceProvider($this->vars, $resource);
                }

                $this->addContent($resource->getContent());
            }
        }
    }

    /**
     * Creates the content from the entity
     *
     * @param string|array $entity The configuration entity
     * @param string       $type   The type of entity
     *
     * @throws \InvalidArgumentException If the entity is not array|file, is readable or exists
     *
     * @returns array The array of resources
     */
    private function processEntity($entity, $type)
    {
        $resources = $entity;

        if ($type === 'string') {
            $entity = $this->parseEntity($entity);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

            if (is_file($entity)) {
                $resources = array($entity);
            } elseif (is_dir($entity)) {
                $resources = $this->getSupportedFilesInDir();
            } elseif ($this->suppress_file_exceptions) {
                $resources = false;
            } else {
                throw new \InvalidArgumentException(sprintf("'%s' does not exist or is not readable", $entity));
            }
        }

        return $resources;
    }

    /**
     * Creates the content from the entity
     *
     * @param string $entity The configuration entity
     *
     * @returns string The parsed entity
     */
    private function parseEntity($entity)
    {
        $files = $this->explodeResourceIfElse($entity);

        foreach ($files as $f) {
            $this->suppress_file_exceptions = false;

            if ($this->checkSuppression($f)) {
                $f = trim($f, "@");
                $this->suppress_file_exceptions = true;
            }

            if (file_exists($f) || !isset($files[1])) {
                return $f;
            }
        }

        return $f;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    /**
     * Adds content to the parent contents
     *
     * @param array $content The content from the resource
     */
    private function addContent($content)
    {
        if ($this->relative) {
            $this->content = $this->mergeContents($this->content, $content);
        } else {
            $this->parent_content = $this->mergeContents($this->parent_content, $content);
        }
    }

    /**
     * Returns the supported files using the extensions from the loaders in the entity which is a directory
     *
     * @see \M1\Vars\Loader\LoaderProvider::getExtensions() \M1\Vars\Loader\LoaderProvider::getExtensions()
     * @see \M1\Vars\Loader\LoaderProvider::makeLoaders() \M1\Vars\Loader\LoaderProvider::makeLoaders()
     *
     * @return array|bool Returns the supported files or false if no files were found
     */
    private function getSupportedFilesInDir()
    {
        $dir_loader = new DirectoryLoader($this->entity, $this->recursive);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $dir_loader->setSupports($this->vars->loader->getExtensions());
        $dir_loader->load();

        return $dir_loader->getContent();
    }

    /**
     * Merges various configuration contents into one array
     *
     * @param mixed $contents,... Optional number of arrays to merge
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return array The merged contents
     */
    private function mergeContents()
    {
        $contents = func_get_args();
        return call_user_func_array('array_replace_recursive', $contents);
    }

    /**
     * Adds content to the parent content array
     *
     * @param array $content The content to add
     */
    public function addParentContent(array $content)
    {
        $this->parent_content = array_merge_recursive($this->parent_content, $content);
    }

    /**
     * Merges the content and the parent content together
     *
     * @return \M1\Vars\Resource\ResourceProvider
     */
    public function mergeParentContent()
    {
        $this->content = $this->mergeContents($this->content, $this->parent_content);

        return $this;
    }

    /**
     * Returns the parent content
     *
     * @return mixed The parent content
     */
    public function getParentContent()
    {
        return $this->parent_content;
    }
}


GitHub Access Token became invalid

Push — master ( 777b8c...ce01dd )

ResourceProvider::parseEntity() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

1		<?php
2
3		/**
4		* This file is part of the m1\vars library
5		*
6		* (c) m1 <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*
11		* @package m1/vars
12		* @version 0.3.0
13		* @author Miles Croxford <[email protected]>
14		* @copyright Copyright (c) Miles Croxford <[email protected]>
15		* @license http://github.com/m1/vars/blob/master/LICENSE
16		* @link http://github.com/m1/vars/blob/master/README.MD Documentation
17		*/
18
19		namespace M1\Vars\Resource;
20
21		use M1\Vars\Loader\DirectoryLoader;
22		use M1\Vars\Traits\ResourceFlagsTrait;
23		use M1\Vars\Vars;
24
25		/**
26		* Vars Resource Provider to separate the different formats of config (array/file/dir) into one resource
27		*
28		* @since 0.1.0
29		*/
30		class ResourceProvider extends AbstractResource
31		{
32		use ResourceFlagsTrait;
33
34		/**
35		* The configuration entity -- could be a file, array or dir
36		*
37		* @var array\|string
38		*/
39		private $entity;
40
41		/**
42		* If the import was not relative then the content will be stored in this array
43		*
44		* @var array
45		*/
46		private $parent_content = array();
47
48		/**
49		* Are dirs wanting to be recursively searched
50		*
51		* @var bool
52		*/
53		private $recursive;
54
55		/**
56		* Is the import relative
57		*
58		* @var bool
59		*/
60		private $relative;
61
62		/**
63		* Suppress file not found exceptions
64		*
65		* @var bool
66		*/
67		private $suppress_file_exceptions = false;
68
69		/**
70		* The parent Vars class
71		*
72		* @var \M1\Vars\Vars
73		*/
74		public $vars;
75
76		/**
77		* The ResourceProvider constructor creates the content from the entity
78		*
79		* @param \M1\Vars\Vars $vars The calling Vars class
80		* @param string\|array $entity The configuration entity
81		* @param bool $relative Is the entity relative to the calling entity or class
82		* @param bool $recursive If entity a dir, do you want to recursively check directories
83		*
84		* @throws \InvalidArgumentException If the entity passed is not a string or array
85		*/
86	72	public function __construct(Vars $vars, $entity, $relative = true, $recursive = true)
87		{
88	72	if (!is_string($entity) && !is_array($entity)) {
89	1	throw new \InvalidArgumentException('You can only pass strings or arrays as Resources');
90		}
91
92	71	$this->vars = $vars;
93	71	$this->entity = $entity;
94	71	$this->relative = $relative;
95	71	$this->recursive = $recursive;
96
97	71	$this->createContent($entity);
98	59	}
99
100		/**
101		* Creates the content from the entity
102		*
103		* @param string\|array $entity The configuration entity
104		*/
105	71	private function createContent($entity)
106		{
107	71	$type = gettype($entity);
108	71	$resources = $this->processEntity($entity, $type);
109
110	68	if ($resources && !empty($resources)) {
111	66	foreach ($resources as $resource) {
		0 ignored issues – show Bug introduced 2015-12-09 14:10 UTC by Report Bug Copy Issue Report The expression `$resources` of type `array\|boolean\|string` 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...
112	66	if ($type === "string") {
113	66	$this->vars->pathsLoadedCheck($resource);
114
115	66	if ($this->vars->cache->checkCache()) {
116	1	return;
117		}
118
119	66	if ($this->vars->resourceImported($resource)) {
120	1	continue;
121		}
122
123	66	$pos = $this->vars->addResource($resource);
124	66	$resource = new FileResource($this, $resource);
125	57	$this->vars->updateResource($resource, $pos);
126	57	} else {
127	1	$resource = new ResourceProvider($this->vars, $resource);
128		}
129
130	57	$this->addContent($resource->getContent());
131	57	}
132	57	}
133	59	}
134
135		/**
136		* Creates the content from the entity
137		*
138		* @param string\|array $entity The configuration entity
139		* @param string $type The type of entity
140		*
141		* @throws \InvalidArgumentException If the entity is not array\|file, is readable or exists
142		*
143		* @returns array The array of resources
144		*/
145	71	private function processEntity($entity, $type)
146		{
147	71	$resources = $entity;
148
149	71	if ($type === 'string') {
150	71	$entity = $this->parseEntity($entity);
		0 ignored issues – show Bug introduced 2015-12-18 22:33 UTC by Report Bug Copy Issue Report It seems like `$entity` can also be of type `array`; however, `M1\Vars\Resource\ResourceProvider::parseEntity()` 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...
151
152	71	if (is_file($entity)) {
153	66	$resources = array($entity);
154	71	} elseif (is_dir($entity)) {
155	5	$resources = $this->getSupportedFilesInDir();
156	12	} elseif ($this->suppress_file_exceptions) {
157	2	$resources = false;
158	2	} else {
159	5	throw new \InvalidArgumentException(sprintf("'%s' does not exist or is not readable", $entity));
160		}
161	68	}
162
163	68	return $resources;
164		}
165
166		/**
167		* Creates the content from the entity
168		*
169		* @param string $entity The configuration entity
170		*
171		* @returns string The parsed entity
172		*/
173	71	private function parseEntity($entity)
174		{
175	71	$files = $this->explodeResourceIfElse($entity);
176
177	71	foreach ($files as $f) {
178	71	$this->suppress_file_exceptions = false;
179
180	71	if ($this->checkSuppression($f)) {
181	2	$f = trim($f, "@");
182	2	$this->suppress_file_exceptions = true;
183	2	}
184
185	71	if (file_exists($f) \|\| !isset($files[1])) {
186	71	return $f;
187		}
188	3	}
189
190	2	return $f;
		0 ignored issues – show Bug introduced 2015-12-18 22:33 UTC by Report Bug Copy Issue Report The variable `$f` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
191		}
192
193		/**
194		* Adds content to the parent contents
195		*
196		* @param array $content The content from the resource
197		*/
198	57	private function addContent($content)
199		{
200	57	if ($this->relative) {
201	57	$this->content = $this->mergeContents($this->content, $content);
202	57	} else {
203	7	$this->parent_content = $this->mergeContents($this->parent_content, $content);
204		}
205	57	}
206
207		/**
208		* Returns the supported files using the extensions from the loaders in the entity which is a directory
209		*
210		* @see \M1\Vars\Loader\LoaderProvider::getExtensions() \M1\Vars\Loader\LoaderProvider::getExtensions()
211		* @see \M1\Vars\Loader\LoaderProvider::makeLoaders() \M1\Vars\Loader\LoaderProvider::makeLoaders()
212		*
213		* @return array\|bool Returns the supported files or false if no files were found
214		*/
215	5	private function getSupportedFilesInDir()
216		{
217	5	$dir_loader = new DirectoryLoader($this->entity, $this->recursive);
		0 ignored issues – show Bug introduced 2015-12-16 14:01 UTC by Report Bug Copy Issue Report It seems like `$this->entity` can also be of type `array`; however, `M1\Vars\Loader\DirectoryLoader::__construct()` 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	5	$dir_loader->setSupports($this->vars->loader->getExtensions());
219	5	$dir_loader->load();
220
221	5	return $dir_loader->getContent();
222		}
223
224		/**
225		* Merges various configuration contents into one array
226		*
227		* @param mixed $contents,... Optional number of arrays to merge
		0 ignored issues – show Bug introduced 2015-12-07 14:50 UTC by Report Bug Copy Issue Report There is no parameter named `$contents,...`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
228		*
229		* @return array The merged contents
230		*/
231	59	private function mergeContents()
232		{
233	59	$contents = func_get_args();
234	59	return call_user_func_array('array_replace_recursive', $contents);
235		}
236
237		/**
238		* Adds content to the parent content array
239		*
240		* @param array $content The content to add
241		*/
242	7	public function addParentContent(array $content)
243		{
244	7	$this->parent_content = array_merge_recursive($this->parent_content, $content);
245	7	}
246
247		/**
248		* Merges the content and the parent content together
249		*
250		* @return \M1\Vars\Resource\ResourceProvider
251		*/
252	59	public function mergeParentContent()
253		{
254	59	$this->content = $this->mergeContents($this->content, $this->parent_content);
255
256	59	return $this;
257		}
258
259		/**
260		* Returns the parent content
261		*
262		* @return mixed The parent content
263		*/
264	44	public function getParentContent()
265		{
266	44	return $this->parent_content;
267		}
268		}
269

m1 / Vars

GitHub Access Token became invalid

Push — master ( 777b8c...ce01dd )

ResourceProvider::parseEntity() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like