capybara 3.0.0 → 3.36.0

data/lib/capybara/spec/spec_helper.rb

@@ -1,11 +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"
+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
@@ -14,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!
@@ -29,11 +30,19 @@ module Capybara
         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.use_html5_parsing = !ENV['HTML5_PARSING'].nil?
+        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
@@ -47,25 +56,27 @@ 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)
+            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
@@ -80,68 +91,45 @@ 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
 
     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
-    end
-
-    def marionette?(session)
-      session.respond_to?(:driver) && session.driver.respond_to?(:marionette?, true) && session.driver.send(:marionette?)
-    end
-
-    def marionette_lt?(version, session)
-      marionette?(session) && (session.driver.browser.capabilities[:browser_version].to_f < version)
-    end
-
-    def marionette_gte?(version, session)
-      marionette?(session) && (session.driver.browser.capabilities[:browser_version].to_f >= version)
-    end
-
-    def chrome?(session)
-      session.respond_to?(:driver) && session.driver.respond_to?(:chrome?, true) && session.driver.send(:chrome?)
-    end
-
-    def chrome_lt?(version, session)
-      chrome?(session) && (session.driver.browser.capabilities[:version].to_f < version)
-    end
-
-    def chrome_gte?(version, session)
-      chrome?(session) && (session.driver.browser.capabilities[:version].to_f >= version)
+      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 edge?(session)
-      session.respond_to?(:driver) && session.driver.respond_to?(:edge?, true) && session.driver.send(:edge?)
+    def be_an_invalid_element_error(session)
+      satisfy { |error| session.driver.invalid_element_errors.any? { |e| error.is_a? e } }
     end
 
-    def ie?(session)
-      session.respond_to?(:driver) && session.driver.respond_to?(:ie?, true) && session.driver.send(:ie?)
+    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,14 +35,26 @@ 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>' \
-    '<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
@@ -49,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
@@ -59,14 +72,18 @@ 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
@@ -74,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
@@ -89,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
@@ -129,11 +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")
+    raise TestAppOtherError.new('something', 'other error')
   end
 
   get '/load_error' do
@@ -146,20 +163,35 @@ 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 '/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 }
+    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="results">#{params[:form].merge('post_count' => self.class.form_post_count).to_yaml}</pre>)
   end
 
   post '/upload_empty' do
@@ -171,28 +203,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.to_s]
-      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
+
+  class << self
+    attr_accessor :form_post_count
   end
+
+  @form_post_count = 0
 end
 
 Rack::Handler::Puma.run TestApp, Port: 8070 if $PROGRAM_NAME == __FILE__

data/lib/capybara/spec/views/animated.erb

@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
+    <title>with_animation</title>
+    <script src="/jquery.js" type="text/javascript" charset="utf-8"></script>
+    <script>
+      $(document).on('contextmenu', function(e){ e.preventDefault(); });
+    </script>
+    <style>
+      div {
+        width: 400px;
+        height: 400px;
+        position: absolute;
+      }
+      #obscured {
+        z-index: 1;
+        background-color: red;
+      }
+      #cover {
+        z-index: 2;
+        background-color: blue;
+      }
+      #offscreen {
+        top: 2000px;
+        left: 2000px;
+        background-color: green;
+      }
+      #offscreen_wrapper {
+        top: 2000px;
+        left: 2000px;
+        overflow-x: scroll;
+        background-color: yellow;
+      }
+    </style>
+  </head>
+
+  <body id="with_animation">
+    <div id="obscured">
+      <input id="obscured_input"/>
+    </div>
+    <div id="cover"></div>
+    <div id="offscreen_wrapper">
+      <div id="offscreen"></div>
+    </div>
+  </body>
+
+  <iframe id="frameOne" src="/frame_one"></iframe>
+</html>