capybara 2.14.0 → 2.14.1

data/lib/capybara/selector/expression_filter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'capybara/selector/filter'
+
+module Capybara
+  class Selector
+    class ExpressionFilter < Filter
+      undef_method :matches?
+
+      def apply_filter(expr, value)
+        return expr if skip?(value)
+
+        if !valid_value?(value)
+          msg = "Invalid value #{value.inspect} passed to expression filter #{@name} - "
+          if default?
+            warn msg + "defaulting to #{default}"
+            value = default
+          else
+            warn msg + "skipping"
+            return expr
+          end
+        end
+
+        @block.call(expr, value)
+      end
+    end
+
+    class IdentityExpressionFilter < ExpressionFilter
+      def initialize
+      end
+
+      def default?
+        false
+      end
+
+      def apply_filter(expr, _value)
+        return expr
+      end
+    end
+  end
+end

data/lib/capybara/selector/filter_set.rb

@@ -13,9 +13,11 @@ module Capybara
       end
 
       def filter(name, *types_and_options, &block)
-        options = types_and_options.last.is_a?(Hash) ? types_and_options.pop.dup : {}
-        types_and_options.each { |k| options[k] = true}
-        filters[name] = Filter.new(name, block, options)
+        add_filter(name, Filter, *types_and_options, &block)
+      end
+
+      def expression_filter(name, *types_and_options, &block)
+        add_filter(name, ExpressionFilter, *types_and_options, &block)
       end
 
       def describe(&block)
@@ -30,7 +32,16 @@ module Capybara
         @filters ||= {}
       end
 
+      def node_filters
+        filters.reject { |_n, f| f.nil? || f.is_a?(ExpressionFilter) }.freeze
+      end
+
+      def expression_filters
+        filters.select { |_n, f| f.nil? || f.is_a?(ExpressionFilter)  }.freeze
+      end
+
       class << self
+
         def all
           @filter_sets ||= {}
         end
@@ -43,6 +54,14 @@ module Capybara
           all.delete(name.to_sym)
         end
       end
+
+      private
+
+      def add_filter(name, filter_class, *types_and_options, &block)
+        options = types_and_options.last.is_a?(Hash) ? types_and_options.pop.dup : {}
+        types_and_options.each { |k| options[k] = true}
+        filters[name] = filter_class.new(name, block, options)
+      end
     end
   end
 end

data/lib/capybara/selector/selector.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'capybara/selector/expression_filter'
 require 'capybara/selector/filter_set'
 require 'capybara/selector/css'
 require 'xpath'
@@ -21,7 +22,7 @@ end
 module Capybara
   class Selector
 
-    attr_reader :name, :format, :expression_filters
+    attr_reader :name, :format
 
     class << self
       def all
@@ -50,7 +51,7 @@ module Capybara
       @description = nil
       @format = nil
       @expression = nil
-      @expression_filters = []
+      @expression_filters = {}
       @default_visibility = nil
       instance_eval(&block)
     end
@@ -59,6 +60,14 @@ module Capybara
       @filter_set.filters
     end
 
+    def node_filters
+      @filter_set.node_filters
+    end
+
+    def expression_filters
+      @filter_set.expression_filters
+    end
+
     ##
     #
     # Define a selector by an xpath expression
@@ -74,7 +83,10 @@ module Capybara
     # @return [#call]                             The block that will be called to generate the XPath expression
     #
     def xpath(*expression_filters, &block)
-      @format, @expression_filters, @expression = :xpath, expression_filters.flatten, block if block
+      if block
+        @format, @expression = :xpath, block
+        expression_filters.flatten.each { |ef| custom_filters[ef] = IdentityExpressionFilter.new }
+      end
       format == :xpath ? @expression : nil
     end
 
@@ -93,7 +105,10 @@ module Capybara
     # @return [#call]                             The block that will be called to generate the CSS selector
     #
     def css(*expression_filters, &block)
-      @format, @expression_filters, @expression = :css, expression_filters.flatten, block if block
+      if block
+        @format, @expression = :css, block
+        expression_filters.flatten.each { |ef| custom_filters[ef] = nil }
+      end
       format == :css ? @expression : nil
     end
 
