webkit_remote 0.3.2 → 0.4.0

data/.travis.yml

@@ -2,8 +2,6 @@ language: ruby
 rvm:
   - 1.9.3
 before_install:
-  - "export DISPLAY=:99.0"
-  - "sh -e /etc/init.d/xvfb start"
   - "sudo sh -c \"echo \\\"deb https://dl.google.com/linux/deb/ stable main\\\" >> /etc/apt/sources.list\""
   - "sudo wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -"
   - "sudo apt-get -qq update"

data/Gemfile

@@ -5,6 +5,7 @@ gem 'posix-spawn', '>= 0.3.6'
 
 group :development do
   gem 'bundler', '>= 1.2.1'
+  gem 'debugger', '>= 1.2.1'
   gem 'jeweler', '>= 1.8.4'
   gem 'minitest', '>= 4.1.0'
   gem 'puma', '>= 1.6.3'

data/Gemfile.lock

@@ -1,6 +1,14 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    columnize (0.3.6)
+    debugger (1.2.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.4)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.4)
     eventmachine (1.0.0)
     faye-websocket (0.4.6)
       eventmachine (>= 0.12.0)
@@ -19,7 +27,7 @@ GEM
     rack (1.4.1)
     rack-contrib (1.1.0)
       rack (>= 0.9.1)
-    rake (0.9.2.2)
+    rake (10.0.1)
     rdoc (3.12)
       json (~> 1.4)
     ruby-prof (0.11.2)
@@ -34,6 +42,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.2.1)
+  debugger (>= 1.2.1)
   eventmachine (>= 1.0.0)
   faye-websocket (>= 0.4.6)
   jeweler (>= 1.8.4)

data/README.md

@@ -25,6 +25,8 @@ Currently, the following sections of the
 have been implemented:
 
 * Console
+* DOM (incomplete)
+* Network
 * Page
 * Remote
 
@@ -36,6 +38,23 @@ platform-dependent functionality is launching and shutting down the browser
 process, everything else should work for any WebKit-based browser that
 implements the remote debugging protocol.
 
