capybara 2.7.0 → 3.35.3

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

@@ -1,29 +1,48 @@
+# frozen_string_literal: true
+
 Capybara::SpecHelper.spec Capybara::Selector do
   before do
     @session.visit('/form')
   end
 
-  describe ":label selector" do
-    it "finds a label by text" do
+  describe ':label selector' do
+    it 'finds a label by text' do
       expect(@session.find(:label, 'Customer Name').text).to eq 'Customer Name'
     end
 
-    it "finds a label by for attribute string" do
+    it 'finds a label by for attribute string' do
       expect(@session.find(:label, for: 'form_other_title')['for']).to eq 'form_other_title'
     end
 
-    it "finds a label from nested input using :for filter" do
+    it 'finds a label for for attribute regex' do
+      expect(@session.find(:label, for: /_other_title/)['for']).to eq 'form_other_title'
+    end
+
+    it 'finds a label from nested input using :for filter with id string' do
+      expect(@session.find(:label, for: 'nested_label').text).to eq 'Nested Label'
+    end
+
+    it 'finds a label from nested input using :for filter with id regexp' do
+      expect(@session.find(:label, for: /nested_lab/).text).to eq 'Nested Label'
+    end
+
+    it 'finds a label from nested input using :for filter with element' do
       input = @session.find(:id, 'nested_label')
       expect(@session.find(:label, for: input).text).to eq 'Nested Label'
     end
 
-    it "finds the label for an non-nested element when using :for filter" do
+    it 'finds a label from nested input using :for filter with element when no id on label' do
+      input = @session.find(:css, '#wrapper_label').find(:css, 'input')
+      expect(@session.find(:label, for: input).text).to eq 'Wrapper Label'
+    end
+
+    it 'finds the label for an non-nested element when using :for filter' do
       select = @session.find(:id, 'form_other_title')
       expect(@session.find(:label, for: select)['for']).to eq 'form_other_title'
     end
 
-    context "with exact option" do
-      it "matches substrings" do
+    context 'with exact option' do
+      it 'matches substrings' do
         expect(@session.find(:label, 'Customer Na', exact: false).text).to eq 'Customer Name'
       end
 
@@ -32,4 +51,48 @@ Capybara::SpecHelper.spec Capybara::Selector do
       end
     end
   end
-end
+
+  describe 'field selectors' do
+    context 'with :id option' do
+      it 'can find specifically by id' do
+        expect(@session.find(:field, id: 'customer_email').value).to eq 'ben@ben.com'
+      end
+
+      it 'can find by regex' do
+        expect(@session.find(:field, id: /ustomer.emai/).value).to eq 'ben@ben.com'
+      end
+
+      it 'can find by case-insensitive id' do
+        expect(@session.find(:field, id: /StOmer.emAI/i).value).to eq 'ben@ben.com'
+      end
+    end
+
+    it 'can find specifically by name string' do
+      expect(@session.find(:field, name: 'form[other_title]')['id']).to eq 'form_other_title'
+    end
+
+    it 'can find specifically by name regex' do
+      expect(@session.find(:field, name: /form\[other_.*\]/)['id']).to eq 'form_other_title'
+    end
+
+    it 'can find specifically by placeholder string' do
+      expect(@session.find(:field, placeholder: 'FirstName')['id']).to eq 'form_first_name'
+    end
+
+    it 'can find specifically by placeholder regex' do
+      expect(@session.find(:field, placeholder: /FirstN.*/)['id']).to eq 'form_first_name'
+    end
+
+    it 'can find by type' do
+      expect(@session.find(:field, 'Confusion', type: 'checkbox')['id']).to eq 'confusion_checkbox'
+      expect(@session.find(:field, 'Confusion', type: 'text')['id']).to eq 'confusion_text'
+      expect(@session.find(:field, 'Confusion', type: 'textarea')['id']).to eq 'confusion_textarea'
+    end
+
+    it 'can find by class' do
+      expect(@session.find(:field, class: 'confusion-checkbox')['id']).to eq 'confusion_checkbox'
+      expect(@session).to have_selector(:field, class: 'confusion', count: 3)
+      expect(@session.find(:field, class: %w[confusion confusion-textarea])['id']).to eq 'confusion_textarea'
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#sibling' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  after do
+    Capybara::Selector.remove(:monkey)
+  end
+
+  it 'should find a prior sibling element using the given locator' do
+    el = @session.find(:css, '#mid_sibling')
+    expect(el.sibling('//div[@data-pre]')[:id]).to eq('pre_sibling')
+  end
+
+  it 'should find a following sibling element using the given locator' do
+    el = @session.find(:css, '#mid_sibling')
+    expect(el.sibling('//div[@data-post]')[:id]).to eq('post_sibling')
+  end
+
+  it 'should raise an error if there are multiple matches' do
+    el = @session.find(:css, '#mid_sibling')
+    expect { el.sibling('//div') }.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, '#mid_sibling')
+      expect(el.sibling(:css, '#pre_sibling')).to have_text('Pre Sibling')
+      expect(el.sibling(:css, '#post_sibling')).to have_text('Post Sibling')
+    end
+  end
+
+  context 'with custom selector' do
+    it 'should use the custom selector' do
+      Capybara.add_selector(:data_attribute) do
+        xpath { |attr| ".//*[@data-#{attr}]" }
+      end
+      el = @session.find(:css, '#mid_sibling')
+      expect(el.sibling(:data_attribute, 'pre').text).to eq('Pre Sibling')
+      expect(el.sibling(:data_attribute, 'post').text).to eq('Post Sibling')
+    end
+  end
+
+  it 'should raise ElementNotFound with a useful default message if nothing was found' do
+    el = @session.find(:css, '#child')
+    expect do
+      el.sibling(:xpath, '//div[@id="nosuchthing"]')
+    end.to raise_error(Capybara::ElementNotFound, 'Unable to find xpath "//div[@id=\\"nosuchthing\\"]" that is a sibling of visible css "#child"')
+  end
+end

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

