capybara 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8304f8ac3e0f20f8fae8db3eedea4f623de6756708c0ba95ec83fc4587ec4321
-  data.tar.gz: dff277e0f6abb0275ff4462de9fd9de8c930032f4a574448af16688af337c58c
+  metadata.gz: 75ca733cee9a96dd5d17e4ae8ed453686c73d4deaf77fae6fa4008b13b62e12d
+  data.tar.gz: ed22e70d57b1baac7bf6aafd9f483acf16f07193fb087e872b94d24b44134165
 SHA512:
-  metadata.gz: 7b7bfa133c75b1556490b7337178cfd3e9137157e16c922679b72067b055fd54d659237367c7f066bbb7e2a6d75311db8736abc8e4d94030898a39e39a297ae9
-  data.tar.gz: b320cdc763f873e87f13b83ec693db1f590a32a2193fb56a7dfd82310101b39636c26a1da520b723dca31672f289201d649b90a0288f1ae281ac40b6b3d612bc
+  metadata.gz: a221f4ae1099fa5367af6c60396263d35f1d1d0fdcc8d5fda712a4ca8f3b32e3ca6de14fae15dcf39e2a76f24c91555a6ac2c5745d4d9185ecbb80a0a34e463b
+  data.tar.gz: 41034edf9b5cf28ab1850a9f499996a4c3903cb75d77112c7d83fe342e7b097a89a83bdfff36750294bf113ba65d07e3db4500eeff8e618e48fa5e55c4e405c8

data/History.md

@@ -1,3 +1,13 @@
+# Version 3.1.0
+Release date: 2018-05-10
+
+### Added
+
+* Support for using `select` with text inputs associated with a datalist element
+* `type` filter on `:button` selector
+* Support for server operating in https mode
+* Selenium driver now uses JS to fill_in/set date and time fields when passed date or time objects [Aleksei Gusev, Thomas Walpole]
+
 # Version 3.0.3
 Release date: 2018-04-30
 

data/lib/capybara.rb

@@ -497,6 +497,6 @@ 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'
+  browser_options.args << '--disable-gpu' if Gem.win_platform?
   Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
 end

data/lib/capybara/helpers.rb

@@ -3,7 +3,7 @@
 module Capybara
   # @api private
   module Helpers
-    extend self
+  module_function
 
     ##
     # @deprecated

data/lib/capybara/minitest/spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'minitest/spec'
 
 module Capybara

data/lib/capybara/node/actions.rb

@@ -158,8 +158,8 @@ module Capybara
 
       ##
       #
-      # If `:from` option is present, `select` finds a select box on the page
-      # and selects a particular option from it.
+      # If `:from` option is present, `select` finds a select box, or text input with associated datalist,
+      # on the page and selects a particular option from it.
       # Otherwise it finds an option inside current scope and selects it.
       # If the select box is a multiple select, +select+ can be called multiple times to select more than
       # one option.
@@ -169,13 +169,47 @@ module Capybara
       #
       # @macro waiting_behavior
       #
-      # @param [String] value                   Which option to select
+      # @param [String] value           Which option to select
       # @option options [String] :from  The id, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element selected
       def select(value = nil, from: nil, **options)
-        scope = from ? find(:select, from, options) : self
-        scope.find(:option, value, options).select_option
+        scope = if from
+          synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
+            begin
+              find(:select, from, options)
+            rescue Capybara::ElementNotFound => select_error
+              raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }
+              begin
+                find(:datalist_input, from, options)
+              rescue Capybara::ElementNotFound => dlinput_error
+                raise Capybara::ElementNotFound, "#{select_error.message} and #{dlinput_error.message}"
+              end
+            end
+          end
+        else
+          self
+        end
+
+        if scope.respond_to?(:tag_name) && scope.tag_name == "input"
+          begin
+            # TODO: this is a more efficient but won't work with non-JS drivers
+            # datalist_options = session.evaluate_script('Array.prototype.slice.call((arguments[0].list||{}).options || []).filter(function(el){ return !el.disabled }).map(function(el){ return { "value": el.value, "label": el.label} })', scope)
+            datalist_options = session.evaluate_script(DATALIST_OPTIONS_SCRIPT, scope)
+            if (option = datalist_options.find { |o| o['value'] == value || o['label'] == value })
+              scope.set(option["value"])
+            else
+              raise ::Capybara::ElementNotFound, "Unable to find datalist option \"#{value}\""
+            end
+          rescue ::Capybara::NotSupportedByDriverError
+            # Implement for drivers that don't support JS
+            datalist = find(:xpath, XPath.descendant(:datalist)[XPath.attr(:id) == scope[:list]], visible: false)
+            option = datalist.find(:datalist_option, value, disabled: false)
+            scope.set(option.value)
+          end
+        else
+          scope.find(:option, value, options).select_option
+        end
       end
 
       ##
