capybara 3.30.0 → 3.35.3

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

@@ -60,6 +60,22 @@ Capybara::SpecHelper.spec '#has_field' do
     end
   end
 
+  context 'with validation message', requires: [:html_validation] do
+    it 'should accept a regexp' do
+      @session.fill_in('form_zipcode', with: '1234')
+      expect(@session).to have_field('form_zipcode', validation_message: /match the requested format/)
+      expect(@session).not_to have_field('form_zipcode', validation_message: /random/)
+    end
+
+    it 'should accept a string' do
+      @session.fill_in('form_zipcode', with: '1234')
+      expect(@session).to have_field('form_zipcode', validation_message: 'Please match the requested format.')
+      expect(@session).not_to have_field('form_zipcode', validation_message: 'match the requested format.')
+      @session.fill_in('form_zipcode', with: '12345')
+      expect(@session).to have_field('form_zipcode', validation_message: '')
+    end
+  end
+
   context 'with type' do
     it 'should be true if a field with the given type is on the page' do
       expect(@session).to have_field('First Name', type: 'text')

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

@@ -63,7 +63,7 @@ Capybara::SpecHelper.spec '#has_select?' do
     end
 
     it "should be true even when the selected option invisible, regardless of the select's visibility" do
-      expect(@session).to have_select('Icecream', visible: false, selected: 'Chocolate')
+      expect(@session).to have_select('Icecream', visible: :hidden, selected: 'Chocolate')
       expect(@session).to have_select('Sorbet', selected: 'Vanilla')
     end
   end
@@ -88,7 +88,7 @@ Capybara::SpecHelper.spec '#has_select?' do
     end
 
     it "should be true even when the selected values are invisible, regardless of the select's visibility" do
-      expect(@session).to have_select('Dessert', visible: false, with_options: %w[Pudding Tiramisu])
+      expect(@session).to have_select('Dessert', visible: :hidden, with_options: %w[Pudding Tiramisu])
       expect(@session).to have_select('Cake', with_selected: ['Chocolate Cake', 'Sponge Cake'])
     end
 
@@ -113,7 +113,35 @@ Capybara::SpecHelper.spec '#has_select?' do
     end
 
     it 'should be true even when the options are invisible, if the select itself is invisible' do
-      expect(@session).to have_select('Icecream', visible: false, options: %w[Chocolate Vanilla Strawberry])
+      expect(@session).to have_select('Icecream', visible: :hidden, options: %w[Chocolate Vanilla Strawberry])
+    end
+  end
+
+  context 'with enabled options' do
+    it 'should be true if the listed options exist and are enabled' do
+      expect(@session).to have_select('form_title', enabled_options: %w[Mr Mrs Miss])
+    end
+
+    it 'should be false if the listed options do not exist' do
+      expect(@session).not_to have_select('form_title', enabled_options: ['Not there'])
+    end
+
+    it 'should be false if the listed option exists but is not enabled' do
+      expect(@session).not_to have_select('form_title', enabled_options: %w[Mr Mrs Miss Other])
+    end
+  end
+
+  context 'with disabled options' do
+    it 'should be true if the listed options exist and are disabled' do
+      expect(@session).to have_select('form_title', disabled_options: ['Other'])
+    end
+
+    it 'should be false if the listed options do not exist' do
+      expect(@session).not_to have_select('form_title', disabled_options: ['Not there'])
+    end
+
+    it 'should be false if the listed option exists but is not disabled' do
+      expect(@session).not_to have_select('form_title', disabled_options: %w[Other Mrs])
     end
   end
 
@@ -130,7 +158,7 @@ Capybara::SpecHelper.spec '#has_select?' do
     end
 
     it 'should be true even when the options are invisible, if the select itself is invisible' do
-      expect(@session).to have_select('Icecream', visible: false, with_options: %w[Vanilla Strawberry])
+      expect(@session).to have_select('Icecream', visible: :hidden, with_options: %w[Vanilla Strawberry])
     end
   end
 

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

