Use Appraisal in CI

Appraisal allows us to test with different versions of gems. In addition to GitHub Actions' matrix functionality, we can use this to test against different combinations of Ruby and Rails versions. As part of this, we've also made the following changes to our CI pipeline: Rename Appraisal rails-head to rails-main Loosen version constraints to minor versions Use setup-ruby's caching mechanism Means we don't need to configure vendor/bundle as the path here. We should probably do this for other workflows too. Don't trigger CI twice on PRs Co-authored-by: Simon Fish <[email protected]>
ViewComponent · Dec 17, 2023 · d1d26ad · d1d26ad
1 parent 1b3747b
commit d1d26ad
Show file tree

Hide file tree

Showing 12 changed files with 113 additions and 55 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,6 +1,10 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  pull_request:
+  push:
+    branches:
+      - main
 
 jobs:
   benchmark:
@@ -22,59 +26,34 @@ jobs:
         bundle exec rake partial_benchmark
         bundle exec rake translatable_benchmark
   test:
+    name: test (${{ matrix.rails_version }}, ${{ matrix.ruby_version }}, ${{ matrix.mode }})
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        include:
-          - rails_version: "6.1.4.4"
-            ruby_version: "3.0"
-            mode: "capture_patch_enabled"
-          - rails_version: "7.0.2.3"
-            ruby_version: "3.0"
-            mode: "capture_patch_enabled"
-          - rails_version: "main"
-            ruby_version: "3.1"
-            mode: "capture_patch_enabled"
-          - rails_version: "7.1.1"
-            ruby_version: "3.2"
-            mode: "capture_patch_enabled"
-          - rails_version: "main"
-            ruby_version: "3.2"
-            mode: "capture_patch_enabled"
-          - rails_version: "6.1.4.4"
-            ruby_version: "3.0"
-            mode: "capture_patch_disabled"
-          - rails_version: "7.0.2.3"
-            ruby_version: "3.0"
-            mode: "capture_patch_disabled"
-          - rails_version: "main"
-            ruby_version: "3.1"
-            mode: "capture_patch_disabled"
-          - rails_version: "7.1.1"
-            ruby_version: "3.2"
-            mode: "capture_patch_disabled"
-          - rails_version: "main"
-            ruby_version: "3.2"
-            mode: "capture_patch_disabled"
+        rails_version: ["6.1", "7.0", "7.1", "main"]
+        ruby_version: ["3.0", "3.1", "3.2"]
+        mode: ["capture_patch_enabled", "capture_patch_disabled"]
+    env:
+      BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.rails_version }}.gemfile
     steps:
     - uses: actions/[email protected]
     - name: Setup Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby_version }}
+        bundler-cache: true
     - uses: actions/cache@v3
       with:
         path: vendor/bundle
-        key: gems-build-rails-${{ matrix.rails_version }}-ruby-${{ matrix.ruby_version }}-${{ hashFiles('**/Gemfile.lock') }}
+        key: gems-build-rails-${{ matrix.rails_version }}-ruby-${{ matrix.ruby_version }}-${{ hashFiles('**/gemfiles/rails_${{ matrix.rails_version }}.gemfile.lock') }}
     - name: Build and test with Rake
+      # Code-reloading isn't compatible with simplecov, so we need to run once
+      # to collect coverage, and again to test reloads.
       run: |
-        bundle config path vendor/bundle
-        bundle update
-        # Code-reloading isn't compatible with simplecov, so we need to run once
-        # to collect coverage, and again to test reloads.
-        MEASURE_COVERAGE=true bundle exec rake test spec
-        ENABLE_RELOADING=true bundle exec rake test spec
+        bundle exec appraisal rails-${{ matrix.rails_version }} bundle
+        MEASURE_COVERAGE=true bundle exec appraisal rails-${{ matrix.rails_version }} rake
+        ENABLE_RELOADING=true  bundle exec appraisal rails-${{ matrix.rails_version }} rake
       env:
         RAISE_ON_WARNING: 1
         RAILS_VERSION: ${{ matrix.rails_version }}
