capybara 3.0.0 → 3.40.0

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#scroll_to', requires: [:scroll] do
+  before do
+    @session.visit('/scroll')
+  end
+
+  it 'can scroll an element to the top of the viewport' do
+    el = @session.find(:css, '#scroll')
+    @session.scroll_to(el, align: :top)
+    expect(el.evaluate_script('this.getBoundingClientRect().top')).to be_within(1).of(0)
+  end
+
+  it 'can scroll an element to the bottom of the viewport' do
+    el = @session.find(:css, '#scroll')
+    @session.scroll_to(el, align: :bottom)
+    el_bottom = el.evaluate_script('this.getBoundingClientRect().bottom')
+    viewport_bottom = el.evaluate_script('document.documentElement.clientHeight')
+    expect(el_bottom).to be_within(1).of(viewport_bottom)
+  end
+
+  it 'can scroll an element to the center of the viewport' do
+    el = @session.find(:css, '#scroll')
+    @session.scroll_to(el, align: :center)
+    el_center = el.evaluate_script('(function(rect){return (rect.top + rect.bottom)/2})(this.getBoundingClientRect())')
+    viewport_bottom = el.evaluate_script('document.documentElement.clientHeight')
+    expect(el_center).to be_within(2).of(viewport_bottom / 2)
+  end
+
+  it 'can scroll the window to the vertical top' do
+    @session.scroll_to :bottom
+    @session.scroll_to :top
+    expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [0, 0]
+  end
+
+  it 'can scroll the window to the vertical bottom' do
+    @session.scroll_to :bottom
+    max_scroll = @session.evaluate_script('document.documentElement.scrollHeight - document.documentElement.clientHeight')
+    scrolled_location_x, scrolled_location_y = @session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')
+    expect(scrolled_location_x).to be_within(0.5).of(0)
+    expect(scrolled_location_y).to be_within(0.5).of(max_scroll)
+  end
+
+  it 'can scroll the window to the vertical center' do
+    @session.scroll_to :center
+    max_scroll = @session.evaluate_script('document.documentElement.scrollHeight - document.documentElement.clientHeight')
+    expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [0, max_scroll / 2]
+  end
+
+  it 'can scroll the window to specific location' do
+    @session.scroll_to 100, 100
+    expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [100, 100]
+  end
+
+  it 'can scroll an element to the top of the scrolling element' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    el = scrolling_element.find(:css, '#inner')
+    scrolling_element.scroll_to(el, align: :top)
+    scrolling_element_top = scrolling_element.evaluate_script('this.getBoundingClientRect().top')
+    expect(el.evaluate_script('this.getBoundingClientRect().top')).to be_within(3).of(scrolling_element_top)
+  end
+
+  it 'can scroll an element to the bottom of the scrolling element' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    el = scrolling_element.find(:css, '#inner')
+    scrolling_element.scroll_to(el, align: :bottom)
+    el_bottom = el.evaluate_script('this.getBoundingClientRect().bottom')
+    scroller_bottom = scrolling_element.evaluate_script('this.getBoundingClientRect().top + this.clientHeight')
+    expect(el_bottom).to be_within(1).of(scroller_bottom)
+  end
+
+  it 'can scroll an element to the center of the scrolling element' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    el = scrolling_element.find(:css, '#inner')
+    scrolling_element.scroll_to(el, align: :center)
+    el_center = el.evaluate_script('(function(rect){return (rect.top + rect.bottom)/2})(this.getBoundingClientRect())')
+    scrollable_center = scrolling_element.evaluate_script('(this.clientHeight / 2) + this.getBoundingClientRect().top')
+    expect(el_center).to be_within(1).of(scrollable_center)
+  end
+
+  it 'can scroll the scrolling element to the top' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    scrolling_element.scroll_to :bottom
+    scrolling_element.scroll_to :top
+    expect(scrolling_element.evaluate_script('[this.scrollLeft, this.scrollTop]')).to eq [0, 0]
+  end
+
+  it 'can scroll the scrolling element to the bottom' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    scrolling_element.scroll_to :bottom
+    max_scroll = scrolling_element.evaluate_script('this.scrollHeight - this.clientHeight')
+    expect(scrolling_element.evaluate_script('[this.scrollLeft, this.scrollTop]')).to eq [0, max_scroll]
+  end
+
+  it 'can scroll the scrolling element to the vertical center' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    scrolling_element.scroll_to :center
+    max_scroll = scrolling_element.evaluate_script('this.scrollHeight - this.clientHeight')
+    expect(scrolling_element.evaluate_script('[this.scrollLeft, this.scrollTop]')).to eq [0, max_scroll / 2]
+  end
+
+  it 'can scroll the scrolling element to specific location' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    scrolling_element.scroll_to 100, 100
+    expect(scrolling_element.evaluate_script('[this.scrollLeft, this.scrollTop]')).to eq [100, 100]
+  end
+
+  it 'can scroll the window by a specific amount' do
+    @session.scroll_to(:current, offset: [50, 75])
+    expect(@session.evaluate_script('[window.scrollX || window.pageXOffset, window.scrollY || window.pageYOffset]')).to eq [50, 75]
+  end
+
+  it 'can scroll the scroll the scrolling element by a specific amount' do
+    scrolling_element = @session.find(:css, '#scrollable')
+    scrolling_element.scroll_to 100, 100
+    scrolling_element.scroll_to(:current, offset: [-50, 50])
+    expect(scrolling_element.evaluate_script('[this.scrollLeft, this.scrollTop]')).to eq [50, 150]
+  end
+end

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

