Add name and description to version information.

Author: bjoern-hempel

composer.json

@@ -24,7 +24,7 @@
   "require": {
     "php":  "^8.0",
     "ixnode/php-exception": "^0.1.7",
-    "ixnode/php-container": "^0.1.0"
+    "ixnode/php-container": "^0.1.2"
   },
   "bin": [
     "bin/version-manager"

composer.lock

@@ -15,7 +15,12 @@
 
 use Composer\Autoload\ClassLoader;
 use Ixnode\PhpContainer\File;
+use Ixnode\PhpContainer\Json;
+use Ixnode\PhpException\ArrayType\ArrayKeyNotFoundException;
 use Ixnode\PhpException\File\FileNotFoundException;
+use Ixnode\PhpException\Function\FunctionJsonEncodeException;
+use Ixnode\PhpException\Type\TypeInvalidException;
+use JsonException;
 use ReflectionClass;
 
 /**
@@ -35,8 +40,14 @@ class Version
 
     public const PATH_VERSION = 'VERSION';
 
+    public const PATH_COMPOSER_JSON = 'composer.json';
+
     public const INDEX_VERSION = 'version';
 
+    public const INDEX_NAME = 'name';
+
+    public const INDEX_DESCRIPTION = 'description';
+
     public const INDEX_DATE = 'date';
 
     public const INDEX_LICENSE = 'license';
@@ -67,9 +78,35 @@ public function __construct(?string $rootDir = null)
      */
     public function getVersion(): string
     {
-        $versionFile = $this->getVersionFile();
+        return $this->getVersionFile()->getContentAsTextTrim();
+    }
 
-        return (new File($versionFile))->getContentAsTextTrim();
+    /**
+     * Returns the name of this application.
+     *
+     * @return string
+     * @throws ArrayKeyNotFoundException
+     * @throws FunctionJsonEncodeException
+     * @throws JsonException
+     * @throws TypeInvalidException
+     */
+    public function getName(): string
+    {
+        return $this->getComposerKey(self::INDEX_NAME);
+    }
+
+    /**
+     * Returns the description of this application.
+     *
+     * @return string
+     * @throws ArrayKeyNotFoundException
+     * @throws FunctionJsonEncodeException
+     * @throws JsonException
+     * @throws TypeInvalidException
+     */
+    public function getDescription(): string
+    {
+        return $this->getComposerKey(self::INDEX_DESCRIPTION);
     }
 
     /**
@@ -80,15 +117,7 @@ public function getVersion(): string
      */
     public function getDate(): string
     {
-        $versionFile = $this->getVersionFile();
-
-        $mtime = filemtime($versionFile);
-
-        if ($mtime === false) {
-            throw new FileNotFoundException($versionFile);
-        }
-
-        return date ('l, F d, Y - H:i:s', $mtime);
+        return $this->getVersionFile()->getDate();
     }
 
     /**
@@ -120,6 +149,8 @@ public function getAuthors(): array
     public function getAll(): array
     {
         return [
+            self::INDEX_NAME => $this->getName(),
+            self::INDEX_DESCRIPTION => $this->getDescription(),
             self::INDEX_VERSION => $this->getVersion(),
             self::INDEX_DATE => $this->getDate(),
             self::INDEX_LICENSE => $this->getLicense(),
@@ -130,10 +161,37 @@ public function getAll(): array
     /**
      * Returns the version file.
      *
+     * @return File
+     */
+    public function getVersionFile(): File
+    {
+        return new File(sprintf('%s/%s', $this->rootDir, self::PATH_VERSION));
+    }
+
+    /**
+     * Returns the composer json file.
+     *
+     * @return File
+     */
+    public function getComposerFile(): File
+    {
+        return new File(sprintf('%s/%s', $this->rootDir, self::PATH_COMPOSER_JSON));
+    }
+
+    /**
+     * Returns a value from composer.json given by key name.
+     *
+     * @param string|string[] $keys
      * @return string
+     * @throws FunctionJsonEncodeException
+     * @throws TypeInvalidException
+     * @throws JsonException
+     * @throws ArrayKeyNotFoundException
      */
-    public function getVersionFile(): string
+    public function getComposerKey(string|array $keys): string
     {
-        return sprintf('%s/%s', $this->rootDir, self::PATH_VERSION);
+        $json = new Json($this->getComposerFile());
+
+        return $json->getKeyString($keys);
     }
 }

src/Version.php

@@ -41,6 +41,8 @@ public function wrapper(): void
         $versionString = $this->getVersionString();
         $dateString = $this->getDateString();
         $versionArray = [
+            Version::INDEX_NAME => 'ixnode/bash-version-manager',
+            Version::INDEX_DESCRIPTION => 'Bash Version Manager',
             Version::INDEX_VERSION => $versionString,
             Version::INDEX_DATE => $dateString,
             Version::INDEX_LICENSE => Version::VALUE_LICENSE,
@@ -64,7 +66,7 @@ protected function getVersionString(): string
     {
         $versionFile = (new Version())->getVersionFile();
 
-        return (new File($versionFile))->getContentAsTextTrim();
+        return $versionFile->getContentAsTextTrim();
     }
 
     /**
@@ -77,10 +79,10 @@ protected function getDateString(): string
     {
         $versionFile = (new Version())->getVersionFile();
 
-        $mtime = filemtime($versionFile);
+        $mtime = filemtime($versionFile->getPathReal());
 
         if ($mtime === false) {
-            throw new FileNotFoundException($versionFile);
+            throw new FileNotFoundException($versionFile->getPath());
         }
 
         return date ('l, F d, Y - H:i:s', $mtime);