versionaire 7.1.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee0ca3727b5bf31067191d7aa4be767dee8d3b7e6c2703d211aa6cc9927c4021
-  data.tar.gz: ea9ce213190cfe550585441125de1bbb4f327fa99263b06bc20ab7736fe4fc66
+  metadata.gz: f5ad83ad73daa56d1e2e0b0d7048cb79e8ef234af33bb71fb09d9d6b50000d66
+  data.tar.gz: 64bef36a76f1590a9209356973150d288ced2811cf1e8a60ded4fd376c92782f
 SHA512:
-  metadata.gz: 4d151a766961b4a96d136ebaf66f6ca8b44dbaf50d5037f7d648f380d217e8bb8cf5d9c72def4fa6d234465aec5eb592ca3193b0d08ab9f7645daac4301c8662
-  data.tar.gz: 9a949b67e45eb87e856f2f256e63dfdb0ff274cd8696ea353d5b6f99f90b350c34e74407656764065533a493417b2303acb0300a762da51a209c8298cd06d064
+  metadata.gz: 1a6e8122fc30d451751d5f705ea2155a0476b5fa258b22a1620df9bf3fd80833dc298b515dbb4a0595eb8c15c611f69b7cedf411b8c8c4b0a8817c055c829cff
+  data.tar.gz: ed363f7d8b928fefdbd0127dd8397a4560b746f7404c92406fc6f906c5b8898575114fd4efa44c7ecd1c099ea1209b67d256bdc8e7f88ca832e98d23f1ea7857

data/README.md

@@ -153,16 +153,16 @@ Explicit conversion to a `String`, `Array`, or `Hash` is supported:
 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)
+    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)
 
 ### Math
 

data/lib/versionaire/conversion.rb

@@ -20,20 +20,20 @@ module Versionaire
 
   # Aids with converting objects into valid versions.
   class Converter
-    def initialize value
-      @value = value
+    def initialize object
+      @object = object
     end
 
     def from_string
       body = %(Use: "<major>.<minor>.<maintenance>" or "v<major>.<minor>.<maintenance>".)
-      fail(Errors::Conversion, error_message(value, body)) unless Version.regex.match? value
+      fail(Errors::Conversion, error_message(object, body)) unless Version.regex.match? object
 
       Version.new string_to_arguments
     end
 
     def from_array
       body = "Use: [], [<major>], [<major>, <minor>], or [<major>, <minor>, <maintenance>]."
-      fail(Errors::Conversion, error_message(value, body)) unless (0..3).cover?(value.size)
+      fail(Errors::Conversion, error_message(object, body)) unless (0..3).cover?(object.size)
 
       Version.new array_to_arguments
     end
@@ -42,29 +42,29 @@ module Versionaire
       body = "Use: {major: <major>}, " \
              "{major: <major>, minor: <minor>}, or " \
              "{major: <major>, minor: <minor>, maintenance: <maintenance>}."
-      fail(Errors::Conversion, error_message(value, body)) unless required_keys?
+      fail(Errors::Conversion, error_message(object, body)) unless required_keys?
 
-      Version.new value
+      Version.new object
     end
 
     def from_object
-      fail Errors::Conversion, error_message(value, "Use: String, Array, Hash, or Version.")
+      fail Errors::Conversion, error_message(object, "Use: String, Array, Hash, or Version.")
     end
 
     private
 
-    attr_reader :value
+    attr_reader :object
 
     def string_to_arguments
-      Version.arguments(*value.tr("v", "").split(".").map(&:to_i))
+      Version.arguments(*object.tr("v", "").split(".").map(&:to_i))
     end
 
     def array_to_arguments
-      Version.arguments(*value.dup.fill(0, value.size..2))
+      Version.arguments(*object.dup.fill(0, object.size..2))
     end
 
     def required_keys?
-      value.keys.all? { |key| VERSION_ATTRIBUTES.include? key }
+      object.keys.all? { |key| VERSION_ATTRIBUTES.include? key }
     end
 
     def error_message object, body

data/lib/versionaire/identity.rb

@@ -12,7 +12,7 @@ module Versionaire
     end
 
     def self.version
-      "7.1.0"
+      "7.2.0"
     end
 
     def self.version_label

data/lib/versionaire/version.rb

@@ -7,6 +7,8 @@ module Versionaire
   # An immutable, semantic version value object.
   # rubocop:disable Metrics/BlockLength
   Version = Struct.new :major, :minor, :maintenance, keyword_init: true do
+    include Comparable
+
     def self.regex
       /
         \A                    # Start of string.
@@ -39,12 +41,18 @@ module Versionaire
       klass.new klass.arguments(*reduce(other, :-))
     end
 
+    def == other
+      hash == other.hash
+    end
+
+    alias_method :eql?, :==
+
     def <=> other
       to_s <=> other.to_s
     end
 
     def to_s
-      [major, minor, maintenance].join VERSION_DELIMITER
+      to_a.join VERSION_DELIMITER
     end
 
     alias_method :to_str, :to_s

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -10,26 +10,25 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDQDCCAiigAwIBAgIBATANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
-  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0xODAyMTQxNTA4NDVaFw0xOTAyMTQx
-  NTA4NDVaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  MIIC/jCCAeagAwIBAgIBAjANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0xOTAyMTcxNjAxMTFaFw0yMDAyMTcx
+  NjAxMTFaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
   IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
   xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
   brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
   9z0A8KcGhz67SdcoQiD7qiCjL/2NTeWHOzkpPrdGlt088+VerEEGf5I13QCvaftP
   D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
   3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
-  AQABo3sweTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
-  2CdikiiE3fJhP/gY4ggwHwYDVR0RBBgwFoEUYnJvb2tlQGFsY2hlbWlzdHMuaW8w
-  HwYDVR0SBBgwFoEUYnJvb2tlQGFsY2hlbWlzdHMuaW8wDQYJKoZIhvcNAQELBQAD
-  ggEBAImQPNpkb90nkDUCJ4ivQNKK1LCebOjqZnOWGC4HxndvBQBqj78MTZifoODl
-  uPBY4fSnnpVGph+Y1OTWw/xhk3HE2AH0GDGC9xbM75qrg3/+a4D81pM94B6zuBdA
-  7hxUy4kByawrii833IidV0zkI4lCombTNicc8JWXXSlL2G/sWPLndNvn5rzoyyRT
-  pPOLYGdB4hqUam3hBgLOsYIOVp+yXMvj0gvk/Djq8IR2P1RS4NZU7HHD485xkBfL
-  4Zrsxi713z6sndd9JBAm4G7mJiV93MsuCM5N4ZDY7XaxIhvctNSNhX/Yn8LLdtGI
-  b4jw5t40FKyNUvLPPXYAvQALBtk=
+  AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBANgfX7kPZkJvsbdWMvbe
+  DUUYxRTqTUzCDpLd2p3sQvgLMKjTNSKt6CFq/kh+98b6RCgO6DqiVfxvOEq02dvf
+  ebMN/ylQqan2FgiAs1rpP0/D4C0MlBjoDktsT+2IyLol1KmkDB20ExJ4Sf1GRNdA
+  hpWOtcgqHtmrc7xzgB6BuyoYufrKKUlCO3ewTM4C375D2qO7hIdKuMOO3CdPMtSk
+  OrWpbzCL+nbbXqeoqiHgZaUvcyyQrGj5sQRxMTzuMXzzQxtHnuTuKrcz16HMTX/O
+  dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
+  y84=
   -----END CERTIFICATE-----
-date: 2019-02-02 00:00:00.000000000 Z
+date: 2019-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print