capybara 2.7.0 → 3.35.3

data/lib/capybara/spec/session/within_spec.rb

@@ -1,34 +1,58 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#within' do
   before do
     @session.visit('/with_scope')
   end
 
-  context "with CSS selector" do
-    it "should click links in the given scope" do
-      @session.within(:css, "#for_bar li", text: 'With Simple HTML') do
+  context 'with CSS selector' do
+    it 'should click links in the given scope' do
+      @session.within(:css, '#for_bar li:first-child') do
         @session.click_link('Go')
       end
       expect(@session).to have_content('Bar')
     end
 
-    it "should assert content in the given scope" do
-      @session.within(:css, "#for_foo") do
+    it 'should assert content in the given scope' do
+      @session.within(:css, '#for_foo') do
         expect(@session).not_to have_content('First Name')
       end
       expect(@session).to have_content('First Name')
     end
 
-    it "should accept additional options" do
-      @session.within(:css, "#for_bar li", :text => 'With Simple HTML') do
+    it 'should accept additional options' do
+      @session.within(:css, '#for_bar li', text: 'With Simple HTML') do
         @session.click_link('Go')
       end
       expect(@session).to have_content('Bar')
     end
+
+    it 'should reload the node if the page is changed' do
+      @session.within(:css, '#for_foo') do
+        @session.visit('/with_scope_other')
+        expect(@session).to have_content('Different text')
+      end
+    end
+
+    it 'should reload multiple nodes if the page is changed' do
+      @session.within(:css, '#for_bar') do
+        @session.within(:css, 'form[action="/redirect"]') do
+          @session.refresh
+          expect(@session).to have_content('First Name')
+        end
+      end
+    end
+
+    it 'should error if the page is changed and a matching node no longer exists' do
+      @session.within(:css, '#for_foo') do
+        @session.visit('/')
+        expect { @session.text }.to raise_error(StandardError)
+      end
+    end
   end
 
-  context "with XPath selector" do
-    it "should click links in the given scope" do
+  context 'with XPath selector' do
+    it 'should click links in the given scope' do
       @session.within(:xpath, "//div[@id='for_bar']//li[contains(.,'With Simple HTML')]") do
         @session.click_link('Go')
       end
@@ -36,8 +60,8 @@ Capybara::SpecHelper.spec '#within' do
     end
   end
 
-  context "with the default selector" do
-    it "should use XPath" do
+  context 'with the default selector' do
+    it 'should use XPath' do
       @session.within("//div[@id='for_bar']//li[contains(.,'With Simple HTML')]") do
         @session.click_link('Go')
       end
@@ -45,9 +69,9 @@ Capybara::SpecHelper.spec '#within' do
     end
   end
 
-  context "with Node rather than selector" do
-    it "should click links in the given scope" do
-      node_of_interest = @session.find(:css, "#for_bar li", text: 'With Simple HTML')
+  context 'with Node rather than selector' do
+    it 'should click links in the given scope' do
+      node_of_interest = @session.find(:css, '#for_bar li', text: 'With Simple HTML')
 
       @session.within(node_of_interest) do
         @session.click_link('Go')
@@ -56,19 +80,21 @@ Capybara::SpecHelper.spec '#within' do
     end
   end
 
-  context "with the default selector set to CSS" do
+  context 'with the default selector set to CSS' do
     before { Capybara.default_selector = :css }
-    it "should use CSS" do
-      @session.within("#for_bar li", text: 'With Simple HTML') do
+
+    after { Capybara.default_selector = :xpath }
+
+    it 'should use CSS' do
+      @session.within('#for_bar li', text: 'With Simple HTML') do
         @session.click_link('Go')
       end
       expect(@session).to have_content('Bar')
     end
-    after { Capybara.default_selector = :xpath }
   end
 
-  context "with nested scopes" do
-    it "should respect the inner scope" do
+  context 'with nested scopes' do
+    it 'should respect the inner scope' do
       @session.within("//div[@id='for_bar']") do
         @session.within(".//li[contains(.,'Bar')]") do
           @session.click_link('Go')
@@ -77,7 +103,7 @@ Capybara::SpecHelper.spec '#within' do
       expect(@session).to have_content('Another World')
     end
 
