Fix compatibility with Ruby 2.2 (#2)

* 🔥 Remove appraisal gemfile locks * 👷 Normalize names of status checks * 👷 Ruby 2.2 need rubygems update - rubygems: "2.7.11" - bundler: "1.17.3" * 👷 Set coverage expectations to 61/50 line/branch * 👷 Normalize heads and current workflows * 👷 Normalize coverage and current workflows * 🐛 Ruby 2.2 compatibility * 👷 Normalize coverage and style workflows * 👷 Prevent premature loading of code coverage gems * 📝 Documentation * 👷 Prevent premature loading of code coverage gems * 👷 Coverage enforcement @ 60/50 line/branch
pboling · Feb 22, 2025 · df8efa6 · df8efa6
1 parent bd19d4e
commit df8efa6
Show file tree

Hide file tree

Showing 39 changed files with 117 additions and 936 deletions.
diff --git a/.envrc b/.envrc
@@ -21,7 +21,7 @@ export K_SOUP_COV_DO=true # Means you want code coverage
 export K_SOUP_COV_COMMAND_NAME="RSpec Coverage"
 export K_SOUP_COV_FORMATTERS="html,tty"
 export K_SOUP_COV_MIN_BRANCH=50 # Means you want to enforce X% branch coverage
-export K_SOUP_COV_MIN_LINE=61 # Means you want to enforce X% line coverage
+export K_SOUP_COV_MIN_LINE=60 # Means you want to enforce X% line coverage
 export K_SOUP_COV_MIN_HARD=true # Means you want the build to fail if the coverage thresholds are not met
 export K_SOUP_COV_MULTI_FORMATTERS=true
 export MAX_ROWS=1 # Setting for simplecov-console gem for tty output, limits to the worst N rows of bad coverage

diff --git a/.github/workflows/ancient.yml b/.github/workflows/ancient.yml
@@ -31,23 +31,23 @@ jobs:
       matrix:
         include:
           # Ruby 2.3
-          - ruby: "2.3"
+          - ruby: "ruby-2.3"
             appraisal: "ruby-2-3"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"
             rubygems: "3.3.27"
             bundler: "2.3.27"
 
           # Ruby 2.4
-          - ruby: "2.4"
+          - ruby: "ruby-2.4"
             appraisal: "ruby-2-4"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"
             rubygems: "3.3.27"
             bundler: "2.3.27"
 
           # Ruby 2.5
-          - ruby: "2.5"
+          - ruby: "ruby-2.5"
             appraisal: "ruby-2-5"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"

diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -1,8 +1,8 @@
 name: Test Coverage
 
 env:
-  K_SOUP_COV_MIN_BRANCH: 100
-  K_SOUP_COV_MIN_LINE: 100
+  K_SOUP_COV_MIN_BRANCH: 50
+  K_SOUP_COV_MIN_LINE: 60
   K_SOUP_COV_MIN_HARD: true
   K_SOUP_COV_DO: true
   K_SOUP_COV_COMMAND_NAME: "RSpec Coverage"
@@ -29,8 +29,8 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  test:
-    name: Specs with Coverage ${{ matrix.ruby }} ${{ matrix.name_extra || '' }}
+  coverage:
+    name: Code Coverage on ${{ matrix.ruby }}@current
     if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
@@ -41,7 +41,7 @@ jobs:
       matrix:
         include:
           # Coverage
-          - ruby: "3.4"
+          - ruby: "ruby"
             appraisal: "coverage"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"
@@ -74,11 +74,11 @@ jobs:
       # Raw `bundle` will use the BUNDLE_GEMFILE set to matrix.gemfile (i.e. Appraisal.root)
       # We need to do this first to get appraisal installed.
       # NOTE: This does not use the main Gemfile at all.
-      - name: Bundle install for Appraisal ${{ matrix.appraisal }}
+      - name: Install Root Appraisal
         run: bundle
-      - name: Install Appraisal ${{ matrix.appraisal }} dependencies
+      - name: Appraisal for ${{ matrix.appraisal }}
         run: bundle exec appraisal ${{ matrix.appraisal }} bundle
-      - name: Run ${{ matrix.appraisal }} tests via ${{ matrix.exec_cmd }}
+      - name: Tests for ${{ matrix.ruby }}@current via ${{ matrix.exec_cmd }}
         run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec ${{ matrix.exec_cmd }}
 
       - name: CodeClimate Post-build Notification

diff --git a/.github/workflows/current.yml b/.github/workflows/current.yml
@@ -27,7 +27,7 @@ concurrency:
 
 jobs:
   test:
-    name: Specs ${{ matrix.ruby }}@${{ matrix.name_extra || '' }}
+    name: Specs ${{ matrix.ruby }}@${{ matrix.appraisal }}
     if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
@@ -38,30 +38,29 @@ jobs:
         include:
           # Ruby 3.4
           - ruby: "ruby"
-            appraisal: "ruby-current"
+            appraisal: "current"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"
             rubygems: latest
             bundler: latest
-            name_extra: "ruby-3.4" # NOTE: This will become out of date!
 
-          # truffleruby-24.1 (targets Ruby 3.3.5 compatibility)
+          # truffleruby-24.1
+          #   (according to documentation: targets Ruby 3.3 compatibility)
+          #   (according to runtime: targets Ruby 3.2 compatibility)
           - ruby: "truffleruby"
-            appraisal: "ruby-current"
+            appraisal: "current"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"
             rubygems: default
             bundler: default
-            name_extra: "truffleruby-24.1" # NOTE: This will become out of date!
 
           # jruby-9.4 (targets Ruby 3.1 compatibility)
           - ruby: "jruby"
-            appraisal: "ruby-current"
+            appraisal: "current"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"
             rubygems: default
             bundler: default
-            name_extra: "jruby-9.4" # NOTE: This will become out of date!
 
     steps:
       - name: Checkout
@@ -80,7 +79,7 @@ jobs:
       # NOTE: This does not use the main Gemfile at all.
       - name: Install Root Appraisal
         run: bundle
-      - name: Appraisal for ${{ matrix.appraisal }}
+      - name: Appraisal for ${{ matrix.ruby }}@${{ matrix.appraisal }}
         run: bundle exec appraisal ${{ matrix.appraisal }} bundle
-      - name: Tests for ${{ matrix.ruby }}@${{ matrix.name_extra }} via ${{ matrix.exec_cmd }}
+      - name: Tests for ${{ matrix.ruby }}@${{ matrix.appraisal }} via ${{ matrix.exec_cmd }}
         run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec ${{ matrix.exec_cmd }}
diff --git a/.github/workflows/heads.yml b/.github/workflows/heads.yml
@@ -26,7 +26,7 @@ concurrency:
 
 jobs:
   test:
-    name: Specs ${{ matrix.ruby }} ${{ matrix.appraisal }}${{ matrix.name_extra || '' }}
+    name: Specs ${{ matrix.ruby }}@${{ matrix.appraisal }}${{ matrix.name_extra || '' }}
     if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
@@ -39,23 +39,23 @@ jobs:
           # NOTE: Heads use default rubygems / bundler; their defaults are custom, unreleased, and from the future!
           # ruby-head
           - ruby: "ruby-head"
-            appraisal: "ruby-head"
+            appraisal: "head"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"
             rubygems: default
             bundler: default
 
           # truffleruby-head
           - ruby: "truffleruby-head"
-            appraisal: "truffleruby-head"
+            appraisal: "head"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"
             rubygems: default
             bundler: default
 
           # jruby-head
           - ruby: "jruby-head"
-            appraisal: "jruby-head"
+            appraisal: "head"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"
             rubygems: default
@@ -78,7 +78,7 @@ jobs:
       # NOTE: This does not use the main Gemfile at all.
       - name: Install Root Appraisal
         run: bundle
-      - name: Appraisal for ${{ matrix.appraisal }}
+      - name: Appraisal for ${{ matrix.ruby }}@${{ matrix.appraisal }}
         run: bundle exec appraisal ${{ matrix.appraisal }} bundle
-      - name: Tests for ${{ matrix.ruby }} via ${{ matrix.exec_cmd }}
+      - name: Tests for ${{ matrix.ruby }}@${{ matrix.appraisal }} via ${{ matrix.exec_cmd }}
         run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec ${{ matrix.exec_cmd }}
diff --git a/.github/workflows/hoary.yml b/.github/workflows/hoary.yml
@@ -32,7 +32,7 @@ jobs:
       matrix:
         include:
           # Ruby 2.2
-          - ruby: "2.2"
+          - ruby: "ruby-2.2"
             appraisal: "ruby-2-2"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"

diff --git a/.github/workflows/legacy.yml b/.github/workflows/legacy.yml
@@ -37,7 +37,7 @@ jobs:
       matrix:
         include:
           # Ruby 3.0
-          - ruby: "3.0"
+          - ruby: "ruby-3.0"
             appraisal: "ruby-3-0"
             exec_cmd: "rake spec"
             gemfile: "Appraisal.root"

diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml
@@ -23,7 +23,7 @@ concurrency:
 
 jobs:
   rubocop:
-    name: RuboCop Gradual
+    name: Style on ${{ matrix.ruby }}@current
     if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
     runs-on: ubuntu-latest
     continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
@@ -34,7 +34,7 @@ jobs:
       matrix:
         include:
           # Style
-          - ruby: "3.4"
+          - ruby: "ruby"
             appraisal: "style"
             exec_cmd: "rake rubocop_gradual:check"
             gemfile: "Appraisal.root"
@@ -56,9 +56,9 @@ jobs:
       # Raw `bundle` will use the BUNDLE_GEMFILE set to matrix.gemfile (i.e. Appraisal.root)
       # We need to do this first to get appraisal installed.
       # NOTE: This does not use the main Gemfile at all.
-      - name: Bundle install for Appraisal ${{ matrix.appraisal }}
+      - name: Install Root Appraisal
         run: bundle
-      - name: Install Appraisal ${{ matrix.appraisal }} dependencies
+      - name: Appraisal for ${{ matrix.appraisal }}
         run: bundle exec appraisal ${{ matrix.appraisal }} bundle
-      - name: Run ${{ matrix.appraisal }} tests via ${{ matrix.exec_cmd }}
+      - name: Run ${{ matrix.appraisal }} checks via ${{ matrix.exec_cmd }}
         run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec ${{ matrix.exec_cmd }}
diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,10 @@
 # rspec failure tracking
 .rspec_status
 
+# IDEs
+/.idea/
+
+# Packaging Artifacts
 *.gem
 gemfiles/*.gemfile.lock
 Appraisal.*.gemfile.lock
diff --git a/.rubocop_gradual.lock b/.rubocop_gradual.lock
diff --git a/Appraisals b/Appraisals
@@ -1,5 +1,25 @@
 # frozen_string_literal: true
 
+# HOW TO UPDATE APPRAISALS:
+#   BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
+#   BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
+
+# Used for head (nightly) releases of ruby, truffleruby, and jruby.
+# Split into discrete appraisals if one of them needs a dependency locked discretely.
+appraise "head" do
+  gem "mutex_m", ">= 0.2"
+  gem "stringio", ">= 3.0"
+  remove_gem "appraisal" # only present because it must be in the gemfile because we target a git branch
+end
+
+# Used for current releases of ruby, truffleruby, and jruby.
+# Split into discrete appraisals if one of them needs a dependency locked discretely.
+appraise "current" do
+  gem "mutex_m", ">= 0.2"
+  gem "stringio", ">= 3.0"
+  remove_gem "appraisal" # only present because it must be in the gemfile because we target a git branch
+end
+
 appraise "ruby-2-2" do
   remove_gem "appraisal" # only present because it must be in the gemfile because we target a git branch
 end
@@ -52,12 +72,6 @@ appraise "ruby-3-3" do
   remove_gem "appraisal" # only present because it must be in the gemfile because we target a git branch
 end
 
-appraise "ruby-current" do
-  gem "mutex_m", ">= 0.2"
-  gem "stringio", ">= 3.0"
-  remove_gem "appraisal" # only present because it must be in the gemfile because we target a git branch
-end
-
 # Only run security audit on latest Ruby version
 appraise "audit" do
   gem "mutex_m", "~> 0.2"
@@ -81,21 +95,3 @@ appraise "style" do
   eval_gemfile "modular/style.gemfile"
   remove_gem "appraisal" # only present because it must be in the gemfile because we target a git branch
 end
-
-appraise "ruby-head" do
-  gem "mutex_m", ">= 0.2"
-  gem "stringio", ">= 3.0"
-  remove_gem "appraisal" # only present because it must be in the gemfile because we target a git branch
-end
-
-appraise "truffleruby-head" do
-  gem "mutex_m", ">= 0.2"
-  gem "stringio", ">= 3.0"
-  remove_gem "appraisal" # only present because it must be in the gemfile because we target a git branch
-end
-
-appraise "jruby-head" do
-  gem "mutex_m", ">= 0.2"
-  gem "stringio", ">= 3.0"
-  remove_gem "appraisal" # only present because it must be in the gemfile because we target a git branch
-end
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -126,6 +126,10 @@ GEM
     rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
+    rspec-pending_for (0.1.16)
+      rspec-core
+      ruby_engine (>= 1, < 3)
+      ruby_version (~> 1.0)
     rspec-stubbed_env (1.0.1)
     rspec-support (3.13.2)
     rubocop (1.71.2)
@@ -174,6 +178,8 @@ GEM
     rubocop-thread_safety (0.6.0)
       rubocop (>= 1.48.1)
     ruby-progressbar (1.13.0)
+    ruby_engine (2.0.3)
+    ruby_version (1.0.3)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -243,10 +249,12 @@ DEPENDENCIES
   reek (~> 6.4)
   rspec (~> 3.13)
   rspec-block_is_expected (~> 1.0)
+  rspec-pending_for (~> 0.1, >= 0.1.16)
   rspec-stubbed_env (~> 1.0, >= 1.0.1)
   rubocop-lts (~> 8.1, >= 8.1.1)
   rubocop-packaging (~> 0.5, >= 0.5.2)
   rubocop-rspec (~> 3.2)
+  simplecov
   standard (>= 1.35.1, != 1.42.0, != 1.41.1)
   yard (~> 0.9, >= 0.9.37)
   yard-junk (~> 0.0, >= 0.0.10)

diff --git a/README.md b/README.md
@@ -14,6 +14,11 @@ It is different from, and improves on, the standard rake task in that it:
 - does various checks to ensure the generated checksums will be valid
 - does `git commit` the generated checksums
 
+The script accomplishes the same thing if you prefer that:
+```shell
+gem_checksums
+```
+
 ## Installation
 
 Install the gem and add to the gem's Gemfile by executing:
@@ -47,6 +52,12 @@ This gem ships an improved version as `build:checksums`, based on the
 rake build:checksums
 ```
 
+Or...
+
+```shell
+gem_checksums
+```
+
 Generating checksums makes sense when you are building and releasing a gem, so how does it fit into that process?
 
 ### How To: Release gem with checksums generated by `gem_checksums`

diff --git a/gem_checksums.gemspec b/gem_checksums.gemspec
@@ -72,6 +72,7 @@ Gem::Specification.new do |spec|
   # Tests
   spec.add_development_dependency("rspec", "~> 3.13")                         # ruby >= 0
   spec.add_development_dependency("rspec-block_is_expected", "~> 1.0")        # ruby >= 1.8.7
+  spec.add_development_dependency("rspec-pending_for", "~> 0.1", ">= 0.1.16") # ruby >= 1.8.7
   spec.add_development_dependency("rspec-stubbed_env", "~> 1.0", ">= 1.0.1")  # Ruby >= 1.8.7
 
   # Development Tasks