Merge pull request #459 from acelaya/feature/preview-generator-module

Created PreviewGenerator module

CHANGELOG.md

@@ -13,6 +13,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 #### Changed
 
 * [#450](https://github.com/shlinkio/shlink/issues/450) Added PHP 7.4 to the build matrix, as an allowed-to-fail env.
+* [#443](https://github.com/shlinkio/shlink/issues/443) Split some logic into independent modules.
 
 #### Deprecated
 

composer.json

@@ -75,7 +75,8 @@
             "Shlinkio\\Shlink\\Core\\": "module/Core/src",
             "Shlinkio\\Shlink\\Common\\": "module/Common/src",
             "Shlinkio\\Shlink\\EventDispatcher\\": "module/EventDispatcher/src",
-            "Shlinkio\\Shlink\\IpGeolocation\\": "module/IpGeolocation/src/"
+            "Shlinkio\\Shlink\\IpGeolocation\\": "module/IpGeolocation/src/",
+            "Shlinkio\\Shlink\\PreviewGenerator\\": "module/PreviewGenerator/src/"
         },
         "files": [
             "module/Common/functions/functions.php",
@@ -94,6 +95,7 @@
             "ShlinkioTest\\Shlink\\Common\\": "module/Common/test",
             "ShlinkioTest\\Shlink\\EventDispatcher\\": "module/EventDispatcher/test",
             "ShlinkioTest\\Shlink\\IpGeolocation\\": "module/IpGeolocation/test",
+            "ShlinkioTest\\Shlink\\PreviewGenerator\\": "module/PreviewGenerator/test",
             "Shlinkio\\Shlink\\TestUtils\\": "module/TestUtils/src"
         }
     },

config/config.php

