capybara 3.23.0 → 3.35.3

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

@@ -143,10 +143,56 @@ Capybara::SpecHelper.spec '#has_no_table?' do
      ])
   end
 
-  it 'should consider columns' do
-    expect(@session).to have_no_table('Vertical Headers', with_cols:
-      [
-        { 'First Name' => 'Joe' }
-      ])
+  context 'using :with_cols' do
+    it 'should consider a single column' do
+      expect(@session).to have_no_table('Vertical Headers', with_cols:
+        [
+          { 'First Name' => 'Joe' }
+        ])
+    end
+
+    it 'should be true even if the last column does exist' do
+      expect(@session).to have_no_table('Vertical Headers', with_cols:
+        [
+          {
+            'First Name' => 'What?',
+            'What?' => 'Walpole',
+            'City' => 'Oceanside' # This line makes the example fail
+          }
+        ])
+    end
+
+    it 'should be true if none of the columns exist' do
+      expect(@session).to have_no_table('Vertical Headers', with_cols:
+        [
+          {
+            'First Name' => 'What?',
+            'What?' => 'Walpole',
+            'City' => 'What?'
+          }
+        ])
+    end
+
+    it 'should be true if the first column does match' do
+      expect(@session).to have_no_table('Vertical Headers', with_cols:
+        [
+          {
+            'First Name' => 'Thomas',
+            'Last Name' => 'What',
+            'City' => 'What'
+          }
+        ])
+    end
+
+    it 'should be true if none of the columns match' do
+      expect(@session).to have_no_table('Vertical Headers', with_cols:
+        [
+          {
+            'First Name' => 'What',
+            'Last Name' => 'What',
+            'City' => 'What'
+          }
+        ])
+    end
   end
 end

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

@@ -111,6 +111,30 @@ Capybara::SpecHelper.spec '#has_text?' do
     expect(@session).not_to have_text(/xxxxyzzz/)
   end
 
+  context 'with object implementing to_s and to_hash' do
+    it 'should work if the object is passed alone' do
+      with_to_hash = Class.new do
+        def to_s; '42' end
+        def to_hash; { value: 'Other hash' } end
+      end.new
+      @session.visit('/with_html')
+      expect(@session).to have_text(with_to_hash)
+    end
+
+    it 'should work if passed with empty options' do
+      with_to_hash = Class.new do
+        def to_s; '42' end
+        def to_hash; { value: 'Other hash' } end
+      end.new
+      @session.visit('/with_html')
+      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
+
   context 'with exact: true option' do
     it 'should be true if text matches exactly' do
       @session.visit('/with_html')
@@ -139,6 +163,12 @@ Capybara::SpecHelper.spec '#has_text?' do
     expect(@session).to have_text(nil)
   end
 
+  it 'should warn when passed nil' do
+    @session.visit('/with_html')
+    expect_any_instance_of(Kernel).to receive(:warn).with(/Checking for expected text of nil is confusing/) # rubocop:disable RSpec/AnyInstance
+    expect(@session).to have_text(nil)
+  end
+
   it 'should wait for text to appear', requires: [:js] do
     Capybara.using_wait_time(3) do
       @session.visit('/with_js')

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.
 
@@ -233,8 +233,9 @@ Capybara::SpecHelper.spec 'node' do
   end
 
   describe '#visible?' do
+    before { Capybara.ignore_hidden_elements = false }
+
     it 'should extract node visibility' do
-      Capybara.ignore_hidden_elements = false
       expect(@session.first('//a')).to be_visible
 
       expect(@session.find('//div[@id="hidden"]')).not_to be_visible
@@ -245,15 +246,39 @@ Capybara::SpecHelper.spec 'node' do
     end
 
     it 'template elements should not be visible' do
-      Capybara.ignore_hidden_elements = false
       expect(@session.find('//template')).not_to be_visible
     end
 
     it 'should be boolean' do
-      Capybara.ignore_hidden_elements = false
       expect(@session.first('//a').visible?).to be true
       expect(@session.find('//div[@id="hidden"]').visible?).to be false
     end
