FileExplorer::accept() - Code Metrics - Inspection of "Introduce bitwise flags to FileExplorer" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dafc3a...b25186 )

by Vladimir

created 2016-10-23 07:48 UTC

FileExplorer::accept() B

↳ Parent: FileExplorer

Complexity

Conditions	5
Paths	4

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	5

Importance

Changes

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

<?php

/**
 * @copyright 2016 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\System;

use Symfony\Component\Finder\SplFileInfo;

class FileExplorer extends \RecursiveFilterIterator
{
    /**
     * A bitwise flag to have FileExplorer ignore all files unless its been explicitly included; all other files will be
     * ignored.
     */
    const INCLUDE_ONLY_FILES = 0x1;

    /**
     * A bitwise flag to have FileExplorer search files starting with a period as well
     */
    const ALLOW_DOT_FILES    = 0x2;

    /**
     * A list of version control folders to ignore
     *
     * @var string[]
     */
    public static $vcsPatterns =  array('.git', '.hg', '.svn', '_svn', 'CVS', '_darcs', '.arch-params', '.monotone', '.bzr');

    /**
     * A list of phrases to exclude from the search
     *
     * @var string[]
     */
    private $excludes;

    /**
     * A list of phrases to explicitly include in the search
     *
     * @var string[]
     */
    private $includes;

    /**
     * The bitwise sum of the flags applied to this FileExplorer instance
     *
     * @var int|null
     */
    private $flags;

    /**
     * FileExplorer constructor.
     *
     * @param \RecursiveIterator $iterator
     * @param array              $excludes
     * @param array              $includes
     * @param int|null           $flags
     */
    public function __construct(\RecursiveIterator $iterator, array $excludes = array(), array $includes = array(), $flags = null)
    {
        parent::__construct($iterator);

        $this->excludes = array_merge(self::$vcsPatterns, $excludes);

        $this->includes = $includes;
        $this->flags = $flags;
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->current()->getFilename();
    }

    /**
     * {@inheritdoc}
     */
    public function accept ()
    {
        $filePath = str_replace(getcwd() . '/', '', $this->current()->getPathname());

        if ($this->strpos_array($filePath, $this->includes)) { return true; }
        if ($this->flags & self::INCLUDE_ONLY_FILES) { return false; }

        if (!($this->flags & self::ALLOW_DOT_FILES) &&
            preg_match('#(^|/)\..+(/|$)#', $filePath) === 1) { return false; }

        return ($this->strpos_array($filePath, $this->excludes) === false);
    }

    /**
     * Get the current SplFileInfo object
     *
     * @return SplFileInfo
     */
    public function current()
    {
        /** @var \SplFileInfo $current */
        $current = parent::current();

        return (new SplFileInfo(
            $current->getPathname(),
            $this->getRelativePath($current->getPath()),
            $this->getRelativePath($current->getPathname())
        ));
    }

    /**
     * {@inheritdoc}
     */
    public function getChildren()
    {
        return (new self(
            $this->getInnerIterator()->getChildren(),
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $this->excludes,
            $this->includes,
            $this->flags
        ));
    }

    /**
     * Get an Iterator with all of the files that have met the search requirements
     *
     * @return \RecursiveIteratorIterator
     */
    public function getExplorer ()
    {
        return (new \RecursiveIteratorIterator($this));
    }

    /**
     * Create an instance of FileExplorer from a directory path as a string
     *
     * @param  string   $folder   The path to the folder we're scanning
     * @param  string[] $excludes
     * @param  string[] $includes
     * @param  int|null $flags
     *
     * @return FileExplorer
     */
    public static function create ($folder, $excludes = array(), $includes = array(), $flags = null)
    {
        $iterator = new \RecursiveDirectoryIterator($folder, \RecursiveDirectoryIterator::SKIP_DOTS);

        return (new self($iterator, $excludes, $includes, $flags));
    }

    /**
     * Search a given string for an array of possible elements
     *
     * @param  string   $haystack
     * @param  string[] $needle
     * @param  int      $offset
     *
     * @return bool True if an element from the given array was found in the string
     */
    private function strpos_array ($haystack, $needle, $offset = 0)

    {
        if (!is_array($needle))
        {
            $needle = array($needle);
        }

        foreach ($needle as $query)
        {
            if (strpos($haystack, $query, $offset) !== false) // stop on first true result
            {
                return true;
            }
        }

        return false;
    }

    /**
     * Strip the current working directory from an absolute path
     *
     * @param  string $path An absolute path
     *
     * @return string
     */
    private function getRelativePath ($path)
    {
        return str_replace(getcwd() . DIRECTORY_SEPARATOR, '', $path);
    }
}


