rayne / semantic-versioning
A tiny independent library for parsing and comparing semantic versions.
Requires
- php: >=5.6
Requires (Dev)
- phpunit/phpunit: ~5.0
This package is auto-updated.
Last update: 2024-11-29 03:58:21 UTC
README
A tiny independent library for parsing and comparing semantic versions which is compatible with Semantic Versioning 2.0.
Dependencies
Production
- PHP 5.6 or better
Development
- Composer
- Git
- PHPUnit
Setup
Download Composer and install rayne/semantic-versioning
.
composer require rayne/semantic-versioning
Tests
-
Clone the repository
git clone https://github.com/rayne/semantic-versioning.php.git
-
Install the development dependencies
composer install --dev
-
Run the tests
./vendor/bin/phpunit
Examples
The library contains the following classes:
-
InvalidVersionException
: Thrown bySemanticVersion
on invalid input -
SemanticComparator
: The semantic versioning comparator for comparingSemanticVersion
objects -
SemanticVersion
: The semantic versioning parser which throws aRuntimeException
on invalid versions
The examples are part of the test suite.
Have a look at the tests
directory for more information.
Interpret semantic versions
use Rayne\SemanticVersioning\SemanticVersion; $version = new SemanticVersion('1.0.0-beta+exp.sha.5114f85'); assert('1.0.0-beta+exp.sha.5114f85' === (string) $version); assert( 1 === $version->getMajor()); assert( 0 === $version->getMinor()); assert( 0 === $version->getPatch()); assert( 'beta' === $version->getPre()); assert( 'exp.sha.5114f85' === $version->getMeta()); assert('1.0.0-beta+exp.sha.5114f85' === $version->getVersion()); assert(true === $version->isMajorRelease()); assert(false === $version->isMinorRelease()); assert(false === $version->isPatchRelease()); assert(true === $version->isPreRelease());
Compare semantic versions
use Rayne\SemanticVersioning\SemanticComparator; use Rayne\SemanticVersioning\SemanticVersion; $comparator = new SemanticComparator; $alpha = new SemanticVersion('1.0.0-alpha'); $candidate = new SemanticVersion('1.0.0-rc.1'); $candidate_meta = new SemanticVersion('1.0.0-rc.1+ci'); $release = new SemanticVersion('1.0.0'); // $alpha < $candidate assert($comparator($alpha, $candidate) < 0); assert($comparator->compare($alpha, $candidate) < 0); // $candidate == $candidate_meta assert($comparator($candidate, $candidate_meta) == 0); assert($comparator->compare($candidate, $candidate_meta) == 0); // $release > $candidate assert($comparator($release, $candidate) > 0); assert($comparator->compare($release, $candidate) > 0);
Sort semantic versions
use Rayne\SemanticVersioning\SemanticComparator; use Rayne\SemanticVersioning\SemanticVersion; $versions = [ $candidate = new SemanticVersion('1.0.0-rc.1'), $release = new SemanticVersion('1.0.0'), $alpha = new SemanticVersion('1.0.0-alpha'), ]; // Sort by semantic precedence. usort($versions, new SemanticComparator); assert($versions[0] === $alpha); assert($versions[1] === $candidate); assert($versions[2] === $release);