capybara 3.35.2 → 3.37.0

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

@@ -15,7 +15,7 @@ Capybara::SpecHelper.spec '#scroll_to', requires: [:scroll] do
     el = @session.find(:css, '#scroll')
     @session.scroll_to(el, align: :bottom)
     el_bottom = el.evaluate_script('this.getBoundingClientRect().bottom')
-    viewport_bottom = el.evaluate_script('document.body.clientHeight')
+    viewport_bottom = el.evaluate_script('document.documentElement.clientHeight')
     expect(el_bottom).to be_within(1).of(viewport_bottom)
   end
 
@@ -23,7 +23,7 @@ Capybara::SpecHelper.spec '#scroll_to', requires: [:scroll] do
     el = @session.find(:css, '#scroll')
     @session.scroll_to(el, align: :center)
     el_center = el.evaluate_script('(function(rect){return (rect.top + rect.bottom)/2})(this.getBoundingClientRect())')
-    viewport_bottom = el.evaluate_script('document.body.clientHeight')
+    viewport_bottom = el.evaluate_script('document.documentElement.clientHeight')
     expect(el_center).to be_within(2).of(viewport_bottom / 2)
   end
 
@@ -35,13 +35,13 @@ Capybara::SpecHelper.spec '#scroll_to', requires: [:scroll] do
 
   it 'can scroll the window to the vertical bottom' do
     @session.scroll_to :bottom
-    max_scroll = @session.evaluate_script('document.body.scrollHeight - document.body.clientHeight')
+    max_scroll = @session.evaluate_script('document.documentElement.scrollHeight - document.documentElement.clientHeight')
     expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [0, max_scroll]
   end
 
   it 'can scroll the window to the vertical center' do
     @session.scroll_to :center
-    max_scroll = @session.evaluate_script('document.documentElement.scrollHeight - document.body.clientHeight')
+    max_scroll = @session.evaluate_script('document.documentElement.scrollHeight - document.documentElement.clientHeight')
     expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [0, max_scroll / 2]
   end
 

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

@@ -201,4 +201,18 @@ Capybara::SpecHelper.spec '#visit' do
     @session.visit('/get_cookie')
     expect(@session).to have_content('root cookie')
   end
+
+  context 'with base element' do
+    it 'should use base href with relative links' do
+      @session.visit('/base/with_base')
+      @session.click_link('Title page')
+      expect(@session).to have_current_path('/with_title')
+    end
+
+    it 'should use base href with bare queries' do
+      @session.visit('/base/with_base')
+      @session.click_link('Bare query')
+      expect(@session).to have_current_path('/?a=3')
+    end
+  end
 end

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

@@ -59,7 +59,7 @@ Capybara::SpecHelper.spec Capybara::Window, requires: [:windows] do
     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)
+      expect(other_window.current?).to be(false)
     end
   end
 

data/lib/capybara/spec/spec_helper.rb

@@ -36,7 +36,7 @@ module Capybara
         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 = false
         reset_threadsafe
       end
@@ -117,8 +117,9 @@ module Capybara
 
     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 be_an_invalid_element_error(session)

data/lib/capybara/spec/test_app.rb

@@ -53,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
@@ -163,21 +163,63 @@ 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 '/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 '/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 '/: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

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

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html>
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
@@ -46,4 +47,3 @@
 
   <iframe id="frameOne" src="/frame_one"></iframe>
 </html>
-

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

@@ -1,11 +1,17 @@
-
 <h1>Form</h1>
 
+<button type="button" tabindex="1">A Button</button>
+
+<label>
+  An Input
+  <input type="text" tabindex="2">
+</label>
+
 <form action="/form" method="post" novalidate>
 
   <p>
     <label for="form_title">Title</label>
-    <select name="form[title]" id="form_title" class="title">
+    <select name="form[title]" id="form_title" class="title" tabindex="3">
       <option class="title">Mrs</option>
       <option class="title">Mr</option>
       <option>Miss</option>
