Merge pull request #66 from Sammyjo20/feature/closure-mock-responses

Feature | Added closure mocking

Author: Sammyjo20

src/Clients/BaseMockClient.php

@@ -80,12 +80,12 @@ public function addResponses(array $responses): void
     /**
      * Add a mock response to the client
      *
-     * @param MockResponse $response
+     * @param MockResponse|callable $response
      * @param string|null $captureMethod
      * @return void
      * @throws SaloonInvalidMockResponseCaptureMethodException
      */
-    public function addResponse(MockResponse $response, ?string $captureMethod = null): void
+    public function addResponse(MockResponse|callable $response, ?string $captureMethod = null): void
     {
         if (is_null($captureMethod)) {
             $this->sequenceResponses[] = $response;
@@ -144,26 +144,26 @@ public function guessNextResponse(SaloonRequest $request): MockResponse
         $requestClass = get_class($request);
 
         if (array_key_exists($requestClass, $this->requestResponses)) {
-            return $this->requestResponses[$requestClass];
+            return $this->mockResponseValue($this->requestResponses[$requestClass], $request);
         }
 
         $connectorClass = get_class($request->getConnector());
 
         if (array_key_exists($connectorClass, $this->connectorResponses)) {
-            return $this->connectorResponses[$connectorClass];
+            return $this->mockResponseValue($this->connectorResponses[$connectorClass], $request);
         }
 
         $guessedResponse = $this->guessResponseFromUrl($request);
 
         if (! is_null($guessedResponse)) {
-            return $guessedResponse;
+            return $this->mockResponseValue($guessedResponse, $request);
         }
 
         if (empty($this->sequenceResponses)) {
             throw new SaloonNoMockResponseFoundException;
         }
 
-        return $this->getNextFromSequence();
+        return $this->mockResponseValue($this->getNextFromSequence(), $request);
     }
 
     /**
@@ -173,7 +173,7 @@ public function guessNextResponse(SaloonRequest $request): MockResponse
      * @return MockResponse|null
      * @throws \Sammyjo20\Saloon\Exceptions\SaloonInvalidConnectorException
      */
-    private function guessResponseFromUrl(SaloonRequest $request): ?MockResponse
+    private function guessResponseFromUrl(SaloonRequest $request): MockResponse|callable|null
     {
         foreach ($this->urlResponses as $url => $response) {
             if (! URLHelper::matches($url, $request->getFullRequestUrl())) {
@@ -456,4 +456,20 @@ private function checkHistoryEmpty(): bool
     {
         return count($this->recordedResponses) <= 0;
     }
+
+    /**
+     * Create the mock response. If it is a callable, we will call it.
+     *
+     * @param MockResponse|callable $mockResponse
+     * @param SaloonRequest $request
+     * @return MockResponse
+     */
+    private function mockResponseValue(MockResponse|callable $mockResponse, SaloonRequest $request): MockResponse
+    {
+        if ($mockResponse instanceof MockResponse) {
+            return $mockResponse;
+        }
+
+        return $mockResponse($request);
+    }
 }

tests/Feature/MockRequestTest.php

@@ -2,6 +2,7 @@
 
 use Sammyjo20\Saloon\Http\MockResponse;
 use Sammyjo20\Saloon\Clients\MockClient;
+use Sammyjo20\Saloon\Http\SaloonRequest;
 use Sammyjo20\Saloon\Tests\Fixtures\Requests\UserRequest;
 use Sammyjo20\Saloon\Tests\Fixtures\Requests\ErrorRequest;
 use Sammyjo20\Saloon\Tests\Fixtures\Connectors\TestConnector;
@@ -157,3 +158,55 @@
     expect($responseC->json())->toEqual(['error' => 'Server Broken']);
     expect($responseC->status())->toEqual(500);
 });
+
+test('you can use a closure for the mock response', function () {
+    $sequenceMock = new MockClient([
+        function (SaloonRequest $request): MockResponse {
+            return new MockResponse(['request' => $request->getFullRequestUrl()]);
+        },
+    ]);
+
+    $sequenceResponse = UserRequest::make()->send($sequenceMock);
+
+    expect($sequenceResponse->isMocked())->toBeTrue();
+    expect($sequenceResponse->json())->toEqual(['request' => 'https://tests.saloon.dev/api/user']);
+
+    // Connector mock
+
+    $connectorMock = new MockClient([
+        TestConnector::class => function (SaloonRequest $request): MockResponse {
+            return new MockResponse(['request' => $request->getFullRequestUrl()]);
+        },
+    ]);
+
+    $connectorResponse = UserRequest::make()->send($connectorMock);
+
+    expect($connectorResponse->isMocked())->toBeTrue();
+    expect($connectorResponse->json())->toEqual(['request' => 'https://tests.saloon.dev/api/user']);
+
+    // Request mock
+
+    $requestMock = new MockClient([
+        UserRequest::class => function (SaloonRequest $request): MockResponse {
+            return new MockResponse(['request' => $request->getFullRequestUrl()]);
+        },
+    ]);
+
+    $requestResponse = UserRequest::make()->send($requestMock);
+
+    expect($requestResponse->isMocked())->toBeTrue();
+    expect($requestResponse->json())->toEqual(['request' => 'https://tests.saloon.dev/api/user']);
+
+    // URL mock
+
+    $urlMock = new MockClient([
+        'tests.saloon.dev/*' => function (SaloonRequest $request): MockResponse {
+            return new MockResponse(['request' => $request->getFullRequestUrl()]);
+        },
+    ]);
+
+    $urlResponse = UserRequest::make()->send($urlMock);
+
+    expect($urlResponse->isMocked())->toBeTrue();
+    expect($urlResponse->json())->toEqual(['request' => 'https://tests.saloon.dev/api/user']);
+});