capybara 2.5.0 → 2.18.0

data/spec/rspec/{matchers_spec.rb → shared_spec_matchers.rb}

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
 require 'spec_helper'
 require 'capybara/dsl'
 require 'capybara/rspec/matchers'
+require 'benchmark'
+
+RSpec.shared_examples Capybara::RSpecMatchers do |session, mode|
 
-RSpec.describe Capybara::RSpecMatchers do
   include Capybara::DSL
   include Capybara::RSpecMatchers
 
   describe "have_css matcher" do
     it "gives proper description" do
-      expect(have_css('h1').description).to eq("have css \"h1\"")
+      expect(have_css('h1').description).to eq("have visible css \"h1\"")
     end
 
     context "on a string" do
@@ -20,35 +23,35 @@ RSpec.describe Capybara::RSpecMatchers do
         it "fails if has_css? returns false" do
           expect do
             expect("<h1>Text</h1>").to have_css('h2')
-          end.to raise_error(/expected to find css "h2" but there were no matches/)
+          end.to raise_error(/expected to find visible css "h2" but there were no matches/)
         end
 
         it "passes if matched node count equals expected count" do
-          expect("<h1>Text</h1>").to have_css('h1', :count => 1)
+          expect("<h1>Text</h1>").to have_css('h1', count: 1)
         end
 
         it "fails if matched node count does not equal expected count" do
           expect do
             expect("<h1>Text</h1>").to have_css('h1', count: 2)
-          end.to raise_error("expected to find css \"h1\" 2 times, found 1 match: \"Text\"")
+          end.to raise_error("expected to find visible css \"h1\" 2 times, found 1 match: \"Text\"")
         end
 
         it "fails if matched node count is less than expected minimum count" do
           expect do
             expect("<h1>Text</h1>").to have_css('p', minimum: 1)
-          end.to raise_error("expected to find css \"p\" at least 1 time but there were no matches")
+          end.to raise_error("expected to find visible css \"p\" at least 1 time but there were no matches")
         end
 
         it "fails if matched node count is more than expected maximum count" do
           expect do
             expect("<h1>Text</h1><h1>Text</h1><h1>Text</h1>").to have_css('h1', maximum: 2)
-          end.to raise_error('expected to find css "h1" at most 2 times, found 3 matches: "Text", "Text", "Text"')
+          end.to raise_error('expected to find visible css "h1" at most 2 times, found 3 matches: "Text", "Text", "Text"')
         end
 
         it "fails if matched node count does not belong to expected range" do
           expect do
             expect("<h1>Text</h1>").to have_css('h1', between: 2..3)
-          end.to raise_error("expected to find css \"h1\" between 2 and 3 times, found 1 match: \"Text\"")
+          end.to raise_error("expected to find visible css \"h1\" between 2 and 3 times, found 1 match: \"Text\"")
         end
 
       end
@@ -61,17 +64,17 @@ RSpec.describe Capybara::RSpecMatchers do
         it "fails if has_no_css? returns false" do
           expect do
             expect("<h1>Text</h1>").not_to have_css('h1')
-          end.to raise_error(/expected not to find css "h1"/)
+          end.to raise_error(/expected not to find visible css "h1"/)
         end
 
         it "passes if matched node count does not equal expected count" do
-          expect("<h1>Text</h1>").not_to have_css('h1', :count => 2)
+          expect("<h1>Text</h1>").not_to have_css('h1', count: 2)
         end
 
         it "fails if matched node count equals expected count" do
           expect do
-            expect("<h1>Text</h1>").not_to have_css('h1', :count => 1)
-          end.to raise_error(/expected not to find css "h1"/)
+            expect("<h1>Text</h1>").not_to have_css('h1', count: 1)
+          end.to raise_error(/expected not to find visible css "h1"/)
         end
       end
 
@@ -94,7 +97,7 @@ RSpec.describe Capybara::RSpecMatchers do
         it "fails if has_css? returns false" do
           expect do
             expect(page).to have_css('h1#doesnotexist')
