versionaire 9.1.1 → 9.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e35f5d3112af653667a69f1421b1c2ffeb9f0ee37081679e42e40b02613fce
-  data.tar.gz: 604702a9d233a94faee6d8ecc20f19b7d17e8f1dda2972a6b72b46cda4f44acb
+  metadata.gz: 3ed24547416f7f6a15d9c09e3125f8f425b60ea6a5b23727a2c7e1fbf298bfba
+  data.tar.gz: 416424449d95c8735779f302b5713d15ac62151f8b77ea16368ababcb97b7177
 SHA512:
-  metadata.gz: 64a6327a293b8dd9989f000b1173541e83bb8855886c4da4213f2b7f70973c8d012ec58080c1ae6b675e4aa6033c5eacd6d2e23968a3ad9c66d58a32472aded0
-  data.tar.gz: 4ef00d34ac1dacff42fa208970bf53b36ba27b0d849a4dcb11d57c98ea756fd7499f3c51c9a0c41316b3451d73b18aa7adc8a0393823a20f96674644f3dc7164
+  metadata.gz: d646ed7306202f5329a3c0bc832c3d584167936710d4c36c06c251eb23bfed3a98a67ab8a387f6ef1c3faa5006e7f40432aa40ecf53580364550dce4e6a5ee15
+  data.tar.gz: 29e34071763bf50bd4e11b851c63727ba549438ed05efb6ef5ef7fb2904ea7815712b83fa5c682af176c1e7cf0b41cf556f10128c5daa3f1c529b8ddabb41d34

checksums.yaml.gz.sig

@@ -1 +1 @@
-`�+����RA
-���pH�pe���ueŴ��T���%ļ�6-ʳ�[�k>��n#p��r�m��y/ۺ�h��ǽ�7���b���m�l�lc1�AF�;	�a=�w��CD�B��ꧺk8�_3lrҐB�a\�VV���H_]k��x]���V����p\>0���ד�l�-z�6����=����e!��3�*G
+ET�h�`���₮7��G��).���:�D(���]Z܇��6v���(��p�A�ۑ �k�{�-z�4l�w����k=|tX3,�����-��B�_j~�6F)�����V�#�ඈ�h���.�ls���p�k�s��C�:yȃ�n�ξ�?��Bjhq�꡺�Sk�79�
�Z�*.�0�M/"

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/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/identity.rb

@@ -5,7 +5,7 @@ module Versionaire
   module Identity
     NAME = "versionaire"
     LABEL = "Versionaire"
-    VERSION = "9.1.1"
-    VERSION_LABEL = "#{LABEL} #{VERSION}"
+    VERSION = "9.3.0"
+    VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 9.1.1
+  version: 9.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2021-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.4'
 description:
 email:
 - brooke@alchemists.io
@@ -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.16
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: Provides an immutable, thread-safe, and semantic version type.