capybara 3.6.0 → 3.7.0

data/lib/capybara/server/middleware.rb

@@ -20,7 +20,7 @@ module Capybara
         end
       end
 
-      attr_accessor :error
+      attr_reader :error
 
       def initialize(app, server_errors, extra_middleware = [])
         @app = app
@@ -35,6 +35,10 @@ module Capybara
         @counter.value.positive?
       end
 
+      def clear_error
+        @error = nil
+      end
+
       def call(env)
         if env['PATH_INFO'] == '/__identify__'
           [200, {}, [@app.object_id.to_s]]
@@ -42,9 +46,9 @@ module Capybara
           @counter.increment
           begin
             @extended_app.call(env)
-          rescue *@server_errors => e
-            @error ||= e
-            raise e
+          rescue *@server_errors => err
+            @error ||= err
+            raise err
           ensure
             @counter.decrement
           end

data/lib/capybara/session.rb

@@ -137,7 +137,7 @@ module Capybara
     # Raise errors encountered in the server
     #
     def raise_server_error!
-      return if @server.nil? || !@server.error
+      return unless @server&.error
       # Force an explanation for the error being raised as the exception cause
       begin
         if config.raise_server_errors
@@ -244,26 +244,19 @@ module Capybara
       @touched = true
 
       visit_uri = ::Addressable::URI.parse(visit_uri.to_s)
+      base_uri = ::Addressable::URI.parse(config.app_host || server_url)
 
-      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 base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme)
         if visit_uri.relative?
-          uri_base.port ||= @server.port if @server && config.always_include_port
-
-          visit_uri_parts = visit_uri.to_hash.delete_if { |_k, v| v.nil? }
+          visit_uri_parts = visit_uri.to_hash.delete_if { |_k, value| value.nil? }
 
           # Useful to people deploying to a subdirectory
           # and/or single page apps where only the url fragment changes
-          visit_uri_parts[:path] = uri_base.path + visit_uri.path
+          visit_uri_parts[:path] = base_uri.path + visit_uri.path
 
-          visit_uri = uri_base.merge(visit_uri_parts)
-        elsif @server && config.always_include_port
-          visit_uri.port ||= @server.port
+          visit_uri = base_uri.merge(visit_uri_parts)
         end
+        adjust_server_port(visit_uri)
       end
 
       driver.visit(visit_uri.to_s)
@@ -544,8 +537,7 @@ module Capybara
       old_handles = driver.window_handles
       yield
 
-      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)
-      document.synchronize(wait_time, errors: [Capybara::WindowError]) do
+      synchronize_windows(options) do
         opened_handles = (driver.window_handles - old_handles)
         if opened_handles.size != 1
           raise Capybara::WindowError, 'block passed to #window_opened_by '\
@@ -675,8 +667,8 @@ module Capybara
     # @return [String]      the path to which the file was saved
     #
     def save_page(path = nil)
-      prepare_path(path, 'html').tap do |p|
-        File.write(p, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')
+      prepare_path(path, 'html').tap do |p_path|
+        File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb')
       end
     end
 
@@ -691,7 +683,7 @@ module Capybara
     # @param [String] path  the path to where it should be saved
     #
     def save_and_open_page(path = nil)
-      save_page(path).tap { |p| open_file(p) }
+      save_page(path).tap { |s_path| open_file(s_path) }
     end
 
     ##
@@ -706,7 +698,7 @@ module Capybara
     # @param [Hash] options   a customizable set of options
     # @return [String]        the path to which the file was saved
     def save_screenshot(path = nil, **options)
-      prepare_path(path, 'png').tap { |p| driver.save_screenshot(p, options) }
+      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, options) }
     end
 
     ##
@@ -722,7 +714,7 @@ module Capybara
     #
     def save_and_open_screenshot(path = nil, **options)
       # rubocop:disable Lint/Debugger
-      save_screenshot(path, options).tap { |p| open_file(p) }
+      save_screenshot(path, options).tap { |s_path| open_file(s_path) }
       # rubocop:enable Lint/Debugger
     end
 
@@ -822,7 +814,7 @@ module Capybara
     end
 
     def prepare_path(path, extension)
