capybara 3.19.1 → 3.20.0

data/lib/capybara/selenium/driver.rb

@@ -18,6 +18,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     def load_selenium
       require 'selenium-webdriver'
       require 'capybara/selenium/logger_suppressor'
+      require 'capybara/selenium/patches/atoms'
       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/)
@@ -135,6 +136,18 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     end
   end
 
+  def frame_obscured_at?(x:, y:)
+    frame = @frame_handles[current_window_handle].last
+    return false unless frame
+
+    switch_to_frame(:parent)
+    begin
+      return frame.base.obscured?(x: x, y: y)
+    ensure
+      switch_to_frame(frame)
+    end
+  end
+
   def switch_to_frame(frame)
     handles = @frame_handles[current_window_handle]
     case frame
@@ -145,7 +158,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
       handles.pop
       browser.switch_to.parent_frame
     else
-      handles << frame.native
+      handles << frame
       browser.switch_to.frame(frame.native)
     end
   end

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

@@ -60,7 +60,7 @@ module Capybara::Selenium::Driver::W3CFirefoxDriver
     # so we have to move to the default_content and iterate back through the frames
     handles = @frame_handles[current_window_handle]
     browser.switch_to.default_content
-    handles.tap(&:pop).each { |fh| browser.switch_to.frame(fh) }
+    handles.tap(&:pop).each { |fh| browser.switch_to.frame(fh.native) }
   end
 
 private

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

@@ -10,7 +10,7 @@ module Capybara::Selenium::Driver::InternetExplorerDriver
     # so we have to move to the default_content and iterate back through the frames
     handles = @frame_handles[current_window_handle]
     browser.switch_to.default_content
-    handles.tap(&:pop).each { |fh| browser.switch_to.frame(fh) }
+    handles.tap(&:pop).each { |fh| browser.switch_to.frame(fh.native) }
   end
 
 private

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

@@ -10,7 +10,7 @@ module Capybara::Selenium::Driver::SafariDriver
     # behaves like switch_to_frame(:top)
     handles = @frame_handles[current_window_handle]
     browser.switch_to.default_content
-    handles.tap(&:pop).each { |fh| browser.switch_to.frame(fh) }
+    handles.tap(&:pop).each { |fh| browser.switch_to.frame(fh.native) }
   end
 
 private

data/lib/capybara/selenium/node.rb

@@ -155,7 +155,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def content_editable?
-    native.attribute('isContentEditable')
+    native.attribute('isContentEditable') == 'true'
   end
 
   def ==(other)
@@ -166,6 +166,13 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     driver.evaluate_script GET_XPATH_SCRIPT, self
   end
 
+  def obscured?(x: nil, y: nil)
+    res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y)
+    return true if res == true
+
+    driver.frame_obscured_at?(x: res['x'], y: res['y'])
+  end
+
 protected
 
   def scroll_if_needed
@@ -401,6 +408,23 @@ private
     })(arguments[0], document)
   JS
 
+  OBSCURED_OR_OFFSET_SCRIPT = <<~'JS'
+    (function(el, x, y) {
+      var box = el.getBoundingClientRect();
+      if (x == null) x = box.width/2;
+      if (y == null) y = box.height/2 ;
+
+      var px = box.left + x,
+          py = box.top + y,
+          e = document.elementFromPoint(px, py);
+
+      if (!el.contains(e))
+        return true;
+
+      return { x: px, y: py };
+    })(arguments[0], arguments[1], arguments[2])
+  JS
+
   # SettableValue encapsulates time/date field formatting
   class SettableValue
     attr_reader :value

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

@@ -16,6 +16,10 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
       return find_css('th:first-child,td:first-child')[0].click(keys, options)
     end
     raise
+  rescue ::Selenium::WebDriver::Error::WebDriverError
+    # Safari doesn't return a specific error here - assume it's an ElementNotInteractableError
+    raise ::Selenium::WebDriver::Error::ElementNotInteractableError,
+          'Non distinct error raised in #click, translated to ElementNotInteractableError for retry'
   end
 
   def select_option
@@ -54,7 +58,9 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
   end
 
   def send_keys(*args)
-    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none? { |arg| arg.is_a? Array }
+    if args.none? { |arg| arg.is_a?(Array) || (arg.is_a?(Symbol) && MODIFIER_KEYS.include?(arg)) }
+      return super(*args.map { |arg| arg == :space ? ' ' : arg })
+    end
 
     native.click
     _send_keys(args).perform
@@ -74,6 +80,11 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
     end
   end
 
+  def hover
+    # Workaround issue where hover would sometimes fail - possibly due to mouse not having moved
+    scroll_if_needed { browser_action.move_to(native, 0, 0).move_to(native).perform }
+  end
+
 private
 
   def bridge
@@ -95,11 +106,7 @@ private
 
   def _send_keys(keys, actions = browser_action, down_keys = ModifierKeysStack.new)
     case keys
-    when :control, :left_control, :right_control,
-         :alt, :left_alt, :right_alt,
-         :shift, :left_shift, :right_shift,
-         :meta, :left_meta, :right_meta,
-         :command
+    when *MODIFIER_KEYS
       down_keys.press(keys)
       actions.key_down(keys)
     when String