-    it "should respect the outer scope" do
+    it 'should respect the outer scope' do
       @session.within("//div[@id='another_foo']") do
         @session.within(".//li[contains(.,'With Simple HTML')]") do
           @session.click_link('Go')
@@ -87,14 +113,14 @@ Capybara::SpecHelper.spec '#within' do
     end
   end
 
-  it "should raise an error if the scope is not found on the page" do
+  it 'should raise an error if the scope is not found on the page' do
     expect do
       @session.within("//div[@id='doesnotexist']") do
       end
     end.to raise_error(Capybara::ElementNotFound)
   end
 
-  it "should restore the scope when an error is raised" do
+  it 'should restore the scope when an error is raised' do
     expect do
       @session.within("//div[@id='for_bar']") do
         expect do
@@ -102,23 +128,30 @@ Capybara::SpecHelper.spec '#within' do
             @session.within(".//div[@id='doesnotexist']") do
             end
           end.to raise_error(Capybara::ElementNotFound)
-        end.to_not change { @session.has_xpath?(".//div[@id='another_foo']") }.from(false)
+        end.not_to change { @session.has_xpath?(".//div[@id='another_foo']") }.from(false)
       end
-    end.to_not change { @session.has_xpath?(".//div[@id='another_foo']") }.from(true)
+    end.not_to change { @session.has_xpath?(".//div[@id='another_foo']") }.from(true)
   end
 
-  it "should fill in a field and click a button" do
+  it 'should fill in a field and click a button' do
     @session.within("//li[contains(.,'Bar')]") do
       @session.click_button('Go')
     end
     expect(extract_results(@session)['first_name']).to eq('Peter')
     @session.visit('/with_scope')
     @session.within("//li[contains(.,'Bar')]") do
-      @session.fill_in('First Name', :with => 'Dagobert')
+      @session.fill_in('First Name', with: 'Dagobert')
       @session.click_button('Go')
     end
     expect(extract_results(@session)['first_name']).to eq('Dagobert')
   end
+
+  it 'should have #within_element as an alias' do
+    expect(Capybara::Session.instance_method(:within)).to eq Capybara::Session.instance_method(:within_element)
+    @session.within_element(:css, '#for_foo') do
+      expect(@session).not_to have_content('First Name')
+    end
+  end
 end
 
 Capybara::SpecHelper.spec '#within_fieldset' do
@@ -126,18 +159,18 @@ Capybara::SpecHelper.spec '#within_fieldset' do
     @session.visit('/fieldsets')
   end
 
-  it "should restrict scope to a fieldset given by id" do
-    @session.within_fieldset("villain_fieldset") do
-      @session.fill_in("Name", :with => 'Goldfinger')
-      @session.click_button("Create")
+  it 'should restrict scope to a fieldset given by id' do
+    @session.within_fieldset('villain_fieldset') do
+      @session.fill_in('Name', with: 'Goldfinger')
+      @session.click_button('Create')
     end
     expect(extract_results(@session)['villain_name']).to eq('Goldfinger')
   end
 
-  it "should restrict scope to a fieldset given by legend" do
-    @session.within_fieldset("Villain") do
-      @session.fill_in("Name", :with => 'Goldfinger')
-      @session.click_button("Create")
+  it 'should restrict scope to a fieldset given by legend' do
+    @session.within_fieldset('Villain') do
+      @session.fill_in('Name', with: 'Goldfinger')
+      @session.click_button('Create')
     end
     expect(extract_results(@session)['villain_name']).to eq('Goldfinger')
   end
@@ -148,18 +181,18 @@ Capybara::SpecHelper.spec '#within_table' do
     @session.visit('/tables')
   end
 
-  it "should restrict scope to a fieldset given by id" do
-    @session.within_table("girl_table") do
-      @session.fill_in("Name", :with => 'Christmas')
-      @session.click_button("Create")
+  it 'should restrict scope to a fieldset given by id' do
+    @session.within_table('girl_table') do
+      @session.fill_in('Name', with: 'Christmas')
+      @session.click_button('Create')
     end
     expect(extract_results(@session)['girl_name']).to eq('Christmas')
   end
 
