capybara 3.3.1 → 3.4.0

data/lib/capybara/session/config.rb

@@ -7,7 +7,7 @@ module Capybara
     OPTIONS = %i[always_include_port run_server default_selector default_max_wait_time ignore_hidden_elements
                  automatic_reload match exact exact_text raise_server_errors visible_text_only
                  automatic_label_click enable_aria_label save_path asset_host default_host app_host
-                 server_host server_port server_errors default_set_options disable_animation].freeze
+                 server_host server_port server_errors default_set_options disable_animation test_id].freeze
 
     attr_accessor(*OPTIONS)
 
@@ -54,6 +54,8 @@ module Capybara
     #   See {Capybara.configure}
     # @!method disable_animation
     #   See {Capybara.configure}
+    # @!method test_id
+    #   See {Capybara.configure}
 
     remove_method :server_host
 
@@ -84,10 +86,23 @@ module Capybara
 
     remove_method :disable_animation=
     def disable_animation=(bool)
-      warn "Capybara.disable_animation is a beta feature - it may change/disappear in a future point version" if bool
+      warn 'Capybara.disable_animation is a beta feature - it may change/disappear in a future point version' if bool
       @disable_animation = bool
     end
 
+    remove_method :test_id=
+    ##
+    #
+    # Set an attribue to be optionally matched against the locator for builtin selector types.
+    # This attribute will be checked by builtin selector types whenever id would normally be checked.
+    # If `nil` then it will be ignored.
+    #
+    #  @params [String, Symbol, nil] id Name of the attribute to use as the test id
+    #
+    def test_id=(id)
+      @test_id = id&.to_sym
+    end
+
     def initialize_copy(other)
       super
       @server_errors = @server_errors.dup
@@ -97,7 +112,7 @@ module Capybara
   class ReadOnlySessionConfig < SimpleDelegator
     SessionConfig::OPTIONS.each do |m|
       define_method "#{m}=" do |_|
-        raise "Per session settings are only supported when Capybara.threadsafe == true"
+        raise 'Per session settings are only supported when Capybara.threadsafe == true'
       end
     end
   end

data/lib/capybara/spec/public/test.js

