From ba06ad44bd7e2d815b9a0baea5fcfd5d8dc5827e Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Tue, 19 Jul 2016 17:38:41 +0200
Subject: [PATCH] Created Common module

---
 config/autoload/services.global.php           | 10 --------
 config/config.php                             |  2 ++
 .../CLI/src/Command/ListShortcodesCommand.php |  4 +--
 module/Common/config/services.config.php      | 25 +++++++++++++++++++
 module/Common/src/ConfigProvider.php          | 13 ++++++++++
 .../Common/src}/Factory/CacheFactory.php      |  2 +-
 .../src}/Factory/EntityManagerFactory.php     |  2 +-
 .../Adapter/PaginableRepositoryAdapter.php    |  4 +--
 .../Paginator/Util/PaginatorUtilsTrait.php    |  2 +-
 .../PaginableRepositoryInterface.php          |  2 +-
 .../Common/src}/Util/StringUtilsTrait.php     |  2 +-
 .../Common/test}/Factory/CacheFactoryTest.php |  4 +--
 .../Factory/EntityManagerFactoryTest.php      |  4 +--
 .../src/Action/ListShortcodesMiddleware.php   |  2 +-
 src/Entity/RestToken.php                      |  2 +-
 .../ShortUrlRepositoryInterface.php           |  1 +
 src/Service/ShortUrlService.php               |  2 +-
 17 files changed, 57 insertions(+), 26 deletions(-)
 create mode 100644 module/Common/config/services.config.php
 create mode 100644 module/Common/src/ConfigProvider.php
 rename {src => module/Common/src}/Factory/CacheFactory.php (96%)
 rename {src => module/Common/src}/Factory/EntityManagerFactory.php (97%)
 rename {src => module/Common/src}/Paginator/Adapter/PaginableRepositoryAdapter.php (91%)
 rename {src => module/Common/src}/Paginator/Util/PaginatorUtilsTrait.php (93%)
 rename {src => module/Common/src}/Repository/PaginableRepositoryInterface.php (92%)
 rename {src => module/Common/src}/Util/StringUtilsTrait.php (96%)
 rename {tests => module/Common/test}/Factory/CacheFactoryTest.php (91%)
 rename {tests => module/Common/test}/Factory/EntityManagerFactoryTest.php (88%)

diff --git a/config/autoload/services.global.php b/config/autoload/services.global.php
index bf5b28e4..00304e5f 100644
--- a/config/autoload/services.global.php
+++ b/config/autoload/services.global.php
@@ -1,11 +1,7 @@
 <?php
-use Acelaya\UrlShortener\Factory\CacheFactory;
-use Acelaya\UrlShortener\Factory\EntityManagerFactory;
 use Acelaya\UrlShortener\Middleware;
 use Acelaya\UrlShortener\Service;
 use Acelaya\ZsmAnnotatedServices\Factory\V3\AnnotatedFactory;
-use Doctrine\Common\Cache\Cache;
-use Doctrine\ORM\EntityManager;
 use Zend\Expressive;
 use Zend\Expressive\Container;
 use Zend\Expressive\Helper;
@@ -32,21 +28,15 @@ return [
             Template\TemplateRendererInterface::class => Twig\TwigRendererFactory::class,
 
             // Services
-            EntityManager::class => EntityManagerFactory::class,
-            GuzzleHttp\Client::class => InvokableFactory::class,
             Service\UrlShortener::class => AnnotatedFactory::class,
             Service\VisitsTracker::class => AnnotatedFactory::class,
             Service\ShortUrlService::class => AnnotatedFactory::class,
-            Cache::class => CacheFactory::class,
 
             // Middleware
             Middleware\Routable\RedirectMiddleware::class => AnnotatedFactory::class,
         ],
         'aliases' => [
-            'em' => EntityManager::class,
-            'httpClient' => GuzzleHttp\Client::class,
             Router\RouterInterface::class => Router\FastRouteRouter::class,
-            AnnotatedFactory::CACHE_SERVICE => Cache::class,
         ],
     ],
 
diff --git a/config/config.php b/config/config.php
index 0fad2300..5b1fedf9 100644
--- a/config/config.php
+++ b/config/config.php
@@ -1,5 +1,6 @@
 <?php
 use Shlinkio\Shlink\CLI;
+use Shlinkio\Shlink\Common;
 use Shlinkio\Shlink\Rest;
 use Zend\Expressive\ConfigManager\ConfigManager;
 use Zend\Expressive\ConfigManager\ZendConfigProvider;
