capybara 3.1.1 → 3.2.0

data/lib/capybara/session.rb

@@ -26,7 +26,7 @@ module Capybara
   #     end
   #
   # Session provides a number of methods for controlling the navigation of the page, such as +visit+,
-  # +current_path, and so on. It also delegate a number of methods to a Capybara::Document, representing
+  # +current_path, and so on. It also delegates a number of methods to a Capybara::Document, representing
   # the current HTML document. This allows interaction:
   #
   #     session.fill_in('q', with: 'Capybara')
@@ -83,10 +83,10 @@ module Capybara
         raise "A configuration block is only accepted when Capybara.threadsafe == true" unless Capybara.threadsafe
         yield config
       end
-      @server = if config.run_server and @app and driver.needs_server?
-        Capybara::Server.new(@app, port: config.server_port, host: config.server_host, reportable_errors: config.server_errors).boot
-      else
-        nil
+      @server = if config.run_server && @app && driver.needs_server?
+        server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }
+        server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation
+        Capybara::Server.new(@app, server_options).boot
       end
       @touched = false
     end
@@ -126,7 +126,7 @@ module Capybara
         driver.reset!
         @touched = false
       end
-      @server.wait_for_pending_requests if @server
+      @server&.wait_for_pending_requests
       raise_server_error!
     end
     alias_method :cleanup!, :reset!
@@ -189,14 +189,11 @@ module Capybara
       # Addressable parsing is more lenient than URI
       uri = ::Addressable::URI.parse(current_url)
 
-      # If current_url ends up being nil, won't be able to call .path on a NilClass.
-      return nil if uri.nil?
-
       # Addressable doesn't support opaque URIs - we want nil here
-      return nil if uri.scheme == "about"
+      return nil if uri&.scheme == "about"
 
-      path = uri.path
-      path if path && !path.empty?
+      path = uri&.path
+      path unless path&.empty?
     end
 
     ##
@@ -248,11 +245,10 @@ module Capybara
 
       visit_uri = ::Addressable::URI.parse(visit_uri.to_s)
 
-      uri_base = if @server
-        ::Addressable::URI.parse(config.app_host || "http#{'s' if @server.using_ssl?}://#{@server.host}:#{@server.port}")
-      else
-        config.app_host && ::Addressable::URI.parse(config.app_host)
-      end
+      base = config.app_host
+      base ||= "http#{'s' if @server.using_ssl?}://#{@server.host}:#{@server.port}" if @server
+
+      uri_base = ::Addressable::URI.parse(base)
 
       if uri_base && [nil, 'http', 'https'].include?(visit_uri.scheme)
         if visit_uri.relative?
@@ -337,7 +333,7 @@ module Capybara
       new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args)
       begin
         scopes.push(new_scope)
-        yield
+        yield if block_given?
       ensure
         scopes.pop
       end
@@ -411,7 +407,7 @@ module Capybara
     #
     # @overload within_frame(element)
     #   @param [Capybara::Node::Element]  frame element
-    # @overload within_frame([kind = :frame], locator, options = {})
+    # @overload within_frame([kind = :frame], locator, **options)
     #   @param [Symbol] kind      Optional selector type (:css, :xpath, :field, etc.) - Defaults to :frame
     #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element
     # @overload within_frame(index)
@@ -419,7 +415,7 @@ module Capybara
     def within_frame(*args)
       switch_to_frame(_find_frame(*args))
       begin
-        yield
+        yield if block_given?
       ensure
         switch_to_frame(:parent)
       end
@@ -475,9 +471,8 @@ module Capybara
     # @raise [ArgumentError]               if both or neither arguments were provided
     #
     def switch_to_window(window = nil, **options, &window_locator)
-      block_given = block_given?
-      raise ArgumentError, "`switch_to_window` can take either a block or a window, not both" if window && block_given
-      raise ArgumentError, "`switch_to_window`: either window or block should be provided" if !window && !block_given
+      raise ArgumentError, "`switch_to_window` can take either a block or a window, not both" if window && block_given?
+      raise ArgumentError, "`switch_to_window`: either window or block should be provided" if !window && !block_given?
       unless scopes.last.nil?
         raise Capybara::ScopeError, "`switch_to_window` is not supposed to be invoked from "\
                                     "`within` or `within_frame` blocks."
@@ -521,7 +516,7 @@ module Capybara
         end
 
         begin
-          yield
+          yield if block_given?
         ensure
           _switch_to_window(original) unless original == window_or_proc
         end
@@ -569,7 +564,7 @@ module Capybara
     #
     def execute_script(script, *args)
       @touched = true
-      driver.execute_script(script, *args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg })
+      driver.execute_script(script, *driver_args(args))
     end
 
     ##
@@ -583,7 +578,7 @@ module Capybara
     #
     def evaluate_script(script, *args)
       @touched = true
