refactoring internal (#13)

* Improve Module::class + test.

* Refactoring internals.

config/di/service.php

@@ -1,15 +1,13 @@
 <?php declare(strict_types=1);
 
 use Http\Discovery\HttpClientDiscovery;
-
-
-use OpenEMR\Modules\Marketplace\Adapter\Http\Web\AboutController;
+use OpenEMR\Modules\Marketplace\Adapter\PackagistFinder\PackagistModuleFinder;
 use OpenEMR\Modules\Marketplace\Adapter\Http\Web\DefaultController;
 use OpenEMR\Modules\Marketplace\Adapter\Http\Web\NotFoundController;
-use OpenEMR\Modules\Marketplace\Finder\ModuleFinder;
-use OpenEMR\Modules\Marketplace\Finder\PackagistModuleFinder;
+use OpenEMR\Modules\Marketplace\Application\ModuleFinder;
 use Twig\Environment;
 
+
 return [
     PackagistModuleFinder::class => DI\create()
         ->constructor(DI\factory([HttpClientDiscovery::class, 'find'])),

public/index.php

@@ -10,19 +10,17 @@
 use Laminas\HttpHandlerRunner\Emitter\SapiStreamEmitter;
 use Nyholm\Psr7\Factory\Psr17Factory;
 use Nyholm\Psr7Server\ServerRequestCreator;
-
-
+use OpenEMR\Modules\Marketplace\Adapter\PackagistFinder\PackagistModuleFinder;
 use OpenEMR\Modules\Marketplace\Adapter\Http\Web\AboutController;
 use OpenEMR\Modules\Marketplace\Adapter\Http\Web\DefaultController;
 use OpenEMR\Modules\Marketplace\Adapter\Http\Web\NotFoundController;
-use OpenEMR\Modules\Marketplace\Finder\PackagistModuleFinder;
 use OpenEMR\Modules\Marketplace\Module;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
-
 use Twig\Environment;
 
+
 require __DIR__ . '/../src/Module.php';
 
 if (Module::isStandAlone()) {

src/Adapter/Http/Web/DefaultController.php

@@ -3,8 +3,7 @@
 namespace OpenEMR\Modules\Marketplace\Adapter\Http\Web;
 
 use Nyholm\Psr7\Factory\Psr17Factory;
-
-use OpenEMR\Modules\Marketplace\Finder\ModuleFinder;
+use OpenEMR\Modules\Marketplace\Application\ModuleFinder;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Twig\Environment;

src/Finder/PackagistModuleFinder.php → src/Adapter/PackagistFinder/PackagistModuleFinder.php

@@ -1,9 +1,13 @@
 <?php declare(strict_types=1);
 
-namespace OpenEMR\Modules\Marketplace\Finder;
+namespace OpenEMR\Modules\Marketplace\Adapter\PackagistFinder;
 
 use GuzzleHttp\Psr7\Request;
 use Http\Client\HttpClient;
+use OpenEMR\Modules\Marketplace\Application\ModuleFinder;
+use OpenEMR\Modules\Marketplace\Application\ModuleItemCollection;
+use OpenEMR\Modules\Marketplace\Application\PackagistItem;
+use OpenEMR\Modules\Marketplace\Application\PackagistItemCollection;
 use RuntimeException;
 
 class PackagistModuleFinder implements ModuleFinder

src/Finder/ModuleFinder.php → src/Application/ModuleFinder.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenEMR\Modules\Marketplace\Finder;
+namespace OpenEMR\Modules\Marketplace\Application;
 
 interface ModuleFinder
 {

src/Finder/ModuleItem.php → src/Application/ModuleItem.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenEMR\Modules\Marketplace\Finder;
+namespace OpenEMR\Modules\Marketplace\Application;
 
 interface ModuleItem
 {

src/Finder/ModuleItemCollection.php → src/Application/ModuleItemCollection.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenEMR\Modules\Marketplace\Finder;
+namespace OpenEMR\Modules\Marketplace\Application;
 
 interface ModuleItemCollection
 {

src/Finder/PackagistItem.php → src/Application/PackagistItem.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenEMR\Modules\Marketplace\Finder;
+namespace OpenEMR\Modules\Marketplace\Application;
 
 class PackagistItem implements ModuleItem
 {

src/Finder/PackagistItemCollection.php → src/Application/PackagistItemCollection.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace OpenEMR\Modules\Marketplace\Finder;
+namespace OpenEMR\Modules\Marketplace\Application;
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Webmozart\Assert\Assert;

src/Module.php

@@ -5,7 +5,7 @@
 use DI\ContainerBuilder;
 use Psr\Container\ContainerInterface;
 
-class Module
+final class Module
 {
     public const MODULE_NAME = 'Modules Marketplace';
 
@@ -22,9 +22,15 @@ class Module
     public const LICENSE_URL = 'https://github.com/medicalmundi/oe-module-marketplace/blob/main/LICENSE';
 
     /**
-     * @var null|ContainerInterface
+     * @var ContainerInterface
+     *
+     * @psalm-suppress PropertyNotSetInConstructor
      */
-    protected $container = null;
+    protected $container;
+
+    private function __construct()
+    {
+    }
 
     public static function bootstrap(): self
     {

tests/Unit/Adapter/PackagistFinder/PackagistHttpResponseTrait.php

@@ -0,0 +1,72 @@
+<?php declare(strict_types=1);
+
+namespace OpenEMR\Modules\Marketplace\Tests\Unit\Adapter\PackagistFinder;
+
+trait PackagistHttpResponseTrait
+{
+    private function packagistEmptyResponseContent(): string
+    {
+        return <<<JSON
+{
+  "results": [],
+  "total": 0
+}
+JSON;
+    }
+
+    private function packagistDefaultSingleResultResponseContent(): string
+    {
+        return <<<JSON
+{
+  "results": [
+    {
+      "name": "openemr/oe-module-faxsms",
+      "description": "OpenEMR Fax and SMS module",
+      "url": "https://packagist.org/packages/openemr/oe-module-faxsms",
+      "repository": "https://github.com/openemr/oe-module-faxsms",
+      "downloads": 36,
+      "favers": 1
+    }
+  ],
+  "total": 1
+}
+JSON;
+    }
+
+    private function packagistDefaultMultipleResultResponseContent(): string
+    {
+        return <<<JSON
+{
+  "results": [
+    {
+      "name": "zerai/oe-module-demo-farm-add-ons",
+      "description": "OpenEMR Demo Farm Add-ons module",
+      "url": "https://packagist.org/packages/zerai/oe-module-demo-farm-add-ons",
+      "repository": "https://github.com/zerai/oe-module-demo-farm-add-ons",
+      "downloads": 7,
+      "favers": 0
+    },
+    {
+      "name": "openemr/oe-module-faxsms",
+      "description": "OpenEMR Fax and SMS module",
+      "url": "https://packagist.org/packages/openemr/oe-module-faxsms",
+      "repository": "https://github.com/openemr/oe-module-faxsms",
+      "downloads": 36,
+      "favers": 1
+    }
+  ],
+  "total": 2
+}
+JSON;
+    }
+
+    private function packagistEmptyResultResponseContent(): string
+    {
+        return <<<JSON
+{
+  "results": [],
+  "total": 0
+}
+JSON;
+    }
+}

tests/Unit/Adapter/PackagistFinder/PackagistModuleFinderTest.php

@@ -0,0 +1,145 @@
+<?php declare(strict_types=1);
+
+namespace OpenEMR\Modules\Marketplace\Tests\Unit\Adapter\PackagistFinder;
+
+use Exception;
+use Http\Mock\Client;
+use OpenEMR\Modules\Marketplace\Adapter\PackagistFinder\PackagistModuleFinder;
+use PHPUnit\Framework\TestCase;
+
+class PackagistModuleFinderTest extends TestCase
+{
+    use PackagistHttpResponseTrait;
+
+    /**
+     * @test
+     */
+    public function can_find_one_module(): void
+    {
+        $client = $this->createHttpClientWithDefaultResponse($this->packagistDefaultSingleResultResponseContent());
+        $packagistModuleFinder = new PackagistModuleFinder($client);
+
+        $foundedModulesCollection = $packagistModuleFinder->searchModule();
+
+        self::assertEquals(1, $foundedModulesCollection->count());
+    }
+
+    /**
+     * @test
+     */
+    public function can_find_multiple_module(): void
+    {
+        $client = $this->createHttpClientWithDefaultResponse($this->packagistDefaultMultipleResultResponseContent());
+        $packagistModuleFinder = new PackagistModuleFinder($client);
+
+        $foundedModulesCollection = $packagistModuleFinder->searchModule();
+
+        self::assertEquals(2, $foundedModulesCollection->count());
+    }
+
+    /**
+     * @test
+     */
+    public function can_handle_http_exception(): void
+    {
+        $this->expectException(\RuntimeException::class);
+
+        $clientException = new \RuntimeException('Whoops! The server is down.');
+        $client = $this->createHttpClientWithExceptionResponse($clientException, 500);
+        $packagistModuleFinder = new PackagistModuleFinder($client);
+
+        $packagistModuleFinder->searchModule();
+    }
+
+    /**
+     * This is an edge case, the module system is based on "openemr/oe-module-installer-plugin"
+     * it should always appear in the search results.
+     * 0 result should never happen.
+     *
+     * @test
+     */
+    public function can_handle_a_empty_respose_content(): void
+    {
+        $client = $this->createHttpClientWithDefaultResponse($this->packagistEmptyResponseContent());
+        $packagistModuleFinder = new PackagistModuleFinder($client);
+
+        $foundedModulesCollection = $packagistModuleFinder->searchModule();
+
+        self::assertEquals(0, $foundedModulesCollection->count());
+    }
+
+    /**
+     * @test
+     */
+    public function can_generate_an_valid_http_endpoint_without_an_input_queryString_parameter(): void
+    {
+        $expectedEndpoint = 'https://packagist.org/search.json?q=&type=openemr-module';
+
+        $packagistModuleFinder = new PackagistModuleFinder($client = new Client());
+
+        $endpoint = $packagistModuleFinder->endpoint();
+
+        self::assertStringContainsString('type=openemr-module', $endpoint);
+        self::assertSame($expectedEndpoint, $endpoint);
+        self::assertTrue((bool) filter_var($endpoint, FILTER_VALIDATE_URL));
+    }
+
+    /**
+     * @test
+     */
+    public function can_generate_an_valid_http_endpoint_from_an_input_queryString_parameter(): void
+    {
+        $queryString = 'vendor_1';
+
+        $expectedEndpoint = 'https://packagist.org/search.json?q=' . $queryString . '&type=openemr-module';
+
+        $packagistModuleFinder = new PackagistModuleFinder($client = new Client());
+
+        $endpoint = $packagistModuleFinder->endpoint($queryString);
+
+        self::assertStringContainsString('type=openemr-module', $endpoint);
+        self::assertSame($expectedEndpoint, $endpoint);
+        self::assertTrue((bool) filter_var($endpoint, FILTER_VALIDATE_URL));
+    }
+
+    private function createHttpClientWithDefaultResponse(string $contentResponse, int $httpStatusCode = 200): Client
+    {
+        $client = new Client();
+
+        $stream = $this->createMock('Psr\Http\Message\StreamInterface');
+        $stream->expects(self::any())->method('getContents')->willReturn($contentResponse);
+
+        $response = $this->createMock('Psr\Http\Message\ResponseInterface');
+        $response->expects(self::any())->method('getStatusCode')->willReturn($httpStatusCode);
+        $response->expects(self::any())->method('getBody')->willReturn($stream);
+
+        $client->setDefaultResponse($response);
+
+        return $client;
+    }
+
+    private function createHttpClientWithExceptionResponse(Exception $exception, int $httpStatusCode): Client
+    {
+        $client = new Client();
+        $client->addException($exception);
+
+        return $client;
+    }
+
+    /**
+     * @test
+     */
+    public function httpClientTest(): void
+    {
+        $stream = $this->createMock('Psr\Http\Message\StreamInterface');
+        $stream->method('getContents')->willReturn($this->packagistDefaultSingleResultResponseContent());
+        $response = $this->createMock('Psr\Http\Message\ResponseInterface');
+        $response->method('getBody')->willReturn($stream);
+        $client = $this->createHttpClientWithDefaultResponse($this->packagistDefaultSingleResultResponseContent());
+
+        $returnedResponse = $client->sendRequest($this->createMock('Psr\Http\Message\RequestInterface'));
+
+        $this->assertEquals($response, $returnedResponse);
+        $this->assertEquals(200, $returnedResponse->getStatusCode());
+    }
+}