@@ -117,6 +124,12 @@ private
     actions
   end
 
+  MODIFIER_KEYS = %i[control left_control right_control
+                     alt left_alt right_alt
+                     shift left_shift right_shift
+                     meta left_meta right_meta
+                     command].freeze
+
   class ModifierKeysStack
     def initialize
       @stack = []

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CapybaraAtoms
+private # rubocop:disable Layout/IndentationWidth
+
+  def read_atom(function)
+    @atoms ||= Hash.new do |hash, key|
+      hash[key] = begin
+                    File.read(File.expand_path("../../atoms/#{key}.min.js", __FILE__))
+                  rescue Errno::ENOENT
+                    super
+                  end
+    end
+    @atoms[function]
+  end
+end
+
+::Selenium::WebDriver::Remote::Bridge.prepend CapybaraAtoms unless ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']

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

@@ -100,6 +100,29 @@ Capybara::SpecHelper.spec '#all' do
     end
   end
 
+  context 'with obscured filter', requires: [:css] do
+    it 'should only find nodes on top in the viewport when false' do
+      expect(@session.all(:css, 'a.simple', obscured: false).size).to eq(1)
+    end
+
+    it 'should not find nodes on top outside the viewport when false' do
+      expect(@session.all(:link, 'Download Me', obscured: false).size).to eq(0)
+      @session.scroll_to(@session.find_link('Download Me'))
+      expect(@session.all(:link, 'Download Me', obscured: false).size).to eq(1)
+    end
+
+    it 'should find top nodes outside the viewport when true' do
+      expect(@session.all(:link, 'Download Me', obscured: true).size).to eq(1)
+      @session.scroll_to(@session.find_link('Download Me'))
+      expect(@session.all(:link, 'Download Me', obscured: true).size).to eq(0)
+    end
+
+    it 'should only find non-top nodes when true' do
+      # Also need visible: false so visibility is ignored
+      expect(@session.all(:css, 'a.simple', visible: false, obscured: true).size).to eq(1)
+    end
+  end
+
   context 'with element count filters' do
     context ':count' do
       it 'should succeed when the number of elements founds matches the expectation' do

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

@@ -118,6 +118,17 @@ Capybara::SpecHelper.spec '#click_link' do
         expect { @session.click_link('Normal Anchor', href: nil) }.to raise_error(Capybara::ElementNotFound, /with no href attribute/)
       end
     end
+
+    context 'href: false' do
+      it 'should not raise an error on links with no href attribute' do
+        expect { @session.click_link('No Href', href: false) }.not_to raise_error
+      end
+
+      it 'should not raise an error if href attribute exists' do
+        expect { @session.click_link('Blank Href', href: false) }.not_to raise_error
+        expect { @session.click_link('Normal Anchor', href: false) }.not_to raise_error
+      end
+    end
   end
 
   it 'should follow relative links' do

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

@@ -251,6 +251,79 @@ Capybara::SpecHelper.spec 'node' do
     end
   end
 
+  describe '#obscured?', requires: [:css] do
+    it 'should see non visible elements as obscured' do
+      Capybara.ignore_hidden_elements = false
+      expect(@session.find('//div[@id="hidden"]')).to be_obscured
+      expect(@session.find('//div[@id="hidden_via_ancestor"]')).to be_obscured
+      expect(@session.find('//div[@id="hidden_attr"]')).to be_obscured
+      expect(@session.find('//a[@id="hidden_attr_via_ancestor"]')).to be_obscured
+      expect(@session.find('//input[@id="hidden_input"]')).to be_obscured
+    end
+
+    it 'should see non-overlapped elements as not obscured' do
+      @session.visit('/obscured')
+      expect(@session.find(:css, '#cover')).not_to be_obscured
+    end
+
+    it 'should see elements only overlapped by descendants as not obscured' do
+      expect(@session.first(:css, 'p:not(.para)')).not_to be_obscured
+    end
+
+    it 'should see elements outside the viewport as obscured' do
+      @session.visit('/obscured')
+      off = @session.find(:css, '#offscreen')
+      off_wrapper = @session.find(:css, '#offscreen_wrapper')
+      expect(off).to be_obscured
+      expect(off_wrapper).to be_obscured
+      @session.scroll_to(off_wrapper)
+      expect(off_wrapper).not_to be_obscured
+      expect(off).to be_obscured
+      off_wrapper.scroll_to(off)
+      expect(off).not_to be_obscured
+      expect(off_wrapper).not_to be_obscured
+    end
+
+    it 'should see overlapped elements as obscured' do
+      @session.visit('/obscured')
+      expect(@session.find(:css, '#obscured')).to be_obscured
+    end
+
+    it 'should be boolean' do
+      Capybara.ignore_hidden_elements = false
+      expect(@session.first('//a').obscured?).to be false
+      expect(@session.find('//div[@id="hidden"]').obscured?).to be true
+    end
+
+    it 'should work in frames' do
+      @session.visit('/obscured')
+      frame = @session.find(:css, '#frameOne')
+      @session.within_frame(frame) do
+        div = @session.find(:css, '#divInFrameOne')
+        expect(div).to be_obscured
+        @session.scroll_to div
+        expect(div).not_to be_obscured
+      end
+    end
+
+    it 'should work in nested iframes' do
+      @session.visit('/obscured')
+      frame = @session.find(:css, '#nestedFrames')
+      @session.within_frame(frame) do
+        @session.within_frame(:css, '#childFrame') do
+          gcframe = @session.find(:css, '#grandchildFrame2')
+          @session.within_frame(gcframe) do
+            expect(@session.find(:css, '#divInFrameTwo')).to be_obscured
+          end
+          @session.scroll_to(gcframe)
+          @session.within_frame(gcframe) do
+            expect(@session.find(:css, '#divInFrameTwo')).not_to be_obscured
+          end
+        end
+      end
+    end
+  end
+
   describe '#checked?' do
     it 'should extract node checked state' do
       @session.visit('/form')
