SelectorUtils::matchPatternStart() - Code Metrics - Inspection of "Bump dependencies" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( eabf33...342b63 )

by Michiel

created 2021-01-22 20:58 UTC

SelectorUtils::matchPatternStart() B

↳ Parent: SelectorUtils

Complexity

Conditions	8
Paths	8

Size

Total Lines	50
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	23
CRAP Score	8.0046

Importance

Changes

Metric	Value
cc	8
eloc	24
c	0
b	0
f	0
nc	8
nop	3
dl	0
loc	50
ccs	23
cts	24
cp	0.9583
crap	8.0046
rs	8.4444

<?php
/**
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

use Phing\Io\File;
use Phing\Util\StringHelper;

/**
 * <p>This is a utility class used by selectors and DirectoryScanner. The
 * functionality more properly belongs just to selectors, but unfortunately
 * DirectoryScanner exposed these as protected methods. Thus we have to
 * support any subclasses of DirectoryScanner that may access these methods.
 * </p>
 * <p>This is a Singleton.</p>
 *
 * @author  Hans Lellelid, [email protected] (Phing)
 * @author  Arnout J. Kuiper, [email protected] (Ant)
 * @author  Magesh Umasankar
 * @author  Bruce Atherton, [email protected] (Ant)
 * @package phing.types.selectors
 */
class SelectorUtils
{
    private static $instance;

    /**
     * Retrieves the instance of the Singleton.
     */
    public static function getInstance()
    {
        if (!isset(self::$instance)) {
            self::$instance = new SelectorUtils();
        }

        return self::$instance;
    }

    /**
     * Tests whether or not a given path matches the start of a given
     * pattern up to the first "**".
     * <p>
     * This is not a general purpose test and should only be used if you
     * can live with false positives. For example, <code>pattern=**\a</code>
     * and <code>str=b</code> will yield <code>true</code>.
     *
     * @param string $pattern
     * @param string $str
     * @param bool $isCaseSensitive
     *
     * @internal param The $pattern pattern to match against. Must not be
     *                <code>null</code>.
     * @internal param The $str path to match, as a String. Must not be
     *                <code>null</code>.
     * @internal param Whether $isCaseSensitive or not matching should be performed
     *                        case sensitively.
     *
     * @return bool whether or not a given path matches the start of a given
     *                 pattern up to the first "**".
     */
    public static function matchPatternStart($pattern, $str, $isCaseSensitive = true)
    {

        // When str starts with a DIRECTORY_SEPARATOR, pattern has to start with a
        // DIRECTORY_SEPARATOR.
        // When pattern starts with a DIRECTORY_SEPARATOR, str has to start with a
        // DIRECTORY_SEPARATOR.
        if (
            StringHelper::startsWith(DIRECTORY_SEPARATOR, $str) !== StringHelper::startsWith(
                DIRECTORY_SEPARATOR,
                $pattern
            )
        ) {
            return false;
        }

        $patDirs = explode(DIRECTORY_SEPARATOR, $pattern);
        $strDirs = explode(DIRECTORY_SEPARATOR, $str);

        $patIdxStart = 0;
        $patIdxEnd = count($patDirs) - 1;
        $strIdxStart = 0;
        $strIdxEnd = count($strDirs) - 1;

        // up to first '**'
        while ($patIdxStart <= $patIdxEnd && $strIdxStart <= $strIdxEnd) {
            $patDir = $patDirs[$patIdxStart];
            if ($patDir == "**") {
                break;
            }
            if (!self::match($patDir, $strDirs[$strIdxStart], $isCaseSensitive)) {
                return false;
            }
            $patIdxStart++;
            $strIdxStart++;
        }

        if ($strIdxStart > $strIdxEnd) {
            // String is exhausted
            return true;
        }

        if ($patIdxStart > $patIdxEnd) {
            // String not exhausted, but pattern is. Failure.
            return false;
        }

// pattern now holds ** while string is not exhausted
        // this will generate false positives but we can live with that.
        return true;
    }