-      result = driver.evaluate_script(script, *args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg })
+      result = driver.evaluate_script(script, *driver_args(args))
       element_script_result(result)
     end
 
@@ -596,7 +591,7 @@ module Capybara
     #
     def evaluate_async_script(script, *args)
       @touched = true
-      result = driver.evaluate_async_script(script, *args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg })
+      result = driver.evaluate_async_script(script, *driver_args(args))
       element_script_result(result)
     end
 
@@ -610,11 +605,11 @@ module Capybara
     #     $0 do
     #       click_link('link that triggers appearance of system modal')
     #     end
-    #   @overload $0(text, options = {}, &blk)
+    #   @overload $0(text, **options, &blk)
     #     @param text [String, Regexp]  Text or regex to match against the text in the modal.  If not provided any modal is matched
     #     @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time to wait for the modal to appear after executing the block.
     #     @yield Block whose actions will trigger the system modal
-    #   @overload $0(options = {}, &blk)
+    #   @overload $0(**options, &blk)
     #     @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time to wait for the modal to appear after executing the block.
     #     @yield Block whose actions will trigger the system modal
     #   @return [String]  the message shown in the modal
@@ -799,6 +794,10 @@ module Capybara
 
     @@instance_created = false
 
+    def driver_args(args)
+      args.map { |arg| arg.is_a?(Capybara::Node::Element) ? arg.base : arg }
+    end
+
     def accept_modal(type, text_or_options, options, &blk)
       driver.accept_modal(type, modal_options(text_or_options, options), &blk)
     end
@@ -878,7 +877,7 @@ module Capybara
               driver.switch_to_window handle
               return Window.new(self, handle) if yield
             end
-          rescue => e
+          rescue StandardError => e
             driver.switch_to_window(original_window_handle)
             raise e
           else

data/lib/capybara/session/config.rb

@@ -7,7 +7,7 @@ module Capybara
     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
+                 server_host server_port server_errors default_set_options disable_animation].freeze
 
     attr_accessor(*OPTIONS)
 
@@ -50,6 +50,10 @@ module Capybara
     #   See {Capybara.configure}
     # @!method server_errors
     #   See {Capybara.configure}
+    # @!method default_set_options
+    #   See {Capybara.configure}
+    # @!method disable_animation
+    #   See {Capybara.configure}
 
     remove_method :server_host
 
@@ -78,6 +82,12 @@ module Capybara
       @default_host = url
     end
 
+    remove_method :disable_animation=
+    def disable_animation=(bool)
+      warn "Capybara.disable_animation is a beta feature - it may change/disappear in a future point version" if bool
+      @disable_animation = bool
+    end
+
     def initialize_copy(other)
       super
       @server_errors = @server_errors.dup

data/lib/capybara/session/matchers.rb

@@ -9,9 +9,9 @@ module Capybara
     # the comparison will depend on the :url option
     #
     # @!macro current_path_query_params
-    #   @overload $0(string, options = {})
+    #   @overload $0(string, **options)
     #     @param string [String]           The string that the current 'path' should equal
-    #   @overload $0(regexp, options = {})
+    #   @overload $0(regexp, **options)
     #     @param regexp [Regexp]           The regexp that the current 'path' should match to
     #   @option options [Boolean] :url (true if `string` ia a full url, otherwise false) Whether the compare should be done against the full current url or just the path
     #   @option options [Boolean] :ignore_query (false)  Whether the query portion of the current url/path should be ignored
@@ -49,7 +49,7 @@ module Capybara
     def has_current_path?(path, **options)
       assert_current_path(path, options)
     rescue Capybara::ExpectationNotMet
-      return false
+      false
     end
 
     ##
@@ -64,7 +64,7 @@ module Capybara
     def has_no_current_path?(path, **options)
       assert_no_current_path(path, options)
     rescue Capybara::ExpectationNotMet
-      return false
+      false
     end
 
   private
@@ -74,7 +74,7 @@ module Capybara
       document.synchronize(query.wait) do
         yield(query)
       end
-      return true
+      true
     end
   end
 end

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

@@ -76,7 +76,7 @@ Capybara::SpecHelper.spec '#assert_text' do
     @session.visit('/with_html')
     expect do
       @session.assert_text(/xxxxyzzz/)
-    end.to raise_error(Capybara::ExpectationNotMet, /\Aexpected to find text matching \/xxxxyzzz\/ in "This is a test\\nHeader Class(.+)"\Z/)
+    end.to raise_error(Capybara::ExpectationNotMet, %r{\Aexpected to find text matching /xxxxyzzz/ in "This is a test\\nHeader Class(.+)"\Z})
   end
 
   it "should escape any characters that would have special meaning in a regexp" do

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