@@ -172,10 +187,16 @@ module Capybara
     #
     def filter(name, *types_and_options, &block)
       options = types_and_options.last.is_a?(Hash) ? types_and_options.pop.dup : {}
-      types_and_options.each { |k| options[k] = true}
+      types_and_options.each { |k| options[k] = true }
       custom_filters[name] = Filter.new(name, block, options)
     end
 
+    def expression_filter(name, *types_and_options, &block)
+      options = types_and_options.last.is_a?(Hash) ? types_and_options.pop.dup : {}
+      types_and_options.each { |k| options[k] = true }
+      custom_filters[name] = ExpressionFilter.new(name, block, options)
+    end
+
     def filter_set(name, filters_to_use = nil)
       f_set = FilterSet.all[name]
       f_set.filters.each do |n, filter|
@@ -215,17 +236,17 @@ module Capybara
       locate_xpath = xpath #need to save original xpath for the label wrap
       if locator
         locator = locator.to_s
-        attr_matchers =  XPath.attr(:id).equals(locator) |
-                         XPath.attr(:name).equals(locator) |
-                         XPath.attr(:placeholder).equals(locator) |
-                         XPath.attr(:id).equals(XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for))
-        attr_matchers |= XPath.attr(:'aria-label').is(locator) if options[:enable_aria_label]
+        attr_matchers =  XPath.attr(:id).equals(locator).or(
+                         XPath.attr(:name).equals(locator)).or(
+                         XPath.attr(:placeholder).equals(locator)).or(
+                         XPath.attr(:id).equals(XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)))
+        attr_matchers = attr_matchers.or XPath.attr(:'aria-label').is(locator) if options[:enable_aria_label]
 
         locate_xpath = locate_xpath[attr_matchers]
-        locate_xpath += XPath.descendant(:label)[XPath.string.n.is(locator)].descendant(xpath)
+        locate_xpath = locate_xpath.union(XPath.descendant(:label)[XPath.string.n.is(locator)].descendant(xpath))
       end
 
-      locate_xpath = [:name, :placeholder].inject(locate_xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }
+      # locate_xpath = [:name, :placeholder].inject(locate_xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }
       locate_xpath
     end
 

data/lib/capybara/selenium/driver.rb

@@ -14,12 +14,16 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def browser
     unless @browser
-      if options[:browser].to_s == "firefox"
-        options[:desired_capabilities] ||= Selenium::WebDriver::Remote::Capabilities.firefox
+      if firefox?
+        options[:desired_capabilities] ||= {}
         options[:desired_capabilities].merge!({ unexpectedAlertBehaviour: "ignore" })
       end
 
-      @browser = Selenium::WebDriver.for(options[:browser], options.reject { |key,_val| SPECIAL_OPTIONS.include?(key) })
+      @processed_options = options.reject { |key,_val| SPECIAL_OPTIONS.include?(key) }
+      @browser = Selenium::WebDriver.for(options[:browser], @processed_options)
+
+      @w3c = ((defined?(Selenium::WebDriver::Remote::W3CCapabilities) && @browser.capabilities.is_a?(Selenium::WebDriver::Remote::W3CCapabilities)) ||
+              (defined?(Selenium::WebDriver::Remote::W3C::Capabilities) && @browser.capabilities.is_a?(Selenium::WebDriver::Remote::W3C::Capabilities)))
 
       main = Process.pid
       at_exit do
@@ -33,6 +37,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def initialize(app, options={})
+    @session = nil
     begin
       require 'selenium-webdriver'
       # Fix for selenium-webdriver 3.4.0 which misnamed these
@@ -145,7 +150,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
           raise Capybara::ExpectationNotMet.new('Timed out waiting for Selenium session reset') if (Capybara::Helpers.monotonic_time - start_time) >= 10
           sleep 0.05
         end