1		<?php
2
3		/**
4		* @copyright 2016 Vladimir Jimenez
5		* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
6		*/
7
8		namespace allejo\stakx\System;
9
10		use Symfony\Component\Finder\SplFileInfo;
11
12		class FileExplorer extends \RecursiveFilterIterator
13		{
14		/**
15		* A bitwise flag to have FileExplorer ignore all files unless its been explicitly included; all other files will be
16		* ignored.
17		*/
18		const INCLUDE_ONLY_FILES = 0x1;
19
20		/**
21		* A bitwise flag to have FileExplorer search files starting with a period as well
22		*/
23		const ALLOW_DOT_FILES = 0x2;
24
25		/**
26		* A list of version control folders to ignore
27		*
28		* @var string[]
29		*/
30		public static $vcsPatterns = array('.git', '.hg', '.svn', '_svn', 'CVS', '_darcs', '.arch-params', '.monotone', '.bzr');
31
32		/**
33		* A list of phrases to exclude from the search
34		*
35		* @var string[]
36		*/
37		private $excludes;
38
39		/**
40		* A list of phrases to explicitly include in the search
41		*
42		* @var string[]
43		*/
44		private $includes;
45
46		/**
47		* The bitwise sum of the flags applied to this FileExplorer instance
48		*
49		* @var int\|null
50		*/
51		private $flags;
52
53		/**
54		* FileExplorer constructor.
55		*
56		* @param \RecursiveIterator $iterator
57		* @param array $excludes
58		* @param array $includes
59		* @param int\|null $flags
60		*/
61	4	public function __construct(\RecursiveIterator $iterator, array $excludes = array(), array $includes = array(), $flags = null)
62		{
63	4	parent::__construct($iterator);
64
65	4	$this->excludes = array_merge(self::$vcsPatterns, $excludes);
		0 ignored issues – show Documentation Bug introduced 2016-10-23 06:16 UTC by Report Bug Copy Issue Report It seems like `array_merge(self::$vcsPatterns, $excludes)` of type `array` is incompatible with the declared type `array<integer,string>` of property `$excludes`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
66	4	$this->includes = $includes;
67	4	$this->flags = $flags;
68	4	}
69
70		/**
71		* @return string
72		*/
73		public function __toString()
74		{
75		return $this->current()->getFilename();
76		}
77
78		/**
79		* {@inheritdoc}
80		*/
81	4	public function accept ()
82		{
83	4	$filePath = str_replace(getcwd() . '/', '', $this->current()->getPathname());
84
85	4	if ($this->strpos_array($filePath, $this->includes)) { return true; }
86	4	if ($this->flags & self::INCLUDE_ONLY_FILES) { return false; }
87
88	4	if (!($this->flags & self::ALLOW_DOT_FILES) &&
89	4	preg_match('#(^\|/)\..+(/\|$)#', $filePath) === 1) { return false; }
90
91	4	return ($this->strpos_array($filePath, $this->excludes) === false);
92		}
93
94		/**
95		* Get the current SplFileInfo object
96		*
97		* @return SplFileInfo
98		*/
99	4	public function current()
100		{
101		/** @var \SplFileInfo $current */
102	4	$current = parent::current();
103
104	4	return (new SplFileInfo(
105	4	$current->getPathname(),
106	4	$this->getRelativePath($current->getPath()),
107	4	$this->getRelativePath($current->getPathname())
108	4	));
109		}
110
111		/**
112		* {@inheritdoc}
113		*/
114		public function getChildren()
115		{
116		return (new self(
117		$this->getInnerIterator()->getChildren(),
		0 ignored issues – show Bug introduced 2016-10-23 06:16 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Iterator` as the method `getChildren()` does only exist in the following implementations of said interface: `DoctrineTest\InstantiatorTestAsset\PharAsset`, `PHPUnit_Runner_Filter_GroupFilterIterator`, `PHPUnit_Runner_Filter_Group_Exclude`, `PHPUnit_Runner_Filter_Group_Include`, `PHPUnit_Runner_Filter_Test`, `PHPUnit_Util_TestSuiteIterator`, `PHP_CodeCoverage_Report_Node_Iterator`, `ParentIterator`, `Phar`, `PharData`, `RecursiveArrayIterator`, `RecursiveCachingIterator`, `RecursiveCallbackFilterIterator`, `RecursiveDirectoryIterator`, `RecursiveFilterIterator`, `RecursiveRegexIterator`, `SimpleXMLIterator`, `SplFileObject`, `SplTempFileObject`, `Symfony\Component\Finder...DirectoryFilterIterator`, `Symfony\Component\Finder...ursiveDirectoryIterator`, `allejo\stakx\System\FileExplorer`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
118		$this->excludes,
119		$this->includes,
120		$this->flags
121		));
122		}
123
124		/**
125		* Get an Iterator with all of the files that have met the search requirements
126		*
127		* @return \RecursiveIteratorIterator
128		*/
129	4	public function getExplorer ()
130		{
131	4	return (new \RecursiveIteratorIterator($this));
132		}
133
134		/**
135		* Create an instance of FileExplorer from a directory path as a string
136		*
137		* @param string $folder The path to the folder we're scanning
138		* @param string[] $excludes
139		* @param string[] $includes
140		* @param int\|null $flags
141		*
142		* @return FileExplorer
143		*/
144	4	public static function create ($folder, $excludes = array(), $includes = array(), $flags = null)
145		{
146	4	$iterator = new \RecursiveDirectoryIterator($folder, \RecursiveDirectoryIterator::SKIP_DOTS);
147
148	4	return (new self($iterator, $excludes, $includes, $flags));
149		}
150
151		/**
152		* Search a given string for an array of possible elements
153		*
154		* @param string $haystack
155		* @param string[] $needle
156		* @param int $offset
157		*
158		* @return bool True if an element from the given array was found in the string
159		*/
160	4	private function strpos_array ($haystack, $needle, $offset = 0)
		0 ignored issues – show Coding Style introduced 2016-10-23 06:16 UTC by Report Bug Copy Issue Report This method is not in camel caps format. This check looks for method names that are not written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection seeker becomes `databaseConnectionSeeker`. Loading history...
161		{
162	4	if (!is_array($needle))
163	4	{
164		$needle = array($needle);
165		}
166
167	4	foreach ($needle as $query)
168		{
169	4	if (strpos($haystack, $query, $offset) !== false) // stop on first true result
170	4	{
171		return true;
172		}
173	4	}
174
175	4	return false;
176		}
177
178		/**
179		* Strip the current working directory from an absolute path
180		*
181		* @param string $path An absolute path
182		*
183		* @return string
184		*/
185	4	private function getRelativePath ($path)
186		{
187	4	return str_replace(getcwd() . DIRECTORY_SEPARATOR, '', $path);
188		}
189		}
190

stakx-io / stakx

Push — master ( dafc3a...b25186 )

FileExplorer::accept() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like