capybara 3.8.1 → 3.33.0

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

@@ -34,6 +34,6 @@ Capybara::SpecHelper.spec '#to_capybara_node' do
     end.to raise_error(/^expected to find css "#second" within #<Capybara::Node::Element/)
     expect do
       expect(para).to have_link(href: %r{/without_simple_html})
-    end.to raise_error(%r{^expected to find visible link nil with href matching /\\/without_simple_html/ within #<Capybara::Node::Element})
+    end.to raise_error(%r{^expected to find link nil with href matching /\\/without_simple_html/ within #<Capybara::Node::Element})
   end
 end

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

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Note: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# because of the methods being tested. In tests using Capybara this type of behavior should be implemented
+# using Capybara provided assertions with builtin waiting behavior.
+
 Capybara::SpecHelper.spec '#refresh' do
   it 'reload the page' do
     @session.visit('/form')

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Capybara::SpecHelper.spec '#reset_session!' do
-  it 'removes cookies' do
+  it 'removes cookies from current domain' do
     @session.visit('/set_cookie')
     @session.visit('/get_cookie')
     expect(@session).to have_content('test_cookie')
@@ -11,6 +11,20 @@ Capybara::SpecHelper.spec '#reset_session!' do
     expect(@session.body).not_to include('test_cookie')
   end
 
+  it 'removes ALL cookies', requires: [:server] do
+    domains = ['localhost', '127.0.0.1']
+    domains.each do |domain|
+      @session.visit("http://#{domain}:#{@session.server.port}/set_cookie")
+      @session.visit("http://#{domain}:#{@session.server.port}/get_cookie")
+      expect(@session).to have_content('test_cookie')
+    end
+    @session.reset_session!
+    domains.each do |domain|
+      @session.visit("http://#{domain}:#{@session.server.port}/get_cookie")
+      expect(@session.body).not_to include('test_cookie')
+    end
+  end
+
   it 'resets current url, host, path' do
     @session.visit '/foo'
     expect(@session.current_url).not_to be_empty
@@ -82,25 +96,26 @@ Capybara::SpecHelper.spec '#reset_session!' do
   end
 
   context 'When reuse_server == false' do
+    let!(:orig_reuse_server) { Capybara.reuse_server }
+
     before do
-      @reuse_server = Capybara.reuse_server
       Capybara.reuse_server = false
     end
 
     after do
-      Capybara.reuse_server = @reuse_server
+      Capybara.reuse_server = orig_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
-          @another_session = Capybara.current_session
-          quietly { @another_session.visit('/error') }
+          another_session = Capybara.current_session
+          quietly { another_session.visit('/error') }
           expect do
-            @another_session.reset_session!
+            another_session.reset_session!
           end.to raise_error(TestApp::TestAppError)
-          @another_session.visit('/')
-          expect(@another_session.current_path).to eq('/')
+          another_session.visit('/')
+          expect(another_session.current_path).to eq('/')
         end
       end
     end

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

@@ -15,7 +15,7 @@ Capybara::SpecHelper.spec '#save_and_open_screenshot' do
     @session.save_and_open_screenshot
 
     expect(@session.driver).to have_received(:save_screenshot)
-      .with(expected_file_regex, {})
+      .with(expected_file_regex, any_args)
     expect(Launchy).to have_received(:open).with(expected_file_regex)
   end
 
@@ -27,7 +27,7 @@ Capybara::SpecHelper.spec '#save_and_open_screenshot' do
     @session.save_and_open_screenshot(custom_path)
 
     expect(@session.driver).to have_received(:save_screenshot)
-      .with(/#{custom_path}$/, {})
+      .with(/#{custom_path}$/, any_args)
     expect(Launchy).to have_received(:open).with(/#{custom_path}$/)
   end
 

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

@@ -19,7 +19,7 @@ Capybara::SpecHelper.spec '#save_screenshot', requires: [:screenshot] do
     @session.save_screenshot
 
     regexp = Regexp.new(File.join(Dir.pwd, 'capybara-\d+\.png'))
-    expect(@session.driver).to have_received(:save_screenshot).with(regexp, {})
+    expect(@session.driver).to have_received(:save_screenshot).with(regexp, any_args)
   end
 
   it 'allows to specify another path' do
@@ -28,7 +28,7 @@ Capybara::SpecHelper.spec '#save_screenshot', requires: [:screenshot] do
     custom_path = 'screenshots/1.png'
     @session.save_screenshot(custom_path)
 
-    expect(@session.driver).to have_received(:save_screenshot).with(/#{custom_path}$/, {})
+    expect(@session.driver).to have_received(:save_screenshot).with(/#{custom_path}$/, any_args)
   end
 
   context 'with Capybara.save_path' do
@@ -39,7 +39,7 @@ Capybara::SpecHelper.spec '#save_screenshot', requires: [:screenshot] do
       @session.save_screenshot
 
       regexp = Regexp.new(File.join(alternative_path, 'capybara-\d+\.png'))
-      expect(@session.driver).to have_received(:save_screenshot).with(regexp, {})
+      expect(@session.driver).to have_received(:save_screenshot).with(regexp, any_args)
     end
 
     it 'relative paths are relative to save_path' do
@@ -49,7 +49,7 @@ Capybara::SpecHelper.spec '#save_screenshot', requires: [:screenshot] do
       custom_path = 'screenshots/2.png'
       @session.save_screenshot(custom_path)
 
-      expect(@session.driver).to have_received(:save_screenshot).with(File.expand_path(custom_path, alternative_path), {})
+      expect(@session.driver).to have_received(:save_screenshot).with(File.expand_path(custom_path, alternative_path), any_args)
     end
   end
 end

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#scroll_to', requires: [:scroll] do
+  before do
+    @session.visit('/scroll')
+  end
+
+  it 'can scroll an element to the top of the viewport' do
+    el = @session.find(:css, '#scroll')
+    @session.scroll_to(el, align: :top)
+    expect(el.evaluate_script('this.getBoundingClientRect().top')).to be_within(1).of(0)
+  end
+
+  it 'can scroll an element to the bottom of the viewport' do
+    el = @session.find(:css, '#scroll')
+    @session.scroll_to(el, align: :bottom)
+    el_bottom = el.evaluate_script('this.getBoundingClientRect().bottom')
+    viewport_bottom = el.evaluate_script('document.body.clientHeight')
+    expect(el_bottom).to be_within(1).of(viewport_bottom)
+  end
+
+  it 'can scroll an element to the center of the viewport' do
+    el = @session.find(:css, '#scroll')
+    @session.scroll_to(el, align: :center)
+    el_center = el.evaluate_script('(function(rect){return (rect.top + rect.bottom)/2})(this.getBoundingClientRect())')
+    viewport_bottom = el.evaluate_script('document.body.clientHeight')
+    expect(el_center).to be_within(2).of(viewport_bottom / 2)
+  end
+
+  it 'can scroll the window to the vertical top' do
+    @session.scroll_to :bottom
+    @session.scroll_to :top
+    expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [0, 0]
+  end
+
+  it 'can scroll the window to the vertical bottom' do
+    @session.scroll_to :bottom
+    max_scroll = @session.evaluate_script('document.body.scrollHeight - document.body.clientHeight')
+    expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [0, max_scroll]
+  end
+
+  it 'can scroll the window to the vertical center' do
+    @session.scroll_to :center
+    max_scroll = @session.evaluate_script('document.documentElement.scrollHeight - document.body.clientHeight')
+    expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [0, max_scroll / 2]
+  end
+
+  it 'can scroll the window to specific location' do
+    @session.scroll_to 100, 100
+    expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [100, 100]
+  end
+
+  it 'can scroll an element to the top of the scrolling element' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    el = scrolling_element.find(:css, '#inner')
+    scrolling_element.scroll_to(el, align: :top)
+    scrolling_element_top = scrolling_element.evaluate_script('this.getBoundingClientRect().top')
+    expect(el.evaluate_script('this.getBoundingClientRect().top')).to be_within(3).of(scrolling_element_top)
+  end
+
+  it 'can scroll an element to the bottom of the scrolling element' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    el = scrolling_element.find(:css, '#inner')
+    scrolling_element.scroll_to(el, align: :bottom)
+    el_bottom = el.evaluate_script('this.getBoundingClientRect().bottom')
+    scroller_bottom = scrolling_element.evaluate_script('this.getBoundingClientRect().top + this.clientHeight')
+    expect(el_bottom).to be_within(1).of(scroller_bottom)
+  end
+
+  it 'can scroll an element to the center of the scrolling element' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    el = scrolling_element.find(:css, '#inner')
+    scrolling_element.scroll_to(el, align: :center)
+    el_center = el.evaluate_script('(function(rect){return (rect.top + rect.bottom)/2})(this.getBoundingClientRect())')
+    scrollable_center = scrolling_element.evaluate_script('(this.clientHeight / 2) + this.getBoundingClientRect().top')
+    expect(el_center).to be_within(1).of(scrollable_center)
+  end
+
+  it 'can scroll the scrolling element to the top' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    scrolling_element.scroll_to :bottom
+    scrolling_element.scroll_to :top
+    expect(scrolling_element.evaluate_script('[this.scrollLeft, this.scrollTop]')).to eq [0, 0]
+  end
+
+  it 'can scroll the scrolling element to the bottom' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    scrolling_element.scroll_to :bottom
+    max_scroll = scrolling_element.evaluate_script('this.scrollHeight - this.clientHeight')
+    expect(scrolling_element.evaluate_script('[this.scrollLeft, this.scrollTop]')).to eq [0, max_scroll]
+  end
+
+  it 'can scroll the scrolling element to the vertical center' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    scrolling_element.scroll_to :center
+    max_scroll = scrolling_element.evaluate_script('this.scrollHeight - this.clientHeight')
+    expect(scrolling_element.evaluate_script('[this.scrollLeft, this.scrollTop]')).to eq [0, max_scroll / 2]
+  end
+
+  it 'can scroll the scrolling element to specific location' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    scrolling_element.scroll_to 100, 100
+    expect(scrolling_element.evaluate_script('[this.scrollLeft, this.scrollTop]')).to eq [100, 100]
+  end
+
+  it 'can scroll the window by a specific amount' do
+    @session.scroll_to(:current, offset: [50, 75])
+    expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [50, 75]
+  end
+
+  it 'can scroll the scroll the scrolling element by a specific amount' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    scrolling_element.scroll_to 100, 100
+    scrolling_element.scroll_to(:current, offset: [-50, 50])
+    expect(scrolling_element.evaluate_script('[this.scrollLeft, this.scrollTop]')).to eq [50, 150]
+  end
+end

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

@@ -42,13 +42,13 @@ Capybara::SpecHelper.spec '#select' do
   end
 
   it 'should select an option from a select box by id' do
-    @session.select('Finish', from: 'form_locale')
+    @session.select('Finnish', from: 'form_locale')
     @session.click_button('awesome')
     expect(extract_results(@session)['locale']).to eq('fi')
   end
 
   it 'should select an option from a select box by label' do
-    @session.select('Finish', from: 'Locale')
+    @session.select('Finnish', from: 'Locale')
     @session.click_button('awesome')
     expect(extract_results(@session)['locale']).to eq('fi')
   end
@@ -141,11 +141,6 @@ Capybara::SpecHelper.spec '#select' do
       @session.select('Other', from: 'form_title')
       expect(@session.find_field('form_title').value).not_to eq 'Other'
     end
-
-    it 'should warn' do
-      expect_any_instance_of(Capybara::Node::Element).to receive(:warn).once
-      @session.select('Other', from: 'form_title')
-    end
   end
 
   context 'with multiple select' do
@@ -188,7 +183,7 @@ Capybara::SpecHelper.spec '#select' do
   context 'with :exact option' do
     context 'when `false`' do
       it 'can match select box approximately' do
-        @session.select('Finish', from: 'Loc', exact: false)
+        @session.select('Finnish', from: 'Loc', exact: false)
         @session.click_button('awesome')
         expect(extract_results(@session)['locale']).to eq('fi')
       end
@@ -209,13 +204,13 @@ Capybara::SpecHelper.spec '#select' do
     context 'when `true`' do
       it 'can match select box approximately' do
         expect do
-          @session.select('Finish', from: 'Loc', exact:  true)
+          @session.select('Finnish', from: 'Loc', exact: true)
         end.to raise_error(Capybara::ElementNotFound)
       end
 
       it 'can match option approximately' do
         expect do
-          @session.select('Fin', from: 'Locale', exact:  true)
+          @session.select('Fin', from: 'Locale', exact: true)
         end.to raise_error(Capybara::ElementNotFound)
       end
 
@@ -226,4 +221,9 @@ Capybara::SpecHelper.spec '#select' do
       end
     end
   end
+
+  it 'should error when not passed a locator for :from option' do
+    select = @session.find(:select, 'Title')
+    expect { @session.select('Mr', from: select) }.to raise_error(ArgumentError, /does not take an element/)
+  end
 end

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

@@ -14,15 +14,28 @@ Capybara::SpecHelper.spec Capybara::Selector do
       expect(@session.find(:label, for: 'form_other_title')['for']).to eq 'form_other_title'
     end
 
+    it 'finds a label for for attribute regex' do
+      expect(@session.find(:label, for: /_other_title/)['for']).to eq 'form_other_title'
+    end
+
     it 'finds a label from nested input using :for filter with id string' do
       expect(@session.find(:label, for: 'nested_label').text).to eq 'Nested Label'
     end
 
+    it 'finds a label from nested input using :for filter with id regexp' do
+      expect(@session.find(:label, for: /nested_lab/).text).to eq 'Nested Label'
+    end
+
     it 'finds a label from nested input using :for filter with element' do
       input = @session.find(:id, 'nested_label')
       expect(@session.find(:label, for: input).text).to eq 'Nested Label'
     end
 
+    it 'finds a label from nested input using :for filter with element when no id on label' do
+      input = @session.find(:css, '#wrapper_label').find(:css, 'input')
+      expect(@session.find(:label, for: input).text).to eq 'Wrapper Label'
+    end
+
     it 'finds the label for an non-nested element when using :for filter' do
       select = @session.find(:id, 'form_other_title')
       expect(@session.find(:label, for: select)['for']).to eq 'form_other_title'
@@ -40,18 +53,36 @@ Capybara::SpecHelper.spec Capybara::Selector do
   end
 
   describe 'field selectors' do
-    it 'can find specifically by id' do
-      expect(@session.find(:field, id: 'customer_email').value).to eq 'ben@ben.com'
+    context 'with :id option' do
+      it 'can find specifically by id' do
+        expect(@session.find(:field, id: 'customer_email').value).to eq 'ben@ben.com'
+      end
+
+      it 'can find by regex' do
+        expect(@session.find(:field, id: /ustomer.emai/).value).to eq 'ben@ben.com'
+      end
+
+      it 'can find by case-insensitive id' do
+        expect(@session.find(:field, id: /StOmer.emAI/i).value).to eq 'ben@ben.com'
+      end
     end
 
-    it 'can find specifically by name' do
+    it 'can find specifically by name string' do
       expect(@session.find(:field, name: 'form[other_title]')['id']).to eq 'form_other_title'
     end
 
-    it 'can find specifically by placeholder' do
+    it 'can find specifically by name regex' do
+      expect(@session.find(:field, name: /form\[other_.*\]/)['id']).to eq 'form_other_title'
+    end
+
+    it 'can find specifically by placeholder string' do
       expect(@session.find(:field, placeholder: 'FirstName')['id']).to eq 'form_first_name'
     end
 
+    it 'can find specifically by placeholder regex' do
+      expect(@session.find(:field, placeholder: /FirstN.*/)['id']).to eq 'form_first_name'
+    end
+
     it 'can find by type' do
       expect(@session.find(:field, 'Confusion', type: 'checkbox')['id']).to eq 'confusion_checkbox'
       expect(@session.find(:field, 'Confusion', type: 'text')['id']).to eq 'confusion_text'
@@ -61,7 +92,7 @@ Capybara::SpecHelper.spec Capybara::Selector do
     it 'can find by class' do
       expect(@session.find(:field, class: 'confusion-checkbox')['id']).to eq 'confusion_checkbox'
       expect(@session).to have_selector(:field, class: 'confusion', count: 3)
-      expect(@session.find(:field, class: ['confusion', 'confusion-textarea'])['id']).to eq 'confusion_textarea'
+      expect(@session.find(:field, class: %w[confusion confusion-textarea])['id']).to eq 'confusion_textarea'
     end
   end
 end

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

@@ -85,11 +85,11 @@ Capybara::SpecHelper.spec '#uncheck' do
       end
 
       it 'should raise original error when no label available' do
-        expect { @session.uncheck('form_cars_porsche') }.to raise_error(Capybara::ElementNotFound, 'Unable to find visible checkbox "form_cars_porsche"')
+        expect { @session.uncheck('form_cars_porsche') }.to raise_error(Capybara::ElementNotFound, /Unable to find visible checkbox "form_cars_porsche"/)
       end
 
       it 'should raise error if not allowed to click label' do
-        expect { @session.uncheck('form_cars_jaguar', allow_label_click: false) }.to raise_error(Capybara::ElementNotFound, 'Unable to find visible checkbox "form_cars_jaguar"')
+        expect { @session.uncheck('form_cars_jaguar', allow_label_click: false) }.to raise_error(Capybara::ElementNotFound, /Unable to find visible checkbox "form_cars_jaguar"/)
       end
 
       it 'should include node filter description in error if necessary' do

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

@@ -56,7 +56,7 @@ Capybara::SpecHelper.spec '#unselect' 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 select box "does not exist"/
       expect do
         @session.unselect('foo', from: 'does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)

data/lib/capybara/spec/session/window/become_closed_spec.rb

@@ -1,38 +1,41 @@
 # frozen_string_literal: true
 
 Capybara::SpecHelper.spec '#become_closed', requires: %i[windows js] do
-  before do
-    @window = @session.current_window
-    @session.visit('/with_windows')
-    @other_window = @session.window_opened_by do
+  let!(:window) { @session.current_window }
+  let(:other_window) do
+    @session.window_opened_by do
       @session.find(:css, '#openWindow').click
     end
   end
 
+  before do
+    @session.visit('/with_windows')
+  end
+
   after do
     @session.document.synchronize(5, errors: [Capybara::CapybaraError]) do
       raise Capybara::CapybaraError if @session.windows.size != 1
     end
-    @session.switch_to_window(@window)
+    @session.switch_to_window(window)
   end
 
   context 'with :wait option' do
     it 'should wait if value of :wait is more than timeout' do
-      @session.within_window @other_window do
+      @session.within_window other_window do
         @session.execute_script('setTimeout(function(){ window.close(); }, 500);')
       end
       Capybara.using_wait_time 0.1 do
-        expect(@other_window).to become_closed(wait: 5)
+        expect(other_window).to become_closed(wait: 5)
       end
     end
 
     it 'should raise error if value of :wait is less than timeout' do
-      @session.within_window @other_window do
+      @session.within_window other_window do
         @session.execute_script('setTimeout(function(){ window.close(); }, 1000);')
       end
       Capybara.using_wait_time 2 do
         expect do
-          expect(@other_window).to become_closed(wait: 0.2)
+          expect(other_window).to become_closed(wait: 0.2)
         end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /\Aexpected #<Window @handle=".+"> to become closed after 0.2 seconds\Z/)
       end
     end
@@ -40,21 +43,21 @@ Capybara::SpecHelper.spec '#become_closed', requires: %i[windows js] do
 
   context 'without :wait option' do
     it 'should wait if value of default_max_wait_time is more than timeout' do
-      @session.within_window @other_window do
+      @session.within_window other_window do
         @session.execute_script('setTimeout(function(){ window.close(); }, 500);')
       end
       Capybara.using_wait_time 5 do
-        expect(@other_window).to become_closed
+        expect(other_window).to become_closed
       end
     end
 
     it 'should raise error if value of default_max_wait_time is less than timeout' do
-      @session.within_window @other_window do
+      @session.within_window other_window do
         @session.execute_script('setTimeout(function(){ window.close(); }, 900);')
       end
       Capybara.using_wait_time 0.4 do
         expect do
-          expect(@other_window).to become_closed
+          expect(other_window).to become_closed
         end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /\Aexpected #<Window @handle=".+"> to become closed after 0.4 seconds\Z/)
       end
     end
@@ -62,23 +65,23 @@ Capybara::SpecHelper.spec '#become_closed', requires: %i[windows js] do
 
   context 'with not_to' do
     it "should not raise error if window doesn't close before default_max_wait_time" do
-      @session.within_window @other_window do
+      @session.within_window other_window do
         @session.execute_script('setTimeout(function(){ window.close(); }, 1000);')
       end
       Capybara.using_wait_time 0.3 do
         expect do
-          expect(@other_window).not_to become_closed
+          expect(other_window).not_to become_closed
         end.not_to raise_error
       end
     end
 
     it 'should raise error if window closes before default_max_wait_time' do
-      @session.within_window @other_window do
+      @session.within_window other_window do
         @session.execute_script('setTimeout(function(){ window.close(); }, 700);')
       end
       Capybara.using_wait_time 3.1 do
         expect do
-          expect(@other_window).not_to become_closed
+          expect(other_window).not_to become_closed
         end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /\Aexpected #<Window @handle=".+"> not to become closed after 3.1 seconds\Z/)
       end
     end

data/lib/capybara/spec/session/window/switch_to_window_spec.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Note: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# because of the methods being tested. In tests using Capybara this type of behavior should be implemented
+# using Capybara provided assertions with builtin waiting behavior.
+
 Capybara::SpecHelper.spec '#switch_to_window', requires: [:windows] do
   before do
     @window = @session.current_window

data/lib/capybara/spec/session/window/window_opened_by_spec.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Note: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# because of the methods being tested. In tests using Capybara this type of behavior should be implemented
+# using Capybara provided assertions with builtin waiting behavior.
+
 Capybara::SpecHelper.spec '#window_opened_by', requires: [:windows] do
   before do
     @window = @session.current_window