capybara 3.0.0 → 3.36.0

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

@@ -1,69 +1,79 @@
 # frozen_string_literal: true
 
 Capybara::SpecHelper.spec '#click_link_or_button' do
-  it "should click on a link" do
+  it 'should click on a link' do
     @session.visit('/with_html')
     @session.click_link_or_button('labore')
     expect(@session).to have_content('Bar')
   end
 
-  it "should click on a button" do
+  it 'should click on a button' do
     @session.visit('/form')
     @session.click_link_or_button('awe123')
     expect(extract_results(@session)['first_name']).to eq('John')
   end
 
-  it "should click on a button with no type attribute" do
+  it 'should click on a button with no type attribute' do
     @session.visit('/form')
     @session.click_link_or_button('no_type')
     expect(extract_results(@session)['first_name']).to eq('John')
   end
 
-  it "should be aliased as click_on" do
+  it 'should be aliased as click_on' do
     @session.visit('/form')
     @session.click_on('awe123')
     expect(extract_results(@session)['first_name']).to eq('John')
   end
 
-  it "should wait for asynchronous load", requires: [:js] do
+  it 'should wait for asynchronous load', requires: [:js] do
+    Capybara.default_max_wait_time = 2
     @session.visit('/with_js')
     @session.click_link('Click me')
     @session.click_link_or_button('Has been clicked')
   end
 
-  it "casts to string" do
+  it 'casts to string' do
     @session.visit('/form')
     @session.click_link_or_button(:awe123)
     expect(extract_results(@session)['first_name']).to eq('John')
   end
 
-  context "with :exact option" do
-    context "when `false`" do
-      it "clicks on approximately matching link" do
+  context 'with test_id' do
+    it 'should click on a button' do
+      Capybara.test_id = 'data-test-id'
+      @session.visit('/form')
+      @session.click_link_or_button('test_id_button')
+      expect(extract_results(@session)['first_name']).to eq('John')
+    end
+  end
+
+  context 'with :exact option' do
+    context 'when `false`' do
+      it 'clicks on approximately matching link' do
         @session.visit('/with_html')
         @session.click_link_or_button('abore', exact: false)
         expect(@session).to have_content('Bar')
       end
 
-      it "clicks on approximately matching button" do
+      it 'clicks on approximately matching button' do
         @session.visit('/form')
         @session.click_link_or_button('awe', exact: false)
         expect(extract_results(@session)['first_name']).to eq('John')
       end
     end
 
-    context "when `true`" do
-      it "does not click on link which matches approximately" do
+    context 'when `true`' do
+      it 'does not click on link which matches approximately' do
         @session.visit('/with_html')
-        msg = "Unable to find visible link or button \"abore\""
+        msg = 'Unable to find link or button "abore"'
         expect do
           @session.click_link_or_button('abore', exact: true)
         end.to raise_error(Capybara::ElementNotFound, msg)
       end
 
-      it "does not click on approximately matching button" do
+      it 'does not click on approximately matching button' do
         @session.visit('/form')
-        msg = "Unable to find visible link or button \"awe\""
+        msg = 'Unable to find link or button "awe"'
 
         expect do
           @session.click_link_or_button('awe', exact: true)
@@ -73,47 +83,56 @@ Capybara::SpecHelper.spec '#click_link_or_button' do
   end
 
   context "with a locator that doesn't exist" do
-    it "should raise an error" do
+    it 'should raise an error' do
       @session.visit('/with_html')
