https://github.com/rayne/semantic-versioning.php

A tiny independent library for parsing and comparing semantic versions.
https://github.com/rayne/semantic-versioning.php

composer composer-packages php php-library semantic-versioning

Last synced: 23 days ago
JSON representation

A tiny independent library for parsing and comparing semantic versions.

• Host: GitHub
• URL: https://github.com/rayne/semantic-versioning.php
• Owner: Rayne
• License: mit
• Created: 2015-12-22T22:06:36.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-12-29T12:56:09.000Z (almost 7 years ago)
• Last Synced: 2024-04-20T20:48:35.678Z (7 months ago)
• Topics: composer, composer-packages, php, php-library, semantic-versioning
• Language: PHP
• Homepage:
• Size: 30.3 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#	Rayne\SemanticVersioning

A tiny independent library for parsing and comparing semantic versions which is compatible with [Semantic Versioning 2.0](http://semver.org).

[![Latest Stable Version](https://poser.pugx.org/rayne/semantic-versioning/v/stable)](https://packagist.org/packages/rayne/semantic-versioning)

[![Latest Unstable Version](https://poser.pugx.org/rayne/semantic-versioning/v/unstable)](https://packagist.org/packages/rayne/semantic-versioning)

[![Build Status](https://travis-ci.org/Rayne/semantic-versioning.php.svg?branch=master)](https://travis-ci.org/Rayne/semantic-versioning.php)

[![Code Coverage](https://scrutinizer-ci.com/g/Rayne/semantic-versioning.php/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/Rayne/semantic-versioning.php/?branch=master)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Rayne/semantic-versioning.php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Rayne/semantic-versioning.php/?branch=master)

[![License](https://poser.pugx.org/rayne/semantic-versioning/license)](https://packagist.org/packages/rayne/semantic-versioning)

##	Dependencies

###	Production

*	PHP 5.6 or better

###	Development

*	Composer

*	Git

*	PHPUnit

##	Setup

[Download Composer](https://getcomposer.org/download) and install `rayne/semantic-versioning`.

	composer require rayne/semantic-versioning

##	Tests

1.	Clone the repository

		git clone https://github.com/rayne/semantic-versioning.php.git

2.	Install the development dependencies

		composer install --dev

3.	Run the tests

 

		./vendor/bin/phpunit

##	Examples

The library contains the following classes:

*	`InvalidVersionException`: Thrown by `SemanticVersion` on invalid input

*	`SemanticComparator`: The semantic versioning comparator for comparing `SemanticVersion` objects

*	`SemanticVersion`: The semantic versioning parser which throws a `RuntimeException` on invalid versions

The examples are part of the test suite.

Have a look at the `tests` directory for more information.

###	Interpret semantic versions

```php

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

```php

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

```php

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);

```