@@ -83,7 +62,7 @@ jobs:
       uses: actions/[email protected]
       if: always()
       with:
-        name: simplecov-resultset-rails${{matrix.rails_version}}-ruby${{matrix.ruby_version}}
+        name: simplecov-resultset-rails${{ matrix.rails_version }}-ruby${{ matrix.ruby_version }}
         path: coverage
   primer_view_components_compatibility:
     name: Test compatibility with Primer ViewComponents (main)

diff --git a/Appraisals b/Appraisals
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 appraise "rails-6.1" do
-  gem "rails", "~> 6.1.0"
+  gem "rails", "~> 6.1"
   gem "tailwindcss-rails", "~> 2.0"
 
   # Required for Ruby 3.1.0
@@ -11,16 +11,16 @@ appraise "rails-6.1" do
 end
 
 appraise "rails-7.0" do
-  gem "rails", "~> 7.0.0"
+  gem "rails", "~> 7.0"
   gem "tailwindcss-rails", "~> 2.0"
 end
 
 appraise "rails-7.1" do
-  gem "rails", "~> 7.1.0"
+  gem "rails", "~> 7.1"
   gem "tailwindcss-rails", "~> 2.0"
 end
 
-appraise "rails-head" do
+appraise "rails-main" do
   gem "rails", github: "rails/rails", branch: "main"
   gem "tailwindcss-rails", "~> 2.0"
 end
diff --git a/Gemfile b/Gemfile
@@ -18,6 +18,10 @@ group :test do
   gem "selenium-webdriver", "4.9.0" # 4.9.1 requires Ruby 3+
 end
 
+group :development, :test do
+  gem "appraisal", "~> 2.5"
+end
+
 if RUBY_VERSION >= "3.1"
   gem "net-imap", require: false
   gem "net-pop", require: false

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -320,7 +320,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal (~> 2.4)
+  appraisal (~> 2.5)
   benchmark-ips (~> 2.12.0)
   better_html
   bundler (~> 2)

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -10,6 +10,10 @@ nav_order: 5
 
 ## main
 
+* Update CI configuration to use `Appraisal`.
+
+    *Hans Lemuet, Simon Fish*
+
 * Resolve console warnings when running test suite.
 
     *Joel Hawksley*

diff --git a/gemfiles/rails_5.2.gemfile b/gemfiles/rails_5.2.gemfile
@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "capybara", "~> 3"
+gem "rails", "~> 5.2.0"
+gem "rspec-rails", "~> 5"
+
+group :test do
+  gem "cuprite", "~> 0.8"
+  gem "puma", "~> 5"
+  gem "selenium-webdriver", "~> 4"
+end
+
+group :development, :test do
+  gem "appraisal", github: "thoughtbot/appraisal"
+end
+
+gemspec path: "../"
diff --git a/gemfiles/rails_6.0.gemfile b/gemfiles/rails_6.0.gemfile
@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "capybara", "~> 3"
+gem "rails", "~> 6.0.0"
+gem "rspec-rails", "~> 5"
+gem "tailwindcss-rails", "~> 2.0"
+
+group :test do
+  gem "cuprite", "~> 0.8"
+  gem "puma", "~> 5"
+  gem "selenium-webdriver", "~> 4"
+end
+
+group :development, :test do
+  gem "appraisal", github: "thoughtbot/appraisal"
+end
+
+gemspec path: "../"
diff --git a/gemfiles/rails_6.1.gemfile b/gemfiles/rails_6.1.gemfile
@@ -3,18 +3,23 @@
 source "https://rubygems.org"
 
 gem "capybara", "~> 3"
-gem "rails", "~> 6.1.0"
+gem "rails", "~> 6.1"
 gem "rspec-rails", "~> 5"
