capybara 2.18.0 → 3.0.0.rc1

data/lib/capybara/session/config.rb

@@ -1,61 +1,55 @@
 # frozen_string_literal: true
+
 require 'delegate'
 
 module Capybara
   class SessionConfig
-    OPTIONS = [:always_include_port, :run_server, :default_selector, :default_max_wait_time, :ignore_hidden_elements,
-               :automatic_reload, :match, :exact, :exact_text, :raise_server_errors, :visible_text_only, :wait_on_first_by_default,
-               :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]
+    OPTIONS = %i[always_include_port run_server default_selector default_max_wait_time ignore_hidden_elements
+                 automatic_reload match exact exact_text raise_server_errors visible_text_only
+                 automatic_label_click enable_aria_label save_path asset_host default_host app_host
+                 server_host server_port server_errors].freeze
 
     attr_accessor(*OPTIONS)
 
     ##
-    #@!method always_include_port
-    #  See {Capybara.configure}
-    #@!method run_server
-    #  See {Capybara.configure}
-    #@!method default_selector
-    #  See {Capybara.configure}
-    #@!method default_max_wait_time
-    #  See {Capybara.configure}
-    #@!method ignore_hidden_elements
-    #  See {Capybara.configure}
-    #@!method automatic_reload
-    #  See {Capybara.configure}
-    #@!method match
-    #  See {Capybara.configure}
-    #@!method exact
-    #  See {Capybara.configure}
-    #@!method raise_server_errors
-    #  See {Capybara.configure}
-    #@!method visible_text_only
-    #  See {Capybara.configure}
-    #@!method wait_on_first_by_default
-    #  See {Capybara.configure}
-    #@!method automatic_label_click
-    #  See {Capybara.configure}
-    #@!method enable_aria_label
-    #  See {Capybara.configure}
-    #@!method save_path
-    #  See {Capybara.configure}
-    #@deprecated
-    #@!method exact_options
-    #  See {Capybara.configure}
-    #@!method asset_host
-    #  See {Capybara.configure}
-    #@!method default_host
-    #  See {Capybara.configure}
-    #@!method app_host
-    #  See {Capybara.configure}
-    #@!method save_and_open_page_path
-    #  See {Capybara.configure}
-    #@!method server_host
-    #  See {Capybara.configure}
-    #@!method server_port
-    #  See {Capybara.configure}
-    #@!method server_errors
-    #  See {Capybara.configure}
+    # @!method always_include_port
+    #   See {Capybara.configure}
+    # @!method run_server
+    #   See {Capybara.configure}
+    # @!method default_selector
+    #   See {Capybara.configure}
+    # @!method default_max_wait_time
+    #   See {Capybara.configure}
+    # @!method ignore_hidden_elements
+    #   See {Capybara.configure}
+    # @!method automatic_reload
+    #   See {Capybara.configure}
+    # @!method match
+    #   See {Capybara.configure}
+    # @!method exact
+    #   See {Capybara.configure}
+    # @!method raise_server_errors
+    #   See {Capybara.configure}
+    # @!method visible_text_only
+    #   See {Capybara.configure}
+    # @!method automatic_label_click
+    #   See {Capybara.configure}
+    # @!method enable_aria_label
+    #   See {Capybara.configure}
+    # @!method save_path
+    #   See {Capybara.configure}
+    # @!method asset_host
+    #   See {Capybara.configure}
+    # @!method default_host
+    #   See {Capybara.configure}
+    # @!method app_host
+    #   See {Capybara.configure}
+    # @!method server_host
+    #   See {Capybara.configure}
+    # @!method server_port
+    #   See {Capybara.configure}
+    # @!method server_errors
+    #   See {Capybara.configure}
 
     remove_method :server_host
 
@@ -74,30 +68,16 @@ module Capybara
 
     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)
+      raise ArgumentError, "Capybara.app_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." if url && url !~ URI::DEFAULT_PARSER.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)
+      raise ArgumentError, "Capybara.default_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." if url && url !~ URI::DEFAULT_PARSER.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?
-      @save_and_open_page_path = path
-    end
-
-    remove_method :exact_options=
-    def exact_options=(opt)
-      @exact_options = opt
-      warn "DEPRECATED: #exact_options is deprecated, please scope your findes/actions and use the `:exact` "\
-           "option if similar functionality is needed."
-    end
-
     def initialize_copy(other)
       super
       @server_errors = @server_errors.dup
@@ -106,9 +86,9 @@ module Capybara
 
   class ReadOnlySessionConfig < SimpleDelegator
     SessionConfig::OPTIONS.each do |m|
