capybara 3.13.2 → 3.40.0

data/lib/capybara/spec/session/window/window_spec.rb

@@ -1,93 +1,91 @@
 # frozen_string_literal: true
 
-# Note: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# NOTE: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
 # because of the methods being tested. In tests using Capybara this type of behavior should be implemented
 # using Capybara provided assertions with builtin waiting behavior.
 
 Capybara::SpecHelper.spec Capybara::Window, requires: [:windows] do
+  let!(:orig_window) { @session.current_window }
   before do
-    @window = @session.current_window
     @session.visit('/with_windows')
   end
 
   after do
-    (@session.windows - [@window]).each do |w|
+    (@session.windows - [orig_window]).each do |w|
       @session.switch_to_window w
       w.close
     end
-    @session.switch_to_window(@window)
+    @session.switch_to_window(orig_window)
   end
 
   describe '#exists?' do
-    before do
-      @other_window = @session.window_opened_by do
+    it 'should become false after window was closed' do
+      other_window = @session.window_opened_by do
         @session.find(:css, '#openWindow').click
       end
-    end
 
-    it 'should become false after window was closed' do
       expect do
-        @session.switch_to_window @other_window
-        @other_window.close
-      end.to change { @other_window.exists? }.from(true).to(false)
+        @session.switch_to_window other_window
+        other_window.close
+      end.to change(other_window, :exists?).from(true).to(false)
     end
   end
 
   describe '#closed?' do
     it 'should become true after window was closed' do
-      @other_window = @session.window_opened_by do
+      other_window = @session.window_opened_by do
         @session.find(:css, '#openWindow').click
       end
       expect do
-        @session.switch_to_window @other_window
-        @other_window.close
-      end.to change { @other_window.closed? }.from(false).to(true)
+        @session.switch_to_window other_window
+        other_window.close
+      end.to change { other_window.closed? }.from(false).to(true)
     end
   end
 
   describe '#current?' do
-    before do
-      @other_window = @session.window_opened_by do
+    let(:other_window) do
+      @session.window_opened_by do
         @session.find(:css, '#openWindow').click
       end
     end
 
     it 'should become true after switching to window' do
       expect do
-        @session.switch_to_window(@other_window)
-      end.to change { @other_window.current? }.from(false).to(true)
+        @session.switch_to_window(other_window)
+      end.to change(other_window, :current?).from(false).to(true)
     end
 
     it 'should return false if window is closed' do
-      @session.switch_to_window(@other_window)
-      @other_window.close
-      expect(@other_window.current?).to eq(false)
+      @session.switch_to_window(other_window)
+      other_window.close
+      expect(other_window.current?).to be(false)
     end
   end
 
   describe '#close' do
-    before do
-      @other_window = @session.window_opened_by do
+    let!(:other_window) do
+      @session.window_opened_by do
         @session.find(:css, '#openWindow').click
       end
     end
 
     it 'should switch to original window if invoked not for current window' do
       expect(@session.windows.size).to eq(2)
-      expect(@session.current_window).to eq(@window)
-      @other_window.close
+      expect(@session.current_window).to eq(orig_window)
+      other_window.close
       expect(@session.windows.size).to eq(1)
-      expect(@session.current_window).to eq(@window)
+      expect(@session.current_window).to eq(orig_window)
     end
 
     it 'should make subsequent invocations of other methods raise no_such_window_error if invoked for current window' do
-      @session.switch_to_window(@other_window)
-      expect(@session.current_window).to eq(@other_window)
-      @other_window.close
+      @session.switch_to_window(other_window)
+      expect(@session.current_window).to eq(other_window)
+      other_window.close
       expect do
         @session.find(:css, '#some_id')
       end.to raise_error(@session.driver.no_such_window_error)
-      @session.switch_to_window(@window)
+      @session.switch_to_window(orig_window)
     end
   end
 
@@ -101,55 +99,54 @@ Capybara::SpecHelper.spec Capybara::Window, requires: [:windows] do
     end
 
     it 'should switch to original window if invoked not for current window' do
-      @other_window = @session.window_opened_by do
+      other_window = @session.window_opened_by do
         @session.find(:css, '#openWindow').click
       end
       sleep 1
-      size = @session.within_window(@other_window) do
+      size = @session.within_window(other_window) do
         win_size
       end
-      expect(@other_window.size).to eq(size)
-      expect(@session.current_window).to eq(@window)
+      expect(other_window.size).to eq(size)
+      expect(@session.current_window).to eq(orig_window)
     end
   end
 
   describe '#resize_to' do
-    before do
-      @initial_size = @session.current_window.size
-    end
+    let!(:initial_size) { @session.current_window.size }
 
     after do
-      @session.current_window.resize_to(*@initial_size)
+      @session.current_window.resize_to(*initial_size)
       sleep 1
     end
 
     it 'should be able to resize window', requires: %i[windows js] do