-  it "should restrict scope to a fieldset given by legend" do
-    @session.within_table("Villain") do
-      @session.fill_in("Name", :with => 'Quantum')
-      @session.click_button("Create")
+  it 'should restrict scope to a fieldset given by legend' do
+    @session.within_table('Villain') do
+      @session.fill_in('Name', with: 'Quantum')
+      @session.click_button('Create')
     end
     expect(extract_results(@session)['villain_name']).to eq('Quantum')
   end

data/lib/capybara/spec/spec_helper.rb

@@ -1,27 +1,22 @@
 # frozen_string_literal: true
-require "rspec"
-require "rspec/expectations"
-require "capybara"
-require "capybara/rspec" # Required here instead of in rspec_spec to avoid RSpec deprecation warning
-require "capybara/spec/test_app"
-require "nokogiri"
-
-# Alias be_truthy/be_falsey if not already defined to be able to use in RSpec 2 and 3
-unless RSpec::Matchers.method_defined?(:be_truthy)
-  RSpec::Matchers.module_eval do
-    alias be_truthy be_true
-    alias be_falsey be_false
-    alias be_falsy be_false
-  end
-end
+
+require 'rspec'
+require 'rspec/expectations'
+require 'capybara'
+require 'capybara/rspec' # Required here instead of in rspec_spec to avoid RSpec deprecation warning
+require 'capybara/spec/test_app'
+require 'nokogiri'
+
+Capybara.save_path = File.join(Dir.pwd, 'save_path_tmp')
 
 module Capybara
   module SpecHelper
     class << self
       def configure(config)
-        config.filter_run_excluding :requires => method(:filter).to_proc
+        config.filter_run_excluding requires: method(:filter).to_proc
         config.before { Capybara::SpecHelper.reset! }
         config.after { Capybara::SpecHelper.reset! }
+        config.shared_context_metadata_behavior = :apply_to_host_groups
       end
 
       def reset!
@@ -31,15 +26,23 @@ module Capybara
         Capybara.default_max_wait_time = 1
         Capybara.ignore_hidden_elements = true
         Capybara.exact = false
-        Capybara.exact_options = false
         Capybara.raise_server_errors = true
         Capybara.visible_text_only = false
         Capybara.match = :smart
-        Capybara.wait_on_first_by_default = false
+        Capybara.enable_aria_label = false
+        Capybara.enable_aria_role = false
+        Capybara.default_set_options = {}
+        Capybara.disable_animation = false
+        Capybara.test_id = nil
+        Capybara.predicates_wait = true
+        Capybara.default_normalize_ws = false
+        Capybara.allow_gumbo = true
+        Capybara.w3c_click_offset = false
+        reset_threadsafe
       end
 
       def filter(requires, metadata)
-        if requires and metadata[:capybara_skip]
+        if requires && metadata[:capybara_skip]
           requires.any? do |require|
             metadata[:capybara_skip].include?(require)
           end
@@ -48,53 +51,84 @@ module Capybara
         end
       end
 
-      def spec(name, options={}, &block)
+      def spec(name, *options, &block)
         @specs ||= []
         @specs << [name, options, block]
       end
 
-      def run_specs(session, name, options={})
+      def run_specs(session, name, **options, &filter_block)
         specs = @specs
         RSpec.describe Capybara::Session, name, options do
           include Capybara::SpecHelper
           include Capybara::RSpecMatchers
-          before do
+
+          before do |example|
             @session = session
+            instance_exec(example, &filter_block) if filter_block
           end
+
           after do
-            @session.reset_session!
+            session.reset_session!
           end
+
+          before :each, psc: true do
+            SpecHelper.reset_threadsafe(bool: true, session: session)
+          end
+
+          after psc: true do
+            SpecHelper.reset_threadsafe(session: session)
+          end
+
+          before :each, :exact_false do
+            Capybara.exact = false
+          end
+
           specs.each do |spec_name, spec_options, block|
-            describe spec_name, spec_options do
+            describe spec_name, *spec_options do
               class_eval(&block)
             end
           end
         end
       end
