capybara 2.7.0 → 3.35.3

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

@@ -1,157 +1,277 @@
 # frozen_string_literal: true
-Capybara::SpecHelper.spec "#all" do
+
+Capybara::SpecHelper.spec '#all' do
   before do
     @session.visit('/with_html')
   end
 
-  it "should find all elements using the given locator" do
+  it 'should find all elements using the given locator' do
     expect(@session.all('//p').size).to eq(3)
     expect(@session.all('//h1').first.text).to eq('This is a test')
-    expect(@session.all("//input[@id='test_field']").first[:value]).to eq('monkey')
+    expect(@session.all("//input[@id='test_field']").first.value).to eq('monkey')
   end
 
-  it "should return an empty array when nothing was found" do
+  it 'should return an empty array when nothing was found' do
     expect(@session.all('//div[@id="nosuchthing"]')).to be_empty
   end
 
-  it "should accept an XPath instance" do
+  it 'should wait for matching elements to appear', requires: [:js] do
+    Capybara.default_max_wait_time = 2
+    @session.visit('/with_js')
+    @session.click_link('Click me')
+    expect(@session.all(:css, 'a#has-been-clicked')).not_to be_empty
+  end
+
+  it 'should not wait if `minimum: 0` option is specified', requires: [:js] do
+    @session.visit('/with_js')
+    @session.click_link('Click me')
+    expect(@session.all(:css, 'a#has-been-clicked', minimum: 0)).to be_empty
+  end
+
+  it 'should accept an XPath instance', :exact_false do
     @session.visit('/form')
-    @xpath = XPath::HTML.fillable_field('Name')
-    @result = @session.all(@xpath).map { |r| r.value }
+    @xpath = Capybara::Selector.new(:fillable_field, config: {}, format: :xpath).call('Name')
+    expect(@xpath).to be_a(::XPath::Union)
+    @result = @session.all(@xpath).map(&:value)
     expect(@result).to include('Smith', 'John', 'John Smith')
   end
 
-  it "should raise an error when given invalid options" do
-    expect { @session.all('//p', :schmoo => "foo") }.to raise_error(ArgumentError)
+  it 'should allow reversing the order' do
+    @session.visit('/form')
+    fields = @session.all(:fillable_field, 'Name', exact: false).to_a
+    reverse_fields = @session.all(:fillable_field, 'Name', order: :reverse, exact: false).to_a
+    expect(fields).to eq(reverse_fields.reverse)
+  end
+
+  it 'should raise an error when given invalid options' do
+    expect { @session.all('//p', schmoo: 'foo') }.to raise_error(ArgumentError)
+  end
+
+  it 'should not reload by default', requires: [:driver] do
+    paras = @session.all(:css, 'p', minimum: 3)
+    expect { paras[0].text }.not_to raise_error
+    @session.refresh
+    expect { paras[0].text }.to raise_error do |err|
+      expect(err).to be_an_invalid_element_error(@session)
+    end
+  end
+
+  context 'with allow_reload' do
+    it 'should reload if true' do
+      paras = @session.all(:css, 'p', allow_reload: true, minimum: 3)
+      expect { paras[0].text }.not_to raise_error
+      @session.refresh
+      sleep 1 # Ensure page has started to reload
+      expect(paras[0]).to have_text('Lorem ipsum dolor')
+      expect(paras[1]).to have_text('Duis aute irure dolor')
+    end
+
+    it 'should not reload if false', requires: [:driver] do
+      paras = @session.all(:css, 'p', allow_reload: false, minimum: 3)
+      expect { paras[0].text }.not_to raise_error
+      @session.refresh
+      sleep 1 # Ensure page has started to reload
+      expect { paras[0].text }.to raise_error do |err|
+        expect(err).to be_an_invalid_element_error(@session)
+      end
+      expect { paras[2].text }.to raise_error do |err|
+        expect(err).to be_an_invalid_element_error(@session)
+      end
+    end
   end
 
