versionaire 7.3.4 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e231ad66954a0d85ea1aed69133b2201ae4438ba14f20220c1eeb49f04821bbf
-  data.tar.gz: 26de9426d482dfc0231ecd6abdbb05e6d55fb52b0886206cd020ab0631c9989b
+  metadata.gz: 6dc5f90be8b452ad0343851d2694d4395bd788c8a41ab56f816f678d437d1f9b
+  data.tar.gz: 40642a094aa8f0cdab7d21fd9b90dd047b69d189bf455c24260d44c729c937c5
 SHA512:
-  metadata.gz: a64e7f0055d5856febf856ccce1759d0468c231f42d6fdd5ee7ffaea8685b1ab55471f4ad45c809b021148dbb5945ae57db15496e28ea50c8c1117db23705353
-  data.tar.gz: 64ac13585e2f1e95238d7b57d371be5ba8fa57bce5d6139ca1bc7b07cf33211f94ed0f6403dfe0659a63b2015e8277434b27164d18df6989fcba5613b20a8df4
+  metadata.gz: 80d314bbaf716a057bd75d0896c1cc0d44435cbd6c76d529e5639bd88a942a5c575e7307aa5497a2668c1fca679117c27c6e15f07c43280bfb727821dd86d5a6
+  data.tar.gz: 22b19780daed16074834b5668e30f353948392e8f3b5d2021ed19b766d051a27b074df0118cb86f5c755a7ab3fee3cad4b518cc25fd5cb52447de9f111db6ef1

data/README.md

