otherinbox-capybara-webkit 0.12.0 → 0.12.0.1

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/README.md

@@ -51,7 +51,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).
 

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     = "otherinbox-capybara-webkit"

data/lib/capybara/webkit.rb

@@ -1,11 +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|
-  browser = Capybara::Driver::Webkit::Browser.new(:socket_class => Capybara::Driver::Webkit::SocketDebugger)
-  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
@@ -81,6 +89,22 @@ class Capybara::Driver::Webkit
       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 command(name, *args)
       @connection.puts name
       @connection.puts args.size
@@ -137,9 +161,9 @@ class Capybara::Driver::Webkit
       result.strip! if result
 
       if result.nil?
-        raise WebkitNoResponseError, "No response received from the server."
+        raise NoResponseError, "No response received from the server."
       elsif result != 'ok'
-        raise WebkitInvalidResponseError, read_response
+        raise InvalidResponseError, read_response
       end
 
       result

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?
@@ -102,19 +114,5 @@ class Capybara::Driver::Webkit
       @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?
-      end
-    end
   end
 end

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

@@ -3,7 +3,7 @@ require 'webrick'
 # A simple cookie jar implementation.
 # Does not take special cookie attributes
 # into account like expire, max-age, httponly, secure
-class Capybara::Driver::Webkit::CookieJar
+class Capybara::Webkit::CookieJar
   attr_reader :browser
 
   def initialize(browser)

data/lib/capybara/webkit/driver.rb

@@ -0,0 +1,150 @@
+require "capybara"
+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
+    attr_reader :browser
+
+    def initialize(app, options={})
+      @app = app
+      @options = options
+      @rack_server = Capybara::Server.new(@app)
+      @rack_server.boot if Capybara.run_server
+      @browser = options[:browser] || Browser.new(Connection.new(options))
+    end
+
+    def enable_logging
+      browser.enable_logging
+    end
+
+    def current_url
+      browser.current_url
+    end
+
+    def requested_url
+      browser.requested_url
+    end
+
+    def visit(path)
+      browser.visit(url(path))
+    end
+
+    def find(query)
+      browser.find(query).map { |native| Node.new(self, native) }
+    end
+
+    def source
+      browser.source
+    end
+
+    def body
+      browser.body
+    end
+
+    def header(key, value)
+      browser.header(key, value)
+    end
+
+    def execute_script(script)
+      value = browser.execute_script script
+      value.empty? ? nil : value
+    end
+
+    def evaluate_script(script)
+      browser.evaluate_script script
+    end
+
+    def console_messages
+      browser.console_messages
+    end
+
+    def error_messages
+      browser.error_messages
+    end
+
+    def response_headers
+      browser.response_headers
+    end
+
+    def status_code
+      browser.status_code
+    end
+
+    def resize_window(width, height)
+      browser.resize_window(width, height)
+    end
+
+    def within_frame(frame_id_or_index)
+      browser.frame_focus(frame_id_or_index)
+      begin
+        yield
+      ensure
+        browser.frame_focus
+      end
+    end
+
+    def within_window(selector)
+      current_window = window_handle
+      browser.window_focus(selector)
+      begin
+        yield
+      ensure
+        browser.window_focus(current_window)
+      end
+    end
+
+    def window_handles
+      browser.get_window_handles
+    end
+
+    def window_handle
+      browser.get_window_handle
+    end
+
+    def wait?
+      true
+    end
+
+    def wait_until(*args)
+    end
+
+    def reset!
+      browser.reset!
+    end
+
+    def has_shortcircuit_timeout?
+      false
+    end
+
+    def render(path, options={})
+      options[:width]  ||= 1000
+      options[:height] ||= 10
+
+      browser.render path, options[:width], options[:height]
+    end
+
+    def server_port
+      @rack_server.port
+    end
+
+    def cookies
+      @cookie_jar ||= CookieJar.new(browser)
+    end
+
+    def invalid_element_errors
+      []
+    end
+
+    private
+
+    def url(path)
+      @rack_server.url(path)
+    end
+  end
+end

data/lib/capybara/webkit/errors.rb

@@ -0,0 +1,10 @@
+module Capybara::Webkit
+  class InvalidResponseError < StandardError
+  end
+
+  class NoResponseError < StandardError
+  end
+
+  class NodeNotAttachedError < Capybara::ElementNotFound
+  end
+end

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

@@ -1,4 +1,4 @@
-class Capybara::Driver::Webkit
+module Capybara::Webkit
   class Node < Capybara::Driver::Node
     NBSP = "\xC2\xA0"
     NBSP.force_encoding("UTF-8") if NBSP.respond_to?(:force_encoding)
@@ -91,7 +91,7 @@ class Capybara::Driver::Webkit
       if allow_unattached_nodes? || attached?
         browser.command "Node", name, native, *args
       else
-        raise Capybara::Driver::Webkit::NodeNotAttachedError
+        raise Capybara::Webkit::NodeNotAttachedError
       end
     end
 

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

@@ -1,6 +1,6 @@
 # Wraps the TCP socket and prints data sent and received. Used for debugging
 # the wire protocol. You can use this by passing a :socket_class to Browser.
-class Capybara::Driver::Webkit
+module Capybara::Webkit
   class SocketDebugger
     def self.open(host, port)
       real_socket = TCPSocket.open(host, port)