capybara 2.7.0 → 3.35.3

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

@@ -1,113 +1,156 @@
 # frozen_string_literal: true
+
 Capybara::SpecHelper.spec '#first' do
   before do
     @session.visit('/with_html')
   end
 
-  it "should find the first element using the given locator" do
+  it 'should find the first element using the given locator' do
     expect(@session.first('//h1').text).to eq('This is a test')
-    expect(@session.first("//input[@id='test_field']")[:value]).to eq('monkey')
+    expect(@session.first("//input[@id='test_field']").value).to eq('monkey')
+  end
+
+  it 'should raise ElementNotFound when nothing was found' do
+    expect do
+      @session.first('//div[@id="nosuchthing"]')
+    end.to raise_error Capybara::ElementNotFound
   end
 
-  it "should return nil when nothing was found" do
-    expect(@session.first('//div[@id="nosuchthing"]')).to be_nil
+  it 'should return nil when nothing was found if count options allow no results' do
+    expect(@session.first('//div[@id="nosuchthing"]', minimum: 0)).to be_nil
+    expect(@session.first('//div[@id="nosuchthing"]', count: 0)).to be_nil
+    expect(@session.first('//div[@id="nosuchthing"]', between: (0..3))).to be_nil
   end
 
-  it "should accept an XPath instance" do
+  it 'should accept an XPath instance' do
     @session.visit('/form')
-    @xpath = XPath::HTML.fillable_field('First Name')
+    @xpath = Capybara::Selector.new(:fillable_field, config: {}, format: :xpath).call('First Name')
+    expect(@xpath).to be_a(::XPath::Union)
     expect(@session.first(@xpath).value).to eq('John')
   end
 
-  context "with css selectors" do
-    it "should find the first element using the given selector" do
+  it 'should raise when unused parameters are passed' do
+    expect do
+      @session.first(:css, 'h1', 'unused text')
+    end.to raise_error ArgumentError, /Unused parameters passed.*unused text/
+  end
+
+  context 'with css selectors' do
+    it 'should find the first element using the given selector' do
       expect(@session.first(:css, 'h1').text).to eq('This is a test')
-      expect(@session.first(:css, "input[id='test_field']")[:value]).to eq('monkey')
+      expect(@session.first(:css, "input[id='test_field']").value).to eq('monkey')
     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.first(:xpath, '//h1').text).to eq('This is a test')
-      expect(@session.first(:xpath, "//input[@id='test_field']")[:value]).to eq('monkey')
+      expect(@session.first(:xpath, "//input[@id='test_field']").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.first('h1').text).to eq('This is a test')
-      expect(@session.first("input[id='test_field']")[:value]).to eq('monkey')
+      expect(@session.first("input[id='test_field']").value).to eq('monkey')
     end
   end
 
-  context "with visible filter" do
-    it "should only find visible nodes when true" do
-      expect(@session.first(:css, "a#invisible", :visible => true)).to be_nil
+  context 'with visible filter' do
+    it 'should only find visible nodes when true' do
+      expect do
+        @session.first(:css, 'a#invisible', visible: true)
+      end.to raise_error Capybara::ElementNotFound
     end
 
-    it "should find nodes regardless of whether they are invisible when false" do
-      expect(@session.first(:css, "a#invisible", :visible => false)).not_to be_nil
-      expect(@session.first(:css, "a#visible", :visible => false)).not_to be_nil
+    it 'should find nodes regardless of whether they are invisible when false' do
+      expect(@session.first(:css, 'a#invisible', visible: false)).to be_truthy
+      expect(@session.first(:css, 'a#invisible', visible: false, text: 'hidden link')).to be_truthy
+      expect(@session.first(:css, 'a#visible', visible: false)).to be_truthy
     end
 
-    it "should find nodes regardless of whether they are invisible when :all" do
-      expect(@session.first(:css, "a#invisible", :visible => :all)).not_to be_nil
-      expect(@session.first(:css, "a#visible", :visible => :all)).not_to be_nil
+    it 'should find nodes regardless of whether they are invisible when :all' do
+      expect(@session.first(:css, 'a#invisible', visible: :all)).to be_truthy
+      expect(@session.first(:css, 'a#invisible', visible: :all, text: 'hidden link')).to be_truthy
+      expect(@session.first(:css, 'a#visible', visible: :all)).to be_truthy
     end
 
