Ruby doesn’t provide a primitive version type by default so Versionaire fills this gap by providing immutable and thread-safe Strict Semantic Versioning so you can leverage versions within your applications. This new Version type behaves and feels a lot like other primitives (i.e. String, Array, Hash, Proc, etc) and can be cast/converted from other primitives.
-
Provides Strict Semantic Versioning which means
<major>.<minor>.<patch>. -
Provides immutable, thread-safe version instances.
-
Converts (casts) from a
String,Array,Hash,Proc, orVersionto aVersion. -
Disallows
<major>.<minor>.<patch>-<pre-release>usage even though Semantic Versioning suggests you may use pre-release information. -
Disallows
<major>.<minor>.<patch>+<build_metadata>usage even though Semantic Versioning suggests you may use build metadata.
-
Ruby.
To install with security, run:
# 💡 Skip this line if you already have the public certificate installed.
gem cert --add <(curl --compressed --location https://alchemists.io/gems.pem)
gem install versionaire --trust-policy HighSecurityTo install without security, run:
gem install versionaireYou can also add the gem directly to your project:
bundle add versionaireOnce the gem is installed, you only need to require it:
require "versionaire"A new version can be initialized in a variety of ways:
Versionaire::Version.new # "0.0.0"
Versionaire::Version[major: 1] # "1.0.0"
Versionaire::Version[major: 1, minor: 2] # "1.2.0"
Versionaire::Version[major: 1, minor: 2, patch: 3] # "1.2.3"Equality is determined by the state of the object. This means that a version is equal to another version as long as all of the values (i.e. state) are equal to each other. Example:
version_a = Versionaire::Version[major: 1]
version_b = Versionaire::Version[major: 2]
version_c = Versionaire::Version[major: 1]
version_a == version_a # true
version_a == version_b # false
version_a == version_c # trueKnowing this, versions can be compared against one another too:
version_a > version_b # false
version_a < version_b # true
version_a.between? version_c, version_b # trueWorks like any other standard Ruby object where an object is equal only to itself.
version_a = Versionaire::Version[major: 1]
version_b = Versionaire::Version[major: 2]
version_c = Versionaire::Version[major: 1]
version_a.equal? version_a # true
version_a.equal? version_b # false
version_a.equal? version_c # falseUse the Versionaire::Version function to explicitly cast to a version:
version = Versionaire::Version[major: 1]
Versionaire::Version "1.0.0"
Versionaire::Version [1, 0, 0]
Versionaire::Version major: 1, minor: 0, patch: 0
Versionaire::Version versionEach of these conversions will result in a version object that represents “1.0.0”.
When attempting to convert an unsupported type, a Versionaire::Error exception will be thrown.
Building upon the above examples, a more elegant solution is to use a refinement:
using Versionaire::Cast
version = Versionaire::Version[major: 1]
Version "1.0.0"
Version [1, 0, 0]
Version major: 1, minor: 0, patch: 0
Version versionBy adding using Versionaire::Cast to your implementation, this allows Versionaire to refine
Kernel so you have a top-level Version conversion function much like Kernel’s native support for
Integer, String, Array, Hash, etc. The benefit to this approach is to reduce the amount of
typing so you don’t pollute your entire object space, like a monkey patch, while providing an idiomatic approach to casting like any other primitive.
Implicit conversion to a String is supported:
"1.0.0".match Versionaire::Version[major: 1] # <MatchData "1.0.0">Explicit conversion to a String, Array, Hash, or Proc is supported:
version = Versionaire::Version.new
version.to_s # "0.0.0"
version.to_a # [0, 0, 0]
version.to_h # {major: 0, minor: 0, patch: 0}
version.to_proc # #<Proc:0x000000010b015b88 (lambda)>To elaborate on procs, this means the following is possible where you might want to collect all minor verions values or make use of version information in other useful ways:
using Versionaire::Cast
version = Version "1.2.3"
version.to_proc.call :major # 1
[version, version, version].map(&:minor) # [2, 2, 2]You can inspect a version which is the equivalent of an escaped string representation. Example:
using Versionaire::Cast
Version("1.2.3").inspect # "\"1.2.3\""All versions are comparable which means any of the operators from the Comparable module will
work. Example:
version_1 = Versionaire::Version "1.0.0"
version_2 = Versionaire::Version "2.0.0"
version_1 < version_2 # true
version_1 <= version_2 # true
version_1 == version_2 # false (see Equality section above for details)
version_1 > version_2 # false
version_1 >= version_2 # false
version_1.between? version_1, version_2 # true
version_1.clamp version_1, version_2 # version_1 (added in Ruby 2.4.0)Versions can be bumped to next logical version with respect current version. Example:
version = Versionaire::Version.new # "0.0.0"
version.bump :patch # "0.0.1"
version.bump :minor # "0.1.0"
version.bump :major # "1.0.0"
Versionaire::Version[major: 1, minor: 2, patch: 3].bump :major # "2.0.0"
Versionaire::Version[major: 1, minor: 2, patch: 3].bump :minor # "1.3.0"
Versionaire::Version[major: 1, minor: 2, patch: 3].bump :patch # "1.2.4"You’ll notice, when bumping the major or minor versions, lower precision gets zeroed out in order to provide the next logical version.
Versions can be added, subtracted, sequentially increased, or sequentially decreased from each other.
Versions can be added together to produce a resulting version sum.
version_1 = Versionaire::Version[major: 1, minor: 2, patch: 3]
version_2 = Versionaire::Version[major: 2, minor: 5, patch: 7]
version_1 + version_2 # "3.7.10"Versions can be substracted from each other as long as there isn’t a negative result.
version_1 = Versionaire::Version[major: 1, minor: 2, patch: 3]
version_2 = Versionaire::Version[major: 1, minor: 1, patch: 1]
version_1 - version_2 # "0.1.2"
version_1 = Versionaire::Version[major: 1]
version_2 = Versionaire::Version[major: 5]
version_1 - version_2 # Versionaire::ErrorVersions can be sequentially increased or given a specific version to jump to.
version = Versionaire::Version[major: 1, minor: 1, patch: 1]
version.up :major # => "2.1.1"
version.up :major, 3 # => "4.1.1"
version.up :minor # => "1.2.1"
version.up :minor, 3 # => "1.4.1"
version.up :patch # => "1.1.2"
version.up :patch, 3 # => "1.1.4"Versions can be sequentially decreased or given a specific version to jump to as long as the result is not negative.
version = Versionaire::Version[major: 5, minor: 5, patch: 5]
version.down :major # => "4.5.5"
version.down :major, 3 # => "2.5.5"
version.down :minor # => "5.4.5"
version.down :minor, 3 # => "5.2.5"
version.down :patch # => "5.5.4"
version.down :patch, 3 # => "5.5.2"
version.down :major, 6 # => Versionaire::ErrorThis project supports libraries which might desire native Version types. Each extension must be
explicitly required in order to be used since they are optional by default. See below for
details.
OptionParser is one of Ruby’s default gems which can accept additional types not native to Ruby by default. To extend OptionParser with the Version type, all you need to do is add these two lines to your implementation:
-
require "versionaire/extensions/option_parser": This will load dependencies and register theVersiontype withOptionParser. -
act.on "--tag VERSION", Versionaire::Version: SpecifyingVersionaire::Versionas the second argument will ensureOptionParserproperly casts command line input as aVersiontype.
Here’s an example implementation that demonstrates full usage:
require "versionaire/extensions/option_parser"
options = {}
parser = OptionParser.new do |act|
act.on "--tag VERSION", Versionaire::Version, "Casts to version." do |value|
options[:version] = value
end
end
parser.parse %w[--tag 1.2.3]
puts optionsThe above will ensure --tag 1.2.3 is parsed as {version: "1.2.3"} within your options variable. Should OptionParser parse an invalid version, you’ll get a OptionParser::InvalidArgument instead.
To contribute, run:
git clone https://github.com/bkuhlmann/versionaire
cd versionaire
bin/setupYou can also use the IRB console for direct access to all objects:
bin/console-
Built with Gemsmith.
-
Engineered by Brooke Kuhlmann.