Merge pull request #194 from ramchale/AbstractSeparator

Remove AbstractSeparator
laminas · Nov 8, 2024 · 55ef969 · 55ef969
2 parents 25d0693 + 813ea51
commit 55ef969
Show file tree

Hide file tree

Showing 9 changed files with 68 additions and 158 deletions.
diff --git a/docs/book/v3/migration/v2-to-v3.md b/docs/book/v3/migration/v2-to-v3.md
@@ -131,6 +131,10 @@ Additionally, `$options['pattern']` _must_ be provided at construction time or a
 
 Exceptions for invalid or empty patterns are now thrown during construct rather than when the filter is invoked.
 
+#### `SeparatorToCamelCase`
+
+The constructor now only accepts an associative array of [documented options](../word.md#separatorToCamelCase).
+
 #### `SeparatorToDash`
 
 The constructor now only accepts an associative array of [documented options](../word.md#separatorToDash).

diff --git a/docs/book/v3/word.md b/docs/book/v3/word.md
@@ -168,8 +168,7 @@ The following options are supported for `Laminas\Filter\Word\SeparatorToCamelCas
 ### Basic Usage
 
 ```php
-$filter = new Laminas\Filter\Word\SeparatorToCamelCase(':');
-// or new Laminas\Filter\Word\SeparatorToCamelCase(array('separator' => ':'));
+$filter = new Laminas\Filter\Word\SeparatorToCamelCase(['separator' => ':']);
 
 print $filter->filter('this:is:my:content');
 ```

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -22,6 +22,9 @@
     <PossiblyInvalidPropertyAssignmentValue>
       <code><![CDATA[$this->options]]></code>
     </PossiblyInvalidPropertyAssignmentValue>
+    <PossiblyUnusedMethod>
+      <code><![CDATA[applyFilterOnlyToStringableValuesAndStringableArrayValues]]></code>
+    </PossiblyUnusedMethod>
     <RedundantConditionGivenDocblockType>
       <code><![CDATA[is_object($options)]]></code>
     </RedundantConditionGivenDocblockType>
@@ -577,41 +580,17 @@
       <code><![CDATA[is_string($attribute)]]></code>
     </RedundantConditionGivenDocblockType>
   </file>
-  <file src="src/Word/AbstractSeparator.php">
-    <DeprecatedClass>
-      <code><![CDATA[AbstractFilter]]></code>
-    </DeprecatedClass>
-    <DeprecatedMethod>
-      <code><![CDATA[setSeparator]]></code>
-      <code><![CDATA[setSeparator]]></code>
-    </DeprecatedMethod>
-    <PossiblyInvalidArgument>
-      <code><![CDATA[$separator]]></code>
-    </PossiblyInvalidArgument>
-    <PossiblyInvalidCast>
-      <code><![CDATA[$separator]]></code>
-    </PossiblyInvalidCast>
-    <PossiblyUnusedMethod>
-      <code><![CDATA[getSeparator]]></code>
-    </PossiblyUnusedMethod>
-  </file>
   <file src="src/Word/SeparatorToCamelCase.php">
     <MissingClosureParamType>
       <code><![CDATA[$matches]]></code>
       <code><![CDATA[$matches]]></code>
-      <code><![CDATA[$matches]]></code>
-      <code><![CDATA[$matches]]></code>
     </MissingClosureParamType>
     <MixedArgument>
       <code><![CDATA[$matches[1]]]></code>
-      <code><![CDATA[$matches[1]]]></code>
-      <code><![CDATA[$matches[2]]]></code>
       <code><![CDATA[$matches[2]]]></code>
     </MixedArgument>
     <MixedArrayAccess>
       <code><![CDATA[$matches[1]]]></code>
-      <code><![CDATA[$matches[1]]]></code>
-      <code><![CDATA[$matches[2]]]></code>
       <code><![CDATA[$matches[2]]]></code>
     </MixedArrayAccess>
   </file>
@@ -963,13 +942,4 @@
       <code><![CDATA[returnUnfilteredDataProvider]]></code>
     </PossiblyUnusedMethod>
   </file>
-  <file src="test/Word/UnderscoreToCamelCaseTest.php">
-    <MixedAssignment>
-      <code><![CDATA[$filtered]]></code>
-      <code><![CDATA[$filtered]]></code>
-      <code><![CDATA[$filtered]]></code>
-      <code><![CDATA[$filtered]]></code>
-      <code><![CDATA[$filtered]]></code>
-    </MixedAssignment>
-  </file>
 </files>
diff --git a/src/Word/AbstractSeparator.php b/src/Word/AbstractSeparator.php
diff --git a/src/Word/DashToCamelCase.php b/src/Word/DashToCamelCase.php
@@ -4,18 +4,18 @@
 
 namespace Laminas\Filter\Word;
 
-/**
- * @psalm-type Options = array{
- *     separator?: string,
- *     ...
- * }
- * @template TOptions of Options
- * @extends SeparatorToCamelCase<TOptions>
- */
-final class DashToCamelCase extends SeparatorToCamelCase
+use Laminas\Filter\FilterInterface;
+
+/** @implements FilterInterface<string|array<array-key, string|mixed>> */
+final class DashToCamelCase implements FilterInterface
 {
-    public function __construct()
+    public function filter(mixed $value): mixed
+    {
+        return (new SeparatorToCamelCase(['separator' => '-']))->filter($value);
+    }
+
+    public function __invoke(mixed $value): mixed
     {
-        parent::__construct('-');
+        return $this->filter($value);
     }
 }
diff --git a/src/Word/SeparatorToCamelCase.php b/src/Word/SeparatorToCamelCase.php
@@ -4,65 +4,57 @@
 
 namespace Laminas\Filter\Word;
 
-use Closure;
-use Laminas\Stdlib\StringUtils;
+use Laminas\Filter\FilterInterface;
+use Laminas\Filter\ScalarOrArrayFilterCallback;
 
 use function mb_strtoupper;
 use function preg_quote;
 use function preg_replace_callback;
-use function strtoupper;
 
 /**
  * @psalm-type Options = array{
  *     separator?: string,
- *     ...
  * }
- * @template TOptions of Options
- * @extends AbstractSeparator<TOptions>
+ * @implements FilterInterface<string|array<array-key, string|mixed>>
  */
-class SeparatorToCamelCase extends AbstractSeparator
+final class SeparatorToCamelCase implements FilterInterface
 {
-    public function filter(mixed $value): mixed
+    private readonly string $separator;
+
+    /** @param Options $options */
+    public function __construct(array $options = [])
     {
-        return self::applyFilterOnlyToStringableValuesAndStringableArrayValues(
-            $value,
-            Closure::fromCallable([$this, 'filterNormalizedValue'])
-        );
+        $this->separator = $options['separator'] ?? ' ';
     }
 
-    /**
-     * @param  string|string[] $value
-     * @return string|string[]
-     */
-    private function filterNormalizedValue($value)
+    public function filter(mixed $value): mixed
     {
         // a unicode safe way of converting characters to \x00\x00 notation
         $pregQuotedSeparator = preg_quote($this->separator, '#');
 
-        if (StringUtils::hasPcreUnicodeSupport()) {
-            $patterns     = [
-                '#(' . $pregQuotedSeparator . ')(\P{Z}{1})#u',
-                '#(^\P{Z}{1})#u',
-            ];
-            $replacements = [
-                static fn($matches): string => mb_strtoupper($matches[2], 'UTF-8'),
-                static fn($matches): string => mb_strtoupper($matches[1], 'UTF-8'),
-            ];
-        } else {
-            $patterns     = [
-                '#(' . $pregQuotedSeparator . ')([\S]{1})#',
-                '#(^[\S]{1})#',
-            ];
-            $replacements = [
-                static fn($matches): string => strtoupper($matches[2]),
-                static fn($matches): string => strtoupper($matches[1]),
-            ];
-        }
+        $patterns     = [
+            '#(' . $pregQuotedSeparator . ')(\P{Z}{1})#u',
+            '#(^\P{Z}{1})#u',
+        ];
+        $replacements = [
+            static fn($matches): string => mb_strtoupper($matches[2], 'UTF-8'),
+            static fn($matches): string => mb_strtoupper($matches[1], 'UTF-8'),
+        ];
 
-        $filtered = $value;
-        foreach ($patterns as $index => $pattern) {
-            $filtered = preg_replace_callback($pattern, $replacements[$index], $filtered);
-        }
-        return $filtered;
+        return ScalarOrArrayFilterCallback::applyRecursively(
+            $value,
+            function (string $input) use ($patterns, $replacements): string {
+                $filtered = $input;
+                foreach ($patterns as $index => $pattern) {
+                    $filtered = preg_replace_callback($pattern, $replacements[$index], $filtered);
+                }
+                return $filtered;
+            }
+        );
+    }
+
+    public function __invoke(mixed $value): mixed
+    {
+        return $this->filter($value);
     }
 }
diff --git a/src/Word/UnderscoreToCamelCase.php b/src/Word/UnderscoreToCamelCase.php
@@ -4,18 +4,18 @@
 
 namespace Laminas\Filter\Word;
 
-/**
- * @psalm-type Options = array{
- *     separator?: string,
- *     ...
- * }
- * @template TOptions of Options
- * @extends SeparatorToCamelCase<TOptions>
- */
-class UnderscoreToCamelCase extends SeparatorToCamelCase
+use Laminas\Filter\FilterInterface;
+
+/** @implements FilterInterface<string|array<array-key, string|mixed>> */
+class UnderscoreToCamelCase implements FilterInterface
 {
-    public function __construct()
+    public function filter(mixed $value): mixed
+    {
+        return (new SeparatorToCamelCase(['separator' => '_']))->filter($value);
+    }
+
+    public function __invoke(mixed $value): mixed
     {
-        parent::__construct('_');
+        return $this->filter($value);
     }
 }
diff --git a/src/Word/UnderscoreToStudlyCase.php b/src/Word/UnderscoreToStudlyCase.php
@@ -23,7 +23,7 @@ public function filter(mixed $value): mixed
         }
 
         /** @var string|array $value */
-        $value = (new SeparatorToCamelCase('_'))->filter($value);
+        $value = (new SeparatorToCamelCase(['separator' => '_']))->filter($value);
 
         return ScalarOrArrayFilterCallback::applyRecursively(
             $value,

diff --git a/test/Word/SeparatorToCamelCaseTest.php b/test/Word/SeparatorToCamelCaseTest.php
@@ -25,7 +25,7 @@ public function testFilterSeparatesCamelCasedWordsWithSpacesByDefault(): void
     public function testFilterSeparatesCamelCasedWordsWithProvidedSeparator(): void
     {
         $string   = 'camel:-:cased:-:Words';
-        $filter   = new SeparatorToCamelCaseFilter(':-:');
+        $filter   = new SeparatorToCamelCaseFilter(['separator' => ':-:']);
         $filtered = $filter($string);
 
         self::assertNotEquals($string, $filtered);
@@ -36,7 +36,7 @@ public function testFilterSeparatesCamelCasedWordsWithProvidedSeparator(): void
     public function testFilterSeparatesUniCodeCamelCasedWordsWithProvidedSeparator(): void
     {
         $string   = 'camel:-:cased:-:Words';
-        $filter   = new SeparatorToCamelCaseFilter(':-:');
+        $filter   = new SeparatorToCamelCaseFilter(['separator' => ':-:']);
         $filtered = $filter($string);
 
         self::assertNotEquals($string, $filtered);
@@ -47,7 +47,7 @@ public function testFilterSeparatesUniCodeCamelCasedWordsWithProvidedSeparator()
     public function testFilterSeparatesUniCodeCamelCasedUserWordsWithProvidedSeparator(): void
     {
         $string   = 'test šuma';
-        $filter   = new SeparatorToCamelCaseFilter(' ');
+        $filter   = new SeparatorToCamelCaseFilter(['separator' => ' ']);
         $filtered = $filter($string);
 
         self::assertNotEquals($string, $filtered);
@@ -58,7 +58,7 @@ public function testFilterSeparatesUniCodeCamelCasedUserWordsWithProvidedSeparat
     public function testFilterSeparatesCamelCasedNonAlphaWordsWithProvidedSeparator(): void
     {
         $string   = 'user_2_user';
-        $filter   = new SeparatorToCamelCaseFilter('_');
+        $filter   = new SeparatorToCamelCaseFilter(['separator' => '_']);
         $filtered = $filter($string);
 
         self::assertNotEquals($string, $filtered);