version_gem 1.1.0 → 1.1.8

data/SECURITY.md

@@ -2,12 +2,20 @@
 
 ## Supported Versions
 
-| Version    | Supported |
-|------------|-----------|
-| 1.<latest> | ✅         |
+| Version  | Supported |
+|----------|-----------|
+| 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,4 +1,7 @@
+# frozen_string_literal: true
+
 module VersionGem
+  # Public API of this library
   module Api
     # The version number as a string
     #
@@ -11,39 +14,39 @@ module VersionGem
     #
     # @return [Integer]
     def major
-      _to_a[0].to_i
+      @major ||= _to_a[0].to_i
     end
 
     # The minor version
     #
     # @return [Integer]
     def minor
-      _to_a[1].to_i
+      @minor ||= _to_a[1].to_i
     end
 
     # The patch version
     #
     # @return [Integer]
     def patch
-      _to_a[2].to_i
+      @patch ||= _to_a[2].to_i
     end
 
     # The pre-release version, if any
     #
     # @return [String, NilClass]
     def pre
-      _to_a[3]
+      @pre ||= _to_a[3]
     end
 
     # The version number as a hash
     #
     # @return [Hash]
     def to_h
-      {
+      @to_h ||= {
         major: major,
         minor: minor,
         patch: patch,
-        pre: pre
+        pre: pre,
       }
     end
 
@@ -51,7 +54,7 @@ module VersionGem
     #
     # @return [Array<[Integer, String, NilClass]>]
     def to_a
-      [major, minor, patch, pre]
+      @to_a ||= [major, minor, patch, pre]
     end
 
     private
@@ -60,7 +63,7 @@ module VersionGem
     #
     # @return [Array<String>]
     def _to_a
-      self::VERSION.split('.')
+      @_to_a = self::VERSION.split(".")
     end
   end
 end

data/lib/version_gem/basic.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
-require_relative 'error'
-require_relative 'api'
+require_relative "error"
+require_relative "api"
 
 module VersionGem
   # This is a very *basic* version parser. Others could be built based on this pattern!
   module Basic
-    def self.extended(base)
-      raise Error, "VERSION must be defined before 'extend #{name}'" unless defined?(base::VERSION)
+    class << self
+      def extended(base)
+        raise Error, "VERSION must be defined before 'extend #{name}'" unless defined?(base::VERSION)
 
-      base.extend Api
+        base.extend(Api)
+      end
     end
   end
 end

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

@@ -1,54 +1,79 @@
 # frozen_string_literal: true
 
-RSpec::Matchers.define :have_version_constant do
+RSpec::Matchers.define(:have_version_constant) do
   match do |version_mod|
     version_mod.const_defined?(:VERSION, false)
   end
 end
 
-RSpec::Matchers.define :have_version_as_string do
+RSpec::Matchers.define(:have_version_as_string) do
   match do |version_mod|
     !version_mod::VERSION.nil? && version_mod::VERSION.is_a?(String)
   end
 end
 
-RSpec::Matchers.define :have_major_as_integer do
+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)
   end
 end
 
-RSpec::Matchers.define :have_minor_as_integer do
+RSpec::Matchers.define(:have_minor_as_integer) do
   match do |version_mod|
     version_mod.minor.is_a?(Integer)
   end
 end
 
-RSpec::Matchers.define :have_patch_as_integer do
+RSpec::Matchers.define(:have_patch_as_integer) do
   match do |version_mod|
     version_mod.patch.is_a?(Integer)
   end
 end
 
-RSpec::Matchers.define :have_pre_as_nil_or_string do
+RSpec::Matchers.define(:have_pre_as_nil_or_string) do
   match do |version_mod|
     version_mod.pre.nil? || version_mod.pre.is_a?(String)
   end
 end
 
-RSpec.shared_examples_for 'a Version module' do |version_mod|
-  it 'is introspectable' do
-    aggregate_failures 'introspectable api' do
+RSpec.shared_examples_for("a 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_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[major minor patch pre]))
+      expect(version_mod.to_a).to(be_a(Array))
+    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_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[major minor patch pre])
-      expect(version_mod.to_a).to be_a(Array)
+      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

@@ -0,0 +1,23 @@
+# 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")
+      segs = RUBY_VER.segments
+      major.to_i == segs[0] &&
+        minor.to_i == segs[1] &&
+        ::RUBY_ENGINE == engine
+    end
+    module_function :actual_minor_version?
+  end
+end

data/lib/version_gem/version.rb

@@ -2,11 +2,13 @@
 
 module VersionGem
   module Version
-    VERSION = '1.1.0'.freeze
+    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

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'version_gem/version'
-require_relative 'version_gem/basic'
+require_relative "version_gem/version"
+require_relative "version_gem/basic"
+require_relative "version_gem/epoch"
 
+# Namespace of this library
 module VersionGem
 end
 

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: version_gem
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.8
 platform: ruby
 authors:
 - Peter Boling
-autorequire: 
-bindir: exe
-cert_chain: []
-date: 2022-06-24 00:00:00.000000000 Z
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
+  ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
+  DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+  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
+  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: 2025-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
-  name: rubocop-lts
+  name: rspec-block_is_expected
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 8.0.2
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 8.0.2
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: stone_checksums
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        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
@@ -116,23 +116,32 @@ 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
 - lib/version_gem/version.rb
-- sig/version_gem.rbs
-homepage: https://github.com/pboling/version_gem
+homepage: https://gitlab.com/oauth-xx/version_gem
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/pboling/version_gem
-  source_code_uri: https://github.com/pboling/version_gem/tree/v1.1.0
-  changelog_uri: https://github.com/pboling/version_gem/blob/v1.1.0/CHANGELOG.md
-  bug_tracker_uri: https://github.com/pboling/version_gem/issues
-  documentation_uri: https://www.rubydoc.info/gems/version_gem/1.1.0
-  wiki_uri: https://github.com/pboling/version_gem/wiki
+  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.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
@@ -146,8 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
-signing_key: 
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Enhance your VERSION! Sugar for Version modules.
 test_files: []

data/sig/version_gem.rbs

@@ -1,4 +0,0 @@
-module VersionGem
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end