@@ -61,12 +61,12 @@ Capybara::SpecHelper.spec '#has_selector?' do
     end
 
     it 'should respect visibility setting' do
-      expect(@session).to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: false)
-      expect(@session).not_to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: true)
+      expect(@session).to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: :all)
+      expect(@session).not_to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: :visible)
       Capybara.ignore_hidden_elements = false
-      expect(@session).to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: false)
+      expect(@session).to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: :all)
       Capybara.visible_text_only = true
-      expect(@session).not_to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: true)
+      expect(@session).not_to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: :visible)
     end
 
     it 'should discard all matches where the given regexp is not matched' do

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

@@ -127,18 +127,11 @@ Capybara::SpecHelper.spec '#has_text?' do
         def to_hash; { value: 'Other hash' } end
       end.new
       @session.visit('/with_html')
-      expect(@session).to have_text(:visible, with_to_hash, {})
-    end
-
-    it 'should fail if passed without empty options' do
-      with_to_hash = Class.new do
-        def to_s; '42' end
-        def to_hash; { blah: 'Other hash' } end
-      end.new
-      @session.visit('/with_html')
-      expect do
-        expect(@session).to have_text(:visible, with_to_hash)
-      end.to raise_error(ArgumentError)
+      if RUBY_VERSION >= '2.7'
+        expect(@session).to have_text(:visible, with_to_hash, **{})
+      else
+        expect(@session).to have_text(:visible, with_to_hash, {})
+      end
     end
   end
 

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Note: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# 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.
 

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

@@ -28,8 +28,8 @@ Capybara::SpecHelper.spec '#matches_style?', requires: [:css] do
       output(/have_style is deprecated/).to_stderr
 
     el = @session.find(:css, '#first')
-    allow(el).to receive(:warn).and_return(nil)
+    allow(Capybara::Helpers).to receive(:warn).and_return(nil)
     el.has_style?('display' => /^bl/)
-    expect(el).to have_received(:warn)
+    expect(Capybara::Helpers).to have_received(:warn)
   end
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Note: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# 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.
 
@@ -270,13 +270,13 @@ Capybara::SpecHelper.spec 'node' do
     end
 
     it 'works when details is toggled open and closed' do
-      @session.find(:css, '#closed_details').click
-      expect(@session).to have_css('#closed_details *', visible: true, count: 5)
+      @session.find(:css, '#closed_details > summary').click
+      expect(@session).to have_css('#closed_details *', visible: :visible, count: 5)
         .and(have_no_css('#closed_details *', visible: :hidden))
 
-      @session.find(:css, '#closed_details').click
+      @session.find(:css, '#closed_details > summary').click
       descendants_css = '#closed_details > *:not(summary), #closed_details > *:not(summary) *'
-      expect(@session).to have_no_css(descendants_css, visible: true)
+      expect(@session).to have_no_css(descendants_css, visible: :visible)
         .and(have_css(descendants_css, visible: :hidden, count: 3))
     end
   end
@@ -388,8 +388,8 @@ Capybara::SpecHelper.spec 'node' do
 
   describe '#==' do
     it 'preserve object identity' do
-      expect(@session.find('//h1') == @session.find('//h1')).to be true # rubocop:disable Lint/UselessComparison
-      expect(@session.find('//h1') === @session.find('//h1')).to be true # rubocop:disable Style/CaseEquality, Lint/UselessComparison
+      expect(@session.find('//h1') == @session.find('//h1')).to be true # rubocop:disable Lint/BinaryOperatorWithIdenticalOperands
+      expect(@session.find('//h1') === @session.find('//h1')).to be true # rubocop:disable Style/CaseEquality, Lint/BinaryOperatorWithIdenticalOperands
       expect(@session.find('//h1').eql?(@session.find('//h1'))).to be false
     end
 
@@ -409,6 +409,17 @@ Capybara::SpecHelper.spec 'node' do
       element = @session.find(:link, 'Second Link')
       expect(@session.find(:xpath, element.path)).to eq(element)
     end