-    it "should find only hidden nodes when :hidden" do
-      expect(@session.first(:css, "a#invisible", :visible => :hidden)).not_to be_nil
-      expect(@session.first(:css, "a#visible", :visible => :hidden)).to be_nil
+    it 'should find only hidden nodes when :hidden' do
+      expect(@session.first(:css, 'a#invisible', visible: :hidden)).to be_truthy
+      expect(@session.first(:css, 'a#invisible', visible: :hidden, text: 'hidden link')).to be_truthy
+      expect do
+        @session.first(:css, 'a#invisible', visible: :hidden, text: 'not hidden link')
+      end.to raise_error Capybara::ElementNotFound
+      expect do
+        @session.first(:css, 'a#visible', visible: :hidden)
+      end.to raise_error Capybara::ElementNotFound
     end
 
-    it "should find only visible nodes when :visible" do
-      expect(@session.first(:css, "a#invisible", :visible => :visible)).to be_nil
-      expect(@session.first(:css, "a#visible", :visible => :visible)).not_to be_nil
+    it 'should find only visible nodes when :visible' do
+      expect do
+        @session.first(:css, 'a#invisible', visible: :visible)
+      end.to raise_error Capybara::ElementNotFound
+      expect do
+        @session.first(:css, 'a#invisible', visible: :visible, text: 'hidden link')
+      end.to raise_error Capybara::ElementNotFound
+      expect(@session.first(:css, 'a#visible', visible: :visible)).to be_truthy
     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.first(:css, "a#invisible")).to be_nil
+      expect do
+        @session.first(:css, 'a#invisible')
+      end.to raise_error Capybara::ElementNotFound
       Capybara.ignore_hidden_elements = false
-      expect(@session.first(:css, "a#invisible")).not_to be_nil
-      expect(@session.first(:css, "a")).not_to be_nil
+      expect(@session.first(:css, 'a#invisible')).to be_truthy
+      expect(@session.first(:css, 'a')).to be_truthy
     end
   end
 
-  context "within a scope" do
+  context 'within a scope' do
     before do
       @session.visit('/with_scope')
     end
 
-    it "should find the first element using the given locator" do
+    it 'should find the first element using the given locator' do
       @session.within(:xpath, "//div[@id='for_bar']") do
-        expect(@session.first('.//form')).not_to be_nil
+        expect(@session.first('.//form')).to be_truthy
       end
     end
   end
 
-  context "with Capybara.wait_on_first_by_default", requires: [:js] do
+  context 'waiting behavior', requires: [:js] do
     before do
       @session.visit('/with_js')
     end
 
-    it "should not wait if false" do
-      Capybara.wait_on_first_by_default = false
+    it 'should not wait if minimum: 0' do
       @session.click_link('clickable')
-      expect(@session.first(:css, 'a#has-been-clicked')).to be_nil
+      Capybara.using_wait_time(3) do
+        start_time = Time.now
+        expect(@session.first(:css, 'a#has-been-clicked', minimum: 0)).to be_nil
+        expect(Time.now - start_time).to be < 3
+      end
     end
 
-    it "should wait for at least one match if true" do
-      Capybara.wait_on_first_by_default = true
-      @session.click_link('clickable')
-      expect(@session.first(:css, 'a#has-been-clicked')).not_to be_nil
+    it 'should wait for at least one match by default' do
+      Capybara.using_wait_time(3) do
+        @session.click_link('clickable')
+        expect(@session.first(:css, 'a#has-been-clicked')).not_to be_nil
+      end
     end
 
-    it "should return nil after waiting if no match" do
-      Capybara.wait_on_first_by_default = true
+    it 'should raise an error after waiting if no match' do
       @session.click_link('clickable')
-      expect(@session.first(:css, 'a#not-a-real-link')).to be_nil
+      Capybara.using_wait_time(3) do
+        start_time = Time.now
+        expect do
+          @session.first(:css, 'a#not-a-real-link')
+        end.to raise_error Capybara::ElementNotFound
+        expect(Time.now - start_time).to be > 3
+      end
     end
   end
 end

data/lib/capybara/spec/session/frame/frame_title_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#frame_title', requires: [:frames] do
+  before do
+    @session.visit('/within_frames')
+  end
+
+  it 'should return the title in a frame' do
+    @session.within_frame('frameOne') do
+      expect(@session.driver.frame_title).to eq 'This is the title of frame one'
+    end
+  end
+
+  it 'should return the title in FrameTwo' do
+    @session.within_frame('frameTwo') do
+      expect(@session.driver.frame_title).to eq 'This is the title of frame two'
+    end
+  end
+
+  it 'should return the title in the main frame' do
+    expect(@session.driver.frame_title).to eq 'With Frames'
+  end
+end

data/lib/capybara/spec/session/frame/frame_url_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#frame_url', requires: [:frames] do
+  before do
+    @session.visit('/within_frames')
+  end
+
+  it 'should return the url in a frame' do
+    @session.within_frame('frameOne') do
+      expect(@session.driver.frame_url).to end_with '/frame_one'
+    end
+  end
+
+  it 'should return the url in FrameTwo' do
+    @session.within_frame('frameTwo') do
+      expect(@session.driver.frame_url).to end_with '/frame_two'
+    end
+  end
+
+  it 'should return the url in the main frame' do
+    expect(@session.driver.frame_url).to end_with('/within_frames')
+  end
+end

