kherge / java.semver Goto Github PK

Problem

The getBuild() and getPreRelease() methods will return empty arrays if metadata is not present. While not terrible, checks can lead to the following type of code:

String[] metadata = version.getPreRelease();

if (metadata.length > 0) {
    // ...
}

Resolution

It would be a minor convenience if an Optional was returned.

version.getPreRelease().ifPresent(doSomething);

While VersionException may be applicable to other library classes in the future, the InvalidVersionException is a tad bit misleading and is strictly used by the parser inside of the Version class. To clear things up, InvalidVersionException should be made an inner class to Version and renamed to InvalidStringException.

Since the version number is a value object, it does not make much sense to use a list of strings over an immutable array of strings.

Problem

The regular expression was found in issue #232 on the semver repository.

Resolution

Give credit to @DavidFichtmueller.

References

1. semver/semver#232

Templates need to be added for opening issues and creating pull requests.

When parsing the numbers (i.e. major, minor, patch), the NumberFormatException should be caught and used as a cause for a new InvalidVersionException.

When creating a new instance, the constructor should not permit numbers (i.e. major, minor, patch) less than 0 (zero).

Problem

The source code has not been checked for conformance to the Google Java style guide.

Resolution

Modify build.gradle to check for style conformance.

References

1. https://docs.gradle.org/current/userguide/checkstyle_plugin.html
2. https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml

This semver class from another library has the right idea on how to handle comparing integer vs integer and alpha vs alpha metadata. This should replace the way it is handled in my implementation.

A isPreRelease() method should be added to check if a version number is a pre-release version number.

return (major == 0) ||  !preRelease.isEmpty();

Tag a 1.0.0 release and publish to Maven Central.

Problem

When the pre and stable constraints were added, the documentation for version constraints was not updated to include their use.

Resolution

Add new and constraints to the example using pre and stable.

The Version class should define a constant, SPEC that is an instance of Version that matches the version of the specification the Version class supports.

public static final SPEC = new Version(2, 0, 0);

The metadata values must be validated to ensure that the conform to spec.

• When the major version number is incremented.
  • The minor and patch version number should be set to 0 (zero).
  • The pre-release and build metadata should be cleared.
• When the minor version number is incremented.
  • The patch version number should be set to 0 (zero).
  • The pre-release and build metadata should be cleared.
• When the patch version number is incremented.
  • The pre-release and build metadata should be cleared.

Problem

There is no bundled constraints for enforcing stability.

Resolution

Create two new constraints.

• PreRelease - Requires that a version be a pre-release version.
• Stable - Requires that the version be a stable version.