-      File.expand_path(path || default_fn(extension), config.save_path).tap { |p| FileUtils.mkdir_p(File.dirname(p)) }
+      File.expand_path(path || default_fn(extension), config.save_path).tap { |p_path| FileUtils.mkdir_p(File.dirname(p_path)) }
     end
 
     def default_fn(extension)
@@ -837,9 +829,9 @@ module Capybara
     def element_script_result(arg)
       case arg
       when Array
-        arg.map { |e| element_script_result(e) }
+        arg.map { |subarg| element_script_result(subarg) }
       when Hash
-        arg.each { |k, v| arg[k] = element_script_result(v) }
+        arg.each { |key, value| arg[key] = element_script_result(value) }
       when Capybara::Driver::Node
         Capybara::Node::Element.new(self, arg, nil, nil)
       else
@@ -847,6 +839,14 @@ module Capybara
       end
     end
 
+    def server_url
+      "http#{'s' if @server.using_ssl?}://#{@server.host}:#{@server.port}" if @server
+    end
+
+    def adjust_server_port(uri)
+      uri.port ||= @server.port if @server && config.always_include_port
+    end
+
     def _find_frame(*args)
       return find(:frame) if args.length.zero?
 
@@ -865,31 +865,37 @@ module Capybara
       end
     end
 
-    def _switch_to_window(window = nil, **options)
+    def _switch_to_window(window = nil, **options, &window_locator)
       raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)
-      raise Capybara::ScopeError, 'Window cannot be switch inside a `within` block' unless scopes.last.nil?
+      raise Capybara::ScopeError, 'Window cannot be switched inside a `within` block' unless scopes.last.nil?
 
       if window
         driver.switch_to_window(window.handle)
         window
       else
-        wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)
-        document.synchronize(wait_time, errors: [Capybara::WindowError]) do
+        synchronize_windows(options) do
           original_window_handle = driver.current_window_handle
           begin
-            driver.window_handles.each do |handle|
-              driver.switch_to_window handle
-              return Window.new(self, handle) if yield
-            end
-          rescue StandardError => e
+            _switch_to_window_by_locator(&window_locator)
+          rescue StandardError
             driver.switch_to_window(original_window_handle)
-            raise e
-          else
-            driver.switch_to_window(original_window_handle)
-            raise Capybara::WindowError, 'Could not find a window matching block/lambda'
+            raise
           end
         end
       end
     end
+
+    def _switch_to_window_by_locator
+      driver.window_handles.each do |handle|
+        driver.switch_to_window handle
+        return Window.new(self, handle) if yield
+      end
+      raise Capybara::WindowError, 'Could not find a window matching block/lambda'
+    end
+
+    def synchronize_windows(options, &block)
+      wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)
+      document.synchronize(wait_time, errors: [Capybara::WindowError], &block)
+    end
   end
 end

data/lib/capybara/session/config.rb

@@ -8,7 +8,7 @@ module Capybara
                  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 default_set_options disable_animation test_id
-                 predicates_wait].freeze
+                 predicates_wait default_normalize_ws].freeze
 
     attr_accessor(*OPTIONS)
 
@@ -57,6 +57,8 @@ module Capybara
     #   See {Capybara.configure}
     # @!method test_id
     #   See {Capybara.configure}
+    # @!method default_normalize_ws
+    #   See {Capybara.configure}
 
     remove_method :server_host
 
@@ -86,9 +88,9 @@ module Capybara
     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
+    def disable_animation=(bool_or_allowlist)
+      warn 'Capybara.disable_animation is a beta feature - it may change/disappear in a future point version' if bool_or_allowlist
+      @disable_animation = bool_or_allowlist
     end
 
     remove_method :test_id=
@@ -111,8 +113,8 @@ module Capybara
   end
 
   class ReadOnlySessionConfig < SimpleDelegator
-    SessionConfig::OPTIONS.each do |m|
-      define_method "#{m}=" do |_|
+    SessionConfig::OPTIONS.each do |option|
+      define_method "#{option}=" do |_|
         raise 'Per session settings are only supported when Capybara.threadsafe == true'
       end
     end

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

@@ -15,6 +15,20 @@ Capybara::SpecHelper.spec '#assert_text' do
     expect(@session.assert_text('text with whitespace', normalize_ws: true)).to eq(true)
   end
 