@@ -441,7 +514,7 @@ Capybara::SpecHelper.spec 'node' do
     end
 
     it 'should retry clicking', requires: [:js] do
-      @session.visit('/obscured')
+      @session.visit('/animated')
       obscured = @session.find(:css, '#obscured')
       @session.execute_script <<~JS
         setTimeout(function(){ $('#cover').hide(); }, 700)
@@ -450,7 +523,7 @@ Capybara::SpecHelper.spec 'node' do
     end
 
     it 'should allow to retry longer', requires: [:js] do
-      @session.visit('/obscured')
+      @session.visit('/animated')
       obscured = @session.find(:css, '#obscured')
       @session.execute_script <<~JS
         setTimeout(function(){ $('#cover').hide(); }, 3000)
@@ -459,7 +532,7 @@ Capybara::SpecHelper.spec 'node' do
     end
 
     it 'should not retry clicking when wait is disabled', requires: [:js] do
-      @session.visit('/obscured')
+      @session.visit('/animated')
       obscured = @session.find(:css, '#obscured')
       @session.execute_script <<~JS
         setTimeout(function(){ $('#cover').hide(); }, 2000)
@@ -493,7 +566,7 @@ Capybara::SpecHelper.spec 'node' do
     end
 
     it 'should retry clicking', requires: [:js] do
-      @session.visit('/obscured')
+      @session.visit('/animated')
       obscured = @session.find(:css, '#obscured')
       @session.execute_script <<~JS
         setTimeout(function(){ $('#cover').hide(); }, 700)
@@ -527,7 +600,7 @@ Capybara::SpecHelper.spec 'node' do
     end
 
     it 'should retry clicking', requires: [:js] do
-      @session.visit('/obscured')
+      @session.visit('/animated')
       obscured = @session.find(:css, '#obscured')
       @session.execute_script <<~JS
         setTimeout(function(){ $('#cover').hide(); }, 700)

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

@@ -14,10 +14,18 @@ Capybara::SpecHelper.spec Capybara::Selector do
       expect(@session.find(:label, for: 'form_other_title')['for']).to eq 'form_other_title'
     end
 
+    it 'finds a label for for attribute regex' do
+      expect(@session.find(:label, for: /_other_title/)['for']).to eq 'form_other_title'
+    end
+
     it 'finds a label from nested input using :for filter with id string' do
       expect(@session.find(:label, for: 'nested_label').text).to eq 'Nested Label'
     end
 
+    it 'finds a label from nested input using :for filter with id regexp' do
+      expect(@session.find(:label, for: /nested_lab/).text).to eq 'Nested Label'
+    end
+
     it 'finds a label from nested input using :for filter with element' do
       input = @session.find(:id, 'nested_label')
       expect(@session.find(:label, for: input).text).to eq 'Nested Label'

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

@@ -0,0 +1,49 @@
+<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>
+

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

@@ -5,5 +5,6 @@
     </head>
     <body>
         <div id="divInFrameOne">This is the text of divInFrameOne</div>
+        <div id="otherDivInFrameOne">Some other text</div>
     </body>
 </html>

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

@@ -1,15 +1,13 @@
 <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>
+    <title>Obscured</title>
     <style>
       div {
-        width: 400px;
-        height: 400px;
+        width: 200px;
+        height: 200px;
+      }
+      #cover, #offscreen, #offscreen_wrapper {
         position: absolute;
       }
       #obscured {
@@ -17,6 +15,7 @@
         background-color: red;
       }
       #cover {
+        top: 0px;
         z-index: 2;
         background-color: blue;
       }
@@ -33,12 +32,13 @@
       }
     </style>
   </head>
-
-  <body id="with_animation">
+  <body>
     <div id="obscured">
       <input id="obscured_input"/>
     </div>
     <div id="cover"></div>
+    <iframe id="frameOne" height="10px" src="/frame_one"></iframe>
+    <iframe id="nestedFrames" src="/frame_parent"></iframe>
     <div id="offscreen_wrapper">
       <div id="offscreen"></div>
     </div>