-          end.to raise_error(/expected to find css "h1#doesnotexist" but there were no matches/)
+          end.to raise_error(/expected to find visible css "h1#doesnotexist" but there were no matches/)
         end
       end
 
@@ -106,7 +109,7 @@ RSpec.describe Capybara::RSpecMatchers do
         it "fails if has_no_css? returns false" do
           expect do
             expect(page).not_to have_css('h1')
-          end.to raise_error(/expected not to find css "h1"/)
+          end.to raise_error(/expected not to find visible css "h1"/)
         end
       end
     end
@@ -114,7 +117,7 @@ RSpec.describe Capybara::RSpecMatchers do
 
   describe "have_xpath matcher" do
     it "gives proper description" do
-      expect(have_xpath('//h1').description).to eq("have xpath \"\/\/h1\"")
+      expect(have_xpath('//h1').description).to eq("have visible xpath \"\/\/h1\"")
     end
 
     context "on a string" do
@@ -126,7 +129,7 @@ RSpec.describe Capybara::RSpecMatchers do
         it "fails if has_xpath? returns false" do
           expect do
             expect("<h1>Text</h1>").to have_xpath('//h2')
-          end.to raise_error(%r(expected to find xpath "//h2" but there were no matches))
+          end.to raise_error(%r(expected to find visible xpath "//h2" but there were no matches))
         end
       end
 
@@ -138,7 +141,7 @@ RSpec.describe Capybara::RSpecMatchers do
         it "fails if has_no_xpath? returns false" do
           expect do
             expect("<h1>Text</h1>").not_to have_xpath('//h1')
-          end.to raise_error(%r(expected not to find xpath "//h1"))
+          end.to raise_error(%r(expected not to find visible xpath "//h1"))
         end
       end
 
@@ -161,7 +164,7 @@ RSpec.describe Capybara::RSpecMatchers do
         it "fails if has_xpath? returns false" do
           expect do
             expect(page).to have_xpath("//h1[@id='doesnotexist']")
-          end.to raise_error(%r(expected to find xpath "//h1\[@id='doesnotexist'\]" but there were no matches))
+          end.to raise_error(%r(expected to find visible xpath "//h1\[@id='doesnotexist'\]" but there were no matches))
         end
       end
 
@@ -173,7 +176,7 @@ RSpec.describe Capybara::RSpecMatchers do
         it "fails if has_no_xpath? returns false" do
           expect do
             expect(page).not_to have_xpath('//h1')
-          end.to raise_error(%r(expected not to find xpath "//h1"))
+          end.to raise_error(%r(expected not to find visible xpath "//h1"))
         end
       end
     end
@@ -183,7 +186,7 @@ RSpec.describe Capybara::RSpecMatchers do
     it "gives proper description" do
       matcher = have_selector('//h1')
       expect("<h1>Text</h1>").to matcher
-      expect(matcher.description).to eq("have xpath \"//h1\"")
+      expect(matcher.description).to eq("have visible xpath \"//h1\"")
     end
 
     context "on a string" do
@@ -195,7 +198,7 @@ RSpec.describe Capybara::RSpecMatchers do
         it "fails if has_selector? returns false" do
           expect do
             expect("<h1>Text</h1>").to have_selector('//h2')
-          end.to raise_error(%r(expected to find xpath "//h2" but there were no matches))
+          end.to raise_error(%r(expected to find visible xpath "//h2" but there were no matches))
         end
       end
 
@@ -207,7 +210,7 @@ RSpec.describe Capybara::RSpecMatchers do
         it "fails if has_no_selector? returns false" do
           expect do
             expect("<h1>Text</h1>").not_to have_selector(:css, 'h1')
-          end.to raise_error(%r(expected not to find css "h1"))
+          end.to raise_error(%r(expected not to find visible css "h1"))
         end
       end
     end
@@ -219,19 +222,19 @@ RSpec.describe Capybara::RSpecMatchers do
 
       context "with should" do
         it "passes if has_selector? returns true" do