-  context "with css selectors" do
-    it "should find all elements using the given selector" do
+  context 'with css selectors' do
+    it 'should find all elements using the given selector' do
       expect(@session.all(:css, 'h1').first.text).to eq('This is a test')
-      expect(@session.all(:css, "input[id='test_field']").first[:value]).to eq('monkey')
+      expect(@session.all(:css, "input[id='test_field']").first.value).to eq('monkey')
     end
 
-    it "should find all elements when given a list of selectors" do
+    it 'should find all elements when given a list of selectors' do
       expect(@session.all(:css, 'h1, p').size).to eq(4)
     end
   end
 
-  context "with xpath selectors" do
-    it "should find the first element using the given locator" do
+  context 'with xpath selectors' do
+    it 'should find the first element using the given locator' do
       expect(@session.all(:xpath, '//h1').first.text).to eq('This is a test')
-      expect(@session.all(:xpath, "//input[@id='test_field']").first[:value]).to eq('monkey')
+      expect(@session.all(:xpath, "//input[@id='test_field']").first.value).to eq('monkey')
+    end
+
+    it 'should use alternated regex for :id' do
+      expect(@session.all(:xpath, './/h2', id: /h2/).unfiltered_size).to eq 3
+      expect(@session.all(:xpath, './/h2', id: /h2(one|two)/).unfiltered_size).to eq 2
     end
   end
 
-  context "with css as default selector" do
+  context 'with css as default selector' do
     before { Capybara.default_selector = :css }
-    it "should find the first element using the given locator" do
+
+    it 'should find the first element using the given locator' do
       expect(@session.all('h1').first.text).to eq('This is a test')
-      expect(@session.all("input[id='test_field']").first[:value]).to eq('monkey')
+      expect(@session.all("input[id='test_field']").first.value).to eq('monkey')
     end
   end
 
-  context "with visible filter" do
-    it "should only find visible nodes when true" do
-      expect(@session.all(:css, "a.simple", :visible => true).size).to eq(1)
+  context 'with visible filter' do
+    it 'should only find visible nodes when true' do
+      expect(@session.all(:css, 'a.simple', visible: true).size).to eq(1)
     end
 
-    it "should find nodes regardless of whether they are invisible when false" do
-      expect(@session.all(:css, "a.simple", :visible => false).size).to eq(2)
+    it 'should find nodes regardless of whether they are invisible when false' do
+      expect(@session.all(:css, 'a.simple', visible: false).size).to eq(2)
     end
 
-    it "should default to Capybara.ignore_hidden_elements" do
+    it 'should default to Capybara.ignore_hidden_elements' do
       Capybara.ignore_hidden_elements = true
-      expect(@session.all(:css, "a.simple").size).to eq(1)
+      expect(@session.all(:css, 'a.simple').size).to eq(1)
       Capybara.ignore_hidden_elements = false
-      expect(@session.all(:css, "a.simple").size).to eq(2)
+      expect(@session.all(:css, 'a.simple').size).to eq(2)
+    end
+
+    context 'with per session config', requires: [:psc] do
+      it 'should use the sessions ignore_hidden_elements', psc: true do
+        Capybara.ignore_hidden_elements = true
+        @session.config.ignore_hidden_elements = false
+        expect(Capybara.ignore_hidden_elements).to eq(true)
+        expect(@session.all(:css, 'a.simple').size).to eq(2)
+        @session.config.ignore_hidden_elements = true
+        expect(@session.all(:css, 'a.simple').size).to eq(1)
+      end
+    end
+  end
+
+  context 'with obscured filter', requires: [:css] do
+    it 'should only find nodes on top in the viewport when false' do
+      expect(@session.all(:css, 'a.simple', obscured: false).size).to eq(1)
+    end
+
+    it 'should not find nodes on top outside the viewport when false' do
+      expect(@session.all(:link, 'Download Me', obscured: false).size).to eq(0)
+      @session.scroll_to(@session.find_link('Download Me'))
+      expect(@session.all(:link, 'Download Me', obscured: false).size).to eq(1)
+    end
+
+    it 'should find top nodes outside the viewport when true' do
+      expect(@session.all(:link, 'Download Me', obscured: true).size).to eq(1)
+      @session.scroll_to(@session.find_link('Download Me'))
+      expect(@session.all(:link, 'Download Me', obscured: true).size).to eq(0)
+    end
+
+    it 'should only find non-top nodes when true' do
+      # Also need visible: false so visibility is ignored
+      expect(@session.all(:css, 'a.simple', visible: false, obscured: true).size).to eq(1)
     end
   end
 
   context 'with element count filters' do
     context ':count' do
       it 'should succeed when the number of elements founds matches the expectation' do