@@ -22,6 +22,7 @@ return (new ConfigAggregator\ConfigAggregator([
     CLI\ConfigProvider::class,
     Rest\ConfigProvider::class,
     EventDispatcher\ConfigProvider::class,
+    PreviewGenerator\ConfigProvider::class,
     new ConfigAggregator\PhpFileProvider('config/autoload/{{,*.}global,{,*.}local}.php'),
     env('APP_ENV') === 'test'
         ? new ConfigAggregator\PhpFileProvider('config/test/*.global.php')

module/CLI/config/dependencies.config.php

@@ -7,10 +7,10 @@ use Doctrine\DBAL\Connection;
 use GeoIp2\Database\Reader;
 use Shlinkio\Shlink\CLI\Util\GeolocationDbUpdater;
 use Shlinkio\Shlink\Common\Doctrine\NoDbNameConnectionFactory;
-use Shlinkio\Shlink\Common\Service\PreviewGenerator;
 use Shlinkio\Shlink\Core\Service;
 use Shlinkio\Shlink\IpGeolocation\GeoLite2\DbUpdater;
 use Shlinkio\Shlink\IpGeolocation\Resolver\IpLocationResolverInterface;
+use Shlinkio\Shlink\PreviewGenerator\Service\PreviewGenerator;
 use Shlinkio\Shlink\Rest\Service\ApiKeyService;
 use Symfony\Component\Console as SymfonyCli;
 use Symfony\Component\Lock\Factory as Locker;

module/CLI/src/Command/ShortUrl/GeneratePreviewCommand.php

@@ -4,9 +4,9 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
 
 use Shlinkio\Shlink\CLI\Util\ExitCodes;
-use Shlinkio\Shlink\Common\Exception\PreviewGenerationException;
-use Shlinkio\Shlink\Common\Service\PreviewGeneratorInterface;
 use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
+use Shlinkio\Shlink\PreviewGenerator\Exception\PreviewGenerationException;
+use Shlinkio\Shlink\PreviewGenerator\Service\PreviewGeneratorInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;

module/CLI/test/Command/ShortUrl/GeneratePreviewCommandTest.php

@@ -7,10 +7,10 @@ use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
 use Shlinkio\Shlink\CLI\Command\ShortUrl\GeneratePreviewCommand;
-use Shlinkio\Shlink\Common\Exception\PreviewGenerationException;
-use Shlinkio\Shlink\Common\Service\PreviewGenerator;
 use Shlinkio\Shlink\Core\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\Service\ShortUrlService;
+use Shlinkio\Shlink\PreviewGenerator\Exception\PreviewGenerationException;
+use Shlinkio\Shlink\PreviewGenerator\Service\PreviewGenerator;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Tester\CommandTester;
 use Zend\Paginator\Adapter\ArrayAdapter;

module/Common/config/dependencies.config.php

@@ -25,10 +25,6 @@ return [
             Middleware\LocaleMiddleware::class => ConfigAbstractFactory::class,
             Middleware\CloseDbConnectionMiddleware::class => ConfigAbstractFactory::class,
             IpAddress::class => Middleware\IpAddressMiddlewareFactory::class,
-
-            Image\ImageBuilder::class => Image\ImageBuilderFactory::class,
-
-            Service\PreviewGenerator::class => ConfigAbstractFactory::class,
         ],
         'aliases' => [
             'httpClient' => GuzzleClient::class,
@@ -47,12 +43,6 @@ return [
         Template\Extension\TranslatorExtension::class => ['translator'],
         Middleware\LocaleMiddleware::class => ['translator'],
         Middleware\CloseDbConnectionMiddleware::class => ['em'],
-
-        Service\PreviewGenerator::class => [
-            Image\ImageBuilder::class,
-            Filesystem::class,
-            'config.preview_generation.files_location',
-        ],
     ],
 
 ];

module/Core/config/dependencies.config.php

@@ -5,8 +5,8 @@ namespace Shlinkio\Shlink\Core;
 
 use Doctrine\Common\Cache\Cache;
 use Psr\EventDispatcher\EventDispatcherInterface;
-use Shlinkio\Shlink\Common\Service\PreviewGenerator;
 use Shlinkio\Shlink\Core\Response\NotFoundHandler;
+use Shlinkio\Shlink\PreviewGenerator\Service\PreviewGenerator;
 use Zend\Expressive\Router\RouterInterface;
 use Zend\Expressive\Template\TemplateRendererInterface;
 use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;

module/Core/src/Action/PreviewAction.php

@@ -9,13 +9,13 @@ use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
-use Shlinkio\Shlink\Common\Exception\PreviewGenerationException;
 use Shlinkio\Shlink\Common\Response\ResponseUtilsTrait;
-use Shlinkio\Shlink\Common\Service\PreviewGeneratorInterface;
 use Shlinkio\Shlink\Core\Action\Util\ErrorResponseBuilderTrait;
 use Shlinkio\Shlink\Core\Exception\EntityDoesNotExistException;
 use Shlinkio\Shlink\Core\Exception\InvalidShortCodeException;
 use Shlinkio\Shlink\Core\Service\UrlShortenerInterface;
+use Shlinkio\Shlink\PreviewGenerator\Exception\PreviewGenerationException;
+use Shlinkio\Shlink\PreviewGenerator\Service\PreviewGeneratorInterface;
 
 /** @deprecated */
 class PreviewAction implements MiddlewareInterface

module/Core/test/Action/PreviewActionTest.php

@@ -8,12 +8,12 @@ use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
 use Psr\Http\Server\RequestHandlerInterface;
-use Shlinkio\Shlink\Common\Service\PreviewGenerator;
 use Shlinkio\Shlink\Core\Action\PreviewAction;
 use Shlinkio\Shlink\Core\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\Exception\EntityDoesNotExistException;
 use Shlinkio\Shlink\Core\Exception\InvalidShortCodeException;
 use Shlinkio\Shlink\Core\Service\UrlShortener;
+use Shlinkio\Shlink\PreviewGenerator\Service\PreviewGenerator;
 use ShlinkioTest\Shlink\Common\Util\TestUtils;
 use Zend\Diactoros\Response;
 use Zend\Diactoros\ServerRequest;

module/PreviewGenerator/config/dependencies.config.php

@@ -0,0 +1,26 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\PreviewGenerator;
+
+use Symfony\Component\Filesystem\Filesystem;
+use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
+
+return [
+
+    'dependencies' => [
+        'factories' => [
+            Image\ImageBuilder::class => Image\ImageBuilderFactory::class,
+            Service\PreviewGenerator::class => ConfigAbstractFactory::class,
+        ],
+    ],
+
+    ConfigAbstractFactory::class => [
+        Service\PreviewGenerator::class => [
+            Image\ImageBuilder::class,
+            Filesystem::class,
+            'config.preview_generation.files_location',
+        ],
+    ],
+
+];

module/PreviewGenerator/src/ConfigProvider.php

@@ -0,0 +1,15 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\PreviewGenerator;
+
+use function Shlinkio\Shlink\Common\loadConfigFromGlob;
+
+/** @deprecated */
+class ConfigProvider
+{
+    public function __invoke(): array
+    {
+        return loadConfigFromGlob(__DIR__ . '/../config/{,*.}config.php');
+    }
+}

module/PreviewGenerator/src/Exception/PreviewGenerationException.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Common\Exception;
+namespace Shlinkio\Shlink\PreviewGenerator\Exception;
 
 use RuntimeException;
 

module/PreviewGenerator/src/Image/ImageBuilder.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Common\Image;
+namespace Shlinkio\Shlink\PreviewGenerator\Image;
 
 use mikehaertl\wkhtmlto\Image;
 use Zend\ServiceManager\AbstractPluginManager;

module/PreviewGenerator/src/Image/ImageBuilderFactory.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Common\Image;
+namespace Shlinkio\Shlink\PreviewGenerator\Image;
 
 use Interop\Container\ContainerInterface;
 use Interop\Container\Exception\ContainerException;

module/PreviewGenerator/src/Image/ImageBuilderInterface.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Common\Image;
+namespace Shlinkio\Shlink\PreviewGenerator\Image;
 
 use Zend\ServiceManager\ServiceLocatorInterface;
 

module/PreviewGenerator/src/Image/ImageFactory.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Common\Image;
+namespace Shlinkio\Shlink\PreviewGenerator\Image;
 
 use Interop\Container\ContainerInterface;
 use Interop\Container\Exception\ContainerException;

module/PreviewGenerator/src/Service/PreviewGenerator.php

@@ -1,11 +1,11 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Common\Service;
+namespace Shlinkio\Shlink\PreviewGenerator\Service;
 
 use mikehaertl\wkhtmlto\Image;
-use Shlinkio\Shlink\Common\Exception\PreviewGenerationException;
-use Shlinkio\Shlink\Common\Image\ImageBuilderInterface;
+use Shlinkio\Shlink\PreviewGenerator\Exception\PreviewGenerationException;
+use Shlinkio\Shlink\PreviewGenerator\Image\ImageBuilderInterface;
 use Symfony\Component\Filesystem\Filesystem;
 
 use function sprintf;

module/PreviewGenerator/src/Service/PreviewGeneratorInterface.php

@@ -1,9 +1,9 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\Common\Service;
+namespace Shlinkio\Shlink\PreviewGenerator\Service;
 
-use Shlinkio\Shlink\Common\Exception\PreviewGenerationException;
+use Shlinkio\Shlink\PreviewGenerator\Exception\PreviewGenerationException;
 
 /** @deprecated */
 interface PreviewGeneratorInterface

module/PreviewGenerator/test/ConfigProviderTest.php

@@ -0,0 +1,26 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\PreviewGenerator;
+
+use PHPUnit\Framework\TestCase;
+use Shlinkio\Shlink\PreviewGenerator\ConfigProvider;
+
+class ConfigProviderTest extends TestCase
+{
+    /** @var ConfigProvider */
+    private $configProvider;
+
+    public function setUp(): void
+    {
+        $this->configProvider = new ConfigProvider();
+    }
+
+    /** @test */
+    public function configIsReturned(): void
+    {
+        $config = ($this->configProvider)();
+
+        $this->assertArrayHasKey('dependencies', $config);
+    }
+}

module/PreviewGenerator/test/Image/ImageBuilderFactoryTest.php

@@ -1,11 +1,11 @@
 <?php
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\Common\Image;
+namespace ShlinkioTest\Shlink\PreviewGenerator\Image;
 
 use PHPUnit\Framework\TestCase;
-use Shlinkio\Shlink\Common\Image\ImageBuilder;
-use Shlinkio\Shlink\Common\Image\ImageBuilderFactory;
+use Shlinkio\Shlink\PreviewGenerator\Image\ImageBuilder;
+use Shlinkio\Shlink\PreviewGenerator\Image\ImageBuilderFactory;
 use Zend\ServiceManager\ServiceManager;
 
 class ImageBuilderFactoryTest extends TestCase

module/PreviewGenerator/test/Image/ImageFactoryTest.php

@@ -1,12 +1,12 @@
 <?php
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\Common\Image;
+namespace ShlinkioTest\Shlink\PreviewGenerator\Image;
 
 use mikehaertl\wkhtmlto\Image;
 use PHPUnit\Framework\TestCase;
 use ReflectionObject;
-use Shlinkio\Shlink\Common\Image\ImageFactory;
+use Shlinkio\Shlink\PreviewGenerator\Image\ImageFactory;
 use Zend\ServiceManager\ServiceManager;
 
 class ImageFactoryTest extends TestCase

module/PreviewGenerator/test/Service/PreviewGeneratorTest.php

@@ -1,15 +1,15 @@
 <?php
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\Common\Service;
+namespace ShlinkioTest\Shlink\PreviewGenerator\Service;
 
 use mikehaertl\wkhtmlto\Image;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
-use Shlinkio\Shlink\Common\Exception\PreviewGenerationException;
-use Shlinkio\Shlink\Common\Image\ImageBuilder;
-use Shlinkio\Shlink\Common\Service\PreviewGenerator;
+use Shlinkio\Shlink\PreviewGenerator\Exception\PreviewGenerationException;
+use Shlinkio\Shlink\PreviewGenerator\Image\ImageBuilder;
+use Shlinkio\Shlink\PreviewGenerator\Service\PreviewGenerator;
 use Symfony\Component\Filesystem\Filesystem;
 use Zend\ServiceManager\ServiceManager;
 

phpunit.xml.dist

@@ -24,6 +24,9 @@
         <testsuite name="IpGeolocation">
             <directory>./module/IpGeolocation/test</directory>
         </testsuite>
+        <testsuite name="PreviewGenerator">
+            <directory>./module/PreviewGenerator/test</directory>
+        </testsuite>
     </testsuites>
 
     <filter>
@@ -32,6 +35,7 @@
 
             <exclude>
                 <directory suffix=".php">./module/Core/src/Repository</directory>
+                <directory suffix=".php">./module/TestUtils</directory>
             </exclude>
         </whitelist>
     </filter>