capybara 3.3.0 → 3.40.0

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#have_sibling' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  it 'should assert a prior sibling element using the given locator' do
+    el = @session.find(:css, '#mid_sibling')
+    expect(el).to have_sibling(:css, '#pre_sibling')
+  end
+
+  it 'should assert a following sibling element using the given locator' do
+    el = @session.find(:css, '#mid_sibling')
+    expect(el).to have_sibling(:css, '#post_sibling')
+  end
+
+  it 'should not raise an error if there are multiple matches' do
+    el = @session.find(:css, '#mid_sibling')
+    expect(el).to have_sibling(:css, 'div')
+  end
+
+  it 'should allow counts to be specified' do
+    el = @session.find(:css, '#mid_sibling')
+
+    expect(el).to have_sibling(:css, 'div').exactly(2).times
+    expect do
+      expect(el).to have_sibling(:css, 'div').once
+    end.to raise_error(RSpec::Expectations::ExpectationNotMetError)
+  end
+end
+
+Capybara::SpecHelper.spec '#have_no_sibling' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  it 'should assert no matching sibling' do
+    el = @session.find(:css, '#mid_sibling')
+    expect(el).to have_no_sibling(:css, '#not_a_sibling')
+    expect(el).not_to have_sibling(:css, '#not_a_sibling')
+  end
+
+  it 'should raise if there are matching siblings' do
+    el = @session.find(:css, '#mid_sibling')
+    expect do
+      expect(el).to have_no_sibling(:css, '#pre_sibling')
+    end.to raise_error(RSpec::Expectations::ExpectationNotMetError)
+  end
+end

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

@@ -5,15 +5,132 @@ Capybara::SpecHelper.spec '#has_table?' do
     @session.visit('/tables')
   end
 
-  it "should be true if the table is on the page" do
+  it 'should be true if the table is on the page' do
     expect(@session).to have_table('Villain')
     expect(@session).to have_table('villain_table')
     expect(@session).to have_table(:villain_table)
   end
 
-  it "should be false if the table is not on the page" do
+  it 'should accept rows with column header hashes' do
+    expect(@session).to have_table('Horizontal Headers', with_rows:
+      [
+        { 'First Name' => 'Vern', 'Last Name' => 'Konopelski', 'City' => 'Everette' },
+        { 'First Name' => 'Palmer', 'Last Name' => 'Sawayn', 'City' => 'West Trinidad' }
+      ])
+  end
+
+  it 'should accept rows with partial column header hashes' do
+    expect(@session).to have_table('Horizontal Headers', with_rows:
+      [
+        { 'First Name' => 'Thomas' },
+        { 'Last Name' => 'Sawayn', 'City' => 'West Trinidad' }
+      ])
+
+    expect(@session).not_to have_table('Horizontal Headers', with_rows:
+      [
+        { 'Unmatched Header' => 'Thomas' }
+      ])
+  end
+
+  it 'should accept rows with array of cell values' do
+    expect(@session).to have_table('Horizontal Headers', with_rows:
+      [
+        %w[Thomas Walpole Oceanside],
+        ['Ratke', 'Lawrence', 'East Sorayashire']
+      ])
+  end
+
+  it 'should consider order of cells in each row' do
+    expect(@session).not_to have_table('Horizontal Headers', with_rows:
+      [
+        %w[Thomas Walpole Oceanside],
+        ['Lawrence', 'Ratke', 'East Sorayashire']
+      ])
+  end
+
+  it 'should accept all rows with array of cell values' do
+    expect(@session).to have_table('Horizontal Headers', rows:
+      [
+        %w[Thomas Walpole Oceanside],
+        %w[Danilo Wilkinson Johnsonville],
+        %w[Vern Konopelski Everette],
+        ['Ratke', 'Lawrence', 'East Sorayashire'],
+        ['Palmer', 'Sawayn', 'West Trinidad']
+      ])
+  end
+
+  it 'should match with vertical headers' do
+    expect(@session).to have_table('Vertical Headers', with_cols:
+      [
+        { 'First Name' => 'Thomas' },
+        { 'First Name' => 'Danilo', 'Last Name' => 'Wilkinson', 'City' => 'Johnsonville' },
+        { 'Last Name' => 'Sawayn', 'City' => 'West Trinidad' }
+      ])
+  end
+
+  it 'should match col with array of cell values' do
+    expect(@session).to have_table('Vertical Headers', with_cols:
+      [
+        %w[Vern Konopelski Everette]
+      ])
+  end
+
+  it 'should match cols with array of cell values' do
+    expect(@session).to have_table('Vertical Headers', with_cols:
+      [
+        %w[Danilo Wilkinson Johnsonville],
+        %w[Vern Konopelski Everette]
+      ])
+  end
+
+  it 'should match all cols with array of cell values' do
+    expect(@session).to have_table('Vertical Headers', cols:
+      [
+        %w[Thomas Walpole Oceanside],
+        %w[Danilo Wilkinson Johnsonville],
+        %w[Vern Konopelski Everette],
+        ['Ratke', 'Lawrence', 'East Sorayashire'],
+        ['Palmer', 'Sawayn', 'West Trinidad']
+      ])
+  end
+
+  it "should not match if the order of cell values doesn't match" do
+    expect(@session).not_to have_table('Vertical Headers', with_cols:
+      [
+        %w[Vern Everette Konopelski]
+      ])
+  end
+
+  it "should not match with vertical headers if the columns don't match" do
+    expect(@session).not_to have_table('Vertical Headers', with_cols:
+      [
+        { 'First Name' => 'Thomas' },
+        { 'First Name' => 'Danilo', 'Last Name' => 'Walpole', 'City' => 'Johnsonville' },
+        { 'Last Name' => 'Sawayn', 'City' => 'West Trinidad' }
+      ])
+
+    expect(@session).not_to have_table('Vertical Headers', with_cols:
+      [
+        { 'Unmatched Header' => 'Thomas' }
+      ])
+  end
+
+  it 'should be false if the table is not on the page' do
     expect(@session).not_to have_table('Monkey')
   end
