capybara-webkit 0.5.0 → 0.6.0

data/.gitignore

@@ -12,3 +12,6 @@ moc_*.cpp
 .bundle
 pkg
 src/webkit_server
+.DS_Store
+tmp
+.rvmrc

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+We love pull requests. Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate: `bundle && rake`
+
+3. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request.
+
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+  whatever is affected by your contribution
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+* a = b and not a=b.
+* Follow the conventions you see used in the source already.
+
+And in case we didn't emphasize it enough: we love tests!

data/Gemfile

@@ -1,5 +1,6 @@
 source "http://rubygems.org"
-gem "rspec", :require => false
+gem "rspec", '~> 2.6.0', :require => false
 gem "capybara"
 gem "sinatra", :require => false
-
+gem "mini_magick", :require => false
+gem 'rake'

data/Gemfile.lock

@@ -1,48 +1,46 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    capybara (0.4.1.2)
-      celerity (>= 0.7.9)
-      culerity (>= 0.2.4)
+    capybara (1.0.0)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
-      selenium-webdriver (>= 0.0.27)
-      xpath (~> 0.1.3)
-    celerity (0.8.8)
-    childprocess (0.1.7)
-      ffi (~> 0.6.3)
-    culerity (0.2.15)
+      selenium-webdriver (~> 0.2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.1.9)
+      ffi (~> 1.0.6)
     diff-lcs (1.1.2)
-    ffi (0.6.3)
-      rake (>= 0.8.7)
-    json_pure (1.5.1)
+    ffi (1.0.9)
+    json_pure (1.5.3)
     mime-types (1.16)
-    nokogiri (1.4.4)
-    rack (1.2.1)
-    rack-test (0.5.7)
+    mini_magick (3.2.1)
+      subexec (~> 0.0.4)
+    nokogiri (1.5.0)
+    rack (1.3.0)
+    rack-test (0.6.0)
       rack (>= 1.0)
-    rake (0.8.7)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
+    rspec-mocks (2.6.0)
     rubyzip (0.9.4)
-    selenium-webdriver (0.1.3)
-      childprocess (~> 0.1.5)
-      ffi (~> 0.6.3)
+    selenium-webdriver (0.2.2)
+      childprocess (>= 0.1.9)
+      ffi (>= 1.0.7)
       json_pure
       rubyzip
     sinatra (1.1.2)
       rack (~> 1.1)
       tilt (~> 1.2)
+    subexec (0.0.4)
     tilt (1.2.2)
-    xpath (0.1.3)
+    xpath (0.1.4)
       nokogiri (~> 1.3)
 
 PLATFORMS
@@ -50,5 +48,7 @@ PLATFORMS
 
 DEPENDENCIES
   capybara
-  rspec
+  mini_magick
+  rake
+  rspec (~> 2.6.0)
   sinatra

data/README.md

@@ -3,14 +3,36 @@ 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).
 
-Dependencies
-------------
+Dependent on Qt
+---------------
 
 capybara-webkit depends on a WebKit implementation from Qt, a cross-platform development toolkit. You'll need to download the Qt libraries to build and install the gem.
 
