Merge pull request #3 from swisnl/feature/strict-mode

Strict mode

Author: JaZo

README.md

@@ -55,6 +55,11 @@ Please see the following table for some examples.
 |                                                     |     | /path/to/fixtures/example.com/api/comments.get.mock |
 |                                                     |     | /path/to/fixtures/example.com/api/comments.mock |
 
+### Strict mode
+The `ReponseBuilder` can be set to strict mode using `setStrictMode(true)`.
+When in strict mode, only the first possible fixture path will be used.
+This means that both the method and query params must be present in the fixture file name and it does not fall back to other fixture files.
+
 ### Helper
 <UrlHelper>Please see <a href="https://swisnl.github.io/php-http-fixture-client/#helper">https://swisnl.github.io/php-http-fixture-client/#helper</a> for the URL helper.</UrlHelper>
 

docs/.vuepress/components/UrlHelper.vue

@@ -15,6 +15,8 @@
             <option value="trace">TRACE</option>
             <option value="patch">PATCH</option>
         </select>
+        <h4>Strict mode</h4>
+        <label><input type="checkbox" v-model="strictMode"> Use strict mode</label>
         <h4>Possible fixtures (in order of specificity)</h4>
         <ol v-if="fixtures.length">
             <li v-for="fixture in fixtures">/path/to/fixtures/{{ fixture }}</li>
@@ -196,7 +198,8 @@
         data() {
             return {
                 url: '',
-                method: 'get'
+                method: 'get',
+                strictMode: false
             };
         },
 
@@ -223,6 +226,10 @@
                 fixtures.push(`${url.hostname}${pathname}.${this.method}.mock`);
                 fixtures.push(`${url.hostname}${pathname}.mock`);
 
+                if (this.strictMode) {
+                    fixtures = fixtures.slice(0, 1);
+                }
+
                 return fixtures;
             }
         },

src/ResponseBuilder.php

@@ -40,6 +40,11 @@ class ResponseBuilder implements ResponseBuilderInterface
      */
     private $responseFactory;
 
+    /**
+     * @var bool
+     */
+    private $strictMode = false;
+
     /**
      * @param string                             $fixturesPath
      * @param array                              $domainAliases
@@ -52,6 +57,26 @@ public function __construct(string $fixturesPath, array $domainAliases = [], Res
         $this->responseFactory = $responseFactory ?: MessageFactoryDiscovery::find();
     }
 
+    /**
+     * @return bool
+     */
+    public function useStrictMode(): bool
+    {
+        return $this->strictMode;
+    }
+
+    /**
+     * @param bool $strictMode
+     *
+     * @return self
+     */
+    public function setStrictMode(bool $strictMode): self
+    {
+        $this->strictMode = $strictMode;
+
+        return $this;
+    }
+
     /**
      * @param \Psr\Http\Message\RequestInterface $request
      *
@@ -184,6 +209,10 @@ protected function getPossibleMockFilePathsForRequest(RequestInterface $request,
         $possibleFiles[] = implode('.', [$basePathToFile, $method, $type]);
         $possibleFiles[] = implode('.', [$basePathToFile, $type]);
 
+        if ($this->useStrictMode()) {
+            $possibleFiles = array_slice($possibleFiles, 0, 1);
+        }
+
         return $possibleFiles;
     }
 

tests/ResponseBuilderTest.php

@@ -62,6 +62,29 @@ public function getResponses(): array
         ];
     }
 
+    /**
+     * @test
+     */
+    public function it_can_be_set_to_strict_mode()
+    {
+        $builder = $this->getBuilder();
+
+        // Strict mode off
+        $this->assertFalse($builder->useStrictMode());
+
+        $messageFactory = MessageFactoryDiscovery::find();
+        $builder->build($messageFactory->createRequest('POST', 'http://example.com/api/articles?foo=bar'));
+
+        // Strict mode on
+        $builder->setStrictMode(true);
+        $this->assertTrue($builder->useStrictMode());
+
+        $this->expectException(MockNotFoundException::class);
+
+        $messageFactory = MessageFactoryDiscovery::find();
+        $builder->build($messageFactory->createRequest('POST', 'http://example.com/api/articles?foo=bar'));
+    }
+
     /**
      * @test
      */