@@ -170,7 +176,7 @@ New line after and before textarea tag
     <label for="gender_male">Male</label>
     <input type="radio" name="form[gender]" value="female" id="gender_female" checked="checked"/>
     <label for="gender_female">Female</label>
-    <input type="radio" name="form[gender]" value="both" id="gender_both"/>
+    <input type="radio" name="form[gender]" value="both" id="gender_both" readonly="readonly"/>
     <label for="gender_both">Both</label>
   </p>
 
@@ -223,6 +229,8 @@ New line after and before textarea tag
     </label>
     <input type="checkbox" value="maserati" name="form[cars][]" id="form_cars_maserati" disabled="disabled"/>
     <label for="form_cars_maserati">Maserati</label>
+    <input type="checkbox" value="lotus" name="form[cars][]" id="form_cars_lotus" style="display: none"/>
+    <label for="form_cars_lotus"><a href="#" onclick="return false;">Link here</a>Lotus</label>
   </p>
 
   <p>

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

@@ -1,4 +1,4 @@
-
+<!DOCTYPE html>
 <html>
     <head>
         <title>This is the child frame title</title>

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

@@ -1,4 +1,4 @@
-
+<!DOCTYPE html>
 <html>
     <head>
         <title>This is the title of frame one</title>

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

@@ -1,4 +1,4 @@
-
+<!DOCTYPE html>
 <html>
     <head>
         <title>This is the parent frame title</title>

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

@@ -1,4 +1,4 @@
-
+<!DOCTYPE html>
 <html>
     <head>
         <title>This is the title of frame two</title>

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

@@ -1,4 +1,5 @@
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<!DOCTYPE html>
+<html lang="en">
   <body>
     <div>
       Initial alert page

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

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

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

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html>
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
@@ -44,4 +45,3 @@
     </div>
   </body>
 </html>
-

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

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html>
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
@@ -29,4 +30,4 @@
       <div id="clicker"></div>
     </div>
   </body>
-  </html>
+  </html>

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

@@ -1,5 +1,5 @@
-
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<!DOCTYPE html>
+<html lang="en">
   <body>
     <div>
       <a href="#">First Link</a>

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

@@ -1,4 +1,4 @@
-
+<!DOCTYPE html>
 <html>
     <head>
         <title>Title of the first popup</title>

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

@@ -1,4 +1,4 @@
-
+<!DOCTYPE html>
 <html>
     <head>
         <title>Title of popup two</title>

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

@@ -1,4 +1,4 @@
-<!doctype html>
+<!DOCTYPE html>
 <html>
   <head>
     <script src="https://unpkg.com/react/umd/react.development.js"></script>
@@ -42,4 +42,4 @@
         document.getElementById('root'));
     </script>
   </body>
-</html>
+</html>

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

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html style="height: 250%; width: 150%">
   <head>
     <style>
@@ -17,4 +18,4 @@
     </div>
   </div>
   </body>
-</html>
+</html>

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

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html>
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
@@ -28,4 +29,3 @@
     <div class="footer distance">10</div>
   </body>
 </html>
-

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

@@ -1,5 +1,5 @@
-
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<!DOCTYPE html>
+<html lang="en">
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
     <title>with_animation</title>
@@ -79,4 +79,3 @@
     </a>
   </body>
 </html>
-

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

@@ -1,5 +1,5 @@
-
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<!DOCTYPE html>
+<html lang="en">
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
     <base href="http://example2.com" />

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

@@ -1,4 +1,5 @@
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<!DOCTYPE html>
+<html lang="en">
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
     <title>with_dragula</title>
@@ -21,4 +22,3 @@
     </script>
   </body>
 </html>
-

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

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html>
 <head>
   <style>
@@ -14,4 +15,4 @@
       <a href="/">Go to root</a>
     </div>
   <footer>My footer</footer>
-</body>
+</body>

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

