capybara 3.26.0 → 3.27.0

data/lib/capybara/selenium/driver.rb

@@ -11,7 +11,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     clear_local_storage: nil,
     clear_session_storage: nil
   }.freeze
-  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout].freeze
+  SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze
   attr_reader :app, :options
 
   class << self
@@ -19,6 +19,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
       require 'selenium-webdriver'
       require 'capybara/selenium/logger_suppressor'
       require 'capybara/selenium/patches/atoms'
+      require 'capybara/selenium/patches/is_displayed'
       warn "Warning: You're using an unsupported version of selenium-webdriver, please upgrade." if Gem.loaded_specs['selenium-webdriver'].version < Gem::Version.new('3.5.0')
     rescue LoadError => e
       raise e unless e.message.match?(/selenium-webdriver/)

data/lib/capybara/selenium/driver_specializations/chrome_driver.rb

@@ -7,6 +7,8 @@ module Capybara::Selenium::Driver::ChromeDriver
   def self.extended(base)
     bridge = base.send(:bridge)
     bridge.extend Capybara::Selenium::ChromeLogs unless bridge.respond_to?(:log)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    base.options[:native_displayed] = false if base.options[:native_displayed].nil?
   end
 
   def fullscreen_window(handle)
@@ -43,8 +45,8 @@ module Capybara::Selenium::Driver::ChromeDriver
 
     timer = Capybara::Helpers.timer(expire_in: 10)
     begin
-      @browser.navigate.to('about:blank')
       clear_storage unless uniform_storage_clear?
+      @browser.navigate.to('about:blank')
       wait_for_empty_page(timer)
     rescue *unhandled_alert_errors
       accept_unhandled_reset_alert
@@ -63,12 +65,15 @@ private
   end
 
   def clear_all_storage?
-    options.values_at(:clear_session_storage, :clear_local_storage).none? { |s| s == false }
+    storage_clears.none? { |s| s == false }
   end
 
   def uniform_storage_clear?
-    clear = options.values_at(:clear_session_storage, :clear_local_storage)
-    clear.all? { |s| s == false } || clear.none? { |s| s == false }
+    storage_clears.uniq { |s| s == false }.length <= 1
+  end
+
+  def storage_clears
+    options.values_at(:clear_session_storage, :clear_local_storage)
   end
 
   def clear_storage

data/lib/capybara/selenium/driver_specializations/edge_driver.rb

@@ -39,8 +39,8 @@ module Capybara::Selenium::Driver::EdgeDriver
 
     timer = Capybara::Helpers.timer(expire_in: 10)
     begin
-      @browser.navigate.to('about:blank')
       clear_storage unless uniform_storage_clear?
+      @browser.navigate.to('about:blank')
       wait_for_empty_page(timer)
     rescue *unhandled_alert_errors
       accept_unhandled_reset_alert
@@ -68,17 +68,19 @@ private
   end
 
   def clear_all_storage?
-    options.values_at(:clear_session_storage, :clear_local_storage).none? { |s| s == false }
+    storage_clears.none? { |s| s == false }
   end
 
   def uniform_storage_clear?
-    clear = options.values_at(:clear_session_storage, :clear_local_storage)
-    clear.all? { |s| s == false } || clear.none? { |s| s == false }
+    storage_clears.uniq { |s| s == false }.length <= 1
+  end
+
+  def storage_clears
+    options.values_at(:clear_session_storage, :clear_local_storage)
   end
 
   def clear_storage
-    # Chrome errors if attempt to clear storage on about:blank
-    # In W3C mode it crashes chromedriver
+    # Edgedriver crashes if attempt to clear storage on about:blank
     url = current_url
     super unless url.nil? || url.start_with?('about:')
   end

data/lib/capybara/selenium/driver_specializations/firefox_driver.rb

@@ -5,18 +5,27 @@ require 'capybara/selenium/nodes/firefox_node'
 module Capybara::Selenium::Driver::FirefoxDriver
   def self.extended(driver)
     driver.extend Capybara::Selenium::Driver::W3CFirefoxDriver if w3c?(driver)
+    bridge = driver.send(:bridge)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
   end
 
   def self.w3c?(driver)
     (defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)) ||
       driver.browser.capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
   end
