versionaire 12.0.1 → 12.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 769818a4d08698f98c8ffca2b83d5703e0cc6570410e74f73c70443e7a31a90c
-  data.tar.gz: 1fdc7934a9a66ea188183935016e0c1268d5bea83834e5fb3b470c73043c44db
+  metadata.gz: 5491ae46c08cb7f8a99682ddb9f59e0860cd7a2eb563caf027f5610bab7fc641
+  data.tar.gz: 46073e43dd7326186280e5c26ced3d432947678c5e9f58dcaebc90fbe9ab59ab
 SHA512:
-  metadata.gz: da502bdb67648c51083cf7f07fa4affdf38277a567aa8ec85828c705b2e5c74d507e53769fab9c925027d71de2648d4f872c5275e058aab2357ffbf90d61d270
-  data.tar.gz: 0bababadf95c679b81582d27a67f16524330caf5187b885cd1982d935ca540e2abc863c0d0effe5200b64a6902a25e607d9ceb1ba7096978998ab52a73c3974b
+  metadata.gz: d49bfe2ed44bc125d4ad0521bdffb1e960a0f60201a5408cb1bda60c708f3db37d8a91e64c6447a255d28618882b703c374dc231c41fa76b729dc74a267dd816
+  data.tar.gz: 79809e27fcc439583a0723f0954ec262baa2d17857b71a3ff0c8b686bb3aa911014177b44caf07f2c92ac0ae6fe7c0d9c04f50ba5d890304c27e486b1f276803

checksums.yaml.gz.sig