-      define_method "#{m}=" do |val|
+      define_method "#{m}=" do |_|
         raise "Per session settings are only supported when Capybara.threadsafe == true"
       end
     end
   end
-end
+end

data/lib/capybara/session/matchers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Capybara
   module SessionMatchers
     ##
@@ -18,8 +19,8 @@ module Capybara
     # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
     # @return [true]
     #
-    def assert_current_path(path, options={})
-      _verify_current_path(path,options) { |query| raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self) }
+    def assert_current_path(path, **options)
+      _verify_current_path(path, options) { |query| raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self) }
     end
 
     ##
@@ -32,8 +33,8 @@ module Capybara
     # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
     # @return [true]
     #
-    def assert_no_current_path(path, options={})
-      _verify_current_path(path,options) { |query| raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self) }
+    def assert_no_current_path(path, **options)
+      _verify_current_path(path, options) { |query| raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self) }
     end
 
     ##
@@ -45,7 +46,7 @@ module Capybara
     # @macro current_path_query_params
     # @return [Boolean]
     #
-    def has_current_path?(path, options={})
+    def has_current_path?(path, **options)
       assert_current_path(path, options)
     rescue Capybara::ExpectationNotMet
       return false
@@ -60,13 +61,13 @@ module Capybara
     # @macro current_path_query_params
     # @return [Boolean]
     #
-    def has_no_current_path?(path, options={})
+    def has_no_current_path?(path, **options)
       assert_no_current_path(path, options)
     rescue Capybara::ExpectationNotMet
       return false
     end
 
-    private
+  private
 
     def _verify_current_path(path, options)
       query = Capybara::Queries::CurrentPathQuery.new(path, options)

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

@@ -8,7 +8,8 @@ $(function() {
       $(this).html('Dropped!');
     }
   });
