capybara 2.4.4 → 2.5.0

data/lib/capybara/session.rb

@@ -1,3 +1,5 @@
+require 'capybara/session/matchers'
+
 module Capybara
 
   ##
@@ -24,10 +26,12 @@ module Capybara
   # When using capybara/dsl, the Session is initialized automatically for you.
   #
   class Session
+    include Capybara::SessionMatchers
+
     NODE_METHODS = [
       :all, :first, :attach_file, :text, :check, :choose,
       :click_link_or_button, :click_button, :click_link, :field_labeled,
-      :fill_in, :find, :find_button, :find_by_id, :find_field, :find_link,
+      :fill_in, :find, :find_all, :find_button, :find_by_id, :find_field, :find_link,
       :has_content?, :has_text?, :has_css?, :has_no_content?, :has_no_text?,
       :has_no_css?, :has_no_xpath?, :resolve, :has_xpath?, :select, :uncheck,
       :has_link?, :has_no_link?, :has_button?, :has_no_button?, :has_field?,
@@ -48,7 +52,8 @@ module Capybara
       :windows, :open_new_window, :switch_to_window, :within_window, :window_opened_by,
       :save_page, :save_and_open_page, :save_screenshot,
       :save_and_open_screenshot, :reset_session!, :response_headers,
-      :status_code, :current_scope
+      :status_code, :current_scope,
+      :assert_current_path, :assert_no_current_path, :has_current_path?, :has_no_current_path?
     ] + DOCUMENT_METHODS
     MODAL_METHODS = [
       :accept_alert, :accept_confirm, :dismiss_confirm, :accept_prompt,
@@ -101,7 +106,7 @@ module Capybara
     def reset!
       if @touched
         driver.reset!
-        assert_no_selector :xpath, "/html/body/*"
+        assert_no_selector :xpath, "/html/body/*" if driver.browser_initialized?
         @touched = false
       end
       raise_server_error!
@@ -380,7 +385,11 @@ module Capybara
     #   `within_frame` or `within_window` methods
     # @raise [ArgumentError]               if both or neither arguments were provided
     #
-    def switch_to_window(window = nil)
+    def switch_to_window(window = nil, options= {})
+      if window.is_a? Hash
+        options = window
+        window = nil
+      end
       block_given = block_given?
       if window && block_given
         raise ArgumentError, "`switch_to_window` can take either a block or a window, not both"
@@ -395,20 +404,23 @@ module Capybara
         driver.switch_to_window(window.handle)
         window
       else
-        original_window_handle = driver.current_window_handle
-        begin
-          driver.window_handles.each do |handle|
-            driver.switch_to_window handle
-            if yield
-              return Window.new(self, handle)
+        wait_time = Capybara::Query.new(options).wait
+        document.synchronize(wait_time, errors: [Capybara::WindowError]) do
+          original_window_handle = driver.current_window_handle
+          begin
+            driver.window_handles.each do |handle|
+              driver.switch_to_window handle
+              if yield
+                return Window.new(self, handle)
+              end
             end
+          rescue => e
+            driver.switch_to_window(original_window_handle)
+            raise e
+          else
+            driver.switch_to_window(original_window_handle)
+            raise Capybara::WindowError, "Could not find a window matching block/lambda"
           end
-        rescue => e
-          driver.switch_to_window(original_window_handle)
-          raise e
-        else
-          driver.switch_to_window(original_window_handle)
-          raise Capybara::WindowError, "Could not find a window matching block/lambda"
         end
       end
     end
@@ -480,7 +492,7 @@ module Capybara
     # {https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}
     #
     # @param options [Hash]
-    # @option options [Numeric] :wait (Capybara.default_wait_time) wait time
+    # @option options [Numeric] :wait (Capybara.default_max_wait_time) maximum wait time
     # @return [Capybara::Window]       the window that has been opened within a block
     # @raise [Capybara::WindowError]   if block passed to window hasn't opened window
     #   or opened more than one window
@@ -561,7 +573,7 @@ module Capybara
       else
         options[:text]=text_or_options
       end
-      
+
       driver.accept_modal(:confirm, options, &blk)
     end
 
@@ -577,7 +589,7 @@ module Capybara
       else
         options[:text]=text_or_options
       end
-      
+
       driver.dismiss_modal(:confirm, options, &blk)
     end
 
@@ -594,7 +606,7 @@ module Capybara
       else
         options[:text]=text_or_options
       end
-      
+
       driver.accept_modal(:prompt, options, &blk)
     end
 
@@ -610,60 +622,70 @@ module Capybara
       else
         options[:text]=text_or_options
       end
-      
+
       driver.dismiss_modal(:prompt, options, &blk)
     end
 
     ##
     #
-    # Save a snapshot of the page.
+    # Save a snapshot of the page. If `Capybara.asset_host` is set it will inject `base` tag
+    #   pointing to `asset_host`.
     #
-    # @param  [String] path     The path to where it should be saved [optional]
+    # If invoked without arguments it will save file to `Capybara.save_and_open_page_path`
+    #   and file will be given randomly generated filename.
     #
-    def save_page(path=nil)
-      path ||= default_path('html')
-
-      FileUtils.mkdir_p(File.dirname(path))
-
-      File.open(path,'wb') { |f| f.write(Capybara::Helpers.inject_asset_host(body)) }
+    # @param [String] path  the path to where it should be saved
+    # @return [String]      the path to which the file was saved
+    #
+    def save_page(path = nil)
+      path = prepare_path(path, 'html')
+      File.write(path, Capybara::Helpers.inject_asset_host(body), mode: 'wb')
       path
     end
 
     ##
     #
-    # Save a snapshot of the page and open it in a browser for inspection
+    # Save a snapshot of the page and open it in a browser for inspection.
+    #
+    # If invoked without arguments it will save file to `Capybara.save_and_open_page_path`
+    #   and file will be given randomly generated filename.
     #
-    # @param  [String] file_name  The path to where it should be saved [optional]
+    # @param [String] path  the path to where it should be saved
     #
-    def save_and_open_page(file_name=nil)
-      file_name = save_page(file_name)
-      open_file(file_name)
+    def save_and_open_page(path = nil)
+      path = save_page(path)
+      open_file(path)
     end
 
     ##
     #
-    # Save a screenshot of page
+    # Save a screenshot of page.
     #
-    # @param  [String] path    A string of image path
-    # @option [Hash]   options Options for saving screenshot
-    def save_screenshot(path, options={})
-      path ||= default_path('png')
-
-      FileUtils.mkdir_p(File.dirname(path))
-
+    # If invoked without `path` argument it will save file to `Capybara.save_and_open_page_path`
+    #   and file will be given randomly generated filename.
+    #
+    # @param [String] path    the path to where it should be saved
+    # @param [Hash] options   a customizable set of options
+    # @return [String]        the path to which the file was saved
+    def save_screenshot(path = nil, options = {})
+      path = prepare_path(path, 'png')
       driver.save_screenshot(path, options)
       path
     end
 
     ##
     #
-    # Save a screenshot of the page and open it for inspection
+    # Save a screenshot of the page and open it for inspection.
     #
-    # @param  [String] file_name  The path to where it should be saved [optional]
+    # If invoked without `path` argument it will save file to `Capybara.save_and_open_page_path`
+    #   and file will be given randomly generated filename.
     #
-    def save_and_open_screenshot(file_name=nil)
-      file_name = save_screenshot(file_name)
-      open_file(file_name)
+    # @param [String] path    the path to where it should be saved
+    # @param [Hash] options   a customizable set of options
+    #
+    def save_and_open_screenshot(path = nil, options = {})
+      path = save_screenshot(path, options)
+      open_file(path)
     end
 
     def document
@@ -693,16 +715,22 @@ module Capybara
 
   private
 
-    def open_file(file_name)
+    def open_file(path)
       begin
         require "launchy"
-        Launchy.open(file_name)
+        Launchy.open(path)
       rescue LoadError
-        warn "File saved to #{file_name}."
+        warn "File saved to #{path}."
         warn "Please install the launchy gem to open the file automatically."
       end
     end
 
+    def prepare_path(path, extension)
+      path = default_path(extension) if path.nil?
+      FileUtils.mkdir_p(File.dirname(path))
+      path
+    end
+
     def default_path(extension)
       timestamp = Time.new.strftime("%Y%m%d%H%M%S")
       path = "capybara-#{timestamp}#{rand(10**10)}.#{extension}"

data/lib/capybara/session/matchers.rb

@@ -0,0 +1,69 @@
+module Capybara
+  module SessionMatchers
+    ##
+    # Asserts that the page has the given path.
+    # By default this will compare against the path+query portion of the full url
+    #
+    # @!macro current_path_query_params
+    #   @overload $0(string, options = {})
+    #     @param string [String]           The string that the current 'path' should equal
+    #   @overload $0(regexp, options = {})
+    #     @param regexp [Regexp]           The regexp that the current 'path' should match to
+    #   @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time that Capybara will wait for the current path to eq/match given string/regexp argument
+    #   @option options [Boolean] :url  (false)  Whether the compare should be done against the full url
+    #   @option options [Boolean] :only_path (false)  Whether the compare should be done against just the path protion of the url
+    # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
+    # @return [true]
+    #
+    def assert_current_path(path, options={})
+      query = Capybara::Queries::CurrentPathQuery.new(path, options)
+      document.synchronize(query.wait) do
+        unless query.resolves_for?(self)
+          raise Capybara::ExpectationNotMet, query.failure_message
+        end
+      end
+      return true
+    end
+
+    ##
+    # Asserts that the page doesn't have the given path.
+    #
+    # @macro current_path_query_params
+    # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
+    # @return [true]
+    #
+    def assert_no_current_path(path, options={})
+      query = Capybara::Queries::CurrentPathQuery.new(path, options)
+      document.synchronize(query.wait) do
+        if query.resolves_for?(self)
+          raise Capybara::ExpectationNotMet, query.negative_failure_message
+        end
+      end
+      return true
+    end
+
+    ##
+    # Checks if the page has the given path.
+    #
+    # @macro current_path_query_params
+    # @return [Boolean]
+    #
+    def has_current_path?(path, options={})
+      assert_current_path(path, options)
+    rescue Capybara::ExpectationNotMet
+      return false
+    end
+
+    ##
+    # Checks if the page doesn't have the given path.
+    #
+    # @macro current_path_query_params
+    # @return [Boolean]
+    #
+    def has_no_current_path?(path, options={})
+      assert_no_current_path(path, options)
+    rescue Capybara::ExpectationNotMet
+      return false
+    end
+  end
+end

data/lib/capybara/spec/public/test.js

@@ -100,4 +100,12 @@ $(function() {
       $(this).attr('response', response);
     }
   });
