Update tests and introduce client factory for better unit testing

Author: bezin

src/FeedIo/Adapter/ClientFactory.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace FeedIo\Adapter;
+
+use FeedIo\Adapter\ClientInterface as AdapterClientInterface;
+use Psr\Http\Client\ClientInterface;
+
+class ClientFactory
+{
+    public function create(ClientInterface $client): AdapterClientInterface
+    {
+        return new Client($client);
+    }
+}

src/FeedIo/FeedIo.php

@@ -5,7 +5,8 @@
 namespace FeedIo;
 
 use DateTime;
-use FeedIo\Adapter\Client;
+use FeedIo\Adapter\ClientInterface as AdapterClientInterface;
+use FeedIo\Adapter\ClientFactory;
 use FeedIo\Http\ResponseBuilder;
 use FeedIo\Reader\Result;
 use FeedIo\Rule\DateTimeBuilderInterface;
@@ -18,7 +19,7 @@
  * This class acts as a facade. It provides methods to access feed-io main features
  *
  * <code>
- *   // $client is a \FeedIo\Adapter\ClientInterface instance, $logger a \Psr\Log\LoggerInterface
+ *   // $client is a \Psr\Http\Client\ClientInterface, $logger a \Psr\Log\LoggerInterface
  *   $feedIo = new FeedIo($client, $logger);
  *
  *   // read a feed. Output is a Result instance
@@ -64,17 +65,19 @@
  */
 class FeedIo
 {
+    protected AdapterClientInterface $client;
     protected Reader $reader;
 
     public function __construct(
         ?ClientInterface $client = null,
         protected LoggerInterface $logger = new NullLogger(),
         protected ?SpecificationInterface $specification = null,
+        ClientFactory $factory = new ClientFactory(),
     ) {
         if (is_null($client)) {
             throw new \Exception('You must provide a PSR18-compliant HTTP client');
         }
-        $this->client = new Client($client);
+        $this->client = $factory->create($client);
         if (is_null($this->specification)) {
             $this->specification = new Specification($this->logger);
         }

tests/FeedIo/FeedIoTest.php

@@ -2,14 +2,16 @@
 
 namespace FeedIo;
 
-use FeedIo\Rule\DateTimeBuilder;
-use FeedIo\Standard\Atom;
+use FeedIo\Adapter\ClientFactory;
+use Nyholm\Psr7\Response;
+use Nyholm\Psr7\Stream;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\StreamInterface;
 
 /**
  * Generated by PHPUnit_SkeletonGenerator on 2015-02-23 at 20:31:12.
  */
-use PHPUnit\Framework\TestCase;
-
 class FeedIoTest extends TestCase
 {
     /**
@@ -23,18 +25,31 @@ class FeedIoTest extends TestCase
      */
     protected function setUp(): void
     {
-        $client = $this->getMockForAbstractClass('\FeedIo\Adapter\ClientInterface');
-        $response = $this->createMock('FeedIo\Adapter\ResponseInterface');
-        $response->expects($this->any())->method('isModified')->will($this->returnValue(true));
-        $response->expects($this->any())->method('getBody')->will($this->returnValue(
-            file_get_contents(dirname(__FILE__)."/../samples/expected-atom.xml")
-        ));
-        $response->expects($this->any())->method('getLastModified')->will($this->returnValue(new \DateTime()));
-        $client->expects($this->any())->method('getResponse')->will($this->returnValue($response));
+        $html = file_get_contents(__DIR__ ."/../samples/expected-atom.xml");
+
+        $adapterClient = $this->getMockForAbstractClass('\FeedIo\Adapter\ClientInterface');
+        $clientFactory = $this->createMock(ClientFactory::class);
+        $clientFactory->expects($this->once())->method('create')->willReturn($adapterClient);
+
+        $stream = $this->createMock(Stream::class);
+        $stream->expects($this->any())->method('getContents')->willReturn($html);
+
+        $psrResponse = $this->createMock(Response::class);
+        $psrResponse->expects($this->any())->method('getBody')->willReturn($stream);
+        $psrResponse->expects($this->any())->method('getStatusCode')->willReturn(200);
+
+        $client = $this->createMock(ClientInterface::class);
+        $client->method('sendRequest')->willReturn($psrResponse);
+
+        $adapterResponse = $this->createMock('FeedIo\Adapter\ResponseInterface');
+        $adapterResponse->expects($this->any())->method('isModified')->willReturn(true);
+        $adapterResponse->expects($this->any())->method('getBody')->willReturn($html);
+        $adapterResponse->expects($this->any())->method('getLastModified')->willReturn(new \DateTime());
+        $adapterClient->expects($this->any())->method('getResponse')->willReturn($adapterResponse);
 
         $logger = new \Psr\Log\NullLogger();
 
-        $this->object = new FeedIo($client, $logger, new Specification($logger));
+        $this->object = new FeedIo($client, $logger, new Specification($logger), $clientFactory);
     }
 
     /**
@@ -43,20 +58,34 @@ protected function setUp(): void
      */
     public function testConstruct()
     {
-        $client = $this->getMockForAbstractClass('\FeedIo\Adapter\ClientInterface');
+        $client = $this->getMockForAbstractClass(ClientInterface::class);
         $feedIo = new FeedIo($client, new \Psr\Log\NullLogger());
         $this->assertInstanceOf('\FeedIo\Reader', $feedIo->getReader());
     }
 
     public function testDiscovery()
     {
-        $html = file_get_contents(dirname(__FILE__)."/../samples/discovery.html");
-        $client = $this->createMock('FeedIo\Adapter\ClientInterface');
-        $response = $this->createMock('FeedIo\Adapter\ResponseInterface');
-        $response->expects($this->any())->method('getBody')->will($this->returnValue($html));
-        $client->expects($this->any())->method('getResponse')->will($this->returnValue($response));
+        $html = file_get_contents(__DIR__ ."/../samples/discovery.html");
 
-        $feedIo = new FeedIo($client, new \Psr\Log\NullLogger());
+        $adapterClient = $this->getMockForAbstractClass('\FeedIo\Adapter\ClientInterface');
+        $clientFactory = $this->createMock(ClientFactory::class);
+        $clientFactory->expects($this->once())->method('create')->willReturn($adapterClient);
+
+        $stream = $this->createMock(Stream::class);
+        $stream->expects($this->any())->method('getContents')->willReturn($html);
+
+        $psrResponse = $this->createMock(Response::class);
+        $psrResponse->method('getBody')->willReturn($stream);
+        $psrResponse->method('getStatusCode')->willReturn(200);
+
+        $client = $this->createMock(ClientInterface::class);
+        $client->method('sendRequest')->willReturn($psrResponse);
+
+        $adapterResponse = $this->createMock('FeedIo\Adapter\ResponseInterface');
+        $adapterResponse->expects($this->any())->method('getBody')->willReturn($html);
+        $adapterClient->expects($this->any())->method('getResponse')->willReturn($adapterResponse);
+
+        $feedIo = new FeedIo($client, new \Psr\Log\NullLogger(), null, $clientFactory);
         $urls = $feedIo->discover('https://example.org/feed');
 
         $this->assertCount(2, $urls);