@@ -1,59 +1,74 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#text' do
-  it "should print the text of the page" do
+  it 'should print the text of the page' do
     @session.visit('/with_simple_html')
     expect(@session.text).to eq('Bar')
   end
 
-  it "ignores invisible text by default" do
+  it 'ignores invisible text by default' do
     @session.visit('/with_html')
-    expect(@session.find(:id, "hidden-text").text).to eq('Some of this text is')
+    expect(@session.find(:id, 'hidden-text').text).to eq('Some of this text is')
   end
 
-  it "shows invisible text if `:all` given" do
+  it 'shows invisible text if `:all` given' do
     @session.visit('/with_html')
-    expect(@session.find(:id, "hidden-text").text(:all)).to eq('Some of this text is hidden!')
+    expect(@session.find(:id, 'hidden-text').text(:all)).to eq('Some of this text is hidden!')
   end
 
-  it "ignores invisible text if `:visible` given" do
+  it 'ignores invisible text if `:visible` given' do
     Capybara.ignore_hidden_elements = false
     @session.visit('/with_html')
-    expect(@session.find(:id, "hidden-text").text(:visible)).to eq('Some of this text is')
+    expect(@session.find(:id, 'hidden-text').text(:visible)).to eq('Some of this text is')
   end
 
-  it "ignores invisible text if `Capybara.ignore_hidden_elements = true`" do
+  it 'ignores invisible text if `Capybara.ignore_hidden_elements = true`' do
     @session.visit('/with_html')
-    expect(@session.find(:id, "hidden-text").text).to eq('Some of this text is')
+    expect(@session.find(:id, 'hidden-text').text).to eq('Some of this text is')
     Capybara.ignore_hidden_elements = false
-    expect(@session.find(:id, "hidden-text").text).to eq('Some of this text is hidden!')
+    expect(@session.find(:id, 'hidden-text').text).to eq('Some of this text is hidden!')
   end
 
-  it "ignores invisible text if `Capybara.visible_text_only = true`" do
+  it 'ignores invisible text if `Capybara.visible_text_only = true`' do
     @session.visit('/with_html')
     Capybara.visible_text_only = true
-    expect(@session.find(:id, "hidden-text").text).to eq('Some of this text is')
+    expect(@session.find(:id, 'hidden-text').text).to eq('Some of this text is')
     Capybara.ignore_hidden_elements = false
-    expect(@session.find(:id, "hidden-text").text).to eq('Some of this text is')
+    expect(@session.find(:id, 'hidden-text').text).to eq('Some of this text is')
   end
-  
-  it "ignores invisible text if ancestor is invisible" do
+
+  it 'ignores invisible text if ancestor is invisible' do
     @session.visit('/with_html')
-    expect(@session.find(:id, "hidden_via_ancestor", visible: false).text).to eq('')
+    expect(@session.find(:id, 'hidden_via_ancestor', visible: false).text).to eq('')
   end
 
-  context "with css as default selector" do
+  context 'with css as default selector' do
     before { Capybara.default_selector = :css }
