capybara 3.32.2

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#become_closed', requires: %i[windows js] do
+  let!(:window) { @session.current_window }
+  let(:other_window) do
+    @session.window_opened_by do
+      @session.find(:css, '#openWindow').click
+    end
+  end
+
+  before do
+    @session.visit('/with_windows')
+  end
+
+  after do
+    @session.document.synchronize(5, errors: [Capybara::CapybaraError]) do
+      raise Capybara::CapybaraError if @session.windows.size != 1
+    end
+    @session.switch_to_window(window)
+  end
+
+  context 'with :wait option' do
+    it 'should wait if value of :wait is more than timeout' do
+      @session.within_window other_window do
+        @session.execute_script('setTimeout(function(){ window.close(); }, 500);')
+      end
+      Capybara.using_wait_time 0.1 do
+        expect(other_window).to become_closed(wait: 5)
+      end
+    end
+
+    it 'should raise error if value of :wait is less than timeout' do
+      @session.within_window other_window do
+        @session.execute_script('setTimeout(function(){ window.close(); }, 1000);')
+      end
+      Capybara.using_wait_time 2 do
+        expect do
+          expect(other_window).to become_closed(wait: 0.2)
+        end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /\Aexpected #<Window @handle=".+"> to become closed after 0.2 seconds\Z/)
+      end
+    end
+  end
+
+  context 'without :wait option' do
+    it 'should wait if value of default_max_wait_time is more than timeout' do
+      @session.within_window other_window do
+        @session.execute_script('setTimeout(function(){ window.close(); }, 500);')
+      end
+      Capybara.using_wait_time 5 do
+        expect(other_window).to become_closed
+      end
+    end
+
+    it 'should raise error if value of default_max_wait_time is less than timeout' do
+      @session.within_window other_window do
+        @session.execute_script('setTimeout(function(){ window.close(); }, 900);')
+      end
+      Capybara.using_wait_time 0.4 do
+        expect do
+          expect(other_window).to become_closed
+        end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /\Aexpected #<Window @handle=".+"> to become closed after 0.4 seconds\Z/)
+      end
+    end
+  end
+
+  context 'with not_to' do
+    it "should not raise error if window doesn't close before default_max_wait_time" do
+      @session.within_window other_window do
+        @session.execute_script('setTimeout(function(){ window.close(); }, 1000);')
+      end
+      Capybara.using_wait_time 0.3 do
+        expect do
+          expect(other_window).not_to become_closed
+        end.not_to raise_error
+      end
+    end
+
+    it 'should raise error if window closes before default_max_wait_time' do
+      @session.within_window other_window do
+        @session.execute_script('setTimeout(function(){ window.close(); }, 700);')
+      end
+      Capybara.using_wait_time 3.1 do
+        expect do
+          expect(other_window).not_to become_closed
+        end.to raise_error(RSpec::Expectations::ExpectationNotMetError, /\Aexpected #<Window @handle=".+"> not to become closed after 3.1 seconds\Z/)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#current_window', requires: [:windows] do
+  before do
+    @window = @session.current_window
+    @session.visit('/with_windows')
+  end
+
+  after do
+    (@session.windows - [@window]).each do |w|
+      @session.switch_to_window w
+      w.close
+    end
+    @session.switch_to_window(@window)
+  end
+
+  it 'should return window' do
+    expect(@session.current_window).to be_instance_of(Capybara::Window)
+  end
+
+  it 'should be modified by switching to another window' do
+    window = @session.window_opened_by { @session.find(:css, '#openWindow').click }
+
+    expect do
+      @session.switch_to_window(window)
+    end.to change { @session.current_window }.from(@window).to(window)
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#open_new_window', requires: [:windows] do
+  before do
+    @window = @session.current_window
+    @session.visit('/with_windows')
+  end
+
+  after do
+    (@session.windows - [@window]).each do |w|
+      @session.switch_to_window w
+      w.close
+    end
+    @session.switch_to_window(@window)
+  end
+
+  it 'should open new window with blank url and title' do
+    window = @session.open_new_window
+    @session.switch_to_window(window)
+    expect(@session.title).to satisfy('be a blank title') { |title| ['', 'about:blank'].include? title }
+    expect(@session.current_url).to eq('about:blank')
+  end
+
+  it 'should open window with changeable content' do
+    window = @session.open_new_window
+    @session.within_window window do
+      @session.visit '/with_html'
+      expect(@session).to have_css('#first')
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+# 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 '#switch_to_window', requires: [:windows] do
+  before do
+    @window = @session.current_window
+    @session.visit('/with_windows')
+    @session.assert_selector(:css, 'body.loaded')
+  end
+
+  after do
+    (@session.windows - [@window]).each do |w|
+      @session.switch_to_window w
+      w.close
+    end
+    @session.switch_to_window(@window)
+  end
+
+  it 'should raise error when invoked without args' do
+    expect do
+      @session.switch_to_window
+    end.to raise_error(ArgumentError, '`switch_to_window`: either window or block should be provided')
+  end
+
+  it 'should raise error when invoked with window and block' do
+    expect do
+      @session.switch_to_window(@window) { @session.title == 'Title of the first popup' }
+    end.to raise_error(ArgumentError, '`switch_to_window` can take either a block or a window, not both')
+  end
+
+  context 'with an instance of Capybara::Window' do
+    it 'should be able to switch to window' do
+      window = @session.open_new_window
+      expect(@session.title).to eq('With Windows')
+      @session.switch_to_window(window)
+      expect(@session.title).to satisfy('be a blank title') { |title| ['', 'about:blank'].include? title }
+    end
+
+    it 'should raise error when closed window is passed' do
+      original_window = @session.current_window
+      new_window = @session.open_new_window
+      @session.switch_to_window(new_window)
+      new_window.close
+      @session.switch_to_window(original_window)
+      expect do
+        @session.switch_to_window(new_window)
+      end.to raise_error(@session.driver.no_such_window_error)
+    end
+  end
+
+  context 'with block' do
+    before do
+      @session.find(:css, '#openTwoWindows').click
+      sleep(1) # wait for the windows to open
+    end
+
+    it 'should be able to switch to current window' do
+      @session.switch_to_window { @session.title == 'With Windows' }
+      expect(@session).to have_css('#openTwoWindows')
+    end
+
+    it 'should find the div in another window' do
+      @session.switch_to_window { @session.title == 'Title of popup two' }
+      expect(@session).to have_css('#divInPopupTwo')
+    end
+
+    it 'should be able to switch multiple times' do
+      @session.switch_to_window { @session.title == 'Title of the first popup' }
+      expect(@session).to have_css('#divInPopupOne')
+      @session.switch_to_window { @session.title == 'Title of popup two' }
+      expect(@session).to have_css('#divInPopupTwo')
+    end
+
+    it 'should return window' do
+      window = @session.switch_to_window { @session.title == 'Title of popup two' }
+      expect((@session.windows - [@window])).to include(window)
+    end
+
+    it "should raise error when invoked inside `within` as it's nonsense" do
+      expect do
+        @session.within(:css, '#doesNotOpenWindows') do
+          @session.switch_to_window { @session.title == 'With Windows' }
+        end
+      end.to raise_error(Capybara::ScopeError, /`switch_to_window` is not supposed to be invoked/)
+    end
+
+    it "should raise error when invoked inside `within_frame` as it's nonsense" do
+      expect do
+        @session.within_frame('frameOne') do
+          @session.switch_to_window { @session.title == 'With Windows' }
+        end
+      end.to raise_error(Capybara::ScopeError, /`switch_to_window` is not supposed to be invoked from/)
+    end
+
+    it 'should allow to be called inside within_window and within_window will still return to original' do
+      other_windows = (@session.windows - [@window])
+      expect(@session.current_window).to eq(@window)
+      @session.within_window other_windows[0] do
+        expect(@session.current_window).to eq(other_windows[0])
+        @session.switch_to_window other_windows[1]
+        expect(@session.current_window).to eq(other_windows[1])
+      end
+      expect(@session.current_window).to eq(@window)
+    end
+
+    it "should raise error if window matching block wasn't found" do
+      original = @session.current_window
+      expect do
+        @session.switch_to_window { @session.title == 'A title' }
+      end.to raise_error(Capybara::WindowError, 'Could not find a window matching block/lambda')
+      expect(@session.current_window).to eq(original)
+    end
+
+    it 'should switch to original window if error is raised inside block' do
+      original = @session.switch_to_window(@session.windows[1])
+      expect do
+        @session.switch_to_window { raise 'error' }
+      end.to raise_error(StandardError, 'error')
+      expect(@session.current_window).to eq(original)
+    end
+  end
+
+  it 'should wait for window to appear' do
+    @session.find(:css, '#openWindowWithTimeout').click
+    expect do
+      @session.switch_to_window(wait: 5) { @session.title == 'Title of the first popup' }
+    end.not_to raise_error
+  end
+end

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

@@ -0,0 +1,99 @@
+# 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 '#window_opened_by', requires: [:windows] do
+  before do
+    @window = @session.current_window
+    @session.visit('/with_windows')
+    @session.assert_selector(:css, 'body.loaded')
+  end
+
+  after do
+    (@session.windows - [@window]).each do |w|
+      @session.switch_to_window w
+      w.close
+    end
+    @session.switch_to_window(@window)
+  end
+
+  let(:zero_windows_message) { 'block passed to #window_opened_by opened 0 windows instead of 1' }
+  let(:two_windows_message) { 'block passed to #window_opened_by opened 2 windows instead of 1' }
+
+  context 'with :wait option' do
+    it 'should raise error if value of :wait is less than timeout' do
+      # So large value is used as `driver.window_handles` takes up to 800 ms on Travis
+      Capybara.using_wait_time 2 do
+        button = @session.find(:css, '#openWindowWithLongerTimeout')
+        expect do
+          @session.window_opened_by(wait: 0.3) do
+            button.click
+          end
+        end.to raise_error(Capybara::WindowError, zero_windows_message)
+      end
+      @session.document.synchronize(5, errors: [Capybara::CapybaraError]) do
+        raise Capybara::CapybaraError if @session.windows.size != 2
+      end
+    end
+
+    it 'should find window if value of :wait is more than timeout' do
+      button = @session.find(:css, '#openWindowWithTimeout')
+      Capybara.using_wait_time 0.1 do
+        window = @session.window_opened_by(wait: 1.5) do
+          button.click
+        end
+        expect(window).to be_instance_of(Capybara::Window)
+      end
+    end
+  end
+
+  context 'without :wait option' do
+    it 'should raise error if default_max_wait_time is less than timeout' do
+      button = @session.find(:css, '#openWindowWithTimeout')
+      Capybara.using_wait_time 0.1 do
+        expect do
+          @session.window_opened_by do
+            button.click
+          end
+        end.to raise_error(Capybara::WindowError, zero_windows_message)
+      end
+      @session.document.synchronize(2, errors: [Capybara::CapybaraError]) do
+        raise Capybara::CapybaraError if @session.windows.size != 2
+      end
+    end
+
+    it 'should find window if default_max_wait_time is more than timeout' do
+      button = @session.find(:css, '#openWindowWithTimeout')
+      Capybara.using_wait_time 5 do
+        window = @session.window_opened_by do
+          button.click
+        end
+        expect(window).to be_instance_of(Capybara::Window)
+      end
+    end
+  end
+
+  it 'should raise error when two windows have been opened by block' do
+    button = @session.find(:css, '#openTwoWindows')
+    expect do
+      @session.window_opened_by do
+        button.click
+        sleep 1 # It's possible for window_opened_by to be fullfilled before the second window opens
+      end
+    end.to raise_error(Capybara::WindowError, two_windows_message)
+    @session.document.synchronize(2, errors: [Capybara::CapybaraError]) do
+      raise Capybara::CapybaraError if @session.windows.size != 3
+    end
+  end
+
+  it 'should raise error when no windows were opened by block' do
+    button = @session.find(:css, '#doesNotOpenWindows')
+    expect do
+      @session.window_opened_by do
+        button.click
+      end
+    end.to raise_error(Capybara::WindowError, zero_windows_message)
+  end
+end

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

@@ -0,0 +1,203 @@
+# 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 Capybara::Window, requires: [:windows] do
+  let!(:orig_window) { @session.current_window }
+  before do
+    @session.visit('/with_windows')
+  end
+
+  after do
+    (@session.windows - [orig_window]).each do |w|
+      @session.switch_to_window w
+      w.close
+    end
+    @session.switch_to_window(orig_window)
+  end
+
+  describe '#exists?' do
+    it 'should become false after window was closed' do
+      other_window = @session.window_opened_by do
+        @session.find(:css, '#openWindow').click
+      end
+
+      expect do
+        @session.switch_to_window other_window
+        other_window.close
+      end.to change(other_window, :exists?).from(true).to(false)
+    end
+  end
+
+  describe '#closed?' do
+    it 'should become true after window was closed' do
+      other_window = @session.window_opened_by do
+        @session.find(:css, '#openWindow').click
+      end
+      expect do
+        @session.switch_to_window other_window
+        other_window.close
+      end.to change { other_window.closed? }.from(false).to(true)
+    end
+  end
+
+  describe '#current?' do
+    let(:other_window) do
+      @session.window_opened_by do
+        @session.find(:css, '#openWindow').click
+      end
+    end
+
+    it 'should become true after switching to window' do
+      expect do
+        @session.switch_to_window(other_window)
+      end.to change(other_window, :current?).from(false).to(true)
+    end
+
+    it 'should return false if window is closed' do
+      @session.switch_to_window(other_window)
+      other_window.close
+      expect(other_window.current?).to eq(false)
+    end
+  end
+
+  describe '#close' do
+    let!(:other_window) do
+      @session.window_opened_by do
+        @session.find(:css, '#openWindow').click
+      end
+    end
+
+    it 'should switch to original window if invoked not for current window' do
+      expect(@session.windows.size).to eq(2)
+      expect(@session.current_window).to eq(orig_window)
+      other_window.close
+      expect(@session.windows.size).to eq(1)
+      expect(@session.current_window).to eq(orig_window)
+    end
+
+    it 'should make subsequent invocations of other methods raise no_such_window_error if invoked for current window' do
+      @session.switch_to_window(other_window)
+      expect(@session.current_window).to eq(other_window)
+      other_window.close
+      expect do
+        @session.find(:css, '#some_id')
+      end.to raise_error(@session.driver.no_such_window_error)
+      @session.switch_to_window(orig_window)
+    end
+  end
+
+  describe '#size' do
+    def win_size
+      @session.evaluate_script('[window.outerWidth || window.innerWidth, window.outerHeight || window.innerHeight]')
+    end
+
+    it 'should return size of whole window', requires: %i[windows js] do
+      expect(@session.current_window.size).to eq win_size
+    end
+
+    it 'should switch to original window if invoked not for current window' do
+      other_window = @session.window_opened_by do
+        @session.find(:css, '#openWindow').click
+      end
+      sleep 1
+      size = @session.within_window(other_window) do
+        win_size
+      end
+      expect(other_window.size).to eq(size)
+      expect(@session.current_window).to eq(orig_window)
+    end
+  end
+
+  describe '#resize_to' do
+    let!(:initial_size) { @session.current_window.size }
+
+    after do
+      @session.current_window.resize_to(*initial_size)
+      sleep 1
+    end
+
+    it 'should be able to resize window', requires: %i[windows js] do
+      width, height = initial_size
+      @session.current_window.resize_to(width - 100, height - 100)
+      sleep 1
+      expect(@session.current_window.size).to eq([width - 100, height - 100])
+    end
+
+    it 'should stay on current window if invoked not for current window', requires: %i[windows js] do
+      other_window = @session.window_opened_by do
+        @session.find(:css, '#openWindow').click
+      end
+
+      other_window.resize_to(600, 400)
+      expect(@session.current_window).to eq(orig_window)
+
+      @session.within_window(other_window) do
+        expect(@session.current_window.size).to eq([600, 400])
+      end
+    end
+  end
+
+  describe '#maximize' do
+    let! :initial_size do
+      @session.current_window.size
+    end
+
+    after do
+      @session.current_window.resize_to(*initial_size)
+      sleep 0.5
+    end
+
+    it 'should be able to maximize window', requires: %i[windows js] do
+      start_width, start_height = 400, 300
+      @session.current_window.resize_to(start_width, start_height)
+      sleep 0.5
+
+      @session.current_window.maximize
+      sleep 0.5 # The timing on maximize is finicky on Travis -- wait a bit for maximize to occur
+
+      max_width, max_height = @session.current_window.size
+
+      # maximize behavior is window manage dependant, so just make sure it increases in size
+      expect(max_width).to be > start_width
+      expect(max_height).to be > start_height
+    end
+
+    it 'should stay on current window if invoked not for current window', requires: %i[windows js] do
+      other_window = @session.window_opened_by do
+        @session.find(:css, '#openWindow').click
+      end
+      other_window.resize_to(400, 300)
+      sleep 0.5
+      other_window.maximize
+      sleep 0.5 # The timing on maximize is finicky on Travis -- wait a bit for maximize to occur
+
+      expect(@session.current_window).to eq(orig_window)
+      # Maximizing the browser affects all tabs so this may not be valid in real browsers
+      # expect(@session.current_window.size).to eq(initial_size)
+
+      ow_width, ow_height = other_window.size
+      expect(ow_width).to be > 400
+      expect(ow_height).to be > 300
+    end
+  end
+
+  describe '#fullscreen' do
+    let! :initial_size do
+      @session.current_window.size
+    end
+
+    after do
+      @session.current_window.resize_to(*initial_size)
+      sleep 1
+    end
+
+    it 'should be able to fullscreen the window' do
+      expect do
+        @session.current_window.fullscreen
+      end.not_to raise_error
+    end
+  end
+end