capybara 2.18.0 → 3.38.0

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class NodeWrapper
+  def initialize(element); @element = element end
+  def to_capybara_node(); @element end
+end
+
+Capybara::SpecHelper.spec '#to_capybara_node' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  it 'should support have_xxx expectations' do
+    para = NodeWrapper.new(@session.find(:css, '#first'))
+    expect(para).to have_link('ullamco')
+  end
+
+  it 'should support within' do
+    para = NodeWrapper.new(@session.find(:css, '#first'))
+    expect(@session).to have_css('#second')
+    @session.within(para) do
+      expect(@session).to have_link('ullamco')
+      expect(@session).not_to have_css('#second')
+    end
+  end
+
+  it 'should generate correct errors' do
+    para = NodeWrapper.new(@session.find(:css, '#first'))
+    expect do
+      expect(para).to have_text('Header Class Test One')
+    end.to raise_error(/^expected to find text "Header Class Test One" in "Lore/)
+    expect do
+      expect(para).to have_css('#second')
+    end.to raise_error(/^expected to find css "#second" within #<Capybara::Node::Element/)
+    expect do
+      expect(para).to have_link(href: %r{/without_simple_html})
+    end.to raise_error(%r{^expected to find link nil with href matching /\\/without_simple_html/ within #<Capybara::Node::Element})
+  end
+end

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

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
+
+# NOTE: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# because of the methods being tested. In tests using Capybara this type of behavior should be implemented
+# using Capybara provided assertions with builtin waiting behavior.
+
 Capybara::SpecHelper.spec '#refresh' do
-  it "reload the page" do
+  it 'reload the page' do
     @session.visit('/form')
     expect(@session).to have_select('form_locale', selected: 'English')
     @session.select('Swedish', from: 'form_locale')
@@ -9,20 +14,21 @@ Capybara::SpecHelper.spec '#refresh' do
     expect(@session).to have_select('form_locale', selected: 'English')
   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.refresh
     end.to raise_error(TestApp::TestAppError)
   end
 
-  it "it reposts" do
+  it 'it reposts' do
     @session.visit('/form')
     @session.select('Sweden', from: 'form_region')
     @session.click_button('awesome')
-    expect {
+    sleep 2
+    expect do
       @session.refresh
       sleep 2
-    }.to change{ extract_results(@session)['post_count'] }.by(1)
+    end.to change { extract_results(@session)['post_count'] }.by(1)
   end
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#reset_session!' do
-  it "removes cookies" do
+  it 'removes cookies from current domain' do
     @session.visit('/set_cookie')
     @session.visit('/get_cookie')
     expect(@session).to have_content('test_cookie')
@@ -10,19 +11,33 @@ Capybara::SpecHelper.spec '#reset_session!' do
     expect(@session.body).not_to include('test_cookie')
   end
 
-  it "resets current url, host, path" do
+  it 'removes ALL cookies', requires: [:server] do
+    domains = ['localhost', '127.0.0.1']
+    domains.each do |domain|
+      @session.visit("http://#{domain}:#{@session.server.port}/set_cookie")
+      @session.visit("http://#{domain}:#{@session.server.port}/get_cookie")
+      expect(@session).to have_content('test_cookie')
+    end
+    @session.reset_session!
+    domains.each do |domain|
+      @session.visit("http://#{domain}:#{@session.server.port}/get_cookie")
+      expect(@session.body).not_to include('test_cookie')
+    end
+  end
+
+  it 'resets current url, host, path' do
     @session.visit '/foo'
     expect(@session.current_url).not_to be_empty
     expect(@session.current_host).not_to be_empty
     expect(@session.current_path).to eq('/foo')
 
     @session.reset_session!
-    expect([nil, '', 'about:blank']).to include(@session.current_url)
-    expect(['', nil]).to include(@session.current_path)
+    expect(@session.current_url).to satisfy('be a blank url') { |url| [nil, '', 'about:blank'].include? url }
+    expect(@session.current_path).to satisfy('be a blank path') { |path| ['', nil].include? path }
     expect(@session.current_host).to be_nil
   end
 
-  it "resets page body" do
+  it 'resets page body' do
     @session.visit('/with_html')
     expect(@session).to have_content('This is a test')
     expect(@session.find('.//h1').text).to include('This is a test')
@@ -32,71 +47,103 @@ Capybara::SpecHelper.spec '#reset_session!' do
     expect(@session).to have_no_selector('.//h1')
   end
 
-  it "is synchronous" do
-    @session.visit("/with_slow_unload")
+  it 'is synchronous' do
+    @session.visit('/with_slow_unload')
     expect(@session).to have_selector(:css, 'div')
     @session.reset_session!
-    expect(@session).to have_no_selector :xpath, "/html/body/*", wait: false
+    expect(@session).to have_no_selector :xpath, '/html/body/*', wait: false
   end
 
-  it "handles modals during unload", requires: [:modals] do
+  it 'handles modals during unload', requires: [:modals] do
     @session.visit('/with_unload_alert')
     expect(@session).to have_selector(:css, 'div')
     expect { @session.reset_session! }.not_to raise_error
-    expect(@session).to have_no_selector :xpath, "/html/body/*", wait: false
+    expect(@session).to have_no_selector :xpath, '/html/body/*', wait: false
   end
 
-  it "handles already open modals", requires: [:modals] do
+  it 'handles already open modals', requires: [:modals] do
     @session.visit('/with_unload_alert')
     @session.click_link('Go away')
     expect { @session.reset_session! }.not_to raise_error
-    expect(@session).to have_no_selector :xpath, "/html/body/*", wait: false
+    expect(@session).to have_no_selector :xpath, '/html/body/*', wait: false
   end
 
-  it "raises any standard errors caught inside the server", requires: [:server] do
-    quietly { @session.visit("/error") }
+  it 'raises any standard errors caught inside the server', requires: [:server] do
+    quietly { @session.visit('/error') }
     expect do
       @session.reset_session!
     end.to raise_error(TestApp::TestAppError)
-    @session.visit("/")
-    expect(@session.current_path).to eq("/")
+    @session.visit('/')
+    expect(@session.current_path).to eq('/')
+  end
+
+  it 'closes extra windows', requires: [:windows] do
+    @session.visit('/with_html')
+    @session.open_new_window
+    @session.open_new_window
+    expect(@session.windows.size).to eq 3
+    @session.reset_session!
+    expect(@session.windows.size).to eq 1
+  end
+
+  it 'closes extra windows when not on the first window', requires: [:windows] do
+    @session.visit('/with_html')
+    @session.switch_to_window(@session.open_new_window)
+    @session.open_new_window
+    expect(@session.windows.size).to eq 3
+    @session.reset_session!
+    expect(@session.windows.size).to eq 1
   end
 
-  context "When reuse_server == false" do
+  it 'does not block opening a new window after a frame was switched to and not switched back', requires: [:windows] do
+    @session.visit('/with_iframe?id=test_iframe&url=/')
+    @session.switch_to_frame(@session.find(:frame, 'test_iframe'))
+    within_window_test = lambda do
+      @session.within_window(@session.open_new_window) do
+        @session.visit('/')
+      end
+    end
+    expect(&within_window_test).to raise_error(Capybara::ScopeError)
+    @session.reset_session!
+    expect(&within_window_test).not_to raise_error
+  end
+
+  context 'When reuse_server == false' do
+    let!(:orig_reuse_server) { Capybara.reuse_server }
+
     before do
-      @reuse_server = Capybara.reuse_server
       Capybara.reuse_server = false
     end
 
-    it "raises any standard errors caught inside the server during a second session", requires: [:server] do
+    after do
+      Capybara.reuse_server = orig_reuse_server
+    end
+
+    it 'raises any standard errors caught inside the server during a second session', requires: [:server] do
       Capybara.using_driver(@session.mode) do
         Capybara.using_session(:another_session) do
-          @another_session = Capybara.current_session
-          quietly { @another_session.visit("/error") }
+          another_session = Capybara.current_session
+          quietly { another_session.visit('/error') }
           expect do
-            @another_session.reset_session!
+            another_session.reset_session!
           end.to raise_error(TestApp::TestAppError)
-          @another_session.visit("/")
-          expect(@another_session.current_path).to eq("/")
+          another_session.visit('/')
+          expect(another_session.current_path).to eq('/')
         end
       end
     end
-
-    after do
-      Capybara.reuse_server = @reuse_server
-    end
   end
 
-  it "raises configured errors caught inside the server", requires: [:server] do
+  it 'raises configured errors caught inside the server', requires: [:server] do
     prev_errors = Capybara.server_errors.dup
 
     Capybara.server_errors = [LoadError]
-    quietly { @session.visit("/error") }
+    quietly { @session.visit('/error') }
     expect do
       @session.reset_session!
     end.not_to raise_error
 
-    quietly { @session.visit("/load_error") }
+    quietly { @session.visit('/load_error') }
     expect do
       @session.reset_session!
     end.to raise_error(LoadError)
@@ -104,11 +151,11 @@ Capybara::SpecHelper.spec '#reset_session!' do
     Capybara.server_errors = prev_errors
   end
 
-  it "ignores server errors when `Capybara.raise_server_errors = false`", requires: [:server] do
+  it 'ignores server errors when `Capybara.raise_server_errors = false`', requires: [:server] do
     Capybara.raise_server_errors = false
-    quietly { @session.visit("/error") }
+    quietly { @session.visit('/error') }
     @session.reset_session!
-    @session.visit("/")
-    expect(@session.current_path).to eq("/")
+    @session.visit('/')
+    expect(@session.current_path).to eq('/')
   end
 end

data/lib/capybara/spec/session/{response_code.rb → response_code_spec.rb}

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#status_code' do
-  it "should return response codes", requires: [:status_code] do
+  it 'should return response codes', requires: [:status_code] do
     @session.visit('/with_simple_html')
     expect(@session.status_code).to eq(200)
   end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'launchy'
 
 Capybara::SpecHelper.spec '#save_and_open_page' do
@@ -7,12 +8,12 @@ Capybara::SpecHelper.spec '#save_and_open_page' do
   end
 
   after do
-    Dir.glob("capybara-*.html").each do |file|
+    Dir.glob('capybara-*.html').each do |file|
       FileUtils.rm(file)
     end
   end
 
-  it "sends open method to launchy" do
+  it 'sends open method to launchy' do
     allow(Launchy).to receive(:open)
     @session.save_and_open_page
     expect(Launchy).to have_received(:open).with(/capybara-\d+\.html/)

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'launchy'
 
 Capybara::SpecHelper.spec '#save_and_open_screenshot' do
@@ -7,14 +8,14 @@ Capybara::SpecHelper.spec '#save_and_open_screenshot' do
   end
 
   it 'opens file from the default directory', requires: [:screenshot] do
-    expected_file_regex = %r{capybara-\d+\.png}
+    expected_file_regex = /capybara-\d+\.png/
     allow(@session.driver).to receive(:save_screenshot)
     allow(Launchy).to receive(:open)
 
     @session.save_and_open_screenshot
 
-    expect(@session.driver).to have_received(:save_screenshot).
-      with(expected_file_regex, {})
+    expect(@session.driver).to have_received(:save_screenshot)
+      .with(expected_file_regex, any_args)
     expect(Launchy).to have_received(:open).with(expected_file_regex)
   end
 
@@ -25,23 +26,18 @@ Capybara::SpecHelper.spec '#save_and_open_screenshot' do
 
     @session.save_and_open_screenshot(custom_path)
 
-    expect(@session.driver).to have_received(:save_screenshot).
-      with(/#{custom_path}$/, {})
+    expect(@session.driver).to have_received(:save_screenshot)
+      .with(/#{custom_path}$/, any_args)
     expect(Launchy).to have_received(:open).with(/#{custom_path}$/)
   end
 
   context 'when launchy cannot be required' do
     it 'prints out a correct warning message', requires: [:screenshot] do
       file_path = File.join(Dir.tmpdir, 'test.png')
-      allow(@session).to receive(:require).with('launchy').and_raise(LoadError)
       allow(@session).to receive(:warn)
-
+      allow(@session).to receive(:require).with('launchy').and_raise(LoadError)
       @session.save_and_open_screenshot(file_path)
-
-      expect(@session).to have_received(:warn).
-        with("File saved to #{file_path}.")
-      expect(@session).to have_received(:warn).
-        with('Please install the launchy gem to open the file automatically.')
+      expect(@session).to have_received(:warn).with("File saved to #{file_path}.\nPlease install the launchy gem to open the file automatically.")
     end
   end
 end

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

@@ -1,76 +1,79 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#save_page' do
-  let(:alternative_path) { File.join(Dir.pwd, "save_and_open_page_tmp") }
+  let(:alternative_path) { File.join(Dir.pwd, 'save_and_open_page_tmp') }
   before do
-    @session.visit("/foo")
+    @old_save_path = Capybara.save_path
+    Capybara.save_path = nil
+    @session.visit('/foo')
   end
 
   after do
-    Capybara.save_and_open_page_path = nil
-    Capybara.save_path = nil
-    Dir.glob("capybara-*.html").each do |file|
+    Capybara.save_path = @old_save_path
+    Dir.glob('capybara-*.html').each do |file|
       FileUtils.rm(file)
     end
     FileUtils.rm_rf alternative_path
   end
 
-  it "saves the page in the root directory" do
+  it 'saves the page in the root directory' do
     @session.save_page
-    path = Dir.glob("capybara-*.html").first
-    expect(File.read(path)).to include("Another World")
+    path = Dir.glob('capybara-*.html').first
+    expect(File.read(path)).to include('Another World')
   end
 
-  it "generates a sensible filename" do
+  it 'generates a sensible filename' do
     @session.save_page
-    filename = Dir.glob("capybara-*.html").first
+    filename = Dir.glob('capybara-*.html').first
     expect(filename).to match(/^capybara-\d+\.html$/)
   end
 
-  it "can store files in a specified directory" do
+  it 'can store files in a specified directory' do
     Capybara.save_path = alternative_path
     @session.save_page
-    path = Dir.glob(alternative_path + "/capybara-*.html").first
-    expect(File.read(path)).to include("Another World")
+    path = Dir.glob("#{alternative_path}/capybara-*.html").first
+    expect(File.read(path)).to include('Another World')
   end
 
-  it "uses the given filename" do
-    @session.save_page("capybara-001122.html")
-    expect(File.read("capybara-001122.html")).to include("Another World")
+  it 'uses the given filename' do
+    @session.save_page('capybara-001122.html')
+    expect(File.read('capybara-001122.html')).to include('Another World')
   end
 
-  it "can store files in a specified directory with a given filename" do
+  it 'can store files in a specified directory with a given filename' do
     Capybara.save_path = alternative_path
-    @session.save_page("capybara-001133.html")
-    path = alternative_path + "/capybara-001133.html"
-    expect(File.read(path)).to include("Another World")
+    @session.save_page('capybara-001133.html')
+    path = "#{alternative_path}/capybara-001133.html"
+    expect(File.read(path)).to include('Another World')
   end
 
-  it "can store files in a specified directory with a given relative filename" do
+  it 'can store files in a specified directory with a given relative filename' do
     Capybara.save_path = alternative_path
-    @session.save_page("tmp/capybara-001144.html")
-    path = alternative_path + "/tmp/capybara-001144.html"
-    expect(File.read(path)).to include("Another World")
+    @session.save_page('tmp/capybara-001144.html')
+    path = "#{alternative_path}/tmp/capybara-001144.html"
+    expect(File.read(path)).to include('Another World')
   end
 
-  it "returns an absolute path in pwd" do
+  it 'returns an absolute path in pwd' do
     result = @session.save_page
-    path = File.expand_path(Dir.glob("capybara-*.html").first, Dir.pwd)
+    path = File.expand_path(Dir.glob('capybara-*.html').first, Dir.pwd)
     expect(result).to eq(path)
   end
 
-  it "returns an absolute path in given directory" do
+  it 'returns an absolute path in given directory' do
     Capybara.save_path = alternative_path
     result = @session.save_page
-    path = File.expand_path(Dir.glob(alternative_path + "/capybara-*.html").first, alternative_path)
+    path = File.expand_path(Dir.glob("#{alternative_path}/capybara-*.html").first, alternative_path)
     expect(result).to eq(path)
   end
 
-  context "asset_host contains a string" do
-    before { Capybara.asset_host = "http://example.com" }
+  context 'asset_host contains a string' do
+    before { Capybara.asset_host = 'http://example.com' }
+
     after { Capybara.asset_host = nil }
 
-    it "prepends base tag with value from asset_host to the head" do
-      @session.visit("/with_js")
+    it 'prepends base tag with value from asset_host to the head' do
+      @session.visit('/with_js')
       path = @session.save_page
 
       result = File.read(path)
@@ -79,45 +82,29 @@ Capybara::SpecHelper.spec '#save_page' do
 
     it "doesn't prepend base tag to pages when asset_host is nil" do
       Capybara.asset_host = nil
-      @session.visit("/with_js")
+      @session.visit('/with_js')
       path = @session.save_page
 
       result = File.read(path)
       expect(result).to include('<html')
-      expect(result).not_to include("http://example.com")
+      expect(result).not_to include('http://example.com')
     end
 
     it "doesn't prepend base tag to pages which already have it" do
-      @session.visit("/with_base_tag")
+      @session.visit('/with_base_tag')
       path = @session.save_page
 
       result = File.read(path)
       expect(result).to include('<html')
-      expect(result).not_to include("http://example.com")
+      expect(result).not_to include('http://example.com')
     end
 
-    it "executes successfully even if the page is missing a <head>" do
-      @session.visit("/with_simple_html")
+    it 'executes successfully even if the page is missing a <head>' do
+      @session.visit('/with_simple_html')
       path = @session.save_page
 
       result = File.read(path)
-      expect(result).to include("Bar")
-    end
-  end
-
-  context "with deprecated save_and_open_page_path" do
-    it "can store files in a specified directory" do
-      Capybara.save_and_open_page_path = alternative_path
-      @session.save_page
-      path = Dir.glob(alternative_path + "/capybara-*.html").first
-      expect(File.read(path)).to include("Another World")
-    end
-
-    it "returns an absolute path in given directory" do
-      Capybara.save_and_open_page_path = alternative_path
-      result = @session.save_page
-      path = File.expand_path(Dir.glob(alternative_path + "/capybara-*.html").first, alternative_path)
-      expect(result).to eq(path)
+      expect(result).to include('Bar')
     end
   end
 end

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

@@ -1,53 +1,55 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#save_screenshot', requires: [:screenshot] do
-  let(:alternative_path) { File.join(Dir.pwd, "save_screenshot_tmp") }
+  let(:alternative_path) { File.join(Dir.pwd, 'save_screenshot_tmp') }
   before do
+    @old_save_path = Capybara.save_path
+    Capybara.save_path = nil
     @session.visit '/foo'
   end
 
   after do
-    Capybara.save_and_open_page_path = nil
-    Capybara.save_path = nil
+    Capybara.save_path = @old_save_path
     FileUtils.rm_rf alternative_path
   end
 
-  it "generates sensible filename" do
+  it 'generates sensible filename' do
     allow(@session.driver).to receive(:save_screenshot)
 
     @session.save_screenshot
 
-    regexp = Regexp.new(File.expand_path('capybara-\d+\.png'))
-    expect(@session.driver).to have_received(:save_screenshot).with(regexp, {})
+    regexp = Regexp.new(File.join(Dir.pwd, 'capybara-\d+\.png'))
+    expect(@session.driver).to have_received(:save_screenshot).with(regexp, any_args)
   end
 
-  it "allows to specify another path" do
+  it 'allows to specify another path' do
     allow(@session.driver).to receive(:save_screenshot)
 
     custom_path = 'screenshots/1.png'
     @session.save_screenshot(custom_path)
 
-    expect(@session.driver).to have_received(:save_screenshot).with(/#{custom_path}$/, {})
+    expect(@session.driver).to have_received(:save_screenshot).with(/#{custom_path}$/, any_args)
   end
 
-  context "with Capybara.save_path" do
-    it "file is generated in the correct location" do
+  context 'with Capybara.save_path' do
+    it 'file is generated in the correct location' do
       Capybara.save_path = alternative_path
       allow(@session.driver).to receive(:save_screenshot)
 
       @session.save_screenshot
 
-      regexp = Regexp.new(File.expand_path('capybara-\d+\.png', alternative_path))
-      expect(@session.driver).to have_received(:save_screenshot).with(regexp, {})
+      regexp = Regexp.new(File.join(alternative_path, 'capybara-\d+\.png'))
+      expect(@session.driver).to have_received(:save_screenshot).with(regexp, any_args)
     end
 
-    it "relative paths are relative to save_path" do
+    it 'relative paths are relative to save_path' do
       Capybara.save_path = alternative_path
       allow(@session.driver).to receive(:save_screenshot)
 
       custom_path = 'screenshots/2.png'
       @session.save_screenshot(custom_path)
 
-      expect(@session.driver).to have_received(:save_screenshot).with(File.expand_path(custom_path, alternative_path), {})
+      expect(@session.driver).to have_received(:save_screenshot).with(File.expand_path(custom_path, alternative_path), any_args)
     end
   end
 end

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

@@ -1,14 +1,14 @@
 # coding: US-ASCII
 # frozen_string_literal: true
 
-Capybara::SpecHelper.spec "#save_screenshot" do
+Capybara::SpecHelper.spec '#save_screenshot' do
   let(:image_path) { File.join(Dir.tmpdir, 'capybara-screenshot.png') }
 
   before do
     @session.visit '/'
   end
 
-  it "should generate PNG file", requires: [:screenshot] do
+  it 'should generate PNG file', requires: [:screenshot] do
     path = @session.save_screenshot image_path
 
     magic = File.read(image_path, 4)