@@ -1,5 +1,5 @@
-
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<!DOCTYPE html>
+<html lang="en">
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
     <title>with_hover</title>

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

@@ -19,7 +19,7 @@
 
 <p class="para" id="first" data-random="abc\def" style="line-height: 25px;">
   Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
-  tempor incididunt ut <a href="/with_simple_html" title="awesome title" class="simple">labore</a>
+  tempor incididunt ut <a href="/with_simple_html" title="awesome title" class="simple" tabindex="1">labore</a>
   et dolore magna aliqua. Ut enim ad minim veniam,
   quis nostrud exercitation <a href="/foo" id="foo" data-test-id="test-foo">ullamco</a> laboris nisi
   ut aliquip ex ea commodo consequat.

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

@@ -1,4 +1,4 @@
-
+<!DOCTYPE html>
 <html>
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>

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

@@ -1,5 +1,5 @@
-
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<!DOCTYPE html>
+<html lang="en">
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
     <title>with_js</title>
@@ -160,4 +160,3 @@
     </script>
   </body>
 </html>
-

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

@@ -1,4 +1,4 @@
-<!doctype html>
+<!DOCTYPE html>
 <html>
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>

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

@@ -1,3 +1,4 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <title>Namespace</title>

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

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<%# Borrowed from Titus Fortner %>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>Shadow DOM</title>
+  </head>
+  <body>
+    <div id="no_host"></div>
+    <div id="shadow_host"></div>
+    <a href="scroll.html">scroll.html</a>
+    <script>
+      let shadowRoot = document.getElementById('shadow_host').attachShadow({mode: 'open'});
+      shadowRoot.innerHTML = `
+              <span class="wrapper" id="shadow_content"><span class="info">some text</span></span>
+              <div id="nested_shadow_host"></div>
+              <a href="scroll.html">scroll.html</a>
+	  		  <div id="controls_wrapper">
+                <input type="text" />
+                <input type="checkbox" id="shadow_checkbox" />
+                <input type="file" />
+	 		  </div>
+            `;
+
+      let nestedShadowRoot = shadowRoot.getElementById('nested_shadow_host').attachShadow({mode: 'open'});
+      nestedShadowRoot.innerHTML = `
+              <div id="nested_shadow_content"><div>nested text</div></div>
+            `;
+    </script>
+  </body>
+</html>

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

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html>
 <head>
   <script>
@@ -14,4 +15,4 @@
 <body>
   <div>This delays unload by 2 seconds</div>
 </body>
-</html>
+</html>

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

@@ -1,4 +1,5 @@
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<!DOCTYPE html>
+<html lang="en">
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
     <title>with_sortable_js</title>
@@ -18,4 +19,3 @@
     </script>
   </body>
 </html>
-

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

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html>
 <head>
   <script>

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

@@ -1,4 +1,4 @@
-
+<!DOCTYPE html>
 <html>
   <head>
     <title>With Windows</title>

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

@@ -1,4 +1,4 @@
-
+<!DOCTYPE html>
 <html>
     <head>
         <title>With Frames</title>

data/lib/capybara/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Capybara
-  VERSION = '3.35.2'
+  VERSION = '3.37.0'
 end

data/lib/capybara/window.rb

@@ -118,7 +118,7 @@ module Capybara
     alias_method :==, :eql?
 
     def hash
-      @session.hash ^ @handle.hash
+      [@session, @handle].hash
     end
 
     def inspect

data/lib/capybara.rb

@@ -39,7 +39,7 @@ module Capybara
     #   See {Capybara.configure}
     # @!method javascript_driver
     #   See {Capybara.configure}
-    # @!method allow_gumbo
+    # @!method use_html5_parsing
     #   See {Capybara.configure}
     Config::OPTIONS.each do |method|
       def_delegators :config, method, "#{method}="
@@ -69,7 +69,7 @@ module Capybara
     #
     # #### Configurable options
     #
