capybara 3.32.2

data/lib/capybara/spec/session/window/windows_spec.rb

@@ -0,0 +1,34 @@
+# 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 '#windows', requires: [:windows] do
+  before do
+    @window = @session.current_window
+    @session.visit('/with_windows')
+    @session.find(:css, '#openTwoWindows').click
+
+    @session.document.synchronize(3, errors: [Capybara::CapybaraError]) do
+      raise Capybara::CapybaraError if @session.windows.size != 3
+    end
+  end
+
+  after do
+    (@session.windows - [@window]).each(&:close)
+    @session.switch_to_window(@window)
+  end
+
+  it 'should return objects of Capybara::Window class' do
+    expect(@session.windows.map { |window| window.instance_of?(Capybara::Window) }).to eq([true] * 3)
+  end
+
+  it 'should be able to switch to windows' do
+    sleep 1 # give windows enough time to fully load
+    titles = @session.windows.map do |window|
+      @session.within_window(window) { @session.title }
+    end
+    expect(titles).to match_array(['With Windows', 'Title of the first popup', 'Title of popup two'])
+  end
+end

data/lib/capybara/spec/session/window/within_window_spec.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#within_window', requires: [:windows] do
+  before do
+    @window = @session.current_window
+    @session.visit('/with_windows')
+    @session.find(:css, '#openTwoWindows').click
+
+    @session.document.synchronize(3, errors: [Capybara::CapybaraError]) do
+      raise Capybara::CapybaraError if @session.windows.size != 3
+    end
+  end
+
+  after do
+    (@session.windows - [@window]).each do |w|
+      @session.switch_to_window w
+      w.close
+    end
+    @session.switch_to_window(@window)
+  end
+
+  context 'with an instance of Capybara::Window' do
+    it 'should not invoke driver#switch_to_window when given current window' do
+      allow(@session.driver).to receive(:switch_to_window).and_call_original
+      @session.within_window @window do
+        expect(@session.title).to eq('With Windows')
+      end
+      expect(@session.driver).not_to have_received(:switch_to_window)
+    end
+
+    it 'should be able to switch to another window' do
+      window = (@session.windows - [@window]).first
+      @session.within_window window do
+        expect(@session).to have_title(/Title of the first popup|Title of popup two/)
+      end
+      expect(@session.title).to eq('With Windows')
+    end
+
+    it 'returns value from the block' do
+      window = (@session.windows - [@window]).first
+      value = @session.within_window window do
+        43252003274489856000
+      end
+      expect(value).to eq(43252003274489856000)
+    end
+
+    it 'should switch back if exception was raised inside block' do
+      window = (@session.windows - [@window]).first
+      expect do
+        @session.within_window(window) do
+          @session.within 'html' do
+            raise 'some error'
+          end
+        end
+      end.to raise_error(StandardError, 'some error')
+      expect(@session.current_window).to eq(@window)
+      expect(@session).to have_css('#doesNotOpenWindows')
+      expect(@session.send(:scopes)).to eq([nil])
+    end
+
+    it 'should leave correct scopes after execution in case of error', requires: %i[windows frames] do
+      window = (@session.windows - [@window]).first
+      expect do
+        @session.within_frame 'frameOne' do
+          @session.within_window(window) {}
+        end
+      end.to raise_error(Capybara::ScopeError)
+      expect(@session.current_window).to eq(@window)
+      expect(@session).to have_css('#doesNotOpenWindows')
+      expect(@session.send(:scopes)).to eq([nil])
+    end
+
+    it 'should raise error if closed window was passed' do
+      other_window = (@session.windows - [@window]).first
+      @session.within_window other_window do
+        other_window.close
+      end
+      expect do
+        @session.within_window(other_window) do
+          raise 'should not be invoked'
+        end
+      end.to raise_error(@session.driver.no_such_window_error)
+      expect(@session.current_window).to eq(@window)
+      expect(@session).to have_css('#doesNotOpenWindows')
+      expect(@session.send(:scopes)).to eq([nil])
+    end
+  end
+
+  context 'with lambda' do
+    it 'should find the div in another window' do
+      @session.within_window(-> { @session.title == 'Title of the first popup' }) do
+        expect(@session).to have_css('#divInPopupOne')
+      end
+    end
+
+    it 'should find divs in both windows' do
+      @session.within_window(-> { @session.title == 'Title of popup two' }) do
+        expect(@session).to have_css('#divInPopupTwo')
+      end
+      @session.within_window(-> { @session.title == 'Title of the first popup' }) do
+        expect(@session).to have_css('#divInPopupOne')
+      end
+      expect(@session.title).to eq('With Windows')
+    end
+
+    it 'should be able to nest within_window' do
+      @session.within_window(-> { @session.title == 'Title of popup two' }) do
+        expect(@session).to have_css('#divInPopupTwo')
+        @session.within_window(-> { @session.title == 'Title of the first popup' }) do
+          expect(@session).to have_css('#divInPopupOne')
+        end
+        expect(@session).to have_css('#divInPopupTwo')
+        expect(@session).not_to have_css('divInPopupOne')
+      end
+      expect(@session).not_to have_css('#divInPopupTwo')
+      expect(@session).not_to have_css('divInPopupOne')
+      expect(@session.title).to eq('With Windows')
+    end
+
+    it 'should work inside a normal scope' do
+      expect(@session).to have_css('#openWindow')
+      @session.within(:css, '#scope') do
+        @session.within_window(-> { @session.title == 'Title of the first popup' }) do
+          expect(@session).to have_css('#divInPopupOne')
+        end
+        expect(@session).to have_content('My scoped content')
+        expect(@session).not_to have_css('#openWindow')
+      end
+    end
+
+    it "should raise error if window wasn't found" do
+      expect do
+        @session.within_window(-> { @session.title == 'Invalid title' }) do
+          expect(@session).to have_css('#divInPopupOne')
+        end
+      end.to raise_error(Capybara::WindowError, 'Could not find a window matching block/lambda')
+      expect(@session.current_window).to eq(@window)
+      expect(@session).to have_css('#doesNotOpenWindows')
+      expect(@session.send(:scopes)).to eq([nil])
+    end
+
+    it 'returns value from the block' do
+      value = @session.within_window(-> { @session.title == 'Title of popup two' }) { 42 }
+      expect(value).to eq(42)
+    end
+
+    it 'should switch back if exception was raised inside block' do
+      expect do
+        @session.within_window(-> { @session.title == 'Title of popup two' }) do
+          raise 'some error'
+        end
+      end.to raise_error(StandardError, 'some error')
+      expect(@session.current_window).to eq(@window)
+      expect(@session.send(:scopes)).to eq([nil])
+    end
+  end
+end

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

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#within' do
+  before do
+    @session.visit('/with_scope')
+  end
+
+  context 'with CSS selector' do
+    it 'should click links in the given scope' do
+      @session.within(:css, '#for_bar li:first-child') do
+        @session.click_link('Go')
+      end
+      expect(@session).to have_content('Bar')
+    end
+
+    it 'should assert content in the given scope' do
+      @session.within(:css, '#for_foo') do
+        expect(@session).not_to have_content('First Name')
+      end
+      expect(@session).to have_content('First Name')
+    end
+
+    it 'should accept additional options' do
+      @session.within(:css, '#for_bar li', text: 'With Simple HTML') do
+        @session.click_link('Go')
+      end
+      expect(@session).to have_content('Bar')
+    end
+
+    it 'should reload the node if the page is changed' do
+      @session.within(:css, '#for_foo') do
+        @session.visit('/with_scope_other')
+        expect(@session).to have_content('Different text')
+      end
+    end
+
+    it 'should reload multiple nodes if the page is changed' do
+      @session.within(:css, '#for_bar') do
+        @session.within(:css, 'form[action="/redirect"]') do
+          @session.refresh
+          expect(@session).to have_content('First Name')
+        end
+      end
+    end
+
+    it 'should error if the page is changed and a matching node no longer exists' do
+      @session.within(:css, '#for_foo') do
+        @session.visit('/')
+        expect { @session.text }.to raise_error(StandardError)
+      end
+    end
+  end
+
+  context 'with XPath selector' do
+    it 'should click links in the given scope' do
+      @session.within(:xpath, "//div[@id='for_bar']//li[contains(.,'With Simple HTML')]") do
+        @session.click_link('Go')
+      end
+      expect(@session).to have_content('Bar')
+    end
+  end
+
+  context 'with the default selector' do
+    it 'should use XPath' do
+      @session.within("//div[@id='for_bar']//li[contains(.,'With Simple HTML')]") do
+        @session.click_link('Go')
+      end
+      expect(@session).to have_content('Bar')
+    end
+  end
+
+  context 'with Node rather than selector' do
+    it 'should click links in the given scope' do
+      node_of_interest = @session.find(:css, '#for_bar li', text: 'With Simple HTML')
+
+      @session.within(node_of_interest) do
+        @session.click_link('Go')
+      end
+      expect(@session).to have_content('Bar')
+    end
+  end
+
+  context 'with the default selector set to CSS' do
+    before { Capybara.default_selector = :css }
+
+    after { Capybara.default_selector = :xpath }
+
+    it 'should use CSS' do
+      @session.within('#for_bar li', text: 'With Simple HTML') do
+        @session.click_link('Go')
+      end
+      expect(@session).to have_content('Bar')
+    end
+  end
+
+  context 'with nested scopes' do
+    it 'should respect the inner scope' do
+      @session.within("//div[@id='for_bar']") do
+        @session.within(".//li[contains(.,'Bar')]") do
+          @session.click_link('Go')
+        end
+      end
+      expect(@session).to have_content('Another World')
+    end
+
+    it 'should respect the outer scope' do
+      @session.within("//div[@id='another_foo']") do
+        @session.within(".//li[contains(.,'With Simple HTML')]") do
+          @session.click_link('Go')
+        end
+      end
+      expect(@session).to have_content('Hello world')
+    end
+  end
+
+  it 'should raise an error if the scope is not found on the page' do
+    expect do
+      @session.within("//div[@id='doesnotexist']") do
+      end
+    end.to raise_error(Capybara::ElementNotFound)
+  end
+
+  it 'should restore the scope when an error is raised' do
+    expect do
+      @session.within("//div[@id='for_bar']") do
+        expect do
+          expect do
+            @session.within(".//div[@id='doesnotexist']") do
+            end
+          end.to raise_error(Capybara::ElementNotFound)
+        end.not_to change { @session.has_xpath?(".//div[@id='another_foo']") }.from(false)
+      end
+    end.not_to change { @session.has_xpath?(".//div[@id='another_foo']") }.from(true)
+  end
+
+  it 'should fill in a field and click a button' do
+    @session.within("//li[contains(.,'Bar')]") do
+      @session.click_button('Go')
+    end
+    expect(extract_results(@session)['first_name']).to eq('Peter')
+    @session.visit('/with_scope')
+    @session.within("//li[contains(.,'Bar')]") do
+      @session.fill_in('First Name', with: 'Dagobert')
+      @session.click_button('Go')
+    end
+    expect(extract_results(@session)['first_name']).to eq('Dagobert')
+  end
+
+  it 'should have #within_element as an alias' do
+    expect(Capybara::Session.instance_method(:within)).to eq Capybara::Session.instance_method(:within_element)
+    @session.within_element(:css, '#for_foo') do
+      expect(@session).not_to have_content('First Name')
+    end
+  end
+end
+
+Capybara::SpecHelper.spec '#within_fieldset' do
+  before do
+    @session.visit('/fieldsets')
+  end
+
+  it 'should restrict scope to a fieldset given by id' do
+    @session.within_fieldset('villain_fieldset') do
+      @session.fill_in('Name', with: 'Goldfinger')
+      @session.click_button('Create')
+    end
+    expect(extract_results(@session)['villain_name']).to eq('Goldfinger')
+  end
+
+  it 'should restrict scope to a fieldset given by legend' do
+    @session.within_fieldset('Villain') do
+      @session.fill_in('Name', with: 'Goldfinger')
+      @session.click_button('Create')
+    end
+    expect(extract_results(@session)['villain_name']).to eq('Goldfinger')
+  end
+end
+
+Capybara::SpecHelper.spec '#within_table' do
+  before do
+    @session.visit('/tables')
+  end
+
+  it 'should restrict scope to a fieldset given by id' do
+    @session.within_table('girl_table') do
+      @session.fill_in('Name', with: 'Christmas')
+      @session.click_button('Create')
+    end
+    expect(extract_results(@session)['girl_name']).to eq('Christmas')
+  end
+
+  it 'should restrict scope to a fieldset given by legend' do
+    @session.within_table('Villain') do
+      @session.fill_in('Name', with: 'Quantum')
+      @session.click_button('Create')
+    end
+    expect(extract_results(@session)['villain_name']).to eq('Quantum')
+  end
+end

