capybara 2.18.0 → 3.40.0

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

@@ -1,34 +1,71 @@
 # 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
+
+    it 'should pass scope element to the block' do
+      @session.within(:css, '#another_foo') do |scope|
+        expect(scope).to match_css('#another_foo')
+      end
+    end
+
+    it 'should scope click', requires: [:js] do
+      @session.within(:css, '#another_foo') do |scope|
+        @session.click
+        expect(scope).to have_text('I was clicked')
+      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 +73,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 +82,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 +93,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 +116,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 +126,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,12 +141,12 @@ 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
@@ -120,9 +159,9 @@ Capybara::SpecHelper.spec '#within' do
     expect(extract_results(@session)['first_name']).to eq('Dagobert')
   end
 
-  it "should have #within_element as an alias" do
+  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
+    @session.within_element(:css, '#for_foo') do
       expect(@session).not_to have_content('First Name')
     end
   end
@@ -133,18 +172,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
@@ -155,18 +194,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,19 +1,13 @@
 # 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
@@ -22,8 +16,7 @@ module Capybara
         config.filter_run_excluding requires: method(:filter).to_proc
         config.before { Capybara::SpecHelper.reset! }
         config.after { Capybara::SpecHelper.reset! }
-        # Test in 3.5+ where metadata doesn't autotrigger shared context inclusion - will be only behavior in RSpec 4
-        config.shared_context_metadata_behavior = :apply_to_host_groups if RSpec::Core::Version::STRING.to_f >= 3.5
+        config.shared_context_metadata_behavior = :apply_to_host_groups
       end
 
       def reset!
@@ -31,21 +24,26 @@ module Capybara
         Capybara.app_host = nil
         Capybara.default_selector = :xpath
         Capybara.default_max_wait_time = 1
+        Capybara.default_retry_interval = 0.01
         Capybara.ignore_hidden_elements = true
         Capybara.exact = false
-        # `exact_options` is deprecated - set instancce var directly so we
-        # don't generate message every reset
-        Capybara.send(:config).session_options.instance_variable_set('@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.use_html5_parsing = !ENV['HTML5_PARSING'].nil?
+        Capybara.w3c_click_offset = true
         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
@@ -59,25 +57,31 @@ module Capybara
         @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(true, @session)
+          before :each, :psc do
+            SpecHelper.reset_threadsafe(bool: true, session: session)
           end
 
           after psc: true do
-            SpecHelper.reset_threadsafe(false, @session)
+            SpecHelper.reset_threadsafe(session: session)
+          end
+
+          before :each, :exact_false do
+            Capybara.exact = false
           end
 
           specs.each do |spec_name, spec_options, block|
@@ -88,44 +92,50 @@ module Capybara
         end
       end
 
-      def reset_threadsafe(bool = false, session = nil)
-        Capybara::Session.class_variable_set(:@@instance_created, false) # Work around limit on when threadsafe can be changed
+      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) if session
+        session&.instance_variable_set(:@config, nil)
       end
-    end # class << self
+    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
+      perms = [(::Sinatra::IndifferentHash if defined? ::Sinatra::IndifferentHash)].compact
+      results = Capybara::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
+      YAML.safe_load results, permitted_classes: perms
+    end
+
+    def extract_content_type(session)
+      expect(session).to have_xpath("//pre[@id='content_type']")
+      Capybara::HTML(session.body).xpath("//pre[@id='content_type']").first.text
     end
 
-    def marionette?(session)
-      session.driver.respond_to?(:marionette?, true) && session.driver.send(:marionette?)
+    def be_an_invalid_element_error(session)
+      satisfy { |error| session.driver.invalid_element_errors.any? { |e| error.is_a? e } }
     end
 
-    def rspec2?
-      !defined?(::RSpec::Expectations::Version) || (Gem::Version.new(RSpec::Expectations::Version::STRING) < Gem::Version.new('3.0'))
+    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 }