Add Parameter Type {raw} (Fix #56)

cundd · Apr 6, 2019 · 3047fad · 3047fad
1 parent 8aceb0b
commit 3047fad
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 2 deletions.
diff --git a/Classes/Router/ParameterType.php b/Classes/Router/ParameterType.php
@@ -41,6 +41,9 @@ private static function createParameter($input)
                 case 'string':
                     return ParameterTypeInterface::SLUG;
 
+                case 'raw':
+                    return ParameterTypeInterface::RAW;
+
                 case 'float':
                 case 'double':
                 case 'number':

diff --git a/Classes/Router/ParameterTypeInterface.php b/Classes/Router/ParameterTypeInterface.php
@@ -9,4 +9,5 @@ interface ParameterTypeInterface
     const FLOAT = 'float';
     const SLUG = 'slug';
     const BOOLEAN = 'boolean';
+    const RAW = 'raw';
 }
diff --git a/Classes/Router/Router.php b/Classes/Router/Router.php
@@ -28,13 +28,13 @@ class Router implements RouterInterface
      */
     public function dispatch(RestRequestInterface $request)
     {
-        $parameters = $this->getPreparedParameters($request);
         $route = $this->getMatchingRoute($request);
-
         if (!$route) {
             return new NotFoundException();
         }
 
+        $parameters = $this->getPreparedParametersForRoute($request, $route);
+
         return $route->process($request, ...$parameters);
     }
 
@@ -148,6 +148,18 @@ public function getPreparedParameters(RestRequestInterface $request)
             return [];
         }
 
+        return $this->getPreparedParametersForRoute($request, $route);
+    }
+
+    /**
+     * Returns the prepared parameters
+     *
+     * @param RestRequestInterface $request
+     * @param RouteInterface       $route
+     * @return array
+     */
+    private function getPreparedParametersForRoute(RestRequestInterface $request, RouteInterface $route)
+    {
         $segments = explode('/', $request->getPath());
         $parameters = [];
         foreach ($route->getParameters() as $index => $type) {
@@ -167,6 +179,7 @@ public function getPreparedParameters(RestRequestInterface $request)
     private function getPreparedParameter($type, $segment)
     {
         switch ($type) {
+            case ParameterTypeInterface::RAW:
             case ParameterTypeInterface::SLUG:
                 return (string)$segment;
             case ParameterTypeInterface::BOOLEAN:
@@ -188,6 +201,7 @@ private function patternToRegularExpression($pattern)
     {
         $outputPattern = $pattern;
         $parameterTypeToRegex = [
+            ParameterTypeInterface::RAW     => '[^/]+',
             ParameterTypeInterface::SLUG    => '[a-zA-Z0-9\._\-]+',
             ParameterTypeInterface::INTEGER => '[0-9]+',
             ParameterTypeInterface::FLOAT   => '[0-9]+\.[0-9]+',

diff --git a/Documentation/Customize.md b/Documentation/Customize.md
@@ -228,6 +228,21 @@ Route::get($request->getResourceType() . '/{boolean}', function(RestRequestInter
 ```
 
 
+### Matching anything aka. `raw`
+
+Extracts the value from segments matching the regular expression `[^/]+`
+
+```php
+Route::get($request->getResourceType() . '/{raw}', function(RestRequestInterface $request, $theParameter) {
+    // Callback will be invoked for
+    # curl -X GET http://localhost:8888/rest/customhandler/Mr Müller
+    // with $theParameter set to 'Mr%20Müller'
+});
+```
+
+> The parameter value will not be decoded before being passed to the route callback
+
+
 Response
 --------
 

diff --git a/Tests/Unit/Router/RouteTest.php b/Tests/Unit/Router/RouteTest.php
@@ -186,9 +186,13 @@ public function patternsWithExpressionsHaveLowerPriorityDataProvider()
             ['path/{string}/{float}/1', 'path/sub-path/another/1'],
             ['path/sub-path/{string}/1/2/path/item/x', 'path/sub-path/another/1/2/path/item/x'],
             ['path/sub-path/{string}/1/2/path/item/x/y', 'path/sub-path/another/1/2/path/item/x/y'],
+            ['path/sub-path/{raw}/1/2/path/item/x/y', 'path/sub-path/another/1/2/path/item/x/y'],
 
             ['path/sub-path/{string}/{int}/2/path/item/x', 'path/sub-path/{string}/1/2/path/item/x'],
             ['path/sub-path/{string}/{int}/2/path/item/x/y', 'path/sub-path/{string}/1/2/path/item/x/y'],
+
+            ['path/sub-path/{raw}/{int}/2/path/item/x', 'path/sub-path/{string}/1/2/path/item/x'],
+            ['path/sub-path/{raw}/{int}/2/path/item/x/y', 'path/sub-path/{string}/1/2/path/item/x/y'],
         ];
     }
 
@@ -289,6 +293,15 @@ public function getParametersDataProvider()
                 'path/sub-path/{string}/{int}/2/path/item/x/y',
                 [ParameterTypeInterface::SLUG, ParameterTypeInterface::INTEGER],
             ],
+
+            [
+                'path/sub-path/{string}/{raw}/2/path/item/x',
+                [ParameterTypeInterface::SLUG, ParameterTypeInterface::RAW],
+            ],
+            [
+                'path/sub-path/{string}/{raw}/2/path/item/x/y',
+                [ParameterTypeInterface::SLUG, ParameterTypeInterface::RAW],
+            ],
         ];
     }
 

diff --git a/Tests/Unit/Router/RouterTest.php b/Tests/Unit/Router/RouterTest.php
@@ -109,6 +109,30 @@ public function getPreparedParametersDataProvider()
             ['path/{slug}/sub-path/{float}/{bool}/{int}/?', '/slug/sub-path/1.0/no/9', [], true],
             ['path/{slug}/sub-path/{float}/{bool}/{int}/?', '/', [], true],
             ['path/{slug}/sub-path/{float}/{bool}/{int}/?', '', [], true],
+            [
+                'path/{raw}/?',
+                '/path/here could be änything but a slash',
+                ['here%20could%20be%20änything%20but%20a%20slash'],
+                false,
+            ],
+            [
+                'path/{raw}/?',
+                '/path/here could be änything but a slash/',
+                ['here%20could%20be%20änything%20but%20a%20slash'],
+                false,
+            ],
+            [
+                'path/{raw}/{int}/?',
+                '/path/here could be änything but a slash/1',
+                ['here%20could%20be%20änything%20but%20a%20slash', 1],
+                false,
+            ],
+            [
+                'path/{raw}/?',
+                '/path/Mr Müller/',
+                ['Mr%20Müller'],
+                false,
+            ],
         ];
     }