@@ -16,6 +17,7 @@ use Zend\Expressive\ConfigManager\ZendConfigProvider;
 return call_user_func(function () {
     $configManager = new ConfigManager([
         new ZendConfigProvider('config/autoload/{{,*.}global,{,*.}local}.php'),
+        Common\ConfigProvider::class,
         CLI\ConfigProvider::class,
         Rest\ConfigProvider::class,
     ], 'data/cache/app_config.php');
diff --git a/module/CLI/src/Command/ListShortcodesCommand.php b/module/CLI/src/Command/ListShortcodesCommand.php
index f3efa3d1..449e20a7 100644
--- a/module/CLI/src/Command/ListShortcodesCommand.php
+++ b/module/CLI/src/Command/ListShortcodesCommand.php
@@ -1,11 +1,11 @@
 <?php
 namespace Shlinkio\Shlink\CLI\Command;
 
-use Acelaya\UrlShortener\Paginator\Adapter\PaginableRepositoryAdapter;
-use Acelaya\UrlShortener\Paginator\Util\PaginatorUtilsTrait;
 use Acelaya\UrlShortener\Service\ShortUrlService;
 use Acelaya\UrlShortener\Service\ShortUrlServiceInterface;
 use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
+use Shlinkio\Shlink\Common\Paginator\Adapter\PaginableRepositoryAdapter;
+use Shlinkio\Shlink\Common\Paginator\Util\PaginatorUtilsTrait;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Helper\Table;
diff --git a/module/Common/config/services.config.php b/module/Common/config/services.config.php
new file mode 100644
index 00000000..8736a660
--- /dev/null
+++ b/module/Common/config/services.config.php
@@ -0,0 +1,25 @@
+<?php
+use Acelaya\UrlShortener\Middleware;
+use Acelaya\ZsmAnnotatedServices\Factory\V3\AnnotatedFactory;
+use Doctrine\Common\Cache\Cache;
+use Doctrine\ORM\EntityManager;
+use Shlinkio\Shlink\Common\Factory\CacheFactory;
+use Shlinkio\Shlink\Common\Factory\EntityManagerFactory;
+use Zend\ServiceManager\Factory\InvokableFactory;
+
+return [
+
+    'services' => [
+        'factories' => [
+            EntityManager::class => EntityManagerFactory::class,
+            GuzzleHttp\Client::class => InvokableFactory::class,
+            Cache::class => CacheFactory::class,
+        ],
+        'aliases' => [
+            'em' => EntityManager::class,
+            'httpClient' => GuzzleHttp\Client::class,
+            AnnotatedFactory::CACHE_SERVICE => Cache::class,
+        ],
+    ],
+
+];
diff --git a/module/Common/src/ConfigProvider.php b/module/Common/src/ConfigProvider.php
new file mode 100644
index 00000000..9af040c2
--- /dev/null
+++ b/module/Common/src/ConfigProvider.php
@@ -0,0 +1,13 @@
+<?php
+namespace Shlinkio\Shlink\Common;
+
+use Zend\Config\Factory;
+use Zend\Stdlib\Glob;
+
+class ConfigProvider
+{
+    public function __invoke()
+    {
+        return Factory::fromFiles(Glob::glob(__DIR__ . '/../config/{,*.}config.php', Glob::GLOB_BRACE));
+    }
+}
diff --git a/src/Factory/CacheFactory.php b/module/Common/src/Factory/CacheFactory.php
similarity index 96%
rename from src/Factory/CacheFactory.php
rename to module/Common/src/Factory/CacheFactory.php
index 86c88e6b..33949dc3 100644
--- a/src/Factory/CacheFactory.php
+++ b/module/Common/src/Factory/CacheFactory.php
@@ -1,5 +1,5 @@
 <?php
-namespace Acelaya\UrlShortener\Factory;
+namespace Shlinkio\Shlink\Common\Factory;
 
 use Doctrine\Common\Cache\ApcuCache;
 use Doctrine\Common\Cache\ArrayCache;
diff --git a/src/Factory/EntityManagerFactory.php b/module/Common/src/Factory/EntityManagerFactory.php
similarity index 97%
rename from src/Factory/EntityManagerFactory.php
rename to module/Common/src/Factory/EntityManagerFactory.php
index 8716b3f8..d6de017c 100644
--- a/src/Factory/EntityManagerFactory.php
+++ b/module/Common/src/Factory/EntityManagerFactory.php
@@ -1,5 +1,5 @@
 <?php
-namespace Acelaya\UrlShortener\Factory;
+namespace Shlinkio\Shlink\Common\Factory;
 
 use Doctrine\Common\Cache\ArrayCache;
 use Doctrine\Common\Cache\Cache;
diff --git a/src/Paginator/Adapter/PaginableRepositoryAdapter.php b/module/Common/src/Paginator/Adapter/PaginableRepositoryAdapter.php
similarity index 91%
rename from src/Paginator/Adapter/PaginableRepositoryAdapter.php
rename to module/Common/src/Paginator/Adapter/PaginableRepositoryAdapter.php
index 243e4a1b..ade0c0c9 100644
--- a/src/Paginator/Adapter/PaginableRepositoryAdapter.php
+++ b/module/Common/src/Paginator/Adapter/PaginableRepositoryAdapter.php
@@ -1,7 +1,7 @@
 <?php
-namespace Acelaya\UrlShortener\Paginator\Adapter;
+namespace Shlinkio\Shlink\Common\Paginator\Adapter;
 
-use Acelaya\UrlShortener\Repository\PaginableRepositoryInterface;
+use Shlinkio\Shlink\Common\Repository\PaginableRepositoryInterface;
 use Zend\Paginator\Adapter\AdapterInterface;
 
 class PaginableRepositoryAdapter implements AdapterInterface
diff --git a/src/Paginator/Util/PaginatorUtilsTrait.php b/module/Common/src/Paginator/Util/PaginatorUtilsTrait.php
similarity index 93%
rename from src/Paginator/Util/PaginatorUtilsTrait.php
rename to module/Common/src/Paginator/Util/PaginatorUtilsTrait.php
index 270aaea4..a1e0ec5c 100644
--- a/src/Paginator/Util/PaginatorUtilsTrait.php
+++ b/module/Common/src/Paginator/Util/PaginatorUtilsTrait.php
@@ -1,5 +1,5 @@
 <?php
-namespace Acelaya\UrlShortener\Paginator\Util;
+namespace Shlinkio\Shlink\Common\Paginator\Util;
 
 use Zend\Paginator\Paginator;
 use Zend\Stdlib\ArrayUtils;
diff --git a/src/Repository/PaginableRepositoryInterface.php b/module/Common/src/Repository/PaginableRepositoryInterface.php
similarity index 92%
rename from src/Repository/PaginableRepositoryInterface.php
rename to module/Common/src/Repository/PaginableRepositoryInterface.php
index 99c8696e..b9a75aea 100644
--- a/src/Repository/PaginableRepositoryInterface.php
+++ b/module/Common/src/Repository/PaginableRepositoryInterface.php
@@ -1,5 +1,5 @@
 <?php
-namespace Acelaya\UrlShortener\Repository;
+namespace Shlinkio\Shlink\Common\Repository;
 
 interface PaginableRepositoryInterface
 {
diff --git a/src/Util/StringUtilsTrait.php b/module/Common/src/Util/StringUtilsTrait.php
similarity index 96%
rename from src/Util/StringUtilsTrait.php
rename to module/Common/src/Util/StringUtilsTrait.php
index 2b4bf625..648dbfcb 100644
--- a/src/Util/StringUtilsTrait.php
+++ b/module/Common/src/Util/StringUtilsTrait.php
@@ -1,5 +1,5 @@
 <?php
-namespace Acelaya\UrlShortener\Util;
+namespace Shlinkio\Shlink\Common\Util;
 
 trait StringUtilsTrait
 {
diff --git a/tests/Factory/CacheFactoryTest.php b/module/Common/test/Factory/CacheFactoryTest.php
similarity index 91%
rename from tests/Factory/CacheFactoryTest.php
rename to module/Common/test/Factory/CacheFactoryTest.php
index a6920d56..6f23aa0b 100644
--- a/tests/Factory/CacheFactoryTest.php
+++ b/module/Common/test/Factory/CacheFactoryTest.php
@@ -1,10 +1,10 @@
 <?php
-namespace AcelayaTest\UrlShortener\Factory;
+namespace ShlinkioTest\Shlink\Common\Factory;
 
-use Acelaya\UrlShortener\Factory\CacheFactory;
 use Doctrine\Common\Cache\ApcuCache;
 use Doctrine\Common\Cache\ArrayCache;
 use PHPUnit_Framework_TestCase as TestCase;
+use Shlinkio\Shlink\Common\Factory\CacheFactory;
 use Zend\ServiceManager\ServiceManager;
 
 class CacheFactoryTest extends TestCase
diff --git a/tests/Factory/EntityManagerFactoryTest.php b/module/Common/test/Factory/EntityManagerFactoryTest.php
similarity index 88%
rename from tests/Factory/EntityManagerFactoryTest.php
rename to module/Common/test/Factory/EntityManagerFactoryTest.php
index 4b9bd82f..53c839ed 100644
--- a/tests/Factory/EntityManagerFactoryTest.php
+++ b/module/Common/test/Factory/EntityManagerFactoryTest.php
@@ -1,9 +1,9 @@
 <?php
-namespace AcelayaTest\UrlShortener\Factory;
+namespace ShlinkioTest\Shlink\Common\Factory;
 
-use Acelaya\UrlShortener\Factory\EntityManagerFactory;
 use Doctrine\ORM\EntityManager;
 use PHPUnit_Framework_TestCase as TestCase;
+use Shlinkio\Shlink\Common\Factory\EntityManagerFactory;
 use Zend\ServiceManager\ServiceManager;
 
 class EntityManagerFactoryTest extends TestCase
diff --git a/module/Rest/src/Action/ListShortcodesMiddleware.php b/module/Rest/src/Action/ListShortcodesMiddleware.php
index 158a3860..2bea8189 100644
--- a/module/Rest/src/Action/ListShortcodesMiddleware.php
+++ b/module/Rest/src/Action/ListShortcodesMiddleware.php
@@ -1,12 +1,12 @@
 <?php
 namespace Shlinkio\Shlink\Rest\Action;
 
-use Acelaya\UrlShortener\Paginator\Util\PaginatorUtilsTrait;
 use Acelaya\UrlShortener\Service\ShortUrlService;
 use Acelaya\UrlShortener\Service\ShortUrlServiceInterface;
 use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
+use Shlinkio\Shlink\Common\Paginator\Util\PaginatorUtilsTrait;
 use Shlinkio\Shlink\Rest\Util\RestUtils;
 use Zend\Diactoros\Response\JsonResponse;
 
diff --git a/src/Entity/RestToken.php b/src/Entity/RestToken.php
index 90a70f0e..7f122ea4 100644
--- a/src/Entity/RestToken.php
+++ b/src/Entity/RestToken.php
@@ -1,8 +1,8 @@
 <?php
 namespace Acelaya\UrlShortener\Entity;
 
-use Acelaya\UrlShortener\Util\StringUtilsTrait;
 use Doctrine\ORM\Mapping as ORM;
+use Shlinkio\Shlink\Common\Util\StringUtilsTrait;
 
 /**
  * Class RestToken
diff --git a/src/Repository/ShortUrlRepositoryInterface.php b/src/Repository/ShortUrlRepositoryInterface.php
index be7f3fff..af92b6ef 100644
--- a/src/Repository/ShortUrlRepositoryInterface.php
+++ b/src/Repository/ShortUrlRepositoryInterface.php
@@ -2,6 +2,7 @@
 namespace Acelaya\UrlShortener\Repository;
 
 use Doctrine\Common\Persistence\ObjectRepository;
+use Shlinkio\Shlink\Common\Repository\PaginableRepositoryInterface;
 
 interface ShortUrlRepositoryInterface extends ObjectRepository, PaginableRepositoryInterface
 {
diff --git a/src/Service/ShortUrlService.php b/src/Service/ShortUrlService.php
index 9dbc176b..0b200838 100644
--- a/src/Service/ShortUrlService.php
+++ b/src/Service/ShortUrlService.php
@@ -2,10 +2,10 @@
 namespace Acelaya\UrlShortener\Service;
 
 use Acelaya\UrlShortener\Entity\ShortUrl;
-use Acelaya\UrlShortener\Paginator\Adapter\PaginableRepositoryAdapter;
 use Acelaya\UrlShortener\Repository\ShortUrlRepository;
 use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
 use Doctrine\ORM\EntityManagerInterface;
+use Shlinkio\Shlink\Common\Paginator\Adapter\PaginableRepositoryAdapter;
 use Zend\Paginator\Paginator;
 
 class ShortUrlService implements ShortUrlServiceInterface