@@ -7,19 +7,17 @@ Capybara::SpecHelper.spec '#body' do
     expect(@session.body).to include('Hello world!')
   end
 
-  if "".respond_to?(:encoding)
-    context "encoding of response between ascii and utf8" do
-      it "should be valid with html entities" do
-        @session.visit('/with_html_entities')
-        expect(@session).to have_content('Encoding') # wait for content to appear if visit is async
-        expect { @session.body.encode!("UTF-8") }.not_to raise_error
-      end
+  context "encoding of response between ascii and utf8" do
+    it "should be valid with html entities" do
+      @session.visit('/with_html_entities')
+      expect(@session).to have_content('Encoding') # wait for content to appear if visit is async
+      expect { @session.body.encode!("UTF-8") }.not_to raise_error
+    end
 
-      it "should be valid without html entities" do
-        @session.visit('/with_html')
-        expect(@session).to have_content('This is a test') # wait for content to appear if visit is async
-        expect { @session.body.encode!("UTF-8") }.not_to raise_error
-      end
+    it "should be valid without html entities" do
+      @session.visit('/with_html')
+      expect(@session).to have_content('This is a test') # wait for content to appear if visit is async
+      expect { @session.body.encode!("UTF-8") }.not_to raise_error
     end
   end
 end

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

@@ -93,12 +93,12 @@ Capybara::SpecHelper.spec '#click_link' do
     end
 
     it "should find a link matching an exact regex pattern" do
-      @session.click_link('labore', href: /\/with_simple_html/)
+      @session.click_link('labore', href: %r{/with_simple_html})
       expect(@session).to have_content('Bar')
     end
 
     it "should find a link matching a partial regex pattern" do
-      @session.click_link('labore', href: /\/with_simple/)
+      @session.click_link('labore', href: %r{/with_simple})
       expect(@session).to have_content('Bar')
     end
 
@@ -137,7 +137,7 @@ Capybara::SpecHelper.spec '#click_link' do
 
   it "should follow redirects back to itself" do
     @session.click_link('BackToMyself')
-    expect(@session).to have_css('#referrer', text: /\/with_html$/)
+    expect(@session).to have_css('#referrer', text: %r{/with_html$})
     expect(@session).to have_content('This is a test')
   end
 

data/lib/capybara/spec/session/element/assert_match_selector_spec.rb

@@ -28,7 +28,7 @@ Capybara::SpecHelper.spec '#assert_matches_selector' do
   end
 
   it "should not accept count options" do
-    expect { @element.assert_matches_selector(:css, '.number', count: 1) }.to raise_error(ArgumentError)
+    expect { @element.assert_matches_selector(:css, '.number', count: 1) }.to raise_error(ArgumentError, /count/)
   end
 
   it "should accept a filter block" do

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

@@ -159,9 +159,18 @@ Capybara::SpecHelper.spec "#fill_in" do
     expect(extract_results(@session)['zipcode']).to eq('12345')
   end
 
+  it "fills in a field if default_set_options is nil" do
+    Capybara.default_set_options = nil
+    @session.fill_in(:form_first_name, with: 'Thomas')
+    @session.click_button('awesome')
+    expect(extract_results(@session)['first_name']).to eq('Thomas')
+  end
+
   context 'on a pre-populated textfield with a reformatting onchange', requires: [:js] do
     it 'should only trigger onchange once' do
       @session.visit('/with_js')
+      # Click somewhere on the page to ensure focus is acquired. Without this FF won't generate change events for some reason???
+      @session.find(:css, 'body').click
       @session.fill_in('with_change_event', with: 'some value')
       # click outside the field to trigger the change event
       @session.find(:css, 'body').click

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

@@ -39,7 +39,7 @@ Capybara::SpecHelper.spec '#find_field' do
   it "should raise error if filter option is invalid" do
     expect do
       @session.find_field('Dog', disabled: nil)
-    end.to raise_error ArgumentError, "Invalid value nil passed to filter disabled"
+    end.to raise_error ArgumentError, "Invalid value nil passed to NodeFilter disabled"
   end
 
   context "with :exact option" do

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

@@ -127,7 +127,8 @@ Capybara::SpecHelper.spec '#find' do
     before do
       Capybara.add_selector(:beatle) do
         xpath { |name| ".//li[contains(@class, 'beatle')][contains(text(), '#{name}')]" }
-        filter(:type) { |node, type| node[:class].split(/\s+/).include?(type) }
+        node_filter(:type) { |node, type| node[:class].split(/\s+/).include?(type) }
+        node_filter(:fail) { |_node, _val| raise Capybara::ElementNotFound, 'fail' }
       end
     end
 
@@ -145,13 +146,17 @@ Capybara::SpecHelper.spec '#find' do
       expect { @session.find(:beatle, 'John', type: 'drummer') }.to raise_error(Capybara::ElementNotFound)
       expect { @session.find(:beatle, 'George', type: 'drummer') }.to raise_error(Capybara::ElementNotFound)
     end