-        expect { @session.all(:css, 'h1, p', :count => 4) }.to_not raise_error
+        expect { @session.all(:css, 'h1, p', count: 4) }.not_to raise_error
       end
+
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
-        expect { @session.all(:css, 'h1, p', :count => 5) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.all(:css, 'h1, p', count: 5) }.to raise_error(Capybara::ExpectationNotMet)
       end
     end
+
     context ':minimum' do
       it 'should succeed when the number of elements founds matches the expectation' do
-        expect { @session.all(:css, 'h1, p', :minimum => 0) }.to_not raise_error
+        expect { @session.all(:css, 'h1, p', minimum: 0) }.not_to raise_error
       end
+
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
-        expect { @session.all(:css, 'h1, p', :minimum => 5) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.all(:css, 'h1, p', minimum: 5) }.to raise_error(Capybara::ExpectationNotMet)
       end
     end
+
     context ':maximum' do
       it 'should succeed when the number of elements founds matches the expectation' do
-        expect { @session.all(:css, 'h1, p', :maximum => 4) }.to_not raise_error
+        expect { @session.all(:css, 'h1, p', maximum: 4) }.not_to raise_error
       end
+
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
-        expect { @session.all(:css, 'h1, p', :maximum => 0) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.all(:css, 'h1, p', maximum: 0) }.to raise_error(Capybara::ExpectationNotMet)
       end
     end
+
     context ':between' do
       it 'should succeed when the number of elements founds matches the expectation' do
-        expect { @session.all(:css, 'h1, p', :between => 2..7) }.to_not raise_error
+        expect { @session.all(:css, 'h1, p', between: 2..7) }.not_to raise_error
       end
+
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
-        expect { @session.all(:css, 'h1, p', :between => 0..3) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.all(:css, 'h1, p', between: 0..3) }.to raise_error(Capybara::ExpectationNotMet)
       end
+
+      eval <<~TEST, binding, __FILE__, __LINE__ + 1 if RUBY_VERSION.to_f > 2.5
+        it'treats an endless range as minimum' do
+          expect { @session.all(:css, 'h1, p', between: 2..) }.not_to raise_error
+          expect { @session.all(:css, 'h1, p', between: 5..) }.to raise_error(Capybara::ExpectationNotMet)
+        end
+      TEST
+
+      eval <<~TEST, binding, __FILE__, __LINE__ + 1 if RUBY_VERSION.to_f > 2.6
+        it'treats a beginless range as maximum' do
+          expect { @session.all(:css, 'h1, p', between: ..7) }.not_to raise_error
+          expect { @session.all(:css, 'h1, p', between: ..3) }.to raise_error(Capybara::ExpectationNotMet)
+        end
+      TEST
     end
 
     context 'with multiple count filters' do
       it 'ignores other filters when :count is specified' do
-        o = {:count   => 4,
-             :minimum => 5,
-             :maximum => 0,
-             :between => 0..3}
-        expect { @session.all(:css, 'h1, p', o) }.to_not raise_error
+        o = { count: 4,
+              minimum: 5,
+              maximum: 0,
+              between: 0..3 }
+        expect { @session.all(:css, 'h1, p', **o) }.not_to raise_error
       end
+
       context 'with no :count expectation' do
         it 'fails if :minimum is not met' do
