Created Common module

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;

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,
+        ],
+    ],
+
+];

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));
+    }
+}

module/Common/src/Factory/CacheFactory.php

@@ -0,0 +1,30 @@
+<?php
+namespace Shlinkio\Shlink\Common\Factory;
+
+use Doctrine\Common\Cache\ApcuCache;
+use Doctrine\Common\Cache\ArrayCache;
+use Interop\Container\ContainerInterface;
+use Interop\Container\Exception\ContainerException;
+use Zend\ServiceManager\Exception\ServiceNotCreatedException;
+use Zend\ServiceManager\Exception\ServiceNotFoundException;
+use Zend\ServiceManager\Factory\FactoryInterface;
+
+class CacheFactory implements FactoryInterface
+{
+    /**
+     * Create an object
+     *
+     * @param  ContainerInterface $container
+     * @param  string $requestedName
+     * @param  null|array $options
+     * @return object
+     * @throws ServiceNotFoundException if unable to resolve the service.
+     * @throws ServiceNotCreatedException if an exception is raised when
+     *     creating a service.
+     * @throws ContainerException if any other error occurs
+     */
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
+    {
+        return getenv('APP_ENV') === 'pro' ? new ApcuCache() : new ArrayCache();
+    }
+}

module/Common/src/Factory/EntityManagerFactory.php

@@ -0,0 +1,43 @@
+<?php
+namespace Shlinkio\Shlink\Common\Factory;
+
+use Doctrine\Common\Cache\ArrayCache;
+use Doctrine\Common\Cache\Cache;
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Tools\Setup;
+use Interop\Container\ContainerInterface;
+use Interop\Container\Exception\ContainerException;
+use Zend\ServiceManager\Exception\ServiceNotCreatedException;
+use Zend\ServiceManager\Exception\ServiceNotFoundException;
+use Zend\ServiceManager\Factory\FactoryInterface;
+
+class EntityManagerFactory implements FactoryInterface
+{
+    /**
+     * Create an object
+     *
+     * @param  ContainerInterface $container
+     * @param  string $requestedName
+     * @param  null|array $options
+     * @return object
+     * @throws ServiceNotFoundException if unable to resolve the service.
+     * @throws ServiceNotCreatedException if an exception is raised when
+     *     creating a service.
+     * @throws ContainerException if any other error occurs
+     */
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
+    {
+        $globalConfig = $container->get('config');
+        $isDevMode = isset($globalConfig['debug']) ? ((bool) $globalConfig['debug']) : false;
+        $cache = $container->has(Cache::class) ? $container->get(Cache::class) : new ArrayCache();
+        $dbConfig = isset($globalConfig['database']) ? $globalConfig['database'] : [];
+
+        return EntityManager::create($dbConfig, Setup::createAnnotationMetadataConfiguration(
+            ['src/Entity'],
+            $isDevMode,
+            'data/proxies',
+            $cache,
+            false
+        ));
+    }
+}

module/Common/src/Paginator/Adapter/PaginableRepositoryAdapter.php

@@ -0,0 +1,56 @@
+<?php
+namespace Shlinkio\Shlink\Common\Paginator\Adapter;
+
+use Shlinkio\Shlink\Common\Repository\PaginableRepositoryInterface;
+use Zend\Paginator\Adapter\AdapterInterface;
+
+class PaginableRepositoryAdapter implements AdapterInterface
+{
+    const ITEMS_PER_PAGE = 10;
+
+    /**
+     * @var PaginableRepositoryInterface
+     */
+    private $paginableRepository;
+    /**
+     * @var null
+     */
+    private $searchTerm;
+    /**
+     * @var null
+     */
+    private $orderBy;
+
+    public function __construct(PaginableRepositoryInterface $paginableRepository, $searchTerm = null, $orderBy = null)
+    {
+        $this->paginableRepository = $paginableRepository;
+        $this->searchTerm = $searchTerm;
+        $this->orderBy = $orderBy;
+    }
+
+    /**
+     * Returns a collection of items for a page.
+     *
+     * @param  int $offset Page offset
+     * @param  int $itemCountPerPage Number of items per page
+     * @return array
+     */
+    public function getItems($offset, $itemCountPerPage)
+    {
+        return $this->paginableRepository->findList($itemCountPerPage, $offset, $this->searchTerm, $this->orderBy);
+    }
+
+    /**
+     * Count elements of an object
+     * @link http://php.net/manual/en/countable.count.php
+     * @return int The custom count as an integer.
+     * </p>
+     * <p>
+     * The return value is cast to an integer.
+     * @since 5.1.0
+     */
+    public function count()
+    {
+        return $this->paginableRepository->countList($this->searchTerm);
+    }
+}

module/Common/src/Paginator/Util/PaginatorUtilsTrait.php