-      msg = "Unable to find visible link or button \"does not exist\""
+      msg = 'Unable to find link or button "does not exist"'
       expect do
         @session.click_link_or_button('does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)
     end
   end
 
-  context "with :disabled option" do
-    it "ignores disabled buttons when false" do
+  context 'with :disabled option' do
+    it 'ignores disabled buttons when false' do
       @session.visit('/form')
       expect do
         @session.click_link_or_button('Disabled button', disabled: false)
       end.to raise_error(Capybara::ElementNotFound)
     end
 
-    it "ignores disabled buttons by default" do
+    it 'ignores disabled buttons by default' do
       @session.visit('/form')
       expect do
         @session.click_link_or_button('Disabled button')
       end.to raise_error(Capybara::ElementNotFound)
     end
 
-    it "happily clicks on links which incorrectly have the disabled attribute" do
+    it 'happily clicks on links which incorrectly have the disabled attribute' do
       @session.visit('/with_html')
       @session.click_link_or_button('Disabled link')
-      expect(@session).to have_content("Bar")
-    end
-
-    it "does nothing when button is disabled" do
-      @session.visit('/form')
-      expect do
-        @session.click_link_or_button('Disabled button', disabled: false)
-      end.to raise_error(Capybara::ElementNotFound)
+      expect(@session).to have_content('Bar')
     end
   end
 
-  it "should return the element clicked" do
+  it 'should return the element clicked' do
     @session.visit('/with_html')
     link = @session.find(:link, 'Blank Anchor')
     expect(@session.click_link_or_button('Blank Anchor')).to eq link
   end
+
+  context 'with enable_aria_label' do
+    it 'should click on link' do
+      @session.visit('/with_html')
+      expect do
+        @session.click_link_or_button('Go to simple', enable_aria_label: true)
+      end.not_to raise_error
+    end
+
+    it 'should click on button' do
+      @session.visit('/form')
+      expect do
+        @session.click_link_or_button('Aria button', enable_aria_label: true)
+      end.not_to raise_error
+    end
+  end
 end

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

@@ -5,202 +5,225 @@ Capybara::SpecHelper.spec '#click_link' do
     @session.visit('/with_html')
   end
 
-  it "should wait for asynchronous load", requires: [:js] do
+  it 'should wait for asynchronous load', requires: [:js] do
+    Capybara.default_max_wait_time = 2
     @session.visit('/with_js')
     @session.click_link('Click me')
     @session.click_link('Has been clicked')
   end
 
-  it "casts to string" do
+  it 'casts to string' do
     @session.click_link(:foo)
     expect(@session).to have_content('Another World')
   end
 
-  it "raises any errors caught inside the server", requires: [:server] do
-    quietly { @session.visit("/error") }
+  it 'raises any errors caught inside the server', requires: [:server] do
+    quietly { @session.visit('/error') }
     expect do
       @session.click_link('foo')
     end.to raise_error(TestApp::TestAppError)
   end
 
-  context "with id given" do
-    it "should take user to the linked page" do
+  context 'with id given' do
+    it 'should take user to the linked page' do
       @session.click_link('foo')
       expect(@session).to have_content('Another World')
     end
   end
 
-  context "with text given" do
-    it "should take user to the linked page" do
+  context 'with text given' do
+    it 'should take user to the linked page' do
       @session.click_link('labore')
       expect(@session).to have_content('Bar')
     end
 
-    it "should accept partial matches", :exact_false do
+    it 'should accept partial matches', :exact_false do
       @session.click_link('abo')
       expect(@session).to have_content('Bar')
     end
   end
 
-  context "with title given" do
-    it "should take user to the linked page" do
+  context 'with title given' do
+    it 'should take user to the linked page' do
       @session.click_link('awesome title')
       expect(@session).to have_content('Bar')
     end
 
-    it "should accept partial matches", :exact_false do
+    it 'should accept partial matches', :exact_false do
       @session.click_link('some titl')
       expect(@session).to have_content('Bar')
     end
   end
 
-  context "with alternative text given to a contained image" do
-    it "should take user to the linked page" do
+  context 'with alternative text given to a contained image' do
+    it 'should take user to the linked page' do
       @session.click_link('awesome image')
       expect(@session).to have_content('Bar')
     end
 
-    it "should accept partial matches", :exact_false do
+    it 'should accept partial matches', :exact_false do
       @session.click_link('some imag')
       expect(@session).to have_content('Bar')
     end
   end
 
   context "with a locator that doesn't exist" do
-    it "should raise an error" do
-      msg = "Unable to find visible link \"does not exist\""
+    it 'should raise an error' do
+      msg = 'Unable to find link "does not exist"'
       expect do
         @session.click_link('does not exist')
       end.to raise_error(Capybara::ElementNotFound, msg)
     end
   end
 
-  context "with :href option given" do
-    it "should find links with valid href" do
+  context 'with :href option given' do
+    it 'should find links with valid href' do
       @session.click_link('labore', href: '/with_simple_html')
       expect(@session).to have_content('Bar')
     end
 
     it "should raise error if link wasn't found" do
-      expect { @session.click_link('labore', href: 'invalid_href') }.to raise_error(Capybara::ElementNotFound)
+      expect { @session.click_link('labore', href: 'invalid_href') }.to raise_error(Capybara::ElementNotFound, /with href "invalid_href/)
     end
   end
 
-  context "with a regex :href option given" do
-    it "should find a link matching an all-matching regex pattern" do
+  context 'with a regex :href option given' do
+    it 'should find a link matching an all-matching regex pattern' do
       @session.click_link('labore', href: /.+/)
       expect(@session).to have_content('Bar')
     end
 
-    it "should find a link matching an exact regex pattern" do
-      @session.click_link('labore', href: /\/with_simple_html/)
+    it 'should find a link matching an exact regex pattern' do
+      @session.click_link('labore', href: %r{/with_simple_html})
       expect(@session).to have_content('Bar')
     end
 
-    it "should find a link matching a partial regex pattern" do
-      @session.click_link('labore', href: /\/with_simple/)
+    it 'should find a link matching a partial regex pattern' do
+      @session.click_link('labore', href: %r{/with_simple})
       expect(@session).to have_content('Bar')
     end
 
     it "should raise an error if no link's href matched the pattern" do
-      expect { @session.click_link('labore', href: /invalid_pattern/) }.to raise_error(Capybara::ElementNotFound)
-      expect { @session.click_link('labore', href: /.+d+/) }.to raise_error(Capybara::ElementNotFound)
+      expect { @session.click_link('labore', href: /invalid_pattern/) }.to raise_error(Capybara::ElementNotFound, %r{with href matching /invalid_pattern/})
+      expect { @session.click_link('labore', href: /.+d+/) }.to raise_error(Capybara::ElementNotFound, /#{Regexp.quote "with href matching /.+d+/"}/)
     end
 
     context 'href: nil' do
-      it "should not raise an error on links with no href attribute" do
+      it 'should not raise an error on links with no href attribute' do
         expect { @session.click_link('No Href', href: nil) }.not_to raise_error
       end
 
-      it "should raise an error if href attribute exists" do
-        expect { @session.click_link('Blank Href', href: nil) }.to raise_error(Capybara::ElementNotFound)
-        expect { @session.click_link('Normal Anchor', href: nil) }.to raise_error(Capybara::ElementNotFound)
+      it 'should raise an error if href attribute exists' do
+        expect { @session.click_link('Blank Href', href: nil) }.to raise_error(Capybara::ElementNotFound, /with no href attribute/)
+        expect { @session.click_link('Normal Anchor', href: nil) }.to raise_error(Capybara::ElementNotFound, /with no href attribute/)
+      end
+    end
+
+    context 'href: false' do
+      it 'should not raise an error on links with no href attribute' do
+        expect { @session.click_link('No Href', href: false) }.not_to raise_error
+      end
+
+      it 'should not raise an error if href attribute exists' do
+        expect { @session.click_link('Blank Href', href: false) }.not_to raise_error
+        expect { @session.click_link('Normal Anchor', href: false) }.not_to raise_error
       end
     end
   end
 
-  it "should follow relative links" do
+  it 'should follow relative links' do
     @session.visit('/')
     @session.click_link('Relative')
     expect(@session).to have_content('This is a test')
   end
 
-  it "should follow protocol relative links" do
+  it 'should follow protocol relative links' do
     @session.click_link('Protocol')
     expect(@session).to have_content('Another World')
   end
 
-  it "should follow redirects" do
+  it 'should follow redirects' do
     @session.click_link('Redirect')
     expect(@session).to have_content('You landed')
   end
 
-  it "should follow redirects back to itself" do
+  it 'should follow redirects back to itself' do
     @session.click_link('BackToMyself')
-    expect(@session).to have_css('#referrer', text: /\/with_html$/)
+    expect(@session).to have_css('#referrer', text: %r{/with_html$})
     expect(@session).to have_content('This is a test')
   end
 
-  it "should add query string to current URL with naked query string" do
+  it 'should add query string to current URL with naked query string' do
     @session.click_link('Naked Query String')
     expect(@session).to have_content('Query String sent')
   end
 
-  it "should do nothing on anchor links" do
-    @session.fill_in("test_field", with: 'blah')
+  it 'should do nothing on anchor links' do
+    @session.fill_in('test_field', with: 'blah')
     @session.click_link('Normal Anchor')
-    expect(@session.find_field("test_field").value).to eq('blah')
+    expect(@session.find_field('test_field').value).to eq('blah')
     @session.click_link('Blank Anchor')
-    expect(@session.find_field("test_field").value).to eq('blah')
+    expect(@session.find_field('test_field').value).to eq('blah')
     @session.click_link('Blank JS Anchor')
-    expect(@session.find_field("test_field").value).to eq('blah')
+    expect(@session.find_field('test_field').value).to eq('blah')
   end
 
-  it "should do nothing on URL+anchor links for the same page" do
-    @session.fill_in("test_field", with: 'blah')
+  it 'should do nothing on URL+anchor links for the same page' do
+    @session.fill_in('test_field', with: 'blah')
     @session.click_link('Anchor on same page')
-    expect(@session.find_field("test_field").value).to eq('blah')
+    expect(@session.find_field('test_field').value).to eq('blah')
   end
 
-  it "should follow link on URL+anchor links for a different page" do
+  it 'should follow link on URL+anchor links for a different page' do
     @session.click_link('Anchor on different page')
     expect(@session).to have_content('Bar')
   end
 
-  it "should follow link on anchor if the path has regex special characters" do
+  it 'should follow link on anchor if the path has regex special characters' do
     @session.visit('/with.*html')
     @session.click_link('Anchor on different page')
     expect(@session).to have_content('Bar')
   end
 
-  it "should raise an error with links with no href" do
+  it 'should raise an error with links with no href' do
     expect do
       @session.click_link('No Href')
     end.to raise_error(Capybara::ElementNotFound)
   end
 
-  context "with :exact option" do
-    it "should accept partial matches when false" do
+  context 'with :exact option' do
+    it 'should accept partial matches when false' do
       @session.click_link('abo', exact: false)
       expect(@session).to have_content('Bar')
     end
 
-    it "should not accept partial matches when true" do
+    it 'should not accept partial matches when true' do
       expect do
         @session.click_link('abo', exact: true)
       end.to raise_error(Capybara::ElementNotFound)
     end
   end
 
-  context "without locator" do
-    it "uses options" do
+  context 'without locator' do
+    it 'uses options' do
       @session.click_link(href: '/foo')
       expect(@session).to have_content('Another World')
     end
   end
 
-  it "should return element clicked" do
+  it 'should return element clicked' do
     el = @session.find(:link, 'Normal Anchor')
     expect(@session.click_link('Normal Anchor')).to eq el
   end
+
+  it 'can download a file', requires: [:download] do
+    # This requires the driver used for the test to be configured
+    # to download documents with the mime type "text/csv"
+    download_file = File.join(Capybara.save_path, 'download.csv')
+    expect(File).not_to exist(download_file)
+    @session.click_link('Download Me')
+    sleep 2 # allow time for file to download
+    expect(File).to exist(download_file)
+    FileUtils.rm_rf download_file
+  end
 end

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

@@ -5,22 +5,22 @@ Capybara::SpecHelper.spec '#current_scope' do
     @session.visit('/with_scope')
   end
 
-  context "when not in a #within block" do
-    it "should return the document" do
+  context 'when not in a #within block' do
+    it 'should return the document' do
       expect(@session.current_scope).to be_kind_of Capybara::Node::Document
     end
   end
 
-  context "when in a #within block" do
-    it "should return the element in scope" do
-      @session.within(:css, "#simple_first_name") do
+  context 'when in a #within block' do
+    it 'should return the element in scope' do
+      @session.within(:css, '#simple_first_name') do
         expect(@session.current_scope[:name]).to eq 'first_name'
       end
     end
   end
 
-  context "when in a nested #within block" do
-    it "should return the element in scope" do
+  context 'when in a nested #within block' do
+    it 'should return the element in scope' do
       @session.within("//div[@id='for_bar']") do
         @session.within(".//input[@value='Peter']") do
           expect(@session.current_scope[:name]).to eq 'form[first_name]'

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

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require "capybara/spec/test_app"
+require 'capybara/spec/test_app'
 
 Capybara::SpecHelper.spec '#current_url, #current_path, #current_host' do
-  before :all do
+  before :all do # rubocop:disable RSpec/BeforeAfterAll
     @servers = Array.new(2) { Capybara::Server.new(TestApp.new).boot }
     # sanity check
-    expect(@servers[0].port).not_to eq(@servers[1].port)
-    expect(@servers.map(&:port)).not_to include 80
+    expect(@servers[0].port).not_to eq(@servers[1].port) # rubocop:disable RSpec/ExpectInHook
+    expect(@servers.map(&:port)).not_to include 80 # rubocop:disable RSpec/ExpectInHook
   end
 
   def bases
     @servers.map { |s| "http://#{s.host}:#{s.port}" }
   end
 
-  def should_be_on(server_index, path = "/host", scheme = "http")
+  def should_be_on(server_index, path = '/host', scheme = 'http')
     # Check that we are on /host on the given server
     s = @servers[server_index]
 
@@ -22,23 +22,21 @@ Capybara::SpecHelper.spec '#current_url, #current_path, #current_host' do
 
     expect(@session.current_url.chomp('?')).to eq("#{scheme}://#{s.host}:#{s.port}#{path}")
     expect(@session.current_host).to eq("#{scheme}://#{s.host}") # no port
-    expect(@session.current_path).to eq(path)
-    if path == '/host'
-      # Server should agree with us
-      expect(@session).to have_content("Current host is #{scheme}://#{s.host}:#{s.port}")
-    end
+    expect(@session.current_path).to eq(path.split('#')[0])
+    # Server should agree with us
+    expect(@session).to have_content("Current host is #{scheme}://#{s.host}:#{s.port}") if path == '/host'
   end
 
   def visit_host_links
     @session.visit("#{bases[0]}/host_links?absolute_host=#{bases[1]}")
   end
 
-  it "is affected by visiting a page directly" do
+  it 'is affected by visiting a page directly' do
     @session.visit("#{bases[0]}/host")
     should_be_on 0
   end
 
-  it "returns to the app host when visiting a relative url" do
+  it 'returns to the app host when visiting a relative url' do
     Capybara.app_host = bases[1]
     @session.visit("#{bases[0]}/host")
     should_be_on 0
@@ -47,67 +45,76 @@ Capybara::SpecHelper.spec '#current_url, #current_path, #current_host' do
     Capybara.app_host = nil
   end
 
-  it "is affected by setting Capybara.app_host" do
+  it 'is affected by setting Capybara.app_host' do
     Capybara.app_host = bases[0]
-    @session.visit("/host")
+    @session.visit('/host')
     should_be_on 0
     Capybara.app_host = bases[1]
-    @session.visit("/host")
+    @session.visit('/host')
     should_be_on 1
     Capybara.app_host = nil
   end
 
-  it "is unaffected by following a relative link" do
+  it 'is unaffected by following a relative link' do
     visit_host_links
-    @session.click_link("Relative Host")
+    @session.click_link('Relative Host')
     should_be_on 0
   end
 
-  it "is affected by following an absolute link" do
+  it 'is affected by following an absolute link' do
     visit_host_links
-    @session.click_link("Absolute Host")
+    @session.click_link('Absolute Host')
     should_be_on 1
   end
 
-  it "is unaffected by posting through a relative form" do
+  it 'is unaffected by posting through a relative form' do
     visit_host_links
-    @session.click_button("Relative Host")
+    @session.click_button('Relative Host')
     should_be_on 0
   end
 
-  it "is affected by posting through an absolute form" do
+  it 'is affected by posting through an absolute form' do
     visit_host_links
-    @session.click_button("Absolute Host")
+    @session.click_button('Absolute Host')
     should_be_on 1
   end
 
-  it "is affected by following a redirect" do
+  it 'is affected by following a redirect' do
     @session.visit("#{bases[0]}/redirect")
-    should_be_on 0, "/landed"
+    should_be_on 0, '/landed'
+  end
+
+  it 'maintains fragment' do
+    @session.visit("#{bases[0]}/redirect#fragment")
+    should_be_on 0, '/landed#fragment'
+  end
+
+  it 'redirects to a fragment' do
+    @session.visit("#{bases[0]}/redirect_with_fragment")
+    should_be_on 0, '/landed#with_fragment'
   end
 
-  it "is affected by pushState", requires: [:js] do
-    @session.visit("/with_js")
+  it 'is affected by pushState', requires: [:js] do
+    @session.visit('/with_js')
     @session.execute_script("window.history.pushState({}, '', '/pushed')")
-    expect(@session.current_path).to eq("/pushed")
+    expect(@session.current_path).to eq('/pushed')
   end
 
-  it "is affected by replaceState", requires: [:js] do
-    @session.visit("/with_js")
+  it 'is affected by replaceState', requires: [:js] do
+    @session.visit('/with_js')
     @session.execute_script("window.history.replaceState({}, '', '/replaced')")
-    expect(@session.current_path).to eq("/replaced")
+    expect(@session.current_path).to eq('/replaced')
   end
 
-  it "doesn't raise exception on a nil current_url" do
-    skip "Only makes sense when there is a real driver" unless @session.respond_to?(:driver)
-    allow(@session.driver).to receive(:current_url) { nil }
-    @session.visit("/")
+  it "doesn't raise exception on a nil current_url", requires: [:driver] do
+    allow(@session.driver).to receive(:current_url).and_return(nil)
+    @session.visit('/')
     expect { @session.current_url }.not_to raise_exception
     expect { @session.current_path }.not_to raise_exception
   end
 
-  context "within iframe", requires: [:frames] do
-    it "should get the url of the top level browsing context" do
+  context 'within iframe', requires: [:frames] do
+    it 'should get the url of the top level browsing context' do
       @session.visit('/within_frames')
       expect(@session.current_url).to match(/within_frames\z/)
       @session.within_frame('frameOne') do