+  context 'with enabled default collapsing whitespace' do
+    before { Capybara.default_normalize_ws = true }
+
+    it 'should be true if the given unnormalized text is on the page' do
+      @session.visit('/with_html')
+      expect(@session.assert_text('text with   whitespace', normalize_ws: false)).to eq(true)
+    end
+
+    it 'should support collapsing whitespace' do
+      @session.visit('/with_html')
+      expect(@session.assert_text('text with whitespace')).to eq(true)
+    end
+  end
+
   it 'should take scopes into account' do
     @session.visit('/with_html')
     @session.within("//a[@title='awesome title']") do

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

@@ -22,6 +22,13 @@ Capybara::SpecHelper.spec '#attach_file' do
       expect(extract_results(@session)['image']).to eq(File.basename(__FILE__))
     end
 
+    it 'should be able to set on element if no locator passed' do
+      ff = @session.find(:file_field, 'Image')
+      ff.attach_file(with_os_path_separators(__FILE__))
+      @session.click_button('awesome')
+      expect(extract_results(@session)['image']).to eq(File.basename(__FILE__))
+    end
+
     it 'casts to string' do
       @session.attach_file :form_image, with_os_path_separators(__FILE__)
       @session.click_button('awesome')

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

@@ -68,6 +68,13 @@ Capybara::SpecHelper.spec '#check' do
     expect(extract_results(@session)['pets']).to include('dog', 'cat', 'hamster')
   end
 
+  it 'should be able to check itself if no locator specified' do
+    cb = @session.find(:id, 'form_pets_cat')
+    cb.check
+    @session.click_button('awesome')
+    expect(extract_results(@session)['pets']).to include('dog', 'cat', 'hamster')
+  end
+
   it 'casts to string' do
     @session.check(:form_pets_cat)
     @session.click_button('awesome')
@@ -142,6 +149,20 @@ Capybara::SpecHelper.spec '#check' do
         expect(extract_results(@session)['cars']).to include('mclaren')
       end
 
+      it 'should check via clicking the label with :for attribute if locator nil' do
+        cb = @session.find(:checkbox, 'form_cars_tesla', unchecked: true, visible: :hidden)
+        cb.check
+        @session.click_button('awesome')
+        expect(extract_results(@session)['cars']).to include('tesla')
+      end
+
+      it 'should check self via clicking the wrapping label if locator nil' do
+        cb = @session.find(:checkbox, 'form_cars_mclaren', unchecked: true, visible: :hidden)
+        cb.check
+        @session.click_button('awesome')
+        expect(extract_results(@session)['cars']).to include('mclaren')
+      end
+
       it 'should not click the label if unneeded' do
         expect(@session.find(:checkbox, 'form_cars_jaguar', checked: true, visible: :hidden)).to be_truthy
         @session.check('form_cars_jaguar')

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

@@ -23,6 +23,13 @@ Capybara::SpecHelper.spec '#choose' do
     expect(extract_results(@session)['gender']).to eq('male')
   end
 
+  it 'should be able to choose self when no locator string specified' do
+    rb = @session.find(:id, 'gender_male')
+    rb.choose
+    @session.click_button('awesome')
+    expect(extract_results(@session)['gender']).to eq('male')
+  end
+
   it 'casts to string' do
     @session.choose('Both')
     @session.click_button(:awesome)
@@ -82,12 +89,19 @@ Capybara::SpecHelper.spec '#choose' do
         Capybara.automatic_label_click = old_click_label
       end
 
-      it 'should select by clicking the link if available' do
+      it 'should select by clicking the label if available' do
         @session.choose('party_democrat')
         @session.click_button('awesome')
         expect(extract_results(@session)['party']).to eq('democrat')
       end
 
+      it 'should select self by clicking the label if no locator specified' do
+        cb = @session.find(:id, 'party_democrat', visible: :hidden)
+        cb.choose
+        @session.click_button('awesome')
+        expect(extract_results(@session)['party']).to eq('democrat')
+      end
+
       it 'should raise error if not allowed to click label' do
         expect { @session.choose('party_democrat', allow_label_click: false) }.to raise_error(Capybara::ElementNotFound, 'Unable to find visible radio button "party_democrat"')
       end

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