-      rescue Selenium::WebDriver::Error::UnhandledAlertError
+      rescue Selenium::WebDriver::Error::UnhandledAlertError, Selenium::WebDriver::Error::UnexpectedAlertOpenError
         # This error is thrown if an unhandled alert is on the page
         # Firefox appears to automatically dismiss this alert, chrome does not
         # We'll try to accept it
@@ -232,20 +237,32 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def accept_modal(_type, options={})
-    yield if block_given?
-    modal = find_modal(options)
-    modal.send_keys options[:with] if options[:with]
-    message = modal.text
-    modal.accept
-    message
+    if headless_chrome?
+      insert_modal_handlers(true, options[:with], options[:text])
+      yield if block_given?
+      find_headless_modal(options)
+    else
+      yield if block_given?
+      modal = find_modal(options)
+      modal.send_keys options[:with] if options[:with]
+      message = modal.text
+      modal.accept
+      message
+    end
   end
 
   def dismiss_modal(_type, options={})
-    yield if block_given?
-    modal = find_modal(options)
-    message = modal.text
-    modal.dismiss
-    message
+    if headless_chrome?
+      insert_modal_handlers(false, options[:with], options[:text])
+      yield if block_given?
+      find_headless_modal(options)
+    else
+      yield if block_given?
+      modal = find_modal(options)
+      message = modal.text
+      modal.dismiss
+      message
+    end
   end
 
   def quit
@@ -275,6 +292,37 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   # @api private
+  def marionette?
+    firefox? && browser && @w3c
+  end
+
+  # @api private
+  def firefox?
+    browser_name == "firefox"
+  end
+
+  # @api private
+  def chrome?
+    browser_name == "chrome"
+  end
+
+  # @api private
+  def headless_chrome?
+    chrome? && ((@processed_options[:desired_capabilities][:chrome_options] || {})['args'] || []).include?("headless")
+  end
+
+  # @deprecated This method is being removed
+  def browser_initialized?
+    super && !@browser.nil?
+  end
+
+  private
+
+  # @api private
+  def browser_name
+    options[:browser].to_s
+  end
+
   def find_window(locator)
     handles = browser.window_handles
     return locator if handles.include? locator
@@ -292,18 +340,49 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     raise Capybara::ElementNotFound, "Could not find a window identified by #{locator}"
   end
 
-  #@api private
-  def marionette?
-    (options[:browser].to_s == "firefox") && browser.capabilities.is_a?(Selenium::WebDriver::Remote::W3CCapabilities)
+  def insert_modal_handlers(accept, response_text, expected_text=nil)
+    script = <<-JS
+      if (typeof window.capybara  === 'undefined') {
+        window.capybara = {
+          modal_handlers: [],
+          current_modal_status: function() {
+            return [this.modal_handlers[0].called, this.modal_handlers[0].modal_text];
+          },
+          add_handler: function(handler) {
+            this.modal_handlers.unshift(handler);
+          },
+          remove_handler: function(handler) {
+            window.alert = handler.alert;
+            window.confirm = handler.confirm;
+            window.prompt = handler.prompt;
+          },
+          handler_called: function(handler, str) {
+            handler.called = true;
+            handler.modal_text = str;
+            this.remove_handler(handler);
+          }
+        };
+      };
+
+      var modal_handler = {
+        prompt: window.prompt,
+        confirm: window.confirm,
+        alert: window.alert,
+      }
+      window.capybara.add_handler(modal_handler);
+
+      window.alert = window.confirm = function(str) {
+        window.capybara.handler_called(modal_handler, str);
+        return #{accept ? 'true' : 'false'};
+      };
+      window.prompt = function(str) {
+        window.capybara.handler_called(modal_handler, str);
+        return #{accept ? "'#{response_text}'" : 'null'};
+      }
+    JS
+    execute_script script
   end
 
-  # @deprecated This method is being removed
-  def browser_initialized?
-    super && !@browser.nil?
-  end
-
-  private
-
   def within_given_window(handle)
     original_handle = self.current_window_handle
     if handle == original_handle
@@ -333,6 +412,32 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     end
   end
 