+
+    it "should not raise an ElementNotFound error from in a filter" do
+      expect { @session.find(:beatle, 'John', fail: 'something') }.to raise_error(Capybara::ElementNotFound, /beatle "John"/)
+    end
   end
 
   context "with custom selector with custom filter and default" do
     before do
       Capybara.add_selector(:beatle) do
         xpath { |name| ".//li[contains(@class, 'beatle')][contains(text(), '#{name}')]" }
-        filter(:type, default: "drummer") { |node, type| node[:class].split(/\s+/).include?(type) }
+        node_filter(:type, default: "drummer") { |node, type| node[:class].split(/\s+/).include?(type) }
       end
     end
 
@@ -174,7 +179,7 @@ Capybara::SpecHelper.spec '#find' do
   context "with alternate filter set" do
     before do
       Capybara::Selector::FilterSet.add(:value) do
-        filter(:with) { |node, with| node.value == with.to_s }
+        node_filter(:with) { |node, with| node.value == with.to_s }
       end
 
       Capybara.add_selector(:id_with_field_filters) do

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

@@ -10,7 +10,7 @@ Capybara::SpecHelper.spec '#has_link?' do
     expect(@session).to have_link('awesome title')
     expect(@session).to have_link('A link', href: '/with_simple_html')
     expect(@session).to have_link(:'A link', href: :'/with_simple_html')
-    expect(@session).to have_link('A link', href: /\/with_simple_html/)
+    expect(@session).to have_link('A link', href: %r{/with_simple_html})
   end
 
   it "should be false if the given link is not on the page" do
@@ -34,6 +34,6 @@ Capybara::SpecHelper.spec '#has_no_link?' do
   it "should be true if the given link is not on the page" do
     expect(@session).to have_no_link('monkey')
     expect(@session).to have_no_link('A link', href: '/nonexistent-href')
-    expect(@session).to have_no_link('A link', href: /\/nonexistent-href/)
+    expect(@session).to have_no_link('A link', href: %r{/nonexistent-href})
   end
 end

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

@@ -102,6 +102,14 @@ Capybara::SpecHelper.spec "node" do
       expect { @session.first('//textarea[@readonly]').set('changed') }.to raise_error(Capybara::ReadOnlyElementError)
     end
 
+    it 'should use global default options' do
+      Capybara.default_set_options = { clear: :backspace }
+      element = @session.first(:fillable_field, type: 'text')
+      allow(element.base).to receive(:set)
+      element.set('gorilla')
+      expect(element.base).to have_received(:set).with('gorilla', clear: :backspace)
+    end
+
     context "with a contenteditable element", requires: [:js] do
       it 'should allow me to change the contents' do
         @session.visit('/with_js')
@@ -447,6 +455,48 @@ Capybara::SpecHelper.spec "node" do
     end
   end
 
+  describe "#execute_script", requires: %i[js es_args] do
+    it "should execute the given script in the context of the element and return nothing" do
+      @session.visit('/with_js')
+      expect(@session.find(:css, '#change').execute_script("this.textContent = 'Funky Doodle'")).to be_nil
+      expect(@session).to have_css('#change', text: 'Funky Doodle')
+    end
+
+    it "should pass arguments to the script" do
+      @session.visit('/with_js')
+      @session.find(:css, '#change').execute_script("this.textContent = arguments[0]", "Doodle Funk")
+      expect(@session).to have_css('#change', text: 'Doodle Funk')
+    end
+  end
+
+  describe "#evaluate_script", requires: %i[js es_args] do
+    it "should evaluate the given script in the context of the element and  return whatever it produces" do
+      @session.visit('/with_js')
+      el = @session.find(:css, '#with_change_event')
+      expect(el.evaluate_script("this.value")).to eq('default value')
+    end
+
+    it "should pass arguments to the script" do
+      @session.visit('/with_js')
+      @session.find(:css, '#change').evaluate_script("this.textContent = arguments[0]", "Doodle Funk")
+      expect(@session).to have_css('#change', text: 'Doodle Funk')
+    end
+
+    it "should pass multiple arguments" do
+      @session.visit('/with_js')
+      change = @session.find(:css, '#change')
+      expect(change.evaluate_script("arguments[0] + arguments[1]", 2, 3)).to eq 5
+    end
+
+    it "should support returning elements" do
+      @session.visit('/with_js')
+      change = @session.find(:css, '#change') # ensure page has loaded and element is available
+      el = change.evaluate_script("this")
+      expect(el).to be_instance_of(Capybara::Node::Element)
+      expect(el).to eq(change)
+    end
+  end
+
   describe '#reload', requires: [:js] do
     context "without automatic reload" do
       before { Capybara.automatic_reload = false }