+
+  it 'should find row by header and cell values' do
+    expect(@session.find(:table, 'Horizontal Headers')).to have_selector(:table_row, 'First Name' => 'Thomas', 'Last Name' => 'Walpole')
+    expect(@session.find(:table, 'Horizontal Headers')).to have_selector(:table_row, 'Last Name' => 'Walpole')
+    expect(@session.find(:table, 'Horizontal Headers')).not_to have_selector(:table_row, 'First Name' => 'Walpole')
+    expect(@session.find(:table, 'Horizontal Headers')).not_to have_selector(:table_row, 'Unmatched Header' => 'Thomas')
+  end
+
+  it 'should find row by cell values' do
+    expect(@session.find(:table, 'Horizontal Headers')).to have_selector(:table_row, %w[Thomas Walpole Oceanside])
+    expect(@session.find(:table, 'Horizontal Headers')).not_to have_selector(:table_row, %w[Walpole Thomas])
+    expect(@session.find(:table, 'Horizontal Headers')).not_to have_selector(:table_row, %w[Other])
+  end
 end
 
 Capybara::SpecHelper.spec '#has_no_table?' do
@@ -21,12 +138,72 @@ Capybara::SpecHelper.spec '#has_no_table?' do
     @session.visit('/tables')
   end
 
-  it "should be false if the table is on the page" do
+  it 'should be false if the table is on the page' do
     expect(@session).not_to have_no_table('Villain')
     expect(@session).not_to have_no_table('villain_table')
   end
 
-  it "should be true if the table is not on the page" do
+  it 'should be true if the table is not on the page' do
     expect(@session).to have_no_table('Monkey')
   end
+
+  it 'should consider rows' do
+    expect(@session).to have_no_table('Horizontal Headers', with_rows:
+     [
+       { 'First Name' => 'Thomas', 'City' => 'Los Angeles' }
+     ])
+  end
+
+  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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Capybara::SpecHelper.spec '#has_text?' do
-  it "should be true if the given text is on the page at least once" do
+  it 'should be true if the given text is on the page at least once' do
     @session.visit('/with_html')
     expect(@session).to have_text('est')
     expect(@session).to have_text('Lorem')
@@ -9,32 +9,51 @@ Capybara::SpecHelper.spec '#has_text?' do
     expect(@session).to have_text(:Redirect)
   end
 
-  it "should be true if scoped to an element which has the text" do
+  it 'should be true if scoped to an element which has the text' do
     @session.visit('/with_html')
     @session.within("//a[@title='awesome title']") do
       expect(@session).to have_text('labore')
     end
   end
 
