versionaire 8.6.0 → 8.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '086f0f72812f1c6dd5ae1597a8098c53513642ba6b642009dc7d33309dc87b84'
-  data.tar.gz: daad3d46b8ccd0528fe9def4a0b4bd83b6b99810b909076150edce0fe6e8efcd
+  metadata.gz: b41a84e38c6e7d73b9ecc460bb8bbecc5d763aa11a05cac1021d16d8b3e17235
+  data.tar.gz: 10e14aeb64f4ca5c92eb559a594627bef37d03abb05d1029d417ce32c7b71ea0
 SHA512:
-  metadata.gz: 7958a758fc0d40c359f26a21c3f6eb9bbaf778b8dbfe82b9f798f15b5bfd5333ca1275554ea908a76a35539408578a8c9025386b14379983788e8d1ebdd47222
-  data.tar.gz: 8646bfa7633a29cf08a75231df02eb55fc04f8d0ef8fc7b7c1e77b2361b8967f508ea2caa1444367e0d3fd683537babf14d2338773965a3a17c1d5ea272fffd2
+  metadata.gz: 5673376e2e87acee93d11e1ef4283d18bd89fea650c9fd77018263ad3a7a1e9f9041139f38d69c881540a4810eb0035dd307c5343a2dfc114d564d47c7825af1
+  data.tar.gz: 88cc980f9c39af47d3443d3348894e8189487c378a402c537e6565d53cb1f18f753892fcec26c7f41274d6bc1a4ea2b1d902708e12c6b68eed029b8f0c6caa96

data/README.adoc

@@ -159,7 +159,7 @@ Implicit conversion to a `+String+` is supported:
 
 [source,ruby]
 ----
-"1.0.0".match Versionaire::Version[major: 1] # <MatchData "1.0.0">
+"1.0.0".match Versionaire::Version[major: 1]  # <MatchData "1.0.0">
 ----
 
 ==== Explicit
@@ -170,9 +170,9 @@ Explicit conversion to a `String`, `Array`, or `Hash` is supported:
 ----
 version = Versionaire::Version.new
 
-version.to_s # "0.0.0"
-version.to_a # [0, 0, 0]
-version.to_h # {major: 0, minor: 0, patch: 0}
+version.to_s  # "0.0.0"
+version.to_a  # [0, 0, 0]
+version.to_h  # {major: 0, minor: 0, patch: 0}
 ----
 
 === Comparisons
@@ -185,39 +185,76 @@ work. Example:
 version_1 = Versionaire::Version "1.0.0"
 version_2 = Versionaire::Version "2.0.0"
 
-version_1 < version_2 # true
-version_1 <= version_2 # true
-version_1 == version_2 # false (see Equality section above for details)
-version_1 > version_2 # false
-version_1 >= version_2 # false
-version_1.between? version_1, version_2 # true
-version_1.clamp version_1, version_2 # version_1 (added in Ruby 2.4.0)
+version_1 < version_2                    # true
+version_1 <= version_2                   # true
+version_1 == version_2                   # false (see Equality section above for details)
+version_1 > version_2                    # false
+version_1 >= version_2                   # false
+version_1.between? version_1, version_2  # true
+version_1.clamp version_1, version_2     # version_1 (added in Ruby 2.4.0)
 ----
 
 === Math
 
-Versions can be added and subtracted from each other.
+Versions can be added, subtracted, sequentially increased, or sequentially decreased from each
+other.
 
 ==== Addition
 
+Versions can be added together to produce a resulting version sum.
+
 [source,ruby]
 ----
 version_1 = Versionaire::Version[major: 1, minor: 2, patch: 3]
 version_2 = Versionaire::Version[major: 2, minor: 5, patch: 7]
-version_1 + version_2 # "3.7.10"
+version_1 + version_2  # "3.7.10"
 ----
 
 ==== Subtraction
 
+Versions can be substracted from each other as long as there isn't a negative result.
+
 [source,ruby]
 ----
 version_1 = Versionaire::Version[major: 1, minor: 2, patch: 3]
 version_2 = Versionaire::Version[major: 1, minor: 1, patch: 1]
-version_1 - version_2 # "0.1.2"
+version_1 - version_2  # "0.1.2"
 
 version_1 = Versionaire::Version[major: 1]
 version_2 = Versionaire::Version[major: 5]
