Enumerator::getExcludePaths() - Code Metrics - Inspection of "Merge pull request #402 from Rastusik/2.x" - goaop/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.x ( 0b066a...325133 )

by Alexander

created 2019-01-04 10:58 UTC

Enumerator::getExcludePaths() A

↳ Parent: Enumerator

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	6
cts	6
cp	1
rs	9.9
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2

<?php
/*
 * Go! AOP framework
 *
 * @copyright Copyright 2015, Lisachenko Alexander <[email protected]>
 *
 * This source file is subject to the license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Go\Instrument\FileSystem;

use ArrayIterator;
use CallbackFilterIterator;
use InvalidArgumentException;
use LogicException;
use RecursiveIteratorIterator;
use SplFileInfo;
use Symfony\Component\Finder\Finder;
use UnexpectedValueException;

/**
 * Enumerates files in the concrete directory, applying filtration logic
 */
class Enumerator
{

    /**
     * Path to the root directory, where enumeration should start
     *
     * @var string
     */
    private $rootDirectory;

    /**
     * List of additional include paths, should be below rootDirectory
     *
     * @var array
     */
    private $includePaths;

    /**
     * List of additional exclude paths, should be below rootDirectory
     *
     * @var array
     */
    private $excludePaths;

    /**
     * Initializes an enumerator
     *
     * @param string $rootDirectory Path to the root directory
     * @param array  $includePaths  List of additional include paths
     * @param array  $excludePaths  List of additional exclude paths
     */
    public function __construct($rootDirectory, array $includePaths = [], array $excludePaths = [])
    {
        $this->rootDirectory = $rootDirectory;
        $this->includePaths = $includePaths;
        $this->excludePaths = $excludePaths;
    }

    /**
     * Returns an enumerator for files
     *
     * @return \Iterator|SplFileInfo[]
     * @throws UnexpectedValueException
     * @throws InvalidArgumentException
     * @throws LogicException
     */
    public function enumerate()
    {
        $finder = new Finder();
        $finder->files()
            ->name('*.php')
            ->in($this->getInPaths());

        foreach ($this->getExcludePaths() as $path) {
            $finder->notPath($path);
        }

        $iterator = $finder->getIterator();

        // on Windows platform the default iterator is unable to rewind, not sure why
        if (strpos(PHP_OS, 'WIN') === 0) {
            $iterator = new ArrayIterator(iterator_to_array($iterator));
        }

        return $iterator;
    }

    /**
     * @return array
     * @throws UnexpectedValueException
     */
    private function getInPaths()
    {
        $inPaths = [];

        foreach ($this->includePaths as $path) {
            if (strpos($path, $this->rootDirectory, 0) === false) {
                throw new UnexpectedValueException(sprintf('Path %s is not in %s', $path, $this->rootDirectory));
            }

            $path = str_replace('*', '', $path);
            $inPaths[] = $path;
        }

        if (empty($inPaths)) {
            $inPaths[] = $this->rootDirectory;
        }

        return $inPaths;
    }

    /**
     * @return array
     */
    private function getExcludePaths()
    {
        $excludePaths = [];

        foreach ($this->excludePaths as $path) {
            $path = str_replace('*', '.*', $path);
            $excludePaths[] = '#' . str_replace($this->rootDirectory . '/', '', $path) . '#';
        }

        return $excludePaths;
    }

    /**
     * Returns a filter callback for enumerating files
     *
     * @return \Closure
     */
    public function getFilter()
    {
        $rootDirectory = $this->rootDirectory;
        $includePaths = $this->includePaths;
        $excludePaths = $this->excludePaths;

        return function (SplFileInfo $file) use ($rootDirectory, $includePaths, $excludePaths) {

            if ($file->getExtension() !== 'php') {
                return false;
            }

            $fullPath = $this->getFileFullPath($file);
            // Do not touch files that not under rootDirectory
            if (strpos($fullPath, $rootDirectory) !== 0) {
                return false;
            }

            if (!empty($includePaths)) {
                $found = false;
                foreach ($includePaths as $includePattern) {
                    if (fnmatch("{$includePattern}*", $fullPath, FNM_NOESCAPE)) {
                        $found = true;
                        break;
                    }
                }
                if (!$found) {
                    return false;
                }
            }

            foreach ($excludePaths as $excludePattern) {
                if (fnmatch("{$excludePattern}*", $fullPath, FNM_NOESCAPE)) {
                    return false;
                }
            }

            return true;
        };
    }

    /**
     * Return the real path of the given file
     *
     * This is used for testing purpose with virtual file system.
     * In a vfs the 'realPath' methode will always return false.
     * So we have a chance to mock this single function to return different path.
     *
     * @param SplFileInfo $file
     *
     * @return string
     */
    protected function getFileFullPath(SplFileInfo $file)
    {
        return $file->getRealPath();
    }

}