data/lib/capybara/spec/spec_helper.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'rspec/expectations'
+require 'capybara'
+require 'capybara/rspec' # Required here instead of in rspec_spec to avoid RSpec deprecation warning
+require 'capybara/spec/test_app'
+require 'nokogiri'
+
+Capybara.save_path = File.join(Dir.pwd, 'save_path_tmp')
+
+module Capybara
+  module SpecHelper
+    class << self
+      def configure(config)
+        config.filter_run_excluding requires: method(:filter).to_proc
+        config.before { Capybara::SpecHelper.reset! }
+        config.after { Capybara::SpecHelper.reset! }
+        config.shared_context_metadata_behavior = :apply_to_host_groups
+      end
+
+      def reset!
+        Capybara.app = TestApp
+        Capybara.app_host = nil
+        Capybara.default_selector = :xpath
+        Capybara.default_max_wait_time = 1
+        Capybara.ignore_hidden_elements = true
+        Capybara.exact = false
+        Capybara.raise_server_errors = true
+        Capybara.visible_text_only = false
+        Capybara.match = :smart
+        Capybara.enable_aria_label = false
+        Capybara.default_set_options = {}
+        Capybara.disable_animation = false
+        Capybara.test_id = nil
+        Capybara.predicates_wait = true
+        Capybara.default_normalize_ws = false
+        Capybara.allow_gumbo = true
+        Capybara.w3c_click_offset = false
+        reset_threadsafe
+      end
+
+      def filter(requires, metadata)
+        if requires && metadata[:capybara_skip]
+          requires.any? do |require|
+            metadata[:capybara_skip].include?(require)
+          end
+        else
+          false
+        end
+      end
+
+      def spec(name, *options, &block)
+        @specs ||= []
+        @specs << [name, options, block]
+      end
+
+      def run_specs(session, name, **options, &filter_block)
+        specs = @specs
+        RSpec.describe Capybara::Session, name, options do # rubocop:disable RSpec/EmptyExampleGroup
+          include Capybara::SpecHelper
+          include Capybara::RSpecMatchers
+
+          before do |example|
+            @session = session
+            instance_exec(example, &filter_block) if filter_block
+          end
+
+          after do
+            session.reset_session!
+          end
+
+          before :each, psc: true do
+            SpecHelper.reset_threadsafe(true, session)
+          end
+
+          after psc: true do
+            SpecHelper.reset_threadsafe(false, session)
+          end
+
+          before :each, :exact_false do
+            Capybara.exact = false
+          end
+
+          specs.each do |spec_name, spec_options, block|
+            describe spec_name, *spec_options do # rubocop:disable RSpec/EmptyExampleGroup
+              class_eval(&block)
+            end
+          end
+        end
+      end
+
+      def reset_threadsafe(bool = false, session = nil)
+        Capybara::Session.class_variable_set(:@@instance_created, false) # Work around limit on when threadsafe can be changed
+        Capybara.threadsafe = bool
+        session = session.current_session if session.respond_to?(:current_session)
+        session&.instance_variable_set(:@config, nil)
+      end
+    end
+
+    def silence_stream(stream)
+      old_stream = stream.dup
+      stream.reopen(RbConfig::CONFIG['host_os'].match?(/rmswin|mingw/) ? 'NUL:' : '/dev/null')
+      stream.sync = true
+      yield
+    ensure
+      stream.reopen(old_stream)
+    end
+
+    def quietly
+      silence_stream(STDOUT) do
+        silence_stream(STDERR) do
+          yield
+        end
+      end
+    end
+
+    def extract_results(session)
+      expect(session).to have_xpath("//pre[@id='results']")
+      # YAML.load Nokogiri::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
+      YAML.load Capybara::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
+    end
+
+    def be_an_invalid_element_error(session)
+      satisfy { |error| session.driver.invalid_element_errors.any? { |e| error.is_a? e } }
+    end
+
+    def with_os_path_separators(path)
+      Gem.win_platform? ? path.to_s.tr('/', '\\') : path.to_s
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + '/session/**/*.rb'].each { |file| require_relative file }