-      width, height = @initial_size
+      width, height = initial_size
       @session.current_window.resize_to(width - 100, height - 100)
       sleep 1
       expect(@session.current_window.size).to eq([width - 100, height - 100])
     end
 
     it 'should stay on current window if invoked not for current window', requires: %i[windows js] do
-      @other_window = @session.window_opened_by do
+      other_window = @session.window_opened_by do
         @session.find(:css, '#openWindow').click
       end
-      @other_window.resize_to(600, 300)
-      expect(@session.current_window).to eq(@window)
 
-      @session.within_window(@other_window) do
-        expect(@session.current_window.size).to eq([600, 300])
+      other_window.resize_to(600, 400)
+      expect(@session.current_window).to eq(orig_window)
+
+      @session.within_window(other_window) do
+        expect(@session.current_window.size).to eq([600, 400])
       end
     end
   end
 
   describe '#maximize' do
-    before do
-      @initial_size = @session.current_window.size
+    let! :initial_size do
+      @session.current_window.size
     end
 
     after do
-      @session.current_window.resize_to(*@initial_size)
+      @session.current_window.resize_to(*initial_size)
       sleep 0.5
     end
 
@@ -169,31 +166,31 @@ Capybara::SpecHelper.spec Capybara::Window, requires: [:windows] do
     end
 
     it 'should stay on current window if invoked not for current window', requires: %i[windows js] do
-      @other_window = @session.window_opened_by do
+      other_window = @session.window_opened_by do
         @session.find(:css, '#openWindow').click
       end
-      @other_window.resize_to(400, 300)
+      other_window.resize_to(400, 300)
       sleep 0.5
-      @other_window.maximize
+      other_window.maximize
       sleep 0.5 # The timing on maximize is finicky on Travis -- wait a bit for maximize to occur
 
-      expect(@session.current_window).to eq(@window)
+      expect(@session.current_window).to eq(orig_window)
       # Maximizing the browser affects all tabs so this may not be valid in real browsers
-      # expect(@session.current_window.size).to eq(@initial_size)
+      # expect(@session.current_window.size).to eq(initial_size)
 
-      ow_width, ow_height = @other_window.size
+      ow_width, ow_height = other_window.size
       expect(ow_width).to be > 400
       expect(ow_height).to be > 300
     end
   end
 
   describe '#fullscreen' do
-    before do
-      @initial_size = @session.current_window.size
+    let! :initial_size do
+      @session.current_window.size
     end
 
     after do
-      @session.current_window.resize_to(*@initial_size)
+      @session.current_window.resize_to(*initial_size)
       sleep 1
     end
 

data/lib/capybara/spec/session/window/windows_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Note: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# NOTE: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
 # because of the methods being tested. In tests using Capybara this type of behavior should be implemented
 # using Capybara provided assertions with builtin waiting behavior.
 
@@ -29,6 +29,6 @@ Capybara::SpecHelper.spec '#windows', requires: [:windows] do
     titles = @session.windows.map do |window|
       @session.within_window(window) { @session.title }
     end
-    expect(titles).to match_array(['With Windows', 'Title of the first popup', 'Title of popup two'])
+    expect(titles).to match_array(['With Windows', 'Title of the first popup', 'Title of popup two']) # rubocop:disable RSpec/MatchArray
   end
 end

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

@@ -26,6 +26,42 @@ Capybara::SpecHelper.spec '#within' do
       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

data/lib/capybara/spec/spec_helper.rb

@@ -24,18 +24,21 @@ 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
         Capybara.raise_server_errors = true
         Capybara.visible_text_only = false
         Capybara.match = :smart
         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.use_html5_parsing = !ENV['HTML5_PARSING'].nil?
+        Capybara.w3c_click_offset = true
         reset_threadsafe
       end
 
@@ -56,10 +59,10 @@ module Capybara
 
       def run_specs(session, name, **options, &filter_block)
         specs = @specs
-        RSpec.describe Capybara::Session, name, options do # rubocop:disable RSpec/EmptyExampleGroup
+        RSpec.describe Capybara::Session, name, options do
           include Capybara::SpecHelper
           include Capybara::RSpecMatchers
-          # rubocop:disable RSpec/ScatteredSetup
+
           before do |example|
             @session = session
             instance_exec(example, &filter_block) if filter_block
@@ -69,29 +72,29 @@ module Capybara
             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
-          # rubocop:enable RSpec/ScatteredSetup
 
           specs.each do |spec_name, spec_options, block|
-            describe spec_name, *spec_options do # rubocop:disable RSpec/EmptyExampleGroup
+            describe spec_name, *spec_options do
               class_eval(&block)
             end
           end
         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)
@@ -100,31 +103,39 @@ module Capybara
 
     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 Capybara::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 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