-  $('#clickable').click(function() {
+  $('#clickable').click(function(e) {
+    debugger;
     var link = $(this);
     setTimeout(function() {
       $(link).after('<a id="has-been-clicked" href="#">Has been clicked</a>');
@@ -64,12 +65,33 @@ $(function() {
     }, 400)
   });
   $('#click-test').on({
-    dblclick: function() {
-      $(this).after('<a id="has-been-double-clicked" href="#">Has been double clicked</a>');
+    click: function(e) {
+      var desc = "";
+      if (e.altKey) desc += 'alt ';
+      if (e.ctrlKey) desc += 'control ';
+      if (e.metaKey) desc += 'meta ';
+      if (e.shiftKey) desc += 'shift ';
+      var pos = this.getBoundingClientRect();
+      $(this).after('<a id="has-been-clicked" href="#">Has been ' + desc + 'clicked at ' + (e.clientX - pos.left) + ',' + (e.clientY - pos.top) + '</a>');
+    },
+    dblclick: function(e) {
+      var desc = "";
+      if (e.altKey) desc += 'alt ';
+      if (e.ctrlKey) desc += 'control ';
+      if (e.metaKey) desc += 'meta ';
+      if (e.shiftKey) desc += 'shift ';
+      var pos = this.getBoundingClientRect();
+      $(this).after('<a id="has-been-double-clicked" href="#">Has been ' + desc + 'double clicked at ' + (e.clientX - pos.left) + ',' + (e.clientY - pos.top) + '</a>');
     },
     contextmenu: function(e) {
       e.preventDefault();
-      $(this).after('<a id="has-been-right-clicked" href="#">Has been right clicked</a>');
+      var desc = "";
+      if (e.altKey) desc += 'alt ';
+      if (e.ctrlKey) desc += 'control ';
+      if (e.metaKey) desc += 'meta ';
+      if (e.shiftKey) desc += 'shift ';
+      var pos = this.getBoundingClientRect();
+      $(this).after('<a id="has-been-right-clicked" href="#">Has been ' + desc + 'right clicked at ' + (e.clientX - pos.left) + ',' + (e.clientY - pos.top) + '</a>');
     }
   });
   $('#open-alert').click(function() {

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#accept_alert', requires: [:modals] do
   before do
     @session.visit('/with_js')

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#accept_confirm', requires: [:modals] do
   before do
     @session.visit('/with_js')
@@ -19,13 +20,13 @@ Capybara::SpecHelper.spec '#accept_confirm', requires: [:modals] do
   end
 
   it "should work with nested modals" do
-    expect {
+    expect do
       @session.dismiss_confirm 'Are you really sure?' do
         @session.accept_confirm 'Are you sure?' do
           @session.click_link('Open check twice')
         end
       end
-    }.not_to raise_error
+    end.not_to raise_error
     expect(@session).to have_xpath("//a[@id='open-twice' and @confirmed='false']")
   end
 end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#accept_prompt', requires: [:modals] do
   before do
     @session.visit('/with_js')

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec "#all" do
   before do
     @session.visit('/with_html')
@@ -14,11 +15,23 @@ Capybara::SpecHelper.spec "#all" do
     expect(@session.all('//div[@id="nosuchthing"]')).to be_empty
   end
 
-  it "should accept an XPath instance" do
+  it "should wait for matching elements to appear", requires: [:js] do
+    @session.visit('/with_js')
+    @session.click_link('Click me')
+    expect(@session.all(:css, "a#has-been-clicked")).not_to be_empty
+  end
+
+  it "should not wait if `minimum: 0` option is specified", requires: [:js] do
+    @session.visit('/with_js')
+    @session.click_link('Click me')
+    expect(@session.all(:css, "a#has-been-clicked", minimum: 0)).to be_empty
+  end
+
+  it "should accept an XPath instance", :exact_false do
     @session.visit('/form')
     @xpath = Capybara::Selector.all[:fillable_field].call('Name')
     expect(@xpath).to be_a(::XPath::Union)
-    @result = @session.all(@xpath).map { |r| r.value }
+    @result = @session.all(@xpath).map(&:value)
     expect(@result).to include('Smith', 'John', 'John Smith')
   end
 
@@ -116,35 +129,35 @@ Capybara::SpecHelper.spec "#all" do
 
     context 'with multiple count filters' do
       it 'ignores other filters when :count is specified' do
-        o = {count: 4,
-             minimum: 5,
-             maximum: 0,
-             between: 0..3}
+        o = { count: 4,
+              minimum: 5,
+              maximum: 0,
+              between: 0..3 }
         expect { @session.all(:css, 'h1, p', o) }.to_not raise_error
       end
       context 'with no :count expectation' do
         it 'fails if :minimum is not met' do
-          o = {minimum: 5,
-               maximum: 4,
-               between: 2..7}
+          o = { minimum: 5,
+                maximum: 4,
+                between: 2..7 }
           expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
         end
         it 'fails if :maximum is not met' do
-          o = {minimum: 0,
-               maximum: 0,
-               between: 2..7}
+          o = { minimum: 0,
+                maximum: 0,
+                between: 2..7 }
           expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
         end
         it 'fails if :between is not met' do
-          o = {minimum: 0,
-               maximum: 4,
-               between: 0..3}
+          o = { minimum: 0,
+                maximum: 4,
+                between: 0..3 }
           expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
         end
         it 'succeeds if all combineable expectations are met' do
-          o = {minimum: 0,
-               maximum: 4,
-               between: 2..7}
+          o = { minimum: 0,
+                maximum: 4,
+                between: 2..7 }
           expect { @session.all(:css, 'h1, p', o) }.to_not raise_error
         end
       end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#ancestor' do
   before do
     @session.visit('/with_html')
@@ -57,7 +58,6 @@ Capybara::SpecHelper.spec '#ancestor' do
     end
   end
 
-
   it "should raise ElementNotFound with a useful default message if nothing was found" do
     el = @session.find(:css, '#child')
     expect do
@@ -65,13 +65,11 @@ Capybara::SpecHelper.spec '#ancestor' do
     end.to raise_error(Capybara::ElementNotFound, "Unable to find xpath \"//div[@id=\\\"nosuchthing\\\"]\" that is an ancestor of visible css \"#child\"")
   end
 
-
-
   context "within a scope" do
     it "should limit the ancestors to inside the scope" do
       @session.within(:css, '#ancestor2') do
         el = @session.find(:css, '#child')
-        expect(el.ancestor(:css,'div', text: 'Ancestor')[:id]).to eq('ancestor1')
+        expect(el.ancestor(:css, 'div', text: 'Ancestor')[:id]).to eq('ancestor1')
       end
     end
   end

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

@@ -1,21 +1,22 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#assert_all_of_selectors' do
   before do
     @session.visit('/with_html')
   end
 
   it "should be true if the given selectors are on the page" do
-    @session.assert_all_of_selectors(:css, "p a#foo", "h2#h2one", "h2#h2two" )
+    @session.assert_all_of_selectors(:css, "p a#foo", "h2#h2one", "h2#h2two")
   end
 
   it "should be false if any of the given selectors are not on the page" do
-    expect { @session.assert_all_of_selectors(:css, "p a#foo", "h2#h2three", "h2#h2one")}.to raise_error(Capybara::ElementNotFound)
+    expect { @session.assert_all_of_selectors(:css, "p a#foo", "h2#h2three", "h2#h2one") }.to raise_error(Capybara::ElementNotFound)
   end
 
   it "should use default selector" do
     Capybara.default_selector = :css
-    expect { @session.assert_all_of_selectors("p a#foo", "h2#h2three", "h2#h2one")}.to raise_error(Capybara::ElementNotFound)
-    @session.assert_all_of_selectors("p a#foo", "h2#h2two", "h2#h2one" )
+    expect { @session.assert_all_of_selectors("p a#foo", "h2#h2three", "h2#h2one") }.to raise_error(Capybara::ElementNotFound)
+    @session.assert_all_of_selectors("p a#foo", "h2#h2two", "h2#h2one")
   end
 
   context "should respect scopes" do
@@ -63,7 +64,7 @@ Capybara::SpecHelper.spec '#assert_none_of_selectors' do
   end
 
   it "should be true if none of the given locators are on the page" do
-    @session.assert_none_of_selectors(:xpath, "//abbr", "//td" )
+    @session.assert_none_of_selectors(:xpath, "//abbr", "//td")
     @session.assert_none_of_selectors(:css, "p a#doesnotexist", "abbr")
   end
 

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#assert_current_path' do
   before do
     @session.visit('/with_js')
   end
 
   it "should not raise if the page has the given current path" do
-    expect {@session.assert_current_path('/with_js')}.not_to raise_error
+    expect { @session.assert_current_path('/with_js') }.not_to raise_error
   end
 
   it "should allow regexp matches" do
@@ -18,27 +19,27 @@ Capybara::SpecHelper.spec '#assert_current_path' do
   end
 
   it "should raise if the page has not the given current_path" do
-    expect{@session.assert_current_path('/with_html')}.to raise_error(Capybara::ExpectationNotMet, 'expected "/with_js" to equal "/with_html"')
+    expect { @session.assert_current_path('/with_html') }.to raise_error(Capybara::ExpectationNotMet, 'expected "/with_js" to equal "/with_html"')
   end
 
   it "should check query options" do
     @session.visit('/with_js?test=test')
-    expect{@session.assert_current_path('/with_js?test=test')}.not_to raise_error
+    expect { @session.assert_current_path('/with_js?test=test') }.not_to raise_error
   end
 
   it "should compare the full url" do
-    expect{@session.assert_current_path(%r{\Ahttp://[^/]*/with_js\Z}, url: true)}.not_to raise_error
+    expect { @session.assert_current_path(%r{\Ahttp://[^/]*/with_js\Z}, url: true) }.not_to raise_error
   end
 
   it "should ignore the query" do
     @session.visit('/with_js?test=test')
-    expect{@session.assert_current_path('/with_js', only_path: true)}.not_to raise_error
+    expect { @session.assert_current_path('/with_js', ignore_query: true) }.not_to raise_error
   end
 
   it "should not cause an exception when current_url is nil" do
     allow_any_instance_of(Capybara::Session).to receive(:current_url) { nil }
 
-    expect{@session.assert_current_path(nil)}.not_to raise_error
+    expect { @session.assert_current_path(nil) }.not_to raise_error
   end
 end
 
@@ -48,25 +49,25 @@ Capybara::SpecHelper.spec '#assert_no_current_path?' do
   end
 
   it "should raise if the page has the given current_path" do
-    expect{@session.assert_no_current_path('/with_js')}.to raise_error(Capybara::ExpectationNotMet)
+    expect { @session.assert_no_current_path('/with_js') }.to raise_error(Capybara::ExpectationNotMet)
   end
 
   it "should allow regexp matches" do
-    expect{@session.assert_no_current_path(/monkey/)}.not_to raise_error
+    expect { @session.assert_no_current_path(/monkey/) }.not_to raise_error
   end
 
   it "should wait for current_path to disappear", requires: [:js] do
     @session.click_link("Change page")
-    expect{@session.assert_no_current_path('/with_js')}.not_to raise_error
+    expect { @session.assert_no_current_path('/with_js') }.not_to raise_error
   end
 
   it "should not raise if the page has not the given current_path" do
-    expect{@session.assert_no_current_path('/with_html')}.not_to raise_error
+    expect { @session.assert_no_current_path('/with_html') }.not_to raise_error
   end
 
   it "should not cause an exception when current_url is nil" do
     allow_any_instance_of(Capybara::Session).to receive(:current_url) { nil }
 
-    expect{@session.assert_no_current_path('/with_html')}.not_to raise_error
+    expect { @session.assert_no_current_path('/with_html') }.not_to raise_error
   end
 end