+
+    it 'reports when element in shadow dom', requires: [:shadow_dom] do
+      @session.visit('/with_js')
+      shadow = @session.find(:css, '#shadow')
+      element = @session.evaluate_script(<<~JS, shadow)
+        (function(root){
+          return root.shadowRoot.querySelector('span');
+        })(arguments[0])
+      JS
+      expect(element.path).to eq '(: Shadow DOM element - no XPath :)'
+    end
   end
 
   describe '#trigger', requires: %i[js trigger] do
@@ -446,7 +457,7 @@ Capybara::SpecHelper.spec 'node' do
 
     it 'should work with Dragula' do
       @session.visit('/with_dragula')
-      @session.within(:css, '#sortable') do
+      @session.within(:css, '#sortable.ready') do
         src = @session.find('div', text: 'Item 1')
         target = @session.find('div', text: 'Item 3')
         src.drag_to target
@@ -468,6 +479,50 @@ Capybara::SpecHelper.spec 'node' do
       end
     end
 
+    it 'should simulate a single held down modifier key' do
+      %I[
+        alt
+        ctrl
+        meta
+        shift
+      ].each do |modifier_key|
+        @session.visit('/with_js')
+
+        element = @session.find('//div[@id="drag"]')
+        target = @session.find('//div[@id="drop"]')
+
+        element.drag_to(target, drop_modifiers: modifier_key)
+        expect(@session).to have_css('div.drag_start', exact_text: 'Dragged!')
+        expect(@session).to have_xpath("//div[contains(., 'Dropped!-#{modifier_key}')]")
+      end
+    end
+
+    it 'should simulate multiple held down modifier keys' do
+      @session.visit('/with_js')
+
+      element = @session.find('//div[@id="drag"]')
+      target = @session.find('//div[@id="drop"]')
+
+      modifier_keys = %I[alt ctrl meta shift]
+
+      element.drag_to(target, drop_modifiers: modifier_keys)
+      expect(@session).to have_xpath("//div[contains(., 'Dropped!-#{modifier_keys.join('-')}')]")
+    end
+
+    it 'should support key aliases' do
+      { control: :ctrl,
+        command: :meta,
+        cmd: :meta }.each do |(key_alias, key)|
+        @session.visit('/with_js')
+
+        element = @session.find('//div[@id="drag"]')
+        target = @session.find('//div[@id="drop"]')
+
+        element.drag_to(target, drop_modifiers: [key_alias])
+        expect(target).to have_text("Dropped!-#{key}", exact: true)
+      end
+    end
+
     context 'HTML5', requires: %i[js html5_drag] do
       it 'should HTML5 drag and drop an object' do
         @session.visit('/with_js')
@@ -499,8 +554,13 @@ Capybara::SpecHelper.spec 'node' do
         target = @session.find('//div[@id="drop_html5"]')
         element.drag_to(target)
 
+        conditions = %w[DragLeave Drop DragEnd].map do |text|
+          have_css('div.log', text: text)
+        end
+        expect(@session).to(conditions.reduce { |memo, cond| memo.and(cond) })
+
         # The first "DragOver" div is inserted by the last dragover event dispatched
