capybara 3.13.2 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 535d547d5a25d769afa754066f54cc0d873a2997ebfbc1ed12dd418d80cbb3f0
-  data.tar.gz: c576db6d285f055bfc3e030ff4973f7c3fecaf54bff9e74c64070408a2a579ac
+  metadata.gz: f79ad67119c7cc637fcab5cbc4fe95b0d80a76c2c38182f2a6b8beb3564f8448
+  data.tar.gz: 9d5c1ca24bbc3e7f2a9c18c71c5b61a78b96d24147b21c9b0f753217d4fc2772
 SHA512:
-  metadata.gz: 37be4e1475274ec82574b4839eb7a06b4db262ebacbd6534669561b92b4a87fcbfc73d57d058657a58b800ec95b86804d16ea663beb4407c6cb9247af100e283
-  data.tar.gz: b6b5996ff037790502bb89783f48441c6288e5241b967739a463dcf339c17bc1d3a2c5c4226bf7ab3eb502b82e56079347c96c5a55737edcd84477a85a4fa92e
+  metadata.gz: a799dc6db1032d812bf749ca8ee8ca8b46e59e957130f80ddfb9d5c2b08fce1a543ce3a0e9c28ee2bf38470867bc6d8a64ce6ed3f3d6c32ae3f31f41c071cb8f
+  data.tar.gz: d41beb222470a77bd2f2784a8def99ef3fc4b2928ee1b50cb66167d1764a94ec7ea1be59424c4d09f2a7981b3c6ba47ee6df02b13d6472480f10d9698c742e82

data/History.md

@@ -1,3 +1,18 @@
+# Version 3.14
+Release date: 2019-02-25
+
+### Added
+
+* rack_test driver now supports reloading elements when the document changes - Issue #2157
+* Selenium driver HTML5 drag-drop emulation now emits multiple move events so drag direction
+  is determinable [Erkki Eilonen, Thomas Walpole]
+* Capybara.server_errors now defaults to [Exception] - Issue #2160 [Edgars Beigarts]
+### Fixed
+
+* Workaround hover issue with FF 65 - Issue #2156
+* Workaround chromedriver issue when setting blank strings to react controlled text fields
+* Workaround chromedriver issue with popup windows not loading content - https://bugs.chromium.org/p/chromedriver/issues/detail?id=2650&q=load&sort=-id&colspec=ID%20Status%20Pri%20Owner%20Summary
+
 # Version 3.13.2
 Release date: 2019-01-24
 
@@ -22,7 +37,7 @@ Release date: 2019-01-23
 * Speed optimizations around multiple element location and path generation when using the Selenium driver
 * Support for locator type checking in custom selectors
 * Allow configuration of gumbo use - defaults to off
-* `assert_style`/`has_style`/`have_style` depreacted in favor of `assert_matches_style`/`matches_styles?`/`match_style`
+* `assert_style`/`has_style`/`have_style` deprecated in favor of `assert_matches_style`/`matches_styles?`/`match_style`
 * :style filter added to selectors
 
 # Version 3.12.0

data/README.md

@@ -6,7 +6,7 @@
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jnicklas/capybara?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=capybara&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=capybara&package-manager=bundler&version-scheme=semver)
 
-**Note** You are viewing the README for the version 3.13.x of Capybara.
+**Note** You are viewing the README for the 3.14.x version of Capybara.
 
 Capybara helps you test web applications by simulating how a real user would
 interact with your app. It is agnostic about the driver running your tests and
