webkit_remote_unstable 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 484a5b3e3e676e39784355b98fb8f2af4314d961
-  data.tar.gz: da3586c9f9f985e39b336cf2556e493d54c59459
+  metadata.gz: 92207ab762337f22db4f10bcd26525d254c02f4d
+  data.tar.gz: d22bb09a90c7c0c0978657b0ffcab3549054588d
 SHA512:
-  metadata.gz: 96cb133e49bae96fc65589219e277da8ce6c10dfd82062aa8e0da1ac893d61f797fafcf0d45750eefb8e9252a781a72be75eeeec5232f5d40999a8990365145f
-  data.tar.gz: c79cb1b179f4cfaa34f4e6ba557906b3fe1cd0833e95cfbba4ac05f0377be5ccfc65a9f1bf29e174a1092a45c35cf7351b3311e3467fa2bcef69cd6fc48dc58a
+  metadata.gz: a15fc42945c824463215ec5573e5c19c8788562c78cc901816155b9ed8ad0c258e7125b3ccb3b2639aee13ffad76106953ff0ef3e01f0c2396e6248901f7f895
+  data.tar.gz: 001ec141a3a3ad5e44957a3e44e76ee9f67ad437f8c36e7295ffe65fc2e293cb6f1100a83d5f992fdfe480aa0c754318a9545b38248ec04043809cfe172744a7

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/webkit_remote_unstable.rb

@@ -3,4 +3,5 @@ require 'webkit_remote'
 
 require 'webkit_remote_unstable/css.rb'
 require 'webkit_remote_unstable/css_events.rb'
+require 'webkit_remote_unstable/dom.rb'
 require 'webkit_remote_unstable/page.rb'

data/lib/webkit_remote_unstable/dom.rb

@@ -0,0 +1,98 @@
+module WebkitRemote
+
+class Client
+
+# Unstable API for the DOM domain.
+module Dom
+  # Retrieves the node at a given location.
+  #
+  # @param [Integer] x the X coordinate, in window coordinates
+  # @param [Integer] y the Y coordinate, in window coordinates
+  def dom_node_at(x, y)
+    result = @rpc.call 'DOM.getNodeForLocation', x: x.to_i, y: y.to_i
+    dom_node result['nodeId']
+  end
+
+  # @private Called by the Client constructor to set up unsupported DOM data.
+  def initialize_dom_unstable
+  end
+end  # module WebkitRemote::Client::Dom
+
+initializer :initialize_dom_unstable
+
+# Unstable cached information about a DOM node.
+class DomNode
+  # This node's box model information.
+  #
+  # @return [WebkitRemote::Client::BoxModel] the node's box model layout
+  def box_model
+    @box_model ||= box_model!
+  end
+
+  # Retrieves this node's box model, bypassing the cache.
+  #
+  # @return [WebkitRemote::Client::BoxModel] the node's box model layout
+  def box_model!
+    result = @client.rpc.call 'DOM.getBoxModel', nodeId: @remote_id
+    WebkitRemote::Client::DomBoxModel.new result['model']
+  end
+
+  # @private Called by the DomNode constructor.
+  def initialize_unstable
+    @box_model = nil
+  end
+  initializer :initialize_unstable
+end  # class WebkitRemote::Client::DomNode
+
+# Box model layout information for an element.
+class DomBoxModel
+  # @return [DomQuad] the margin's boundary
+  attr_reader :margin
+  # @return [DomQuad] the border's boundary
+  attr_reader :border
+  # @return [DomQuad] the padding's boundary
+  attr_reader :padding
+  # @return [DomQuad] the content's boundary
+  attr_reader :content
+
+  # @return [Number] the box's width
+  attr_reader :width
+  # @return [Number] the box's height
+  attr_reader :height
+
+  # Wraps raw box model data received via a RPC call.
+  #
+  # @param [Hash<Symbol, Object>] raw_box_model a BoxModel instance, according
+  #     to the Webkit remote debugging protocol; this is the return value of a
+  #     'DOM.getBoxModel' call
+  def initialize(raw_box_model)
+    @width = raw_box_model['width']
+    @height = raw_box_model['height']
+    @margin = WebkitRemote::Client::DomQuad.new raw_box_model['margin']
+    @border = WebkitRemote::Client::DomQuad.new raw_box_model['border']
+    @padding = WebkitRemote::Client::DomQuad.new raw_box_model['padding']
+    @content = WebkitRemote::Client::DomQuad.new raw_box_model['content']
+  end
+end  # class WebkitRemote::Client::DomBoxModel
+
+# Coordinates for 4 points that make up a box's boundary.
+class DomQuad
+  # @return [Array<Number>] x coordinates for the 4 points, in clockwise order
+  attr_reader :x
+
+  # @return [Array<Number>] y coordinates for the 4 points, in clockwise order
+  attr_reader :y
+
+  # Wraps raw box model data received via a RPC call.
+  #
+  # @param [Array<Number>] raw_quad a Quad instance, according to the Webkit
+  #     remote debugging protocol
+  def initialize(raw_quad)
+    @x = [raw_quad[0], raw_quad[2], raw_quad[4], raw_quad[6]].freeze
+    @y = [raw_quad[1], raw_quad[3], raw_quad[5], raw_quad[7]].freeze
+  end
+end  # class WebKitRemote::Client::DomQuad
+
+end  # namespace WebkitRemote::Client
+
+end  # namespace WebkitRemote