-    it "should print the text of the page" do
+
+    after { Capybara.default_selector = :xpath }
+
+    it 'should print the text of the page' do
       @session.visit('/with_simple_html')
       expect(@session.text).to eq('Bar')
     end
-    after { Capybara.default_selector = :xpath }
   end
 
-  it "should strip whitespace" do
+  it 'should be correctly normalized when visible' do
+    @session.visit('/with_html')
+    el = @session.find(:css, '#normalized')
+    expect(el.text).to eq "Some text\nMore text\nAnd more text\nEven more    text on multiple lines"
+  end
+
+  it 'should be a textContent with irrelevant whitespace collapsed when non-visible' do
+    @session.visit('/with_html')
+    el = @session.find(:css, '#non_visible_normalized', visible: false)
+    expect(el.text(:all)).to eq 'Some textMore text And more text Even more    text on multiple lines'
+  end
+
+  it 'should strip correctly' do
     @session.visit('/with_html')
-    n = @session.find(:css, '#second')
-    expect(@session.find(:css, '#second').text).to match \
-      /\ADuis aute .* text with whitespace .* est laborum\.\z/
+    el = @session.find(:css, '#ws')
+    expect(el.text).to eq ' '
+    expect(el.text(:all)).to eq ' '
   end
 end

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

@@ -1,17 +1,29 @@
 # frozen_string_literal: true
-Capybara::SpecHelper.spec '#title' do
 
-  it "should get the title of the page" do
+Capybara::SpecHelper.spec '#title' do
+  it 'should get the title of the page' do
     @session.visit('/with_title')
     expect(@session.title).to eq('Test Title')
   end
 
-  context "with css as default selector" do
+  context 'with css as default selector' do
     before { Capybara.default_selector = :css }
-    it "should get the title of the page" do
+
+    after { Capybara.default_selector = :xpath }
+
+    it 'should get the title of the page' do
       @session.visit('/with_title')
       expect(@session.title).to eq('Test Title')
     end
-    after { Capybara.default_selector = :xpath }
+  end
+
+  context 'within iframe', requires: [:frames] do
+    it 'should get the title of the top level browsing context' do
+      @session.visit('/within_frames')
+      expect(@session.title).to eq('With Frames')
+      @session.within_frame('frameOne') do
+        expect(@session.title).to eq('With Frames')
+      end
+    end
   end
 end

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

@@ -1,41 +1,100 @@
 # frozen_string_literal: true
-Capybara::SpecHelper.spec "#uncheck" do
+
+Capybara::SpecHelper.spec '#uncheck' do
   before do
     @session.visit('/form')
   end
 
-  it "should uncheck a checkbox by id" do
-    @session.uncheck("form_pets_hamster")
+  it 'should uncheck a checkbox by id' do
+    @session.uncheck('form_pets_hamster')
+    @session.click_button('awesome')
+    expect(extract_results(@session)['pets']).to include('dog')
+    expect(extract_results(@session)['pets']).not_to include('hamster')
+  end
+
+  it 'should uncheck a checkbox by label' do
+    @session.uncheck('Hamster')
+    @session.click_button('awesome')
+    expect(extract_results(@session)['pets']).to include('dog')
+    expect(extract_results(@session)['pets']).not_to include('hamster')
+  end
+
+  it 'should work without a locator string' do
+    @session.uncheck(id: 'form_pets_hamster')
     @session.click_button('awesome')
     expect(extract_results(@session)['pets']).to include('dog')
     expect(extract_results(@session)['pets']).not_to include('hamster')
   end
 
-  it "should uncheck a checkbox by label" do
-    @session.uncheck("Hamster")
+  it 'should be able to uncheck itself if no locator specified' do
+    cb = @session.find(:id, 'form_pets_hamster')
+    cb.uncheck
     @session.click_button('awesome')
     expect(extract_results(@session)['pets']).to include('dog')
     expect(extract_results(@session)['pets']).not_to include('hamster')
   end
 
-  it "casts to string" do
-    @session.uncheck(:"form_pets_hamster")
+  it 'casts to string' do
+    @session.uncheck(:form_pets_hamster)
     @session.click_button('awesome')
     expect(extract_results(@session)['pets']).to include('dog')
     expect(extract_results(@session)['pets']).not_to include('hamster')
   end
 
-  context "with :exact option" do
-    it "should accept partial matches when false" do
-      @session.uncheck('Ham', :exact => false)
+  context 'with :exact option' do
+    it 'should accept partial matches when false' do
+      @session.uncheck('Ham', exact:  false)
       @session.click_button('awesome')
       expect(extract_results(@session)['pets']).not_to include('hamster')
     end
 