-          expect(page).to have_selector('//h1', :text => 'test')
+          expect(page).to have_selector('//h1', text: 'test')
         end
 
         it "fails if has_selector? returns false" do
           expect do
             expect(page).to have_selector("//h1[@id='doesnotexist']")
-          end.to raise_error(%r(expected to find xpath "//h1\[@id='doesnotexist'\]" but there were no matches))
+          end.to raise_error(%r(expected to find visible xpath "//h1\[@id='doesnotexist'\]" but there were no matches))
         end
 
         it "includes text in error message" do
           expect do
-            expect(page).to have_selector("//h1", :text => 'wrong text')
-          end.to raise_error(%r(expected to find xpath "//h1" with text "wrong text" but there were no matches))
+            expect(page).to have_selector("//h1", text: 'wrong text')
+          end.to raise_error(%r(expected to find visible xpath "//h1" with text "wrong text" but there were no matches))
         end
       end
 
@@ -242,8 +245,8 @@ RSpec.describe Capybara::RSpecMatchers do
 
         it "fails if has_no_selector? returns false" do
           expect do
-            expect(page).not_to have_selector(:css, 'h1', :text => 'test')
-          end.to raise_error(%r(expected not to find css "h1" with text "test"))
+            expect(page).not_to have_selector(:css, 'h1', text: 'test')
+          end.to raise_error(%r(expected not to find visible css "h1" with text "test"))
         end
       end
     end
@@ -370,7 +373,7 @@ RSpec.describe Capybara::RSpecMatchers do
           end.to raise_error('expected to find text matching /No such Text/ in "Text"')
         end
 
-        it "casts Fixnum to string" do
+        it "casts Integer to string" do
           expect do
             expect("<h1>Text</h1>").to have_text(3)
           end.to raise_error(/expected to find text "3" in "Text"/)
@@ -481,7 +484,7 @@ RSpec.describe Capybara::RSpecMatchers do
     let(:html) { '<a href="#">Just a link</a><a href="#">Another link</a>' }
 
     it "gives proper description" do
-      expect(have_link('Just a link').description).to eq("have link \"Just a link\"")
+      expect(have_link('Just a link').description).to eq("have visible link \"Just a link\"")
     end
 
     it "passes if there is such a button" do
@@ -491,7 +494,7 @@ RSpec.describe Capybara::RSpecMatchers do
     it "fails if there is no such button" do
       expect do
         expect(html).to have_link('No such Link')
-      end.to raise_error(/expected to find link "No such Link"/)
+      end.to raise_error(/expected to find visible link "No such Link"/)
     end
 
     it "supports compounding" do
@@ -540,7 +543,7 @@ RSpec.describe Capybara::RSpecMatchers do
 
       context 'with wait' do
         before(:each) do
-          @session = TestSessions::Selenium
+          @session = session
           @session.visit('/with_js')
         end
 
@@ -553,8 +556,8 @@ RSpec.describe Capybara::RSpecMatchers do
 
         it "doesn't wait if wait time is less than timeout" do
           @session.click_link("Change title")
-          using_wait_time 0 do
-            expect(@session).not_to have_title('changed title')
+          using_wait_time 3 do
+            expect(@session).not_to have_title('changed title', wait: 0)
           end
         end
       end
@@ -585,7 +588,7 @@ RSpec.describe Capybara::RSpecMatchers do
 
       context 'with wait' do
         before(:each) do
-          @session = TestSessions::Selenium
+          @session = session
           @session.visit('/with_js')
         end
 
@@ -615,7 +618,7 @@ RSpec.describe Capybara::RSpecMatchers do
     let(:html) { '<button>A button</button><input type="submit" value="Another button"/>' }
 
     it "gives proper description" do
-      expect(have_button('A button').description).to eq("have button \"A button\"")
+      expect(have_button('A button').description).to eq("have visible button \"A button\"")
     end
 
     it "passes if there is such a button" do
@@ -625,7 +628,7 @@ RSpec.describe Capybara::RSpecMatchers do
     it "fails if there is no such button" do
       expect do
         expect(html).to have_button('No such Button')
