Merge pull request #32 from madewithlove/more-server-variable-support

Add support for all kinds of custom server variables

README.md

@@ -52,19 +52,13 @@ Test are stopped, a redirect will be made with status code 302"
 
 ### Server variables
 
-Htaccess Tester supports passing a predefined set of server variables to be evaluated by the rewrite rules.
+Htaccess Tester supports passing server variables to be evaluated by the rewrite rules.
 We currently support the following variables.
-```
-HTTP_REFERER
-HTTP_USER_AGENT
-SERVER_NAME
-REMOTE_ADDR
-```
 
 Server variables can be passed to the `test()` and `share()` methods.
 ```php
 $serverVariables = ServerVariables::default()->with(
-    ServerVariable::SERVER_NAME,
+    'SERVER_NAME',
     'example.com'
 );
 

phpstan.neon

@@ -1,5 +1,5 @@
 parameters:
-    level: 5
+    level: max
     paths:
         - src
         - tests

src/HtaccessClient.php

@@ -102,15 +102,22 @@ function (array $line) {
         );
     }
 
+    /**
+     * @param array<string,mixed> $requestData
+     * @return array<string,mixed>
+     */
     private function request(string $method, string $endpoint = '', array $requestData = []): array
     {
         $request = $this->requestFactory->createServerRequest(
             $method,
             'https://htaccess.madewithlove.be/api' . $endpoint
         );
 
+        /** @var string $requestBody */
+        $requestBody = json_encode($requestData);
+
         $body = $request->getBody();
-        $body->write(json_encode($requestData));
+        $body->write($requestBody);
 
         $request = $request
             ->withHeader('Content-Type', 'application/json')

src/HtaccessException.php

@@ -6,6 +6,9 @@
 
 class HtaccessException extends Exception
 {
+    /**
+     * @param array<int,array{field: string, message: string}> $errors
+     */
     public static function fromApiErrors(array $errors): self
     {
         $errorMessages = array_map(

src/ServerVariable.php

@@ -4,6 +4,9 @@
 
 namespace Madewithlove;
 
+/**
+ * @deprecated use regular strings instead of the constants included in this class
+ */
 final class ServerVariable
 {
     public const HTTP_REFERER = 'HTTP_REFERER';

src/ServerVariables.php

@@ -8,6 +8,9 @@
 
 class ServerVariables
 {
+    /**
+     * @param array<string, string> $variables
+     */
     private function __construct(
         private array $variables
     ) {
@@ -20,7 +23,7 @@ public static function default(): self
 
     public function with(string $optionName, string $value): self
     {
-        if (!in_array($optionName, ServerVariable::ALL)) {
+        if (!preg_match('/^[a-zA-Z1-9_\-:]+$/', $optionName)) {
             throw new InvalidArgumentException('Unsupported server variable: ' . $optionName);
         }
 
@@ -40,6 +43,9 @@ public function get(string $optionName): string
         return $this->variables[$optionName] ?? '';
     }
 
+    /**
+     * @return array<string, string>
+     */
     public function toArray(): array
     {
         return $this->variables;

tests/HtaccessClientTest.php

@@ -302,4 +302,25 @@ public function it can share a test run with a server name(): void
             $sharedResult->getOutputUrl()
         );
     }
+
+    /** @test */
+    public function it accepts custom server variables as well(): void
+    {
+        $client = new HtaccessClient(
+            new Client(),
+            new ServerRequestFactory()
+        );
+
+        $response = $client->test(
+            'http://localhost',
+            'RewriteCond %{CUSTOM_VARIABLE} example.com
+             RewriteRule .* /example-page [L]',
+            ServerVariables::default()->with('CUSTOM_VARIABLE', 'example.com')
+        );
+
+        $this->assertEquals(
+            'http://localhost/example-page',
+            $response->getOutputUrl()
+        );
+    }
 }

tests/ServerVariablesTest.php

@@ -9,12 +9,45 @@
 
 class ServerVariablesTest extends TestCase
 {
-    /** @test */
-    public function it only allows supported variables(): void
+    /**
+     * @test
+     * @dataProvider providesInvalidServerVariableNames
+     */
+    public function it does not support variables using unsupported characters(string $serverVariableName): void
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('Unsupported server variable: foo');
-        ServerVariables::default()->with('foo', 'bar');
+        $this->expectExceptionMessage('Unsupported server variable: ' . $serverVariableName);
+        ServerVariables::default()->with($serverVariableName, 'bar');
+    }
+
+    /**
+     * @return array<int, array<string>>
+     */
+    public function providesInvalidServerVariableNames(): array
+    {
+        return [
+            [
+                'PERCENTAGE_NOT_ALLOWED%',
+            ],
+            [
+                'CURLY_BRACE_NOT_ALLOWED{',
+            ],
+            [
+                'CURLY_BRACE_NOT_ALLOWED}',
+            ],
+            [
+                'DOLLAR_NOT_ALLOWED$',
+            ],
+            [
+                'CARRET_NOT_ALLOWED^',
+            ],
+            [
+                '%ALSO_NOT_ALLOWED_IN_BEGINNING_OF_LINE',
+            ],
+            [
+                'ALSO_NOT_ALLOWED_IN_%MIDDLE_OF_LINE',
+            ],
+        ];
     }
 
     /** @test */