versionaire 9.0.0 → 9.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5bf3f6ca78ae9c031159e94ca9c756fa50b13cdec20d434695ae8a26126d7b0
-  data.tar.gz: b6d5c1ca4d9528e70885e9e5842d3bf32a884d3c18934c7e9d3300023fc7f583
+  metadata.gz: ee362c5cbe42be9177b1ec4f7f82576bf39b465d030291526051d7cba3f89766
+  data.tar.gz: 1c8cef6f4967e1abc9b88c5009c017cba13e51037bdb6354d2215a9d6171c746
 SHA512:
-  metadata.gz: 8c1334716bba3802c6adb35c8be2f0066f6020314f92736d6fa935600aadf19d47c7313d6087e3bc6d7171e0dfab3472c4509fba6ff24684a4b731140ff60569
-  data.tar.gz: 65ae92c897c984976c44c2efa6e101af3d7fda55e6ecc3ee7990b56f1d7d6d3f324ed667dde497b3715b9f0fa6764bfb74268b1d98d6d4d887b1330478196ef6
+  metadata.gz: 3bed3af0bd372891d25432aae32d886a56377dc82e564f55bd4dce33bb27df5cad8d226101406a235bb818329d5b0fcb4d104efebe268750b4b6771da0172073
+  data.tar.gz: 58b4fc773ce456a43854544617f33fe22f2c3a495d69426647130ffd6dd14303f3422e9eaa7e0f3b4c7851b3ab21111619e198c9a0a37f6c3c3ff22fdda9b712

data/README.adoc

@@ -257,6 +257,46 @@ version.down :patch, 3  # => "5.5.2"
 version.down :major, 6  # => Versionaire::Errors::NegativeNumber
 ----
 
+=== Extensions
+
+This 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
+
+link:https://github.com/ruby/optparse[OptionParser] is one of Ruby's
+link:https://stdgems.org[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 the
+  `Version` type with `OptionParser`.
+. `instance.on "--tag VERSION", Versionaire::Version` - Specifying `Versionaire::Version` as the
+  second argument will ensure `OptionParser` properly casts command line input as a `Version` type.
+
+Here's an example implementation that demonstrates full usage:
+
+[source,ruby]
+----
+require "versionaire/extensions/option_parser"
+
+options = {}
+
+parser = OptionParser.new do |instance|
+  instance.on "--tag VERSION", Versionaire::Version, "Casts to version." do |value|
+    options[:version] = value
+  end
+end
+
+parser.parse! %w[--tag 1.2.3]
+puts options
+----
+
+The above will ensure `--tag 1.2.3` is parsed as `{:version=>#<struct Versionaire::Version major=1,
+minor=2, patch=3>}` within your `options` variable. Should `OptionParser` parse an invalid version,
+you'll get a `OptionParser::InvalidArgument` instead.
+
 == Development
 
 To contribute, run:

data/lib/versionaire/cast.rb

@@ -4,9 +4,7 @@ module Versionaire
   # Refines Kernel in order to provide a top-level Version conversion function.
   module Cast
     refine Kernel do
-      def Version object
-        Versionaire::Version object
-      end
+      def Version(object) = Versionaire::Version(object)
     end
   end
 end

data/lib/versionaire/errors/invalid_number.rb

@@ -4,9 +4,7 @@ module Versionaire
   module Errors
     # Thrown when not using numbers.
     class InvalidNumber < Base
-      def initialize message = "Major, minor, and patch must be a number."
-        super message
-      end
+      def initialize(message = "Major, minor, and patch must be a number.") = super(message)
     end
   end
 end

data/lib/versionaire/extensions/option_parser.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "versionaire"
+
+OptionParser.accept Versionaire::Version do |value|
+  Versionaire::Version value
+rescue Versionaire::Errors::Base
+  raise OptionParser::InvalidArgument, value
+end

data/lib/versionaire/function.rb

@@ -67,13 +67,9 @@ module Versionaire
             .then { |arguments| Version.with_positions(*arguments) }
     end
 
