Replace danielstjules/stringy with symfony/string

The former isn't maintained anymore and triggers some deprecations on PHP 8.1.

Author: JaZo

CHANGELOG.md

@@ -12,6 +12,7 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 ### Changed
 - The `ResponseBuilder` now requires PSR-17 factories instead of a PHP-HTTP factory, to align it with the `Client`. This is only a breaking change in the rare case where you provide your own factory to the `ResponseBuilder`.
 - Removed `domainAliases` from constructor arguments. Please use `setDomainAliases()` on the instance instead.
+- Replaced [danielstjules/stringy](https://packagist.org/packages/danielstjules/stringy) with [symfony/string](https://packagist.org/packages/symfony/string). In some edge cases, mainly special or accented characters, this will affect how query parameters are transformed to a fixture.
 
 ### Removed
 - Dropped PHP <7.4 support.

README.md

@@ -67,7 +67,7 @@ The `ReponseBuilder` can be instructed to ignore certain query parameters using
 When configured, the provided parameters will be ignored when transforming requests to file paths.
 You should only provide the parameter name, not the value.
 This allows you to ignore 'dynamic' parameters that change in each test execution.
-Parameters are matched strictly, so 'foo' will match 'foo=bar', but not 'foo[]=bar'.
+Parameters are matched strictly, after url decoding, so 'foo' will match 'foo=bar', but not 'foo[]=bar'.
 
 ### Strict mode
 The `ReponseBuilder` can be set to strict mode using `setStrictMode(true)`.

composer.json

@@ -23,11 +23,11 @@
     ],
     "require": {
         "php": "^7.4|^8.0",
-        "danielstjules/stringy": "^3.1",
         "php-http/discovery": "^1.4",
         "php-http/mock-client": "^1.5",
         "psr/http-factory": "^1.0",
-        "psr/http-message": "^1.0"
+        "psr/http-message": "^1.0",
+        "symfony/string": "^5.4|^6.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.0",

docs/.vuepress/components/UrlHelper.vue

@@ -1,6 +1,6 @@
 <template>
     <div>
-        <p>Use this helper to generate the possible fixtures for your own URL.</p>
+        <p>Use this helper to generate the possible fixtures for your own URL. Please note this is a simple JavaScript port and it will not be 100% accurate for special or accented characters.</p>
         <h4><label for="url">URL</label></h4>
         <input class="input" type="text" id="url" placeholder="http://example.com/api/comments?query=json&order=id" v-model="url"/>
         <h4><label for="method">Method</label></h4>
@@ -75,7 +75,7 @@
                    'ŏ', 'ο', 'ὀ', 'ὁ', 'ὂ', 'ὃ', 'ὄ', 'ὅ', 'ὸ', 'ό',
                    'о', 'و', 'θ', 'ို', 'ǒ', 'ǿ', 'º', 'ო', 'ओ', 'ｏ',
                    'ö'],
-        'p'     : ['п', 'π', 'ပ', 'პ', 'پ', 'ｐ'],
+        'p'     : ['п', 'π', 'ပ', 'პ', 'پ', 'ｐ', 'ƥ'],
         'q'     : ['ყ', 'ｑ'],
         'r'     : ['ŕ', 'ř', 'ŗ', 'р', 'ρ', 'ر', 'რ', 'ｒ'],
         's'     : ['ś', 'š', 'ş', 'с', 'σ', 'ș', 'ς', 'س', 'ص', 'စ',
@@ -253,27 +253,20 @@
                     .map(param => {
                         return param.replace(/[\\/?:*"><|]/g, REPLACEMENT);
                     })
-                    // toAscii
+                    // folded + ascii
                     .map(param => {
                         Object.keys(CHARS).forEach(key => {
                             param = param.replace(new RegExp(`[${CHARS[key].join('')}]`, 'g'), key);
                         });
-
-                        return param.replace(/[^\x20-\x7E]/gu, '');
-                    })
-                    // delimit
-                    .map(param => {
-                        return param.replace(/\B([A-Z])/g, '-$1')
-                            .toLowerCase()
-                            .replace(/[-_\s]+/g, REPLACEMENT);
+                        return param.toLowerCase().replace(/[^\x20-\x7E]/gu, '');
                     })
-                    // removeLeft
+                    // replaceMatches
                     .map(param => {
-                        return param.replace(new RegExp(`^${REPLACEMENT}+`), '');
+                        return param.replace(/[-_\s]+/, REPLACEMENT);
                     })
-                    // removeRight
+                    // trim
                     .map(param => {
-                        return param.replace(new RegExp(`${REPLACEMENT}+$`), '');
+                        return param.replace(new RegExp(`^${REPLACEMENT}+|${REPLACEMENT}+$`), '');
                     })
                     .join('&');
             }

src/ResponseBuilder.php

@@ -8,7 +8,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamFactoryInterface;
 use Psr\Http\Message\StreamInterface;
-use Stringy\Stringy;
+use Symfony\Component\String\UnicodeString;
 
 class ResponseBuilder implements ResponseBuilderInterface
 {
@@ -324,11 +324,12 @@ function (string $part) {
         sort($parts);
         $query = implode('&', $parts);
 
-        return (string) Stringy::create(str_replace(['\\', '/', '?', ':', '*', '"', '>', '<', '|'], $replacement, $query))
-            ->toAscii()
-            ->delimit($replacement)
-            ->removeLeft($replacement)
-            ->removeRight($replacement);
+        return (new UnicodeString(str_replace(['\\', '/', '?', ':', '*', '"', '>', '<', '|'], $replacement, $query)))
+            ->folded()
+            ->ascii()
+            ->replaceMatches('/[-_\s]+/', $replacement)
+            ->trim($replacement)
+            ->toString();
     }
 
     /**