Move domainAliases from constructor to setter

Author: JaZo

CHANGELOG.md

@@ -11,6 +11,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.
 
 ## [2.3.2] - 2021-08-30
 

src/ResponseBuilder.php

@@ -32,11 +32,6 @@ class ResponseBuilder implements ResponseBuilderInterface
      */
     private $fixturesPath;
 
-    /**
-     * @var array
-     */
-    private $domainAliases;
-
     /**
      * @var \Psr\Http\Message\ResponseFactoryInterface
      */
@@ -48,49 +43,51 @@ class ResponseBuilder implements ResponseBuilderInterface
     private $streamFactory;
 
     /**
-     * @var bool
+     * @var array
      */
-    private $strictMode = false;
+    private $domainAliases = [];
 
     /**
      * @var array
      */
     private $ignoredQueryParameters = [];
 
+    /**
+     * @var bool
+     */
+    private $strictMode = false;
+
     /**
      * @param string                                          $fixturesPath
-     * @param array                                           $domainAliases
      * @param \Psr\Http\Message\ResponseFactoryInterface|null $responseFactory
      * @param \Psr\Http\Message\StreamFactoryInterface|null   $streamFactory
      */
     public function __construct(
         string $fixturesPath,
-        array $domainAliases = [],
         ResponseFactoryInterface $responseFactory = null,
         StreamFactoryInterface $streamFactory = null
     ) {
         $this->fixturesPath = $fixturesPath;
-        $this->domainAliases = $domainAliases;
         $this->responseFactory = $responseFactory ?: Psr17FactoryDiscovery::findResponseFactory();
         $this->streamFactory = $streamFactory ?: Psr17FactoryDiscovery::findStreamFactory();
     }
 
     /**
-     * @return bool
+     * @return array
      */
-    public function useStrictMode(): bool
+    public function getDomainAliases(): array
     {
-        return $this->strictMode;
+        return $this->domainAliases;
     }
 
     /**
-     * @param bool $strictMode
+     * @param array $domainAliases
      *
-     * @return self
+     * @return $this
      */
-    public function setStrictMode(bool $strictMode): self
+    public function setDomainAliases(array $domainAliases): self
     {
-        $this->strictMode = $strictMode;
+        $this->domainAliases = $domainAliases;
 
         return $this;
     }
@@ -106,7 +103,7 @@ public function getIgnoredQueryParameters(): array
     /**
      * @param array $ignoredQueryParameters
      *
-     * @return self
+     * @return $this
      */
     public function setIgnoredQueryParameters(array $ignoredQueryParameters): self
     {
@@ -115,6 +112,26 @@ public function setIgnoredQueryParameters(array $ignoredQueryParameters): self
         return $this;
     }
 
+    /**
+     * @return bool
+     */
+    public function useStrictMode(): bool
+    {
+        return $this->strictMode;
+    }
+
+    /**
+     * @param bool $strictMode
+     *
+     * @return $this
+     */
+    public function setStrictMode(bool $strictMode): self
+    {
+        $this->strictMode = $strictMode;
+
+        return $this;
+    }
+
     /**
      * @param \Psr\Http\Message\RequestInterface $request
      *
@@ -261,8 +278,9 @@ protected function getHostFromRequest(RequestInterface $request): string
     {
         $host = trim($request->getUri()->getHost(), '/');
 
-        if (array_key_exists($host, $this->domainAliases)) {
-            return $this->domainAliases[$host];
+        $domainAliases = $this->getDomainAliases();
+        if (array_key_exists($host, $domainAliases)) {
+            return $domainAliases[$host];
         }
 
         return $host;

tests/ResponseBuilderTest.php

@@ -117,12 +117,13 @@ public function itCanBuildAResponseUsingDomainAliases(): void
         // arrange
         $requestFactory = Psr17FactoryDiscovery::findRequestFactory();
         $responseFactory = Psr17FactoryDiscovery::findResponseFactory();
+        $builder = $this->getBuilder()->setDomainAliases(['foo.bar' => 'example.com']);
 
         $expectedResponse = $responseFactory->createResponse()
             ->withBody(Utils::streamFor(file_get_contents($this->getFixturesPath().'/example.com/api/articles.mock')));
 
         // act
-        $actualResponse = $this->getBuilder()->build($requestFactory->createRequest('GET', 'https://foo.bar/api/articles'));
+        $actualResponse = $builder->build($requestFactory->createRequest('GET', 'https://foo.bar/api/articles'));
 
         // assert
         $this->assertEquals($expectedResponse->getBody()->__toString(), $actualResponse->getBody()->__toString());
@@ -190,7 +191,7 @@ public function itCanBuildAResponseWithCustomStatus(): void
      */
     protected function getBuilder(): ResponseBuilderInterface
     {
-        return new ResponseBuilder($this->getFixturesPath(), ['foo.bar' => 'example.com']);
+        return new ResponseBuilder($this->getFixturesPath());
     }
 
     /**