Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kherge/java.semver
A library to parse, compare, and constrain semantic version numbers.
https://github.com/kherge/java.semver
java semver
Last synced: 27 days ago
JSON representation
A library to parse, compare, and constrain semantic version numbers.
- Host: GitHub
- URL: https://github.com/kherge/java.semver
- Owner: kherge
- Created: 2018-10-19T18:33:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-27T01:34:54.000Z (about 6 years ago)
- Last Synced: 2024-10-27T15:33:41.403Z (3 months ago)
- Topics: java, semver
- Language: Java
- Size: 188 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
[](https://travis-ci.org/kherge/java.semver)
[](https://sonarcloud.io/dashboard?id=kherge_java.semver)
Semantic Versioning
===================
**semver** is a library to parse, compare, and constrain semantic version numbers.
This library revolves around an immutable value object called `Version`. The class is capable of parsing valid string
representations of semantic version numbers, managing version number information (changes create new instances), and
performing basic comparisons. The library also includes a basic set of constraints that can be assembled to create
complex version constraints.
> The library does not include the ability to parse string representations of version constraints (e.g. `>=1.0.0`)
> into instances of the bundled version constraints (e.g. `new GreaterThanOrEqualTo(new Version(1, 0, 0))`). There
> is no one-size-fits-all solution since each package manager has its own grammar for version constraints.
```java
Version version = new Version ("1.2.3");
if (and(gte("1.0.0"), lt("2.0.0")).apply(version)) {
// ...
}
```
Requirements
------------
- Java 8
Installation
------------
### Gradle
```groovy
compile 'io.herrera.kevin:semver:?'
```
### Maven
```xml
io.herrera.kevin
semver
?
```
Usage
-----
```java
import static io.herrera.kevin.semver.constraints.Constraints.*;
import io.herrera.kevin.semver.constraints.Constraint;
import io.herrera.kevin.semver.Version;
class Example {
public static void main() {
// Create a version number using a string representation.
Version version = new Version("1.0.0-alpha.1+20181020.123");
// Create a version number using only number.
Version version = new Version(1, 2, 3);
// Create a version number using numbers and pre-release metadata.
Version version = new Version(1, 2, 3, new String[] {"alpha", "1"});
// Create a version number using numbers, pre-release, and build metadata.
Version version = new Version(
1,
2,
3,
new String[] {"alpha", "1"},
new String[] {"20181020", "123"}
);
// Create a version number using the default version number (0.0.0).
Version version = Version.DEFAULT;
// Create a version number using a builder interface.
Version version = Version
.DEFAULT
.setMajor(1)
.setMinor(2)
.setPatch(3)
.setPreRelease("alpha", "1")
.setBuild("20181020", "123");
// Get version information.
int major = version.getMajor();
int minor = version.getMinor();
int patch = version.getPatch();
String[] preRelease = version.getPreRelease();
String[] build = version.getBuild();
// Set version information.
Version changed = version
.clearPreRelease()
.clearBuild()
.setMajor(4)
.setMinor(5)
.setPatch(6)
.setPreRelease("beta", "2")
.setBuild("20181020", "456");
// Increment version information.
Version changed = version
.incrementMajor()
.incrementMinor()
.incrementPatch();
Version changed = version
.incrementMajor(123)
.incrementMinor(456)
.incrementPatch(789);
// Create a string representation.
String string = version.toString();
// Perform basic comparisons.
Version another = new Version("2.0.0");
if (version.isEqualTo(another)) {
// Can also use: version.equals(another)
}
if (version.isGreaterThan(another)) {
// ...
}
if (version.isLessThan(another)) {
// ...
}
// Perform stability checks.
if (version.isPreRelease()) {
// ...
}
if (version.isStable()) {
// ...
}
// Can create and apply complex version constraints.
// Match any of the following conditions.
Constraint constraint = or(
// Match all of these conditions.
and(
// The version must be greater than or equal to this one.
gte("1.0.0"),
// The version must be less than this one.
lt("2.0.0"),
// The version must not equal to this one.
ne("1.2.3")
),
// Match all of these conditions.
and(
// The version must be greater than this one.
gt("2.0.0"),
// The version must be less than or equal to this one.
lte("2.1.0")
),
// The version must be equal to this one.
eq("9.9.9"),
// Match all of these conditions.
and(
// The version must be greater than or equal to this one.
gte("10.0.0"),
// The version must be less than this one.
lt("11.0.0"),
// The version must be stable.
stable()
),
// Match all of these conditions.
and(
// The version must be greater than or equal to this one.
gte("11.0.0"),
// The version must be less than this one.
lt("12.0.0"),
// The version must be pre-release.
pre()
)
);
if (constraint.apply(version)) {
// ...
}
}
}
```
License
-------
This library is made available under the MIT and Apache 2.0 licenses.