versionaire 8.4.0 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1776d9481fa83da0c743faa221bda1a9c65634994ef1033e31eaaa4e0cb19633
-  data.tar.gz: 2167d8631a24e61763400cecb8bf33842f66753a0098a5c3e1610331288d295a
+  metadata.gz: 0f0a4896401e4a8c4df94fe4ec19fabe7bbf6dc17b776fa7cd0eabb49de39f84
+  data.tar.gz: 4ad3d1ab406e3fa81c68bb2d0a09d0d59c2bb03cde9c0dba6039a38ec16cfae5
 SHA512:
-  metadata.gz: 0cacf3c8a5927747a88ca9dd679a1dd685a1aec06ead8d2d0bc349b2534434eda31d6c7d3cb1a42c44a9cca581a1e07c3c9530575d8edffda18094e8699725ae
-  data.tar.gz: 398494d23393c467d3f18361fc87574d86e2b299fce75b007326b5de45b8a0c3218ff7edb6268ff6b8796da27e84429ac47d602f2743e5bc30c465dc2d4b4705
+  metadata.gz: d6a72bbec222e02ce976ec42523e4300611b0c22a59f551cdc9c6ab21af9bf9d591f03a7dce52e3b738862f6f8de98ca2a333543f0ccc49f9489ed887e094d43
+  data.tar.gz: acdb7b4f11ac472ff3c555415b9a58732b16dfc43fbfb96cb99ba1ab414fb900ac12fb47f1db6c9a3c8d5ded5a4555b150ab2db11b228939a881d46f1e85e511

checksums.yaml.gz.sig

@@ -1,3 +1 @@
-P0��n4{Zωh����+�F~�����y�� Fu�Nekb��Gh%h�V^�U�����.������x7�7	�憡�[q�9>\��j��&sy�Rf�z����-0�pܒX�&A�Mx�F�?����tXX���X��ޔ]�vq�Px�~Aɨ%�{��ẓ�H�?���-P�3�:���i�d��h���_�"�L�v)wśEaM�㼩�
-K:�$�LyԄ�h�]h���W��[Y
-dq�
+K�P�Ap_��J~_�X#�l��&�s�P�>'V
ɃT��A,�51���G���'�%�K~����}�/ �'5:�\#�`S,��S<Ԣ���VӋ.,��з) (�M�0%���>�浝�%�p6^�W=[I���<޾��;e���P��Y���5t=2<*��
��3ZK�ג��/{�E��B�ڦ5r�����a�i�QͩB�5�x�w��sb�hEF��&��a�K���Uc�i�|�~��ԇs>����{��	(

data/README.adoc

@@ -55,10 +55,10 @@ A new version can be initialized in a variety of ways:
 
 [source,ruby]
 ----
-Versionaire::Version.new                                    # "0.0.0"
-Versionaire::Version[major: 1]                              # "1.0.0"
-Versionaire::Version[major: 1, minor: 2]                    # "1.2.0"
-Versionaire::Version[major: 1, minor: 2, patch: 3]          # "1.2.3"
+Versionaire::Version.new                            # "0.0.0"
+Versionaire::Version[major: 1]                      # "1.0.0"
+Versionaire::Version[major: 1, minor: 2]            # "1.2.0"
+Versionaire::Version[major: 1, minor: 2, patch: 3]  # "1.2.3"
 ----
 
 === Equality
@@ -74,18 +74,18 @@ version_a = Versionaire::Version[major: 1]
 version_b = Versionaire::Version[major: 2]
 version_c = Versionaire::Version[major: 1]
 
-version_a == version_a # true
-version_a == version_b # false
-version_a == version_c # true
+version_a == version_a  # true
+version_a == version_b  # false
+version_a == version_c  # true
 ----
 
 Knowning this, versions can be compared against one another too:
 
 [source,ruby]
 ----
-version_a > version_b                   # false
-version_a < version_b                   # true
-version_a.between? version_c, version_b # true
+version_a > version_b                    # false
+version_a < version_b                    # true
+version_a.between? version_c, version_b  # true
 ----
 
 ==== Hash (`#eql?`)
@@ -106,16 +106,16 @@ version_a = Versionaire::Version[major: 1]
 version_b = Versionaire::Version[major: 2]
 version_c = Versionaire::Version[major: 1]
 
-version_a.equal? version_a # true
-version_a.equal? version_b # false
-version_a.equal? version_c # false
+version_a.equal? version_a  # true
+version_a.equal? version_b  # false
+version_a.equal? version_c  # false
 ----
 
 === Conversions
 
-==== Function (Casting)
+==== Function
 
-The `Versionaire::Version` function is provided for explicit casting to a version:
+Use the `Versionaire::Version` function to explicitly cast to a version:
 
 [source,ruby]
 ----
@@ -130,6 +130,29 @@ Versionaire::Version version
 Each of these conversions will result in a version object that represents "`1.0.0`". When attempting
 to convert an unsupported type, a `+Versionaire::Errors::Conversion+` exception will be thrown.
 
+==== Refinement
+
+Building upon the examples shown above, there is an even more elegant solution where you can use
+this gem's built-in link:https://www.alchemists.io/articles/ruby_refinements[refinement] support:
+
+[source,ruby]
+----
+using Versionaire::Cast
+
+version = Versionaire::Version[major: 1]
+
+Version "1.0.0"
+Version [1, 0, 0]
+Version major: 1, minor: 0, patch: 0
+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
+approach to casting like any other primitive.
+
 ==== Implicit
 
 Implicit conversion to a `+String+` is supported:

data/lib/versionaire.rb

@@ -8,3 +8,4 @@ require "versionaire/filler"
 require "versionaire/conversion"
 require "versionaire/identity"
 require "versionaire/version"
+require "versionaire/cast"

data/lib/versionaire/cast.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+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
+    end
+  end
+end

data/lib/versionaire/filler.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Versionaire
+  # Ensures an array can be filled to a certain size with default elements.
   class Filler
     def initialize pad = 0, max: 2
       @pad = pad

data/lib/versionaire/identity.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 8.4.0
+  version: 8.5.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-11-14 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -58,6 +58,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.8'
+- !ruby/object:Gem::Dependency
+  name: git-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +156,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.16'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -224,6 +266,7 @@ files:
 - LICENSE.adoc
 - README.adoc
 - lib/versionaire.rb
+- lib/versionaire/cast.rb
 - lib/versionaire/conversion.rb
 - lib/versionaire/errors/base.rb
 - lib/versionaire/errors/conversion.rb