    /**
     * Tests whether or not a given path matches a given pattern.
     *
     * @param string $pattern The pattern to match against. Must not be <code>null</code>.
     * @param string $str The path to match, as a String. Must not be <code>null</code>.
     * @param bool $isCaseSensitive Whether or not matching should be performed case sensitively.
     *
     * @return bool <code>true</code> if the pattern matches against the string,
     */
    public static function matchPath($pattern, $str, $isCaseSensitive = true)
    {
        // explicitly exclude directory itself
        if ($str == '' && $pattern == '**/*') {
            return false;
        }

        $rePattern = preg_quote($pattern, '/');
        $dirSep = preg_quote(DIRECTORY_SEPARATOR, '/');
        $trailingDirSep = '((' . $dirSep . ')?|(' . $dirSep . ').+)';
        $patternReplacements = [
            $dirSep . '\*\*' . $dirSep => $dirSep . '.*' . $trailingDirSep,
            $dirSep . '\*\*' => $trailingDirSep,
            '\*\*' . $dirSep => '(.*' . $dirSep . ')?',
            '\*\*' => '.*',
            '\*' => '[^' . $dirSep . ']*',
            '\?' => '[^' . $dirSep . ']'
        ];
        $rePattern = str_replace(array_keys($patternReplacements), array_values($patternReplacements), $rePattern);
        $rePattern = '/^' . $rePattern . '$/' . ($isCaseSensitive ? '' : 'i');

        return (bool) preg_match($rePattern, $str);
    }

    /**
     * Tests whether or not a string matches against a pattern.
     * The pattern may contain two special characters:<br>
     * '*' means zero or more characters<br>
     * '?' means one and only one character
     *
     * @param string $pattern The pattern to match against.
     *                                Must not be
     *                                <code>null</code>.
     * @param string $str The string which must be matched against the pattern.
     *                                Must not be <code>null</code>.
     * @param bool $isCaseSensitive Whether or not matching should be performed
     *                                case sensitively.case sensitively.
     *
     * @return bool <code>true</code> if the string matches against the pattern,
     *                           or <code>false</code> otherwise.
     */
    public static function match($pattern, $str, $isCaseSensitive = true)
    {
        $rePattern = preg_quote($pattern, '/');
        $rePattern = str_replace(["\*", "\?"], ['.*', '.'], $rePattern);
        $rePattern = '/^' . $rePattern . '$/' . ($isCaseSensitive ? '' : 'i');

        return (bool) preg_match($rePattern, $str);
    }

    /**
     * Returns dependency information on these two files. If src has been
     * modified later than target, it returns true. If target doesn't exist,
     * it likewise returns true. Otherwise, target is newer than src and
     * is not out of date, thus the method returns false. It also returns
     * false if the src file doesn't even exist, since how could the
     * target then be out of date.
     *
     * @param  File $src the original file
     * @param  File $target the file being compared against
     * @param  int $granularity the amount in seconds of slack we will give in
     *                                determining out of dateness
     * @return bool whether   the target is out of date
     */
    public static function isOutOfDate(File $src, File $target, $granularity)
    {
        if (!$src->exists()) {
            return false;
        }
        if (!$target->exists()) {
            return true;
        }
        if (($src->lastModified() - $granularity) > $target->lastModified()) {
            return true;
        }

        return false;
    }

    /**
     * @param string $string
     * @return string
     */
    public static function removeWhitespace($string)
    {
        return preg_replace(
            "/(\t|\n|\v|\f|\r| |\xC2\x85|\xc2\xa0|\xe1\xa0\x8e|\xe2\x80[\x80-\x8D]|\xe2\x80\xa8|\xe2\x80\xa9|\xe2\x80\xaF|\xe2\x81\x9f|\xe2\x81\xa0|\xe3\x80\x80|\xef\xbb\xbf)+/",
            '',
            $string
        );
    }
}


