Merge pull request #285 from Ocramius/feature/#284-dynamic-package-ve…

…rsion-resolution

Feature - #284 - dynamic package version resolution

UPGRADE.md

@@ -26,7 +26,8 @@ This is a list of backwards compatibility (BC) breaks introduced in ProxyManager
    remove them.
  * Private properties are now also correctly handled by ProxyManager: accessing proxy state via friend classes
    (protected or private scope) does not require any particular workarounds anymore.
-
+ * `ProxyManager\Version::VERSION` was removed. Please use `ProxyManager\Version::getVersion()` instead.
+
 # 1.0.0
 
 `1.0.0` is be fully compatible with `0.5.0`.

composer.json

@@ -19,8 +19,9 @@
         }
     ],
     "require": {
-        "php":                     "~7.0",
-        "zendframework/zend-code": "~3.0"
+        "php":                       "~7.0",
+        "zendframework/zend-code":   "~3.0",
+        "ocramius/package-versions": "^1.0"
     },
     "require-dev": {
         "ext-phar":                    "*",

src/ProxyManager/Factory/AbstractBaseFactory.php

@@ -71,7 +71,7 @@ protected function generateProxy(string $className, array $proxyOptions = []) :
         $proxyParameters = [
             'className'           => $className,
             'factory'             => get_class($this),
-            'proxyManagerVersion' => Version::VERSION
+            'proxyManagerVersion' => Version::getVersion(),
         ];
         $proxyClassName  = $this
             ->configuration

src/ProxyManager/Version.php

@@ -20,6 +20,8 @@
 
 namespace ProxyManager;
 
+use PackageVersions\Versions;
+
 /**
  * Version class - to be adjusted when a new release is created.
  *
@@ -30,12 +32,21 @@
  */
 final class Version
 {
-    const VERSION = '2.0.0-dev';
-
     /**
      * Private constructor - this class is not meant to be instantiated
      */
     private function __construct()
     {
     }
+
+    /**
+     * Retrieves the package version in the format <detected-version>@<commit-hash>,
+     * where the detected version is what composer could detect.
+     *
+     * @return string
+     */
+    public static function getVersion() : string
+    {
+        return Versions::getVersion('ocramius/proxy-manager');
+    }
 }

tests/ProxyManagerTest/VersionTest.php

@@ -34,11 +34,12 @@
  */
 class VersionTest extends PHPUnit_Framework_TestCase
 {
-    public function testVersionNumberIsSemverCompliant()
+    public function testGetVersion()
     {
-        $this->assertRegExp(
-            '/\d+\.\d+\.\d+(-(ALPHA|BETA|RC(\d+)?|DEV))?/i',
-            Version::VERSION
-        );
+        $version = Version::getVersion();
+
+        self::assertInternalType('string', $version);
+        self::assertNotEmpty($version);
+        self::assertStringMatchesFormat('%A@%A', $version);
     }
 }