CombinedRegexp::matchPattern() - Code Metrics - Inspection of "Combined regexp" - yiisoft/strings - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#102)

by Dmitriy

created 2023-06-11 18:35 UTC

CombinedRegexp::matchPattern() A

↳ Parent: CombinedRegexp

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	2
b	0
f	0
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php

declare(strict_types=1);

namespace Yiisoft\Strings;

/**
 * `CombinedRegexp` optimizes matching of multiple regular expressions.
 * Read more about the concept in
 * {@see https://nikic.github.io/2014/02/18/Fast-request-routing-using-regular-expressions.html}.
 */
final class CombinedRegexp
{
    private const REGEXP_DELIMITER = '/';
    private const QUOTE_REPLACER = '\\/';

    /**
     * @var string[]
     */
    private array $patterns;
    private string $compiledPattern;

    /**
     * @param string[] $patterns Regular expressions to combine.
     * @param string $flags Regular expression flags.
     */
    public function __construct(
        array $patterns,
        string $flags = ''
    ) {
        $this->patterns = $patterns;
        $this->compiledPattern = $this->compilePatterns($patterns) . $flags;
    }

    /**
     * @return string The compiled pattern.
     */
    public function getCompiledPattern(): string
    {
        return $this->compiledPattern;
    }

    /**
     * Returns `true` whether the given string matches any of the patterns, `false` - otherwise.
     */
    public function matches(string $string): bool
    {
        return preg_match($this->compiledPattern, $string) === 1;
    }

    /**
     * Returns pattern that matches the given string.
     * @throws \Exception if the string does not match any of the patterns.
     */
    public function matchPattern(string $string): string
    {
        return $this->patterns[$this->matchPatternPosition($string)];
    }

    /**
     * Returns position of the pattern that matches the given string.
     * @throws \Exception if the string does not match any of the patterns.
     */
    public function matchPatternPosition(string $string): int
    {
        $match = preg_match($this->compiledPattern, $string, $matches);
        if ($match !== 1) {
            throw new \Exception(
                sprintf(
                    'Failed to match pattern "%s" with string "%s".',
                    $this->getCompiledPattern(),
                    $string,
                )
            );
        }

        return count($matches) - 1;
    }

    /**
     * @param string[] $patterns
     */
    private function compilePatterns(array $patterns): string
    {
        $quotedPatterns = [];

        for ($i = 0; $i < count($patterns); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            $quotedPatterns[] = $patterns[$i] . str_repeat('()', $i);
        }
        $combinedRegexps = '(?|' . strtr(
            implode('|', $quotedPatterns),
            [self::REGEXP_DELIMITER => self::QUOTE_REPLACER]
        ) . ')';

        return self::REGEXP_DELIMITER . $combinedRegexps . self::REGEXP_DELIMITER;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Strings;
6
7		/**
8		* `CombinedRegexp` optimizes matching of multiple regular expressions.
9		* Read more about the concept in
10		* {@see https://nikic.github.io/2014/02/18/Fast-request-routing-using-regular-expressions.html}.
11		*/
12		final class CombinedRegexp
13		{
14		private const REGEXP_DELIMITER = '/';
15		private const QUOTE_REPLACER = '\\/';
16
17		/**
18		* @var string[]
19		*/
20		private array $patterns;
21		private string $compiledPattern;
22
23		/**
24		* @param string[] $patterns Regular expressions to combine.
25		* @param string $flags Regular expression flags.
26		*/
27	17	public function __construct(
28		array $patterns,
29		string $flags = ''
30		) {
31	17	$this->patterns = $patterns;
32	17	$this->compiledPattern = $this->compilePatterns($patterns) . $flags;
33		}
34
35		/**
36		* @return string The compiled pattern.
37		*/
38	17	public function getCompiledPattern(): string
39		{
40	17	return $this->compiledPattern;
41		}
42
43		/**
44		* Returns `true` whether the given string matches any of the patterns, `false` - otherwise.
45		*/
46	11	public function matches(string $string): bool
47		{
48	11	return preg_match($this->compiledPattern, $string) === 1;
49		}
50
51		/**
52		* Returns pattern that matches the given string.
53		* @throws \Exception if the string does not match any of the patterns.
54		*/
55	5	public function matchPattern(string $string): string
56		{
57	5	return $this->patterns[$this->matchPatternPosition($string)];
58		}
59
60		/**
61		* Returns position of the pattern that matches the given string.
62		* @throws \Exception if the string does not match any of the patterns.
63		*/
64	8	public function matchPatternPosition(string $string): int
65		{
66	8	$match = preg_match($this->compiledPattern, $string, $matches);
67	8	if ($match !== 1) {
68		throw new \Exception(
69		sprintf(
70		'Failed to match pattern "%s" with string "%s".',
71		$this->getCompiledPattern(),
72		$string,
73		)
74		);
75		}
76
77	8	return count($matches) - 1;
78		}
79
80		/**
81		* @param string[] $patterns
82		*/
83	17	private function compilePatterns(array $patterns): string
84		{
85	17	$quotedPatterns = [];
86
87	17	for ($i = 0; $i < count($patterns); $i++) {
		0 ignored issues – show Performance Best Practice introduced 2023-06-11 17:28 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
88	17	$quotedPatterns[] = $patterns[$i] . str_repeat('()', $i);
89		}
90	17	$combinedRegexps = '(?\|' . strtr(
91	17	implode('\|', $quotedPatterns),
92	17	[self::REGEXP_DELIMITER => self::QUOTE_REPLACER]
93	17	) . ')';
94
95	17	return self::REGEXP_DELIMITER . $combinedRegexps . self::REGEXP_DELIMITER;
96		}
97		}
98

yiisoft / strings

Pull Request — master (#102)

CombinedRegexp::matchPattern() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like