Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rollerworks/version
Semantic Versioning helper library. Validation, incrementing (get next possible version(s)).
https://github.com/rollerworks/version
php rollerworks semver validation version
Last synced: 23 days ago
JSON representation
Semantic Versioning helper library. Validation, incrementing (get next possible version(s)).
- Host: GitHub
- URL: https://github.com/rollerworks/version
- Owner: rollerworks
- License: mit
- Created: 2017-03-19T10:17:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T19:28:56.000Z (7 months ago)
- Last Synced: 2024-10-15T02:32:52.786Z (about 1 month ago)
- Topics: php, rollerworks, semver, validation, version
- Language: PHP
- Homepage:
- Size: 44.9 KB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Rollerworks Semver Component
============================
A small Semantic Versioning helper library.
Validation Continues Versions. Finding next possible version version increments.
Requirements
------------
You need at least PHP 7.1
Installation
------------
To install this package, add `rollerworks/version` to your composer.json
```bash
$ php composer.phar require rollerworks/version
```
This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.
Now, Composer will automatically download all required files, and install them
for you.
Basic usage
-----------
```php
require 'vendor/autoload.php';
use Rollerworks\Component\Version\Version;
use Rollerworks\Component\Version\VersionsValidator;
// Creates an immutable Version value-object.
// Any call to this object will produce a new Version object
$version = Version::fromString('v1.3.2');
$newVersion = $version->increase('major'); // v2.0.0
$newVersion = $version->increase('minor'); // v1.4.0
$newVersion = $version->increase('next'); // v1.4.0
$newVersion = $version->increase('patch'); // v1.3.3
$newVersion = $version->increase('stable'); // v1.4.0
$newVersion = $version->increase('alpha'); // v1.4.0-ALPHA1
$newVersion = $version->increase('beta'); // v1.4.0-BETA1
$newVersion = $version->increase('rc'); // v1.4.0-RC1
// ...
// Increasing minor or patch is prohibited until the meta-ver (alpha,beta,rc) is 0
// For patch this resolves to "next".
$version = Version::fromString('v1.4.0-BETA1');
$newVersion = $version->increase('beta'); // v1.4.0-BETA2
$newVersion = $version->increase('rc'); // v1.4.0-RC1
$newVersion = $version->increase('major'); // v1.4.0
$newVersion = $version->increase('next'); // v1.4.0-BETA2
$newVersion = $version->increase('patch'); // v1.4.0-BETA2
$newVersion = $version->increase('stable'); // v1.4.0
// Version validation
// ... //
$existingVersions = [
Version::fromString('0.1.0'),
Version::fromString('v1.0.0-beta1'),
Version::fromString('v1.0.0-beta2'),
Version::fromString('v1.0.0-beta6'),
Version::fromString('v1.0.0-beta7'),
Version::fromString('1.0.0'),
Version::fromString('v1.0.1'),
Version::fromString('v1.1.0'),
Version::fromString('v2.0.0'),
Version::fromString('v3.5-beta1'),
];
$validator = new ContinuesVersionsValidator(...$existingVersions); // Expects the versions as a variadic arguments
//$validator = new ContinuesVersionsValidator(); // No existing versions
VersionsValidator::isVersionContinues(Version::fromString('v1.1.1')); // true
VersionsValidator::isVersionContinues(Version::fromString('1.0.2')); // true
VersionsValidator::isVersionContinues(Version::fromString('1.1.1.')); // true
VersionsValidator::isVersionContinues(Version::fromString('2.0.1.')); // true
VersionsValidator::isVersionContinues(Version::fromString('3.5.0-beta2')); // true
VersionsValidator::isVersionContinues(Version::fromString('3.5.0')); // true
// A new minor or major version is not considered acceptable when there are already higher
// versions. Only patch releases are accepted then.
VersionsValidator::isVersionContinues(Version::fromString('0.2.0')); // false
VersionsValidator::isVersionContinues(Version::fromString('v1.0.0-beta8')); // false
VersionsValidator::isVersionContinues(Version::fromString('v1.2')); // false
VersionsValidator::isVersionContinues(Version::fromString('v2.1')); // false
VersionsValidator::isVersionContinues(Version::fromString('v3.5-alpha1')); // false
VersionsValidator::isVersionContinues(Version::fromString('v3.5-beta3')); // false
VersionsValidator::isVersionContinues(Version::fromString('v3.6')); // false
// A list of possible versions with respect to the major.minor bounds of any existing version
// For higher major.minor versions then validated only suggests a patch release, otherwise
// all possible increments till the next stable major are suggested.
$possibleVersions = $validator->getPossibleVersions();
```
Versioning
----------
For transparency and insight into the release cycle, and for striving
to maintain backward compatibility, this package is maintained under
the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the following format:
`..`
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bumps the patch
For more information on SemVer, please visit .
License
-------
The source of this package is subject to the MIT license that is bundled
with this source code in the file [LICENSE](LICENSE).
This library is maintained by [Sebastiaan Stok](https://github.com/sstok).