-      end.to raise_error(/expected to find button "No such Button"/)
+      end.to raise_error(/expected to find visible button "No such Button"/)
     end
 
     it "supports compounding" do
@@ -637,11 +640,11 @@ RSpec.describe Capybara::RSpecMatchers do
     let(:html) { '<p><label>Text field<input type="text" value="some value"/></label></p>' }
 
     it "gives proper description" do
-      expect(have_field('Text field').description).to eq("have field \"Text field\"")
+      expect(have_field('Text field').description).to eq("have visible field \"Text field\" that is not disabled")
     end
 
     it "gives proper description for a given value" do
-      expect(have_field('Text field', with: 'some value').description).to eq("have field \"Text field\" with value \"some value\"")
+      expect(have_field('Text field', with: 'some value').description).to eq("have visible field \"Text field\" that is not disabled with value \"some value\"")
     end
 
     it "passes if there is such a field" do
@@ -655,13 +658,13 @@ RSpec.describe Capybara::RSpecMatchers do
     it "fails if there is no such field" do
       expect do
         expect(html).to have_field('No such Field')
-      end.to raise_error(/expected to find field "No such Field"/)
+      end.to raise_error(/expected to find visible field "No such Field"/)
     end
 
     it "fails if there is such field but with false value" do
       expect do
         expect(html).to have_field('Text field', with: 'false value')
-      end.to raise_error(/expected to find field "Text field"/)
+      end.to raise_error(/expected to find visible field "Text field"/)
     end
 
     it "treats a given value as a string" do
@@ -685,7 +688,7 @@ RSpec.describe Capybara::RSpecMatchers do
     end
 
     it "gives proper description" do
-      expect(have_checked_field('it is checked').description).to eq("have field \"it is checked\" that is checked")
+      expect(have_checked_field('it is checked').description).to eq("have visible field \"it is checked\" that is checked and not disabled")
     end
 
     context "with should" do
@@ -696,13 +699,13 @@ RSpec.describe Capybara::RSpecMatchers do
       it "fails if there is such a field but it is not checked" do
         expect do
           expect(html).to have_checked_field('unchecked field')
-        end.to raise_error(/expected to find field "unchecked field"/)
+        end.to raise_error(/expected to find visible field "unchecked field"/)
       end
 
       it "fails if there is no such field" do
         expect do
           expect(html).to have_checked_field('no such field')
-        end.to raise_error(/expected to find field "no such field"/)
+        end.to raise_error(/expected to find visible field "no such field"/)
       end
     end
 
@@ -710,7 +713,7 @@ RSpec.describe Capybara::RSpecMatchers do
       it "fails if there is such a field and it is checked" do
         expect do
           expect(html).not_to have_checked_field('it is checked')
-        end.to raise_error(/expected not to find field "it is checked"/)
+        end.to raise_error(/expected not to find visible field "it is checked"/)
       end
 
       it "passes if there is such a field but it is not checked" do
@@ -734,7 +737,7 @@ RSpec.describe Capybara::RSpecMatchers do
     end
 
     it "gives proper description" do
-      expect(have_unchecked_field('unchecked field').description).to eq("have field \"unchecked field\" that is not checked")
+      expect(have_unchecked_field('unchecked field').description).to eq("have visible field \"unchecked field\" that is not checked and not disabled")
     end
 
     context "with should" do
@@ -745,13 +748,13 @@ RSpec.describe Capybara::RSpecMatchers do
       it "fails if there is such a field but it is checked" do
         expect do
           expect(html).to have_unchecked_field('it is checked')
-        end.to raise_error(/expected to find field "it is checked"/)
+        end.to raise_error(/expected to find visible field "it is checked"/)
       end
 
       it "fails if there is no such field" do
         expect do
           expect(html).to have_unchecked_field('no such field')
-        end.to raise_error(/expected to find field "no such field"/)
+        end.to raise_error(/expected to find visible field "no such field"/)
       end
     end
 