@@ -15,7 +15,7 @@ $(function() {
       $(link).after('<input type="submit" value="New Here">');
       $(link).after('<input type="text" id="new_field">');
       $('#change').remove();
-    }, 500);
+    }, 1000);
     return false;
   });
   $('#slow-click').click(function() {

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

@@ -5,14 +5,14 @@ Capybara::SpecHelper.spec '#accept_alert', requires: [:modals] do
     @session.visit('/with_js')
   end
 
-  it "should accept the alert" do
+  it 'should accept the alert' do
     @session.accept_alert do
       @session.click_link('Open alert')
     end
     expect(@session).to have_xpath("//a[@id='open-alert' and @opened='true']")
   end
 
-  it "should accept the alert if the text matches" do
+  it 'should accept the alert if the text matches' do
     @session.accept_alert 'Alert opened' do
       @session.click_link('Open alert')
     end
@@ -26,14 +26,14 @@ Capybara::SpecHelper.spec '#accept_alert', requires: [:modals] do
     expect(@session).to have_xpath("//a[@id='open-alert' and @opened='true']")
   end
 
-  it "should accept the alert if the text matches a regexp" do
+  it 'should accept the alert if the text matches a regexp' do
     @session.accept_alert(/op.{2}ed/) do
       @session.click_link('Open alert')
     end
     expect(@session).to have_xpath("//a[@id='open-alert' and @opened='true']")
   end
 
-  it "should not accept the alert if the text doesnt match" do
+  it 'should not accept the alert if the text doesnt match' do
     expect do
       @session.accept_alert 'Incorrect Text' do
         @session.click_link('Open alert')
@@ -41,14 +41,14 @@ Capybara::SpecHelper.spec '#accept_alert', requires: [:modals] do
     end.to raise_error(Capybara::ModalNotFound)
   end
 
-  it "should return the message presented" do
+  it 'should return the message presented' do
     message = @session.accept_alert do
       @session.click_link('Open alert')
     end
     expect(message).to eq('Alert opened [*Yay?*]')
   end
 
-  it "should handle the alert if the page changes" do
+  it 'should handle the alert if the page changes' do
     @session.accept_alert do
       @session.click_link('Alert page change')
       sleep 1 # ensure page change occurs before the accept_alert block exits
@@ -56,22 +56,22 @@ Capybara::SpecHelper.spec '#accept_alert', requires: [:modals] do
     expect(@session).to have_current_path('/with_html')
   end
 
-  context "with an asynchronous alert" do
-    it "should accept the alert" do
+  context 'with an asynchronous alert' do
+    it 'should accept the alert' do
       @session.accept_alert do
         @session.click_link('Open delayed alert')
       end
       expect(@session).to have_xpath("//a[@id='open-delayed-alert' and @opened='true']")
     end
 
-    it "should return the message presented" do
+    it 'should return the message presented' do
       message = @session.accept_alert do
         @session.click_link('Open delayed alert')
       end
       expect(message).to eq('Delayed alert opened')
     end
 
-    it "should allow to adjust the delay" do
+    it 'should allow to adjust the delay' do
       @session.accept_alert wait: 10 do
         @session.click_link('Open slow alert')
       end

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

@@ -5,21 +5,21 @@ Capybara::SpecHelper.spec '#accept_confirm', requires: [:modals] do
     @session.visit('/with_js')
   end
 
-  it "should accept the confirm" do
+  it 'should accept the confirm' do
     @session.accept_confirm do
       @session.click_link('Open confirm')
     end
     expect(@session).to have_xpath("//a[@id='open-confirm' and @confirmed='true']")
   end
 
-  it "should return the message presented" do
+  it 'should return the message presented' do
     message = @session.accept_confirm do
       @session.click_link('Open confirm')
     end
     expect(message).to eq('Confirm opened')
   end
 
-  it "should work with nested modals" do
+  it 'should work with nested modals' do
     expect do
       @session.dismiss_confirm 'Are you really sure?' do
         @session.accept_confirm 'Are you sure?' do

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

@@ -5,57 +5,56 @@ Capybara::SpecHelper.spec '#accept_prompt', requires: [:modals] do
     @session.visit('/with_js')
   end
 
-  it "should accept the prompt with no message" do
+  it 'should accept the prompt with no message' do
     @session.accept_prompt do
       @session.click_link('Open prompt')
     end
     expect(@session).to have_xpath("//a[@id='open-prompt' and @response='']")
   end
 
-  it "should accept the prompt with no message when there is a default" do
+  it 'should accept the prompt with no message when there is a default' do
     @session.accept_prompt do
       @session.click_link('Open defaulted prompt')
     end
     expect(@session).to have_xpath("//a[@id='open-prompt-with-default' and @response='Default value!']")
   end
 
-  it "should return the message presented" do
+  it 'should return the message presented' do
     message = @session.accept_prompt do
       @session.click_link('Open prompt')
     end
     expect(message).to eq('Prompt opened')
   end
 
-  it "should accept the prompt with a response" do
+  it 'should accept the prompt with a response' do
     @session.accept_prompt with: 'the response' do
       @session.click_link('Open prompt')
     end
     expect(@session).to have_xpath("//a[@id='open-prompt' and @response='the response']")
   end
 
-  it "should accept the prompt with a response when there is a default" do
+  it 'should accept the prompt with a response when there is a default' do
     @session.accept_prompt with: 'the response' do
       @session.click_link('Open defaulted prompt')
     end
     expect(@session).to have_xpath("//a[@id='open-prompt-with-default' and @response='the response']")
   end
 
-  it "should accept the prompt with a blank response when there is a default" do
-    pending "Geckodriver doesn't set a blank response currently" if marionette?(@session)
+  it 'should accept the prompt with a blank response when there is a default' do
     @session.accept_prompt with: '' do
       @session.click_link('Open defaulted prompt')
     end
     expect(@session).to have_xpath("//a[@id='open-prompt-with-default' and @response='']")
   end
 
-  it "should allow special characters in the reponse" do
+  it 'should allow special characters in the reponse' do
     @session.accept_prompt with: '\'the\' \b "response"' do
       @session.click_link('Open prompt')
     end
     expect(@session).to have_xpath(%{//a[@id='open-prompt' and @response=concat("'the' ", '\\b "response"')]})
   end
 
-  it "should accept the prompt if the message matches" do
+  it 'should accept the prompt if the message matches' do
     @session.accept_prompt 'Prompt opened', with: 'matched' do
       @session.click_link('Open prompt')
     end
@@ -70,7 +69,7 @@ Capybara::SpecHelper.spec '#accept_prompt', requires: [:modals] do
     end.to raise_error(Capybara::ModalNotFound)
   end
 
-  it "should return the message presented" do
+  it 'should return the message presented' do
     message = @session.accept_prompt with: 'the response' do
       @session.click_link('Open prompt')
     end

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

@@ -1,33 +1,34 @@
 # 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')
   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 wait for matching elements to appear", requires: [:js] 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
+    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
+  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
+    expect(@session.all(:css, 'a#has-been-clicked', minimum: 0)).to be_empty
   end
 
-  it "should accept an XPath instance", :exact_false do
+  it 'should accept an XPath instance', :exact_false do
     @session.visit('/form')
     @xpath = Capybara::Selector.all[:fillable_field].call('Name')
     expect(@xpath).to be_a(::XPath::Union)
@@ -35,61 +36,61 @@ Capybara::SpecHelper.spec "#all" do
     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 raise an error when given invalid options' do
+    expect { @session.all('//p', schmoo: 'foo') }.to raise_error(ArgumentError)
   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')
     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')
     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')
     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
+    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)
+        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)
+        expect(@session.all(:css, 'a.simple').size).to eq(1)
       end
     end
   end
@@ -168,19 +169,19 @@ Capybara::SpecHelper.spec "#all" do
     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

@@ -9,64 +9,64 @@ Capybara::SpecHelper.spec '#ancestor' do
     Capybara::Selector.remove(:monkey)
   end
 
-  it "should find the ancestor element using the given locator" do
+  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')
+    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
+  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 raise an error if there are multiple matches" do
+  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
+  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
+    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
+  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')
+      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
+  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"
+      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
+  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 visible xpath \"//div[@id=\\\"nosuchthing\\\"]\" that is an ancestor of visible css \"#child\"")
+    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
+  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')
@@ -74,7 +74,7 @@ Capybara::SpecHelper.spec '#ancestor' do
     end
   end
 
-  it "should raise if selector type is unknown" do
+  it 'should raise if selector type is unknown' do
     el = @session.find(:css, '#child')
     expect do
       el.ancestor(:unknown, '//h1')