capybara-webkit 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7ab00fe907aecf18f18973fe2bcc061ed182978
-  data.tar.gz: c54ebbc9979ef8cbf0ef185e1eb53bddb11967f0
+  metadata.gz: fb1c802882892f9e70e1b42d5b2f16bd01fbe99f
+  data.tar.gz: 8d803700aa341d54a6cb4a5e3016ab8afb0dbcf7
 SHA512:
-  metadata.gz: f58d3a1b7368ccdb11de8a7b1b4504722d8f92a272133e4c7d547437e796837ac700dea1f17f6c04cf4b723bb327b9432f54af5eee1a304621bde7089c722e3b
-  data.tar.gz: 16b5ed8715b7b388e8392c7af85900116f15afa2235c85f46fa672c38cf46751de2fe2c2e8eb7b80e2fc2c21d5926d8c6c5e135362859bc356aa2f7f5443026b
+  metadata.gz: cb8a7c5f7b5e29063d2fa241f38510797d26aefd9e3f112715b1d1c42028d169f954e869e445c8f8a4ee652e969e7972b67663774f579992c16346355383100f
+  data.tar.gz: 72b58214cdb532805b2ff63b7f8ff64342dc61a1faca858ee878f5ba5932839143785aef111ec00fa1ebb960fc8053ade23c4681a18c6f59e182c178d17a5e53

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.1
+  - 2.2
   - jruby-19mode
 notifications:
   email: false

data/CONTRIBUTING.md