@@ -291,6 +325,12 @@ module Capybara
           delete el.capybara_style_cache;
         }
       JS
+
+      DATALIST_OPTIONS_SCRIPT = <<-'JS'.freeze
+        Array.prototype.slice.call((arguments[0].list||{}).options || []).
+          filter(function(el){ return !el.disabled }).
+          map(function(el){ return { "value": el.value, "label": el.label} })
+      JS
     end
   end
 end

data/lib/capybara/queries/match_query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Capybara
   module Queries
     class MatchQuery < Capybara::Queries::SelectorQuery

data/lib/capybara/queries/selector_query.rb

@@ -35,7 +35,7 @@ module Capybara
         @description << "visible " if visible == :visible
         @description << "non-visible " if visible == :hidden
         @description << "#{label} #{locator.inspect}"
-        @description << " with#{" exact" if exact_text == true} text #{options[:text].inspect}" if options[:text]
+        @description << " with#{' exact' if exact_text == true} text #{options[:text].inspect}" if options[:text]
         @description << " with exact text #{options[:exact_text]}" if options[:exact_text].is_a?(String)
         @description << " with id #{options[:id]}" if options[:id]
         @description << " with classes [#{Array(options[:class]).join(',')}]" if options[:class]
@@ -167,9 +167,8 @@ module Capybara
 
       def assert_valid_keys
         super
-        unless VALID_MATCH.include?(match)
-          raise ArgumentError, "invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(", ")}"
-        end
+        return if VALID_MATCH.include?(match)
+        raise ArgumentError, "invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}"
       end
 
       def filtered_xpath(expr)

data/lib/capybara/queries/text_query.rb

@@ -39,7 +39,7 @@ module Capybara
         if @expected_text.is_a?(Regexp)
           "text matching #{@expected_text.inspect}"
         else
-          "#{"exact " if exact?}text #{@expected_text.inspect}"
+          "#{'exact ' if exact?}text #{@expected_text.inspect}"
         end
       end
 
@@ -68,16 +68,15 @@ module Capybara
       def case_insensitive_message
         insensitive_regexp = Capybara::Helpers.to_regexp(@expected_text, options: Regexp::IGNORECASE)
         insensitive_count = @actual_text.scan(insensitive_regexp).size
-        if insensitive_count != @count
-          "it was found #{insensitive_count} #{Capybara::Helpers.declension("time", "times", insensitive_count)} using a case insensitive search"
-        end
+        return if insensitive_count == @count
+        "it was found #{insensitive_count} #{Capybara::Helpers.declension('time', 'times', insensitive_count)} using a case insensitive search"
       end
 
       def invisible_message
         invisible_text = text(@node, :all)
         invisible_count = invisible_text.scan(@search_regexp).size
         if invisible_count != @count
-          "it was found #{invisible_count} #{Capybara::Helpers.declension("time", "times", invisible_count)} including non-visible text"
+          "it was found #{invisible_count} #{Capybara::Helpers.declension('time', 'times', invisible_count)} including non-visible text"
         end
       rescue # An error getting the non-visible text (if element goes out of scope) should not affect the response
       end

data/lib/capybara/rack_test/node.rb

@@ -90,7 +90,7 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
     return true if string_node.disabled?
 
     if %w[option optgroup].include? tag_name
-      find_xpath("parent::*[self::optgroup or self::select]")[0].disabled?
+      find_xpath("parent::*[self::optgroup or self::select or self::datalist]")[0].disabled?
     else
       !find_xpath("parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]").empty?
     end
@@ -210,9 +210,7 @@ private
       find_xpath(".//input")
     end.first
 
-    if labelled_control && (labelled_control.checkbox? || labelled_control.radio?)
-      labelled_control.set(!labelled_control.checked?)
-    end
+    labelled_control.set(!labelled_control.checked?) if checkbox_or_radio?(labelled_control)
   end
 
   def link?
@@ -229,6 +227,10 @@ private
 
 protected
 
+  def checkbox_or_radio?(field = self)
+    field && (field.checkbox? || field.radio?)
+  end
+
   def checkbox?
     input_field? && type == 'checkbox'
   end

data/lib/capybara/result.rb

@@ -114,7 +114,7 @@ module Capybara
       if count.zero?
         message << " but there were no matches"
       else
-        message << ", found #{count} #{Capybara::Helpers.declension("match", "matches", count)}: " << full_results.map(&:text).map(&:inspect).join(", ")
+        message << ", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: " << full_results.map(&:text).map(&:inspect).join(", ")
       end
       unless rest.empty?
         elements = rest.map { |el| el.text rescue "<<ERROR>>" }.map(&:inspect).join(", ")

data/lib/capybara/rspec/compound.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Capybara
   module RSpecMatchers
     module Compound

data/lib/capybara/selector.rb