-    # - **allow_gumbo** (Boolean = `false`) - When `nokogumbo` is available, whether it will be used to parse HTML strings.
+    # - **use_html5_parsing** (Boolean = `false`) - When Nokogiri >= 1.12.0 or `nokogumbo` is installed, whether HTML5 parsing will be used for HTML strings.
     # - **always_include_port** (Boolean = `false`) - Whether the Rack server's port should automatically be inserted into every visited URL
     #   unless another port is explicitly specified.
     # - **app_host** (String, `nil`) - The default host to use when giving a relative URL to visit, must be a valid URL e.g. `http://www.example.com`.
@@ -96,6 +96,7 @@ module Capybara
     #   {Capybara::Session#save_and_open_page save_and_open_page}, or {Capybara::Session#save_and_open_screenshot save_and_open_screenshot}.
     # - **server** (Symbol = `:default` (which uses puma)) - The name of the registered server to use when running the app under test.
     # - **server_port** (Integer) - The port Capybara will run the application server on, if not specified a random port will be used.
+    # - **server_host** (String = "127.0.0.1") - The IP address Capybara will bind the application server to. If the test application is to be accessed from an external host, you will want to change this to "0.0.0.0" or to a more specific IP address that your test client can reach.
     # - **server_errors** (Array\<Class> = `[Exception]`) - Error classes that should be raised in the tests if they are raised in the server
     #   and {configure raise_server_errors} is `true`.
     # - **test_id** (Symbol, String, `nil` = `nil`) - Optional attribute to match locator against with built-in selectors along with id.
@@ -385,26 +386,21 @@ module Capybara
     # @return [Nokogiri::HTML::Document]      HTML document
     #
     def HTML(html) # rubocop:disable Naming/MethodName
-      if Nokogiri.respond_to?(:HTML5) && Capybara.allow_gumbo # Nokogumbo installed and allowed for use
-        Nokogiri::HTML5(html).tap do |document|
-          document.xpath('//template').each do |template|
-            # template elements content is not part of the document
-            template.inner_html = ''
-          end
-          document.xpath('//textarea').each do |textarea|
-            # The Nokogumbo HTML5 parser already returns spec compliant contents
-            textarea['_capybara_raw_value'] = textarea.content
-          end
-        end
+      # Nokogiri >= 1.12.0 or Nokogumbo installed and allowed for use
+      html_parser, using_html5 = if defined?(Nokogiri::HTML5) && Capybara.use_html5_parsing
+        [Nokogiri::HTML5, true]
       else
-        Nokogiri::HTML(html).tap do |document|
-          document.xpath('//template').each do |template|
-            # template elements content is not part of the document
-            template.inner_html = ''
-          end
-          document.xpath('//textarea').each do |textarea|
-            textarea['_capybara_raw_value'] = textarea.content.delete_prefix("\n")
-          end
+        [defined?(Nokogiri::HTML4) ? Nokogiri::HTML4 : Nokogiri::HTML, false]
+      end
+
+      html_parser.parse(html).tap do |document|
+        document.xpath('//template').each do |template|
+          # template elements content is not part of the document
+          template.inner_html = ''
+        end
+        document.xpath('//textarea').each do |textarea|
+          # The Nokogiri HTML5 parser already returns spec compliant contents
+          textarea['_capybara_raw_value'] = using_html5 ? textarea.content : textarea.content.delete_prefix("\n")
         end
       end
     end
@@ -467,6 +463,7 @@ module Capybara
   require 'capybara/queries/ancestor_query'
   require 'capybara/queries/sibling_query'
   require 'capybara/queries/style_query'
+  require 'capybara/queries/active_element_query'
 
   require 'capybara/node/finders'
   require 'capybara/node/matchers'
@@ -516,6 +513,6 @@ Capybara.configure do |config|
   config.test_id = nil
   config.predicates_wait = true
   config.default_normalize_ws = false
-  config.allow_gumbo = false
+  config.use_html5_parsing = false
   config.w3c_click_offset = false
 end