-  it "should be false if scoped to an element which does not have the text" do
+  it 'should be false if scoped to an element which does not have the text' do
     @session.visit('/with_html')
     @session.within("//a[@title='awesome title']") do
       expect(@session).not_to have_text('monkey')
     end
   end
 
-  it "should ignore tags" do
+  it 'should ignore tags' do
     @session.visit('/with_html')
     expect(@session).not_to have_text('exercitation <a href="/foo" id="foo">ullamco</a> laboris')
     expect(@session).to have_text('exercitation ullamco laboris')
   end
 
-  it "should search correctly normalized text" do
+  it 'should search correctly normalized text' do
     @session.visit('/with_html')
     expect(@session).to have_text('text with   whitespace')
   end
 
-  it "should be false if the given text is not on the page" do
+  it 'should search whitespace collapsed text' do
+    @session.visit('/with_html')
+    expect(@session).to have_text('text with whitespace', normalize_ws: true)
+  end
+
+  context 'with enabled default collapsing whitespace' do
+    before { Capybara.default_normalize_ws = true }
+
+    it 'should search unnormalized text' do
+      @session.visit('/with_html')
+      expect(@session).to have_text('text with   whitespace', normalize_ws: false)
+    end
+
+    it 'should search whitespace collapsed text' do
+      @session.visit('/with_html')
+      expect(@session).to have_text('text with whitespace')
+    end
+  end
+
+  it 'should be false if the given text is not on the page' do
     @session.visit('/with_html')
     expect(@session).not_to have_text('xxxxyzzz')
     expect(@session).not_to have_text('monkey')
@@ -66,23 +85,23 @@ Capybara::SpecHelper.spec '#has_text?' do
     expect(@session).not_to have_text('aVar')
   end
 
-  it "should be false if the given text is on the page but not visible" do
+  it 'should be false if the given text is on the page but not visible' do
     @session.visit('/with_html')
     expect(@session).not_to have_text('Inside element with hidden ancestor')
   end
 
-  it "should be true if :all given and text is invisible." do
+  it 'should be true if :all given and text is invisible.' do
     @session.visit('/with_html')
     expect(@session).to have_text(:all, 'Some of this text is hidden!')
   end
 
-  it "should be true if `Capybara.ignore_hidden_elements = false` and text is invisible." do
+  it 'should be true if `Capybara.ignore_hidden_elements = false` and text is invisible.' do
     Capybara.ignore_hidden_elements = false
     @session.visit('/with_html')
     expect(@session).to have_text('Some of this text is hidden!')
   end
 
-  it "should be true if the text in the page matches given regexp" do
+  it 'should be true if the text in the page matches given regexp' do
     @session.visit('/with_html')
     expect(@session).to have_text(/Lorem/)
   end
@@ -92,50 +111,72 @@ Capybara::SpecHelper.spec '#has_text?' do
     expect(@session).not_to have_text(/xxxxyzzz/)
   end
 
-  context "with exact: true option" do
-    it "should be true if text matches exactly" do
+  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.find(:id, "h2one")).to have_text("Header Class Test One", exact: true)
+      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')
+      expect(@session).to have_text(:visible, with_to_hash, **{})
+    end
+  end
+
+  context 'with exact: true option' do
+    it 'should be true if text matches exactly' do
+      @session.visit('/with_html')
+      expect(@session.find(:id, 'h2one')).to have_text('Header Class Test One', exact: true)
     end
 
     it "should be false if text doesn't match exactly" do
       @session.visit('/with_html')
-      expect(@session.find(:id, "h2one")).not_to have_text("Header Class Test On", exact: true)
+      expect(@session.find(:id, 'h2one')).not_to have_text('Header Class Test On', exact: true)
     end
   end
 
-  it "should escape any characters that would have special meaning in a regexp" do
+  it 'should escape any characters that would have special meaning in a regexp' do
     @session.visit('/with_html')
     expect(@session).not_to have_text('.orem')
   end
 
-  it "should accept non-string parameters" do
+  it 'should accept non-string parameters' do
     @session.visit('/with_html')
     expect(@session).to have_text(42)
   end
 
