Refer to Capybara.current_session by document

The Capybara DSL provides a `page` helper method to refer to the
Capybara.current_session for assertions about the current document.
Unfortunately as I have chosen a key application model to be `Page`, I
am often shadowing the Capybara.current_session helper in system specs
with the local variable `page` to refer to the domain concept. Using
them interchangeably doesn’t work.

In this changeset, I have added a separate alias to
Capybara.current_sesison for system specs called `document`. I’m not
enforcing its usage as Capybara appears to use the `page` DSL method
internally.

Author: rossta

lib/generators/article/templates/article_spec.rb.tt

@@ -4,6 +4,6 @@ RSpec.describe "<%= title %>", type: :system do
   it "displays the article content" do
     visit "/articles/<%= article_file_name %>"
 
-    expect(page).to have_content <%= title %>
+    expect(document).to have_content <%= title %>
   end
 end

spec/requests/feed_spec.rb

@@ -16,13 +16,13 @@
       get "/feed"
 
       expect(response.status).to eq(200)
-      page = Capybara.string(response.body)
+      Capybara.string(response.body)
 
-      expect(page).to have_content("Introducing Joy of Rails")
-      expect(page).to have_content("/introducing-joy-of-rails")
-      expect(page).to have_content("How it started, How it’s going</h2>")
-      expect(page).to have_content(%(<div class="code-wrapper highlight language-ruby"><pre><code><span class="k">class</span>))
-      expect(page).not_to have_content(%(<turbo-frame))
+      expect(document).to have_content("Introducing Joy of Rails")
+      expect(document).to have_content("/introducing-joy-of-rails")
+      expect(document).to have_content("How it started, How it’s going</h2>")
+      expect(document).to have_content(%(<div class="code-wrapper highlight language-ruby"><pre><code><span class="k">class</span>))
+      expect(document).not_to have_content(%(<turbo-frame))
     end
 
     it "render valid feed" do

spec/requests/search_spec.rb

@@ -7,31 +7,31 @@
 
       expect(response).to have_http_status(:success)
 
-      expect(page).not_to have_content("No results")
+      expect(document).not_to have_content("No results")
     end
 
     it "renders empty without search query as POST" do
       post search_path
 
       expect(response).to have_http_status(:success)
 
-      expect(page).not_to have_content("No results")
+      expect(document).not_to have_content("No results")
     end
 
     it "renders empty without search query as turbo stream" do
       get search_path(format: :turbo_stream)
 
       expect(response).to have_http_status(:success)
 
-      expect(page).not_to have_content("No results")
+      expect(document).not_to have_content("No results")
     end
 
     it "renders No results feedback when query is long enough" do
       get search_path, params: {query: "Pro"}
 
       expect(response).to have_http_status(:success)
 
-      expect(page).to have_content("No results")
+      expect(document).to have_content("No results")
     end
 
     it "renders the search results without query" do
@@ -42,7 +42,7 @@
 
       expect(response).to have_http_status(:success)
 
-      expect(page).not_to have_content("No results")
+      expect(document).not_to have_content("No results")
     end
 
     it "renders the search results with query as turbo stream" do
@@ -73,15 +73,15 @@
 
       expect(response).to have_http_status(:success)
 
-      expect(page).to have_content("Progressive Web Apps on Rails Showcase")
-      expect(page).not_to have_content("Introducing Joy of Rails")
+      expect(document).to have_content("Progressive Web Apps on Rails Showcase")
+      expect(document).not_to have_content("Introducing Joy of Rails")
     end
 
     it "doesn’t blow up with invalid query" do
       get search_path, params: {query: "(((("}
 
       expect(response).to have_http_status(:success)
-      expect(page).to have_content("No results")
+      expect(document).to have_content("No results")
     end
 
     it "doesn’t blow up with invalid query as turbo stream" do

spec/requests/share/polls_spec.rb

@@ -11,14 +11,14 @@
     it "does not render the New Poll button when not allowed" do
       get share_polls_url
 
-      expect(page).to_not have_content("New Poll")
+      expect(document).not_to have_content("New Poll")
     end
 
     it "renders the New Poll button when allowed" do
       Flipper.enable(:polls, login_as_user)
       get share_polls_url
 
-      expect(page).to have_content("New Poll")
+      expect(document).to have_content("New Poll")
     end
   end
 

spec/requests/share/snippets_spec.rb

@@ -23,14 +23,14 @@
     it "does not render the New Snippet button when not allowed" do
       get share_snippets_url
 
-      expect(page).to_not have_content("New Snippet")
+      expect(document).not_to have_content("New Snippet")
     end
 
     it "renders the New Snippet button when allowed" do
       Flipper.enable(:snippets, login_as_user)
       get share_snippets_url
 
-      expect(page).to have_content("New Snippet")
+      expect(document).to have_content("New Snippet")
     end
   end
 
@@ -58,7 +58,7 @@
       snippet = FactoryBot.create(:snippet)
       get share_snippet_url(snippet)
 