+
+private
+
+  def bridge
+    browser.send(:bridge)
+  end
 end
 
 module Capybara::Selenium::Driver::W3CFirefoxDriver
   class << self
     def extended(driver)
       require 'capybara/selenium/patches/pause_duration_fix' if pause_broken?(driver.browser)
+      driver.options[:native_displayed] = false if driver.options[:native_displayed].nil?
     end
 
     def pause_broken?(sel_driver)

data/lib/capybara/selenium/nodes/chrome_node.rb

@@ -55,10 +55,22 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     click unless selected_or_disabled
   end
 
+  def visible?
+    return super unless native_displayed?
+
+    begin
+      bridge.send(:execute, :is_element_displayed, id: native.ref)
+    rescue Selenium::WebDriver::Error::UnknownCommandError
+      # If the is_element_displayed command is unknown, no point in trying again
+      driver.options[:native_displayed] = false
+      super
+    end
+  end
+
 private
 
   def perform_legacy_drag(element)
-    return super unless (browser_version < 77.0) && w3c? && !element.obscured?
+    return super if chromedriver_fixed_actions_key_state? || !w3c? || element.obscured?
 
     # W3C Chrome/chromedriver < 77 doesn't maintain mouse button state across actions API performs
     # https://bugs.chromium.org/p/chromedriver/issues/detail?id=2981
@@ -78,11 +90,35 @@ private
 
   def w3c?
     (defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)) ||
-      driver.browser.capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
+      capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
+  end
+
+  def browser_version(to_float = true)
+    caps = capabilities
+    ver = (caps[:browser_version] || caps[:version])
+    ver = ver.to_f if to_float
+    ver
+  end
+
+  def chromedriver_fixed_actions_key_state?
+    Gem::Version.new(chromedriver_version) >= Gem::Version.new('76.0.3809.68')
+  end
+
+  def chromedriver_supports_displayed_endpoint?
+    Gem::Version.new(chromedriver_version) >= Gem::Version.new('76.0.3809.25')
+  end
+
+  def chromedriver_version
+    capabilities['chrome']['chromedriverVersion'].split(' ')[0]
+  end
+
+  def capabilities
+    driver.browser.capabilities
   end
 