-  it "should be true when passed nil" do
+  it 'should be true when passed nil, and warn about it' do
     # nil is converted to '' when to_s is invoked
     @session.visit('/with_html')
-    expect(@session).to have_text(nil)
+    expect do
+      expect(@session).to have_text(nil)
+    end.to output(/Checking for expected text of nil is confusing/).to_stderr
   end
 
-  it "should wait for text to appear", requires: [:js] do
+  it 'should wait for text to appear', requires: [:js] do
     Capybara.using_wait_time(3) do
       @session.visit('/with_js')
       @session.click_link('Click me')
-      expect(@session).to have_text("Has been clicked")
+      expect(@session).to have_text('Has been clicked')
     end
   end
 
-  context "with between" do
-    it "should be true if the text occurs within the range given" do
+  context 'with between' do
+    it 'should be true if the text occurs within the range given' do
       @session.visit('/with_count')
       expect(@session).to have_text('count', between: 1..3)
       expect(@session).to have_text(/count/, between: 2..2)
     end
 
-    it "should be false if the text occurs more or fewer times than range" do
+    it 'should be false if the text occurs more or fewer times than range' do
       @session.visit('/with_count')
       expect(@session).not_to have_text('count', between: 0..1)
       expect(@session).not_to have_text('count', between: 3..10)
@@ -143,76 +184,82 @@ Capybara::SpecHelper.spec '#has_text?' do
     end
   end
 
-  context "with count" do
-    it "should be true if the text occurs the given number of times" do
+  context 'with count' do
+    it 'should be true if the text occurs the given number of times' do
       @session.visit('/with_count')
       expect(@session).to have_text('count', count: 2)
+      expect(@session).to have_text('count').exactly(2).times
     end
 
-    it "should be false if the text occurs a different number of times than the given" do
+    it 'should be false if the text occurs a different number of times than the given' do
       @session.visit('/with_count')
       expect(@session).not_to have_text('count', count: 0)
       expect(@session).not_to have_text('count', count: 1)
+      expect(@session).not_to have_text('count').once
       expect(@session).not_to have_text(/count/, count: 3)
     end
 
-    it "should coerce count to an integer" do
+    it 'should coerce count to an integer' do
       @session.visit('/with_count')
       expect(@session).to have_text('count', count: '2')
       expect(@session).not_to have_text('count', count: '3')
     end
   end
 
-  context "with maximum" do
-    it "should be true when text occurs same or fewer times than given" do
+  context 'with maximum' do
+    it 'should be true when text occurs same or fewer times than given' do
       @session.visit('/with_count')
       expect(@session).to have_text('count', maximum: 2)
+      expect(@session).to have_text('count').at_most(2).times
       expect(@session).to have_text(/count/, maximum: 3)
     end
 
-    it "should be false when text occurs more times than given" do
+    it 'should be false when text occurs more times than given' do
       @session.visit('/with_count')
       expect(@session).not_to have_text('count', maximum: 1)
+      expect(@session).not_to have_text('count').at_most(1).times
       expect(@session).not_to have_text('count', maximum: 0)
     end
 
-    it "should coerce maximum to an integer" do
+    it 'should coerce maximum to an integer' do
       @session.visit('/with_count')
       expect(@session).to have_text('count', maximum: '2')
       expect(@session).not_to have_text('count', maximum: '1')
     end
   end
 
-  context "with minimum" do
-    it "should be true when text occurs same or more times than given" do
+  context 'with minimum' do
+    it 'should be true when text occurs same or more times than given' do
       @session.visit('/with_count')
       expect(@session).to have_text('count', minimum: 2)
+      expect(@session).to have_text('count').at_least(2).times
       expect(@session).to have_text(/count/, minimum: 0)
     end
 
-    it "should be false when text occurs fewer times than given" do
+    it 'should be false when text occurs fewer times than given' do
       @session.visit('/with_count')
       expect(@session).not_to have_text('count', minimum: 3)
+      expect(@session).not_to have_text('count').at_least(3).times
     end
 
-    it "should coerce minimum to an integer" do
+    it 'should coerce minimum to an integer' do
       @session.visit('/with_count')
       expect(@session).to have_text('count', minimum: '2')
       expect(@session).not_to have_text('count', minimum: '3')
     end
   end
 
