versionaire 9.1.0 → 9.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dd4a85312295a2cc1e5aa13d6252156a095da2718fe8bff2afaa6d4a5ca0689
-  data.tar.gz: 6eadfe1ca935a2e35681a189562ee9fd5a6e49c9c757774ec977ee2e21820399
+  metadata.gz: 6fc322d69d30450c7c68857bfe9976a59af4489a5651ddb30972ed4918a6b369
+  data.tar.gz: d222908d2a74363b6fbd4d5aac6202b6c51553eff1a175f08d66b03821b44c40
 SHA512:
-  metadata.gz: 21b92646e48340c1fdde455bf0d45aed944e3d63440e304c86ed7d3b66877cfd1d66e9c7e49468a7e340d96015ecc8e995f64878755764f8bda5e98df4df6daa
-  data.tar.gz: 7a5d2418831d0c11f0802bc5f3a554b610a39a21736fef4b08b1130963b594c074c4127871288eb05446b053ccebe4e6fbfbf68cd5cf74c8d16a564349d161b8
+  metadata.gz: 5492ddd489f1f689fec8f6a263e99c28a22b4c824f604735e58910f15ffab439f49b09cb5a47d534ce3d141d14f50b95d196d0c3656633f1b76989a22221c607
+  data.tar.gz: ae282cecbd1dc785aa0b6be8f1e8b3807a2dedfbc13d4bca10fea484c9ce3a4cbea3dc97fcc6b6b6c8daa5a5c58938226dc593adf7a341baae59f2697902d803

data/README.adoc

@@ -11,8 +11,10 @@ image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchem
 [link=https://circleci.com/gh/bkuhlmann/versionaire]
 image::https://circleci.com/gh/bkuhlmann/versionaire.svg?style=svg[Circle CI Status]
 
-Provides an immutable, thread-safe, and semantic version type when managing versions within your
-applications.
+Ruby doesn't provide a primitive version type by default. Versionaire fills this gap by providing an
+immutable, thread-safe, and link:https://semver.org[Semantic Version] in order to use versions
+within your applications. This new version type behaves and feels a lot like other primitives (i.e.
+`String`, `Array`, `Hash`, etc) and can even be cast/converted from other primitives.
 
 toc::[]
 
@@ -150,7 +152,7 @@ Version version
 By 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 it reduces the amount of
-typing, doesn't polute your entire object space like a monkey patch would, and provides a idiomatic
+typing, doesn't pollute your entire object space like a monkey patch would, and provides a idiomatic
 approach to casting like any other primitive.
 
 ==== Implicit
@@ -257,6 +259,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.1.0"
-    VERSION_LABEL = "#{LABEL} #{VERSION}"
+    VERSION = "9.2.2"
+    VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
   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.1.0
+  version: 9.2.2
 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: 2021-01-20 00:00:00.000000000 Z
+date: 2021-09-06 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.5
+rubygems_version: 3.2.27
 signing_key:
 specification_version: 4
 summary: Provides an immutable, thread-safe, and semantic version type.