1		<?php
2		/**
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the LGPL. For more information please see
17		* <http://phing.info>.
18		*/
19
20		use Phing\Io\File;
21		use Phing\Util\StringHelper;
22
23		/**
24		* <p>This is a utility class used by selectors and DirectoryScanner. The
25		* functionality more properly belongs just to selectors, but unfortunately
26		* DirectoryScanner exposed these as protected methods. Thus we have to
27		* support any subclasses of DirectoryScanner that may access these methods.
28		* </p>
29		* <p>This is a Singleton.</p>
30		*
31		* @author Hans Lellelid, [email protected] (Phing)
32		* @author Arnout J. Kuiper, [email protected] (Ant)
33		* @author Magesh Umasankar
34		* @author Bruce Atherton, [email protected] (Ant)
35		* @package phing.types.selectors
36		*/
37		class SelectorUtils
38		{
39		private static $instance;
40
41		/**
42		* Retrieves the instance of the Singleton.
43		*/
44	7	public static function getInstance()
45		{
46	7	if (!isset(self::$instance)) {
47	1	self::$instance = new SelectorUtils();
48		}
49
50	7	return self::$instance;
51		}
52
53		/**
54		* Tests whether or not a given path matches the start of a given
55		* pattern up to the first "**".
56		* <p>
57		* This is not a general purpose test and should only be used if you
58		* can live with false positives. For example, <code>pattern=**\a</code>
59		* and <code>str=b</code> will yield <code>true</code>.
60		*
61		* @param string $pattern
62		* @param string $str
63		* @param bool $isCaseSensitive
64		*
65		* @internal param The $pattern pattern to match against. Must not be
66		* <code>null</code>.
67		* @internal param The $str path to match, as a String. Must not be
68		* <code>null</code>.
69		* @internal param Whether $isCaseSensitive or not matching should be performed
70		* case sensitively.
71		*
72		* @return bool whether or not a given path matches the start of a given
73		* pattern up to the first "**".
74		*/
75	38	public static function matchPatternStart($pattern, $str, $isCaseSensitive = true)
76		{
77
78		// When str starts with a DIRECTORY_SEPARATOR, pattern has to start with a
79		// DIRECTORY_SEPARATOR.
80		// When pattern starts with a DIRECTORY_SEPARATOR, str has to start with a
81		// DIRECTORY_SEPARATOR.
82		if (
83	38	StringHelper::startsWith(DIRECTORY_SEPARATOR, $str) !== StringHelper::startsWith(
84	38	DIRECTORY_SEPARATOR,
85	38	$pattern
86		)
87		) {
88		return false;
89		}
90
91	38	$patDirs = explode(DIRECTORY_SEPARATOR, $pattern);
92	38	$strDirs = explode(DIRECTORY_SEPARATOR, $str);
93
94	38	$patIdxStart = 0;
95	38	$patIdxEnd = count($patDirs) - 1;
96	38	$strIdxStart = 0;
97	38	$strIdxEnd = count($strDirs) - 1;
98
99		// up to first '**'
100	38	while ($patIdxStart <= $patIdxEnd && $strIdxStart <= $strIdxEnd) {
101	38	$patDir = $patDirs[$patIdxStart];
102	38	if ($patDir == "**") {
103	17	break;
104		}
105	25	if (!self::match($patDir, $strDirs[$strIdxStart], $isCaseSensitive)) {
106	19	return false;
107		}
108	10	$patIdxStart++;
109	10	$strIdxStart++;
110		}
111
112	23	if ($strIdxStart > $strIdxEnd) {
113		// String is exhausted
114	8	return true;
115		}
116
117	18	if ($patIdxStart > $patIdxEnd) {
118		// String not exhausted, but pattern is. Failure.
119	1	return false;
120		}
121
122		// pattern now holds ** while string is not exhausted
123		// this will generate false positives but we can live with that.
124	17	return true;
125		}
126
127		/**
128		* Tests whether or not a given path matches a given pattern.
129		*
130		* @param string $pattern The pattern to match against. Must not be <code>null</code>.
131		* @param string $str The path to match, as a String. Must not be <code>null</code>.
132		* @param bool $isCaseSensitive Whether or not matching should be performed case sensitively.
133		*
134		* @return bool <code>true</code> if the pattern matches against the string,
135		*/
136	147	public static function matchPath($pattern, $str, $isCaseSensitive = true)
137		{
138		// explicitly exclude directory itself
139	147	if ($str == '' && $pattern == '*/') {
140	1	return false;
141		}
142
143	146	$rePattern = preg_quote($pattern, '/');
144	146	$dirSep = preg_quote(DIRECTORY_SEPARATOR, '/');
145	146	$trailingDirSep = '((' . $dirSep . ')?\|(' . $dirSep . ').+)';
146		$patternReplacements = [
147	146	$dirSep . '\\' . $dirSep => $dirSep . '.*' . $trailingDirSep,
148	146	$dirSep . '\\' => $trailingDirSep,
149	146	'\\' . $dirSep => '(.*' . $dirSep . ')?',
150	146	'\\' => '.*',
151	146	'\' => '[^' . $dirSep . ']',
152	146	'\?' => '[^' . $dirSep . ']'
153		];
154	146	$rePattern = str_replace(array_keys($patternReplacements), array_values($patternReplacements), $rePattern);
155	146	$rePattern = '/^' . $rePattern . '$/' . ($isCaseSensitive ? '' : 'i');
156
157	146	return (bool) preg_match($rePattern, $str);
158		}
159
160		/**
161		* Tests whether or not a string matches against a pattern.
162		* The pattern may contain two special characters:<br>
163		* '*' means zero or more characters<br>
164		* '?' means one and only one character
165		*
166		* @param string $pattern The pattern to match against.
167		* Must not be
168		* <code>null</code>.
169		* @param string $str The string which must be matched against the pattern.
170		* Must not be <code>null</code>.
171		* @param bool $isCaseSensitive Whether or not matching should be performed
172		* case sensitively.case sensitively.
173		*
174		* @return bool <code>true</code> if the string matches against the pattern,
175		* or <code>false</code> otherwise.
176		*/
177	25	public static function match($pattern, $str, $isCaseSensitive = true)
178		{
179	25	$rePattern = preg_quote($pattern, '/');
180	25	$rePattern = str_replace(["\", "\?"], ['.', '.'], $rePattern);
181	25	$rePattern = '/^' . $rePattern . '$/' . ($isCaseSensitive ? '' : 'i');
182
183	25	return (bool) preg_match($rePattern, $str);
184		}
185
186		/**
187		* Returns dependency information on these two files. If src has been
188		* modified later than target, it returns true. If target doesn't exist,
189		* it likewise returns true. Otherwise, target is newer than src and
190		* is not out of date, thus the method returns false. It also returns
191		* false if the src file doesn't even exist, since how could the
192		* target then be out of date.
193		*
194		* @param File $src the original file
195		* @param File $target the file being compared against
196		* @param int $granularity the amount in seconds of slack we will give in
197		* determining out of dateness
198		* @return bool whether the target is out of date
199		*/
200	3	public static function isOutOfDate(File $src, File $target, $granularity)
201		{
202	3	if (!$src->exists()) {
203	1	return false;
204		}
205	2	if (!$target->exists()) {
206	1	return true;
207		}
208	1	if (($src->lastModified() - $granularity) > $target->lastModified()) {
209		return true;
210		}
211
212	1	return false;
213		}
214
215		/**
216		* @param string $string
217		* @return string
218		*/
219	1	public static function removeWhitespace($string)
220		{
221	1	return preg_replace(
222	1	"/(\t\|\n\|\v\|\f\|\r\| \|\xC2\x85\|\xc2\xa0\|\xe1\xa0\x8e\|\xe2\x80[\x80-\x8D]\|\xe2\x80\xa8\|\xe2\x80\xa9\|\xe2\x80\xaF\|\xe2\x81\x9f\|\xe2\x81\xa0\|\xe3\x80\x80\|\xef\xbb\xbf)+/",
223	1	'',
224	1	$string
225		);
226		}
227		}
228

phingofficial / phing

Push — master ( eabf33...342b63 )

SelectorUtils::matchPatternStart() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like