versionaire 10.5.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f17a50efda09cafe9d5d2416d3ffe07ede58a1dd463f4355536075ad2c1b60af
-  data.tar.gz: 81b1567024ff03840b9bd878efc2fed81e87bae23c2373d13298ddd91a28872e
+  metadata.gz: eb98e3cae752ba465daee34c368625932376bb16090c9ad35daaba8af285c361
+  data.tar.gz: '059670fecbd63ffeb7a16eadbac9ab1eba865611017b65c7c790a4fafbf189ea'
 SHA512:
-  metadata.gz: 510a8a2d9f4e086380c22702fc106555b74d574adc4653c7a08f441fe6b3dc10adff70bc60fd1d54664bd35b4479fc9452d40657813bd70526f3c82595a10cfc
-  data.tar.gz: 2a20ee6de5a824b08629c80285d166b2156b58c2335e03c65a5b0f58dc5193bcd73feff936a60919ce5258bc2c01448908c6d523c26397919cc2e44d3de6fbea
+  metadata.gz: 23f4803ab79920bfc77025d530f25184942ce2cd677374565d25daed0628516c920e7df50e4c5aa6258fd2168597623e53600cc68d7a7ce067ff1137d55b6a15
+  data.tar.gz: e5a5f455bff106e41487a359eae6084be25480f016a1d4df6e925d002eb6938f90556787bb91f5582c618fa48aeb5024f39b315491ed5cce9520886a964f3e0d

data/README.adoc

@@ -2,20 +2,21 @@
 :toclevels: 5
 :figure-caption!:
 
+:semver_link: link:https://semver.org[Semantic Versioning]
+
 = Versionaire
 
-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.
+Ruby doesn't provide a primitive version type by default so Versionaire fills this gap by providing immutable and thread-safe {semver_link} so you can leverage 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::[]
 
 == Features
 
-* Provides https://semver.org[Semantic Versioning].
+* Provides _strict_ {semver_link} which means `<major>.<minor>.<patch>`.
 * Provides immutable, thread-safe version instances.
 * Converts (casts) from a `String`, `Array`, `Hash`, or `Version` to a `Version`.
+* Disallows `<major>.<minor>.<patch>-<pre-release>` usage even though {semver_link} suggests that you _may_ use pre-release information.
+* Disallows `<major>.<minor>.<patch>+<build_metadata>` usage even though {semver_link} suggests that you _may_ use build metadata.
 
 == Screencasts
 
@@ -322,7 +323,7 @@ To contribute, run:
 
 [source,bash]
 ----
-git clone https://github.com/bkuhlmann/versionaire.git
+git clone https://github.com/bkuhlmann/versionaire
 cd versionaire
 bin/setup
 ----

data/lib/versionaire/function.rb

@@ -8,7 +8,6 @@ module Versionaire
   module_function
 
   # Conversion function (strict) for casting an object into a version.
-  # :reek:TooManyStatements
   def Version object
     Converter.new(object).then do |converter|
       case object
@@ -26,13 +25,14 @@ module Versionaire
     using Refinements::Arrays
     using Refinements::Structs
 
-    def initialize object
+    def initialize object, model: Version
       @object = object
+      @model = model
     end
 
     def from_string
       body = "Use: <major>.<minor>.<patch>, <major>.<minor>, <major>, or empty string."
-      fail Error, error_message(object, body) unless Version.pattern.match? object
+      fail Error, error_message(object, body) unless PATTERN.match? object
 
       string_to_version
     end
@@ -41,7 +41,7 @@ module Versionaire
       body = "Use: [<major>, <minor>, <patch>], [<major>, <minor>], [<major>], or []."
       fail Error, error_message(object, body) unless (0..3).cover? object.size
 
-      Version.with_positions(*object.pad(0, max: 3))
+      model.with_positions(*object.pad(0, max: 3))
     end
 
     def from_hash
@@ -58,16 +58,16 @@ module Versionaire
 
     private
 
-    attr_reader :object, :filler
+    attr_reader :object, :model
 
     def string_to_version
-      object.split(Version.delimiter)
+      object.split(DELIMITER)
             .map(&:to_i)
             .then { |numbers| numbers.pad 0, max: 3 }
-            .then { |arguments| Version.with_positions(*arguments) }
+            .then { |arguments| model.with_positions(*arguments) }
     end
 
-    def required_keys? = object.keys.all? { |key| Version.members.include? key }
+    def required_keys? = object.keys.all? { |key| model.members.include? key }
 
     def error_message(object, body) = "Invalid version conversion: #{object}. #{body}"
   end

data/lib/versionaire/version.rb

@@ -9,21 +9,6 @@ module Versionaire
 
     using Refinements::Structs
 
-    def self.delimiter = "."
-
-    def self.pattern
-      /
-        \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 initialize major: 0, minor: 0, patch: 0
       super
       validate
@@ -52,7 +37,7 @@ module Versionaire
 
     def to_proc = method(:[]).to_proc
 
-    def to_s = to_a.join(self.class.delimiter)
+    def to_s = to_a.join DELIMITER
 
     alias_method :to_str, :to_s
 

data/lib/versionaire.rb

@@ -1,6 +1,21 @@
 # frozen_string_literal: true
 
+require "versionaire/cast"
 require "versionaire/error"
-require "versionaire/version"
 require "versionaire/function"
-require "versionaire/cast"
+require "versionaire/version"
+
+module Versionaire
+  DELIMITER = "."
+
+  PATTERN = /
+              \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

data/versionaire.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "versionaire"
-  spec.version = "10.5.0"
+  spec.version = "11.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/versionaire"
@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = "~> 3.1"
-  spec.add_dependency "refinements", "~> 9.6"
+  spec.required_ruby_version = "~> 3.2"
+  spec.add_dependency "refinements", "~> 10.0"
 
   spec.files = Dir["*.gemspec", "lib/**/*"]
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 10.5.0
+  version: 11.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2022-07-17 00:00:00.000000000 Z
+date: 2022-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.6'
+        version: '10.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.6'
+        version: '10.0'
 description:
 email:
 - brooke@alchemists.io
@@ -81,14 +81,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.18
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Provides an immutable, thread-safe, and semantic version type.