+  $('#delayed-page-change').click(function() {
+    setTimeout(function() {
+      window.location.pathname = '/with_html'
+    }, 500)
+  })
+  $('#with-key-events').keydown(function(e){
+    $('#key-events-output').append('keydown:'+e.which+' ')
+  });
 });

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

@@ -149,4 +149,9 @@ Capybara::SpecHelper.spec "#all" do
       end
     end
   end
+
+  it "should have #find_all as an alias" do
+    expect(Capybara::Node::Finders.instance_method(:all)).to eq Capybara::Node::Finders.instance_method(:find_all)
+    expect(@session.find_all('//p').size).to eq(3)
+  end
 end

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

@@ -0,0 +1,59 @@
+Capybara::SpecHelper.spec '#assert_current_path' do
+  before do
+    @session.visit('/with_js')
+  end
+
+  it "should not raise if the page has the given current path" do
+    expect {@session.assert_current_path('/with_js')}.not_to raise_error
+  end
+
+  it "should allow regexp matches" do
+    expect { @session.assert_current_path(/w[a-z]{3}_js/) }.not_to raise_error
+  end
+
+  it "should wait for current_path", :requires => [:js] do
+    @session.click_link("Change page")
+    expect { @session.assert_current_path("/with_html") }.not_to raise_error
+  end
+
+  it "should raise if the page has not the given current_path" do
+    expect{@session.assert_current_path('/with_html')}.to raise_error(Capybara::ExpectationNotMet, 'expected "/with_js" to equal "/with_html"')
+  end
+
+  it "should check query options" do
+    @session.visit('/with_js?test=test')
+    expect{@session.assert_current_path('/with_js?test=test')}.not_to raise_error
+  end
+
+  it "should compare the full url" do
+    expect{@session.assert_current_path(%r{\Ahttp://[^/]*/with_js\Z}, url: true)}.not_to raise_error
+  end
+
+  it "should ignore the query" do
+    @session.visit('/with_js?test=test')
+    expect{@session.assert_current_path('/with_js', only_path: true)}.not_to raise_error
+  end
+end
+
+Capybara::SpecHelper.spec '#assert_no_current_path?' do
+  before do
+    @session.visit('/with_js')
+  end
+
+  it "should raise if the page has the given current_path" do
+    expect{@session.assert_no_current_path('/with_js')}.to raise_error(Capybara::ExpectationNotMet)
+  end
+
+  it "should allow regexp matches" do
+    expect{@session.assert_no_current_path(/monkey/)}.not_to raise_error
+  end
+
+  it "should wait for current_path to disappear", :requires => [:js] do
+    @session.click_link("Change page")
+    expect{@session.assert_no_current_path('/with_js')}.not_to raise_error
+  end
+
+  it "should not raise if the page has not the given current_path" do
+    expect{@session.assert_no_current_path('/with_html')}.not_to raise_error
+  end
+end

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

@@ -189,7 +189,7 @@ Capybara::SpecHelper.spec '#assert_no_text' do
       @session.visit('/with_js')
       @session.click_link('Click me')
       @session.find(:css, '#reload-list').click
-      @session.find(:css, '#the-list').assert_no_text('Foo Bar', :wait => 0.4)
+      @session.find(:css, '#the-list').assert_no_text('Foo Bar', :wait => 0.3)
     end
   end
 end

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

@@ -59,8 +59,8 @@ Capybara::SpecHelper.spec "#attach_file" do
     it "should not break when using HTML5 multiple file input" do
       @session.attach_file "Multiple Documents", @test_file_path
       @session.click_button('Upload Multiple')
-      expect(@session.body).to include("1 | ")#number of files
       expect(@session).to have_content(File.read(@test_file_path))
+      expect(@session.body).to include("1 | ")#number of files
     end
 
     it  "should not break when using HTML5 multiple file input uploading multiple files" do
@@ -74,7 +74,7 @@ Capybara::SpecHelper.spec "#attach_file" do
 
     it "should not send anything when attaching no files to a multiple upload field" do
       @session.click_button('Upload Empty Multiple')
-      expect(@session.body).to include("Successfully ignored empty file field")
+      expect(@session).to have_content("Successfully ignored empty file field")
     end
   end
 

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

@@ -9,11 +9,13 @@ Capybara::SpecHelper.spec '#body' do
     context "encoding of response between ascii and utf8" do
       it "should be valid with html entities" do
         @session.visit('/with_html_entities')
+        expect(@session).to have_content('Encoding') # wait for content to appear if visit is async
         expect { @session.body.encode!("UTF-8") }.not_to raise_error
       end
 
       it "should be valid without html entities" do
         @session.visit('/with_html')
+        expect(@session).to have_content('This is a test') # wait for content to appear if visit is async
         expect { @session.body.encode!("UTF-8") }.not_to raise_error
       end
     end

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

@@ -11,8 +11,8 @@ Capybara::SpecHelper.spec '#click_button' do
 
   it "casts to string" do
     @session.click_button(:'Relative Action')
-    expect(@session.current_path).to eq('/relative')
     expect(extract_results(@session)['relative']).to eq('Relative Action')
+    expect(@session.current_path).to eq('/relative')
   end
 
   context "with multiple values with the same name" do
@@ -26,16 +26,16 @@ Capybara::SpecHelper.spec '#click_button' do
   context "with a form that has a relative url as an action" do
     it "should post to the correct url" do
       @session.click_button('Relative Action')
-      expect(@session.current_path).to eq('/relative')
       expect(extract_results(@session)['relative']).to eq('Relative Action')
+      expect(@session.current_path).to eq('/relative')
     end
   end
 
   context "with a form that has no action specified" do
     it "should post to the correct url" do
       @session.click_button('No Action')
-      expect(@session.current_path).to eq('/form')
       expect(extract_results(@session)['no_action']).to eq('No Action')
+      expect(@session.current_path).to eq('/form')
     end
   end
 
@@ -110,7 +110,7 @@ Capybara::SpecHelper.spec '#click_button' do
         expect(@results['pets']).to include('dog', 'hamster')
         expect(@results['pets']).not_to include('cat')
       end
-      
+
       it "should default checkbox value to 'on' if none specififed" do
         expect(@results['valueless_checkbox']).to eq('on')
       end
@@ -134,11 +134,11 @@ Capybara::SpecHelper.spec '#click_button' do
       it "should not serialize a select tag without options" do
         expect(@results['tendency']).to be_nil
       end
-      
+
       it "should convert lf to cr/lf in submitted textareas" do
         expect(@results['newline']).to eq("\r\nNew line after and before textarea tag\r\n")
       end
-      
+
       it "should not submit disabled fields" do
         expect(@results['disabled_text_field']).to be_nil
         expect(@results['disabled_textarea']).to be_nil
@@ -254,7 +254,7 @@ Capybara::SpecHelper.spec '#click_button' do
       expect(extract_results(@session)['first_name']).to eq('John')
     end
   end
-  
+
 
   context "with value given on an image button" do
     it "should submit the associated form" do
@@ -349,8 +349,17 @@ Capybara::SpecHelper.spec '#click_button' do
   context "with formaction attribute on button" do
     it "should submit to the formaction attribute" do
       @session.click_button('Formaction button')
+      @results = extract_results(@session)
       expect(@session.current_path).to eq '/form'
+      expect(@results['which_form']).to eq 'formaction form'
+    end
+  end
+
+  context "with formmethod attribute on button" do
+    it "should submit to the formethod attribute" do
+      @session.click_button('Formmethod button')
       @results = extract_results(@session)
+      expect(@session.current_path).to eq '/form/get'
       expect(@results['which_form']).to eq 'formaction form'
     end
   end
@@ -377,8 +386,8 @@ Capybara::SpecHelper.spec '#click_button' do
 
   it "should follow redirects" do
     @session.click_button('Go FAR')
-    expect(@session.current_url).to match(%r{/landed$})
     expect(@session).to have_content('You landed')
+    expect(@session.current_url).to match(%r{/landed$})
   end
 
   it "should post pack to the same URL when no action given" do