-    it "should not accept partial matches when true" do
+    it 'should not accept partial matches when true' do
       expect do
-        @session.uncheck('Ham', :exact => true)
+        @session.uncheck('Ham', exact:  true)
       end.to raise_error(Capybara::ElementNotFound)
     end
   end
+
+  context 'when checkbox hidden' do
+    context 'with Capybara.automatic_label_click == true' do
+      around do |spec|
+        old_click_label, Capybara.automatic_label_click = Capybara.automatic_label_click, true
+        spec.run
+        Capybara.automatic_label_click = old_click_label
+      end
+
+      it 'should uncheck via clicking the label with :for attribute if possible' do
+        expect(@session.find(:checkbox, 'form_cars_jaguar', checked: true, visible: :hidden)).to be_truthy
+        @session.uncheck('form_cars_jaguar')
+        @session.click_button('awesome')
+        expect(extract_results(@session)['cars']).not_to include('jaguar')
+      end
+
+      it 'should uncheck via clicking the wrapping label if possible' do
+        expect(@session.find(:checkbox, 'form_cars_koenigsegg', checked: true, visible: :hidden)).to be_truthy
+        @session.uncheck('form_cars_koenigsegg')
+        @session.click_button('awesome')
+        expect(extract_results(@session)['cars']).not_to include('koenigsegg')
+      end
+
+      it 'should not click the label if unneeded' do
+        expect(@session.find(:checkbox, 'form_cars_tesla', unchecked: true, visible: :hidden)).to be_truthy
+        @session.uncheck('form_cars_tesla')
+        @session.click_button('awesome')
+        expect(extract_results(@session)['cars']).not_to include('tesla')
+      end
+
+      it 'should raise original error when no label available' do
+        expect { @session.uncheck('form_cars_porsche') }.to raise_error(Capybara::ElementNotFound, /Unable to find visible checkbox "form_cars_porsche"/)
+      end
+
+      it 'should raise error if not allowed to click label' do
+        expect { @session.uncheck('form_cars_jaguar', allow_label_click: false) }.to raise_error(Capybara::ElementNotFound, /Unable to find visible checkbox "form_cars_jaguar"/)
+      end
+
+      it 'should include node filter description in error if necessary' do
+        expect { @session.uncheck('form_cars_maserati', allow_label_click: false) }.to raise_error(Capybara::ElementNotFound, 'Unable to find visible checkbox "form_cars_maserati" that is not disabled')
+      end
+    end
+  end
 end

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

@@ -1,113 +1,114 @@
 # frozen_string_literal: true
-Capybara::SpecHelper.spec "#unselect" do
+
+Capybara::SpecHelper.spec '#unselect' do
   before do
     @session.visit('/form')
   end
 
-  context "with multiple select" do
-    it "should unselect an option from a select box by id" do
-      @session.unselect('Commando', :from => 'form_underwear')
+  context 'with multiple select' do
+    it 'should unselect an option from a select box by id' do
+      @session.unselect('Commando', from: 'form_underwear')
       @session.click_button('awesome')
       expect(extract_results(@session)['underwear']).to include('Briefs', 'Boxerbriefs')
       expect(extract_results(@session)['underwear']).not_to include('Commando')
     end
 
-    it "should unselect an option without a select box" do
+    it 'should unselect an option without a select box' do
       @session.unselect('Commando')
       @session.click_button('awesome')
       expect(extract_results(@session)['underwear']).to include('Briefs', 'Boxerbriefs')
       expect(extract_results(@session)['underwear']).not_to include('Commando')
     end
 
-    it "should unselect an option from a select box by label" do
-      @session.unselect('Commando', :from => 'Underwear')
+    it 'should unselect an option from a select box by label' do
+      @session.unselect('Commando', from: 'Underwear')
       @session.click_button('awesome')
       expect(extract_results(@session)['underwear']).to include('Briefs', 'Boxerbriefs')
       expect(extract_results(@session)['underwear']).not_to include('Commando')
     end
 
-    it "should favour exact matches to option labels" do
-      @session.unselect("Briefs", :from => 'Underwear')
+    it 'should favour exact matches to option labels' do
+      @session.unselect('Briefs', from: 'Underwear')
       @session.click_button('awesome')
       expect(extract_results(@session)['underwear']).to include('Commando', 'Boxerbriefs')
       expect(extract_results(@session)['underwear']).not_to include('Briefs')
     end
 