+
+    it 'closed details > summary elements and descendants should be visible' do
+      expect(@session.find(:css, '#closed_details summary')).to be_visible
+      expect(@session.find(:css, '#closed_details summary h6')).to be_visible
+    end
+
+    it 'details non-summary descendants should be non-visible when closed' do
+      descendants = @session.all(:css, '#closed_details > *:not(summary), #closed_details > *:not(summary) *', minimum: 2)
+      expect(descendants).not_to include(be_visible)
+    end
+
+    it 'deatils descendants should be visible when open' do
+      descendants = @session.all(:css, '#open_details *')
+      expect(descendants).to all(be_visible)
+    end
+
+    it 'works when details is toggled open and closed' do
+      @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 > summary').click
+      descendants_css = '#closed_details > *:not(summary), #closed_details > *:not(summary) *'
+      expect(@session).to have_no_css(descendants_css, visible: :visible)
+        .and(have_css(descendants_css, visible: :hidden, count: 3))
+    end
   end
 
   describe '#obscured?', requires: [:css] do
@@ -363,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
 
@@ -384,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
@@ -419,6 +455,74 @@ Capybara::SpecHelper.spec 'node' do
       expect(@session).to have_xpath('//div[contains(., "Dropped!")]')
     end
 
+    it 'should work with Dragula' do
+      @session.visit('/with_dragula')
+      @session.within(:css, '#sortable.ready') do
+        src = @session.find('div', text: 'Item 1')
+        target = @session.find('div', text: 'Item 3')
+        src.drag_to target
+        expect(@session).to have_content(/Item 2.*Item 1/, normalize_ws: true)
+      end
+    end
+
+    it 'should work with jsTree' do
+      @session.visit('/with_jstree')
+      @session.within(:css, '#container') do
+        @session.assert_text(/A.*B.*C/m)
+        source = @session.find(:css, '#j1_1_anchor')
+        target = @session.find(:css, '#j1_2_anchor')
+
+        source.drag_to(target)
+
+        @session.assert_no_text(/A.*B.*C/m)
+        @session.assert_text(/B.*C/m)
+      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')
@@ -428,6 +532,14 @@ Capybara::SpecHelper.spec 'node' do
         expect(@session).to have_xpath('//div[contains(., "HTML5 Dropped string: text/plain drag_html5")]')
       end
 
+      it 'should HTML5 drag and drop an object child' do
+        @session.visit('/with_js')
+        element = @session.find('//div[@id="drag_html5"]/p')
+        target = @session.find('//div[@id="drop_html5"]')
+        element.drag_to(target)
+        expect(@session).to have_xpath('//div[contains(., "HTML5 Dropped string: text/plain drag_html5")]')
+      end
+
       it 'should set clientX/Y in dragover events' do
         @session.visit('/with_js')
         element = @session.find('//div[@id="drag_html5"]')
@@ -436,6 +548,26 @@ Capybara::SpecHelper.spec 'node' do
         expect(@session).to have_css('div.log', text: /DragOver with client position: [1-9]\d*,[1-9]\d*/, count: 2)
       end
 
+      it 'should preserve clientX/Y from last dragover event' do
+        @session.visit('/with_js')
+        element = @session.find('//div[@id="drag_html5"]')
+        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.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)
+        expect(@session).to have_css('div.log', text: /Drop #{position}/, count: 1)
+        expect(@session).to have_css('div.log', text: /DragEnd #{position}/, count: 1)
+      end
+
       it 'should not HTML5 drag and drop on a non HTML5 drop element' do
         @session.visit('/with_js')
         element = @session.find('//div[@id="drag_html5"]')
@@ -471,6 +603,54 @@ Capybara::SpecHelper.spec 'node' do
           expect(@session).to have_content(/Item 3.*Item 1/, normalize_ws: true)
         end
       end
+
+      it 'should drag HTML5 default draggable element child' do
+        @session.visit('/with_js')
+        source = @session.find_link('drag_link_html5').find(:css, 'p')
+        target = @session.find(:id, 'drop_html5')
+        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
 
@@ -502,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"]')
@@ -589,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)
@@ -635,6 +824,67 @@ Capybara::SpecHelper.spec 'node' do
       JS
       expect { obscured.click(wait: 0) }.to(raise_error { |e| expect(e).to be_an_invalid_element_error(@session) })
     end
+
+    context 'offset', requires: [:js] do
+      before do
+        @session.visit('/offset')
+      end
+
+      let :clicker do
+        @session.find(:id, 'clicker')
+      end
+
+      context 'when w3c_click_offset is false' do
+        before do
+          Capybara.w3c_click_offset = false
+        end
+
+        it 'should offset from top left of element' do
+          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)
+          expect(@session).to have_text(/clicked at 85,90/)
+        end
+
+        it 'should default to click the middle' do
+          clicker.click
+          expect(@session).to have_text(/clicked at 150,150/)
+        end
+      end
+
+      context 'when w3c_click_offset is true' do
+        before do
+          Capybara.w3c_click_offset = true
+        end
+
+        it 'should offset from center of element' do
+          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)
+          expect(@session).to have_text(/clicked at 85,90/)
+        end
+
+        it 'should default to click the middle' do
+          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
@@ -654,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)
@@ -669,6 +919,58 @@ Capybara::SpecHelper.spec 'node' do
       JS
       expect { obscured.double_click }.not_to raise_error
     end