@@ -9,7 +9,8 @@
 [![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/e61fa9230ecc0bfa6f07/test_coverage)](https://codeclimate.com/github/bkuhlmann/versionaire/test_coverage)
 [![Circle CI Status](https://circleci.com/gh/bkuhlmann/versionaire.svg?style=svg)](https://circleci.com/gh/bkuhlmann/versionaire)
 
-Provides immutable, thread-safe, semantic versioning.
+Provides an immutable, thread-safe, and semantic version type when managing versions within your
+applications.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -48,11 +49,11 @@ Provides immutable, thread-safe, semantic versioning.
 
 - Provides [Semantic Versioning](https://semver.org).
 - Provides immutable, thread-safe version instances.
-- Provides conversions (casts) from a `String`, `Array`, `Hash`, or `Version` to a `Version`.
+- Converts (casts) from a `String`, `Array`, `Hash`, or `Version` to a `Version`.
 
 ## Screencasts
 
-[![asciicast](https://asciinema.org/a/263062.svg)](https://asciinema.org/a/263062)
+[![asciicast](https://asciinema.org/a/278658.svg)](https://asciinema.org/a/278658)
 
 ## Requirements
 
@@ -77,7 +78,7 @@ A new version can be initialized in a variety of ways:
     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, maintenance: 3]    # "1.2.3"
+    Versionaire::Version[major: 1, minor: 2, patch: 3]          # "1.2.3"
 
 ### Equality
 
@@ -130,7 +131,7 @@ The `Versionaire::Version` function is provided for explicit casting to a versio
 
     Versionaire::Version "1.0.0"
     Versionaire::Version [1, 0, 0]
-    Versionaire::Version major: 1, minor: 0, maintenance: 0
+    Versionaire::Version major: 1, minor: 0, patch: 0
     Versionaire::Version version
 
 Each of these conversions will result in a version object that represents "1.0.0". When attempting
@@ -150,7 +151,7 @@ Explicit conversion to a `String`, `Array`, or `Hash` is supported:
 
     version.to_s # "0.0.0"
     version.to_a # [0, 0, 0]
-    version.to_h # {major: 0, minor: 0, maintenance: 0}
+    version.to_h # {major: 0, minor: 0, patch: 0}
 
 ### Comparisons
 
@@ -174,14 +175,14 @@ Versions can be added and subtracted from each other.
 
 #### Addition
 
-    version_1 = Versionaire::Version[major: 1, minor: 2, maintenance: 3]
-    version_2 = Versionaire::Version[major: 2, minor: 5, maintenance: 7]
+    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"
 
 #### Subtraction
 
-    version_1 = Versionaire::Version[major: 1, minor: 2, maintenance: 3]
-    version_2 = Versionaire::Version[major: 1, minor: 1, maintenance: 1]
+    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 = Versionaire::Version[major: 1]

data/lib/versionaire.rb

@@ -4,6 +4,7 @@ require "versionaire/errors/base"
 require "versionaire/errors/conversion"
 require "versionaire/errors/invalid_number"
 require "versionaire/errors/negative_number"
+require "versionaire/filler"
 require "versionaire/conversion"
 require "versionaire/identity"
 require "versionaire/version"

data/lib/versionaire/conversion.rb

@@ -7,44 +7,44 @@ module Versionaire
   # Conversion function (strict) for casting an object into a version.
   # :reek:TooManyStatements
   def Version object
-    converter = Converter.new object
-
-    case object
-      when String then converter.from_string
-      when Array then converter.from_array
-      when Hash then converter.from_hash
-      when Version then object
-      else converter.from_object
+    Converter.new(object).then do |converter|
+      case object
+        when String then converter.from_string
+        when Array then converter.from_array
+        when Hash then converter.from_hash
+        when Version then object
+        else converter.from_object
+      end
     end
   end
 
   # Aids with converting objects into valid versions.
   class Converter
-    def initialize object
+    def initialize object, filler: Filler.new
       @object = object
+      @filler = filler
     end
 
     def from_string
-      body = %(Use: "<major>.<minor>.<maintenance>" or "v<major>.<minor>.<maintenance>".)
+      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]
+      Version[**string_to_arguments]
     end
 
     def from_array
-      body = "Use: [], [<major>], [<major>, <minor>], or [<major>, <minor>, <maintenance>]."
+      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[**array_to_arguments]
     end
 
     def from_hash
-      body = "Use: {major: <major>}, " \
-             "{major: <major>, minor: <minor>}, or " \
-             "{major: <major>, minor: <minor>, maintenance: <maintenance>}."
+      body = "Use: {major: <major>, minor: <minor>, patch: <patch>}, " \
+             "{major: <major>, minor: <minor>}, {major: <major>}, or {}."
       fail Errors::Conversion, error_message(object, body) unless required_keys?
 
-      Version[object]
+      Version[**object]
     end
 
     def from_object
@@ -53,18 +53,21 @@ module Versionaire
 
     private
 
-    attr_reader :object
+    attr_reader :object, :filler
 
     def string_to_arguments
-      Version.arguments(*object.tr("v", "").split(".").map(&:to_i))
+      object.split(DELIMITER)
+            .map(&:to_i)
+            .then { |numbers| filler.call numbers }
+            .then { |arguments| Version.arguments(*arguments) }
     end
 
     def array_to_arguments
-      Version.arguments(*object.dup.fill(0, object.size..2))
+      Version.arguments(*filler.call(object))
     end
 
     def required_keys?
-      object.keys.all? { |key| VERSION_ATTRIBUTES.include? key }
+      object.keys.all? { |key| Version.members.include? key }
     end
 
     def error_message object, body

data/lib/versionaire/errors/invalid_number.rb

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

data/lib/versionaire/errors/negative_number.rb

@@ -4,7 +4,7 @@ module Versionaire
   module Errors
     # Thrown when numbers are negative.
     class NegativeNumber < Base
-      def initialize message = "Major, minor, and maintenance must be a positive number."
+      def initialize message = "Major, minor, and patch must be a positive number."
         super
       end
     end

data/lib/versionaire/filler.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Versionaire
+  class Filler
+    def initialize pad = 0, max: 2
+      @pad = pad
+      @max = max
+    end
+
+    def call array
+      array.dup.fill pad, array.size..max
+    end
+
+    private
+
+    attr_reader :pad, :max
+  end
+end

data/lib/versionaire/identity.rb

@@ -12,7 +12,7 @@ module Versionaire
     end
 
     def self.version
-      "7.3.4"
+      "8.0.0"
     end
 
     def self.version_label

data/lib/versionaire/version.rb

@@ -1,44 +1,42 @@
 # frozen_string_literal: true
 
 module Versionaire
-  VERSION_ATTRIBUTES = %i[major minor maintenance].freeze
-  VERSION_DELIMITER = "."
+  DELIMITER = "."
 
   # An immutable, semantic version value object.
   # rubocop:disable Metrics/BlockLength
-  Version = Struct.new :major, :minor, :maintenance, keyword_init: true do
+  Version = Struct.new :major, :minor, :patch, keyword_init: true do
     include Comparable
 
     def self.regex
       /
-        \A                    # Start of string.
-        \d{1,}                # Major version.
-        #{VERSION_DELIMITER}  # Delimiter.
-        \d{1,}                # Minor version.
-        #{VERSION_DELIMITER}  # Delimiter.
-        \d{1,}                # Maintenance version.
-        \z                    # End of string.
+        \A(                  # Start of string and OR.
+        \d*                  # Major only.
+        |                    # OR pipe.
+        \d+                  # Major.
+        #{DELIMITER}?        # Delimiter.
+        \d*                  # Minor.
+        (?:#{DELIMITER}\d+)  # Passive delimiter and patch.
+        )\z                  # End of OR and string.
       /x
     end
 
-    def self.arguments major, minor, maintenance
-      Hash[VERSION_ATTRIBUTES.zip [major, minor, maintenance]]
+    def self.arguments major, minor, patch
+      Hash[members.zip [major, minor, patch]]
     end
 
-    def initialize major: 0, minor: 0, maintenance: 0
+    def initialize major: 0, minor: 0, patch: 0
       super
       validate
       freeze
     end
 
     def + other
-      klass = self.class
-      klass.new klass.arguments(*reduce(other, :+))
+      self.class.then { |klass| klass.new(**klass.arguments(*reduce(other, :+))) }
     end
 
     def - other
-      klass = self.class
-      klass.new klass.arguments(*reduce(other, :-))
+      self.class.then { |klass| klass.new(**klass.arguments(*reduce(other, :-))) }
     end
 
     def == other
@@ -52,13 +50,13 @@ module Versionaire
     end
 
     def to_s
-      to_a.join VERSION_DELIMITER
+      to_a.join DELIMITER
     end
 
     alias_method :to_str, :to_s
 
     def to_a
-      [major, minor, maintenance]
+      [major, minor, patch]
     end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 7.3.4
+  version: 8.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,36 +28,8 @@ cert_chain:
   dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
   y84=
   -----END CERTIFICATE-----
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2020-01-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: bond
-  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: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -72,34 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.5'
-- !ruby/object:Gem::Dependency
-  name: git-cop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,48 +58,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: hirb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -204,84 +134,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '0.78'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '0.78'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.37'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.37'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: wirb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0.17'
 description: 
 email:
 - brooke@alchemists.io
@@ -299,6 +215,7 @@ files:
 - lib/versionaire/errors/conversion.rb
 - lib/versionaire/errors/invalid_number.rb
 - lib/versionaire/errors/negative_number.rb
+- lib/versionaire/filler.rb
 - lib/versionaire/identity.rb
 - lib/versionaire/version.rb
 homepage: https://github.com/bkuhlmann/versionaire
@@ -316,15 +233,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Provides immutable, thread-safe, semantic versioning.
+summary: Provides an immutable, thread-safe, and semantic version type.
 test_files: []