-If you're on OS X, [download the non-debug Cocoa package](http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x). Note that installing Qt via homebrew takes more than an hour, so we don't recommend it.
+OS X Lion 10.7:
+
+Install Qt via [homebrew](http://mxcl.github.com/homebrew/)(can take more than an hour) using:
+
+    brew install qt --build-from-source
+
+OS X < 10.7:
+
+[Download the non-debug Cocoa package](http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x).
+
+Ubuntu:
+
+    apt-get install libqt4-dev
+
+Fedora:
+
+    yum install qt-webkit-devel
+
+Gentoo Linux:
 
-If you're on Ubuntu, you can install the libqt4-dev package. For other Linux distributions, [download this package](http://qt.nokia.com/downloads/linux-x11-cpp).
+    emerge x11-libs/qt-webkit
+
+Other Linux distributions:
+
+[Download this package](http://qt.nokia.com/downloads/linux-x11-cpp).
 
 CI
 --
@@ -32,15 +54,28 @@ Set your Capybara Javascript driver to webkit:
 
 Tag scenarios with @javascript to run them using a headless WebKit browser.
 
+Contributing
+------------
+
+See the CONTRIBUTING document.
+
 About
 -----
 
 The capybara WebKit driver was written by Joe Ferris, Tristan Dunn, and Jason Morrison from [thoughtbot, inc](http://thoughtbot.com/community).
 
+Code for rendering the current webpage to a PNG is borrowed from Phantom.js' implementation.
+
 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
 
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
+Notes
+-----
+
+This capybara WebKit driver will listen on port 8200, this may conflict
+with other services.
+
 License
 -------
 

data/capybara-webkit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "capybara-webkit"
-  s.version = "0.5.0"
+  s.version = "0.6.0"
   s.authors = ["thoughtbot", "Joe Ferris", "Jason Morrison", "Tristan Dunn",
                "Joshua Clayton", "Yuichi Tateno", "Aaron Gibralter",
                "Vasily Reys", "petrushka", "John Bintz", "Chad Pytel",
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.require_path = "lib"
   s.rubygems_version = "1.3.5"
   s.summary = "Headless Webkit driver for Capybara"
-  s.add_runtime_dependency "capybara", "~> 0.4.1"
+  s.add_runtime_dependency "capybara", "~> 1.0.0"
   s.extensions = "extconf.rb"
 end
 

data/lib/capybara-webkit.rb

@@ -5,3 +5,7 @@ Capybara.register_driver :webkit do |app|
   Capybara::Driver::Webkit.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)
+end

data/lib/capybara/driver/webkit.rb

@@ -1,9 +1,13 @@
 require "capybara"
 require "capybara/driver/webkit/node"
 require "capybara/driver/webkit/browser"
+require "capybara/driver/webkit/socket_debugger"
 
 class Capybara::Driver::Webkit
-  class WebkitError < StandardError
+  class WebkitInvalidResponseError < StandardError
+  end
+
+  class WebkitNoResponseError < StandardError
   end
 
   attr_reader :browser
@@ -33,11 +37,16 @@ class Capybara::Driver::Webkit
   end
 
   def body
-    source
+    browser.body
+  end
+
+  def header(key, value)
+    browser.header(key, value)
   end
 
   def execute_script(script)
-    browser.execute_script script
+    value = browser.execute_script script
+    value.empty? ? nil : value
   end
 
   def evaluate_script(script)
@@ -80,6 +89,17 @@ class Capybara::Driver::Webkit
     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
+
   private
 
   def url(path)

data/lib/capybara/driver/webkit/browser.rb

@@ -4,6 +4,8 @@ require 'json'
 
 class Capybara::Driver::Webkit
   class Browser
+    attr :server_port
+
     def initialize(options = {})
       @socket_class = options[:socket_class] || TCPSocket
       start_server
@@ -14,6 +16,10 @@ class Capybara::Driver::Webkit
       command "Visit", url
     end
 
+    def header(key, value)
+      command("Header", key, value)
+    end
+
     def find(query)
       command("Find", query).split(",")
     end
@@ -22,6 +28,10 @@ class Capybara::Driver::Webkit
       command("Reset")
     end
 
+    def body
+      command("Body")
+    end
+
     def source
       command("Source")
     end
@@ -45,7 +55,7 @@ class Capybara::Driver::Webkit
       @socket.puts args.size
       args.each do |arg|
         @socket.puts arg.to_s.bytesize
-        @socket.print arg
+        @socket.print arg.to_s
       end
       check
       read_response
@@ -60,12 +70,35 @@ class Capybara::Driver::Webkit
       command('Execute', script)
     end
 
+    def render(path, width, height)
+      command "Render", path, width, height
+    end
+
     private
 
     def start_server
+      read_pipe, write_pipe = fork_server
+      @server_port = discover_server_port(read_pipe)
+    end
+
+    def fork_server
       server_path = File.expand_path("../../../../../bin/webkit_server", __FILE__)
-      @pid = fork { exec(server_path) }
+
+      read_pipe, write_pipe = IO.pipe
+      @pid = fork do
+        $stdout.reopen write_pipe
+        read_pipe.close
+        exec(server_path)
+      end
       at_exit { Process.kill("INT", @pid) }
+
+      write_pipe.close
+      [read_pipe, write_pipe]
+    end
+
+    def discover_server_port(read_pipe)
+      return unless IO.select([read_pipe], nil, nil, 10)
+      ((read_pipe.first || '').match(/listening on port: (\d+)/) || [])[1].to_i
     end
 
     def connect
@@ -76,16 +109,21 @@ class Capybara::Driver::Webkit
     end
 
     def attempt_connect
-      @socket = @socket_class.open("localhost", 9200)
+      @socket = @socket_class.open("localhost", @server_port)
     rescue Errno::ECONNREFUSED
     end
 
     def check
-      result = @socket.gets.strip
+      result = @socket.gets
+      result.strip! if result
 
-      unless result == 'ok'
-        raise WebkitError, read_response
+      if result.nil?
+        raise WebkitNoResponseError, "No response received from the server."
+      elsif result != 'ok' 
+        raise WebkitInvalidResponseError, read_response
       end
+
+      result
     end
 
     def read_response

data/lib/capybara/driver/webkit/node.rb

@@ -34,7 +34,12 @@ class Capybara::Driver::Webkit
     end
 
     def unselect_option
-      invoke "unselectOption"
+      select = find("ancestor::select").first
+      if select.multiple_select?
+        invoke "unselectOption"
+      else
+        raise Capybara::UnselectNotAllowed
+      end
     end
 
     def click
@@ -53,10 +58,18 @@ class Capybara::Driver::Webkit
       invoke("visible") == "true"
     end
 
+    def selected?
+      invoke("selected") == "true"
+    end
+
+    def checked?
+      self['checked']
+    end
+
     def disabled?
       self['disabled']
     end
-    
+
     def path
       raise Capybara::NotSupportedByDriverError
     end
@@ -79,8 +92,6 @@ class Capybara::Driver::Webkit
       driver.browser
     end
 
-    private
-
     def multiple_select?
       self.tag_name == "select" && self["multiple"] == "multiple"
     end

data/lib/capybara/driver/webkit/socket_debugger.rb

@@ -0,0 +1,43 @@
+# 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
+  class SocketDebugger
+    def self.open(host, port)
+      real_socket = TCPSocket.open(host, port)
+      new(real_socket)
+    end
+
+    def initialize(socket)
+      @socket = socket
+    end
+
+    def read(length)
+      received @socket.read(length)
+    end
+
+    def puts(line)
+      sent line
+      @socket.puts(line)
+    end
+
+    def print(content)
+      sent content
+      @socket.print(content)
+    end
+
+    def gets
+      received @socket.gets
+    end
+
+    private
+
+    def sent(content)
+      Kernel.puts " >> " + content.to_s
+    end
+
+    def received(content)
+      Kernel.puts " << " + content.to_s
+      content
+    end
+  end
+end