@@ -136,11 +136,19 @@ end
 Capybara.add_selector(:link) do
   xpath(:title, :alt) do |locator, href: true, enable_aria_label: false, alt: nil, title: nil, **_options|
     xpath = XPath.descendant(:a)
-    xpath = if href.nil?
-      xpath[!XPath.attr(:href)]
-    else
-      xpath[XPath.attr(:href)]
-    end
+    xpath = xpath[
+              case href
+              when nil, false
+                !XPath.attr(:href)
+              when true
+                XPath.attr(:href)
+              when Regexp
+                nil # needs to be handled in filter
+              else
+                XPath.attr(:href) == href.to_s
+              end
+            ]
+
     unless locator.nil?
       locator = locator.to_s
       matchers = [XPath.attr(:id) == locator,
@@ -150,20 +158,15 @@ Capybara.add_selector(:link) do
       matchers |= XPath.attr(:'aria-label').is(locator) if enable_aria_label
       xpath = xpath[matchers]
     end
+
     xpath = xpath[find_by_attr(:title, title)]
     xpath = xpath[XPath.descendant(:img)[XPath.attr(:alt) == alt]] if alt
     xpath
   end
 
   filter(:href) do |node, href|
-    case href
-    when nil
-      true
-    when Regexp
-      node[:href].match href
-    else
-      node.first(:xpath, XPath.self[XPath.attr(:href) == href.to_s], minimum: 0)
-    end
+    # If not a Regexp it's been handled in the main XPath
+    href.is_a?(Regexp) ? node[:href].match(href) : true
   end
 
   describe do |**options|
@@ -185,7 +188,7 @@ end
 # @filter [String] :value Matches the value of an input button
 #
 Capybara.add_selector(:button) do
-  xpath(:value, :title) do |locator, **options|
+  xpath(:value, :title, :type) do |locator, **options|
     input_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).one_of('submit', 'reset', 'image', 'button')]
     btn_xpath = XPath.descendant(:button)
     image_btn_xpath = XPath.descendant(:input)[XPath.attr(:type) == 'image']
@@ -380,10 +383,11 @@ Capybara.add_selector(:select) do
     options.sort == actual.sort
   end
 
-  filter(:with_options) do |node, options|
-    finder_settings = { minimum: 0 }
-    finder_settings[:visible] = false unless node.visible?
-    options.all? { |option| node.first(:option, option, finder_settings) }
+  expression_filter(:with_options) do |expr, options|
+    options.each do |option|
+      expr = expr[Capybara::Selector.all[:option].call(option)]
+    end
+    expr
   end
 
   filter(:selected) do |node, selected|
@@ -407,6 +411,37 @@ Capybara.add_selector(:select) do
   end
 end
 
+Capybara.add_selector(:datalist_input) do
+  label "input box with datalist completion"
+
+  xpath do |locator, **options|
+    xpath = XPath.descendant(:input)[XPath.attr(:list)]
+    locate_field(xpath, locator, options)
+  end
+
+  filter_set(:_field, %i[disabled name placeholder])
+
+  filter(:options) do |node, options|
+    actual = node.find("//datalist[@id=#{node[:list]}]", visible: :all).all(:datalist_option, wait: false).map(&:value)
+    options.sort == actual.sort
+  end
+
+  expression_filter(:with_options) do |expr, options|
+    options.each do |option|
+      expr = expr[XPath.attr(:list) == XPath.anywhere(:datalist)[Capybara::Selector.all[:datalist_option].call(option)].attr(:id)]
+    end
+    expr
+  end
+
+  describe do |options: nil, with_options: nil, **opts|
+    desc = "".dup
+    desc << " with options #{options.inspect}" if options
+    desc << " with at least options #{with_options.inspect}" if with_options
+    desc << describe_all_expression_filters(opts)
+    desc
+  end
+end
+
 ##
 #
 # Find option elements
@@ -433,6 +468,25 @@ Capybara.add_selector(:option) do
   end
 end
 
+Capybara.add_selector(:datalist_option) do
+  label "datalist option"
+  visible(:all)
+
+  xpath do |locator|
+    xpath = XPath.descendant(:option)
+    xpath = xpath[XPath.string.n.is(locator.to_s) | (XPath.attr(:value) == locator.to_s)] unless locator.nil?
+    xpath
+  end
+
+  filter(:disabled, :boolean) { |node, value| !(value ^ node.disabled?) }
+
+  describe do |**options|
+    desc = "".dup
+    desc << " that is#{' not' unless options[:disabled]} disabled" if options.key?(:disabled)
+    desc
+  end
+end
+
 ##
 #
 # Find file input elements

data/lib/capybara/selector/css.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Capybara
   class Selector
     class CSS

data/lib/capybara/selenium/driver.rb