@@ -0,0 +1,30 @@
+<?php
+namespace Shlinkio\Shlink\Common\Paginator\Util;
+
+use Zend\Paginator\Paginator;
+use Zend\Stdlib\ArrayUtils;
+
+trait PaginatorUtilsTrait
+{
+    protected function serializePaginator(Paginator $paginator)
+    {
+        return [
+            'data' => ArrayUtils::iteratorToArray($paginator->getCurrentItems()),
+            'pagination' => [
+                'currentPage' => $paginator->getCurrentPageNumber(),
+                'pagesCount' => $paginator->count(),
+            ],
+        ];
+    }
+
+    /**
+     * Checks if provided paginator is in last page
+     *
+     * @param Paginator $paginator
+     * @return bool
+     */
+    protected function isLastPage(Paginator $paginator)
+    {
+        return $paginator->getCurrentPageNumber() >= $paginator->count();
+    }
+}

module/Common/src/Repository/PaginableRepositoryInterface.php

@@ -0,0 +1,24 @@
+<?php
+namespace Shlinkio\Shlink\Common\Repository;
+
+interface PaginableRepositoryInterface
+{
+    /**
+     * Gets a list of elements using provided filtering data
+     *
+     * @param int|null $limit
+     * @param int|null $offset
+     * @param string|null $searchTerm
+     * @param string|array|null $orderBy
+     * @return array
+     */
+    public function findList($limit = null, $offset = null, $searchTerm = null, $orderBy = null);
+
+    /**
+     * Counts the number of elements in a list using provided filtering data
+     *
+     * @param null $searchTerm
+     * @return int
+     */
+    public function countList($searchTerm = null);
+}

module/Common/src/Util/StringUtilsTrait.php

@@ -0,0 +1,40 @@
+<?php
+namespace Shlinkio\Shlink\Common\Util;
+
+trait StringUtilsTrait
+{
+    protected function generateRandomString($length = 10)
+    {
+        $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
+        $charactersLength = strlen($characters);
+        $randomString = '';
+        for ($i = 0; $i < $length; $i++) {
+            $randomString .= $characters[rand(0, $charactersLength - 1)];
+        }
+
+        return $randomString;
+    }
+
+    protected function generateV4Uuid()
+    {
+        return sprintf(
+            '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
+            // 32 bits for "time_low"
+            mt_rand(0, 0xffff),
+            mt_rand(0, 0xffff),
+            // 16 bits for "time_mid"
+            mt_rand(0, 0xffff),
+            // 16 bits for "time_hi_and_version",
+            // four most significant bits holds version number 4
+            mt_rand(0, 0x0fff) | 0x4000,
+            // 16 bits, 8 bits for "clk_seq_hi_res",
+            // 8 bits for "clk_seq_low",
+            // two most significant bits holds zero and one for variant DCE1.1
+            mt_rand(0, 0x3fff) | 0x8000,
+            // 48 bits for "node"
+            mt_rand(0, 0xffff),
+            mt_rand(0, 0xffff),
+            mt_rand(0, 0xffff)
+        );
+    }
+}

module/Common/test/Factory/CacheFactoryTest.php

@@ -0,0 +1,46 @@
+<?php
+namespace ShlinkioTest\Shlink\Common\Factory;
+
+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
+{
+    /**
+     * @var CacheFactory
+     */
+    protected $factory;
+
+    public function setUp()
+    {
+        $this->factory = new CacheFactory();
+    }
+
+    public static function tearDownAfterClass()
+    {
+        putenv('APP_ENV');
+    }
+
+    /**
+     * @test
+     */
+    public function productionReturnsApcAdapter()
+    {
+        putenv('APP_ENV=pro');
+        $instance = $this->factory->__invoke(new ServiceManager(), '');
+        $this->assertInstanceOf(ApcuCache::class, $instance);
+    }
+
+    /**
+     * @test
+     */
+    public function developmentReturnsArrayAdapter()
+    {
+        putenv('APP_ENV=dev');
+        $instance = $this->factory->__invoke(new ServiceManager(), '');
+        $this->assertInstanceOf(ArrayCache::class, $instance);
+    }
+}

module/Common/test/Factory/EntityManagerFactoryTest.php

@@ -0,0 +1,38 @@
+<?php
+namespace ShlinkioTest\Shlink\Common\Factory;
+
+use Doctrine\ORM\EntityManager;
+use PHPUnit_Framework_TestCase as TestCase;
+use Shlinkio\Shlink\Common\Factory\EntityManagerFactory;
+use Zend\ServiceManager\ServiceManager;
+
+class EntityManagerFactoryTest extends TestCase
+{
+    /**
+     * @var EntityManagerFactory
+     */
+    protected $factory;
+
+    public function setUp()
+    {
+        $this->factory = new EntityManagerFactory();
+    }
+
+    /**
+     * @test
+     */
+    public function serviceIsCreated()
+    {
+        $sm = new ServiceManager(['services' => [
+            'config' => [
+                'debug' => true,
+                'database' => [
+                    'driver' => 'pdo_sqlite',
+                ],
+            ],
+        ]]);
+
+        $em = $this->factory->__invoke($sm, EntityManager::class);
+        $this->assertInstanceOf(EntityManager::class, $em);
+    }
+}

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;