Merge pull request #2498 from ViewComponent/2476-support-rails-81-for-viewcomponent-v3

Spone · web-flow · commit 73de0ff5b402 · 2025-11-11T21:14:08.000+01:00
Support Rails 8.1 for ViewComponent v3
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -65,6 +65,12 @@ jobs:
           - ruby_version: "3.4"
             rails_version: "8.0"
             mode: "capture_patch_enabled"
+          - ruby_version: "3.4"
+            rails_version: "8.1"
+            mode: "capture_patch_disabled"
+          - ruby_version: "3.4"
+            rails_version: "8.1"
+            mode: "capture_patch_enabled"
           - ruby_version: "3.4"
             rails_version: "main"
             mode: "capture_patch_disabled"
@@ -77,6 +83,12 @@ jobs:
           - ruby_version: "3.5"
             rails_version: "8.0"
             mode: "capture_patch_enabled"
+          - ruby_version: "3.5"
+            rails_version: "8.1"
+            mode: "capture_patch_disabled"
+          - ruby_version: "3.5"
+            rails_version: "8.1"
+            mode: "capture_patch_enabled"
     env:
       BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.rails_version }}.gemfile
     steps:
@@ -105,38 +117,6 @@ jobs:
         name: simplecov-resultset-rails${{matrix.rails_version}}-ruby${{matrix.ruby_version}}-${{matrix.mode}}
         path: coverage
         include-hidden-files: true
-  primer_view_components_compatibility:
-    name: Test compatibility with Primer ViewComponents (main)
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4.1.1
-      with:
-        repository: 'primer/view_components'
-        path: 'primer_view_components'
-    - uses: actions/checkout@v4.1.1
-      with:
-        path: 'view_component'
-    - name: Setup Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.4
-        bundler-cache: true
-        working-directory: 'view_component'
-    - uses: actions/setup-node@v4
-      with:
-        node-version: 20
-        cache: 'npm'
-        cache-dependency-path: 'primer_view_components/package-lock.json'
-    - name: Build and test with Rake
-      run: |
-        cd primer_view_components
-        npm ci
-        cd demo && npm ci && cd ..
-        bundle && bundle exec rake
-      env:
-        VIEW_COMPONENT_PATH: ../view_component
-        RAILS_VERSION: '7.1.1'
-        PARALLEL_WORKERS: '1'
   coverage:
     needs: test
     runs-on: ubuntu-latest
diff --git a/.tool-versions b/.tool-versions
@@ -1 +1 @@
-ruby 3.4.3
+ruby 3.4.7
diff --git a/Appraisals b/Appraisals
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 appraise "rails-6.1" do
-  gem "rails", "~> 6.1"
+  gem "rails", "~> 6.1.0"
   gem "tailwindcss-rails", "~> 2.0"
   gem "sprockets-rails", "~> 3.4.2"
   gem "concurrent-ruby", "1.3.4"
@@ -14,27 +14,33 @@ appraise "rails-6.1" do
 end
 
 appraise "rails-7.0" do
-  gem "rails", "~> 7.0"
+  gem "rails", "~> 7.0.0"
   gem "tailwindcss-rails", "~> 2.0"
   gem "turbo-rails", "~> 1"
   gem "sprockets-rails", "~> 3.4.2"
 end
 
 appraise "rails-7.1" do
-  gem "rails", "~> 7.1"
+  gem "rails", "~> 7.1.0"
   gem "tailwindcss-rails", "~> 2.0"
   gem "turbo-rails", "~> 1"
   gem "sprockets-rails", "~> 3.4.2"
 end
 
 appraise "rails-7.2" do
-  gem "rails", "~> 7.2"
+  gem "rails", "~> 7.2.0"
   gem "tailwindcss-rails", "~> 2.0"
   gem "sprockets-rails", "~> 3.4.2"
 end
 
 appraise "rails-8.0" do
-  gem "rails", "~> 8.0"
+  gem "rails", "~> 8.0.0"
+  gem "tailwindcss-rails", "~> 2.0"
+  gem "propshaft", "~> 1.1.0"
+end
+
+appraise "rails-8.1" do
+  gem "rails", "~> 8.1.0"
   gem "tailwindcss-rails", "~> 2.0"
   gem "propshaft", "~> 1.1.0"
 end
