version_gem 1.1.8 → 1.1.9

data/RUBOCOP.md

@@ -0,0 +1,71 @@
+# RuboCop Usage Guide
+
+## Overview
+
+A tale of two RuboCop plugin gems.
+
+### RuboCop Gradual
+
+This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
+
+### RuboCop LTS
+
+This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
+RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
+
+## Checking RuboCop Violations
+
+To check for RuboCop violations in this project, always use:
+
+```bash
+bundle exec rake rubocop_gradual:check
+```
+
+**Do not use** the standard RuboCop commands like:
+- `bundle exec rubocop`
+- `rubocop`
+
+## Understanding the Lock File
+
+The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
+
+1. Prevent new violations while gradually fixing existing ones
+2. Track progress on code style improvements
+3. Ensure CI builds don't fail due to pre-existing violations
+
+## Common Commands
+
+- **Check violations**
+    - `bundle exec rake rubocop_gradual`
+    - `bundle exec rake rubocop_gradual:check`
+- **(Safe) Autocorrect violations, and update lockfile if no new violations**
+  - `bundle exec rake rubocop_gradual:autocorrect`
+- **Force update the lock file (w/o autocorrect) to match violations present in code**
+  - `bundle exec rake rubocop_gradual:force_update`
+
+## Workflow
+
+1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
+   a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
+2. If there are new violations, either:
+   - Fix them in your code
+   - Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
+3. Commit the updated `.rubocop_gradual.lock` file along with your changes
+
+## Never add inline RuboCop disables
+
+Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
+
+- Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
+- Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
+  - `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
+  - If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
+
+In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
+
+## Benefits of rubocop_gradual
+
+- Allows incremental adoption of code style rules
+- Prevents CI failures due to pre-existing violations
+- Provides a clear record of code style debt
+- Enables focused efforts on improving code quality over time

data/lib/version_gem/version.rb

@@ -2,7 +2,7 @@
 
 module VersionGem
   module Version
-    VERSION = "1.1.8"
+    VERSION = "1.1.9"
     # 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.

data/sig/all_formatters.rbs

@@ -0,0 +1 @@
+ALL_FORMATTERS: bool

data/sig/debug.rbs

@@ -0,0 +1 @@
+DEBUG: bool

data/sig/debug_ide.rbs

@@ -0,0 +1 @@
+DEBUG_IDE: bool

data/sig/debug_jruby.rbs

@@ -0,0 +1 @@
+DEBUG_JRUBY: bool

data/sig/debugging.rbs

@@ -0,0 +1 @@
+DEBUGGING: bool

data/sig/run_coverage.rbs

@@ -0,0 +1 @@
+RUN_COVERAGE: bool

data/sig/version_gem/api.rbs

@@ -0,0 +1,27 @@
+module VersionGem
+  module Api
+    # Internal memoized version string segments
+    @_to_a: Array[String]
+
+    # Memoized components
+    @major: Integer
+    @minor: Integer
+    @patch: Integer
+    @pre: String?
+    @to_a: Array[Integer | String | nil]
+    @to_h: Hash[Symbol, (Integer | String | nil)]
+
+    # Public API
+    def to_s: () -> String
+    def major: () -> Integer
+    def minor: () -> Integer
+    def patch: () -> Integer
+    def pre: () -> String?
+    def to_a: () -> Array[Integer | String | nil]
+    def to_h: () -> Hash[Symbol, (Integer | String | nil)]
+
+    private
+
+    def _to_a: () -> Array[String]
+  end
+end

data/sig/version_gem/basic.rbs

@@ -0,0 +1,5 @@
+module VersionGem
+  module Basic
+    def self.extended: () -> void
+  end
+end

data/sig/version_gem/epoch.rbs

@@ -0,0 +1,26 @@
+module VersionGem
+  module Epoch
+    EPOCH_SIZE: Integer
+
+    # Hook used when this module is extended
+    def self.extended: (untyped) -> void
+
+    module OverloadApiForEpoch
+      # The epoch component (derived)
+      def epoch: () -> Integer
+
+      # Override of Api#major returning the derived major component
+      def major: () -> Integer
+
+      # Hash representation including epoch
+      def to_h: () -> Hash[Symbol, (Integer | String | nil)]
+
+      # Array of components [epoch, major, minor, patch, pre]
+      def to_a: () -> Array[Integer | String | nil]
+
+      private
+
+      def _major: () -> Integer
+    end
+  end
+end

data/sig/version_gem/error.rbs

@@ -0,0 +1,4 @@
+module VersionGem
+  class Error < ::RuntimeError
+  end
+end

data/sig/version_gem/ruby.rbs

@@ -0,0 +1,11 @@
+module VersionGem
+  module Ruby
+    RUBY_VER: ::Gem::Version
+
+    # Check if the current Ruby version is >= given version for the engine
+    def self.gte_minimum_version?: (String, ?String) -> bool
+
+    # Check if the current Ruby MAJOR.MINOR equals the given values for the engine
+    def self.actual_minor_version?: ((Integer | String), (Integer | String), ?String) -> bool
+  end
+end

data/sig/version_gem/version.rbs

@@ -0,0 +1,9 @@
+module VersionGem
+  module Version
+    VERSION: String
+
+    # At runtime this module is extended with Basic via class_eval in lib/version_gem.rb
+    # Declare the intended extension so class methods are available in typing
+    extend VersionGem::Basic
+  end
+end

data/sig/version_gem.rbs

@@ -0,0 +1,2 @@
+module VersionGem
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: version_gem
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.9
 platform: ruby
 authors:
 - Peter Boling
@@ -35,36 +35,42 @@ cert_chain:
   DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
   L9nRqA==
   -----END CERTIFICATE-----
-date: 2025-05-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: kettle-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
-  name: rspec-block_is_expected
+  name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +85,88 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: require_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: appraisal2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: kettle-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-pending_for
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.17
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.17
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: stone_checksums
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +174,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -93,25 +184,56 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Versions are good. Versions are cool. Versions will win.
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: gitmoji-regex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: "\U0001F516 Versions are good. Versions are cool. Versions will win."
 email:
-- peter.boling@gmail.com
+- floss@galtzo.com
 - oauth-ruby@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
+- CITATION.cff
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- FUNDING.md
 - LICENSE.txt
 - README.md
+- REEK
+- RUBOCOP.md
 - SECURITY.md
 files:
 - CHANGELOG.md
+- CITATION.cff
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- FUNDING.md
 - LICENSE.txt
 - README.md
+- REEK
+- RUBOCOP.md
 - SECURITY.md
 - lib/version_gem.rb
 - lib/version_gem/api.rb
@@ -121,24 +243,41 @@ files:
 - lib/version_gem/rspec.rb
 - lib/version_gem/ruby.rb
 - lib/version_gem/version.rb
-homepage: https://gitlab.com/oauth-xx/version_gem
+- sig/all_formatters.rbs
+- sig/debug.rbs
+- sig/debug_ide.rbs
+- sig/debug_jruby.rbs
+- sig/debugging.rbs
+- sig/run_coverage.rbs
+- sig/version_gem.rbs
+- sig/version_gem/api.rbs
+- sig/version_gem/basic.rbs
+- sig/version_gem/epoch.rbs
+- sig/version_gem/error.rbs
+- sig/version_gem/ruby.rbs
+- sig/version_gem/version.rbs
+homepage: https://github.com/ruby-oauth/version_gem
 licenses:
 - MIT
 metadata:
-  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
+  homepage_uri: https://version-gem.galtzo.com/
+  source_code_uri: https://github.com/ruby-oauth/version_gem/tree/v1.1.9
+  changelog_uri: https://github.com/ruby-oauth/version_gem/blob/v1.1.9/CHANGELOG.md
+  bug_tracker_uri: https://github.com/ruby-oauth/version_gem/issues
+  documentation_uri: https://www.rubydoc.info/gems/version_gem/1.1.9
+  funding_uri: https://github.com/sponsors/pboling
+  wiki_uri: https://github.com/ruby-oauth/version_gem/wiki
   mailing_list_uri: https://groups.google.com/g/oauth-ruby
-  funding_uri: https://liberapay.com/pboling
+  news_uri: https://www.railsbling.com/tags/version_gem
+  discord_uri: https://discord.gg/3qme4XHNKN
   rubygems_mfa_required: 'true'
 rdoc_options:
 - "--title"
-- version_gem - Enhance your VERSION! Sugar for Version modules.
+- "version_gem - \U0001F516 Enhance your VERSION! Sugar for Version modules."
 - "--main"
 - README.md
+- "--exclude"
+- "^sig/"
 - "--line-numbers"
 - "--inline-source"
 - "--quiet"
@@ -155,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.7.1
 specification_version: 4
-summary: Enhance your VERSION! Sugar for Version modules.
+summary: "\U0001F516 Enhance your VERSION! Sugar for Version modules."
 test_files: []