capybara 3.12.0 → 3.13.0

data/lib/capybara/session.rb

@@ -39,7 +39,7 @@ module Capybara
     include Capybara::SessionMatchers
 
     NODE_METHODS = %i[
-      all first attach_file text check choose
+      all first attach_file text check choose scroll_to scroll_by
       click_link_or_button click_button click_link
       fill_in find find_all find_button find_by_id find_field find_link
       has_content? has_text? has_css? has_no_content? has_no_text?
@@ -134,6 +134,18 @@ module Capybara
     alias_method :cleanup!, :reset!
     alias_method :reset_session!, :reset!
 
+    ##
+    #
+    # Disconnect from the current driver.  A new driver will be instantiated on the next interaction
+    #
+    #
+    def quit
+      @driver.quit if @driver.respond_to? :quit
+      @driver = nil
+      @touched = false
+      @server&.reset_error!
+    end
+
     ##
     #
     # Raise errors encountered in the server

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

@@ -3,6 +3,7 @@ $(function() {
   $('#change').text('I changed it');
   $('#drag, #drag_scroll, #drag_link').draggable();
   $('#drop, #drop_scroll').droppable({
+    tolerance: 'touch',
     drop: function(event, ui) {
       ui.draggable.remove();
       $(this).html('Dropped!');

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

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-Capybara::SpecHelper.spec '#assert_style', requires: [:css] do
+Capybara::SpecHelper.spec '#assert_matches_style', requires: [:css] do
   it 'should not raise if the elements style contains the given properties' do
     @session.visit('/with_html')
     expect do
-      @session.find(:css, '#first').assert_style(display: 'block')
+      @session.find(:css, '#first').assert_matches_style(display: 'block')
     end.not_to raise_error
   end
 
   it "should raise error if the elements style doesn't contain the given properties" do
     @session.visit('/with_html')
     expect do
-      @session.find(:css, '#first').assert_style(display: 'inline')
+      @session.find(:css, '#first').assert_matches_style(display: 'inline')
     end.to raise_error(Capybara::ExpectationNotMet, 'Expected node to have styles {"display"=>"inline"}. Actual styles were {"display"=>"block"}')
   end
 
@@ -20,7 +20,7 @@ Capybara::SpecHelper.spec '#assert_style', requires: [:css] do
     el = @session.find(:css, '#change')
     @session.click_link('Change size')
     expect do
-      el.assert_style({ 'font-size': '50px' }, wait: 3)
+      el.assert_matches_style({ 'font-size': '50px' }, wait: 3)
     end.not_to raise_error
   end
 end

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

@@ -13,26 +13,26 @@ Capybara::SpecHelper.spec '#attach_file' do
     it 'should set a file path by id' do
       @session.attach_file 'form_image', with_os_path_separators(__FILE__)
       @session.click_button('awesome')
-      expect(extract_results(@session)['image']).to eq(File.basename(__FILE__))
+      expect(extract_results(@session)['image']).to end_with(File.basename(__FILE__))
     end
 
     it 'should set a file path by label' do
       @session.attach_file 'Image', with_os_path_separators(__FILE__)
       @session.click_button('awesome')
-      expect(extract_results(@session)['image']).to eq(File.basename(__FILE__))
+      expect(extract_results(@session)['image']).to end_with(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__))
+      expect(extract_results(@session)['image']).to end_with(File.basename(__FILE__))
     end
 
     it 'casts to string' do
       @session.attach_file :form_image, with_os_path_separators(__FILE__)
       @session.click_button('awesome')
-      expect(extract_results(@session)['image']).to eq(File.basename(__FILE__))
+      expect(extract_results(@session)['image']).to end_with(File.basename(__FILE__))
     end
   end
 
@@ -137,7 +137,7 @@ Capybara::SpecHelper.spec '#attach_file' do
     it 'should set a file path by partial label when false' do
       @session.attach_file 'Imag', with_os_path_separators(__FILE__), exact: false
       @session.click_button('awesome')
-      expect(extract_results(@session)['image']).to eq(File.basename(__FILE__))
+      expect(extract_results(@session)['image']).to end_with(File.basename(__FILE__))
     end
 
     it 'should not allow partial matches when true' do
@@ -181,7 +181,7 @@ Capybara::SpecHelper.spec '#attach_file' do
     end
   end
 
-  private
+private
 
   def with_os_path_separators(path)
     Gem.win_platform? ? path.to_s.tr('/', '\\') : path.to_s

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

@@ -5,7 +5,7 @@ Capybara::SpecHelper.spec '#click_button' do
     @session.visit('/form')
   end
 
-  it 'should wait for asynchronous load', :focus_, requires: [:js] do
+  it 'should wait for asynchronous load', requires: [:js] do
     @session.visit('/with_js')
     @session.using_wait_time(1.5) do
       @session.click_link('Click me')

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

@@ -15,6 +15,7 @@ Capybara::SpecHelper.spec '#evaluate_script', requires: [:js] do
 
   it 'should pass arguments to the script', requires: %i[js es_args] do
     @session.visit('/with_js')
+    expect(@session).to have_css('#change')
     @session.evaluate_script("document.getElementById('change').textContent = arguments[0]", 'Doodle Funk')
     expect(@session).to have_css('#change', text: 'Doodle Funk')
   end

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

@@ -14,6 +14,7 @@ Capybara::SpecHelper.spec '#execute_script', requires: [:js] do
 
   it 'should pass arguments to the script', requires: %i[js es_args] do
     @session.visit('/with_js')
+    expect(@session).to have_css('#change')
     @session.execute_script("document.getElementById('change').textContent = arguments[0]", 'Doodle Funk')
     expect(@session).to have_css('#change', text: 'Doodle Funk')
   end

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

@@ -126,7 +126,7 @@ Capybara::SpecHelper.spec '#fill_in' do
   end
 
   it 'should fill in a field based on current value' do
-    @session.fill_in(currently_with: 'John', with: 'Thomas')
+    @session.fill_in(id: /form.*name/, currently_with: 'John', with: 'Thomas')
     @session.click_button('awesome')
     expect(extract_results(@session)['first_name']).to eq('Thomas')
   end
@@ -242,4 +242,10 @@ Capybara::SpecHelper.spec '#fill_in' do
     el = @session.find(:fillable_field, 'form_first_name')
     expect(@session.fill_in('form_first_name', with: 'Harry')).to eq el
   end
+
+  it 'should warn if passed what looks like a CSS id selector' do
+    expect do
+      @session.fill_in('#form_first_name', with: 'Harry')
+    end.to raise_error(/you may be passing a CSS selector or XPath expression rather than a locator/)
+  end
 end

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

@@ -102,7 +102,7 @@ Capybara::SpecHelper.spec '#find_field' do
 
   context 'with no locator' do
     it 'should use options to find the field' do
-      expect(@session.find_field(with: 'dog')['id']).to eq 'form_pets_dog'
+      expect(@session.find_field(type: 'checkbox', with: 'dog')['id']).to eq 'form_pets_dog'
     end
   end
 

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

@@ -92,6 +92,12 @@ Capybara::SpecHelper.spec '#find' do
       expect(@session.find(:css, '#\31 escape\.me').text).to eq('needs escaping')
       expect(@session.find(:css, '.\32 escape').text).to eq('needs escaping')
     end
+
+    it 'should not warn about locator' do
+      expect { @session.find(:css, '#not_on_page') }.to raise_error Capybara::ElementNotFound do |e|
+        expect(e.message).not_to match(/you may be passing a CSS selector or XPath expression/)
+      end
+    end
   end
 
   context 'with xpath selectors' do
@@ -99,6 +105,11 @@ Capybara::SpecHelper.spec '#find' do
       expect(@session.find(:xpath, '//h1').text).to eq('This is a test')
       expect(@session.find(:xpath, "//input[@id='test_field']").value).to eq('monkey')
     end
+
+    it 'should warn if passed a non-valid locator type' do
+      expect_any_instance_of(Kernel).to receive(:warn).with(/must respond to to_xpath or be an instance of String/)
+      expect { @session.find(:xpath, 123) }.to raise_error # rubocop:disable RSpec/UnspecifiedException
+    end
   end
 
   context 'with custom selector' do

data/lib/capybara/spec/session/frame/switch_to_frame_spec.rb

@@ -53,7 +53,6 @@ Capybara::SpecHelper.spec '#switch_to_frame', requires: [:frames] do
     @session.switch_to_frame frame
     frame = @session.find(:frame, 'childFrame')
     @session.switch_to_frame frame
-
     @session.click_link 'Close Window'
     @session.switch_to_frame :parent # Go back to parentFrame
     expect(@session).to have_selector(:css, 'body#parentBody')

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

@@ -38,6 +38,32 @@ Capybara::SpecHelper.spec '#has_css?' do
     expect(@session).to have_css('li', class: /.*/)
   end
 
+  context ':style option' do
+    it 'should support String' do
+      expect(@session).to have_css('p', style: 'line-height: 25px;')
+
+      expect do
+        expect(@session).to have_css('p', style: 'display: not_valid')
+      end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /style attribute "display: not_valid"/)
+    end
+
+    it 'should support Regexp' do
+      expect(@session).to have_css('p', style: /-height: 2/)
+
+      expect do
+        expect(@session).to have_css('p', style: /not_valid/)
+      end.to raise_error(RSpec::Expectations::ExpectationNotMetError, %r{style attribute matching /not_valid/})
+    end
+
+    it 'should support Hash', requires: [:css] do
+      expect(@session).to have_css('p', style: { 'line-height': '25px' })
+
+      expect do
+        expect(@session).to have_css('p', style: { 'line-height': '30px' })
+      end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /with styles \{:"line-height"=>"30px"\}/)
+    end
+  end
+
   it 'should support case insensitive :class and :id options' do
     expect(@session).to have_css('li', class: /UiTaRI/i)
     expect(@session).to have_css('h2', id: /2ON/i)
@@ -118,6 +144,12 @@ Capybara::SpecHelper.spec '#has_css?' do
       expect(@session).to have_css('li', class: /guitar|drummer/, count: 4)
       expect(@session).to have_css('li', id: /john|paul/, class: /guitar|drummer/, count: 2)
       expect(@session).to have_css('li', class: %w[beatle guitarist], count: 2)
+      expect(@session).to have_css('p', style: 'line-height: 25px;', count: 1)
+      expect(@session).to have_css('p', style: /-height: 2/, count: 1)
+    end
+
+    it 'should be true if the content occurs the given number of times in CSS processing drivers', requires: [:css] do
+      expect(@session).to have_css('p', style: { 'line-height': '25px' }, count: 1)
     end
 
     it 'should be false if the content occurs a different number of times than the given' do

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

@@ -276,7 +276,7 @@ Capybara::SpecHelper.spec '#has_no_select?' do
   it 'should support locator-less usage' do
     expect(@session.has_no_select?(with_options: %w[Norway Sweden Finland Latvia])).to eq true
     expect(@session).to have_no_select(with_options: ['New London'])
-    expect(@session.has_no_select?(with_selected: ['Boxers'])).to eq true
-    expect(@session).to have_no_select(with_selected: %w[Commando Boxers])
+    expect(@session.has_no_select?(id: 'form_underwear', with_selected: ['Boxers'])).to eq true
+    expect(@session).to have_no_select(id: 'form_underwear', with_selected: %w[Commando Boxers])
   end
 end

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

@@ -56,6 +56,7 @@ Capybara::SpecHelper.spec '#has_selector?' do
   context 'with text' do
     it 'should discard all matches where the given string is not contained' do
       expect(@session).to have_selector('//p//a', text: 'Redirect', count: 1)
+      expect(@session).to have_selector(:css, 'p a', text: 'Redirect', count: 1)
       expect(@session).not_to have_selector('//p', text: 'Doesnotexist')
     end
 
@@ -191,5 +192,11 @@ Capybara::SpecHelper.spec '#has_no_selector?' do
       expect(@session).not_to have_no_selector('//p//a', text: /re[dab]i/i, count: 1)
       expect(@session).to have_no_selector('//p//a', text: /Red$/)
     end
+
+    it 'should error when matching element exists' do
+      expect do
+        expect(@session).to have_no_selector('//h2', text: 'Header Class Test Five')
+      end.to raise_error RSpec::Expectations::ExpectationNotMetError
+    end
   end
 end

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

@@ -226,7 +226,7 @@ Capybara::SpecHelper.spec '#has_text?' do
       Capybara.using_wait_time(0.1) do
         @session.visit('/with_js')
         @session.click_link('Click me')
-        expect(@session).to have_text('Has been clicked', wait: 2)
+        expect(@session).to have_text('Has been clicked', wait: 3)
       end
     end
   end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#matches_style?', requires: [:css] do
+  before do
+    @session.visit('/with_html')
+  end
+
+  it 'should be true if the element has the given style' do
+    expect(@session.find(:css, '#first')).to match_style(display: 'block')
+    expect(@session.find(:css, '#first').matches_style?(display: 'block')).to be true
+    expect(@session.find(:css, '#second')).to match_style('display' => 'inline')
+    expect(@session.find(:css, '#second').matches_style?('display' => 'inline')).to be true
+  end
+
+  it 'should be false if the element does not have the given style' do
+    expect(@session.find(:css, '#first').matches_style?('display' => 'inline')).to be false
+    expect(@session.find(:css, '#second').matches_style?(display: 'block')).to be false
+  end
+
+  it 'allows Regexp for value matching' do
+    expect(@session.find(:css, '#first')).to match_style(display: /^bl/)
+    expect(@session.find(:css, '#first').matches_style?('display' => /^bl/)).to be true
+    expect(@session.find(:css, '#first').matches_style?(display: /^in/)).to be false
+  end
+
+  it 'deprecated has_style?' do
+    expect_any_instance_of(Kernel).to receive(:warn).once
+    have_style(display: /^bl/)
+
+    el = @session.find(:css, '#first')
+    allow(el).to receive(:warn).and_return(nil)
+    el.has_style?('display' => /^bl/)
+    expect(el).to have_received(:warn)
+  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(1).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 specifc 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