versionaire 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02b1d7c076c95ea2d8b508afc74e25a9b5a4389094109578be0df8162939d959
-  data.tar.gz: 7c9d736b55ce7b28a5598b4e4e8e155ea6656becc480a1e7c221ec24bbc79640
+  metadata.gz: 9fa6e823016230a46cf781e162c9223d7be3b20fafe1acab1dbca5c288b0d832
+  data.tar.gz: 63ddf1e3e48c053e1448b58323ed7ebb4d770d6a1e21263020da341345c0da4a
 SHA512:
-  metadata.gz: 99071439cfbbb502971c0cc8f9e8c881f087783ba8d9ae9c87769c0c4114e906ba188c102c62911d928a513a03c14327ab631e2053890f2866dc551ded2cea8d
-  data.tar.gz: 138f40ea59c5c126020b75b873806782550473c26ec1e59b97a85cefaa5a4717b70b715c72fb51557ed039ea530ee0f1759616ac902b946e08f6013fe3e736a2
+  metadata.gz: c3de2b8b340c64d43f628ccf7f9645237dbe6f9f12cc744eebda52ea7dbbc1edc1e385b9fc7073f56edf033ff104d001135d34d8b4b676bd8dfaad2f4bc4daa7
+  data.tar.gz: 10696b37a24d7949aa456dadb48964d4d6045fdf69b420426d32c19722f26af1a07d6fd001ea2d95b06ece185ed9d9820919b59d0346aa609d15607a1009b2bc

data/README.md

@@ -26,6 +26,7 @@ Provides immutable, thread-safe, semantic versioning.
       - [Function (Casting)](#function-casting)
       - [Implicit](#implicit)
       - [Explicit](#explicit)
+    - [Comparisons](#comparisons)
     - [Math](#math)
       - [Addition](#addition)
       - [Subtraction](#subtraction)
@@ -147,6 +148,22 @@ Explicit conversion to a `String`, `Array`, or `Hash` is supported:
     version.to_a # [0, 0, 0]
     version.to_h # {major: 0, minor: 0, maintenance: 0}
 
+### Comparisons
+
+All versions are comparable which means any of the operators from the `Comparable` module will work.
+Example:
+
+    v1 = Versionaire::Version "1.0.0"
+    v2 = Versionaire::Version "2.0.0"
+
+    v1 < v2 # true
+    v1 <= v2 # true
+    v1 == v2 # false (see Equality section above for details)
+    v1 > v2 # false
+    v1 >= v2 # false
+    v1.between? v1, v2 # true
+    v1.clamp v1, v2 # v1 (added in Ruby 2.4.0)
+
 ### Math
 
 Versions can be added and subtracted from each other.

data/lib/versionaire/conversion.rb

@@ -3,7 +3,7 @@
 # The gem namespace.
 module Versionaire
   # Conversion function (strict) for casting an object into a version.
-  # rubocop:disable Naming/MethodName
+  # :reek:TooManyStatements
   def Version object
     converter = Converter.new object
 
@@ -15,7 +15,6 @@ module Versionaire
       else converter.from_object
     end
   end
-  # rubocop:enable Naming/MethodName
 
   module_function :Version
 

data/lib/versionaire/errors/base.rb

@@ -2,7 +2,7 @@
 
 module Versionaire
   module Errors
-    # The base error class for all gem-related errors.
+    # The base error class for all gem related errors.
     class Base < StandardError
     end
   end

data/lib/versionaire/errors/conversion.rb

@@ -2,7 +2,7 @@
 
 module Versionaire
   module Errors
-    # Thrown when attempting to convert (cast) a primitive to a version.
+    # Thrown when attempting to convert (cast) an invalid primitive to a version.
     class Conversion < Base
     end
   end

data/lib/versionaire/identity.rb

@@ -12,7 +12,7 @@ module Versionaire
     end
 
     def self.version
-      "5.0.0"
+      "5.1.0"
     end
 
     def self.version_label

data/lib/versionaire/version.rb

@@ -39,13 +39,16 @@ module Versionaire
     end
 
     def + other
-      self.class.new self.class.arguments(*reduce(other, :+))
+      klass = self.class
+      klass.new klass.arguments(*reduce(other, :+))
     end
 
     def - other
-      self.class.new self.class.arguments(*reduce(other, :-))
+      klass = self.class
+      klass.new klass.arguments(*reduce(other, :-))
     end
 
+    # :reek:FeatureEnvy
     def == other
       other.is_a?(Version) && to_s == other.to_s
     end
@@ -59,12 +62,8 @@ module Versionaire
       [major, minor, maintenance, self.class].hash
     end
 
-    def label
-      "v#{self}"
-    end
-
     def to_s
-      "#{major}#{self.class.delimiter}#{minor}#{self.class.delimiter}#{maintenance}"
+      [major, minor, maintenance].join self.class.delimiter
     end
     alias to_str to_s
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -29,7 +29,7 @@ cert_chain:
   4Zrsxi713z6sndd9JBAm4G7mJiV93MsuCM5N4ZDY7XaxIhvctNSNhX/Yn8LLdtGI
   b4jw5t40FKyNUvLPPXYAvQALBtk=
   -----END CERTIFICATE-----
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -87,20 +87,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: git-cop
   requirement: !ruby/object:Gem::Requirement
@@ -219,14 +205,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.54'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: '0.54'
 - !ruby/object:Gem::Dependency
   name: wirb
   requirement: !ruby/object:Gem::Requirement