versionaire 8.1.0 → 8.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20b3927b31e04a6aa4db539594e3826114c9059bbdbbc7bf82db8cc2bb1642b
-  data.tar.gz: c8f52778a5a07e77d819e525e5a9e8faf00f342280757261972ee73d49dfca1f
+  metadata.gz: '086f0f72812f1c6dd5ae1597a8098c53513642ba6b642009dc7d33309dc87b84'
+  data.tar.gz: daad3d46b8ccd0528fe9def4a0b4bd83b6b99810b909076150edce0fe6e8efcd
 SHA512:
-  metadata.gz: e6541aa88de4802b6e7341b8f6b9deeceb5b33a95533de0255f41485f0be754fe66067b9ce03c3bee0936d25ed14589f359effe3e595616424acbfbbe36d2fc7
-  data.tar.gz: 6922a4629f06dba48a05068301160e7861fcf9780d3a29552d65f6d4d9e16f2cbe1dab590b158990316def5c18f79f36a467eb8453a4b91a0378939b36f8684b
+  metadata.gz: 7958a758fc0d40c359f26a21c3f6eb9bbaf778b8dbfe82b9f798f15b5bfd5333ca1275554ea908a76a35539408578a8c9025386b14379983788e8d1ebdd47222
+  data.tar.gz: 8646bfa7633a29cf08a75231df02eb55fc04f8d0ef8fc7b7c1e77b2361b8967f508ea2caa1444367e0d3fd683537babf14d2338773965a3a17c1d5ea272fffd2

data/LICENSE.adoc

@@ -150,7 +150,7 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright link:https://www.alchemists.io[Alchemists].
+Copyright 2016 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
 compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]

data/README.adoc

@@ -6,6 +6,8 @@
 
 [link=http://badge.fury.io/rb/versionaire]
 image::https://badge.fury.io/rb/versionaire.svg[Gem Version]
+[link=https://www.alchemists.io/projects/code_quality]
+image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
 [link=https://circleci.com/gh/bkuhlmann/versionaire]
 image::https://circleci.com/gh/bkuhlmann/versionaire.svg?style=svg[Circle CI Status]
 
@@ -22,17 +24,15 @@ toc::[]
 
 == Screencasts
 
-[link=https://www.alchemists.io/screencasts/versionaire.html]
-image::https://www.alchemists.io/images/screencasts/versionaire/cover-original.png[Screencast,role=focal_point]
+[link=https://www.alchemists.io/screencasts/versionaire]
+image::https://www.alchemists.io/images/screencasts/versionaire/cover.svg[Screencast,600,240,role=focal_point]
 
 == Requirements
 
-. https://www.ruby-lang.org[Ruby 2.7.x].
+. https://www.ruby-lang.org[Ruby].
 
 == Setup
 
-=== Production
-
 To install, run:
 
 [source,bash]
@@ -47,24 +47,6 @@ Add the following to your Gemfile:
 gem "versionaire"
 ----
 
-=== Development
-
-To contribute, run:
-
-[source,bash]
-----
-git clone https://github.com/bkuhlmann/versionaire.git
-cd versionaire
-bin/setup
-----
-
-You can also use the IRB console for direct access to all objects:
-
-[source,bash]
-----
-bin/console
-----
-
 == Usage
 
 === Initialization
@@ -73,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
@@ -92,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?`)
@@ -124,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]
 ----
@@ -148,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:
@@ -215,6 +220,24 @@ version_2 = Versionaire::Version[major: 5]
 version_1 - version_2 # Fails with a Versionaire::Errors::NegativeNumber
 ----
 
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/versionaire.git
+cd versionaire
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
 == Tests
 
 To test, run:
@@ -251,4 +274,4 @@ Read link:CHANGES.adoc[CHANGES] for details.
 
 == Credits
 
-Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann.html[Brooke Kuhlmann].
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

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/errors/invalid_number.rb

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

data/lib/versionaire/errors/negative_number.rb

@@ -5,7 +5,7 @@ module Versionaire
     # Thrown when numbers are negative.
     class NegativeNumber < Base
       def initialize message = "Major, minor, and patch must be a positive number."
-        super
+        super message
       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.1.0"
+    VERSION = "8.6.0"
     VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

data/lib/versionaire/version.rb

@@ -4,7 +4,6 @@ module Versionaire
   DELIMITER = "."
 
   # An immutable, semantic version value object.
-  # rubocop:disable Metrics/BlockLength
   Version = Struct.new :major, :minor, :patch, keyword_init: true do
     include Comparable
 
@@ -70,5 +69,4 @@ module Versionaire
       to_a.zip(other.to_a).map { |pair| pair.reduce action }
     end
   end
-  # rubocop:enable Metrics/BlockLength
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.6.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -28,205 +28,9 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-04-01 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler-audit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '14.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '14.0'
-- !ruby/object:Gem::Dependency
-  name: git-cop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.79'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.79'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-description: 
+date: 2020-12-13 00:00:00.000000000 Z
+dependencies: []
+description:
 email:
 - brooke@alchemists.io
 executables: []
@@ -238,6 +42,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
@@ -254,7 +59,7 @@ metadata:
   changelog_uri: https://www.alchemists.io/projects/versionaire/changes.html
   documentation_uri: https://www.alchemists.io/projects/versionaire
   source_code_uri: https://github.com/bkuhlmann/versionaire
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -269,8 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.0
+signing_key:
 specification_version: 4
 summary: Provides an immutable, thread-safe, and semantic version type.
 test_files: []

metadata.gz.sig

@@ -1,3 +1,2 @@
-gx�e'��.�\�bf"�d�T���.XQ�LE!"EJt]�vȶ9>:�8�?�︩�Y��~P�~R�IB@mTW^3��?7]vy�]^	������K-b�^�!�=X��_��>����A8�j�}�x����w����*�P���MSóX��J�XED�ht�_3����x���~�(^���{��*;n��a�W亞��ȫ�1�ƒl�/_��H.@�ܧ-�����
-z����n�
-1�K~�3­
+Ƴ1��a if���X�9�q�!�	X����H�R0���+�w�Gʻr����vP��59Y,�d�j�k��[��O�:�X@C_�1yj�	�O��~r�|]�g|6��9��՛z���:�
+h�ږ���
A�Q�u.�D��=>�L�A���,��sn�g0���>m��1��F�G��`�1H�[&[�Y�[��D貍t�Q�[��e�X���Mpy�>���Y���+bLӪ��&S�7�tz#�/�7�$�����"|