@@ -1,4 +1,7 @@
-We love pull requests. Here's a quick guide:
+We love pull requests from everyone. We expect users to follow our
+[code of conduct] while submitting code or comments.
+
+[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
 
 ## Dependencies
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capybara-webkit (1.5.2)
+    capybara-webkit (1.6.0)
       capybara (>= 2.3.0, < 2.5.0)
       json
 

data/NEWS.md

@@ -1,3 +1,15 @@
+New for 1.6.0:
+
+* New, easier, global configuration API.
+* Add `page.driver.allow_unknown_urls` to silent all unknown host warnings.
+* Add warning for users on Qt 4.
+* Fix bug when parsing response headers with values containing colons.
+* Allow multiple, different basic authorizations in a single session.
+* Caches behave more like Selenium
+* Select tag events behave more like Selenium
+* Deprecated `driver.browser`
+* Provide better behavior and information when the driver crashes
+
 New for 1.5.2:
 
 * Fixes bug where aborted Ajax requests caused a crash during reset.

data/README.md

@@ -82,6 +82,60 @@ If you're using capybara-webkit with Sinatra, don't forget to set
 Capybara.app = MySinatraApp.new
 ```
 
+Configuration
+-------------
+
+You can configure global options using `Capybara::Webkit.configure`:
+
+``` ruby
+Capybara::Webkit.configure do |config|
+  # Enable debug mode. Prints a log of everything the driver is doing.
+  config.debug = true
+
+  # By default, requests to outside domains (anything besides localhost) will
+  # result in a warning. Several methods allow you to change this behavior.
+
+  # Silently return an empty 200 response for any requests to unknown URLs.
+  config.block_unknown_urls
+
+  # Allow pages to make requests to any URL without issuing a warning.
+  config.allow_unknown_urls
+
+  # Allow a specifc domain without issuing a warning.
+  config.allow_url("example.com")
+
+  # Allow a specifc URL and path without issuing a warning.
+  config.allow_url("example.com/some/path")
+
+  # Wildcards are allowed in URL expressions.
+  config.allow_url("*.example.com")
+
+  # Silently return an empty 200 response for any requests to the given URL.
+  config.block_url("example.com")
+
+  # Timeout if requests take longer than 5 seconds
+  config.timeout = 5
+
+  # Don't raise errors when SSL certificates can't be validated
+  config.ignore_ssl_errors
+
+  # Don't load images
+  config.skip_image_loading
+
+  # Use a proxy
+  config.use_proxy(
+    host: "example.com",
+    port: 1234,
+    user: "proxy",
+    pass: "secret"
+  )
+end
+```
+
+These options will take effect for all future sessions and only need to be set
+once. It's recommended that you configure these in your `spec_helper.rb` or
+`test_helper.rb` rather than a `before` or `setup` block.
+
 Offline Application Cache
 -------------------------
 
@@ -127,18 +181,6 @@ page.driver.cookies["alpha"]
 page.driver.header 'Referer', 'https://www.thoughtbot.com'
 ```
 
-**block_unknown_urls**: By default, capybara-webkit will warn when a request is made to a URL other than 127.0.0.1 or localhost. This option will block such unknown URLs instead.
-
-```ruby
-page.driver.block_unknown_urls
-```
-
-**allow_url**: Allow requests to a URL. This will silence unknown URL warnings, or permit requests to a URL when `block_unknown_urls` is used. Allowed URLs are reset on `Driver#reset!`.
-
-```ruby
-page.driver.allow_url 'example.com/*.js'
-```
-
 Contributing
 ------------
 

data/lib/capybara/webkit.rb

@@ -2,17 +2,22 @@ require "capybara"
 
 module Capybara
   module Webkit
+    def self.configure(&block)
+      Capybara::Webkit::Configuration.modify(&block)
+    end
   end
 end
 
 require "capybara/webkit/driver"
+require "capybara/webkit/configuration"
 
 Capybara.register_driver :webkit do |app|
-  Capybara::Webkit::Driver.new(app)
+  Capybara::Webkit::Driver.new(app, Capybara::Webkit::Configuration.to_hash)
 end
 
 Capybara.register_driver :webkit_debug do |app|
-  driver = Capybara::Webkit::Driver.new(app)
-  driver.enable_logging
-  driver
+  Capybara::Webkit::Driver.new(
+    app,
+    Capybara::Webkit::Configuration.to_hash.merge(debug: true)
+  )
 end

data/lib/capybara/webkit/browser.rb

@@ -1,4 +1,5 @@
-require 'json'
+require "json"
+require "capybara/webkit/errors"
 
 module Capybara::Webkit
   class Browser
@@ -71,7 +72,7 @@ module Capybara::Webkit
     end
 
     def response_headers
-      Hash[command("Headers").split("\n").map { |header| header.split(": ") }]
+      JSON.parse(command("Headers"))
     end
 
     def current_url
@@ -209,6 +210,17 @@ module Capybara::Webkit
       end
       check
       read_response
+    rescue SystemCallError => exception
+      @connection.restart
+      raise(Capybara::Webkit::CrashError, <<-MESSAGE.strip)
+The webkit_server process crashed!
+
+  #{exception.message}
+
+This is a bug in capybara-webkit. For help with this crash, please visit:
+
+https://github.com/thoughtbot/capybara-webkit/wiki/Reporting-Crashes
+      MESSAGE
     end
 
     def evaluate_script(script)
@@ -277,6 +289,10 @@ module Capybara::Webkit
       command("SetUnknownUrlMode", "block")
     end
 
+    def allow_unknown_urls
+      allow_url("*")
+    end
+
     private
 
     def check

data/lib/capybara/webkit/configuration.rb

@@ -0,0 +1,98 @@
+module Capybara
+  module Webkit
+    class Configuration
+      class << self
+        private
+
+        def instance
+          @instance ||= new
+        end
+      end
+
+      def self.to_hash
+        instance.freeze.to_hash
+      end
+
+      def self.modify
+        if instance.frozen?
+          raise "All configuration must take place before the driver starts"
+        else
+          yield instance
+        end
+      end
+
+      attr_accessor :allowed_urls
+      attr_writer :block_unknown_urls
+      attr_accessor :blocked_urls
+      attr_accessor :debug
+      attr_writer :ignore_ssl_errors
+      attr_accessor :proxy
+      attr_accessor :timeout
+      attr_writer :skip_image_loading
+
+      def initialize
+        @allowed_urls = []
+        @blocked_urls = []
+        @block_unknown_urls = false
+        @debug = false
+        @ignore_ssl_errors = false
+        @proxy = nil
+        @skip_image_loading = false
+        @timeout = -1
+      end
+
+      def allow_url(url)
+        @allowed_urls << url
+      end
+
+      def block_url(url)
+        @blocked_urls << url
+      end
+
+      def block_unknown_urls
+        @block_unknown_urls = true
+      end
+
+      def block_unknown_urls?
+        @block_unknown_urls
+      end
+
+      def allow_unknown_urls
+        allow_url("*")
+      end
+
+      def ignore_ssl_errors
+        @ignore_ssl_errors = true
+      end
+
+      def ignore_ssl_errors?
+        @ignore_ssl_errors
+      end
+
+      def skip_image_loading
+        @skip_image_loading = true
+      end
+
+      def skip_image_loading?
+        @skip_image_loading
+      end
+
+      def use_proxy(proxy)
+        @proxy = proxy
+      end
+
+      def to_hash
+        {
+          allowed_urls: allowed_urls,
+          block_unknown_urls: block_unknown_urls?,
+          blocked_urls: blocked_urls,
+          debug: debug,
+          ignore_ssl_errors: ignore_ssl_errors?,
+          proxy: proxy,
+          skip_image_loading: skip_image_loading?,
+          timeout: timeout
+        }
+      end
+    end
+  end
+end

data/lib/capybara/webkit/connection.rb

@@ -12,7 +12,13 @@ module Capybara::Webkit
 
     def initialize(options = {})
       @socket = nil
-      @socket_class = options[:socket_class] || TCPSocket
+      if options.has_key?(:socket_class)
+        warn '[DEPRECATION] The Capybara::Webkit::Connection `socket_class` ' \
+          'option is deprecated without replacement.'
+        @socket_class = options[:socket_class]
+      else
+        @socket_class = TCPSocket
+      end
       if options.has_key?(:stderr)
         @output_target = options[:stderr]
       elsif options.has_key?(:stdout)
@@ -55,6 +61,12 @@ module Capybara::Webkit
       response
     end
 
+    def restart
+      @socket = nil
+      start_server
+      connect
+    end
+
     private
 
     def start_server

data/lib/capybara/webkit/driver.rb

@@ -3,109 +3,120 @@ require "capybara/webkit/version"
 require "capybara/webkit/node"
 require "capybara/webkit/connection"
 require "capybara/webkit/browser"
-require "capybara/webkit/socket_debugger"
 require "capybara/webkit/cookie_jar"
 require "capybara/webkit/errors"
 
 module Capybara::Webkit
   class Driver < Capybara::Driver::Base
-    attr_reader :browser
-
     def initialize(app, options={})
       @app = app
       @options = options
       @browser = options[:browser] || Browser.new(Connection.new(options))
+      apply_options
     end
 
     def enable_logging
-      browser.enable_logging
+      deprecate_and_replace_with_config "enable_logging", "debug = true"
+      @browser.enable_logging
     end
 
     def allow_url(url)
-      browser.allow_url(url)
+      deprecate_and_replace_with_config "allow_url", "allow_url(#{url.inspect})"
+      @browser.allow_url(url)
     end
 
     def block_url(url)
-      browser.block_url(url)
+      deprecate_and_replace_with_config "block_url", "block_url(#{url.inspect})"
+      @browser.block_url(url)
     end
 
     def block_unknown_urls
-      browser.block_unknown_urls
+      deprecate_and_replace_with_config "block_unknown_urls"
+      @browser.block_unknown_urls
+    end
+
+    def allow_unknown_urls
+      deprecate_and_replace_with_config "allow_unknown_urls"
+      @browser.allow_url("*")
     end
 
     def current_url
-      browser.current_url
+      @browser.current_url
     end
 
     def visit(path)
-      browser.visit(path)
+      @browser.visit(path)
     end
 
     def find_xpath(xpath)
-      browser.find_xpath(xpath).map { |native| Node.new(self, native) }
+      @browser.
+        find_xpath(xpath).
+        map { |native| Node.new(self, native, @browser) }
     end
 
     alias_method :find, :find_xpath
 
     def find_css(selector)
-      browser.find_css(selector).map { |native| Node.new(self, native) }
+      @browser.
+        find_css(selector).
+        map { |native| Node.new(self, native, @browser) }
     end
 
     def html
-      browser.body
+      @browser.body
     end
 
     def header(key, value)
-      browser.header(key, value)
+      @browser.header(key, value)
     end
 
     def title
-      browser.title
+      @browser.title
     end
 
     def execute_script(script)
-      value = browser.execute_script script
+      value = @browser.execute_script script
       value.empty? ? nil : value
     end
 
     def evaluate_script(script)
-      browser.evaluate_script script
+      @browser.evaluate_script script
     end
 
     def console_messages
-      browser.console_messages
+      @browser.console_messages
     end
 
     def error_messages
-      browser.error_messages
+      @browser.error_messages
     end
 
     def alert_messages
       warn '[DEPRECATION] Capybara::Webkit::Driver#alert_messages ' \
         'is deprecated. Please use Capybara::Session#accept_alert instead.'
-      browser.alert_messages
+      @browser.alert_messages
     end
 
     def confirm_messages
       warn '[DEPRECATION] Capybara::Webkit::Driver#confirm_messages ' \
         'is deprecated. Please use Capybara::Session#accept_confirm ' \
         'or Capybara::Session#dismiss_confirm instead.'
-      browser.confirm_messages
+      @browser.confirm_messages
     end
 
     def prompt_messages
       warn '[DEPRECATION] Capybara::Webkit::Driver#prompt_messages ' \
         'is deprecated. Please use Capybara::Session#accept_prompt ' \
         'or Capybara::Session#dismiss_prompt instead.'
-      browser.prompt_messages
+      @browser.prompt_messages
     end
 
     def response_headers
-      browser.response_headers
+      @browser.response_headers
     end
 
     def status_code
-      browser.status_code
+      @browser.status_code
     end
 
     def resize_window(width, height)
@@ -115,19 +126,19 @@ module Capybara::Webkit
     end
 
     def resize_window_to(handle, width, height)
-      browser.window_resize(handle, width, height)
+      @browser.window_resize(handle, width, height)
     end
 
     def window_size(handle)
-      browser.window_size(handle)
+      @browser.window_size(handle)
     end
 
     def within_frame(selector)
-      browser.frame_focus(selector)
+      @browser.frame_focus(selector)
       begin
         yield
       ensure
-        browser.frame_focus
+        @browser.frame_focus
       end
     end
 
@@ -137,74 +148,74 @@ module Capybara::Webkit
       begin
         yield
       ensure
-        browser.window_focus(current_window)
+        @browser.window_focus(current_window)
       end
     end
 
     def switch_to_window(selector)
-      browser.window_focus(selector)
+      @browser.window_focus(selector)
     end
 
     def window_handles
-      browser.get_window_handles
+      @browser.get_window_handles
     end
 
     def current_window_handle
-      browser.get_window_handle
+      @browser.get_window_handle
     end
 
     def open_new_window
-      browser.window_open
+      @browser.window_open
     end
 
     def close_window(selector)
-      browser.window_close(selector)
+      @browser.window_close(selector)
     end
 
     def maximize_window(selector)
-      browser.window_maximize(selector)
+      @browser.window_maximize(selector)
     end
 
     def accept_js_confirms!
       warn '[DEPRECATION] Capybara::Webkit::Driver#accept_js_confirms! ' \
         'is deprecated. Please use Capybara::Session#accept_confirm instead.'
-      browser.accept_js_confirms
+      @browser.accept_js_confirms
     end
 
     def dismiss_js_confirms!
       warn '[DEPRECATION] Capybara::Webkit::Driver#dismiss_js_confirms! ' \
         'is deprecated. Please use Capybara::Session#dismiss_confirm instead.'
-      browser.reject_js_confirms
+      @browser.reject_js_confirms
     end
 
     def accept_js_prompts!
       warn '[DEPRECATION] Capybara::Webkit::Driver#accept_js_prompts! ' \
         'is deprecated. Please use Capybara::Session#accept_prompt instead.'
-      browser.accept_js_prompts
+      @browser.accept_js_prompts
     end
 
     def dismiss_js_prompts!
       warn '[DEPRECATION] Capybara::Webkit::Driver#dismiss_js_prompts! ' \
         'is deprecated. Please use Capybara::Session#dismiss_prompt instead.'
-      browser.reject_js_prompts
+      @browser.reject_js_prompts
     end
 
     def js_prompt_input=(value)
       warn '[DEPRECATION] Capybara::Webkit::Driver#js_prompt_input= ' \
         'is deprecated. Please use Capybara::Session#accept_prompt instead.'
       if value.nil?
-        browser.clear_prompt_text
+        @browser.clear_prompt_text
       else
-        browser.set_prompt_text_to(value)
+        @browser.set_prompt_text_to(value)
       end
     end
 
     def go_back
-      browser.go_back
+      @browser.go_back
     end
 
     def go_forward
-      browser.go_forward
+      @browser.go_forward
     end
 
     def accept_modal(type, options={})
@@ -212,11 +223,11 @@ module Capybara::Webkit
 
       case type
       when :confirm
-        id = browser.accept_confirm(options)
+        id = @browser.accept_confirm(options)
       when :prompt
-        id = browser.accept_prompt(options)
+        id = @browser.accept_prompt(options)
       else
-        id = browser.accept_alert(options)
+        id = @browser.accept_alert(options)
       end
 
       yield
@@ -229,9 +240,9 @@ module Capybara::Webkit
 
       case type
       when :confirm
-        id = browser.reject_confirm(options)
+        id = @browser.reject_confirm(options)
       else
-        id = browser.reject_prompt(options)
+        id = @browser.reject_prompt(options)
       end
 
       yield
@@ -248,7 +259,8 @@ module Capybara::Webkit
     end
 
     def reset!
-      browser.reset!
+      @browser.reset!
+      apply_options
     end
 
     def has_shortcircuit_timeout?
@@ -259,11 +271,19 @@ module Capybara::Webkit
       options[:width]  ||= 1000
       options[:height] ||= 10
 
-      browser.render path, options[:width], options[:height]
+      @browser.render path, options[:width], options[:height]
     end
 
     def cookies
-      @cookie_jar ||= CookieJar.new(browser)
+      @cookie_jar ||= CookieJar.new(@browser)
+    end
+
+    def set_cookie(cookie)
+      @browser.set_cookie(cookie)
+    end
+
+    def clear_cookies
+      @browser.clear_cookies
     end
 
     def invalid_element_errors
@@ -278,10 +298,32 @@ module Capybara::Webkit
       [
         "Capybara: #{Capybara::VERSION}",
         "capybara-webkit: #{Capybara::Driver::Webkit::VERSION}",
-        browser.version
+        @browser.version
       ].join("\n")
     end
 
+    def authenticate(username, password)
+      @browser.authenticate(username, password)
+    end
+
+    def timeout
+      deprecate_and_replace_with_config "timeout"
+      @browser.timeout
+    end
+
+    def timeout=(timeout)
+      deprecate_and_replace_with_config(
+        "timeout=",
+        "timeout = #{timeout.inspect}"
+      )
+      @browser.timeout = timeout
+    end
+
+    def browser
+      warn "[DEPRECATION] Capybara::Webkit::Driver#browser is deprecated."
+      @browser
+    end
+
     private
 
     def modal_action_options_for_browser(options)
@@ -294,7 +336,7 @@ module Capybara::Webkit
 
     def find_modal(type, id, options)
       Timeout::timeout(options[:wait] || Capybara.default_wait_time) do
-        browser.find_modal(id)
+        @browser.find_modal(id)
       end
     rescue ModalNotFound
       raise Capybara::ModalNotFound,
@@ -303,5 +345,44 @@ module Capybara::Webkit
       raise Capybara::ModalNotFound,
         "Timed out waiting for modal dialog#{" with #{options[:original_text]}" if options[:original_text]}"
     end
+
+    def apply_options
+      if @options[:debug]
+        @browser.enable_logging
+      end
+
+      if @options[:block_unknown_urls]
+        @browser.block_unknown_urls
+      end
+
+      if @options[:ignore_ssl_errors]
+        @browser.ignore_ssl_errors
+      end
+
+      if @options[:skip_image_loading]
+        @browser.set_skip_image_loading(true)
+      end
+
+      if @options[:proxy]
+        @browser.set_proxy(@options[:proxy])
+      end
+
+      if @options[:timeout]
+        @browser.timeout = @options[:timeout]
+      end
+
+      Array(@options[:allowed_urls]).each { |url| @browser.allow_url(url) }
+      Array(@options[:blocked_urls]).each { |url| @browser.block_url(url) }
+    end
+
+    def deprecate_and_replace_with_config(deprecated_method, config_syntax = deprecated_method)
+      warn "[DEPRECATION] #{deprecated_method} is deprecated. " \
+        "Please use Capybara::Webkit.configure instead:\n\n" \
+        "  Capybara::Webkit.configure do |config|\n" \
+        "    config.#{config_syntax}\n" \
+        "  end\n\n" \
+        "This option is global and can be configured once" \
+        " (not in a `before` or `setup` block)."
+    end
   end
 end