data/test/fixtures/html/dom.html

@@ -0,0 +1,26 @@
+<!doctype html>
+<html>
+  <head>
+    <title>WebkitRemote DOM test</title>
+    <style type="text/css">
+      #box_test {
+        margin: 1px 2px 3px 4px;
+        border: solid black;
+        border-top: 5px;
+        border-right: 6px;
+        border-bottom: 7px;
+        border-left: 8px;
+        padding: 9px 10px 11px 12px;
+        width: 67px;
+        height: 73px;
+
+        position: absolute;
+        left: 100px;
+        top: 100px;
+      }
+    </style>
+  </head>
+  <body>
+    <p id="box_test">Box model test</p>
+  </body>
+</html>

data/test/webkit_remote_unstable/dom_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../helper.rb', File.dirname(__FILE__))
+
+describe WebkitRemote::Client::Dom do
+  before :all do
+    @client = WebkitRemote.local port: 9669
+    @client.page_events = true
+    @client.navigate_to fixture_url(:dom)
+    @client.wait_for type: WebkitRemote::Event::PageLoaded
+  end
+  after :all do
+    @client.close
+  end
+
+  describe 'DomNode#box_model' do
+    before do
+      @node = @client.dom_root.query_selector '#box_test'
+      @box = @node.box_model
+    end
+
+    it 'has correct numbers' do
+      @box.width.must_equal 89
+      @box.height.must_equal 93
+      @box.margin.x.must_equal [100, 195, 195, 100]
+      @box.margin.y.must_equal [100, 100, 197, 197]
+      @box.border.x.must_equal [104, 193, 193, 104]
+      @box.border.y.must_equal [101, 101, 194, 194]
+      @box.padding.x.must_equal [104, 193, 193, 104]
+      @box.padding.y.must_equal [101, 101, 194, 194]
+      @box.content.x.must_equal [116, 183, 183, 116]
+      @box.content.y.must_equal [110, 110, 183, 183]
+    end
+  end
+
+  describe '#dom_node_at' do
+    before do
+      @node = @client.dom_root.query_selector '#box_test'
+    end
+
+    it 'identifies the test box correctly' do
+      node = @client.dom_node_at 150, 150
+      node.must_equal @node
+    end
+  end
+end

data/webkit_remote_unstable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "webkit_remote_unstable"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
-  s.date = "2014-03-18"
+  s.date = "2014-03-23"
   s.description = "Launches Google Chrome instances and controls them via the Remote Debugging server"
   s.email = "victor@costan.us"
   s.extra_rdoc_files = [
@@ -27,12 +27,15 @@ Gem::Specification.new do |s|
     "lib/webkit_remote_unstable.rb",
     "lib/webkit_remote_unstable/css.rb",
     "lib/webkit_remote_unstable/css_events.rb",
+    "lib/webkit_remote_unstable/dom.rb",
     "lib/webkit_remote_unstable/page.rb",
     "test/fixtures/config.ru",
     "test/fixtures/html/css.html",
+    "test/fixtures/html/dom.html",
     "test/fixtures/html/page.html",
     "test/helper.rb",
     "test/webkit_remote_unstable/css_test.rb",
+    "test/webkit_remote_unstable/dom_test.rb",
     "test/webkit_remote_unstable/page_test.rb",
     "webkit_remote_unstable.gemspec"
   ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webkit_remote_unstable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Victor Costan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-18 00:00:00.000000000 Z
+date: 2014-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webkit_remote
@@ -183,12 +183,15 @@ files:
 - lib/webkit_remote_unstable.rb
 - lib/webkit_remote_unstable/css.rb
 - lib/webkit_remote_unstable/css_events.rb
+- lib/webkit_remote_unstable/dom.rb
 - lib/webkit_remote_unstable/page.rb
 - test/fixtures/config.ru
 - test/fixtures/html/css.html
+- test/fixtures/html/dom.html
 - test/fixtures/html/page.html
 - test/helper.rb
 - test/webkit_remote_unstable/css_test.rb
+- test/webkit_remote_unstable/dom_test.rb
 - test/webkit_remote_unstable/page_test.rb
 - webkit_remote_unstable.gemspec
 homepage: http://github.com/pwnall/webkit_remote_unstable