-    it "should escape quotes" do
-      @session.unselect("Frenchman's Pantalons", :from => 'Underwear')
+    it 'should escape quotes' do
+      @session.unselect("Frenchman's Pantalons", from: 'Underwear')
       @session.click_button('awesome')
       expect(extract_results(@session)['underwear']).not_to include("Frenchman's Pantalons")
     end
 
-    it "casts to string" do
-      @session.unselect(:"Briefs", :from => :'Underwear')
+    it 'casts to string' do
+      @session.unselect(:Briefs, from: :Underwear)
       @session.click_button('awesome')
       expect(extract_results(@session)['underwear']).to include('Commando', 'Boxerbriefs')
       expect(extract_results(@session)['underwear']).not_to include('Briefs')
     end
   end
 
-  context "with single select" do
-    it "should raise an error" do
-      expect { @session.unselect("English", :from => 'form_locale') }.to raise_error(Capybara::UnselectNotAllowed)
+  context 'with single select' do
+    it 'should raise an error' do
+      expect { @session.unselect('English', from: 'form_locale') }.to raise_error(Capybara::UnselectNotAllowed)
     end
   end
 
   context "with a locator that doesn't exist" do
-    it "should raise an error" do
-      msg = "Unable to find select box \"does not exist\""
+    it 'should raise an error' do
+      msg = /Unable to find select box "does not exist"/
       expect do
-        @session.unselect('foo', :from => 'does not exist')
+        @session.unselect('foo', from: 'does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)
     end
   end
 
   context "with an option that doesn't exist" do
-    it "should raise an error" do
-      msg = "Unable to find option \"Does not Exist\""
+    it 'should raise an error' do
+      msg = /^Unable to find option "Does not Exist" within/
       expect do
-        @session.unselect('Does not Exist', :from => 'form_underwear')
+        @session.unselect('Does not Exist', from: 'form_underwear')
       end.to raise_error(Capybara::ElementNotFound, msg)
     end
   end
 
-  context "with :exact option" do
-    context "when `false`" do
-      it "can match select box approximately" do
-        @session.unselect("Boxerbriefs", :from => "Under", :exact => false)
-        @session.click_button("awesome")
-        expect(extract_results(@session)["underwear"]).not_to include("Boxerbriefs")
+  context 'with :exact option' do
+    context 'when `false`' do
+      it 'can match select box approximately' do
+        @session.unselect('Boxerbriefs', from: 'Under', exact: false)
+        @session.click_button('awesome')
+        expect(extract_results(@session)['underwear']).not_to include('Boxerbriefs')
       end
 
-      it "can match option approximately" do
-        @session.unselect("Boxerbr", :from => "Underwear", :exact => false)
-        @session.click_button("awesome")
-        expect(extract_results(@session)["underwear"]).not_to include("Boxerbriefs")
+      it 'can match option approximately' do
+        @session.unselect('Boxerbr', from: 'Underwear', exact: false)
+        @session.click_button('awesome')
+        expect(extract_results(@session)['underwear']).not_to include('Boxerbriefs')
       end
 
-      it "can match option approximately when :from not given" do
-        @session.unselect("Boxerbr", :exact => false)
-        @session.click_button("awesome")
-        expect(extract_results(@session)["underwear"]).not_to include("Boxerbriefs")
+      it 'can match option approximately when :from not given' do
+        @session.unselect('Boxerbr', exact: false)
+        @session.click_button('awesome')
+        expect(extract_results(@session)['underwear']).not_to include('Boxerbriefs')
       end
     end
 
-    context "when `true`" do
-      it "can match select box approximately" do
+    context 'when `true`' do
+      it 'can match select box approximately' do
         expect do
-          @session.unselect("Boxerbriefs", :from => "Under", :exact => true)
+          @session.unselect('Boxerbriefs', from: 'Under', exact:  true)
         end.to raise_error(Capybara::ElementNotFound)
       end
 
-      it "can match option approximately" do
+      it 'can match option approximately' do
         expect do
-          @session.unselect("Boxerbr", :from => "Underwear", :exact => true)
+          @session.unselect('Boxerbr', from: 'Underwear', exact:  true)
         end.to raise_error(Capybara::ElementNotFound)
       end
 
-      it "can match option approximately when :from not given" do
+      it 'can match option approximately when :from not given' do
         expect do
-          @session.unselect("Boxerbr", :exact => true)
+          @session.unselect('Boxerbr', exact: true)
         end.to raise_error(Capybara::ElementNotFound)
       end
     end