-  def browser_version
-    caps = driver.browser.capabilities
-    (caps[:browser_version] || caps[:version]).to_f
+  def native_displayed?
+    (driver.options[:native_displayed] != false) &&
+      (w3c? && chromedriver_supports_displayed_endpoint?) &&
+      (!ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS'])
   end
 end

data/lib/capybara/selenium/nodes/firefox_node.rb

@@ -65,8 +65,24 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
     click unless selected_or_disabled
   end
 
+  def visible?
+    return super unless native_displayed?
+
+    begin
+      bridge.send(:execute, :is_element_displayed, id: native.ref)
+    rescue Selenium::WebDriver::Error::UnknownCommandError
+      # If the is_element_displayed command is unknown, no point in trying again
+      driver.options[:native_displayed] = false
+      super
+    end
+  end
+
 private
 
+  def native_displayed?
+    (driver.options[:native_displayed] != false) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']
+  end
+
   def click_with_options(click_options)
     # Firefox/marionette has an issue clicking with offset near viewport edge
     # scroll element to middle just in case

data/lib/capybara/selenium/patches/is_displayed.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Selenium
+    module IsDisplayed
+      def commands(command)
+        case command
+        when :is_element_displayed
+          [:get, 'session/:session_id/element/:id/displayed']
+        else
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -233,8 +233,9 @@ Capybara::SpecHelper.spec 'node' do
   end
 
   describe '#visible?' do
+    before { Capybara.ignore_hidden_elements = false }
+
     it 'should extract node visibility' do
-      Capybara.ignore_hidden_elements = false
       expect(@session.first('//a')).to be_visible
 
       expect(@session.find('//div[@id="hidden"]')).not_to be_visible
@@ -245,15 +246,29 @@ Capybara::SpecHelper.spec 'node' do
     end
 
     it 'template elements should not be visible' do
-      Capybara.ignore_hidden_elements = false
       expect(@session.find('//template')).not_to be_visible
     end
 
     it 'should be boolean' do
-      Capybara.ignore_hidden_elements = false
       expect(@session.first('//a').visible?).to be true
       expect(@session.find('//div[@id="hidden"]').visible?).to be false
     end
+
+    it 'details > summary elements and descendants should be visible' do
+      expect(@session.find(:css, 'details summary')).to be_visible
+      expect(@session.find(:css, 'details summary h6')).to be_visible
+    end
+
+    it 'details non-summary descendants should be non-visible' do
+      @session.first(:css, 'details li').visible?
+      descendants = @session.all(:css, 'details > *:not(summary), details > *:not(summary) *', minimum: 2)
+      expect(descendants).not_to include(be_visible)
+    end
+
+    it 'sees open details as visible', requires: [:js] do
+      @session.find(:css, 'details').click
+      expect(@session.all(:css, 'details *')).to all(be_visible)
+    end
   end
 
   describe '#obscured?', requires: [:css] do
@@ -987,6 +1002,28 @@ Capybara::SpecHelper.spec 'node' do
   end
 
   describe '#reload', requires: [:js] do
+    it 'should reload elements found via ancestor with CSS' do
+      @session.visit('/with_js')
+      node = @session.find(:css, '#reload-me em').ancestor(:css, 'div')
+      node.reload
+      expect(node[:id]).to eq 'reload-me'
+    end
+
+    it 'should reload elements found via ancestor with XPath' do
+      @session.visit('/with_js')
+      node = @session.find(:css, '#reload-me em').ancestor(:xpath, './/div')
+      node.reload
+      expect(node[:id]).to eq 'reload-me'
+    end
+
+    it 'should reload elements found via sibling' do
+      @session.visit('/with_js')
+      node = @session.find(:css, '#the-list li', text: 'Item 1').sibling(:css, 'li')
+      expect(node.text).to eq 'Item 2'
+      node.reload
+      expect(node.text).to eq 'Item 2'
+    end
+
     context 'without automatic reload' do
       before { Capybara.automatic_reload = false }
 

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

@@ -181,6 +181,16 @@ banana
                   　
 </div>
 
+<details>
+  <summary>
+    <h6>Something</h6>
+  </summary>
+  <ul>
+    <li>Random</li>
+    <li>Things</li>
+  </ul>
+</details>
+
 <template id="template">
   <input />
 </template>

data/lib/capybara/version.rb

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

data/spec/basic_node_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 RSpec.describe Capybara do
   describe '.string' do
     let :string do
-      Capybara.string <<-STRING
+      described_class.string <<-STRING
         <html>
           <head>
             <title>simple_node</title>
@@ -52,7 +52,7 @@ RSpec.describe Capybara do
     end
 
     it 'allows using custom matchers' do
-      Capybara.add_selector :lifeform do
+      described_class.add_selector :lifeform do
         xpath { |name| ".//option[contains(.,'#{name}')]" }
       end
       expect(string).to have_selector(:id, 'page')
@@ -62,7 +62,7 @@ RSpec.describe Capybara do
     end
 
     it 'allows custom matcher using css' do
-      Capybara.add_selector :section do
+      described_class.add_selector :section do
         css { |css_class| "section .#{css_class}" }
       end
       expect(string).to     have_selector(:section, 'subsection')
@@ -112,13 +112,13 @@ RSpec.describe Capybara do
 
     it 'drops illegal fragments when using gumbo' do
       skip 'libxml is less strict than Gumbo' unless Nokogiri.respond_to?(:HTML5)
-      expect(Capybara.string('<td>1</td>')).not_to have_css('td')
+      expect(described_class.string('<td>1</td>')).not_to have_css('td')
     end
 
     it 'can disable use of gumbo' do
       skip "Test doesn't make sense unlesss nokogumbo is loaded" unless Nokogiri.respond_to?(:HTML5)
-      Capybara.allow_gumbo = false
-      expect(Capybara.string('<td>1</td>')).to have_css('td')
+      described_class.allow_gumbo = false
+      expect(described_class.string('<td>1</td>')).to have_css('td')
     end
 
     describe '#title' do

data/spec/capybara_spec.rb

@@ -4,20 +4,20 @@ require 'spec_helper'
 
 RSpec.describe Capybara do
   describe 'default_max_wait_time' do
-    before { @previous_default_time = Capybara.default_max_wait_time }
+    before { @previous_default_time = described_class.default_max_wait_time }
 
-    after { Capybara.default_max_wait_time = @previous_default_time } # rubocop:disable RSpec/InstanceVariable
+    after { described_class.default_max_wait_time = @previous_default_time } # rubocop:disable RSpec/InstanceVariable
 
     it 'should be changeable' do
-      expect(Capybara.default_max_wait_time).not_to eq(5)
-      Capybara.default_max_wait_time = 5
-      expect(Capybara.default_max_wait_time).to eq(5)
+      expect(described_class.default_max_wait_time).not_to eq(5)
+      described_class.default_max_wait_time = 5
+      expect(described_class.default_max_wait_time).to eq(5)
     end
   end
 
   describe '.register_driver' do
     it 'should add a new driver' do
-      Capybara.register_driver :schmoo do |app|
+      described_class.register_driver :schmoo do |app|
         Capybara::RackTest::Driver.new(app)
       end
       session = Capybara::Session.new(:schmoo, TestApp)
@@ -28,85 +28,85 @@ RSpec.describe Capybara do
 
   describe '.register_server' do
     it 'should add a new server' do
-      Capybara.register_server :blob do |_app, _port, _host|
+      described_class.register_server :blob do |_app, _port, _host|
         # do nothing
       end
 
-      expect(Capybara.servers).to have_key(:blob)
+      expect(described_class.servers).to have_key(:blob)
     end
   end
 
   describe '.server' do
     after do
-      Capybara.server = :default
+      described_class.server = :default
     end
 
     it 'should default to a proc that calls run_default_server' do
       mock_app = Object.new
-      allow(Capybara).to receive(:run_default_server).and_return(true)
-      Capybara.server.call(mock_app, 8000)
-      expect(Capybara).to have_received(:run_default_server).with(mock_app, 8000)
+      allow(described_class).to receive(:run_default_server).and_return(true)
+      described_class.server.call(mock_app, 8000)
+      expect(described_class).to have_received(:run_default_server).with(mock_app, 8000)
     end
 
     it 'should return a custom server proc' do
       server = ->(_app, _port) {}
-      Capybara.register_server :custom, &server
-      Capybara.server = :custom
-      expect(Capybara.server).to eq(server)
+      described_class.register_server :custom, &server
+      described_class.server = :custom
+      expect(described_class.server).to eq(server)
     end
 
     it 'should have :webrick registered' do
-      expect(Capybara.servers[:webrick]).not_to be_nil
+      expect(described_class.servers[:webrick]).not_to be_nil
     end
 
     it 'should have :puma registered' do
-      expect(Capybara.servers[:puma]).not_to be_nil
+      expect(described_class.servers[:puma]).not_to be_nil
     end
   end
 
   describe 'server=' do
     after do
-      Capybara.server = :default
+      described_class.server = :default
     end
 
     it 'accepts a proc' do
       server = ->(_app, _port) {}
-      Capybara.server = server
-      expect(Capybara.server).to eq server
+      described_class.server = server
+      expect(described_class.server).to eq server
     end
   end
 
   describe 'app_host' do
     after do
-      Capybara.app_host = nil
+      described_class.app_host = nil
     end
 
     it 'should warn if not a valid URL' do
-      expect { Capybara.app_host = 'www.example.com' }.to raise_error(ArgumentError, /Capybara\.app_host should be set to a url/)
+      expect { described_class.app_host = 'www.example.com' }.to raise_error(ArgumentError, /Capybara\.app_host should be set to a url/)
     end
 
     it 'should not warn if a valid URL' do
-      expect { Capybara.app_host = 'http://www.example.com' }.not_to raise_error
+      expect { described_class.app_host = 'http://www.example.com' }.not_to raise_error
     end
 
     it 'should not warn if nil' do
-      expect { Capybara.app_host = nil }.not_to raise_error
+      expect { described_class.app_host = nil }.not_to raise_error
     end
   end
 
   describe 'default_host' do
     around do |test|
-      old_default = Capybara.default_host
+      old_default = described_class.default_host
       test.run
-      Capybara.default_host = old_default
+      described_class.default_host = old_default
     end
 
     it 'should raise if not a valid URL' do
-      expect { Capybara.default_host = 'www.example.com' }.to raise_error(ArgumentError, /Capybara\.default_host should be set to a url/)
+      expect { described_class.default_host = 'www.example.com' }.to raise_error(ArgumentError, /Capybara\.default_host should be set to a url/)
     end
 
     it 'should not warn if a valid URL' do
-      expect { Capybara.default_host = 'http://www.example.com' }.not_to raise_error
+      expect { described_class.default_host = 'http://www.example.com' }.not_to raise_error
     end
   end
 end