-    end # class << self
+
+      def reset_threadsafe(bool: false, session: nil)
+        # Work around limit on when threadsafe can be changed
+        Capybara::Session.class_variable_set(:@@instance_created, false) # rubocop:disable Style/ClassVars
+        Capybara.threadsafe = bool
+        session = session.current_session if session.respond_to?(:current_session)
+        session&.instance_variable_set(:@config, nil)
+      end
+    end
 
     def silence_stream(stream)
       old_stream = stream.dup
-      stream.reopen(RbConfig::CONFIG['host_os'] =~ /rmswin|mingw/ ? 'NUL:' : '/dev/null')
+      stream.reopen(RbConfig::CONFIG['host_os'].match?(/rmswin|mingw/) ? 'NUL:' : '/dev/null')
       stream.sync = true
       yield
     ensure
       stream.reopen(old_stream)
     end
 
-    def quietly
-      silence_stream(STDOUT) do
-        silence_stream(STDERR) do
-          yield
-        end
+    def quietly(&block)
+      silence_stream($stdout) do
+        silence_stream($stderr, &block)
       end
     end
 
     def extract_results(session)
       expect(session).to have_xpath("//pre[@id='results']")
-      YAML.load Nokogiri::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
+      # YAML.load Nokogiri::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
+      YAML.load Capybara::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
+    end
+
+    def be_an_invalid_element_error(session)
+      satisfy { |error| session.driver.invalid_element_errors.any? { |e| error.is_a? e } }
+    end
+
+    def with_os_path_separators(path)
+      Gem.win_platform? ? path.to_s.tr('/', '\\') : path.to_s
     end
   end
 end
 
-Dir[File.dirname(__FILE__) + "/session/**/*.rb"].each { |file| require_relative file }
+Dir["#{File.dirname(__FILE__)}/session/**/*.rb"].each { |file| require_relative file }

data/lib/capybara/spec/test_app.rb

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
+
 require 'sinatra/base'
 require 'tilt/erb'
 require 'rack'
 require 'yaml'
 
 class TestApp < Sinatra::Base
-  class TestAppError < StandardError; end
+  class TestAppError < Exception; end # rubocop:disable Lint/InheritException
 
+  class TestAppOtherError < Exception # rubocop:disable Lint/InheritException
+    def initialize(string1, msg)
+      super()
+      @something = string1
+      @message = msg
+    end
+  end
   set :root, File.dirname(__FILE__)
   set :static, true
   set :raise_errors, true
@@ -15,7 +23,7 @@ class TestApp < Sinatra::Base
   # Also check lib/capybara/spec/views/*.erb for pages not listed here
 
   get '/' do
-    response.set_cookie('capybara', { value: 'root cookie', domain: request.host, path: request.path} )
+    response.set_cookie('capybara', value: 'root cookie', domain: request.host, path: request.path)
     'Hello world! <a href="with_html">Relative</a>'
   end
 
@@ -27,13 +35,25 @@ class TestApp < Sinatra::Base
     redirect '/redirect_again'
   end
 
+  get '/redirect_with_fragment' do
+    redirect '/landed#with_fragment'
+  end
+
   get '/redirect_again' do
     redirect '/landed'
   end
 
+  post '/redirect_307' do
+    redirect '/landed', 307
+  end
+
+  post '/redirect_308' do
+    redirect '/landed', 308
+  end
+
   get '/referer_base' do
-    '<a href="/get_referer">direct link</a>' +
-    '<a href="/redirect_to_get_referer">link via redirect</a>' +
+    '<a href="/get_referer">direct link</a>' \
+    '<a href="/redirect_to_get_referer">link via redirect</a>' \
     '<form action="/get_referer" method="get"><input type="submit"></form>'
   end
 
@@ -42,7 +62,7 @@ class TestApp < Sinatra::Base
   end
 
   get '/get_referer' do
-    request.referer.nil? ? "No referer" : "Got referer: #{request.referer}"
+    request.referer.nil? ? 'No referer' : "Got referer: #{request.referer}"
   end
 
   get '/host' do
@@ -52,26 +72,30 @@ class TestApp < Sinatra::Base
   get '/redirect/:times/times' do
     times = params[:times].to_i
     if times.zero?
-      "redirection complete"
+      'redirection complete'
     else
       redirect "/redirect/#{times - 1}/times"
     end
   end
 
   get '/landed' do