@@ -1,92 +1,118 @@
 # frozen_string_literal: true
 
-Capybara::SpecHelper.spec "#select" do
+Capybara::SpecHelper.spec '#select' do
   before do
     @session.visit('/form')
   end
 
-  it "should return value of the first option" do
+  it 'should return value of the first option' do
     expect(@session.find_field('Title').value).to eq('Mrs')
   end
 
-  it "should return value of the selected option" do
-    @session.select("Miss", from: 'Title')
+  it 'should return value of the selected option' do
+    @session.select('Miss', from: 'Title')
     expect(@session.find_field('Title').value).to eq('Miss')
   end
 
-  it "should allow selecting exact options where there are inexact matches", :exact_false do
-    @session.select("Mr", from: 'Title')
+  it 'should allow selecting exact options where there are inexact matches', :exact_false do
+    @session.select('Mr', from: 'Title')
     expect(@session.find_field('Title').value).to eq('Mr')
   end
 
-  it "should allow selecting options where they are the only inexact match", :exact_false do
-    @session.select("Mis", from: 'Title')
+  it 'should allow selecting options where they are the only inexact match', :exact_false do
+    @session.select('Mis', from: 'Title')
     expect(@session.find_field('Title').value).to eq('Miss')
   end
 
-  it "should not allow selecting options where they are the only inexact match if `exact: true` is specified" do
+  it 'should not allow selecting options where they are the only inexact match if `exact: true` is specified' do
     sel = @session.find(:select, 'Title')
     expect do
-      sel.select("Mis", exact: true)
+      sel.select('Mis', exact: true)
     end.to raise_error(Capybara::ElementNotFound)
   end
 
-  it "should not allow selecting an option if the match is ambiguous", :exact_false do
+  it 'should not allow selecting an option if the match is ambiguous', :exact_false do
     expect do
-      @session.select("M", from: 'Title')
+      @session.select('M', from: 'Title')
     end.to raise_error(Capybara::Ambiguous)
   end
 
-  it "should return the value attribute rather than content if present" do
+  it 'should return the value attribute rather than content if present' do
     expect(@session.find_field('Locale').value).to eq('en')
   end
 
-  it "should select an option from a select box by id" do
-    @session.select("Finish", from: 'form_locale')
+  it 'should select an option from a select box by id' do
+    @session.select('Finnish', from: 'form_locale')
     @session.click_button('awesome')
     expect(extract_results(@session)['locale']).to eq('fi')
   end
 
-  it "should select an option from a select box by label" do
-    @session.select("Finish", from: 'Locale')
+  it 'should select an option from a select box by label' do
+    @session.select('Finnish', from: 'Locale')
     @session.click_button('awesome')
     expect(extract_results(@session)['locale']).to eq('fi')
   end
 
-  it "should select an option without giving a select box" do
-    @session.select("Swedish")
+  it 'should select an option without giving a select box' do
+    @session.select('Swedish')
     @session.click_button('awesome')
     expect(extract_results(@session)['locale']).to eq('sv')
   end
 
-  it "should escape quotes" do
+  it 'should escape quotes' do
     @session.select("John's made-up language", from: 'Locale')
     @session.click_button('awesome')
     expect(extract_results(@session)['locale']).to eq('jo')
   end
 