@@ -23,11 +23,8 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
       ::Selenium::WebDriver::Error.const_set('ElementClickInterceptedError', Class.new(::Selenium::WebDriver::Error::WebDriverError))
     end
   rescue LoadError => e
-    if e.message =~ /selenium-webdriver/
-      raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
-    else
-      raise e
-    end
+    raise e if e.message !~ /selenium-webdriver/
+    raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
   end
 
   def browser
@@ -305,22 +302,27 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   # @api private
   def firefox?
-    browser.browser == :firefox
+    browser_name == :firefox
   end
 
   # @api private
   def chrome?
-    browser.browser == :chrome
+    browser_name == :chrome
   end
 
   # @api private
   def edge?
-    browser.browser == :edge
+    browser_name == :edge
   end
 
   # @api private
   def ie?
-    browser.browser == :ie
+    browser_name == :ie
+  end
+
+  # @api private
+  def browser_name
+    browser.browser
   end
 
 private
@@ -355,7 +357,7 @@ private
       if response_text.nil?
         "default_text"
       else
-        "'#{response_text.gsub("\\", "\\\\\\").gsub("'", "\\\\'")}'"
+        "'#{response_text.gsub('\\', '\\\\\\').gsub("'", "\\\\'")}'"
       end
     else
       'null'
@@ -447,11 +449,8 @@ private
         if called
           execute_script('window.capybara && window.capybara.modal_handlers.shift()')
           regexp = text.is_a?(Regexp) ? text : Regexp.escape(text.to_s)
-          if alert_text.match(regexp)
-            alert_text
-          else
-            raise Capybara::ModalNotFound, "Unable to find modal dialog#{" with #{text}" if text}"
-          end
+          raise Capybara::ModalNotFound, "Unable to find modal dialog#{" with #{text}" if text}" unless alert_text.match(regexp)
+          alert_text
         elsif called.nil?
           # page changed so modal_handler data has gone away
           warn "Can't verify modal text when page change occurs - ignoring" if options[:text]

data/lib/capybara/selenium/node.rb

@@ -1,19 +1,6 @@
 # frozen_string_literal: true
 
 class Capybara::Selenium::Node < Capybara::Driver::Node
-  SET_FORMATS = Hash.new(date: '%Y-%m-%d', time: '%H:%M', datetime: "%m%d%Y\t%I%M%P").merge(
-    firefox: {
-      date: '%Y-%m-%d',
-      time: '%H:%M',
-      datetime: "%m%d%Y\t%I%M%P"
-    },
-    chrome: {
-      date: '%m%d%Y',
-      time: '%I%M%P',
-      datetime: "%m%d%Y\t%I%M%P"
-    }
-  )
-
   def visible_text
     native.text
   end
@@ -199,7 +186,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
       parent = path.first
       selector = node.tag_name
       if parent
-        siblings = parent.find_xpath(node.tag_name)
+        siblings = parent.find_xpath(selector)
         selector += "[#{siblings.index(node) + 1}]" unless siblings.size == 1
       end
       result.push selector
@@ -254,27 +241,34 @@ private
   end
 
   def set_date(value) # rubocop:disable Naming/AccessorMethodName
-    if value.respond_to?(:to_date)
-      set_text(value.to_date.strftime(SET_FORMATS[driver.browser.browser][:date]))
-    else
-      set_text(value)
-    end
+    return set_text(value) unless value.respond_to?(:to_date)
+    # TODO: this would be better if locale can be detected and correct keystrokes sent
+    update_value_js(value.to_date.strftime('%Y-%m-%d'))
   end
 
   def set_time(value) # rubocop:disable Naming/AccessorMethodName
-    if value.respond_to?(:to_time)
-      set_text(value.to_time.strftime(SET_FORMATS[driver.browser.browser][:time]))
-    else
-      set_text(value)
-    end
+    return set_text(value) unless value.respond_to?(:to_time)
+    # TODO: this would be better if locale can be detected and correct keystrokes sent
+    update_value_js(value.to_time.strftime('%H:%M'))
   end
 
   def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName
-    if value.respond_to?(:to_time)
-      set_text(value.to_time.strftime(SET_FORMATS[driver.browser.browser][:datetime]))
-    else
-      set_text(value)
-    end
+    return set_text(value) unless value.respond_to?(:to_time)
+    # TODO: this would be better if locale can be detected and correct keystrokes sent
+    update_value_js(value.to_time.strftime('%Y-%m-%dT%H:%M'))
+  end
+
+  def update_value_js(value)
+    driver.execute_script(<<-JS, self, value)
+      if (document.activeElement !== arguments[0]){
+        arguments[0].focus();
+      }
+      if (arguments[0].value != arguments[1]) {
+        arguments[0].value = arguments[1]
+        arguments[0].dispatchEvent(new InputEvent('input'));
+        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));
+      }
+      JS
   end
 
   def set_file(value) # rubocop:disable Naming/AccessorMethodName