Merge pull request #209 from acelaya/feature/cli-refactoring

CLI Refactoring

bin/install

@@ -1,5 +1,6 @@
 #!/usr/bin/env php
 <?php
+declare(strict_types=1);
 
 use Shlinkio\Shlink\CLI\Factory\InstallApplicationFactory;
 use Shlinkio\Shlink\CLI\Install\Plugin\DatabaseConfigCustomizer;

bin/update

@@ -1,5 +1,6 @@
 #!/usr/bin/env php
 <?php
+declare(strict_types=1);
 
 use Shlinkio\Shlink\CLI\Factory\InstallApplicationFactory;
 use Shlinkio\Shlink\CLI\Install\Plugin\DatabaseConfigCustomizer;

module/CLI/config/cli.config.php

@@ -9,12 +9,12 @@ return [
     'cli' => [
         'locale' => Common\env('CLI_LOCALE', 'en'),
         'commands' => [
-            Command\Shortcode\GenerateShortcodeCommand::NAME => Command\Shortcode\GenerateShortcodeCommand::class,
-            Command\Shortcode\ResolveUrlCommand::NAME => Command\Shortcode\ResolveUrlCommand::class,
-            Command\Shortcode\ListShortcodesCommand::NAME => Command\Shortcode\ListShortcodesCommand::class,
-            Command\Shortcode\GetVisitsCommand::NAME => Command\Shortcode\GetVisitsCommand::class,
-            Command\Shortcode\GeneratePreviewCommand::NAME => Command\Shortcode\GeneratePreviewCommand::class,
-            Command\Shortcode\DeleteShortCodeCommand::NAME => Command\Shortcode\DeleteShortCodeCommand::class,
+            Command\ShortUrl\GenerateShortUrlCommand::NAME => Command\ShortUrl\GenerateShortUrlCommand::class,
+            Command\ShortUrl\ResolveUrlCommand::NAME => Command\ShortUrl\ResolveUrlCommand::class,
+            Command\ShortUrl\ListShortUrlsCommand::NAME => Command\ShortUrl\ListShortUrlsCommand::class,
+            Command\ShortUrl\GetVisitsCommand::NAME => Command\ShortUrl\GetVisitsCommand::class,
+            Command\ShortUrl\GeneratePreviewCommand::NAME => Command\ShortUrl\GeneratePreviewCommand::class,
+            Command\ShortUrl\DeleteShortUrlCommand::NAME => Command\ShortUrl\DeleteShortUrlCommand::class,
 
             Command\Visit\ProcessVisitsCommand::NAME => Command\Visit\ProcessVisitsCommand::class,
 

module/CLI/config/dependencies.config.php

@@ -17,12 +17,12 @@ return [
         'factories' => [
             Application::class => ApplicationFactory::class,
 
-            Command\Shortcode\GenerateShortcodeCommand::class => ConfigAbstractFactory::class,
-            Command\Shortcode\ResolveUrlCommand::class => ConfigAbstractFactory::class,
-            Command\Shortcode\ListShortcodesCommand::class => ConfigAbstractFactory::class,
-            Command\Shortcode\GetVisitsCommand::class => ConfigAbstractFactory::class,
-            Command\Shortcode\GeneratePreviewCommand::class => ConfigAbstractFactory::class,
-            Command\Shortcode\DeleteShortCodeCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\GenerateShortUrlCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\ResolveUrlCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\ListShortUrlsCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\GetVisitsCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\GeneratePreviewCommand::class => ConfigAbstractFactory::class,
+            Command\ShortUrl\DeleteShortUrlCommand::class => ConfigAbstractFactory::class,
 
             Command\Visit\ProcessVisitsCommand::class => ConfigAbstractFactory::class,
 
@@ -41,24 +41,24 @@ return [
     ],
 
     ConfigAbstractFactory::class => [
-        Command\Shortcode\GenerateShortcodeCommand::class => [
+        Command\ShortUrl\GenerateShortUrlCommand::class => [
             Service\UrlShortener::class,
             'translator',
             'config.url_shortener.domain',
         ],
-        Command\Shortcode\ResolveUrlCommand::class => [Service\UrlShortener::class, 'translator'],
-        Command\Shortcode\ListShortcodesCommand::class => [
+        Command\ShortUrl\ResolveUrlCommand::class => [Service\UrlShortener::class, 'translator'],
+        Command\ShortUrl\ListShortUrlsCommand::class => [
             Service\ShortUrlService::class,
             'translator',
             'config.url_shortener.domain',
         ],
-        Command\Shortcode\GetVisitsCommand::class => [Service\VisitsTracker::class, 'translator'],
-        Command\Shortcode\GeneratePreviewCommand::class => [
+        Command\ShortUrl\GetVisitsCommand::class => [Service\VisitsTracker::class, 'translator'],
+        Command\ShortUrl\GeneratePreviewCommand::class => [
             Service\ShortUrlService::class,
             PreviewGenerator::class,
             'translator',
         ],
-        Command\Shortcode\DeleteShortCodeCommand::class => [
+        Command\ShortUrl\DeleteShortUrlCommand::class => [
             Service\ShortUrl\DeleteShortUrlService::class,
             'translator',
         ],

module/CLI/lang/es.po

@@ -1,8 +1,8 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: Shlink 1.0\n"
-"POT-Creation-Date: 2018-09-15 17:57+0200\n"
-"PO-Revision-Date: 2018-09-15 18:02+0200\n"
+"POT-Creation-Date: 2018-09-16 18:36+0200\n"
+"PO-Revision-Date: 2018-09-16 18:37+0200\n"
 "Last-Translator: Alejandro Celaya <alejandro@alejandrocelaya.com>\n"
 "Language-Team: \n"
 "Language: es_ES\n"
@@ -83,8 +83,8 @@ msgstr "Clave secreta: \"%s\""
 msgid "Deletes a short URL"
 msgstr "Elimina una URL"
 
-msgid "The short code to be deleted"
-msgstr "El código corto a eliminar"
+msgid "The short code for the short URL to be deleted"
+msgstr "El código corto de la URL corta a eliminar"
 
 msgid ""
 "Ignores the safety visits threshold check, which could make short URLs with "
@@ -135,9 +135,8 @@ msgstr " <info>¡Correcto!</info>"
 msgid "Error"
 msgstr "Error"
 
-msgid "Generates a short code for provided URL and returns the short URL"
-msgstr ""
-"Genera un código corto para la URL proporcionada y devuelve la URL acortada"
+msgid "Generates a short URL for provided long URL and returns it"
+msgstr "Genera una URL corta para la URL larga proporcionada y la devuelve"
 
 msgid "The long URL to parse"
 msgstr "La URL larga a procesar"
@@ -268,8 +267,8 @@ msgstr "Número de visitas"
 msgid "Tags"
 msgstr "Etiquetas"
 
-msgid "Short codes properly listed"
-msgstr "Códigos cortos correctamente listados"
+msgid "Short URLs properly listed"
+msgstr "URLs cortas listadas correctamente"
 
 msgid "Continue with page"
 msgstr "Continuar con la página"

module/CLI/src/Command/Config/GenerateCharsetCommand.php

@@ -28,7 +28,7 @@ class GenerateCharsetCommand extends Command
     public function configure()
     {
         $this->setName(self::NAME)
-             ->setDescription(sprintf($this->translator->translate(
+             ->setDescription(\sprintf($this->translator->translate(
                  'Generates a character set sample just by shuffling the default one, "%s". '
                  . 'Then it can be set in the SHORTCODE_CHARS environment variable'
              ), UrlShortener::DEFAULT_CHARS));

module/CLI/src/Command/Install/InstallCommand.php

@@ -102,7 +102,7 @@ class InstallCommand extends Command
 
         $this->io->writeln([
             '<info>Welcome to Shlink!!</info>',
-            'This will guide you through the installation process.',
+            'This tool will guide you through the installation process.',
         ]);
 
         // Check if a cached config file exists and drop it if so

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

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
 
 use Shlinkio\Shlink\Core\Exception;
 use Shlinkio\Shlink\Core\Service\ShortUrl\DeleteShortUrlServiceInterface;
@@ -13,10 +13,10 @@ use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Zend\I18n\Translator\TranslatorInterface;
 
-class DeleteShortCodeCommand extends Command
+class DeleteShortUrlCommand extends Command
 {
-    public const NAME = 'short-code:delete';
-    private const ALIASES = [];
+    public const NAME = 'short-url:delete';
+    private const ALIASES = ['short-code:delete'];
 
     /**
      * @var DeleteShortUrlServiceInterface
@@ -45,7 +45,7 @@ class DeleteShortCodeCommand extends Command
             ->addArgument(
                 'shortCode',
                 InputArgument::REQUIRED,
-                $this->translator->translate('The short code to be deleted')
+                $this->translator->translate('The short code for the short URL to be deleted')
             )
             ->addOption(
                 'ignore-threshold',

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

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
 
 use Shlinkio\Shlink\Common\Exception\PreviewGenerationException;
 use Shlinkio\Shlink\Common\Service\PreviewGeneratorInterface;
@@ -14,8 +14,8 @@ use Zend\I18n\Translator\TranslatorInterface;
 
 class GeneratePreviewCommand extends Command
 {
-    public const NAME = 'short-code:process-previews';
-    private const ALIASES = ['shortcode:process-previews'];
+    public const NAME = 'short-url:process-previews';
+    private const ALIASES = ['shortcode:process-previews', 'short-code:process-previews'];
 
     /**
      * @var PreviewGeneratorInterface

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

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
 
 use Shlinkio\Shlink\Core\Exception\InvalidUrlException;
 use Shlinkio\Shlink\Core\Exception\NonUniqueSlugException;
@@ -16,12 +16,12 @@ use Symfony\Component\Console\Style\SymfonyStyle;
 use Zend\Diactoros\Uri;
 use Zend\I18n\Translator\TranslatorInterface;
 
-class GenerateShortcodeCommand extends Command
+class GenerateShortUrlCommand extends Command
 {
     use ShortUrlBuilderTrait;
 
-    public const NAME = 'short-code:generate';
-    private const ALIASES = ['shortcode:generate'];
+    public const NAME = 'short-url:generate';
+    private const ALIASES = ['shortcode:generate', 'short-code:generate'];
 
     /**
      * @var UrlShortenerInterface
@@ -53,7 +53,7 @@ class GenerateShortcodeCommand extends Command
             ->setName(self::NAME)
             ->setAliases(self::ALIASES)
             ->setDescription(
-                $this->translator->translate('Generates a short code for provided URL and returns the short URL')
+                $this->translator->translate('Generates a short URL for provided long URL and returns it')
             )
             ->addArgument('longUrl', InputArgument::REQUIRED, $this->translator->translate('The long URL to parse'))
             ->addOption(

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

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
 
 use Shlinkio\Shlink\Common\Util\DateRange;
 use Shlinkio\Shlink\Core\Service\VisitsTrackerInterface;
@@ -15,8 +15,8 @@ use Zend\I18n\Translator\TranslatorInterface;
 
 class GetVisitsCommand extends Command
 {
-    public const NAME = 'short-code:visits';
-    private const ALIASES = ['shortcode:visits'];
+    public const NAME = 'short-url:visits';
+    private const ALIASES = ['shortcode:visits', 'short-code:visits'];
 
     /**
      * @var VisitsTrackerInterface

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

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
 
 use Shlinkio\Shlink\Common\Paginator\Adapter\PaginableRepositoryAdapter;
 use Shlinkio\Shlink\Common\Paginator\Util\PaginatorUtilsTrait;
@@ -14,12 +14,12 @@ use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Zend\I18n\Translator\TranslatorInterface;
 
-class ListShortcodesCommand extends Command
+class ListShortUrlsCommand extends Command
 {
     use PaginatorUtilsTrait;
 
-    public const NAME = 'short-code:list';
-    private const ALIASES = ['shortcode:list'];
+    public const NAME = 'short-url:list';
+    private const ALIASES = ['shortcode:list', 'short-code:list'];
 
     /**
      * @var ShortUrlServiceInterface
@@ -132,7 +132,7 @@ class ListShortcodesCommand extends Command
 
             if ($this->isLastPage($result)) {
                 $continue = false;
-                $io->success($this->translator->translate('Short codes properly listed'));
+                $io->success($this->translator->translate('Short URLs properly listed'));
             } else {
                 $continue = $io->confirm(
                     \sprintf($this->translator->translate('Continue with page') . ' <options=bold>%s</>?', $page),

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

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace Shlinkio\Shlink\CLI\Command\Shortcode;
+namespace Shlinkio\Shlink\CLI\Command\ShortUrl;
 
 use Shlinkio\Shlink\Core\Exception\EntityDoesNotExistException;
 use Shlinkio\Shlink\Core\Exception\InvalidShortCodeException;
@@ -15,8 +15,8 @@ use Zend\I18n\Translator\TranslatorInterface;
 
 class ResolveUrlCommand extends Command
 {
-    public const NAME = 'short-code:parse';
-    private const ALIASES = ['shortcode:parse'];
+    public const NAME = 'short-url:parse';
+    private const ALIASES = ['shortcode:parse', 'short-code:parse'];
 
     /**
      * @var UrlShortenerInterface

module/CLI/src/Factory/InstallApplicationFactory.php

@@ -50,7 +50,7 @@ class InstallApplicationFactory implements FactoryInterface
             $isUpdate
         );
         $app->add($command);
-        $app->setDefaultCommand($command->getName());
+        $app->setDefaultCommand($command->getName(), true);
 
         return $app;
     }

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

@@ -1,12 +1,12 @@
 <?php
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\CLI\Command\Shortcode;
+namespace ShlinkioTest\Shlink\CLI\Command\ShortUrl;
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
-use Shlinkio\Shlink\CLI\Command\Shortcode\DeleteShortCodeCommand;
+use Shlinkio\Shlink\CLI\Command\ShortUrl\DeleteShortUrlCommand;
 use Shlinkio\Shlink\Core\Exception;
 use Shlinkio\Shlink\Core\Service\ShortUrl\DeleteShortUrlServiceInterface;
 use Symfony\Component\Console\Application;
@@ -28,7 +28,7 @@ class DeleteShortCodeCommandTest extends TestCase
     {
         $this->service = $this->prophesize(DeleteShortUrlServiceInterface::class);
 
-        $command = new DeleteShortCodeCommand($this->service->reveal(), Translator::factory([]));
+        $command = new DeleteShortUrlCommand($this->service->reveal(), Translator::factory([]));
         $app = new Application();
         $app->add($command);
 

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

@@ -1,12 +1,12 @@
 <?php
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\CLI\Command\Shortcode;
+namespace ShlinkioTest\Shlink\CLI\Command\ShortUrl;
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
-use Shlinkio\Shlink\CLI\Command\Shortcode\GeneratePreviewCommand;
+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;

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

@@ -1,12 +1,12 @@
 <?php
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\CLI\Command\Shortcode;
+namespace ShlinkioTest\Shlink\CLI\Command\ShortUrl;
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
-use Shlinkio\Shlink\CLI\Command\Shortcode\GenerateShortcodeCommand;
+use Shlinkio\Shlink\CLI\Command\ShortUrl\GenerateShortUrlCommand;
 use Shlinkio\Shlink\Core\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\Exception\InvalidUrlException;
 use Shlinkio\Shlink\Core\Service\UrlShortener;
@@ -28,7 +28,7 @@ class GenerateShortcodeCommandTest extends TestCase
     public function setUp()
     {
         $this->urlShortener = $this->prophesize(UrlShortener::class);
-        $command = new GenerateShortcodeCommand($this->urlShortener->reveal(), Translator::factory([]), [
+        $command = new GenerateShortUrlCommand($this->urlShortener->reveal(), Translator::factory([]), [
             'schema' => 'http',
             'hostname' => 'foo.com',
         ]);

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

@@ -1,12 +1,12 @@
 <?php
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\CLI\Command\Shortcode;
+namespace ShlinkioTest\Shlink\CLI\Command\ShortUrl;
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
-use Shlinkio\Shlink\CLI\Command\Shortcode\GetVisitsCommand;
+use Shlinkio\Shlink\CLI\Command\ShortUrl\GetVisitsCommand;
 use Shlinkio\Shlink\Common\Util\DateRange;
 use Shlinkio\Shlink\Core\Entity\Visit;
 use Shlinkio\Shlink\Core\Entity\VisitLocation;

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

@@ -1,12 +1,12 @@
 <?php
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\CLI\Command\Shortcode;
+namespace ShlinkioTest\Shlink\CLI\Command\ShortUrl;
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
-use Shlinkio\Shlink\CLI\Command\Shortcode\ListShortcodesCommand;
+use Shlinkio\Shlink\CLI\Command\ShortUrl\ListShortUrlsCommand;
 use Shlinkio\Shlink\Core\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\Service\ShortUrlServiceInterface;
 use Symfony\Component\Console\Application;
@@ -30,7 +30,7 @@ class ListShortcodesCommandTest extends TestCase
     {
         $this->shortUrlService = $this->prophesize(ShortUrlServiceInterface::class);
         $app = new Application();
-        $command = new ListShortcodesCommand($this->shortUrlService->reveal(), Translator::factory([]), []);
+        $command = new ListShortUrlsCommand($this->shortUrlService->reveal(), Translator::factory([]), []);
         $app->add($command);
         $this->commandTester = new CommandTester($command);
     }

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

@@ -1,11 +1,11 @@
 <?php
 declare(strict_types=1);
 
-namespace ShlinkioTest\Shlink\CLI\Command\Shortcode;
+namespace ShlinkioTest\Shlink\CLI\Command\ShortUrl;
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Prophecy\ObjectProphecy;
-use Shlinkio\Shlink\CLI\Command\Shortcode\ResolveUrlCommand;
+use Shlinkio\Shlink\CLI\Command\ShortUrl\ResolveUrlCommand;
 use Shlinkio\Shlink\Core\Entity\ShortUrl;
 use Shlinkio\Shlink\Core\Exception\EntityDoesNotExistException;
 use Shlinkio\Shlink\Core\Exception\InvalidShortCodeException;