@@ -759,7 +762,7 @@ RSpec.describe Capybara::RSpecMatchers do
       it "fails if there is such a field and it is not checked" do
         expect do
           expect(html).not_to have_unchecked_field('unchecked field')
-        end.to raise_error(/expected not to find field "unchecked field"/)
+        end.to raise_error(/expected not to find visible field "unchecked field"/)
       end
 
       it "passes if there is such a field but it is checked" do
@@ -780,11 +783,11 @@ RSpec.describe Capybara::RSpecMatchers do
     let(:html) { '<label>Select Box<select></select></label>' }
 
     it "gives proper description" do
-      expect(have_select('Select Box').description).to eq("have select box \"Select Box\"")
+      expect(have_select('Select Box').description).to eq("have visible select box \"Select Box\" that is not disabled")
     end
 
     it "gives proper description for a given selected value" do
-      expect(have_select('Select Box', selected: 'some value').description).to eq("have select box \"Select Box\" with \"some value\" selected")
+      expect(have_select('Select Box', selected: 'some value').description).to eq('have visible select box "Select Box" that is not disabled with "some value" selected')
     end
 
     it "passes if there is such a select" do
@@ -794,7 +797,7 @@ RSpec.describe Capybara::RSpecMatchers do
     it "fails if there is no such select" do
       expect do
         expect(html).to have_select('No such Select box')
-      end.to raise_error(/expected to find select box "No such Select box"/)
+      end.to raise_error(/expected to find visible select box "No such Select box"/)
     end
 
     it "supports compounding" do
@@ -806,7 +809,14 @@ RSpec.describe Capybara::RSpecMatchers do
     let(:html) { '<table><caption>Lovely table</caption></table>' }
 
     it "gives proper description" do
-      expect(have_table('Lovely table').description).to eq("have table \"Lovely table\"")
+      expect(have_table('Lovely table').description).to eq("have visible table \"Lovely table\"")
+    end
+
+    it "gives proper description when :visible option passed" do
+      expect(have_table('Lovely table', visible: true).description).to eq("have visible table \"Lovely table\"")
+      expect(have_table('Lovely table', visible: :hidden).description).to eq("have non-visible table \"Lovely table\"")
+      expect(have_table('Lovely table', visible: :all).description).to eq("have table \"Lovely table\"")
+      expect(have_table('Lovely table', visible: false).description).to eq("have table \"Lovely table\"")
     end
 
     it "passes if there is such a select" do
@@ -816,11 +826,107 @@ RSpec.describe Capybara::RSpecMatchers do
     it "fails if there is no such select" do
       expect do
         expect(html).to have_table('No such Table')
-      end.to raise_error(/expected to find table "No such Table"/)
+      end.to raise_error(/expected to find visible table "No such Table"/)
     end
 
     it "supports compounding" do
       expect(html).to have_table('nope').or have_table('Lovely table')
     end if RSpec::Version::STRING.to_f >= 3.0
   end