diff --git a/Gemfile b/Gemfile
@@ -8,3 +8,7 @@ gem "rails", (rails_version == "main") ? {git: "https://github.com/rails/rails",
 
 ruby_version = (ENV["RUBY_VERSION"] || "~> 3.4").to_s
 ruby ruby_version
+
+group :development, :test do
+  gem "appraisal-run", "~> 1.0"
+end
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     view_component (3.23.2)
-      activesupport (>= 5.2.0, < 8.1)
+      activesupport (>= 5.2.0, < 8.2)
       concurrent-ruby (~> 1)
       method_source (~> 1.0)
 
@@ -88,6 +88,7 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
+    appraisal-run (1.1.0)
     ast (2.4.3)
     base64 (0.2.0)
     benchmark (0.4.0)
@@ -375,6 +376,7 @@ PLATFORMS
 DEPENDENCIES
   allocation_stats (~> 0.1.5)
   appraisal (~> 2.4)
+  appraisal-run (~> 1.0)
   base64
   benchmark-ips (~> 2.13.0)
   better_html
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -10,6 +10,10 @@ nav_order: 6
 
 ## main
 
+* Add Rails 8.1 support to ViewComponent v3.
+
+    *Hans Lemuet*
+
 ## 3.23.2
 
 * Include .tt files in published gem. Fixes templates not being available when using generators.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -43,11 +43,26 @@ The codespace environment includes a minimal Rails app with ViewComponent instal
 2. Expose the port when prompted by the Visual Studio Code Web Editor.
 3. Add the external URL to the config block in `config/application.rb` as prompted by the error.
 
+## Running tests with Appraisal
+
+This project uses [appraisal](https://github.com/thoughtbot/appraisal) to run tests for various versions of Ruby and Rails, and [appraisal-run](https://github.com/camertron/appraisal-run) to run them in Docker containers.
+
+1. Install the dependencies: `bundle`
+2. Make sure the tests pass: `appraisal-run gemfiles/*.gemfile -- bundle exec rake`
+
+When a new version of Rails is released:
+
+1. Add a new `appraise` block in `Appraisals`.
+2. Run `bundle exec appraisal generate`
+3. Update the gemfiles locks `appraisal-run gemfiles/*.gemfile -- bundle lock`
+4. Make sure the tests pass: `appraisal-run gemfiles/*.gemfile -- bundle exec rake`
+5. Commit and push the changes.
+6. Release a new version.
+
 ## Submitting a pull request
 
 1. [Fork](https://github.com/viewcomponent/view_component/fork) and clone the repository.
-1. Configure and install the dependencies: `bundle exec appraisal install`.
-2. Make sure the tests pass: `bundle exec appraisal rake` (see below for specific cases).
+2. Make sure the tests pass: `appraisal-run gemfiles/*.gemfile -- bundle exec rake`.
 3. Create a new branch: `git checkout -b my-branch-name`.
 4. Add tests, make the change, and make sure the tests still pass.
 5. Add an entry to the top of `docs/CHANGELOG.md` for the changes, no matter how small.
diff --git a/gemfiles/rails_6.1.gemfile b/gemfiles/rails_6.1.gemfile
@@ -2,13 +2,17 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 6.1"
+gem "rails", "~> 6.1.0"
 gem "tailwindcss-rails", "~> 2.0"
+gem "sprockets-rails", "~> 3.4.2"
+gem "concurrent-ruby", "1.3.4"
 gem "net-smtp", require: false
 gem "net-imap", require: false
 gem "net-pop", require: false
 gem "turbo-rails", "~> 1"
-gem "sprockets-rails", "~> 3.4.2"
-gem "concurrent-ruby", "1.3.4"
+
+group :development, :test do
+  gem "appraisal-run", "~> 1.0"
+end
 
 gemspec path: "../"
diff --git a/gemfiles/rails_7.0.gemfile b/gemfiles/rails_7.0.gemfile
@@ -2,9 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 7.0"
+gem "rails", "~> 7.0.0"
 gem "tailwindcss-rails", "~> 2.0"
 gem "turbo-rails", "~> 1"
 gem "sprockets-rails", "~> 3.4.2"
 
+group :development, :test do
+  gem "appraisal-run", "~> 1.0"
+end
+
 gemspec path: "../"
diff --git a/gemfiles/rails_7.1.gemfile b/gemfiles/rails_7.1.gemfile
@@ -2,9 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 7.1"
+gem "rails", "~> 7.1.0"
 gem "tailwindcss-rails", "~> 2.0"
 gem "turbo-rails", "~> 1"
 gem "sprockets-rails", "~> 3.4.2"
 
+group :development, :test do
+  gem "appraisal-run", "~> 1.0"
+end
+
 gemspec path: "../"
diff --git a/gemfiles/rails_7.2.gemfile b/gemfiles/rails_7.2.gemfile
@@ -2,27 +2,12 @@
 
 source "https://rubygems.org"
 
-gem "capybara", "~> 3"
-gem "rails", "~> 7.2"
-gem "rspec-rails", "~> 5"
-gem "net-imap", require: false
-gem "net-pop", require: false
-gem "net-smtp", require: false
-gem "debug"
-
+gem "rails", "~> 7.2.0"
 gem "tailwindcss-rails", "~> 2.0"
-
 gem "sprockets-rails", "~> 3.4.2"
 
-group :test do
-  gem "cuprite", "~> 0.15"
-  gem "puma", "~> 6"
-  gem "warning"
-  gem "selenium-webdriver", "4.9.0"
-end
-
 group :development, :test do
-  gem "appraisal", "~> 2.5"
+  gem "appraisal-run", "~> 1.0"
 end
 
 gemspec path: "../"
diff --git a/gemfiles/rails_8.0.gemfile b/gemfiles/rails_8.0.gemfile
@@ -2,9 +2,12 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 8.0"
+gem "rails", "~> 8.0.0"
 gem "tailwindcss-rails", "~> 2.0"
-gem "turbo-rails", "~> 1"
 gem "propshaft", "~> 1.1.0"
 
+group :development, :test do
+  gem "appraisal-run", "~> 1.0"
+end
+
 gemspec path: "../"
diff --git a/gemfiles/rails_8.1.gemfile b/gemfiles/rails_8.1.gemfile
@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 8.1.0"
+gem "tailwindcss-rails", "~> 2.0"
+gem "propshaft", "~> 1.1.0"
+
+group :development, :test do
+  gem "appraisal-run", "~> 1.0"
+end
+
+gemspec path: "../"
diff --git a/gemfiles/rails_main.gemfile b/gemfiles/rails_main.gemfile
@@ -5,6 +5,9 @@ source "https://rubygems.org"
 gem "rails", github: "rails/rails", branch: "main"
 gem "tailwindcss-rails", "~> 2.0"
 gem "turbo-rails", "~> 1"
-gem "propshaft", "~> 1.1.0"
+
+group :development, :test do
+  gem "appraisal-run", "~> 1.0"
+end
 
 gemspec path: "../"
diff --git a/lib/rails/generators/component/component_generator.rb b/lib/rails/generators/component/component_generator.rb
@@ -22,7 +22,7 @@ class ComponentGenerator < Rails::Generators::NamedBase
       class_option :skip_suffix, type: :boolean, default: false
 
       def create_component_file
-        template "component.rb", File.join(component_path, class_path, "#{file_name}#{options[:skip_suffix] ? "" : "_component"}.rb")
+        template "component.rb", File.join(component_path, class_path, "#{file_name}#{"_component" unless options[:skip_suffix]}.rb")
       end
 
       hook_for :test_framework
diff --git a/lib/view_component/collection.rb b/lib/view_component/collection.rb
@@ -5,6 +5,7 @@
 module ViewComponent
   class Collection
     include Enumerable
+
     attr_reader :component
 
     delegate :size, to: :@collection
diff --git a/lib/view_component/inline_template.rb b/lib/view_component/inline_template.rb
@@ -3,6 +3,7 @@
 module ViewComponent # :nodoc:
   module InlineTemplate
     extend ActiveSupport::Concern
+
     Template = Struct.new(:source, :language, :path, :lineno)
 
     class_methods do
diff --git a/test/sandbox/test/preview_helper_test.rb b/test/sandbox/test/preview_helper_test.rb
@@ -4,6 +4,7 @@
 # rubocop:disable Style/MixinUsage
 include PreviewHelper
 # rubocop:enable Style/MixinUsage
+
 class PreviewHelperTest < ActiveSupport::TestCase
   def test_returns_template_data_with_no_template
     template_identifier = "preview/no_template"
diff --git a/test/sandbox/test/rendering_test.rb b/test/sandbox/test/rendering_test.rb
@@ -17,11 +17,11 @@ def test_render_inline_allocations
 
     allocations =
       if Rails.version.to_f < 8.0
-        {"3.3.8" => 124, "3.3.0" => 140, "3.2.8" => 122, "3.1.7" => 122, "3.0.7" => 131}
+        {"3.3" => 126, "3.2" => 128..129, "3.1" => 130, "3.0" => 131}
       elsif Rails.version.split(".").first(2).map(&:to_i) == [8, 0]
-        {"3.5.0" => 117, "3.4.4" => 121, "3.3.8" => 133}
+        {"3.5" => 118, "3.4" => 122, "3.3" => 134}
       else
-        {"3.4.4" => 119}
+        {"3.5" => 116, "3.4" => 120}
       end
 
     assert_allocations(**allocations) do
diff --git a/test/sandbox/test/tasks_test.rb b/test/sandbox/test/tasks_test.rb
@@ -2,21 +2,24 @@
 
 require "test_helper"
 
-class TasksTest < ActiveSupport::TestCase
-  setup do
-    Kernel.silence_warnings do
-      Rails.application.load_tasks
+# `rails stats` command has been removed in Rails 8.1
+if Rails.version.to_f < 8.1
+  class TasksTest < ActiveSupport::TestCase
+    setup do
+      Kernel.silence_warnings do
+        Rails.application.load_tasks
+      end
     end
-  end
 
-  teardown do
-    Rake.application.clear
-  end
+    teardown do
+      Rake.application.clear
+    end
 
-  test "adds components to rails stats" do
-    Dir.chdir(Rails.root) do
-      assert_output(/ViewComponents/) do
-        Rake::Task["stats"].invoke
+    test "adds components to rails stats" do
+      Dir.chdir(Rails.root) do
+        assert_output(/ViewComponents/) do
+          Rake::Task["stats"].invoke
+        end
       end
     end
   end
diff --git a/test/test_helper.rb b/test/test_helper.rb
diff --git a/view_component.gemspec b/view_component.gemspec