1		<?php
2		/*
3		* Go! AOP framework
4		*
5		* @copyright Copyright 2015, Lisachenko Alexander <[email protected]>
6		*
7		* This source file is subject to the license that is bundled
8		* with this source code in the file LICENSE.
9		*/
10
11		namespace Go\Instrument\FileSystem;
12
13		use ArrayIterator;
14		use CallbackFilterIterator;
15		use InvalidArgumentException;
16		use LogicException;
17		use RecursiveIteratorIterator;
18		use SplFileInfo;
19		use Symfony\Component\Finder\Finder;
20		use UnexpectedValueException;
21
22		/**
23		* Enumerates files in the concrete directory, applying filtration logic
24		*/
25		class Enumerator
26		{
27
28		/**
29		* Path to the root directory, where enumeration should start
30		*
31		* @var string
32		*/
33		private $rootDirectory;
34
35		/**
36		* List of additional include paths, should be below rootDirectory
37		*
38		* @var array
39		*/
40		private $includePaths;
41
42		/**
43		* List of additional exclude paths, should be below rootDirectory
44		*
45		* @var array
46		*/
47		private $excludePaths;
48
49		/**
50		* Initializes an enumerator
51		*
52		* @param string $rootDirectory Path to the root directory
53		* @param array $includePaths List of additional include paths
54		* @param array $excludePaths List of additional exclude paths
55		*/
56	7	public function __construct($rootDirectory, array $includePaths = [], array $excludePaths = [])
57		{
58	7	$this->rootDirectory = $rootDirectory;
59	7	$this->includePaths = $includePaths;
60	7	$this->excludePaths = $excludePaths;
61	7	}
62
63		/**
64		* Returns an enumerator for files
65		*
66		* @return \Iterator\|SplFileInfo[]
67		* @throws UnexpectedValueException
68		* @throws InvalidArgumentException
69		* @throws LogicException
70		*/
71	7	public function enumerate()
72		{
73	7	$finder = new Finder();
74	7	$finder->files()
75	7	->name('*.php')
76	7	->in($this->getInPaths());
77
78	7	foreach ($this->getExcludePaths() as $path) {
79	4	$finder->notPath($path);
80		}
81
82	7	$iterator = $finder->getIterator();
83
84		// on Windows platform the default iterator is unable to rewind, not sure why
85	7	if (strpos(PHP_OS, 'WIN') === 0) {
86		$iterator = new ArrayIterator(iterator_to_array($iterator));
87		}
88
89	7	return $iterator;
90		}
91
92		/**
93		* @return array
94		* @throws UnexpectedValueException
95		*/
96	7	private function getInPaths()
97		{
98	7	$inPaths = [];
99
100	7	foreach ($this->includePaths as $path) {
101	1	if (strpos($path, $this->rootDirectory, 0) === false) {
102		throw new UnexpectedValueException(sprintf('Path %s is not in %s', $path, $this->rootDirectory));
103		}
104
105	1	$path = str_replace('*', '', $path);
106	1	$inPaths[] = $path;
107		}
108
109	7	if (empty($inPaths)) {
110	6	$inPaths[] = $this->rootDirectory;
111		}
112
113	7	return $inPaths;
114		}
115
116		/**
117		* @return array
118		*/
119	7	private function getExcludePaths()
120		{
121	7	$excludePaths = [];
122
123	7	foreach ($this->excludePaths as $path) {
124	4	$path = str_replace('', '.', $path);
125	4	$excludePaths[] = '#' . str_replace($this->rootDirectory . '/', '', $path) . '#';
126		}
127
128	7	return $excludePaths;
129		}
130
131		/**
132		* Returns a filter callback for enumerating files
133		*
134		* @return \Closure
135		*/
136		public function getFilter()
137		{
138		$rootDirectory = $this->rootDirectory;
139		$includePaths = $this->includePaths;
140		$excludePaths = $this->excludePaths;
141
142		return function (SplFileInfo $file) use ($rootDirectory, $includePaths, $excludePaths) {
143
144		if ($file->getExtension() !== 'php') {
145		return false;
146		}
147
148		$fullPath = $this->getFileFullPath($file);
149		// Do not touch files that not under rootDirectory
150		if (strpos($fullPath, $rootDirectory) !== 0) {
151		return false;
152		}
153
154		if (!empty($includePaths)) {
155		$found = false;
156		foreach ($includePaths as $includePattern) {
157		if (fnmatch("{$includePattern}*", $fullPath, FNM_NOESCAPE)) {
158		$found = true;
159		break;
160		}
161		}
162		if (!$found) {
163		return false;
164		}
165		}
166
167		foreach ($excludePaths as $excludePattern) {
168		if (fnmatch("{$excludePattern}*", $fullPath, FNM_NOESCAPE)) {
169		return false;
170		}
171		}
172
173		return true;
174		};
175		}
176
177		/**
178		* Return the real path of the given file
179		*
180		* This is used for testing purpose with virtual file system.
181		* In a vfs the 'realPath' methode will always return false.
182		* So we have a chance to mock this single function to return different path.
183		*
184		* @param SplFileInfo $file
185		*
186		* @return string
187		*/
188		protected function getFileFullPath(SplFileInfo $file)
189		{
190		return $file->getRealPath();
191		}
192
193		}
194

goaop / framework

Push — 2.x ( 0b066a...325133 )

Enumerator::getExcludePaths() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like