version_gem 1.1.4 → 1.1.8

data/SECURITY.md

@@ -6,8 +6,16 @@
 |----------|-----------|
 | 1.latest | ✅         |
 
-## Reporting a Vulnerability
+## Security contact information
 
-Peter Boling is the primary maintainer of this gem. Please find a way
-to [contact him directly](https://railsbling.com/contact) to report the issue. Include as much relevant information as
-possible.
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
+
+## Additional Support
+
+If you are interested in support for versions older than the latest release,
+please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
+or find other sponsorship links in the [README].
+
+[README]: README.md

data/lib/version_gem/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VersionGem
   # Public API of this library
   module Api

data/lib/version_gem/epoch.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "error"
+require_relative "api"
+
+module VersionGem
+  # Support for Epoch Semantic Versioning
+  # See: https://antfu.me/posts/epoch-semver
+  module Epoch
+    EPOCH_SIZE = 1_000
+
+    class << self
+      def extended(base)
+        raise Error, "VERSION must be defined before 'extend #{name}'" unless defined?(base::VERSION)
+
+        base.extend(Api)
+        base.extend(OverloadApiForEpoch)
+      end
+    end
+
+    # Tweak the basic API so it will support Epoch Semantic Versioning
+    module OverloadApiForEpoch
+      # *** OVERLOAD METHODS FROM API ***
+      #
+      # The epoch version
+      #
+      # @return [Integer]
+      def epoch
+        @epoch ||= _major / EPOCH_SIZE
+      end
+
+      # The major version
+      #
+      # @return [Integer]
+      def major
+        @major ||= _major % EPOCH_SIZE
+      end
+
+      # The version number as a hash
+      #
+      # @return [Hash]
+      def to_h
+        @to_h ||= {
+          epoch: epoch,
+          major: major,
+          minor: minor,
+          patch: patch,
+          pre: pre,
+        }
+      end
+
+      # NOTE: This is not the same as _to_a, which returns an array of strings
+      #
+      # The version number as an array of cast values
+      # where epoch and major are derived from a single string:
+      #   EPOCH * 1000 + MAJOR
+      #
+      # @return [Array<[Integer, String, NilClass]>]
+      def to_a
+        @to_a ||= [epoch, major, minor, patch, pre]
+      end
+
+      private
+
+      def _major
+        @_major ||= _to_a[0].to_i
+      end
+    end
+  end
+end

data/lib/version_gem/error.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
 module VersionGem
+  # Errors raised by VersionGem will be of this class
   class Error < RuntimeError; end
 end

data/lib/version_gem/rspec.rb

@@ -12,6 +12,12 @@ RSpec::Matchers.define(:have_version_as_string) do
   end
 end
 
+RSpec::Matchers.define(:have_epoch_as_integer) do
+  match do |version_mod|
+    version_mod.epoch.is_a?(Integer)
+  end
+end
+
 RSpec::Matchers.define(:have_major_as_integer) do
   match do |version_mod|
     version_mod.major.is_a?(Integer)
@@ -52,3 +58,22 @@ RSpec.shared_examples_for("a Version module") do |version_mod|
     end
   end
 end
+
+# This one is more Epoch ;)
+RSpec.shared_examples_for("an Epoch Version module") do |version_mod|
+  it "is introspectable" do
+    aggregate_failures "introspectable api" do
+      expect(version_mod).is_a?(Module)
+      expect(version_mod).to(have_version_constant)
+      expect(version_mod).to(have_version_as_string)
+      expect(version_mod.to_s).to(be_a(String))
+      expect(version_mod).to(have_epoch_as_integer)
+      expect(version_mod).to(have_major_as_integer)
+      expect(version_mod).to(have_minor_as_integer)
+      expect(version_mod).to(have_patch_as_integer)
+      expect(version_mod).to(have_pre_as_nil_or_string)
+      expect(version_mod.to_h.keys).to(match_array(%i[epoch major minor patch pre]))
+      expect(version_mod.to_a).to(be_a(Array))
+    end
+  end
+end

data/lib/version_gem/ruby.rb

@@ -1,16 +1,21 @@
+# frozen_string_literal: true
+
 module VersionGem
   # Helpers for library CI integration against many different versions of Ruby
   module Ruby
     RUBY_VER = ::Gem::Version.new(RUBY_VERSION)
 
+    # Check if the current Ruby version is greater than or equal to the given version
     def gte_minimum_version?(version, engine = "ruby")
       RUBY_VER >= ::Gem::Version.new(version) && ::RUBY_ENGINE == engine
     end
     module_function :gte_minimum_version?
 
+    # Check if the current Ruby version (MAJOR.MINOR) is equal to the given version
     def actual_minor_version?(major, minor, engine = "ruby")
-      major.to_i == RUBY_VER.segments[0] &&
-        minor.to_i == RUBY_VER.segments[1] &&
+      segs = RUBY_VER.segments
+      major.to_i == segs[0] &&
+        minor.to_i == segs[1] &&
         ::RUBY_ENGINE == engine
     end
     module_function :actual_minor_version?

data/lib/version_gem/version.rb

@@ -2,11 +2,13 @@
 
 module VersionGem
   module Version
-    VERSION = "1.1.4"
+    VERSION = "1.1.8"
     # This would work in this gem, but not in external libraries,
     #   because version files are loaded in Gemspecs before bundler
     #   has a chance to load dependencies.
     # Instead, see lib/version_gem.rb for a solution that will work everywhere
     # extend VersionGem::Basic
+    #   or
+    # extend VersionGem::Epoch
   end
 end

data/lib/version_gem.rb

@@ -2,6 +2,7 @@
 
 require_relative "version_gem/version"
 require_relative "version_gem/basic"
+require_relative "version_gem/epoch"
 
 # Namespace of this library
 module VersionGem

metadata

@@ -1,42 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: version_gem
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.8
 platform: ruby
 authors:
 - Peter Boling
-autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
   MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
   ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
-  A2NvbTAeFw0yMzA5MjAxNzMwMjhaFw0yNDA5MTkxNzMwMjhaMEMxFTATBgNVBAMM
+  A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
   DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
-  LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA+a9UvHo3
-  84k96WgU5Kk5HB+cLZs/modjorsTfqY67MJF5nNvAoqcKTUBW4uG+Zpfnm3jaDO5
-  GxhJEIZWfndYzycHT2KMVQ1uTP82ba8ZaKrPlPIafkbui3mdds47qsmqHiblKERg
-  U532lkwfqHDlJwE7OBZQ59EwWWLynlT/yAUHpOBbqIuHKUxdpmBI+sIjrZcD1e05
-  WmjkO6fwIdC5oM757aoPxIgXD587VOViH11Vkm2doskj4T8yONtwVHlcrrhJ9Bzd
-  /zdp6vEn7GZQrABvpOlqwWxQ72ZnFhJe/RJZf6CXOPOh69Ai0QKYl2a1sYuCJKS3
-  nsBnxXJINEEznjR7rZjNUmYD+CZqfjzgPqedRxTlASe7iA4w7xZOqMDzcuhNwcUQ
-  tMEH6BTktxKP3jXZPXRfHCf6s+HRVb6vezAonTBVyydf5Xp5VwWkd6cwm+2BzHl5
-  7kc/3lLxKMcsyEUprAsk8LdHohwZdC267l+RS++AP6Cz6x+nB3oGob19AgMBAAGj
-  fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQCSSas60GqqMjt
-  xR7LoY1gucEvtzAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
+  LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAruUoo0WA
+  uoNuq6puKWYeRYiZekz/nsDeK5x/0IEirzcCEvaHr3Bmz7rjo1I6On3gGKmiZs61
+  LRmQ3oxy77ydmkGTXBjruJB+pQEn7UfLSgQ0xa1/X3kdBZt6RmabFlBxnHkoaGY5
+  mZuZ5+Z7walmv6sFD9ajhzj+oIgwWfnEHkXYTR8I6VLN7MRRKGMPoZ/yvOmxb2DN
+  coEEHWKO9CvgYpW7asIihl/9GMpKiRkcYPm9dGQzZc6uTwom1COfW0+ZOFrDVBuV
+  FMQRPswZcY4Wlq0uEBLPU7hxnCL9nKK6Y9IhdDcz1mY6HZ91WImNslOSI0S8hRpj
+  yGOWxQIhBT3fqCBlRIqFQBudrnD9jSNpSGsFvbEijd5ns7Z9ZMehXkXDycpGAUj1
+  to/5cuTWWw1JqUWrKJYoifnVhtE1o1DZ+LkPtWxHtz5kjDG/zR3MG0Ula0UOavlD
+  qbnbcXPBnwXtTFeZ3C+yrWpE4pGnl3yGkZj9SMTlo9qnTMiPmuWKQDatAgMBAAGj
+  fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQE8uWvNbPVNRXZ
+  HlgPbc2PCzC4bjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
   A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
-  ggGBAMl9ifcw5p+PdvB7dCPoNKoVdp/2LbC9ztETHuYL2gUMJB6UoS3o9c/piSuR
-  V3ZMQaijmNu6ms1bWAtJ66LjmYrVflJtf9yp31Kierr9LpisMSUx2qbMOHGa8d2Z
-  vCUWPF8E9Cg0mP3GAyZ6qql8jDh/anUKeksPXqJvNxNPDu2DVYsa/IWdl96whzS4
-  Bl7SwB1E7agps40UcshCSKaVDOU0M+XN6SrnJMElnBic+KSAkBkVFbzS0BE4ODZM
-  BgE6nYzQ05qhuvbE+oGdACTlemNtDDWCh0uw+7x0q2PocGIDU5zsPn/WNTkCXPmB
-  CHGvqDNWq4M7ncTKAaS2XExgyb7uPdq9fKiOW8nmH+zCiGzJXzBWwZlKf7L4Ht9E
-  a3f0e5C+zvee9Z5Ng9ciyfav9/fcXgYt5MjoBv27THr5XfBhgOCIHSYW2tqJmWKi
-  KuxrfYrN+9HvMdm+nZ6TypmKftHY3Gj+/uu+g8Icm/zrvTWAEE0mcJOkfrIoNPJb
-  pF8dMA==
+  ggGBAJbnUwfJQFPkBgH9cL7hoBfRtmWiCvdqdjeTmi04u8zVNCUox0A4gT982DE9
+  wmuN12LpdajxZONqbXuzZvc+nb0StFwmFYZG6iDwaf4BPywm2e/Vmq0YG45vZXGR
+  L8yMDSK1cQXjmA+ZBKOHKWavxP6Vp7lWvjAhz8RFwqF9GuNIdhv9NpnCAWcMZtpm
+  GUPyIWw/Cw/2wZp74QzZj6Npx+LdXoLTF1HMSJXZ7/pkxLCsB8m4EFVdb/IrW/0k
+  kNSfjtAfBHO8nLGuqQZVH9IBD1i9K6aSs7pT6TW8itXUIlkIUI2tg5YzW6OFfPzq
+  QekSkX3lZfY+HTSp/o+YvKkqWLUV7PQ7xh1ZYDtocpaHwgxe/j3bBqHE+CUPH2vA
+  0V/FwdTRWcwsjVoOJTrYcff8pBZ8r2MvtAc54xfnnhGFzeRHfcltobgFxkAXdE6p
+  DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
+  L9nRqA==
   -----END CERTIFICATE-----
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2025-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rspec-block_is_expected
   requirement: !ruby/object:Gem::Requirement
@@ -81,26 +80,32 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: stone_checksums
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1.0'
 description: Versions are good. Versions are cool. Versions will win.
 email:
 - peter.boling@gmail.com
 - oauth-ruby@googlegroups.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- LICENSE.txt
+- README.md
+- SECURITY.md
 files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -111,6 +116,7 @@ files:
 - lib/version_gem.rb
 - lib/version_gem/api.rb
 - lib/version_gem/basic.rb
+- lib/version_gem/epoch.rb
 - lib/version_gem/error.rb
 - lib/version_gem/rspec.rb
 - lib/version_gem/ruby.rb
@@ -119,17 +125,23 @@ homepage: https://gitlab.com/oauth-xx/version_gem
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/oauth-xx/version_gem
-  source_code_uri: https://gitlab.com/oauth-xx/version_gem/-/tree/v1.1.4
-  changelog_uri: https://gitlab.com/oauth-xx/version_gem/-/blob/v1.1.4/CHANGELOG.md
+  homepage_uri: https://railsbling.com/tags/version_gem/
+  source_code_uri: https://gitlab.com/oauth-xx/version_gem/-/tree/v1.1.8
+  changelog_uri: https://gitlab.com/oauth-xx/version_gem/-/blob/v1.1.8/CHANGELOG.md
   bug_tracker_uri: https://gitlab.com/oauth-xx/version_gem/-/issues
-  documentation_uri: https://www.rubydoc.info/gems/version_gem/1.1.4
+  documentation_uri: https://www.rubydoc.info/gems/version_gem/1.1.8
   wiki_uri: https://gitlab.com/oauth-xx/version_gem/-/wiki
   mailing_list_uri: https://groups.google.com/g/oauth-ruby
   funding_uri: https://liberapay.com/pboling
   rubygems_mfa_required: 'true'
-post_install_message:
-rdoc_options: []
+rdoc_options:
+- "--title"
+- version_gem - Enhance your VERSION! Sugar for Version modules.
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -143,8 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Enhance your VERSION! Sugar for Version modules.
 test_files: []