-  it "should obey from" do
-    @session.select("Miss", from: "Other title")
+  it 'should obey from' do
+    @session.select('Miss', from: 'Other title')
     @session.click_button('awesome')
     results = extract_results(@session)
-    expect(results['other_title']).to eq("Miss")
-    expect(results['title']).not_to eq("Miss")
+    expect(results['other_title']).to eq('Miss')
+    expect(results['title']).not_to eq('Miss')
   end
 
-  it "show match labels with preceding or trailing whitespace" do
-    @session.select("Lojban", from: 'Locale')
+  it 'show match labels with preceding or trailing whitespace' do
+    @session.select('Lojban', from: 'Locale')
     @session.click_button('awesome')
     expect(extract_results(@session)['locale']).to eq('jbo')
   end
 
-  it "casts to string" do
+  it 'casts to string' do
     @session.select(:Miss, from: :Title)
     expect(@session.find_field('Title').value).to eq('Miss')
   end
 
+  context 'input with datalist' do
+    it 'should select an option' do
+      @session.select('Audi', from: 'manufacturer')
+      @session.click_button('awesome')
+      expect(extract_results(@session)['manufacturer']).to eq('Audi')
+    end
+
+    it 'should not find an input without a datalist' do
+      expect do
+        @session.select('Thomas', from: 'form_first_name')
+      end.to raise_error(/Unable to find input box with datalist completion "form_first_name"/)
+    end
+
+    it "should not select an option that doesn't exist" do
+      expect do
+        @session.select('Tata', from: 'manufacturer')
+      end.to raise_error(/Unable to find datalist option "Tata"/)
+    end
+
+    it 'should not select a disabled option' do
+      expect do
+        @session.select('Mercedes', from: 'manufacturer')
+      end.to raise_error(/Unable to find datalist option "Mercedes"/)
+    end
+  end
+
   context "with a locator that doesn't exist" do
