capybara 2.14.4 → 2.15.0

data/lib/capybara/session.rb

@@ -58,7 +58,7 @@ module Capybara
     ]
     SESSION_METHODS = [
       :body, :html, :source, :current_url, :current_host, :current_path,
-      :execute_script, :evaluate_script, :visit, :go_back, :go_forward,
+      :execute_script, :evaluate_script, :visit, :refresh, :go_back, :go_forward,
       :within, :within_element, :within_fieldset, :within_table, :within_frame, :switch_to_frame,
       :current_window, :windows, :open_new_window, :switch_to_window, :within_window, :window_opened_by,
       :save_page, :save_and_open_page, :save_screenshot,
@@ -269,6 +269,15 @@ module Capybara
       driver.visit(visit_uri.to_s)
     end
 
+    ##
+    #
+    # Refresh the page
+    #
+    def refresh
+      raise_server_error!
+      driver.refresh
+    end
+
     ##
     #
     # Move back a single entry in the browser's history.
@@ -472,14 +481,14 @@ module Capybara
     #   @raise [Capybara::WindowError]     if no window matches given block
     # @overload switch_to_window(window)
     #   @param window [Capybara::Window]   window that should be switched to
-    #   @raise [Capybara::Driver::Base#no_such_window_error] if unexistent (e.g. closed) window was passed
+    #   @raise [Capybara::Driver::Base#no_such_window_error] if non-existent (e.g. closed) window was passed
     #
     # @return [Capybara::Window]         window that has been switched to
-    # @raise [Capybara::ScopeError]        if this method is invoked inside `within`,
-    #   `within_frame` or `within_window` methods
+    # @raise [Capybara::ScopeError]        if this method is invoked inside `within` or
+    #   `within_frame` methods
     # @raise [ArgumentError]               if both or neither arguments were provided
     #
-    def switch_to_window(window = nil, options= {})
+    def switch_to_window(window = nil, options= {}, &window_locator)
       options, window = window, nil if window.is_a? Hash
 
       block_given = block_given?
@@ -487,34 +496,12 @@ module Capybara
         raise ArgumentError, "`switch_to_window` can take either a block or a window, not both"
       elsif !window && !block_given
         raise ArgumentError, "`switch_to_window`: either window or block should be provided"
-      elsif scopes.size > 1
+      elsif !scopes.last.nil?
         raise Capybara::ScopeError, "`switch_to_window` is not supposed to be invoked from "\
-                                    "`within`'s, `within_frame`'s' or `within_window`'s' block."
+                                    "`within` or `within_frame` blocks."
       end
 
-      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
-          original_window_handle = driver.current_window_handle
-          begin
-            driver.window_handles.each do |handle|
-              driver.switch_to_window handle
-              if yield
-                return Window.new(self, handle)
-              end
-            end
-          rescue => e
-            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"
-          end
-        end
-      end
+      _switch_to_window(window, options, &window_locator)
     end
 
     ##
@@ -538,30 +525,35 @@ module Capybara
     #   @deprecated                            Pass window or lambda instead
     #   @param [String]                        handle, name, url or title of the window
     #
-    # @raise [Capybara::ScopeError]        if this method is invoked inside `within`,
-    #   `within_frame` or `within_window` methods
+    # @raise [Capybara::ScopeError]        if this method is invoked inside `within_frame` method
     # @return                              value returned by the block
     #
     def within_window(window_or_handle)
       if window_or_handle.instance_of?(Capybara::Window)
         original = current_window
-        switch_to_window(window_or_handle) unless original == window_or_handle
         scopes << nil
         begin
-          yield
+          _switch_to_window(window_or_handle) unless original == window_or_handle
+          begin
+            yield
+          ensure
+            _switch_to_window(original) unless original == window_or_handle
+          end
         ensure
-          @scopes.pop
-          switch_to_window(original) unless original == window_or_handle
+          scopes.pop
         end
       elsif window_or_handle.is_a?(Proc)
         original = current_window
-        switch_to_window { window_or_handle.call }
         scopes << nil
         begin
-          yield
+          _switch_to_window { window_or_handle.call }
+          begin
+            yield
+          ensure
+            _switch_to_window(original)
+          end
         ensure
-          @scopes.pop
-          switch_to_window(original)
+          scopes.pop
         end
       else
         offending_line = caller.first
@@ -572,7 +564,7 @@ module Capybara
           scopes << nil
           driver.within_window(window_or_handle) { yield }
         ensure
-          @scopes.pop
+          scopes.pop
         end
       end
     end
@@ -919,5 +911,37 @@ module Capybara
         end
       end
     end
+
+    def _switch_to_window(window = nil, options= {})
+      options, window = window, nil if window.is_a? Hash
+
+      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?
+
+      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
+          original_window_handle = driver.current_window_handle
+          begin
+            driver.window_handles.each do |handle|
+              driver.switch_to_window handle
+              if yield
+                return Window.new(self, handle)
+              end
+            end
+          rescue => e
+            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"
+          end
+        end
+      end
+    end
+
   end
 end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+Capybara::SpecHelper.spec '#ancestor' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  after do
+    Capybara::Selector.remove(:monkey)
+  end
+
+  it "should find the ancestor element using the given locator" do
+    el = @session.find(:css, '#first_image')
+    expect(el.ancestor('//p')).to have_text('Lorem ipsum dolor')
+    expect(el.ancestor("//a")[:'aria-label']).to eq('Go to simple')
+  end
+
+  it "should find the ancestor element using the given locator and options" do
+    el = @session.find(:css, '#child')
+    expect(el.ancestor('//div', text: 'Ancestor Ancestor Ancestor')[:id]).to eq('ancestor3')
+  end
+
+  it "should raise an error if there are multiple matches" do
+    el = @session.find(:css, '#child')
+    expect { el.ancestor('//div') }.to raise_error(Capybara::Ambiguous)
+    expect { el.ancestor('//div', text: 'Ancestor') }.to raise_error(Capybara::Ambiguous)
+  end
+
+  context "with css selectors" do
+    it "should find the first element using the given locator" do
+      el = @session.find(:css, '#first_image')
+      expect(el.ancestor(:css, 'p')).to have_text('Lorem ipsum dolor')
+      expect(el.ancestor(:css, 'a')[:'aria-label']).to eq('Go to simple')
+    end
+
+    it "should support pseudo selectors" do
+      el = @session.find(:css, '#button_img')
+      expect(el.ancestor(:css, 'button:disabled')[:id]).to eq('ancestor_button')
+    end
+  end
+
+  context "with xpath selectors" do
+    it "should find the first element using the given locator" do
+      el = @session.find(:css, '#first_image')
+      expect(el.ancestor(:xpath, '//p')).to have_text('Lorem ipsum dolor')
+      expect(el.ancestor(:xpath, "//a")[:'aria-label']).to eq('Go to simple')
+    end
+  end
+
+  context "with custom selector" do
+    it "should use the custom selector" do
+      Capybara.add_selector(:level) do
+        xpath { |num| ".//*[@id='ancestor#{num}']" }
+      end
+      el = @session.find(:css, '#child')
+      expect(el.ancestor(:level, 1).text).to eq('Ancestor Child')
+      expect(el.ancestor(:level, 3).text).to eq('Ancestor Ancestor Ancestor Child')
+    end
+  end
+
+
+  it "should raise ElementNotFound with a useful default message if nothing was found" do
+    el = @session.find(:css, '#child')
+    expect do
+      el.ancestor(:xpath, '//div[@id="nosuchthing"]')
+    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')
+      end
+    end
+  end
+
+  it "should raise if selector type is unknown" do
+    el = @session.find(:css, '#child')
+    expect do
+      el.ancestor(:unknown, '//h1')
+    end.to raise_error(ArgumentError)
+  end
+end

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

@@ -81,7 +81,7 @@ Capybara::SpecHelper.spec "#attach_file" do
 
   context "with a locator that doesn't exist" do
     it "should raise an error" do
-      msg = "Unable to find file field \"does not exist\""
+      msg = "Unable to find visible file field \"does not exist\" that is not disabled"
       expect do
         @session.attach_file('does not exist', @test_file_path)
       end.to raise_error(Capybara::ElementNotFound, msg)

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

@@ -69,7 +69,7 @@ Capybara::SpecHelper.spec "#check" do
 
   context "with a locator that doesn't exist" do
     it "should raise an error" do
-      msg = "Unable to find checkbox \"does not exist\""
+      msg = "Unable to find visible checkbox \"does not exist\" that is not disabled"
       expect do
         @session.check('does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)
@@ -142,11 +142,11 @@ Capybara::SpecHelper.spec "#check" do
       end
 
       it "should raise original error when no label available" do
-        expect { @session.check('form_cars_ariel') }.to raise_error(Capybara::ElementNotFound, 'Unable to find checkbox "form_cars_ariel"')
+        expect { @session.check('form_cars_ariel') }.to raise_error(Capybara::ElementNotFound, 'Unable to find visible checkbox "form_cars_ariel" that is not disabled')
       end
 
       it "should raise error if not allowed to click label" do
-        expect{@session.check('form_cars_mclaren', allow_label_click: false)}.to raise_error(Capybara::ElementNotFound, 'Unable to find checkbox "form_cars_mclaren"')
+        expect{@session.check('form_cars_mclaren', allow_label_click: false)}.to raise_error(Capybara::ElementNotFound, 'Unable to find visible checkbox "form_cars_mclaren" that is not disabled')
       end
     end
 
@@ -158,7 +158,7 @@ Capybara::SpecHelper.spec "#check" do
       end
 
       it "should raise error if checkbox not visible" do
-        expect{@session.check('form_cars_mclaren')}.to raise_error(Capybara::ElementNotFound, 'Unable to find checkbox "form_cars_mclaren"')
+        expect{@session.check('form_cars_mclaren')}.to raise_error(Capybara::ElementNotFound, 'Unable to find visible checkbox "form_cars_mclaren" that is not disabled')
       end
 
       context "with allow_label_click == true" do

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

@@ -24,7 +24,7 @@ Capybara::SpecHelper.spec "#choose" do
 
   context "with a locator that doesn't exist" do
     it "should raise an error" do
-      msg = "Unable to find radio button \"does not exist\""
+      msg = "Unable to find visible radio button \"does not exist\" that is not disabled"
       expect do
         @session.choose('does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)
@@ -82,7 +82,7 @@ Capybara::SpecHelper.spec "#choose" do
       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 radio button "party_democrat"')
+        expect{@session.choose("party_democrat", allow_label_click: false)}.to raise_error(Capybara::ElementNotFound, 'Unable to find visible radio button "party_democrat" that is not disabled')
       end
     end
   end

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

@@ -353,7 +353,7 @@ Capybara::SpecHelper.spec '#click_button' do
 
   context "with a locator that doesn't exist" do
     it "should raise an error" do
-      msg = "Unable to find button \"does not exist\""
+      msg = "Unable to find visible button \"does not exist\""
       expect do
         @session.click_button('does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)

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

@@ -54,7 +54,7 @@ Capybara::SpecHelper.spec '#click_link_or_button' do
     context "when `false`" do
       it "does not click on link which matches approximately" do
         @session.visit('/with_html')
-        msg = "Unable to find link or button \"abore\""
+        msg = "Unable to find visible link or button \"abore\""
         expect do
           @session.click_link_or_button('abore', exact:  true)
         end.to raise_error(Capybara::ElementNotFound, msg)
@@ -62,7 +62,7 @@ Capybara::SpecHelper.spec '#click_link_or_button' do
 
       it "does not click on approximately matching button" do
         @session.visit('/form')
-        msg = "Unable to find link or button \"awe\""
+        msg = "Unable to find visible link or button \"awe\""
 
         expect do
           @session.click_link_or_button('awe', exact:  true)
@@ -74,7 +74,7 @@ Capybara::SpecHelper.spec '#click_link_or_button' do
   context "with a locator that doesn't exist" do
     it "should raise an error" do
       @session.visit('/with_html')
-      msg = "Unable to find link or button \"does not exist\""
+      msg = "Unable to find visible link or button \"does not exist\""
       expect do
         @session.click_link_or_button('does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)

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

@@ -67,7 +67,7 @@ Capybara::SpecHelper.spec '#click_link' do
 
   context "with a locator that doesn't exist" do
     it "should raise an error" do
-      msg = "Unable to find link \"does not exist\""
+      msg = "Unable to find visible link \"does not exist\""
       expect do
         @session.click_link('does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)

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

@@ -156,7 +156,7 @@ Capybara::SpecHelper.spec "#fill_in" do
     before { Capybara.ignore_hidden_elements = true }
     after  { Capybara.ignore_hidden_elements = false }
     it "should not find a hidden field" do
-      msg = "Unable to find field \"Super Secret\""
+      msg = "Unable to find visible field \"Super Secret\" that is not disabled"
       expect do
         @session.fill_in('Super Secret', with: '777')
       end.to raise_error(Capybara::ElementNotFound, msg)
@@ -165,7 +165,7 @@ Capybara::SpecHelper.spec "#fill_in" do
 
   context "with a locator that doesn't exist" do
     it "should raise an error" do
-      msg = "Unable to find field \"does not exist\""
+      msg = "Unable to find visible field \"does not exist\" that is not disabled"
       expect do
         @session.fill_in('does not exist', with: 'Blah blah')
       end.to raise_error(Capybara::ElementNotFound, msg)

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

@@ -205,7 +205,7 @@ Capybara::SpecHelper.spec '#find' do
   it "should raise ElementNotFound with a useful default message if nothing was found" do
     expect do
       @session.find(:xpath, '//div[@id="nosuchthing"]').to be_nil
-    end.to raise_error(Capybara::ElementNotFound, "Unable to find xpath \"//div[@id=\\\"nosuchthing\\\"]\"")
+    end.to raise_error(Capybara::ElementNotFound, "Unable to find visible xpath \"//div[@id=\\\"nosuchthing\\\"]\"")
   end
 
   it "should accept an XPath instance" do

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+Capybara::SpecHelper.spec '#refresh' do
+  it "reload the page" do
+    @session.visit('/form')
+    expect(@session).to have_select('form_locale', selected: 'English')
+    @session.select('Swedish', from: 'form_locale')
+    expect(@session).to have_select('form_locale', selected: 'Swedish')
+    @session.refresh
+    expect(@session).to have_select('form_locale', selected: 'English')
+  end
+
+  it "raises any errors caught inside the server", requires: [:server] do
+    quietly { @session.visit("/error") }
+    expect do
+      @session.refresh
+    end.to raise_error(TestApp::TestAppError)
+  end
+
+  it "it reposts" do
+    @session.visit('/form')
+    @session.select('Sweden', from: 'form_region')
+    @session.click_button('awesome')
+    expect {
+      @session.refresh
+      sleep 2
+    }.to change{ extract_results(@session)['post_count'] }.by(1)
+  end
+end

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

@@ -85,7 +85,7 @@ Capybara::SpecHelper.spec "#select" do
 
   context "with a locator that doesn't exist" do
     it "should raise an error" do
-      msg = "Unable to find select box \"does not exist\""
+      msg = "Unable to find visible select box \"does not exist\" that is not disabled"
       expect do
         @session.select('foo', from: 'does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)
@@ -94,7 +94,7 @@ Capybara::SpecHelper.spec "#select" do
 
   context "with an option that doesn't exist" do
     it "should raise an error" do
-      msg = "Unable to find option \"Does not Exist\""
+      msg = "Unable to find visible option \"Does not Exist\""
       expect do
         @session.select('Does not Exist', from: 'form_locale')
       end.to raise_error(Capybara::ElementNotFound, msg)

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+Capybara::SpecHelper.spec '#sibling' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  after do
+    Capybara::Selector.remove(:monkey)
+  end
+
+  it "should find a prior sibling element using the given locator" do
+    el = @session.find(:css, '#mid_sibling')
+    expect(el.sibling('//div[@data-pre]')[:id]).to eq('pre_sibling')
+  end
+
+  it "should find a following sibling element using the given locator" do
+    el = @session.find(:css, '#mid_sibling')
+    expect(el.sibling('//div[@data-post]')[:id]).to eq('post_sibling')
+  end
+
+  it "should raise an error if there are multiple matches" do
+    el = @session.find(:css, '#mid_sibling')
+    expect { el.sibling('//div') }.to raise_error(Capybara::Ambiguous)
+  end
+
+  context "with css selectors" do
+    it "should find the first element using the given locator" do
+      el = @session.find(:css, '#mid_sibling')
+      expect(el.sibling(:css, '#pre_sibling')).to have_text('Pre Sibling')
+      expect(el.sibling(:css, '#post_sibling')).to have_text('Post Sibling')
+    end
+  end
+
+  context "with custom selector" do
+    it "should use the custom selector" do
+      Capybara.add_selector(:data_attribute) do
+        xpath { |attr| ".//*[@data-#{attr}]" }
+      end
+      el = @session.find(:css, '#mid_sibling')
+      expect(el.sibling(:data_attribute, 'pre').text).to eq('Pre Sibling')
+      expect(el.sibling(:data_attribute, 'post').text).to eq('Post Sibling')
+    end
+  end
+
+
+  it "should raise ElementNotFound with a useful default message if nothing was found" do
+    el = @session.find(:css, '#child')
+    expect do
+      el.sibling(:xpath, '//div[@id="nosuchthing"]')
+    end.to raise_error(Capybara::ElementNotFound, "Unable to find xpath \"//div[@id=\\\"nosuchthing\\\"]\" that is a sibling of visible css \"#child\"")
+  end
+end