+  def find_headless_modal(options={})
+    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time
+    # Actual wait time may be longer than specified
+    wait = Selenium::WebDriver::Wait.new(
+      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0 ,
+      ignore: Selenium::WebDriver::Error::NoAlertPresentError)
+    begin
+      wait.until do
+        called, alert_text = evaluate_script('window.capybara.current_modal_status()')
+        if called
+          execute_script('window.capybara.modal_handlers.shift()')
+          regexp = options[:text].is_a?(Regexp) ? options[:text] : Regexp.escape(options[:text].to_s)
+          if alert_text.match(regexp)
+            alert_text
+          else
+            raise Capybara::ModalNotFound.new("Unable to find modal dialog#{" with #{options[:text]}" if options[:text]}")
+          end
+        else
+          nil
+        end
+      end
+    rescue Selenium::WebDriver::Error::TimeOutError
+      raise Capybara::ModalNotFound.new("Unable to find modal dialog#{" with #{options[:text]}" if options[:text]}")
+    end
+  end
+
   def silenced_unknown_error_message?(msg)
     silenced_unknown_error_messages.any? { |r| msg =~ r }
   end

data/lib/capybara/selenium/node.rb

@@ -47,7 +47,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
       click if value ^ native.attribute('checked').to_s.eql?("true")
     elsif tag_name == 'input' and type == 'file'
       path_names = value.to_s.empty? ? [] : value
-      if driver.options[:browser].to_s == "chrome"
+      if driver.chrome?
         native.send_keys(Array(path_names).join("\n"))
       else
         native.send_keys(*path_names)
@@ -88,8 +88,8 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
       JS
       driver.execute_script script, self
 
-      if (driver.options[:browser].to_s == "chrome") ||
-         (driver.options[:browser].to_s == "firefox" && !driver.marionette?)
+      if (driver.chrome?) ||
+         (driver.firefox? && !driver.marionette?)
         # chromedriver raises a can't focus element for child elements if we use native.send_keys
         # we've already focused it so just use action api
         driver.browser.action.send_keys(value.to_s).perform

data/lib/capybara/session/config.rb

@@ -8,53 +8,55 @@ module Capybara
                :automatic_label_click, :enable_aria_label, :save_path, :exact_options, :asset_host, :default_host, :app_host,
                :save_and_open_page_path, :server_host, :server_port, :server_errors]
 
-    attr_accessor *OPTIONS
+    attr_accessor(*OPTIONS)
 
     ##
     #@!method always_include_port
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method run_server
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method default_selector
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method default_max_wait_time
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method ignore_hidden_elements
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method automatic_reload
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method match
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method exact
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method raise_server_errors
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method visible_text_only
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method wait_on_first_by_default
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method automatic_label_click
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method enable_aria_label
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method save_path
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method exact_options
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method asset_host
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method default_host
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method app_host
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method save_and_open_page_path
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method server_host
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method server_port
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
     #@!method server_errors
-    #  See {Capybara#configure}
+    #  See {Capybara.configure}
+
+    remove_method :server_host
 
     ##
     #
@@ -64,20 +66,24 @@ module Capybara
       @server_host || '127.0.0.1'
     end
 
+    remove_method :server_errors=
     def server_errors=(errors)
       (@server_errors ||= []).replace(errors.dup)
     end
 
+    remove_method :app_host=
     def app_host=(url)
       raise ArgumentError.new("Capybara.app_host should be set to a url (http://www.example.com)") unless url.nil? || (url =~ URI::Parser.new.make_regexp)
       @app_host = url
     end
 
+    remove_method :default_host=
     def default_host=(url)
       raise ArgumentError.new("Capybara.default_host should be set to a url (http://www.example.com)") unless url.nil? || (url =~ URI::Parser.new.make_regexp)
       @default_host = url
     end
 
+    remove_method :save_and_open_page_path=
     def save_and_open_page_path=(path)
       warn "DEPRECATED: #save_and_open_page_path is deprecated, please use #save_path instead. \n"\
            "Note: Behavior is slightly different with relative paths - see documentation" unless path.nil?