capybara-webkit 0.12.1 → 0.13.0

data/.gitignore

@@ -16,4 +16,5 @@ src/webkit_server.exe
 .DS_Store
 tmp
 .rvmrc
-src/debug
+src/debug
+webkit_server.pro.user

data/GOALS

@@ -0,0 +1,9 @@
+capybara-webkit hits 1.0.0 when:
+
+* All shared examples from capybara are implemented. See
+  capybara:lib/capybara/spec/**/*rb for the shared example groups.
+* Test failures are a result of issues in the developer's code and not
+  capybara-webkit.
+* Test failures lead to clear explanations for what failed and what can
+  be done to resolve them.
+* It handles iframes, cookies, page loading, and other oddities.

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    capybara-webkit (0.12.1)
+    capybara-webkit (0.13.0)
       capybara (>= 1.0.0, < 1.2)
       json
 
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.3.2)
     appraisal (0.4.0)
       bundler
       rake
@@ -18,18 +19,20 @@ GEM
       rack-test (>= 0.5.4)
       selenium-webdriver (~> 2.0)
       xpath (~> 0.1.4)
-    childprocess (0.3.1)
-      ffi (~> 1.0.6)
+    childprocess (0.3.6)
+      ffi (~> 1.0, >= 1.0.6)
     diff-lcs (1.1.2)
-    ffi (1.0.11)
-    json (1.7.1)
-    mime-types (1.18)
+    ffi (1.1.5)
+    json (1.7.5)
+    libwebsocket (0.1.5)
+      addressable
+    mime-types (1.19)
     mini_magick (3.2.1)
       subexec (~> 0.0.4)
-    multi_json (1.3.2)
-    nokogiri (1.5.2)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
     rack (1.3.2)
-    rack-test (0.6.1)
+    rack-test (0.6.2)
       rack (>= 1.0)
     rake (0.9.2)
     rspec (2.6.0)