-          o = {:minimum => 5,
-               :maximum => 4,
-               :between => 2..7}
-          expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
+          o = { minimum: 5,
+                maximum: 4,
+                between: 2..7 }
+          expect { @session.all(:css, 'h1, p', **o) }.to raise_error(Capybara::ExpectationNotMet)
         end
+
         it 'fails if :maximum is not met' do
-          o = {:minimum => 0,
-               :maximum => 0,
-               :between => 2..7}
-          expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
+          o = { minimum: 0,
+                maximum: 0,
+                between: 2..7 }
+          expect { @session.all(:css, 'h1, p', **o) }.to raise_error(Capybara::ExpectationNotMet)
         end
+
         it 'fails if :between is not met' do
-          o = {:minimum => 0,
-               :maximum => 4,
-               :between => 0..3}
-          expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
+          o = { minimum: 0,
+                maximum: 4,
+                between: 0..3 }
+          expect { @session.all(:css, 'h1, p', **o) }.to raise_error(Capybara::ExpectationNotMet)
         end
+
         it 'succeeds if all combineable expectations are met' do
-          o = {:minimum => 0,
-               :maximum => 4,
-               :between => 2..7}
-          expect { @session.all(:css, 'h1, p', o) }.to_not raise_error
+          o = { minimum: 0,
+                maximum: 4,
+                between: 2..7 }
+          expect { @session.all(:css, 'h1, p', **o) }.not_to raise_error
         end
       end
     end
   end
 
-  context "within a scope" do
+  context 'within a scope' do
     before do
       @session.visit('/with_scope')
     end
 
-    it "should find any element using the given locator" do
+    it 'should find any element using the given locator' do
       @session.within(:xpath, "//div[@id='for_bar']") do
         expect(@session.all('.//li').size).to eq(2)
       end
     end
   end
 