-    def required_keys?
-      object.keys.all? { |key| Version.members.include? key }
-    end
+    def required_keys? = object.keys.all? { |key| Version.members.include? key }
 
-    def error_message object, body
-      "Invalid version conversion: #{object}. #{body}"
-    end
+    def error_message(object, body) = "Invalid version conversion: #{object}. #{body}"
   end
 
   private_constant :Converter

data/lib/versionaire/identity.rb

@@ -5,7 +5,7 @@ module Versionaire
   module Identity
     NAME = "versionaire"
     LABEL = "Versionaire"
-    VERSION = "9.0.0"
+    VERSION = "9.2.1"
     VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

data/lib/versionaire/version.rb

@@ -9,9 +9,7 @@ module Versionaire
 
     using Refinements::Structs
 
-    def self.delimiter
-      "."
-    end
+    def self.delimiter = "."
 
     def self.pattern
       /
@@ -54,17 +52,11 @@ module Versionaire
       to_s <=> other.to_s
     end
 
-    def down key, value = 1
-      revalue(key => value) { |previous, current| previous - current }
-    end
+    def down(key, value = 1) = revalue(key => value) { |previous, current| previous - current }
 
-    def up key, value = 1
-      revalue(key => value) { |previous, current| previous + current }
-    end
+    def up(key, value = 1) = revalue(key => value) { |previous, current| previous + current }
 
-    def to_s
-      to_a.join self.class.delimiter
-    end
+    def to_s = to_a.join(self.class.delimiter)
 
     alias_method :to_str, :to_s
     alias_method :values, :to_a

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.2.1
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIC/jCCAeagAwIBAgIBAzANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
-  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMDAzMTUxNDQ1MzJaFw0yMTAzMTUx
-  NDQ1MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  MIIC/jCCAeagAwIBAgIBBDANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMTAzMTkxMjQ4MDZaFw0yMjAzMTkx
+  MjQ4MDZaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
   IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
   xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
   brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
@@ -20,15 +20,15 @@ cert_chain:
   D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
   3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
   AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
-  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAIHhAlD3po4sTYqacXaQ
-  XI9jIhrfMy//2PgbHWcETtlJPBeNUbbSNBABcllUHKqYsVDlSvSmss034KSWNR8F
-  bF1GcloicyvcCC4y6IoW4it0COAcdeaaxkxiBSgKdQFpff9REnDlIKK4uQ9lLxIo
-  Y2G5xubiziKZkyfWFuSr67PIjW3Bu673D1JVBArhA1qbgQmYQcy1CkGOjo+iO8Nf
-  7u/QSfBHb+r/bXhKscDgPpnKwbUmvgO2+94zJG9KsrmIydlzYfsD09aXKx0t6Xy4
-  2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
-  QWc=
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAEjpaOXHHp8s/7GL2qCb
+  YAs7urOLv9VHSPfQWAwaTMVnSsIf3Sw4xzISOP/mmfEPBPXtz61K5esrE/uTFtgb
+  FyjxQk2H0sEWgrRXGGNHBWQRhhEs7LP/TByoC15A0br++xLxRz4r7HBLGAWQQDpg
+  66BJ2TBVjxS6K64tKbq7+ACyrOZGgTfNHACh4M076y0x0oRf/rwBrU39/KRfuhbb
+  cm+nNCEtO35gTmZ2bVDHLGvWazi3gJt6+huQjfXTCUUG2YYBxwhu+GPdAGQPxpf9
+  lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
+  W2A=
   -----END CERTIFICATE-----
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -61,6 +61,7 @@ files:
 - lib/versionaire/errors/cast.rb
 - lib/versionaire/errors/invalid_number.rb
 - lib/versionaire/errors/negative_number.rb
+- lib/versionaire/extensions/option_parser.rb
 - lib/versionaire/function.rb
 - lib/versionaire/identity.rb
 - lib/versionaire/version.rb
@@ -87,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.25
 signing_key:
 specification_version: 4
 summary: Provides an immutable, thread-safe, and semantic version type.