@@ -409,7 +409,7 @@ and test server, see [Transactions and database setup](#transactions-and-databas
 
 ### <a name="apparition"></a>Apparition
 
-The [apparition driver](https://github.com/twalpole/apparition) in a new driver thatallows you to run tests using Chrome in a headless
+The [apparition driver](https://github.com/twalpole/apparition) in a new driver that allows you to run tests using Chrome in a headless
 or headed configuration. It attempts to provide backwards compatibility with the [Poltergeist driver API](https://github.com/teampoltergeist/poltergeist)
 while allowing for the use of modern JS/CSS. It uses CDP to communicate with Chrome, thereby obviating the need for chromedriver.
 A compatibility layer for capybara-webkit is planned, although has not yet been started. This driver is being developed by the

data/lib/capybara.rb

@@ -73,7 +73,7 @@ module Capybara
     # [asset_host = String]               Where dynamic assets are hosted - will be prepended to relative asset locations if present (Default: nil)
     # [run_server = Boolean]              Whether to start a Rack server for the given Rack app (Default: true)
     # [raise_server_errors = Boolean]     Should errors raised in the server be raised in the tests? (Default: true)
-    # [server_errors = Array\<Class\>]    Error classes that should be raised in the tests if they are raised in the server and Capybara.raise_server_errors is true (Default: [StandardError])
+    # [server_errors = Array\<Class\>]    Error classes that should be raised in the tests if they are raised in the server and Capybara.raise_server_errors is true (Default: [Exception])
     # [default_selector = :css/:xpath]    Methods which take a selector use the given type by default (Default: :css)
     # [default_max_wait_time = Numeric]   The maximum number of seconds to wait for asynchronous processes to finish (Default: 2)
     # [ignore_hidden_elements = Boolean]  Whether to ignore hidden elements on the page (Default: true)
@@ -516,7 +516,7 @@ Capybara.configure do |config|
   config.exact = false
   config.exact_text = false
   config.raise_server_errors = true
-  config.server_errors = [StandardError]
+  config.server_errors = [Exception]
   config.visible_text_only = false
   config.automatic_label_click = false
   config.enable_aria_label = false
@@ -544,13 +544,20 @@ Capybara.register_driver :selenium_headless do |app|
 end
 
 Capybara.register_driver :selenium_chrome do |app|
-  Capybara::Selenium::Driver.new(app, browser: :chrome)
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+    # Workaround https://bugs.chromium.org/p/chromedriver/issues/detail?id=2650&q=load&sort=-id&colspec=ID%20Status%20Pri%20Owner%20Summary
+    opts.args << '--disable-site-isolation-trials'
+  end
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
 end
 
 Capybara.register_driver :selenium_chrome_headless do |app|
   Capybara::Selenium::Driver.load_selenium
-  browser_options = ::Selenium::WebDriver::Chrome::Options.new
-  browser_options.args << '--headless'
-  browser_options.args << '--disable-gpu' if Gem.win_platform?
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+    opts.args << '--headless'
+    opts.args << '--disable-gpu' if Gem.win_platform?
+    # Workaround https://bugs.chromium.org/p/chromedriver/issues/detail?id=2650&q=load&sort=-id&colspec=ID%20Status%20Pri%20Owner%20Summary
+    opts.args << '--disable-site-isolation-trials'
+  end
   Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
 end

data/lib/capybara/node/base.rb

@@ -83,11 +83,18 @@ module Capybara
           yield
         rescue StandardError => err
           session.raise_server_error!
-          raise err unless driver.wait? && catch_error?(err, errors)
-          raise err if timer.expired?
+          raise err unless catch_error?(err, errors)
 
-          sleep(0.01)
-          reload if session_options.automatic_reload
+          if driver.wait?
+            raise err if timer.expired?
+
+            sleep(0.01)
+            reload if session_options.automatic_reload
+          else
+            old_base = @base
+            reload if session_options.automatic_reload
+            raise err if old_base == @base
+          end
           retry
         ensure
           session.synchronized = false

data/lib/capybara/rack_test/driver.rb

@@ -102,4 +102,8 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
   def put(*args, &block); browser.put(*args, &block); end
   def delete(*args, &block); browser.delete(*args, &block); end
   def header(key, value); browser.header(key, value); end
+
+  def invalid_element_errors
+    [Capybara::RackTest::Errors::StaleElementReferenceError]
+  end
 end

data/lib/capybara/rack_test/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Capybara::RackTest::Errors
+  class StaleElementReferenceError < StandardError
+  end
+end

data/lib/capybara/rack_test/node.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'capybara/rack_test/errors'
+
 class Capybara::RackTest::Node < Capybara::Driver::Node
   BLOCK_ELEMENTS = %w[p h1 h2 h3 h4 h5 h6 ol ul pre address blockquote dl div fieldset form hr noscript table].freeze
 
@@ -106,14 +108,24 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
     native.path
   end
 
-  def find_xpath(locator)
+  def find_xpath(locator, **_hints)
     native.xpath(locator).map { |el| self.class.new(driver, el) }
   end
 
-  def find_css(locator)
+  def find_css(locator, **_hints)
     native.css(locator, Capybara::RackTest::CSSHandlers.new).map { |el| self.class.new(driver, el) }
   end
 
+  public_instance_methods(false).each do |meth_name|
+    alias_method "unchecked_#{meth_name}", meth_name
+    private "unchecked_#{meth_name}" # rubocop:disable Layout/AccessModifierIndentation,Style/AccessModifierDeclarations
+
+    define_method meth_name do |*args|
+      stale_check
+      send("unchecked_#{meth_name}", *args)
+    end
+  end
+
   def ==(other)
     native == other.native
   end
@@ -141,6 +153,10 @@ protected
 
 private
 
+  def stale_check
+    raise Capybara::RackTest::Errors::StaleElementReferenceError unless native.document == driver.dom
+  end
+
   def deselect_options
     select_node.find_xpath('.//option[@selected]').each { |node| node.native.remove_attribute('selected') }
   end

data/lib/capybara/selenium/driver.rb

@@ -386,6 +386,11 @@ private
       raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?
 
       sleep 0.01
+
+      # It has been observed that it is possible that asynchronous JS code in
+      # the application under test can navigate the browser away from about:blank
+      # if the timing is just right. Ensure we are still at about:blank...
+      @browser.navigate.to('about:blank') unless current_url == 'about:blank'
     end
   end
 

data/lib/capybara/selenium/extensions/find.rb

@@ -77,9 +77,9 @@ module Capybara
       def is_displayed_atom # rubocop:disable Naming/PredicateName
         @@is_displayed_atom ||= begin
           browser.send(:bridge).send(:read_atom, 'isDisplayed')
-        rescue StandardError
-          # If the atom doesn't exist or other error
-          ""
+                                rescue StandardError
+                                  # If the atom doesn't exist or other error
+                                  ''
         end
       end
     end

data/lib/capybara/selenium/extensions/html5_drag.rb

@@ -30,6 +30,44 @@ class Capybara::Selenium::Node
       var source = arguments[0];
       var target = arguments[1];
 
+      function rectCenter(rect){
+        return new DOMPoint(
+          (rect.left + rect.right)/2,
+          (rect.top + rect.bottom)/2
+        );
+      }
+
+      function pointOnRect(pt, rect) {
+      	var rectPt = rectCenter(rect);
+      	var slope = (rectPt.y - pt.y) / (rectPt.x - pt.x);
+
+      	if (pt.x <= rectPt.x) { // left side
+      		var minXy = slope * (rect.left - pt.x) + pt.y;
+      		if (rect.top <= minXy && minXy <= rect.bottom)
+            return new DOMPoint(rect.left, minXy);
+      	}
+
+      	if (pt.x >= rectPt.x) { // right side
+      		var maxXy = slope * (rect.right - pt.x) + pt.y;
+      		if (rect.top <= maxXy && maxXy <= rect.bottom)
+            return new DOMPoint(rect.right, maxXy);
+      	}
+
+      	if (pt.y <= rectPt.y) { // top side
+      		var minYx = (rectPt.top - pt.y) / slope + pt.x;
+      		if (rect.left <= minYx && minYx <= rect.right)
+            return new DOMPoint(minYx, rect.top);
+      	}
+
+      	if (pt.y >= rectPt.y) { // bottom side
+      		var maxYx = (rect.bottom - pt.y) / slope + pt.x;
+      		if (rect.left <= maxYx && maxYx <= rect.right)
+            return new DOMPoint(maxYx, rect.bottom);
+      	}
+
+        return new DOMPoint(pt.x,pt.y);
+      }
+
       var dt = new DataTransfer();
       var opts = { cancelable: true, bubbles: true, dataTransfer: dt };
 
@@ -41,11 +79,24 @@ class Capybara::Selenium::Node
         dt.setData('text/uri-list', source.src);
         dt.setData('text', source.src);
       }
+
       var dragEvent = new DragEvent('dragstart', opts);
       source.dispatchEvent(dragEvent);
       target.scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});
-      var dragOverEvent = new DragEvent('dragover', opts);
+      var targetRect = target.getBoundingClientRect();
+      var sourceCenter = rectCenter(source.getBoundingClientRect());
+
+      // fire 2 dragover events to simulate dragging with a direction
+      var entryPoint = pointOnRect(sourceCenter, targetRect)
+      var dragOverOpts = Object.assign({clientX: entryPoint.x, clientY: entryPoint.y}, opts);
+      var dragOverEvent = new DragEvent('dragover', dragOverOpts);
       target.dispatchEvent(dragOverEvent);
+
+      var targetCenter = rectCenter(targetRect);
+      dragOverOpts = Object.assign({clientX: targetCenter.x, clientY: targetCenter.y}, opts);
+      dragOverEvent = new DragEvent('dragover', dragOverOpts);
+      target.dispatchEvent(dragOverEvent);
+
       var dragLeaveEvent = new DragEvent('dragleave', opts);
       target.dispatchEvent(dragLeaveEvent);
       if (dragOverEvent.defaultPrevented) {

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

@@ -5,6 +5,13 @@ require 'capybara/selenium/extensions/html5_drag'
 class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
   include Html5Drag
 
+  def set_text(value, clear: nil, **_unused)
+    super.tap do
+      # React doesn't see the chromedriver element clear
+      send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?
+    end
+  end
+
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
     super(value)
   rescue ::Selenium::WebDriver::Error::ExpectedError => err

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

@@ -58,6 +58,13 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
     html5_drag_to(element)
   end
 
+  def hover
+    return super unless browser_version >= 65.0
+
+    # work around issue 2156 - https://github.com/teamcapybara/capybara/issues/2156
+    scroll_if_needed { browser_action.move_to(native, 0, 0).move_to(native).perform }
+  end
+
 private
 
   def click_with_options(click_options)

data/lib/capybara/spec/public/test.js

@@ -13,6 +13,7 @@ $(function() {
     ev.originalEvent.dataTransfer.setData("text", ev.target.id);
   });
   $('#drop_html5, #drop_html5_scroll').on('dragover', function(ev){
+    $(this).after('<div class="log">DragOver with client position: ' + ev.clientX + ',' + ev.clientY)
     if ($(this).hasClass('drop')) { ev.preventDefault(); }
   });
   $('#drop_html5, #drop_html5_scroll').on('drop', function(ev){

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

@@ -344,6 +344,15 @@ Capybara::SpecHelper.spec 'node' do
       @session.find(:css, '.wrapper.scroll_needed').hover
       expect(@session.find(:css, '.wrapper.scroll_needed .hidden_until_hover', visible: false)).to be_visible
     end
+
+    it 'should hover again after following a link and back' do
+      @session.visit('/with_hover')
+      @session.find(:css, '.wrapper:not(.scroll_needed)').hover
+      @session.click_link('Other hover page')
+      @session.click_link('Go back')
+      @session.find(:css, '.wrapper:not(.scroll_needed)').hover
+      expect(@session.find(:css, '.wrapper:not(.scroll_needed) .hidden_until_hover', visible: false)).to be_visible
+    end
   end
 
   describe '#click' do

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

@@ -108,7 +108,7 @@ Capybara::SpecHelper.spec '#scroll_to', requires: [:scroll] do
     expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [50, 75]
   end
 
-  it 'can scroll the scroll the scrolling element by a specifc amount' do
+  it 'can scroll the scroll the scrolling element by a specific amount' do
     scrolling_element = @session.find(:css, '#scrollable')
     scrolling_element.scroll_to 100, 100
     scrolling_element.scroll_to(:current, offset: [-50, 50])

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

@@ -26,6 +26,29 @@ 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
   end
 
   context 'with XPath selector' do

data/lib/capybara/spec/test_app.rb

@@ -6,8 +6,8 @@ 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)
       @something = string1
       @message = msg

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

@@ -10,6 +10,7 @@
       .hidden_until_hover {display: none;}
       .wrapper:hover .hidden_until_hover { display: block }
     </style>
+    <a href='with_hover1'>Other hover page</a>
     <div class="wrapper">
       Some text here so the wrapper has size
       <div class="hidden_until_hover">Here I am</div>

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

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
+  </head>
+
+  <body>
+    <a href="with_hover">Go back</a>
+  </body>
+</html>

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

@@ -0,0 +1,6 @@
+
+<h1>This page is used for testing various scopes</h1>
+
+<p id="for_foo">
+  Different text same wrapper id
+</p>

data/lib/capybara/version.rb

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

data/spec/shared_selenium_session.rb

@@ -307,6 +307,15 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
         expect(session).to have_xpath('//div[contains(., "HTML5 Dropped drag_html5")]')
       end
 
+      it 'should set clientX/Y in dragover events' do
+        session.visit('/with_js')
+        element = session.find('//div[@id="drag_html5"]')
+        target = session.find('//div[@id="drop_html5"]')
+        element.drag_to(target)
+        session.all(:css, 'div.log').each { |el| puts el.text }
+        expect(session).to have_css('div.log', text: /DragOver with client position: [1-9]\d*,[1-9]\d*/, count: 2)
+      end
+
       it 'should not HTML5 drag and drop on a non HTML5 drop element' do
         session.visit('/with_js')
         element = session.find('//div[@id="drag_html5"]')
@@ -453,6 +462,26 @@ RSpec.shared_examples 'Capybara::Session' do |session, mode|
         expect(session).to have_selector(:element, "{custom}": 'abcdef')
       end
     end
+
+    describe 'with react' do
+      context 'controlled components' do
+        it 'can set and clear a text field' do
+          session.visit 'https://reactjs.org/docs/forms.html'
+          session.all(:css, 'h2#controlled-components ~ p a', text: 'Try it on CodePen')[0].click
+          sleep 2 # give codepen a chance to stabilize result frame
+          session.within_frame(:css, 'iframe.result-iframe') do
+            session.fill_in('Name:', with: 'abc')
+            session.accept_prompt 'A name was submitted: abc' do
+              session.click_button('Submit')
+            end
+            session.fill_in('Name:', with: '')
+            session.accept_prompt(/A name was submitted: $/) do
+              session.click_button('Submit')
+            end
+          end
+        end
+      end
+    end
   end
 
   def headless_or_remote?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara
 version: !ruby/object:Gem::Version
-  version: 3.13.2
+  version: 3.14.0
 platform: ruby
 authors:
 - Thomas Walpole
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain:
 - gem-public_cert.pem
-date: 2019-01-24 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -375,6 +375,7 @@ files:
 - lib/capybara/rack_test/browser.rb
 - lib/capybara/rack_test/css_handlers.rb
 - lib/capybara/rack_test/driver.rb
+- lib/capybara/rack_test/errors.rb
 - lib/capybara/rack_test/form.rb
 - lib/capybara/rack_test/node.rb
 - lib/capybara/rails.rb
@@ -541,12 +542,14 @@ files:
 - lib/capybara/spec/views/with_count.erb
 - lib/capybara/spec/views/with_fixed_header_footer.erb
 - lib/capybara/spec/views/with_hover.erb
+- lib/capybara/spec/views/with_hover1.erb
 - lib/capybara/spec/views/with_html.erb
 - lib/capybara/spec/views/with_html5_svg.erb
 - lib/capybara/spec/views/with_html_entities.erb
 - lib/capybara/spec/views/with_js.erb
 - lib/capybara/spec/views/with_namespace.erb
 - lib/capybara/spec/views/with_scope.erb
+- lib/capybara/spec/views/with_scope_other.erb
 - lib/capybara/spec/views/with_simple_html.erb
 - lib/capybara/spec/views/with_slow_unload.erb
 - lib/capybara/spec/views/with_title.erb