Fix #51: Add an option withEnding() to WildcardPattern for match …

…ending of testing string

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 1.0.2 under development
 
+- Enh #51: Add an option `withEnding()` to `WildcardPattern` for match ending of testing string (vjik)
 - Bug #44: `NumericHelper::toOrdinal` throws an error for numbers with fractional part (vjik)
 
 ## 1.0.1 October 12, 2020

README.md

@@ -161,6 +161,7 @@ Several options are available. Call these before doing a `match()`:
 - `withExactSlashes()` - makes `\` in a string to match `\` only in a pattern. 
 - `ignoreCase()` - case-insensitive match.
 - `withExactLeadingPeriod()` - makes first `.` in a string match only `.` in a pattern.
+- `withEnding()` - match ending of testing string.
 
 When matching file paths, it is advised to use both `withExactSlashes()` and `withExactLeadingPeriod()`:
 

src/WildcardPattern.php

@@ -27,6 +27,7 @@ final class WildcardPattern
     private bool $matchSlashesExactly = false;
     private bool $matchLeadingPeriodExactly = false;
     private bool $ignoreCase = false;
+    private bool $matchEnding = false;
     private string $pattern;
 
     /**
@@ -77,7 +78,7 @@ public function match(string $string): bool
         }
 
         $pattern = strtr(preg_quote($pattern, '#'), $replacements);
-        $pattern = '#^' . $pattern . '$#us';
+        $pattern = '#' . ($this->matchEnding ? '' : '^') . $pattern . '$#us';
 
         if ($this->ignoreCase) {
             $pattern .= 'i';
@@ -135,4 +136,17 @@ public function withExactLeadingPeriod(bool $flag = true): self
         $new->matchLeadingPeriodExactly = $flag;
         return $new;
     }
+
+    /**
+     * Match ending only.
+     * By default wildcard pattern matches string exactly. By using this mode, beginning of the string could be anything.
+     * @param bool $flag
+     * @return self
+     */
+    public function withEnding(bool $flag = true): self
+    {
+        $new = clone $this;
+        $new->matchEnding = $flag;
+        return $new;
+    }
 }

tests/WildcardPatternTest.php

@@ -86,6 +86,13 @@ public function dataProviderMatchWildcard(): array
             ['begin\*\end', 'begin\end', false, ['escape' => false]],
             ['begin\*\end', 'begin\middle\end', true, ['filePath' => true, 'escape' => false]],
             ['begin\*\end', 'begin\two\steps\end', false, ['filePath' => true, 'escape' => false]],
+            // ending
+            ['i/*.jpg', 'i/hello.jpg', true, ['ending' => true]],
+            ['i/*.jpg', 'i/hello.jpg', true, ['ending' => true, 'filePath' => true]],
+            ['i/*.jpg', 'i/h/hello.jpg', true, ['ending' => true]],
+            ['i/*.jpg', 'i/h/hello.jpg', false, ['ending' => true, 'filePath' => true]],
+            ['i/*.jpg', 'path/to/i/hello.jpg', true, ['ending' => true]],
+            ['i/*.jpg', 'path/to/i/hello.jpg', true, ['ending' => true, 'filePath' => true]],
         ];
     }
 
@@ -118,12 +125,20 @@ private function getWildcardPattern(string $pattern, array $options): WildcardPa
         if (isset($options['leadingPeriod']) && $options['leadingPeriod'] === true) {
             $wildcardPattern = $wildcardPattern->withExactLeadingPeriod();
         }
+        if (isset($options['ending']) && $options['ending'] === true) {
+            $wildcardPattern = $wildcardPattern->withEnding();
+        }
 
         return $wildcardPattern;
     }
 
     public function testDisableOptions(): void
     {
+        $wildcardPattern = (new WildcardPattern('abc'))
+            ->withEnding()
+            ->withEnding(false);
+        $this->assertFalse($wildcardPattern->match('42abc'));
+
         $wildcardPattern = (new WildcardPattern('\*42'))
             ->withoutEscape()
             ->withoutEscape(false);
@@ -152,5 +167,6 @@ public function testImmutability(): void
         $this->assertNotSame($original, $original->ignoreCase());
         $this->assertNotSame($original, $original->withExactSlashes());
         $this->assertNotSame($original, $original->withoutEscape());
+        $this->assertNotSame($original, $original->withEnding());
     }
 }