-    "You landed"
+    'You landed'
+  end
+
+  post '/landed' do
+    "You post landed: #{params.dig(:form, 'data')}"
   end
 
   get '/with-quotes' do
-    %q{"No," he said, "you can't do that."}
+    %q("No," he said, "you can't do that.")
   end
 
   get '/form/get' do
-    '<pre id="results">' + params[:form].to_yaml + '</pre>'
+    %(<pre id="results">#{params[:form].to_yaml}</pre>)
   end
 
   post '/relative' do
-    '<pre id="results">' + params[:form].to_yaml + '</pre>'
+    %(<pre id="results">#{params[:form].to_yaml}</pre>)
   end
 
   get '/favicon.ico' do
@@ -82,12 +106,12 @@ class TestApp < Sinatra::Base
     redirect '/redirect_again'
   end
 
-  delete "/delete" do
-    "The requested object was deleted"
+  delete '/delete' do
+    'The requested object was deleted'
   end
 
-  get "/delete" do
-    "Not deleted"
+  get '/delete' do
+    'Not deleted'
   end
 
   get '/redirect_back' do
@@ -122,7 +146,11 @@ class TestApp < Sinatra::Base
   end
 
   get '/error' do
-    raise TestAppError, "some error"
+    raise TestAppError, 'some error'
+  end
+
+  get '/other_error' do
+    raise TestAppOtherError.new('something', 'other error')
   end
 
   get '/load_error' do
@@ -133,12 +161,28 @@ class TestApp < Sinatra::Base
     erb :with_html, locals: { referrer: request.referrer }
   end
 
+  get '/with_title' do
+    <<-HTML
+      <title>#{params[:title] || 'Test Title'}</title>
+      <body>
+        <svg><title>abcdefg</title></svg>
+      </body>
+    HTML
+  end
+
+  get '/download.csv' do
+    content_type 'text/csv'
+    'This, is, comma, separated' \
+    'Thomas, Walpole, was , here'
+  end
+
   get '/:view' do |view|
     erb view.to_sym, locals: { referrer: request.referrer }
   end
 
   post '/form' do
-    '<pre id="results">' + params[:form].to_yaml + '</pre>'
+    self.class.form_post_count += 1
+    %(<pre id="results">#{params[:form].merge('post_count' => self.class.form_post_count).to_yaml}</pre>)
   end
 
   post '/upload_empty' do
@@ -150,30 +194,35 @@ class TestApp < Sinatra::Base
   end
 
   post '/upload' do
-    begin
-      buffer = []
-      buffer << "Content-type: #{params[:form][:document][:type]}"
-      buffer << "File content: #{params[:form][:document][:tempfile].read}"
-      buffer.join(' | ')
-    rescue
-      'No file uploaded'
-    end
+    buffer = []
+    buffer << "Content-type: #{params.dig(:form, :document, :type)}"
+    buffer << "File content: #{params.dig(:form, :document, :tempfile).read}"
+    buffer.join(' | ')
+  rescue StandardError
+    'No file uploaded'
   end
 
   post '/upload_multiple' do
-    begin
-      buffer = ["#{params[:form][:multiple_documents].size}"]
-      params[:form][:multiple_documents].each do |doc|
-        buffer << "Content-type: #{doc[:type]}"
-        buffer << "File content: #{doc[:tempfile].read}"
-      end
-      buffer.join(' | ')
-    rescue
-      'No files uploaded'
+    docs = params.dig(:form, :multiple_documents)
+    buffer = [docs.size.to_s]
+    docs.each do |doc|
+      buffer << "Content-type: #{doc[:type]}"
+      buffer << "File content: #{doc[:tempfile].read}"
     end
+    buffer.join(' | ')
+  rescue StandardError
+    'No files uploaded'
+  end
+
+  get '/apple-touch-icon-precomposed.png' do
+    halt(404)
   end
-end
 
-if __FILE__ == $0
-  Rack::Handler::WEBrick.run TestApp, :Port => 8070
+  class << self
+    attr_accessor :form_post_count
+  end
+
+  @form_post_count = 0
 end
+
+Rack::Handler::Puma.run TestApp, Port: 8070 if $PROGRAM_NAME == __FILE__