-      expect(page).to_not have_content("Edit this snippet")
+      expect(document).not_to have_content("Edit this snippet")
     end
 
     it "renders the Edit Snippet button when allowed" do
@@ -67,7 +67,7 @@
       snippet = FactoryBot.create(:snippet, author: user)
       get share_snippet_url(snippet)
 
-      expect(page).to have_content("Edit this snippet")
+      expect(document).to have_content("Edit this snippet")
     end
   end
 end

spec/requests/topics_spec.rb

@@ -14,8 +14,8 @@
 
       expect(response).to have_http_status(:success)
 
-      expect(page).to have_content(topic_1.name)
-      expect(page).to have_content(topic_2.name)
+      expect(document).to have_content(topic_1.name)
+      expect(document).to have_content(topic_2.name)
     end
   end
 

spec/support/requests.rb

@@ -1,6 +1,6 @@
 module RequestSpecHelpers
-  def page
-    @page ||= Capybara.string(response.body)
+  def document
+    @document ||= Capybara.string(response.body)
   end
 end
 

spec/support/system.rb

@@ -11,10 +11,18 @@
 Capybara.default_max_wait_time = 5
 Capybara.disable_animation = true
 
+module CapybaraHelper
+  extend ActiveSupport::Concern
+
+  # Use the current session as an alternative to `page`
+  def document = Capybara.current_session
+end
+
 RSpec.configure do |config|
   config.include Warden::Test::Helpers, type: :system
   config.include Rails.application.routes.url_helpers, type: :system
   config.include ActiveJob::TestHelper
+  config.include CapybaraHelper, type: :system
 
   config.before(:each, type: :system) do
     driven_by(:cuprite,

spec/system/admin/newsletter_spec.rb

@@ -18,13 +18,13 @@
 
     click_button "Create Newsletter"
 
-    expect(page).to have_content("Newsletter was successfully created.")
+    expect(document).to have_content("Newsletter was successfully created.")
 
-    expect(page).to have_content("Welcome to Joy of Rails!")
+    expect(document).to have_content("Welcome to Joy of Rails!")
 
     click_link "Back to newsletters"
 
-    expect(page).to have_content("Welcome to Joy of Rails!")
+    expect(document).to have_content("Welcome to Joy of Rails!")
 
     within "#newsletters" do
       click_link "Edit"
@@ -38,9 +38,9 @@
 
     click_button "Update Newsletter"
 
-    expect(page).to have_content("Newsletter was successfully updated.")
+    expect(document).to have_content("Newsletter was successfully updated.")
 
-    expect(page).to have_content("OMG! This is the first newsletter.")
+    expect(document).to have_content("OMG! This is the first newsletter.")
   end
 
   it "send a newsletter test", :vcr do
@@ -58,7 +58,7 @@
 
     click_button "Send Test"
 
-    expect(page).to have_content("[TEST] Newsletter was successfully delivered.")
+    expect(document).to have_content("[TEST] Newsletter was successfully delivered.")
 
     perform_enqueued_jobs_and_subsequently_enqueued_jobs
 
@@ -88,7 +88,7 @@
 
     click_button "Send Live"
 
-    expect(page).to have_content("[LIVE] Newsletter was successfully delivered.")
+    expect(document).to have_content("[LIVE] Newsletter was successfully delivered.")
 
     perform_enqueued_jobs_and_subsequently_enqueued_jobs
 

spec/system/admin_users/sessions_spec.rb

@@ -5,18 +5,18 @@
     admin_user = FactoryBot.create(:admin_user)
 
     visit new_admin_users_session_path
-    expect(page).to have_text("Sign in to your admin account")
+    expect(document).to have_text("Sign in to your admin account")
 
     fill_in "Email", with: admin_user.email
     fill_in "Password", with: "password"
 
     click_button "Sign in"
 
-    expect(page).not_to have_text("Sign in to your admin account")
+    expect(document).not_to have_text("Sign in to your admin account")
 
-    expect(page).to have_text("Signed in successfully.")
+    expect(document).to have_text("Signed in successfully.")
 
-    expect(page).to have_text(admin_user.email)
+    expect(document).to have_text(admin_user.email)
   end
 
   it "fails sign in" do
@@ -30,7 +30,7 @@
     click_button "Sign in"
 
     expect(current_path).to eq(admin_users_sessions_path)
-    expect(page).to have_text("Incorrect email or password.")
+    expect(document).to have_text("Incorrect email or password.")
   end
 
   it "signs out admin_user" do
@@ -40,11 +40,11 @@
 
     visit root_path
 
-    expect(page).to have_text(admin_user.email)
+    expect(document).to have_text(admin_user.email)
 
     click_button "Sign out"
 
-    expect(page).to have_text("Signed out successfully.")
-    expect(page).not_to have_text(admin_user.email)
+    expect(document).to have_text("Signed out successfully.")
+    expect(document).not_to have_text(admin_user.email)
   end
 end