-  context "with wait", requires: [:js] do
-    it "should find element if it appears before given wait duration" do
+  context 'with wait', requires: [:js] do
+    it 'should find element if it appears before given wait duration' 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: 0.9)
+        expect(@session).to have_text('Has been clicked', wait: 3)
       end
     end
   end
 
-  it "should raise an error if an invalid option is passed" do
+  it 'should raise an error if an invalid option is passed' do
     @session.visit('/with_html')
     expect do
       expect(@session).to have_text('Lorem', invalid: true)
@@ -221,34 +268,34 @@ Capybara::SpecHelper.spec '#has_text?' do
 end
 
 Capybara::SpecHelper.spec '#has_no_text?' do
-  it "should be false if the given text is on the page at least once" do
+  it 'should be false if the given text is on the page at least once' do
     @session.visit('/with_html')
     expect(@session).not_to have_no_text('est')
     expect(@session).not_to have_no_text('Lorem')
     expect(@session).not_to have_no_text('Redirect')
   end
 
-  it "should be false if scoped to an element which has the text" do
+  it 'should be false if scoped to an element which has the text' do
     @session.visit('/with_html')
     @session.within("//a[@title='awesome title']") do
       expect(@session).not_to have_no_text('labore')
     end
   end
 
-  it "should be true if scoped to an element which does not have the text" do
+  it 'should be true if scoped to an element which does not have the text' do
     @session.visit('/with_html')
     @session.within("//a[@title='awesome title']") do
       expect(@session).to have_no_text('monkey')
     end
   end
 
-  it "should ignore tags" do
+  it 'should ignore tags' do
     @session.visit('/with_html')
     expect(@session).to have_no_text('exercitation <a href="/foo" id="foo">ullamco</a> laboris')
     expect(@session).not_to have_no_text('exercitation ullamco laboris')
   end
 
-  it "should be true if the given text is not on the page" do
+  it 'should be true if the given text is not on the page' do
     @session.visit('/with_html')
     expect(@session).to have_no_text('xxxxyzzz')
     expect(@session).to have_no_text('monkey')
@@ -280,17 +327,17 @@ Capybara::SpecHelper.spec '#has_no_text?' do
     expect(@session).to have_no_text('aVar')
   end
 
-  it "should be true if the given text is on the page but not visible" do
+  it 'should be true if the given text is on the page but not visible' do
     @session.visit('/with_html')
     expect(@session).to have_no_text('Inside element with hidden ancestor')
   end
 
-  it "should be false if :all given and text is invisible." do
+  it 'should be false if :all given and text is invisible.' do
     @session.visit('/with_html')
     expect(@session).not_to have_no_text(:all, 'Some of this text is hidden!')
   end
 
-  it "should be false if `Capybara.ignore_hidden_elements = false` and text is invisible." do
+  it 'should be false if `Capybara.ignore_hidden_elements = false` and text is invisible.' do
     Capybara.ignore_hidden_elements = false
     @session.visit('/with_html')
     expect(@session).not_to have_no_text('Some of this text is hidden!')
@@ -301,24 +348,25 @@ Capybara::SpecHelper.spec '#has_no_text?' do
     expect(@session).to have_no_text(/xxxxyzzz/)
   end
 
-  it "should be false if the text in the page  matches given regexp" do
+  it 'should be false if the text in the page matches given regexp' do
     @session.visit('/with_html')
     expect(@session).not_to have_no_text(/Lorem/)
   end
 
-  it "should escape any characters that would have special meaning in a regexp" do
+  it 'should escape any characters that would have special meaning in a regexp' do
     @session.visit('/with_html')
     expect(@session).to have_no_text('.orem')
   end
 
-  it "should wait for text to disappear", requires: [:js] do
+  it 'should wait for text to disappear', requires: [:js] do
+    Capybara.default_max_wait_time = 2
     @session.visit('/with_js')
     @session.click_link('Click me')
-    expect(@session).to have_no_text("I changed it")
+    expect(@session).to have_no_text('I changed it')
   end
 
-  context "with wait", requires: [:js] do
-    it "should not find element if it appears after given wait duration" do
+  context 'with wait', requires: [:js] do
+    it 'should not find element if it appears after given wait duration' do
       @session.visit('/with_js')
       @session.click_link('Click me')
       expect(@session).to have_no_text('Has been clicked', wait: 0.05)