change how application version (short/long) is handled

Author: llaville

CHANGELOG.md

@@ -7,8 +7,13 @@ using the [Keep a CHANGELOG](http://keepachangelog.com) principles.
 
 ## [Unreleased]
 
+### Added
+
+- `about` command to display current long version and more information about this package.
+
 ### Changed
 
+- option `--version` display now only long version without application description.
 - upgrade [docker-php-extension-installer](https://github.com/mlocati/docker-php-extension-installer) to version 1.4.12
 - `rdfkafka` extension is now supported by PHP 8.1
 - `bin/devkit.php` is made available into the Composer `bin-dir`
@@ -24,6 +29,7 @@ using the [Keep a CHANGELOG](http://keepachangelog.com) principles.
 
 - drop support for PHP 7.3 has ended 6th December 2021.
 - drop support for Composer v1
+- `Bartlett\PHPToolbox\Console\ApplicationInterface::VERSION` constant to define current version (replaced by Composer Runtime API v2)
 
 ## [1.3.0] - 2022-01-09
 

bin/devkit.php

@@ -3,6 +3,7 @@
 // @link https://www.tomasvotruba.cz/blog/2018/08/02/5-gotchas-of-the-bin-file-in-php-cli-applications/
 
 use Bartlett\PHPToolbox\Console\ApplicationInterface;
+use Bartlett\PHPToolbox\Console\Command\About;
 use Bartlett\PHPToolbox\Console\Command\UpdateExtensions;
 use Bartlett\PHPToolbox\Console\Command\UpdateTools;
 use Bartlett\PHPToolbox\DependencyInjection\ContainerFactory;
@@ -11,6 +12,7 @@
 
 $container = (new ContainerFactory())->create(basename(__FILE__, '.php'));
 $application = $container->get(ApplicationInterface::class);
+$application->add(new About());
 $application->add(new UpdateExtensions());
 $application->add(new UpdateTools());
 exit($application->run());

src/Console/Application.php

@@ -7,9 +7,14 @@
  */
 namespace Bartlett\PHPToolbox\Console;
 
+use Composer\InstalledVersions;
+
 use Symfony\Component\Console\Application as SymfonyApplication;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
+use function sprintf;
+use function substr;
+
 /**
  * @since Release 1.0.0alpha1
  * @author Laurent Laville
@@ -23,7 +28,10 @@ final class Application extends SymfonyApplication implements ApplicationInterfa
      */
     public function __construct()
     {
-        parent::__construct(self::NAME, self::VERSION);
+        parent::__construct(
+            self::NAME,
+            $this->getInstalledVersion(false)
+        );
     }
 
     /**
@@ -34,4 +42,36 @@ public function setContainer(ContainerInterface $container = null)
     {
         $this->container = $container;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getHelp(): string
+    {
+        return sprintf(
+            '<info>%s</info> version <comment>%s</comment>',
+            $this->getName(),
+            $this->getVersion()
+        );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getLongVersion(): string
+    {
+        return $this->getInstalledVersion();
+    }
+
+    public function getInstalledVersion(bool $withRef = true): string
+    {
+        $packageName = 'bartlett/docker-php-toolbox';
+
+        $version = InstalledVersions::getPrettyVersion($packageName);
+        if (!$withRef) {
+            return $version;
+        }
+        $commitHash = InstalledVersions::getReference($packageName);
+        return sprintf('%s@%s', $version, substr($commitHash, 0, 7));
+    }
 }

src/Console/ApplicationInterface.php

@@ -17,11 +17,22 @@
 interface ApplicationInterface extends ContainerAwareInterface
 {
     public const NAME = 'Helper to discover and install PHP extensions and/or tools';
-    public const VERSION = '1.2.0';
 
     /**
      * @param CommandLoaderInterface $commandLoader
      * @return void
      */
     public function setCommandLoader(CommandLoaderInterface $commandLoader);
+
+    /**
+     * Gets the name of the application.
+     *
+     * @return string
+     */
+    public function getName();
+
+    /**
+     * Gets the current version installed of the application.
+     */
+    public function getInstalledVersion(bool $withRef = true): string;
 }

src/Console/Command/About.php

@@ -0,0 +1,64 @@
+<?php declare(strict_types=1);
+/**
+ * This file is part of the Docker-PHP-Toolbox package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace Bartlett\PHPToolbox\Console\Command;
+
+use Bartlett\PHPToolbox\Console\ApplicationInterface;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+use function sprintf;
+
+/**
+ * Shows short information about this package.
+ *
+ * @since Release 1.4.0
+ * @author Laurent Laville
+ */
+final class About extends Command implements CommandInterface
+{
+    public const NAME = 'about';
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function configure(): void
+    {
+        $this->setName(self::NAME)
+            ->setDescription('Shows short information about this package')
+        ;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        /** @var ApplicationInterface $app */
+        $app = $this->getApplication();
+
+        $lines = [
+            sprintf(
+                '<info>%s</info> version <comment>%s</comment>',
+                $app->getName(),
+                $app->getInstalledVersion()
+            ),
+            sprintf(
+                '<comment>Please visit %s for more information.</comment>',
+                'https://llaville.github.io/docker-php-toolbox/'
+            ),
+        ];
+        $io->text($lines);
+
+        return self::SUCCESS;
+    }
+}