Merge pull request #2356 from mec/example/of-rspec-features-not-working-as-expected

Add `SystemSpecHelpers` for use with RSpec

Author: joelhawksley

.github/workflows/ci.yml

@@ -35,8 +35,8 @@ jobs:
             rails_version: "7.2"
           - ruby_version: "3.4"
             rails_version: "8.0"
-          - ruby_version: "head"
-            rails_version: "main"
+          # - ruby_version: "head"
+          #   rails_version: "main"
     env:
       BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.rails_version }}.gemfile
     steps:
@@ -49,7 +49,7 @@ jobs:
     - name: Build and test with Rake
       run: |
         bundle exec appraisal rails-${{ matrix.rails_version }} bundle --quiet
-        MEASURE_COVERAGE=true bundle exec appraisal rails-${{ matrix.rails_version }} rake
+        MEASURE_COVERAGE=true bundle exec appraisal rails-${{ matrix.rails_version }} rake all_tests
       env:
         RAISE_ON_WARNING: 1
         RAILS_VERSION: ${{ matrix.rails_version }}

Gemfile

@@ -38,6 +38,7 @@ group :development, :test do
   gem "slim", "~> 5"
   gem "sprockets-rails", "~> 3"
   gem "standard", "~> 1"
+  gem "turbo-rails"
   gem "warning"
   gem "yard-activesupport-concern", "< 1"
   gem "yard", "< 1"

Gemfile.lock

@@ -355,6 +355,9 @@ GEM
     thor (1.3.2)
     tilt (2.6.0)
     timeout (0.4.3)
+    turbo-rails (2.0.16)
+      actionpack (>= 7.1.0)
+      railties (>= 7.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.1.4)
@@ -415,6 +418,7 @@ DEPENDENCIES
   slim (~> 5)
   sprockets-rails (~> 3)
   standard (~> 1)
+  turbo-rails
   view_component!
   warning
   yard (< 1)

Rakefile

@@ -2,8 +2,14 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rspec/core/rake_task"
 require "yard"
 require "yard/mattr_accessor_handler"
+require "rails/version"
+require "simplecov"
+require "simplecov-console"
+
+RSpec::Core::RakeTask.new(:spec)
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -17,12 +23,6 @@ Rake::TestTask.new(:engine_test) do |t|
   t.test_files = FileList["test/test_engine/**/*_test.rb"]
 end
 
-begin
-  require "rspec/core/rake_task"
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-end
-
 desc "Runs benchmarks against components"
 task :partial_benchmark do
   ruby "./performance/partial_benchmark.rb"
@@ -130,4 +130,18 @@ namespace :docs do
   end
 end
 
-task default: [:test, :engine_test, :spec]
+task :all_tests do
+  if ENV["MEASURE_COVERAGE"]
+    SimpleCov.start do
+      command_name "RSpec-rails#{Rails::VERSION::STRING}-ruby#{RUBY_VERSION}"
+
+      formatter SimpleCov::Formatter::Console
+    end
+  end
+
+  Rake::Task["test"].invoke
+  Rake::Task["engine_test"].invoke
+  Rake::Task["spec"].invoke
+end
+
+task default: [:all_tests]

docs/CHANGELOG.md

@@ -14,6 +14,10 @@ nav_order: 6
 
     *Joel Hawksley*
 
+* Add `SystemSpecHelpers` for use with RSpec.
+
+    *Meyric Rawlings*, *Joel Hawksley*
+
 ## 4.0.0.alpha7
 
 * BREAKING: Remove deprecated `use_helper(s)`. Use `include MyHelper` or `helpers.` proxy instead.

docs/guide/testing.md

@@ -42,6 +42,8 @@ RSpec.configure do |config|
   # ...
 
   config.include ViewComponent::TestHelpers, type: :component
+  config.include ViewComponent::SystemSpecHelpers, type: :feature
+  config.include ViewComponent::SystemSpecHelpers, type: :system
 end
 ```
 

lib/docs/docs_builder_component.rb

@@ -62,9 +62,12 @@ def docstring
         @method.docstring
       end
 
+      # Not covered as we have no deprecated methods
+      # :nocov:
       def deprecation_text
         @method.tag(:deprecated)&.text
       end
+      # :nocov:
 
       def docstring_and_deprecation_text
         <<~DOCS.strip.html_safe

lib/view_component.rb

@@ -18,6 +18,7 @@ module ViewComponent
 
   if Rails.env.test?
     autoload :TestHelpers
+    autoload :SystemSpecHelpers
     autoload :SystemTestHelpers
     autoload :TestCase
     autoload :SystemTestCase

lib/view_component/system_spec_helpers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module SystemSpecHelpers
+    include SystemTestHelpers
+
+    def page
+      Capybara.current_session
+    end
+  end
+end

spec/spec_helper.rb

@@ -4,14 +4,6 @@
 require "simplecov-console"
 require "rails/version"
 
-if ENV["MEASURE_COVERAGE"]
-  SimpleCov.start do
-    command_name "RSpec-rails#{Rails::VERSION::STRING}-ruby#{RUBY_VERSION}"
-
-    formatter SimpleCov::Formatter::Console
-  end
-end
-
 require "bundler/setup"
 
 # Configure Rails Environment
@@ -23,6 +15,18 @@
 require File.expand_path("../sandbox/config/environment.rb", __FILE__)
 require "rspec/rails"
 
+require "capybara/cuprite"
+
+# Rails registers its own driver named "cuprite" which will overwrite the one we
+# register here. Avoid the problem by registering the driver with a distinct name.
+Capybara.register_driver(:system_test_driver) do |app|
+  # Add the process_timeout option to prevent failures due to the browser
+  # taking too long to start up.
+  Capybara::Cuprite::Driver.new(app, {process_timeout: 60, timeout: 30})
+end
+
 RSpec.configure do |config|
   config.include ViewComponent::TestHelpers
+  config.include ViewComponent::SystemSpecHelpers, type: :feature
+  config.include ViewComponent::SystemSpecHelpers, type: :system
 end