-        drag_over_div = @session.find('//div[@class="log" and starts-with(text(), "DragOver")]', match: :first)
+        drag_over_div = @session.first('//div[@class="log" and starts-with(text(), "DragOver")]')
         position = drag_over_div.text.sub('DragOver ', '')
 
         expect(@session).to have_css('div.log', text: /DragLeave #{position}/, count: 1)
@@ -551,6 +611,46 @@ Capybara::SpecHelper.spec 'node' do
         source.drag_to target
         expect(@session).to have_xpath('//div[contains(., "HTML5 Dropped")]')
       end
+
+      it 'should simulate a single held down modifier key' do
+        %I[alt ctrl meta shift].each do |modifier_key|
+          @session.visit('/with_js')
+
+          element = @session.find('//div[@id="drag_html5"]')
+          target = @session.find('//div[@id="drop_html5"]')
+
+          element.drag_to(target, drop_modifiers: modifier_key)
+
+          expect(@session).to have_css('div.drag_start', exact_text: 'HTML5 Dragged!')
+          expect(@session).to have_xpath("//div[contains(., 'HTML5 Dropped string: text/plain drag_html5-#{modifier_key}')]")
+        end
+      end
+
+      it 'should simulate multiple held down modifier keys' do
+        @session.visit('/with_js')
+
+        element = @session.find('//div[@id="drag_html5"]')
+        target = @session.find('//div[@id="drop_html5"]')
+
+        modifier_keys = %I[alt ctrl meta shift]
+
+        element.drag_to(target, drop_modifiers: modifier_keys)
+        expect(@session).to have_xpath("//div[contains(., 'HTML5 Dropped string: text/plain drag_html5-#{modifier_keys.join('-')}')]")
+      end
+
+      it 'should support key aliases' do
+        { control: :ctrl,
+          command: :meta,
+          cmd: :meta }.each do |(key_alias, key)|
+          @session.visit('/with_js')
+
+          element = @session.find('//div[@id="drag_html5"]')
+          target = @session.find('//div[@id="drop_html5"]')
+
+          element.drag_to(target, drop_modifiers: [key_alias])
+          expect(target).to have_text(%r{^HTML5 Dropped string: text/plain drag_html5-#{key}$}m, exact: true)
+        end
+      end
     end
   end
 
@@ -582,6 +682,15 @@ Capybara::SpecHelper.spec 'node' do
       expect(@session).to have_xpath('//div[contains(., "HTML5 Dropped string: text/plain Some dropped text")]')
     end
 
+    it 'can drop a pathname' do
+      @session.visit('/with_js')
+      target = @session.find('//div[@id="drop_html5"]')
+      target.drop(
+        Pathname.new(with_os_path_separators(File.expand_path('../fixtures/capybara.jpg', File.dirname(__FILE__))))
+      )
+      expect(@session).to have_xpath('//div[contains(., "HTML5 Dropped file: capybara.jpg")]')
+    end
+
     it 'can drop multiple strings' do
       @session.visit('/with_js')
       target = @session.find('//div[@id="drop_html5"]')
@@ -669,7 +778,7 @@ Capybara::SpecHelper.spec 'node' do
       @session.visit('with_js')
       @session.find(:css, '#click-test').click(x: 5, y: 5)
       link = @session.find(:link, 'has-been-clicked')
-      locations = link.text.match(/^Has been clicked at (?<x>[\d\.-]+),(?<y>[\d\.-]+)$/)
+      locations = link.text.match(/^Has been clicked at (?<x>[\d.-]+),(?<y>[\d.-]+)$/)
       # Resulting click location should be very close to 0, 0 relative to top left corner of the element, but may not be exact due to
       # integer/float conversions and rounding.
       expect(locations[:x].to_f).to be_within(1).of(5)
@@ -719,7 +828,10 @@ Capybara::SpecHelper.spec 'node' do
     context 'offset', requires: [:js] do
       before do
         @session.visit('/offset')
-        @clicker = @session.find(:id, 'clicker')
+      end
+
+      let :clicker do
+        @session.find(:id, 'clicker')
       end
 
       context 'when w3c_click_offset is false' do
@@ -728,17 +840,17 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from top left of element' do
-          @clicker.click(x: 10, y: 5)
+          clicker.click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 110,105/)
         end
 
         it 'should offset outside the element' do
-          @clicker.click(x: -15, y: -10)
+          clicker.click(x: -15, y: -10)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.click
+          clicker.click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
@@ -749,21 +861,30 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from center of element' do
-          @clicker.click(x: 10, y: 5)
+          clicker.click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 160,155/)
         end
 
         it 'should offset outside from center of element' do
-          @clicker.click(x: -65, y: -60)
+          clicker.click(x: -65, y: -60)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.click
+          clicker.click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
     end
+
+    context 'delay', requires: [:js] do
+      it 'should delay the mouse up' do
+        @session.visit('with_js')
+        @session.find(:css, '#click-test').click(delay: 2)
+        delay = @session.evaluate_script('window.click_delay')
+        expect(delay).to be >= 2
+      end
+    end
   end
 
   describe '#double_click', requires: [:js] do
@@ -783,7 +904,7 @@ Capybara::SpecHelper.spec 'node' do
       @session.visit('with_js')
       @session.find(:css, '#click-test').double_click(x: 10, y: 5)
       link = @session.find(:link, 'has-been-double-clicked')
-      locations = link.text.match(/^Has been double clicked at (?<x>[\d\.-]+),(?<y>[\d\.-]+)$/)
+      locations = link.text.match(/^Has been double clicked at (?<x>[\d.-]+),(?<y>[\d.-]+)$/)
       # Resulting click location should be very close to 10, 5 relative to top left corner of the element, but may not be exact due
       # to integer/float conversions and rounding.
       expect(locations[:x].to_f).to be_within(1).of(10)
@@ -802,7 +923,10 @@ Capybara::SpecHelper.spec 'node' do
     context 'offset', requires: [:js] do
       before do
         @session.visit('/offset')
-        @clicker = @session.find(:id, 'clicker')
+      end
+
+      let :clicker do
+        @session.find(:id, 'clicker')
       end
 
       context 'when w3c_click_offset is false' do
@@ -811,17 +935,17 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from top left of element' do
-          @clicker.double_click(x: 10, y: 5)
+          clicker.double_click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 110,105/)
         end
 
         it 'should offset outside the element' do