-version_1 - version_2 # Fails with a Versionaire::Errors::NegativeNumber
+version_1 - version_2  # Versionaire::Errors::NegativeNumber
+----
+
+==== Up
+
+Versions can be sequentially increased or given a specific version to jump to.
+
+[source,ruby]
+----
+version = Versionaire::Version[major: 1, minor: 1, patch: 1]
+version.up :major     # => "2.1.1"
+version.up :major, 3  # => "4.1.1"
+version.up :minor     # => "1.2.1"
+version.up :minor, 3  # => "1.4.1"
+version.up :patch     # => "1.1.2"
+version.up :patch, 3  # => "1.1.4"
+----
+
+==== Down
+
+Versions can be sequentially decreased or given a specific version to jump to as long as the result
+is not negative.
+
+[source,ruby]
+----
+version = Versionaire::Version[major: 5, minor: 5, patch: 5]
+version.down :major     # => "4.5.5"
+version.down :major, 3  # => "2.5.5"
+version.down :minor     # => "5.4.5"
+version.down :minor, 3  # => "5.2.5"
+version.down :patch     # => "5.5.4"
+version.down :patch, 3  # => "5.5.2"
+version.down :major, 6  # => Versionaire::Errors::NegativeNumber
 ----
 
 == Development

data/lib/versionaire/conversion.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "refinements/arrays"
+require "refinements/structs"
+
 # The gem namespace.
 module Versionaire
   module_function
@@ -20,23 +23,25 @@ module Versionaire
 
   # Aids with converting objects into valid versions.
   class Converter
-    def initialize object, filler: Filler.new
+    using Refinements::Arrays
+    using Refinements::Structs
+
+    def initialize object
       @object = object
-      @filler = filler
     end
 
     def from_string
       body = "Use: <major>.<minor>.<patch>, <major>.<minor>, <major>, or empty string."
       fail Errors::Conversion, error_message(object, body) unless Version.regex.match? object
 
-      Version[**string_to_arguments]
+      string_to_version
     end
 
     def from_array
       body = "Use: [<major>, <minor>, <patch>], [<major>, <minor>], [<major>], or []."
       fail Errors::Conversion, error_message(object, body) unless (0..3).cover? object.size
 
-      Version[**array_to_arguments]
+      Version.with_positions(*object.pad(0, max: 3))
     end
 
     def from_hash
@@ -55,15 +60,11 @@ module Versionaire
 
     attr_reader :object, :filler
 
-    def string_to_arguments
+    def string_to_version
       object.split(DELIMITER)
             .map(&:to_i)
-            .then { |numbers| filler.call numbers }
-            .then { |arguments| Version.arguments(*arguments) }
-    end
-
-    def array_to_arguments
-      Version.arguments(*filler.call(object))
+            .then { |numbers| numbers.pad 0, max: 3 }
+            .then { |arguments| Version.with_positions(*arguments) }
     end
 
     def required_keys?

data/lib/versionaire/identity.rb

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

data/lib/versionaire/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "refinements/structs"
+
 module Versionaire
   DELIMITER = "."
 
@@ -7,6 +9,8 @@ module Versionaire
   Version = Struct.new :major, :minor, :patch, keyword_init: true do
     include Comparable
 
+    using Refinements::Structs
+
     def self.regex
       /
         \A(                  # Start of string and OR.
@@ -30,12 +34,16 @@ module Versionaire
       freeze
     end
 
+    def []= key, value
+      super(key, value).tap { validate }
+    end
+
     def + other
-      self.class.then { |klass| klass.new(**klass.arguments(*reduce(other, :+))) }
+      revalue(other.to_h) { |previous, current| previous + current }
     end
 
     def - other
-      self.class.then { |klass| klass.new(**klass.arguments(*reduce(other, :-))) }
+      revalue(other.to_h) { |previous, current| previous - current }
     end
 
     def == other
@@ -48,15 +56,20 @@ module Versionaire
       to_s <=> other.to_s
     end
 
+    def down key, value = 1
+      revalue(key => value) { |previous, current| previous - current }
+    end
+
+    def up key, value = 1
+      revalue(key => value) { |previous, current| previous + current }
+    end
+
     def to_s
       to_a.join DELIMITER
     end
 
     alias_method :to_str, :to_s
-
-    def to_a
-      [major, minor, patch]
-    end
+    alias_method :values, :to_a
 
     private
 
@@ -64,9 +77,5 @@ module Versionaire
       fail Errors::InvalidNumber if to_a.any? { |number| !number.is_a? Integer }
       fail Errors::NegativeNumber if to_a.any?(&:negative?)
     end
-
-    def reduce other, action
-      to_a.zip(other.to_a).map { |pair| pair.reduce action }
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 8.6.0
+  version: 8.7.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,8 +28,22 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-12-13 00:00:00.000000000 Z
-dependencies: []
+date: 2020-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.18'
 description:
 email:
 - brooke@alchemists.io
@@ -74,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0
+rubygems_version: 3.2.2
 signing_key:
 specification_version: 4
 summary: Provides an immutable, thread-safe, and semantic version type.