+
+    context 'offset', requires: [:js] do
+      before do
+        @session.visit('/offset')
+      end
+
+      let :clicker do
+        @session.find(:id, 'clicker')
+      end
+
+      context 'when w3c_click_offset is false' do
+        before do
+          Capybara.w3c_click_offset = false
+        end
+
+        it 'should offset from top left of element' do
+          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)
+          expect(@session).to have_text(/clicked at 85,90/)
+        end
+
+        it 'should default to click the middle' do
+          clicker.double_click
+          expect(@session).to have_text(/clicked at 150,150/)
+        end
+      end
+
+      context 'when w3c_click_offset is true' do
+        before do
+          Capybara.w3c_click_offset = true
+        end
+
+        it 'should offset from center of element' do
+          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)
+          expect(@session).to have_text(/clicked at 85,90/)
+        end
+
+        it 'should default to click the middle' do
+          clicker.double_click
+          expect(@session).to have_text(/clicked at 150,150/)
+        end
+      end
+    end
   end
 
   describe '#right_click', requires: [:js] do
@@ -688,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)
@@ -703,6 +1005,67 @@ Capybara::SpecHelper.spec 'node' do
       JS
       expect { obscured.right_click }.not_to raise_error
     end
+
+    context 'offset', requires: [:js] do
+      before do
+        @session.visit('/offset')
+      end
+
+      let :clicker do
+        @session.find(:id, 'clicker')
+      end
+
+      context 'when w3c_click_offset is false' do
+        before do
+          Capybara.w3c_click_offset = false
+        end
+
+        it 'should offset from top left of element' do
+          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)
+          expect(@session).to have_text(/clicked at 85,90/)
+        end
+
+        it 'should default to click the middle' do
+          clicker.right_click
+          expect(@session).to have_text(/clicked at 150,150/)
+        end
+      end
+
+      context 'when w3c_click_offset is true' do
+        before do
+          Capybara.w3c_click_offset = true
+        end
+
+        it 'should offset from center of element' do
+          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)
+          expect(@session).to have_text(/clicked at 85,90/)
+        end
+
+        it 'should default to click the middle' do
+          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
@@ -814,6 +1177,28 @@ Capybara::SpecHelper.spec 'node' do
   end
 
   describe '#reload', requires: [:js] do
+    it 'should reload elements found via ancestor with CSS' do
+      @session.visit('/with_js')
+      node = @session.find(:css, '#reload-me em').ancestor(:css, 'div')
+      node.reload
+      expect(node[:id]).to eq 'reload-me'
+    end
+
+    it 'should reload elements found via ancestor with XPath' do
+      @session.visit('/with_js')
+      node = @session.find(:css, '#reload-me em').ancestor(:xpath, './/div')
+      node.reload
+      expect(node[:id]).to eq 'reload-me'
+    end
+
+    it 'should reload elements found via sibling' do
+      @session.visit('/with_js')
+      node = @session.find(:css, '#the-list li', text: 'Item 1').sibling(:css, 'li')
+      expect(node.text).to eq 'Item 2'
+      node.reload
+      expect(node.text).to eq 'Item 2'
+    end
+
     context 'without automatic reload' do
       before { Capybara.automatic_reload = false }