+
+  if RSpec::Version::STRING.to_f >= 3.0
+    context "compounding", requires: [:js] do
+      before(:each) do
+        @session = session
+        @session.visit('/with_js')
+        @el = @session.find(:css, '#reload-me')
+      end
+
+      context "#and" do
+        it "should run 'concurrently'" do
+          Capybara.using_wait_time(2) do
+            matcher = have_text('this is not there').and have_text('neither is this')
+            expect(Benchmark.realtime do
+              expect {
+                expect(@el).to matcher
+              }.to raise_error RSpec::Expectations::ExpectationNotMetError
+            end).to be_between(2,3)
+          end
+        end
+
+        it "should run 'concurrently' and retry" do
+          @session.click_link('reload-link')
+          @session.using_wait_time(2) do
+            expect(Benchmark.realtime do
+              expect {
+                expect(@el).to have_text('waiting to be reloaded').and(have_text('has been reloaded'))
+              }.to raise_error RSpec::Expectations::ExpectationNotMetError, /expected to find text "waiting to be reloaded" in "has been reloaded"/
+            end).to be_between(2,3)
+          end
+        end
+
+        it "should ignore :wait options" do
+          @session.using_wait_time(2) do
+            matcher = have_text('this is not there', wait: 5).and have_text('neither is this', wait: 6)
+            expect(Benchmark.realtime do
+              expect {
+                expect(@el).to matcher
+              }.to raise_error RSpec::Expectations::ExpectationNotMetError
+            end).to be_between(2,3)
+          end
+        end
+
+        it "should work on the session" do
+          @session.using_wait_time(2) do
+            @session.click_link('reload-link')
+            expect(@session).to have_selector(:css, 'h1', text: 'FooBar').and have_text('has been reloaded')
+          end
+        end
+      end
+
+      context "#and_then" do
+        it "should run sequentially" do
+          @session.click_link('reload-link')
+          expect(@el).to have_text('waiting to be reloaded').and_then have_text('has been reloaded')
+        end
+      end
+
+      context "#or" do
+        it "should run 'concurrently'" do
+          @session.using_wait_time(3) do
+            expect(Benchmark.realtime do
+              expect(@el).to have_text('has been reloaded').or have_text('waiting to be reloaded')
+            end).to be < 1
+          end
+        end
+
+        it "should retry" do
+          @session.using_wait_time(3) do
+            expect(Benchmark.realtime do
+              expect {
+                expect(@el).to have_text('has been reloaded').or have_text('random stuff')
+              }.to raise_error RSpec::Expectations::ExpectationNotMetError
+            end).to be > 3
+          end
+        end
+
+        it "should ignore :wait options" do
+          @session.using_wait_time(2) do
+            expect(Benchmark.realtime do
+              expect {
+                expect(@el).to have_text('this is not there', wait: 10).or have_text('neither is this', wait: 15)
+              }.to raise_error RSpec::Expectations::ExpectationNotMetError
+            end).to be_between(2,3)
+          end
+        end
+
+        it "should work on the session" do
+          @session.using_wait_time(2) do
+            @session.click_link('reload-link')
+            expect(@session).to have_selector(:css, 'h1', text: 'Not on the page').or have_text('has been reloaded')
+          end
+        end
+      end
+    end
+  end
 end

data/spec/rspec/views_spec.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe "capybara/rspec", type: :view do
   it "allows matchers to be used on strings" do
     expect(%{<h1>Test header</h1>}).to have_css("h1", text: "Test header")
   end
+
+  it "doesn't include RSpecMatcherProxies" do
+    expect(self.class.ancestors).not_to include(Capybara::RSpecMatcherProxies)
+  end
 end

data/spec/rspec_matchers_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe 'Capybara RSpec Matchers', :type => :feature do
+  context "after called on session" do
+    it "HaveSelector should allow getting a description of the matcher" do
+      visit('/with_html')
+      matcher = have_selector(:css, 'h2.head', minimum: 3)
+      expect(page).to matcher
+      expect { matcher.description }.not_to raise_error
+    end
+
+    it "HaveText should allow getting a description" do
+      visit('/with_html')
+      matcher = have_text("Lorem")
+      expect(page).to matcher
+      expect { matcher.description }.not_to raise_error
+    end
+  end
+
+  context "after called on element" do
+    it "HaveSelector should allow getting a description" do
+      visit('/with_html')
+      el = find(:css, '#first')
+      matcher = have_selector(:css, 'a#foo')
+      expect(el).to matcher
+      expect { matcher.description }.not_to raise_error
+    end
+
+    it "MatchSelector should allow getting a description" do
+      visit('/with_html')
+      el = find(:css, '#first')
+      matcher = match_selector(:css, '#first')
+      expect(el).to matcher
+      expect { matcher.description }.not_to raise_error
+    end
+
+    it "HaveText should allow getting a description" do
+      visit('/with_html')
+      el = find(:css, '#first')
+      matcher = have_text("Lorem")
+      expect(el).to matcher
+      expect { matcher.description }.not_to raise_error
+    end
+  end
+end