@@ -6,9 +6,11 @@ require 'rack'
 require 'yaml'
 
 class TestApp < Sinatra::Base
-  class TestAppError < StandardError; end
-  class TestAppOtherError < StandardError
+  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
@@ -18,7 +20,6 @@ class TestApp < Sinatra::Base
   set :raise_errors, true
   set :show_exceptions, false
 
-  @@form_post_count = 0
   # Also check lib/capybara/spec/views/*.erb for pages not listed here
 
   get '/' do
@@ -34,6 +35,10 @@ 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
@@ -48,8 +53,8 @@ class TestApp < Sinatra::Base
 
   get '/referer_base' do
     '<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>'
+      '<a href="/redirect_to_get_referer">link via redirect</a>' \
+      '<form action="/get_referer" method="get"><input type="submit"></form>'
   end
 
   get '/redirect_to_get_referer' do
@@ -86,11 +91,11 @@ class TestApp < Sinatra::Base
   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
@@ -158,60 +163,143 @@ class TestApp < Sinatra::Base
 
   get '/with_title' do
     <<-HTML
-      <title>#{params[:title] || 'Test Title'}</title>
-      <body>
-        <svg><title>abcdefg</title></svg>
-      </body>
+      <!DOCTYPE html>
+      <html lang="en">
+        <head>
+          <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
+          <title>#{params[:title] || 'Test Title'}</title>
+        </head>
+
+        <body>
+          <svg><title>abcdefg</title></svg>
+        </body>
+      </html>
+    HTML
+  end
+
+  get '/with_iframe' do
+    <<-HTML
+      <!DOCTYPE html>
+      <html lang="en">
+        <head>
+          <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
+          <title>Test with Iframe</title>
+        </head>
+
+        <body>
+          <iframe src="#{params[:url]}" id="#{params[:id]}"></iframe>
+        </body>
+      </html>
+    HTML
+  end
+
+  get '/base/with_base' do
+    <<-HTML
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <base href="/">
+          <title>Origin</title>
+        </head>
+        <body>
+          <a href="with_title">Title page</a>
+          <a href="?a=3">Bare query</a>
+        </body>
+      </html>
+    HTML
+  end
+
+  get '/base/with_other_base' do
+    <<-HTML
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <base href="/base/">
+          <title>Origin</title>
+        </head>
+        <body>
+          <a href="with_title">Title page</a>
+          <a href="?a=3">Bare query</a>
+        </body>
+      </html>
+    HTML
+  end
+
+  get '/csp' do
+    response.headers['Content-Security-Policy'] = "default-src 'none'; connect-src 'self'; base-uri 'none'; font-src 'self'; img-src 'self' data:; object-src 'none'; script-src 'self' 'nonce-jAviMuMisoTisVXjgLoWdA=='; style-src 'self' 'nonce-jAviMuMisoTisVXjgLoWdA=='; form-action 'self';"
+    <<-HTML
+      <!DOCTYPE html>
+      <html lang="en">
+        <head>
+          <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
+          <title>CSP</title>
+        </head>
+
+        <body>
+          <div>CSP</div>
+        </body>
+      </html>
     HTML
   end
 
   get '/download.csv' do
     content_type 'text/csv'
     'This, is, comma, separated' \
-    'Thomas, Walpole, was , here'
+      'Thomas, Walpole, was , here'
+  end
+
+  get %r{/apple-touch-.*\.png/} do
+    halt(404)
   end
 
   get '/:view' do |view|
-    erb view.to_sym, locals: { referrer: request.referrer }
+    view_template = "#{__dir__}/views/#{view}.erb"
+    has_layout = File.exist?(view_template) && File.open(view_template) { |f| f.first.downcase.include?('doctype') }
+    erb view.to_sym, locals: { referrer: request.referrer }, layout: !has_layout
   end
 
   post '/form' do
-    @@form_post_count += 1
-    '<pre id="results">' + params[:form].merge('post_count' => @@form_post_count).to_yaml + '</pre>'
+    self.class.form_post_count += 1
+    %(
+      <pre id="content_type">#{request.content_type}</pre>
+      <pre id="results">#{params.fetch(:form, {}).merge('post_count' => self.class.form_post_count).to_yaml}</pre>
+    )
   end
 
   post '/upload_empty' do
     if params[:form][:file].nil?
-      'Successfully ignored empty file field.'
+      "Successfully ignored empty file field. Content type was #{request.content_type}"
     else
       'Something went wrong.'
     end
   end
 
   post '/upload' do
-    begin
-      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
+    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
-      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'
+    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
+
+  class << self
+    attr_accessor :form_post_count
+  end
+
+  @form_post_count = 0
 end
 
 Rack::Handler::Puma.run TestApp, Port: 8070 if $PROGRAM_NAME == __FILE__