@@ -137,6 +137,13 @@ Capybara::SpecHelper.spec '#fill_in' do
     expect(extract_results(@session)['schmooo']).to eq('Schmooo for all')
   end
 
+  it 'should be able to fill in element called on when no locator passed' do
+    field = @session.find(:fillable_field, 'form[password]')
+    field.fill_in(with: 'supasikrit')
+    @session.click_button('awesome')
+    expect(extract_results(@session)['password']).to eq('supasikrit')
+  end
+
   it "should throw an exception if a hash containing 'with' is not provided" do
     expect { @session.fill_in 'Name' }.to raise_error(ArgumentError, /with/)
   end

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

@@ -208,11 +208,12 @@ Capybara::SpecHelper.spec '#find' do
   context 'with css as default selector' do
     before { Capybara.default_selector = :css }
 
+    after { Capybara.default_selector = :xpath }
+
     it 'should find the first element using the given locator' do
       expect(@session.find('h1').text).to eq('This is a test')
       expect(@session.find("input[id='test_field']").value).to eq('monkey')
     end
-    after { Capybara.default_selector = :xpath }
   end
 
   it 'should raise ElementNotFound with a useful default message if nothing was found' do

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

@@ -78,6 +78,24 @@ Capybara::SpecHelper.spec '#has_selector?' do
         expect(@session).to have_selector(:css, 'p a#foo', 'extra')
       end.to raise_error ArgumentError, /extra/
     end
+
+    context 'with whitespace normalization' do
+      context 'Capybara.default_normalize_ws = false' do
+        it 'should support normalize_ws option' do
+          Capybara.default_normalize_ws = false
+          expect(@session).not_to have_selector(:id, 'second', text: 'text with whitespace')
+          expect(@session).to have_selector(:id, 'second', text: 'text with whitespace', normalize_ws: true)
+        end
+      end
+
+      context 'Capybara.default_normalize_ws = true' do
+        it 'should support normalize_ws option' do
+          Capybara.default_normalize_ws = true
+          expect(@session).to have_selector(:id, 'second', text: 'text with whitespace')
+          expect(@session).not_to have_selector(:id, 'second', text: 'text with whitespace', normalize_ws: false)
+        end
+      end
+    end
   end
 
   context 'with exact_text' do

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

@@ -39,6 +39,20 @@ Capybara::SpecHelper.spec '#has_text?' do
     expect(@session).to have_text('text with whitespace', normalize_ws: true)
   end
 
+  context 'with enabled default collapsing whitespace' do
+    before { Capybara.default_normalize_ws = true }
+
+    it 'should search unnormalized text' do
+      @session.visit('/with_html')
+      expect(@session).to have_text('text with   whitespace', normalize_ws: false)
+    end
+
+    it 'should search whitespace collapsed text' do
+      @session.visit('/with_html')
+      expect(@session).to have_text('text with whitespace')
+    end
+  end
+
   it 'should be false if the given text is not on the page' do
     @session.visit('/with_html')
     expect(@session).not_to have_text('xxxxyzzz')

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

@@ -545,6 +545,8 @@ Capybara::SpecHelper.spec 'node' do
     context 'without automatic reload' do
       before { Capybara.automatic_reload = false }
 
+      after { Capybara.automatic_reload = true }
+
       it 'should reload the current context of the node' do
         @session.visit('/with_js')
         node = @session.find(:css, '#reload-me')
@@ -574,7 +576,6 @@ Capybara::SpecHelper.spec 'node' do
           expect(error).to be_an_invalid_element_error(@session)
         end)
       end
-      after { Capybara.automatic_reload = true }
     end
 
     context 'with automatic reload' do

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

@@ -87,6 +87,10 @@ Capybara::SpecHelper.spec '#reset_session!' do
       Capybara.reuse_server = false
     end
 
+    after do
+      Capybara.reuse_server = @reuse_server
+    end
+
     it 'raises any standard errors caught inside the server during a second session', requires: [:server] do
       Capybara.using_driver(@session.mode) do
         Capybara.using_session(:another_session) do
@@ -100,10 +104,6 @@ Capybara::SpecHelper.spec '#reset_session!' do
         end
       end
     end
-
-    after do
-      Capybara.reuse_server = @reuse_server
-    end
   end
 
   it 'raises configured errors caught inside the server', requires: [:server] do