#1 - wip: added helper class, updated tests and readme

readme.md

@@ -33,7 +33,18 @@ use Blumilk\Version\Version;
 
 $version = (new Version(true))->generate();
 ```
+#### Helper class
+You can use also the `VersionHelper` class to generate version strings:
+```php  
+<?php
+
+declare(strict_types=1);
 
+use Blumilk\Version\VersionHelper;
+
+$shortVersion = VersionHelper::generateShortVersion();
+$longVersion = VersionHelper::generateLongVersion();
+```
 ### Contributing
 In cloned or forked repository, run:
 ```shell

src/VersionHelper.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Blumilk\Version;
+
+class VersionHelper
+{
+    public static function generateShortVersion(): string
+    {
+        return (new Version())->generate();
+    }
+
+    public static function generateLongVersion(): string
+    {
+        return (new Version(long: true))->generate();
+    }
+}

tests/VersionHelperTest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+use Blumilk\Version\VersionHelper;
+use PHPUnit\Framework\TestCase;
+
+class VersionHelperTest extends TestCase
+{
+    public function testGeneratingVersionBasedOnGit(): void
+    {
+        $version = VersionHelper::generateShortVersion();
+
+        $this->assertIsString($version);
+        $this->assertStringNotContainsString("|", $version);
+    }
+
+    public function testGeneratingLongVersionBasedOnGit(): void
+    {
+        $version = VersionHelper::generateLongVersion();
+        $versionHash = trim(shell_exec("git log --format='%h' -n 1"));
+
+        $this->assertIsString($version);
+        $this->assertStringContainsString("|", $version);
+        $this->assertStringContainsString($versionHash, $version);
+    }
+}

tests/GenerateVersionTest.php → tests/VersionTest.php

@@ -5,7 +5,7 @@
 use Blumilk\Version\Version;
 use PHPUnit\Framework\TestCase;
 
-class GenerateVersionTest extends TestCase
+class VersionTest extends TestCase
 {
     public function testGeneratingVersionBasedOnGit(): void
     {