+Google Chrome can be used in a headless environment with
+[Xvfb](http://en.wikipedia.org/wiki/Xvfb).
+
+Install Xvfb on Fedora.
+
+```bash
+sudo yum install xorg-x11-server-Xvfb
+```
+
+Install Xvfb on Ubuntu.
+
+```bash
+sudo apt-get install xvfb
+```
+
+Xvfb is included in OSX.
+
 
 ## Installation
 
@@ -123,7 +142,8 @@ client.remote_eval '(function() { console.warn("hello ruby"); })();'
 Take a look at it.
 
 ```ruby
-message = client.wait_for(type: WebkitRemote::Event::ConsoleMessage).first
+client.wait_for type: WebkitRemote::Event::ConsoleMessage
+message = client.console_messages.first
 message.text
 message.level
 message.params
@@ -171,6 +191,21 @@ Clean up.
 client.clear_all
 ```
 
+### Explore the DOM
+
+Find a node and inspect its attributes.
+
+```ruby
+node = client.dom_root.query_selector '[name=text]'
+node.attributes['name']
+node.attributes['id']
+```
+
+Get the JavaScript DOM object for the node and explore its properties.
+
+```ruby
+node.js_object.properties['nodeName'].value
+```
 
 ### Close the Browser
 

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/lib/webkit_remote.rb

@@ -9,6 +9,8 @@ require 'webkit_remote/client.rb'
 require 'webkit_remote/event.rb'
 require 'webkit_remote/client/console.rb'
 require 'webkit_remote/client/console_events.rb'
+require 'webkit_remote/client/dom.rb'
+require 'webkit_remote/client/dom_events.rb'
 require 'webkit_remote/client/network.rb'
 require 'webkit_remote/client/network_events.rb'
 require 'webkit_remote/client/page.rb'

data/lib/webkit_remote/client/console.rb

@@ -22,15 +22,31 @@ module Console
   # @return [WebkitRemote::Client] self
   def clear_console
     @rpc.call 'Console.clearMessages'
+    console_cleared
     self
   end
 
   # @return [Boolean] true if the debugger generates Console.* events
   attr_reader :console_events
 
+  # @return [Array<WebkitRemote::Client::ConsoleMessage>]
+  attr_reader :console_messages
+
+  # @private Called by the ConsoleMessage event constructor
+  def console_add_message(message)
+    @console_messages << message
+  end
+
+  # @private Called by the ConsoleCleared event constructor.
+  def console_cleared
+    @console_messages.each(&:release_params)
+    @console_messages.clear
+  end
+
   # @private Called by the Client constructor to set up Console data.
   def initialize_console
     @console_events = false
+    @console_messages = []
   end
 end  # module WebkitRemote::Client::Console
 
@@ -38,6 +54,121 @@ initializer :initialize_console
 clearer :clear_console
 include WebkitRemote::Client::Console
 
+# Data about an entry in the debugger console.
+class ConsoleMessage
+  # @return [String] the message text
+  attr_reader :text
+
+  # @return [Array<WebkitRemote::Client::JsObject>] extra arguments given
+  #     to the message
+  attr_reader :params
+
+  # @return [Symbol] message severity
+  #
+  # The documented values are :debug, :error, :log, :tip, and :warning.
+  attr_reader :level
+
+  # @return [Integer] how many times this message was repeated
+  attr_accessor :count
+
+  # @return [Symbol] the component that produced this message
+  #
+  # The documented values are :console_api, :html, :javascript, :network,
+  #     :other, :wml, and :xml.
+  attr_reader :reason
+
+  # @return [WebkitRemote::Client::NetworkResource] resource associated with
+  #     this message
+  #
+  # This is set for console messages that indicate network errors.
+  attr_reader :network_resource
+
+  # @return [Symbol] the behavior that produced this message
+  #
+  # The documented values are :assert, :dir, :dirxml, :endGroup, :log,
+  #     :startGroup, :startGroupCollapsed, and :trace.
+  attr_reader :type
+
+  # @return [String] the URL of the file that caused this message
+  attr_reader :source_url
+
+  # @return [Integer] the line number of the statement that caused this message
+  attr_reader :source_line
+
+  # @return [Array<Hash<Symbol, Object>>] JavaScript stack trace to the
+  #     statement that caused this message
+  attr_reader :stack_trace
+
+  # @private Use Event#for instead of calling this constructor directly.
+  #
+  # @param [Hash<String, Object>] the raw JSON for a Message object in the
+  #     Console domain, returned by a RPC call to a Webkit debugging server
+  # @
+  def initialize(raw_message, client)
+    @level = (raw_message['level'] || 'error').to_sym
+    @source_line = raw_message['line'] ? raw_message['line'].to_i : nil
+    if raw_message['networkRequestId']
+      @network_resource =
+        client.network_resource raw_message['networkRequestId']
+    else
+      @network_resource = nil
+    end
+    if raw_message['parameters']
+      @params = raw_message['parameters'].map do |raw_object|
+        WebkitRemote::Client::JsObject.for raw_object, client, nil
+      end
+    else
+      @params = []
+    end
+    @params.freeze
+    @count = raw_message['repeatCount'] ? raw_message['repeatCount'].to_i : 1
+    if raw_message['source']
+      @reason = raw_message['source'].gsub('-', '_').to_sym
+    else
+      @reason = :other
+    end
+    @stack_trace = self.class.parse_stack_trace raw_message['stackTrace']
+    @text = raw_message['text']
+    @type = raw_message['type'] ? raw_message['type'].to_sym : nil
+    @source_url = raw_message['url']
+  end
+
+  # Releases the JavaScript objects referenced by this message's parameters.
+  def release_params
+    @params.each do |param|
+      if param.kind_of?(WebkitRemote::Client::JsObject)
+        param.release
+      end
+    end
+  end
+
+  # Parses a StackTrace object returned by a RPC request.
+  #
+  # @param [Array<String, Object>] raw_stack_trace the raw StackTrace object
+  #     in the Console domain returned by a RPC request
+  # @return [Array<Symbol, Object>] Ruby-friendly stack trace
+  def self.parse_stack_trace(raw_stack_trace)
+    return nil unless raw_stack_trace
+
+    raw_stack_trace.map do |raw_frame|
+      frame = {}
+      if raw_frame['columnNumber']
+        frame[:column] = raw_frame['columnNumber'].to_i
+      end
+      if raw_frame['lineNumber']
+        frame[:line] = raw_frame['lineNumber'].to_i
+      end
+      if raw_frame['functionName']
+        frame[:function] = raw_frame['functionName']
+      end
+      if raw_frame['url']
+        frame[:url] = raw_frame['url']
+      end
+      frame
+    end
+  end
+end  # class WebkitRemote::Client::ConsoleMessage
+
 end  # namespace WebkitRemote::Client
 
 end  # namespace WebkitRemote

data/lib/webkit_remote/client/console_events.rb

@@ -6,82 +6,39 @@ class Event
 class ConsoleMessage < WebkitRemote::Event
   register 'Console.messageAdded'
 
-  # @return [String] the message text
-  attr_reader :text
+  # @return [WebkitRemote::Client::ConsoleMessage] the new message
+  attr_reader :message
 
-  # @return [Array<WebkitRemote::Client::RemoteObject>] extra arguments given
-  #     to the message
-  attr_reader :params
+  # @return [String] the message text
+  def text
+    @message.text
+  end
 
   # @return [Symbol] message severity
   #
   # The documented values are :debug, :error, :log, :tip, and :warning.
-  attr_reader :level
-
-  # @return [Integer] how many times this message was repeated
-  attr_reader :count
+  def level
+    @message.level
+  end
 
   # @return [Symbol] the component that produced this message
   #
   # The documented values are :console_api, :html, :javascript, :network,
   #     :other, :wml, and :xml.
-  attr_reader :reason
-
-  # @return [Symbol] the behavior that produced this message
-  #
-  # The documented values are :assert, :dir, :dirxml, :endGroup, :log,
-  #     :startGroup, :startGroupCollapsed, and :trace.
-  attr_reader :type
-
-  # @return [String] the URL of the file that caused this message
-  attr_reader :source_url
-
-  # @return [Integer] the line number of the statement that caused this message
-  attr_reader :source_line
-
-  # @return [Array<Hash<Symbol, Object>>] JavaScript stack trace to the
-  #     statement that caused this message
-  attr_reader :stack_trace
+  def reason
+    @message.reason
+  end
 
   # @private Use Event#for instead of calling this constructor directly.
   def initialize(rpc_event, client)
     super
 
     if raw_message = raw_data['message']
-      @level = (raw_message['level'] || 'error').to_sym
-      @source_line = raw_message['line'] ? raw_message['line'].to_i : nil
-      # TODO(pwnall): parse networkRequestId when Network is implemented
-      if raw_message['parameters']
-        @params = raw_message['parameters'].map do |raw_object|
-          WebkitRemote::Client::RemoteObject.for raw_object, client, nil
-        end
-      else
-        @params = []
-      end
-      @params.freeze
-      @count = raw_message['repeatCount'] ? raw_message['repeatCount'].to_i : 1
-      if raw_message['source']
-        @reason = raw_message['source'].gsub('-', '_').to_sym
-      else
-        @reason = :other
-      end
-      @stack_trace = WebkitRemote::Event::ConsoleMessage.parse_stack_trace(
-          raw_message['stackTrace'])
-      @text = raw_message['text']
-      @type = raw_message['type'] ? raw_message['type'].to_sym : nil
-      @source_url = raw_message['url']
-    end
-
-    # NOTE(pwnall): if the client will keep track of console messages, this is
-    #     the right place to call into the client and register the message
-  end
-
-  # Releases the JavaScript objects referenced by this message's parameters.
-  def release_params()
-    @params.each do |param|
-      if param.kind_of?(WebkitRemote::Client::RemoteObject)
-        param.release
-      end
+      @message = WebkitRemote::Client::ConsoleMessage.new raw_data['message'],
+                                                          client
+      client.console_add_message @message
+    else
+      @message = nil
     end
   end
 
@@ -89,50 +46,25 @@ class ConsoleMessage < WebkitRemote::Event
   def self.can_reach?(client)
     client.console_events
   end
-
-
-  # Parses a StackTrace object returned by a RPC request.
-  #
-  # @param [Array<String, Object>] raw_stack_trace the raw StackTrace object
-  #     in the Console domain returned by a RPC request
-  # @return [Array<Symbol, Object>] Ruby-friendly stack trace
-  def self.parse_stack_trace(raw_stack_trace)
-    return nil unless raw_stack_trace
-
-    raw_stack_trace.map do |raw_frame|
-      frame = {}
-      if raw_frame['columnNumber']
-        frame[:column] = raw_frame['columnNumber'].to_i
-      end
-      if raw_frame['lineNumber']
-        frame[:line] = raw_frame['lineNumber'].to_i
-      end
-      if raw_frame['functionName']
-        frame[:function] = raw_frame['functionName']
-      end
-      if raw_frame['url']
-        frame[:url] = raw_frame['url']
-      end
-      frame
-    end
-  end
 end  # class WebkitRemote::Event::ConsoleMessage
 
 # Emitted when the same console message is produced repeatedly.
 class ConsoleMessageRepeated < WebkitRemote::Event
   register 'Console.messageRepeatCountUpdated'
 
+  # @return [WebkitRemote::Client::ConsoleMessage] the repeated message
+  attr_reader :message
+
   # @return [Number] the number of times that the message was repeated
   attr_reader :count
 
   # @private Use Event#for instead of calling this constructor directly.
   def initialize(rpc_event, client)
     super
-    @count = raw_data['count'] ? raw_data['count'].to_i : nil
 
-    # NOTE(pwnall): if the client will keep track of console messages, this is
-    #     the right place to call into the client and have it update the repeat
-    #     count of the most recent message that it received
+    @message = client.console_messages.last
+    @count = raw_data['count'] ? raw_data['count'].to_i : nil
+    @message.count = @count if @count
   end
 
   # @private Use Event#can_receive instead of calling this directly.
@@ -148,10 +80,7 @@ class ConsoleCleared < WebkitRemote::Event
   # @private Use Event#for instead of calling this constructor directly.
   def initialize(rpc_event, client)
     super
-
-    # NOTE(pwnall): if the client will keep track of console messages, this is
-    #     the right place to call into the client and have it wipe its message
-    #     list, and call #release_params on the messages
+    client.console_cleared
   end
 
   # @private Use Event#can_receive instead of calling this directly.