-    it "should raise an error" do
-      msg = "Unable to find visible select box \"does not exist\" that is not disabled"
+    it 'should raise an error' do
+      msg = /Unable to find select box "does not exist"/
       expect do
         @session.select('foo', from: 'does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)
@@ -94,110 +120,110 @@ Capybara::SpecHelper.spec "#select" do
   end
 
   context "with an option that doesn't exist" do
-    it "should raise an error" do
-      msg = /^Unable to find visible option "Does not Exist" within/
+    it 'should raise an error' do
+      msg = /^Unable to find option "Does not Exist" within/
       expect do
         @session.select('Does not Exist', from: 'form_locale')
       end.to raise_error(Capybara::ElementNotFound, msg)
     end
   end
 
-  context "on a disabled select" do
-    it "should raise an error" do
+  context 'on a disabled select' do
+    it 'should raise an error' do
       expect do
         @session.select('Should not see me', from: 'Disabled Select')
       end.to raise_error(Capybara::ElementNotFound)
     end
   end
 
-  context "on a disabled option" do
-    it "should not select" do
+  context 'on a disabled option' do
+    it 'should not select' do
       @session.select('Other', from: 'form_title')
       expect(@session.find_field('form_title').value).not_to eq 'Other'
     end
-
-    it "should warn" do
-      expect_any_instance_of(Capybara::Node::Element).to receive(:warn).once
-      @session.select('Other', from: 'form_title')
-    end
   end
 
-  context "with multiple select" do
-    it "should return an empty value" do
+  context 'with multiple select' do
+    it 'should return an empty value' do
       expect(@session.find_field('Languages').value).to eq([])
     end
 
-    it "should return value of the selected options" do
-      @session.select("Ruby",       from: 'Languages')
-      @session.select("Javascript", from: 'Languages')
+    it 'should return value of the selected options' do
+      @session.select('Ruby',       from: 'Languages')
+      @session.select('Javascript', from: 'Languages')
       expect(@session.find_field('Languages').value).to include('Ruby', 'Javascript')
     end
 
-    it "should select one option" do
-      @session.select("Ruby", from: 'Languages')
+    it 'should select one option' do
+      @session.select('Ruby', from: 'Languages')
       @session.click_button('awesome')
       expect(extract_results(@session)['languages']).to eq(['Ruby'])
     end
 
-    it "should select multiple options" do
-      @session.select("Ruby",       from: 'Languages')
-      @session.select("Javascript", from: 'Languages')
+    it 'should select multiple options' do
+      @session.select('Ruby',       from: 'Languages')
+      @session.select('Javascript', from: 'Languages')
       @session.click_button('awesome')
       expect(extract_results(@session)['languages']).to include('Ruby', 'Javascript')
     end
 
-    it "should remain selected if already selected" do
-      @session.select("Ruby",       from: 'Languages')
-      @session.select("Javascript", from: 'Languages')
-      @session.select("Ruby",       from: 'Languages')
+    it 'should remain selected if already selected' do
+      @session.select('Ruby',       from: 'Languages')
+      @session.select('Javascript', from: 'Languages')
+      @session.select('Ruby',       from: 'Languages')
       @session.click_button('awesome')
       expect(extract_results(@session)['languages']).to include('Ruby', 'Javascript')
     end
 
-    it "should return value attribute rather than content if present" do
+    it 'should return value attribute rather than content if present' do
       expect(@session.find_field('Underwear').value).to include('thermal')
     end
   end
 
-  context "with :exact option" do
-    context "when `false`" do
-      it "can match select box approximately" do
-        @session.select("Finish", from: "Loc", exact: false)
-        @session.click_button("awesome")
-        expect(extract_results(@session)["locale"]).to eq("fi")
+  context 'with :exact option' do
+    context 'when `false`' do
+      it 'can match select box approximately' do
+        @session.select('Finnish', from: 'Loc', exact: false)
+        @session.click_button('awesome')
+        expect(extract_results(@session)['locale']).to eq('fi')
       end
 
-      it "can match option approximately" do
-        @session.select("Fin", from: "Locale", exact:  false)
-        @session.click_button("awesome")
-        expect(extract_results(@session)["locale"]).to eq("fi")
+      it 'can match option approximately' do
+        @session.select('Fin', from: 'Locale', exact:  false)
+        @session.click_button('awesome')
+        expect(extract_results(@session)['locale']).to eq('fi')
       end
 
-      it "can match option approximately when :from not given" do
-        @session.select("made-up language", exact:  false)
-        @session.click_button("awesome")
-        expect(extract_results(@session)["locale"]).to eq("jo")
+      it 'can match option approximately when :from not given' do
+        @session.select('made-up language', exact:  false)
+        @session.click_button('awesome')
+        expect(extract_results(@session)['locale']).to eq('jo')
       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.select("Finish", from: "Loc", exact:  true)
+          @session.select('Finnish', from: 'Loc', exact: true)
         end.to raise_error(Capybara::ElementNotFound)
       end
 
-      it "can match option approximately" do
+      it 'can match option approximately' do
         expect do
-          @session.select("Fin", from: "Locale", exact:  true)
+          @session.select('Fin', from: 'Locale', 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.select("made-up language", exact: true)
+          @session.select('made-up language', exact: true)
         end.to raise_error(Capybara::ElementNotFound)
       end
     end
   end
+
+  it 'should error when not passed a locator for :from option' do
+    select = @session.find(:select, 'Title')
+    expect { @session.select('Mr', from: select) }.to raise_error(ArgumentError, /does not take an element/)
+  end
 end

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

@@ -1,33 +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 with id string" 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 element" do
+    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
 
@@ -37,29 +52,47 @@ Capybara::SpecHelper.spec Capybara::Selector do
     end
   end
 
-  describe "field selectors" do
-    it "can find specifically by id" do
-      expect(@session.find(:field, id: 'customer_email').value).to eq "ben@ben.com"
+  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 name" do
-      expect(@session.find(:field, name: 'form[other_title]')['id']).to eq "form_other_title"
+    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" do
-      expect(@session.find(:field, placeholder: 'FirstName')['id']).to eq "form_first_name"
+    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
+    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
+    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: ['confusion', 'confusion-textarea'])['id']).to eq 'confusion_textarea'
+      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

@@ -9,31 +9,31 @@ Capybara::SpecHelper.spec '#sibling' do
     Capybara::Selector.remove(:monkey)
   end
 
-  it "should find a prior sibling element using the given locator" do
+  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
+  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
+  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
+  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
+  context 'with custom selector' do
+    it 'should use the custom selector' do
       Capybara.add_selector(:data_attribute) do
         xpath { |attr| ".//*[@data-#{attr}]" }
       end
@@ -43,10 +43,10 @@ Capybara::SpecHelper.spec '#sibling' do
     end
   end
 
-  it "should raise ElementNotFound with a useful default message if nothing was found" do
+  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.to raise_error(Capybara::ElementNotFound, 'Unable to find xpath "//div[@id=\\"nosuchthing\\"]" that is a sibling of visible css "#child"')
   end
 end