-gem "debug"
-gem "tailwindcss-rails", "~> 2.0"
-gem "net-smtp", require: false
 gem "net-imap", require: false
 gem "net-pop", require: false
+gem "net-smtp", require: false
+gem "debug"
+gem "tailwindcss-rails", "~> 2.0"
 
 group :test do
-  gem "cuprite", "~> 0.8"
+  gem "cuprite", "~> 0.15"
   gem "puma", "~> 6"
+  gem "warning"
   gem "selenium-webdriver", "4.9.0"
 end
 
+group :development, :test do
+  gem "appraisal", github: "thoughtbot/appraisal"
+end
+
 gemspec path: "../"
diff --git a/gemfiles/rails_7.0.gemfile b/gemfiles/rails_7.0.gemfile
@@ -3,15 +3,23 @@
 source "https://rubygems.org"
 
 gem "capybara", "~> 3"
-gem "rails", "~> 7.0.0"
+gem "rails", "~> 7.0"
 gem "rspec-rails", "~> 5"
+gem "net-imap", require: false
+gem "net-pop", require: false
+gem "net-smtp", require: false
 gem "debug"
 gem "tailwindcss-rails", "~> 2.0"
 
 group :test do
-  gem "cuprite", "~> 0.8"
+  gem "cuprite", "~> 0.15"
   gem "puma", "~> 6"
+  gem "warning"
   gem "selenium-webdriver", "4.9.0"
 end
 
+group :development, :test do
+  gem "appraisal", github: "thoughtbot/appraisal"
+end
+
 gemspec path: "../"
diff --git a/gemfiles/rails_7.1.gemfile b/gemfiles/rails_7.1.gemfile
@@ -3,15 +3,23 @@
 source "https://rubygems.org"
 
 gem "capybara", "~> 3"
-gem "rails", "~> 7.1.0"
+gem "rails", "~> 7.1"
 gem "rspec-rails", "~> 5"
+gem "net-imap", require: false
+gem "net-pop", require: false
+gem "net-smtp", require: false
 gem "debug"
 gem "tailwindcss-rails", "~> 2.0"
 
 group :test do
-  gem "cuprite", "~> 0.8"
+  gem "cuprite", "~> 0.15"
   gem "puma", "~> 6"
+  gem "warning"
   gem "selenium-webdriver", "4.9.0"
 end
 
+group :development, :test do
+  gem "appraisal", github: "thoughtbot/appraisal"
+end
+
 gemspec path: "../"
diff --git a/gemfiles/rails_head.gemfile → gemfiles/rails_main.gemfile b/gemfiles/rails_head.gemfile → gemfiles/rails_main.gemfile
@@ -5,13 +5,21 @@ source "https://rubygems.org"
 gem "capybara", "~> 3"
 gem "rails", github: "rails/rails", branch: "main"
 gem "rspec-rails", "~> 5"
+gem "net-imap", require: false
+gem "net-pop", require: false
+gem "net-smtp", require: false
 gem "debug"
 gem "tailwindcss-rails", "~> 2.0"
 
 group :test do
-  gem "cuprite", "~> 0.8"
+  gem "cuprite", "~> 0.15"
   gem "puma", "~> 6"
+  gem "warning"
   gem "selenium-webdriver", "4.9.0"
 end
 
+group :development, :test do
+  gem "appraisal", github: "thoughtbot/appraisal"
+end
+
 gemspec path: "../"
diff --git a/lib/view_component/test_helpers.rb b/lib/view_component/test_helpers.rb
@@ -252,15 +252,18 @@ def __vc_test_helpers_build_controller(klass)
 
     def __vc_test_helpers_preview_class
       result = if respond_to?(:described_class)
+        # :nocov:
         raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
 
         "#{described_class}Preview"
+        # :nocov:
       else
         self.class.name.gsub("Test", "Preview")
       end
       result = result.constantize
     rescue NameError
       raise NameError, "`render_preview` expected to find #{result}, but it does not exist."
     end
+    # :nocov:
   end
 end