data/lib/capybara/spec/session/frame/switch_to_frame_spec.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#switch_to_frame', requires: [:frames] do
+  before do
+    @session.visit('/within_frames')
+  end
+
+  after do
+    # Ensure we clean up after the frame changes
+    @session.switch_to_frame(:top)
+  end
+
+  it 'should find the div in frameOne' do
+    frame = @session.find(:frame, 'frameOne')
+    @session.switch_to_frame(frame)
+    expect(@session.find("//*[@id='divInFrameOne']").text).to eql 'This is the text of divInFrameOne'
+  end
+
+  it 'should find the div in FrameTwo' do
+    frame = @session.find(:frame, 'frameTwo')
+    @session.switch_to_frame(frame)
+    expect(@session.find("//*[@id='divInFrameTwo']").text).to eql 'This is the text of divInFrameTwo'
+  end
+
+  it 'should return to the parent frame when told to' do
+    frame = @session.find(:frame, 'frameOne')
+    @session.switch_to_frame(frame)
+    @session.switch_to_frame(:parent)
+    expect(@session.find("//*[@id='divInMainWindow']").text).to eql 'This is the text for divInMainWindow'
+  end
+
+  it 'should be able to switch to nested frames' do
+    frame = @session.find(:frame, 'parentFrame')
+    @session.switch_to_frame frame
+    frame = @session.find(:frame, 'childFrame')
+    @session.switch_to_frame frame
+    frame = @session.find(:frame, 'grandchildFrame1')
+    @session.switch_to_frame frame
+    expect(@session).to have_selector(:css, '#divInFrameOne', text: 'This is the text of divInFrameOne')
+  end
+
+  it 'should reset scope when changing frames' do
+    frame = @session.find(:frame, 'parentFrame')
+    @session.within(:css, '#divInMainWindow') do
+      @session.switch_to_frame(frame)
+      expect(@session.has_selector?(:css, 'iframe#childFrame')).to be true
+      @session.switch_to_frame(:parent)
+    end
+  end
+
+  it 'works if the frame is closed', requires: %i[frames js] do
+    frame = @session.find(:frame, 'parentFrame')
+    @session.switch_to_frame frame
+    frame = @session.find(:frame, 'childFrame')
+    @session.switch_to_frame frame
+    @session.click_link 'Close Window Now'
+    @session.switch_to_frame :parent # Go back to parentFrame
+    expect(@session).to have_selector(:css, 'body#parentBody')
+    expect(@session).not_to have_selector(:css, '#childFrame')
+    @session.switch_to_frame :parent # Go back to top
+  end
+
+  it 'works if the frame is closed with a slight delay', requires: %i[frames js] do
+    frame = @session.find(:frame, 'parentFrame')
+    @session.switch_to_frame frame
+    frame = @session.find(:frame, 'childFrame')
+    @session.switch_to_frame frame
+    @session.click_link 'Close Window Soon'
+    sleep 1
+    @session.switch_to_frame :parent # Go back to parentFrame
+    expect(@session).to have_selector(:css, 'body#parentBody')
+    expect(@session).not_to have_selector(:css, '#childFrame')
+    @session.switch_to_frame :parent # Go back to top
+  end
+
+  it 'can return to the top frame', requires: [:frames] do
+    frame = @session.find(:frame, 'parentFrame')
+    @session.switch_to_frame frame
+    frame = @session.find(:frame, 'childFrame')
+    @session.switch_to_frame frame
+    @session.switch_to_frame :top
+    expect(@session.find("//*[@id='divInMainWindow']").text).to eql 'This is the text for divInMainWindow'
+  end
+
+  it "should raise error if switching to parent unmatched inside `within` as it's nonsense" do
+    expect do
+      frame = @session.find(:frame, 'parentFrame')
+      @session.switch_to_frame(frame)
+      @session.within(:css, '#parentBody') do
+        @session.switch_to_frame(:parent)
+      end
+    end.to raise_error(Capybara::ScopeError, "`switch_to_frame(:parent)` cannot be called from inside a descendant frame's `within` block.")
+  end
+
+  it "should raise error if switching to top inside a `within` in a frame as it's nonsense" do
+    frame = @session.find(:frame, 'parentFrame')
+    @session.switch_to_frame(frame)
+    @session.within(:css, '#parentBody') do
+      expect do
+        @session.switch_to_frame(:top)
+      end.to raise_error(Capybara::ScopeError, "`switch_to_frame(:top)` cannot be called from inside a descendant frame's `within` block.")
+    end
+  end
+
+  it "should raise error if switching to top inside a nested `within` in a frame as it's nonsense" do
+    frame = @session.find(:frame, 'parentFrame')
+    @session.switch_to_frame(frame)
+    @session.within(:css, '#parentBody') do
+      @session.switch_to_frame(@session.find(:frame, 'childFrame'))
+      expect do
+        @session.switch_to_frame(:top)
+      end.to raise_error(Capybara::ScopeError, "`switch_to_frame(:top)` cannot be called from inside a descendant frame's `within` block.")
+      @session.switch_to_frame(:parent)
+    end
+  end
+end