@@ -40,10 +43,10 @@ GEM
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
-    rubyzip (0.9.7)
-    selenium-webdriver (2.20.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
       childprocess (>= 0.2.5)
-      ffi (~> 1.0)
+      libwebsocket (~> 0.1.3)
       multi_json (~> 1.0)
       rubyzip
     sinatra (1.1.2)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 thoughtbot, inc.
+Copyright (c) 2010-2012 thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/NEWS.md

@@ -1,3 +1,21 @@
+New for HEAD:
+
+* Better detect page load success, and better handle load failures.
+* HTTP Basic Auth support.
+* within_window support.
+* More useful and detailed debugging output.
+* Catch up with recent capybara releases.
+* Ignore errors from canceled requests.
+* Follow how Selenium treats focus and blur form events.
+* Control JavaScript prompts from Ruby.
+* Each command has a configurable timeout.
+* Performance improvements on Linux.
+* Support empty `multiple` attributes.
+
+New for 0.12.1:
+
+* Fix integration with newer capybara for the debugging driver.
+
 New for 0.12.0:
 * Better windows support
 * Support for localStorage

data/README.md

@@ -1,6 +1,8 @@
 capybara-webkit
 ===============
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/thoughtbot/capybara-webkit)
+
 A [capybara](https://github.com/jnicklas/capybara) driver that uses [WebKit](http://webkit.org) via [QtWebKit](http://doc.qt.nokia.com/4.7/qtwebkit.html).
 
 Qt Dependency and Installation Issues
@@ -51,7 +53,7 @@ Set your Capybara Javascript driver to webkit:
 
 In cucumber, tag scenarios with @javascript to run them using a headless WebKit browser.
 
-In RSpec, use the :js => true flag.
+In RSpec, use the :js => true flag. See the [capybara documention](http://rubydoc.info/gems/capybara#Using_Capybara_with_RSpec) for more information about using capybara with RSpec.
 
 Take note of the transactional fixtures section of the [capybara README](https://github.com/jnicklas/capybara/blob/master/README.md).
 
@@ -77,6 +79,20 @@ capybara-webkit supports a few methods that are not part of the standard capybar
     page.driver.error_messages
     => {:source=>"http://example.com", :line_number=>1, :message=>"SyntaxError: Parse error"}
 
+**alert_messages, confirm_messages, prompt_messages**: returns arrays of Javascript dialog messages for each dialog type
+
+    # In Javascript:
+    alert("HI");
+    confirm("Ok?");
+    prompt("Number?", "42");
+    # In Ruby:
+    page.driver.alert_messages
+    => ["Hi"]
+    page.driver.confirm_messages
+    => ["Ok?"]
+    page.driver.prompt_messages
+    => ["Number?"]
+
 **resize_window**: change the viewport size to the given width and height
 
     page.driver.resize_window(500, 300)
@@ -92,6 +108,69 @@ capybara-webkit supports a few methods that are not part of the standard capybar
     page.driver.cookies["alpha"]
     => "abc"
 
+**accept_js_confirms!**: accept any Javascript confirm that is triggered by the page's Javascript
+
+    # In Javascript:
+    if (confirm("Ok?"))
+      console.log("Hi");
+    else
+      console.log("Bye");
+    # In Ruby:
+    page.driver.accept_js_confirms!
+    visit "/"
+    page.driver.console_messages.first[:message]
+    => "Hi"
+
+**dismiss_js_confirms!**: dismiss any Javascript confirm that is triggered by the page's Javascript
+
+    # In Javascript:
+    if (confirm("Ok?"))
+      console.log("Hi");
+    else
+      console.log("Bye");
+    # In Ruby:
+    page.driver.dismiss_js_confirms!
+    visit "/"
+    page.driver.console_messages.first[:message]
+    => "Bye"
+
+**accept_js_prompts!**: accept any Javascript prompt that is triggered by the page's Javascript
+
+    # In Javascript:
+    var a = prompt("Number?", "0")
+    console.log(a);
+    # In Ruby:
+    page.driver.accept_js_prompts!
+    visit "/"
+    page.driver.console_messages.first[:message]
+    => "0"
+
+**dismiss_js_prompts!**: dismiss any Javascript prompt that is triggered by the page's Javascript
+
+    # In Javascript:
+    var a = prompt("Number?", "0")
+    if (a != null)
+      console.log(a);
+    else
+      console.log("you said no"));
+    # In Ruby:
+    page.driver.dismiss_js_prompts!
+    visit "/"
+    page.driver.console_messages.first[:message]
+    => "you said no"
+
+**js_prompt_input=(value)**: set the text to use if a Javascript prompt is encountered and accepted
+
+    # In Javascript:
+    var a = prompt("Number?", "0")
+    console.log(a);
+    # In Ruby:
+    page.driver.js_prompt_input = "42"
+    page.driver.accept_js_prompts!
+    visit "/"
+    page.driver.console_messages.first[:message]
+    => "42"
+
 Contributing
 ------------
 
@@ -111,4 +190,4 @@ The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 License
 -------
 
-capybara-webkit is Copyright (c) 2011 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.
+capybara-webkit is Copyright (c) 2010-2012 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.

data/capybara-webkit.gemspec

@@ -1,5 +1,5 @@
 $:.push File.expand_path("../lib", __FILE__)
-require "capybara/driver/webkit/version"
+require "capybara/webkit/version"
 
 Gem::Specification.new do |s|
   s.name     = "capybara-webkit"

data/lib/capybara/webkit.rb

@@ -1,13 +1,18 @@
 require "capybara"
-require "capybara/driver/webkit"
+
+module Capybara
+  module Webkit
+  end
+end
+
+require "capybara/webkit/driver"
 
 Capybara.register_driver :webkit do |app|
-  Capybara::Driver::Webkit.new(app)
+  Capybara::Webkit::Driver.new(app)
 end
 
 Capybara.register_driver :webkit_debug do |app|
-  connection = Capybara::Driver::Webkit::Connection.new(
-    :socket_class => Capybara::Driver::Webkit::SocketDebugger)
-  browser = Capybara::Driver::Webkit::Browser.new(connection)
-  Capybara::Driver::Webkit.new(app, :browser => browser)
+  driver = Capybara::Webkit::Driver.new(app)
+  driver.enable_logging
+  driver
 end

data/lib/capybara/{driver/webkit → webkit}/browser.rb

@@ -1,11 +1,19 @@
 require 'json'
 
-class Capybara::Driver::Webkit
+module Capybara::Webkit
   class Browser
     def initialize(connection)
       @connection = connection
     end
 
+    def authenticate(username, password)
+      command("Authenticate", username, password)
+    end
+
+    def enable_logging
+      command "EnableLogging"
+    end
+
     def visit(url)
       command "Visit", url
     end
@@ -47,6 +55,18 @@ class Capybara::Driver::Webkit
       end
     end
 
+    def alert_messages
+      command("JavascriptAlertMessages").split("\n")
+    end
+
+    def confirm_messages
+      command("JavascriptConfirmMessages").split("\n")
+    end
+
+    def prompt_messages
+      command("JavascriptPromptMessages").split("\n")
+    end
+
     def response_headers
       Hash[command("Headers").split("\n").map { |header| header.split(": ") }]
     end
@@ -77,6 +97,50 @@ class Capybara::Driver::Webkit
       command("IgnoreSslErrors")
     end
 
+    def set_skip_image_loading(skip_image_loading)
+      command("SetSkipImageLoading", skip_image_loading)
+    end
+
+    def window_focus(selector)
+      command("WindowFocus", selector)
+    end
+
+    def get_window_handles
+      JSON.parse(command('GetWindowHandles'))
+    end
+
+    alias_method :window_handles, :get_window_handles
+
+    def get_window_handle
+      command('GetWindowHandle')
+    end
+
+    alias_method :window_handle, :get_window_handle
+
+    def accept_js_confirms
+      command("SetConfirmAction", "Yes")
+    end
+
+    def reject_js_confirms
+      command("SetConfirmAction", "No")
+    end
+
+    def accept_js_prompts
+      command("SetPromptAction", "Yes")
+    end
+
+    def reject_js_prompts
+      command("SetPromptAction", "No")
+    end
+
+    def set_prompt_text_to(string)
+      command("SetPromptText", string)
+    end
+
+    def clear_prompt_text
+      command("ClearPromptText")
+    end
+
     def command(name, *args)
       @connection.puts name
       @connection.puts args.size
@@ -101,6 +165,14 @@ class Capybara::Driver::Webkit
       command "Render", path, width, height
     end
 
+    def timeout=(timeout_in_seconds)
+      command "SetTimeout", timeout_in_seconds
+    end
+
+    def timeout
+      command("GetTimeout").to_i
+    end
+
     def set_cookie(cookie)
       command "SetCookie", cookie
     end
@@ -133,14 +205,28 @@ class Capybara::Driver::Webkit
       result.strip! if result
 
       if result.nil?
-        raise WebkitNoResponseError, "No response received from the server."
-      elsif result != 'ok' 
-        raise WebkitInvalidResponseError, read_response
+        raise NoResponseError, "No response received from the server."
+      elsif result != 'ok'
+        case response = read_response
+        when "timeout"
+          raise Capybara::TimeoutError, "Request timed out after #{timeout_seconds}"
+        else
+          raise InvalidResponseError, response
+        end
       end
 
       result
     end
 
+    def timeout_seconds
+      seconds = timeout
+      if seconds > 1
+        "#{seconds} seconds"
+      else
+        "1 second"
+      end
+    end
+
     def read_response
       response_length = @connection.gets.to_i
       if response_length > 0

data/lib/capybara/{driver/webkit → webkit}/connection.rb

@@ -2,17 +2,17 @@ require 'socket'
 require 'timeout'
 require 'thread'
 
-class Capybara::Driver::Webkit
+module Capybara::Webkit
   class Connection
+    SERVER_PATH = File.expand_path("../../../../bin/webkit_server", __FILE__)
     WEBKIT_SERVER_START_TIMEOUT = 15
 
     attr_reader :port
 
     def initialize(options = {})
       @socket_class = options[:socket_class] || TCPSocket
-      @stdout       = options.has_key?(:stdout) ?
-                        options[:stdout] :
-                        $stdout
+      @stdout = options.has_key?(:stdout) ?  options[:stdout] : $stdout
+      @command = options[:command] || SERVER_PATH
       start_server
       connect
     end
@@ -36,52 +36,50 @@ class Capybara::Driver::Webkit
     private
 
     def start_server
-      pipe = fork_server
-      @port = discover_port(pipe)
-      @stdout_thread = Thread.new do
-        Thread.current.abort_on_exception = true
-        forward_stdout(pipe)
-      end
+      open_pipe
+      discover_port
+      forward_stdout_in_background_thread
     end
 
-    def fork_server
-      server_path = File.expand_path("../../../../../bin/webkit_server", __FILE__)
-      pipe, @pid = server_pipe_and_pid(server_path)
+    def open_pipe
+      @pipe = IO.popen(@command)
+      @pid = @pipe.pid
       register_shutdown_hook
-      pipe
-    end
-
-    def kill_process(pid)
-      if RUBY_PLATFORM =~ /mingw32/
-        Process.kill(9, pid)
-      else
-        Process.kill("INT", pid)
-      end
     end
 
     def register_shutdown_hook
       @owner_pid = Process.pid
       at_exit do
         if Process.pid == @owner_pid
-          kill_process(@pid)
+          kill_process
         end
       end
     end
 
-    def server_pipe_and_pid(server_path)
-      cmdline = [server_path]
-      pipe = IO.popen(cmdline.join(" "))
-      [pipe, pipe.pid]
+    def kill_process
+      if RUBY_PLATFORM =~ /mingw32/
+        Process.kill(9, @pid)
+      else
+        Process.kill("INT", @pid)
+      end
     end
 
-    def discover_port(read_pipe)
-      return unless IO.select([read_pipe], nil, nil, WEBKIT_SERVER_START_TIMEOUT)
-      ((read_pipe.first || '').match(/listening on port: (\d+)/) || [])[1].to_i
+    def discover_port
+      if IO.select([@pipe], nil, nil, WEBKIT_SERVER_START_TIMEOUT)
+        @port = ((@pipe.first || '').match(/listening on port: (\d+)/) || [])[1].to_i
+      end
     end
 
-    def forward_stdout(pipe)
-      while pipe_readable?(pipe)
-        line = pipe.readline
+    def forward_stdout_in_background_thread
+      @stdout_thread = Thread.new do
+        Thread.current.abort_on_exception = true
+        forward_stdout
+      end
+    end
+
+    def forward_stdout
+      while pipe_readable?
+        line = @pipe.readline
         if @stdout
           @stdout.write(line)
           @stdout.flush
@@ -90,6 +88,20 @@ class Capybara::Driver::Webkit
     rescue EOFError
     end
 
+    if !defined?(RUBY_ENGINE) || (RUBY_ENGINE == "ruby" && RUBY_VERSION <= "1.8")
+      # please note the use of IO::select() here, as it is used specifically to
+      # preserve correct signal handling behavior in ruby 1.8.
+      # https://github.com/thibaudgg/rb-fsevent/commit/d1a868bf8dc72dbca102bedbadff76c7e6c2dc21
+      # https://github.com/thibaudgg/rb-fsevent/blob/1ca42b987596f350ee7b19d8f8210b7b6ae8766b/ext/fsevent/fsevent_watch.c#L171
+      def pipe_readable?
+        IO.select([@pipe])
+      end
+    else
+      def pipe_readable?
+        !@pipe.eof?
+      end
+    end
+
     def connect
       Timeout.timeout(5) do
         while @socket.nil?
@@ -100,21 +112,10 @@ class Capybara::Driver::Webkit
 
     def attempt_connect
       @socket = @socket_class.open("127.0.0.1", @port)
-    rescue Errno::ECONNREFUSED
-    end
-
-    if !defined?(RUBY_ENGINE) || (RUBY_ENGINE == "ruby" && RUBY_VERSION <= "1.8")
-      # please note the use of IO::select() here, as it is used specifically to
-      # preserve correct signal handling behavior in ruby 1.8.
-      # https://github.com/thibaudgg/rb-fsevent/commit/d1a868bf8dc72dbca102bedbadff76c7e6c2dc21
-      # https://github.com/thibaudgg/rb-fsevent/blob/1ca42b987596f350ee7b19d8f8210b7b6ae8766b/ext/fsevent/fsevent_watch.c#L171
-      def pipe_readable?(pipe)
-        IO.select([pipe])
-      end
-    else
-      def pipe_readable?(pipe)
-        !pipe.eof?
+      if defined?(Socket::TCP_NODELAY)
+        @socket.setsockopt(:IPPROTO_TCP, :TCP_NODELAY, 1)
       end
+    rescue Errno::ECONNREFUSED
     end
   end
 end