@@ -1,2 +1 @@
-�_h��]���3��[�+�����!�V<���2��OA�^E0R�\�J��׉�<��F��?�),�2��3����U	0��o���+\E�T�?o�lB�����.�0��E��c]�8�o�W�mk����g`�dw��y�qN�7eg|8ِ���
}�Ð�k۟�>_^i��6�x��!�<Rtu��ɖ��S�q4L܍e�e^��� ��$��S�.�7w���#*�^��QS���ښ�h��kLՒ6N.P���G�R�^jt@I��
���V�`�{�GkV
�2��:����rѷLh
-n3��e�8sY��~au���f0����o�	
�o��n�b�?���B8~m���o(�m}L�:� ��'X];�C>�����J
+�DX6���9EX�U��>X
J�<&�u�;5�2IO��L�wRpL�-�S�i�z���j!t�Y��o �ܤ���dCm��I��A�������Ph@n�Ug'�Y/vn#�9��d��'�F����l`O񁎀G�@��#p؃��
?����ρ�O��{1c���}�m(@�(*-B'��U�j���7��M�X�׼�����}~1��X>n���.�jO9���$ ��0�cN�0���q!�����!\�H�HHUܣ�~-�E&*Q�'/|�3���y�2������>����-���K-�����pR�9�I�v'�pI��K//��q���<};�h

data/README.adoc

@@ -2,6 +2,7 @@
 :toclevels: 5
 :figure-caption!:
 
+:option_parser_link: link:https://alchemists.io/articles/ruby_option_parser[OptionParser]
 :semver_link: link:https://semver.org[Semantic Versioning]
 
 = Versionaire
@@ -77,8 +78,7 @@ Versionaire::Version[major: 1, minor: 2, patch: 3]  # "1.2.3"
 
 ==== Value (`+#==+`)
 
-Equality is deterimined by the state of the object. This means that a version is equal to another
-version as long as all of the values (i.e. state) are equal to each other. Example:
+Equality is determined by the state of the object. This means that a version is equal to another version as long as all of the values (i.e. state) are equal to each other. Example:
 
 [source,ruby]
 ----
@@ -91,7 +91,7 @@ version_a == version_b  # false
 version_a == version_c  # true
 ----
 
-Knowning this, versions can be compared against one another too:
+Knowing this, versions can be compared against one another too:
 
 [source,ruby]
 ----
@@ -140,12 +140,11 @@ 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::Cast+` exception will be thrown.
+to convert an unsupported type, a `Versionaire::Error` 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://alchemists.io/articles/ruby_refinements[refinement] support:
+Building upon the above examples, a more elegant solution is to use a link:https://alchemists.io/articles/ruby_refinements[refinement]:
 
 [source,ruby]
 ----
@@ -230,6 +229,29 @@ version_1.between? version_1, version_2  # true
 version_1.clamp version_1, version_2     # version_1 (added in Ruby 2.4.0)
 ----
 
+=== Bumping
+
+Versions can be bumped to next logical version with respect current version. Example:
+
+[source,ruby]
+----
+version = Versionaire::Version.new  # #<struct Versionaire::Version major=0, minor=0, patch=0>
+version.bump :major                 # #<struct Versionaire::Version major=1, minor=0, patch=0>
+version.bump :minor                 # #<struct Versionaire::Version major=0, minor=1, patch=0>
+version.bump :patch                 # #<struct Versionaire::Version major=0, minor=0, patch=1>
+
+Versionaire::Version[major: 1, minor: 2, patch: 3].bump :major
+#<struct Versionaire::Version major=2, minor=0, patch=0>
+
+Versionaire::Version[major: 1, minor: 2, patch: 3].bump :minor
+#<struct Versionaire::Version major=1, minor=3, patch=0>
+
+Versionaire::Version[major: 1, minor: 2, patch: 3].bump :patch
+#<struct Versionaire::Version major=1, minor=2, patch=4>
+----
+
+You'll notice, when bumping the major or minor versions, lower precision gets zeroed out in order to provide the next logical version.
+
 === Math
 
 Versions can be added, subtracted, sequentially increased, or sequentially decreased from each
@@ -258,7 +280,7 @@ version_1 - version_2  # "0.1.2"
 
 version_1 = Versionaire::Version[major: 1]
 version_2 = Versionaire::Version[major: 5]
-version_1 - version_2  # Versionaire::Errors::NegativeNumber
+version_1 - version_2  # Versionaire::Error
 ----
 
 ==== Up
@@ -290,7 +312,7 @@ 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
+version.down :major, 6  # => Versionaire::Error
 ----
 
 === Extensions
@@ -301,15 +323,10 @@ details.
 
 ==== OptionParser
 
-link:https://github.com/ruby/optparse[OptionParser] is one of Ruby's
-link:https://stdgems.org[default gems] which can accept additional types not native to Ruby by
-default. To extend `OptionParser` with the `Version` type, all you need to do is add these two lines
-to your implementation:
+{option_parser_link} is one of Ruby's link:https://stdgems.org[default gems] which can accept additional types not native to Ruby by default. To extend `OptionParser` with the `Version` type, all you need to do is add these two lines to your implementation:
 
-. `require "versionaire/extensions/option_parser"` - This will load dependencies and register the
-  `Version` type with `OptionParser`.
-. `instance.on "--tag VERSION", Versionaire::Version` - Specifying `Versionaire::Version` as the
-  second argument will ensure `OptionParser` properly casts command line input as a `Version` type.
+. `require "versionaire/extensions/option_parser"`: This will load dependencies and register the `Version` type with `OptionParser`.
+. `act.on "--tag VERSION", Versionaire::Version`: Specifying `Versionaire::Version` as the second argument will ensure `OptionParser` properly casts command line input as a `Version` type.
 
 Here's an example implementation that demonstrates full usage:
 
@@ -319,19 +336,18 @@ require "versionaire/extensions/option_parser"
 
 options = {}
 
-parser = OptionParser.new do |instance|
-  instance.on "--tag VERSION", Versionaire::Version, "Casts to version." do |value|
+parser = OptionParser.new do |act|
+  act.on "--tag VERSION", Versionaire::Version, "Casts to version." do |value|
     options[:version] = value
   end
 end
 
-parser.parse! %w[--tag 1.2.3]
+parser.parse %w[--tag 1.2.3]
 puts options
 ----
 
-The above will ensure `--tag 1.2.3` is parsed as `{:version=>#<struct Versionaire::Version major=1,
-minor=2, patch=3>}` within your `options` variable. Should `OptionParser` parse an invalid version,
-you'll get a `OptionParser::InvalidArgument` instead.
+The above will ensure `--tag 1.2.3` is parsed as `{version: #<struct Versionaire::Version major = 1,
+minor = 2, patch = 3>}` within your `options` variable. Should `OptionParser` parse an invalid version, you'll get a `OptionParser::InvalidArgument` instead.
 
 == Development
 

data/lib/versionaire/version.rb

@@ -7,6 +7,7 @@ module Versionaire
   Version = Struct.new :major, :minor, :patch, keyword_init: true do
     include Comparable
 
+    using Refinements::Arrays
     using Refinements::Structs
 
     def initialize major: 0, minor: 0, patch: 0
@@ -19,9 +20,9 @@ module Versionaire
       super(key, value).tap { validate }
     end
 
-    def +(other) = revalue(other.to_h) { |previous, current| previous + current }
+    def +(other) = (revalue(other.to_h) { |previous, current| previous + current }).freeze
 
-    def -(other) = revalue(other.to_h) { |previous, current| previous - current }
+    def -(other) = (revalue(other.to_h) { |previous, current| previous - current }).freeze
 
     def ==(other) = hash == other.hash
 
@@ -29,9 +30,22 @@ module Versionaire
 
     def <=>(other) = to_s <=> other.to_s
 
-    def down(key, value = 1) = revalue(key => value) { |previous, current| previous - current }
+    def down key, value = 1
+      (revalue(key => value) { |previous, current| previous - current }).freeze
+    end
+
+    def up key, value = 1
+      (revalue(key => value) { |previous, current| previous + current }).freeze
+    end
 
-    def up(key, value = 1) = revalue(key => value) { |previous, current| previous + current }
+    def bump key
+      case key
+        when :major then bump_major
+        when :minor then bump_minor
+        when :patch then bump_patch
+        else fail Error, %(Invalid key: #{key.inspect}. Use: #{members.to_sentence "or"}.)
+      end
+    end
 
     def inspect = to_s.inspect
 
@@ -50,5 +64,11 @@ module Versionaire
 
       fail Error, "Major, minor, and patch must be a positive number." if to_a.any?(&:negative?)
     end
+
+    def bump_major = merge(major: major + 1, minor: 0, patch: 0).freeze
+
+    def bump_minor = merge(major:, minor: minor + 1, patch: 0).freeze
+
+    def bump_patch = merge(major:, minor:, patch: patch + 1).freeze
   end
 end

data/versionaire.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "versionaire"
-  spec.version = "12.0.1"
+  spec.version = "12.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/versionaire"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 12.0.1
+  version: 12.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: An immutable, thread-safe, and semantic version type.