data/lib/capybara/spec/session/frame/within_frame_spec.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#within_frame', requires: [:frames] do
+  before do
+    @session.visit('/within_frames')
+  end
+
+  it 'should find the div in frameOne' do
+    @session.within_frame('frameOne') do
+      expect(@session.find("//*[@id='divInFrameOne']").text).to eql 'This is the text of divInFrameOne'
+    end
+  end
+
+  it 'should find the div in FrameTwo' do
+    @session.within_frame('frameTwo') do
+      expect(@session.find("//*[@id='divInFrameTwo']").text).to eql 'This is the text of divInFrameTwo'
+    end
+  end
+
+  it 'should find the text div in the main window after finding text in frameOne' do
+    @session.within_frame('frameOne') do
+      expect(@session.find("//*[@id='divInFrameOne']").text).to eql 'This is the text of divInFrameOne'
+    end
+    expect(@session.find("//*[@id='divInMainWindow']").text).to eql 'This is the text for divInMainWindow'
+  end
+
+  it 'should find the text div in the main window after finding text in frameTwo' do
+    @session.within_frame('frameTwo') do
+      expect(@session.find("//*[@id='divInFrameTwo']").text).to eql 'This is the text of divInFrameTwo'
+    end
+    expect(@session.find("//*[@id='divInMainWindow']").text).to eql 'This is the text for divInMainWindow'
+  end
+
+  it 'should return the result of executing the block' do
+    expect(@session.within_frame('frameOne') { 'return value' }).to eql 'return value'
+  end
+
+  it 'should find the div given Element' do
+    element = @session.find(:id, 'frameOne')
+    @session.within_frame element do
+      expect(@session.find("//*[@id='divInFrameOne']").text).to eql 'This is the text of divInFrameOne'
+    end
+  end
+
+  it 'should find the div given selector and locator' do
+    @session.within_frame(:css, '#frameOne') do
+      expect(@session.find("//*[@id='divInFrameOne']").text).to eql 'This is the text of divInFrameOne'
+    end
+  end
+
+  it 'should default to the :frame selector kind when only options passed' do
+    @session.within_frame(name: 'my frame one') do
+      expect(@session.find("//*[@id='divInFrameOne']").text).to eql 'This is the text of divInFrameOne'
+    end
+  end
+
+  it 'should default to the :frame selector when no options passed' do
+    container = @session.find(:css, '#divInMainWindow')
+    @session.within(container) do
+      # Ensure only one frame in scope
+      @session.within_frame do
+        expect(@session).to have_css('body#parentBody')
+      end
+    end
+    expect do
+      # Multiple frames in scope here
+      @session.within_frame { ; }
+    end.to raise_error Capybara::Ambiguous
+  end
+
+  it 'should find multiple nested frames' do
+    @session.within_frame 'parentFrame' do
+      @session.within_frame 'childFrame' do
+        @session.within_frame 'grandchildFrame1' do
+          # dummy
+        end
+        @session.within_frame 'grandchildFrame2' do
+          # dummy
+        end
+      end
+    end
+  end
+
+  it 'should reset scope when changing frames' do
+    @session.within(:css, '#divInMainWindow') do
+      @session.within_frame 'innerParentFrame' do
+        expect(@session.has_selector?(:css, 'iframe#childFrame')).to be true
+      end
+    end
+  end
+
+  it 'works if the frame is closed', requires: %i[frames js] do
+    @session.within_frame 'parentFrame' do
+      @session.within_frame 'childFrame' do
+        @session.click_link 'Close Window Now'
+      end
+      expect(@session).to have_selector(:css, 'body#parentBody')
+      expect(@session).not_to have_selector(:css, '#childFrame')
+    end
+  end
+
+  it 'works if the frame is closed with a slight delay', requires: %i[frames js] do
+    @session.within_frame 'parentFrame' do
+      @session.within_frame 'childFrame' do
+        @session.click_link 'Close Window Soon'
+        sleep 1
+      end
+      expect(@session).to have_selector(:css, 'body#parentBody')
+      expect(@session).not_to have_selector(:css, '#childFrame')
+    end
+  end
+end