-          @clicker.double_click(x: -15, y: -10)
+          clicker.double_click(x: -15, y: -10)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.double_click
+          clicker.double_click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
@@ -832,17 +956,17 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from center of element' do
-          @clicker.double_click(x: 10, y: 5)
+          clicker.double_click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 160,155/)
         end
 
         it 'should offset outside from center of element' do
-          @clicker.double_click(x: -65, y: -60)
+          clicker.double_click(x: -65, y: -60)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.double_click
+          clicker.double_click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
@@ -866,7 +990,7 @@ Capybara::SpecHelper.spec 'node' do
       @session.visit('with_js')
       @session.find(:css, '#click-test').right_click(x: 10, y: 10)
       link = @session.find(:link, 'has-been-right-clicked')
-      locations = link.text.match(/^Has been right clicked at (?<x>[\d\.-]+),(?<y>[\d\.-]+)$/)
+      locations = link.text.match(/^Has been right clicked at (?<x>[\d.-]+),(?<y>[\d.-]+)$/)
       # Resulting click location should be very close to 10, 10 relative to top left corner of the element, but may not be exact due
       # to integer/float conversions and rounding
       expect(locations[:x].to_f).to be_within(1).of(10)
@@ -885,7 +1009,10 @@ Capybara::SpecHelper.spec 'node' do
     context 'offset', requires: [:js] do
       before do
         @session.visit('/offset')
-        @clicker = @session.find(:id, 'clicker')
+      end
+
+      let :clicker do
+        @session.find(:id, 'clicker')
       end
 
       context 'when w3c_click_offset is false' do
@@ -894,17 +1021,17 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from top left of element' do
-          @clicker.right_click(x: 10, y: 5)
+          clicker.right_click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 110,105/)
         end
 
         it 'should offset outside the element' do
-          @clicker.right_click(x: -15, y: -10)
+          clicker.right_click(x: -15, y: -10)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.right_click
+          clicker.right_click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
@@ -915,21 +1042,30 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from center of element' do
-          @clicker.right_click(x: 10, y: 5)
+          clicker.right_click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 160,155/)
         end
 
         it 'should offset outside from center of element' do
-          @clicker.right_click(x: -65, y: -60)
+          clicker.right_click(x: -65, y: -60)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.right_click
+          clicker.right_click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
     end
+
+    context 'delay', requires: [:js] do
+      it 'should delay the mouse up' do
+        @session.visit('with_js')
+        @session.find(:css, '#click-test').right_click(delay: 2)
+        delay = @session.evaluate_script('window.right_click_delay')
+        expect(delay).to be >= 2
+      end
+    end
   end
 
   describe '#send_keys', requires: [:send_keys] do