-  it "should have #find_all as an alias" do
+  it 'should have #find_all as an alias' do
     expect(Capybara::Node::Finders.instance_method(:all)).to eq Capybara::Node::Finders.instance_method(:find_all)
     expect(@session.find_all('//p').size).to eq(3)
   end

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#ancestor' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  after do
+    Capybara::Selector.remove(:monkey)
+  end
+
+  it 'should find the ancestor element using the given locator' do
+    el = @session.find(:css, '#first_image')
+    expect(el.ancestor('//p')).to have_text('Lorem ipsum dolor')
+    expect(el.ancestor('//a')[:'aria-label']).to eq('Go to simple')
+  end
+
+  it 'should find the ancestor element using the given locator and options' do
+    el = @session.find(:css, '#child')
+    expect(el.ancestor('//div', text: "Ancestor\nAncestor\nAncestor")[:id]).to eq('ancestor3')
+  end
+
+  it 'should find the closest ancestor' do
+    el = @session.find(:css, '#child')
+    expect(el.ancestor('.//div', order: :reverse, match: :first)[:id]).to eq('ancestor1')
+  end
+
+  it 'should raise an error if there are multiple matches' do
+    el = @session.find(:css, '#child')
+    expect { el.ancestor('//div') }.to raise_error(Capybara::Ambiguous)
+    expect { el.ancestor('//div', text: 'Ancestor') }.to raise_error(Capybara::Ambiguous)
+  end
+
+  context 'with css selectors' do
+    it 'should find the first element using the given locator' do
+      el = @session.find(:css, '#first_image')
+      expect(el.ancestor(:css, 'p')).to have_text('Lorem ipsum dolor')
+      expect(el.ancestor(:css, 'a')[:'aria-label']).to eq('Go to simple')
+    end
+
+    it 'should support pseudo selectors' do
+      el = @session.find(:css, '#button_img')
+      expect(el.ancestor(:css, 'button:disabled')[:id]).to eq('ancestor_button')
+    end
+  end
+
+  context 'with xpath selectors' do
+    it 'should find the first element using the given locator' do
+      el = @session.find(:css, '#first_image')
+      expect(el.ancestor(:xpath, '//p')).to have_text('Lorem ipsum dolor')
+      expect(el.ancestor(:xpath, '//a')[:'aria-label']).to eq('Go to simple')
+    end
+  end
+
+  context 'with custom selector' do
+    it 'should use the custom selector' do
+      Capybara.add_selector(:level) do
+        xpath { |num| ".//*[@id='ancestor#{num}']" }
+      end
+      el = @session.find(:css, '#child')
+      expect(el.ancestor(:level, 1)[:id]).to eq 'ancestor1'
+      expect(el.ancestor(:level, 3)[:id]).to eq 'ancestor3'
+    end
+  end
+
+  it 'should raise ElementNotFound with a useful default message if nothing was found' do
+    el = @session.find(:css, '#child')
+    expect do
+      el.ancestor(:xpath, '//div[@id="nosuchthing"]')
+    end.to raise_error(Capybara::ElementNotFound, 'Unable to find xpath "//div[@id=\\"nosuchthing\\"]" that is an ancestor of visible css "#child"')
+  end
+
+  context 'within a scope' do
+    it 'should limit the ancestors to inside the scope' do
+      @session.within(:css, '#ancestor2') do
+        el = @session.find(:css, '#child')
+        expect(el.ancestor(:css, 'div', text: 'Ancestor')[:id]).to eq('ancestor1')
+      end
+    end
+  end
+
+  it 'should raise if selector type is unknown' do
+    el = @session.find(:css, '#child')
+    expect do
+      el.ancestor(:unknown, '//h1')
+    end.to raise_error(ArgumentError)
+  end
+end

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

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#assert_all_of_selectors' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  it 'should be true if the given selectors are on the page' do
+    @session.assert_all_of_selectors(:css, 'p a#foo', 'h2#h2one', 'h2#h2two')
+  end
+
+  it 'should be false if any of the given selectors are not on the page' do
+    expect { @session.assert_all_of_selectors(:css, 'p a#foo', 'h2#h2three', 'h2#h2one') }.to raise_error(Capybara::ElementNotFound)
+  end
+
+  it 'should use default selector' do
+    Capybara.default_selector = :css
+    expect { @session.assert_all_of_selectors('p a#foo', 'h2#h2three', 'h2#h2one') }.to raise_error(Capybara::ElementNotFound)
+    @session.assert_all_of_selectors('p a#foo', 'h2#h2two', 'h2#h2one')
+  end
+
+  it 'should support filter block' do
+    expect { @session.assert_all_of_selectors(:css, 'h2#h2one', 'h2#h2two') { |n| n[:id] == 'h2one' } }.to raise_error(Capybara::ElementNotFound, /custom filter block/)
+  end
+
+  context 'should respect scopes' do
+    it 'when used with `within`' do
+      @session.within "//p[@id='first']" do
+        @session.assert_all_of_selectors(".//a[@id='foo']")
+        expect { @session.assert_all_of_selectors(".//a[@id='red']") }.to raise_error(Capybara::ElementNotFound)
+      end
+    end
+
+    it 'when called on elements' do
+      el = @session.find "//p[@id='first']"
+      el.assert_all_of_selectors(".//a[@id='foo']")
+      expect { el.assert_all_of_selectors(".//a[@id='red']") }.to raise_error(Capybara::ElementNotFound)
+    end
+  end
+
+  context 'with options' do
+    it 'should apply options to all locators' do
+      @session.assert_all_of_selectors(:field, 'normal', 'additional_newline', type: :textarea)
+      expect { @session.assert_all_of_selectors(:field, 'normal', 'test_field', 'additional_newline', type: :textarea) }.to raise_error(Capybara::ElementNotFound)
+    end
+  end
+
+  context 'with wait', requires: [:js] do
+    it 'should not raise error if all the elements appear before given wait duration' do
+      Capybara.using_wait_time(0.1) do
+        @session.visit('/with_js')
+        @session.click_link('Click me')
+        @session.assert_all_of_selectors(:css, 'a#clickable', 'a#has-been-clicked', '#drag', wait: 1.5)
+      end
+    end
+  end
+end
+
+Capybara::SpecHelper.spec '#assert_none_of_selectors' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  it 'should be false if any of the given locators are on the page' do
+    expect { @session.assert_none_of_selectors(:xpath, '//p', '//a') }.to raise_error(Capybara::ElementNotFound)
+    expect { @session.assert_none_of_selectors(:xpath, '//abbr', '//a') }.to raise_error(Capybara::ElementNotFound)
+    expect { @session.assert_none_of_selectors(:css, 'p a#foo') }.to raise_error(Capybara::ElementNotFound)
+  end
+
+  it 'should be true if none of the given locators are on the page' do
+    @session.assert_none_of_selectors(:xpath, '//abbr', '//td')
+    @session.assert_none_of_selectors(:css, 'p a#doesnotexist', 'abbr')
+  end
+
+  it 'should use default selector' do
+    Capybara.default_selector = :css
+    @session.assert_none_of_selectors('p a#doesnotexist', 'abbr')
+    expect { @session.assert_none_of_selectors('abbr', 'p a#foo') }.to raise_error(Capybara::ElementNotFound)
+  end
+
+  context 'should respect scopes' do
+    it 'when used with `within`' do
+      @session.within "//p[@id='first']" do
+        expect { @session.assert_none_of_selectors(".//a[@id='foo']") }.to raise_error(Capybara::ElementNotFound)
+        @session.assert_none_of_selectors(".//a[@id='red']")
+      end
+    end
+
+    it 'when called on an element' do
+      el = @session.find "//p[@id='first']"
+      expect { el.assert_none_of_selectors(".//a[@id='foo']") }.to raise_error(Capybara::ElementNotFound)
+      el.assert_none_of_selectors(".//a[@id='red']")
+    end
+  end
+
+  context 'with options' do
+    it 'should apply the options to all locators' do
+      expect { @session.assert_none_of_selectors('//p//a', text: 'Redirect') }.to raise_error(Capybara::ElementNotFound)
+      @session.assert_none_of_selectors('//p', text: 'Doesnotexist')
+    end
+
+    it 'should discard all matches where the given regexp is matched' do
+      expect { @session.assert_none_of_selectors('//p//a', text: /re[dab]i/i, count: 1) }.to raise_error(Capybara::ElementNotFound)
+      @session.assert_none_of_selectors('//p//a', text: /Red$/)
+    end
+  end
+
+  context 'with wait', requires: [:js] do
+    it 'should not find elements if they appear after given wait duration' do
+      @session.visit('/with_js')
+      @session.click_link('Click me')
+      @session.assert_none_of_selectors(:css, '#new_field', 'a#has-been-clicked', wait: 0.1)
+    end
+  end
+end
+
+Capybara::SpecHelper.spec '#assert_any_of_selectors' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  it 'should be true if any of the given selectors are on the page' do
+    @session.assert_any_of_selectors(:css, 'a#foo', 'h2#h2three')
+    @session.assert_any_of_selectors(:css, 'h2#h2three', 'a#foo')
+  end
+
+  it 'should be false if none of the given selectors are on the page' do
+    expect { @session.assert_any_of_selectors(:css, 'h2#h2three', 'h4#h4four') }.to raise_error(Capybara::ElementNotFound)
+  end
+
+  it 'should use default selector' do
+    Capybara.default_selector = :css
+    expect { @session.assert_any_of_selectors('h2#h2three', 'h5#h5five') }.to raise_error(Capybara::ElementNotFound)
+    @session.assert_any_of_selectors('p a#foo', 'h2#h2two', 'h2#h2one')
+  end
+
+  it 'should support filter block' do
+    expect { @session.assert_any_of_selectors(:css, 'h2#h2one', 'h2#h2two') { |_n| false } }.to raise_error(Capybara::ElementNotFound, /custom filter block/)
+  end
+end