puppeteer-ruby 0.0.9 → 0.0.10

data/docs/top-level-namespace.html

@@ -116,7 +116,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Jun  9 00:13:39 2020 by
+  Generated on Fri Jun 12 12:38:32 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.24 (ruby-2.6.3).
 </div>

data/lib/puppeteer/browser.rb

@@ -119,7 +119,7 @@ class Puppeteer::Browser
     target = @targets[target_id]
     target.ignore_initialize_callback_promise
     @targets.delete(target_id)
-    target.handle_closed
+    target.closed_callback
     if await target.initialized_promise
       emit_event 'Events.Browser.TargetDestroyed', target
       target.browser_context.emit_event 'Events.BrowserContext.TargetDestroyed', target

data/lib/puppeteer/element_handle.rb

@@ -1,4 +1,6 @@
-require 'mime/types'
+require_relative './element_handle/bounding_box'
+require_relative './element_handle/box_model'
+require_relative './element_handle/point'
 
 class Puppeteer::ElementHandle < Puppeteer::JSHandle
   include Puppeteer::IfPresent
@@ -53,29 +55,6 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     sleep 0.16
   end
 
-  class Point
-    def initialize(x:, y:)
-      @x = x
-      @y = y
-    end
-
-    def +(other)
-      Point.new(
-        x: @x + other.x,
-        y: @y + other.y,
-      )
-    end
-
-    def /(num)
-      Point.new(
-        x: @x / num,
-        y: @y / num,
-      )
-    end
-
-    attr_reader :x, :y
-  end
-
   class ElementNotVisibleError < StandardError
     def initialize
       super("Node is either not visible or not an HTMLElement")
@@ -105,15 +84,6 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     quads.first.reduce(:+) / 4
   end
 
-  #  /**
-  #   * @return {!Promise<void|Protocol.DOM.getBoxModelReturnValue>}
-  #   */
-  #  _getBoxModel() {
-  #    return this._client.send('DOM.getBoxModel', {
-  #      objectId: this._remoteObject.objectId
-  #    }).catch(error => debugError(error));
-  #  }
-
   # @param quad [Array<number>]
   # @return [Array<Point>]
   private def from_protocol_quad(quad)
@@ -265,89 +235,77 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     press(key, delay: delay)
   end
 
-  #  /**
-  #   * @return {!Promise<?{x: number, y: number, width: number, height: number}>}
-  #   */
-  #  async boundingBox() {
-  #    const result = await this._getBoxModel();
-
-  #    if (!result)
-  #      return null;
-
-  #    const quad = result.model.border;
-  #    const x = Math.min(quad[0], quad[2], quad[4], quad[6]);
-  #    const y = Math.min(quad[1], quad[3], quad[5], quad[7]);
-  #    const width = Math.max(quad[0], quad[2], quad[4], quad[6]) - x;
-  #    const height = Math.max(quad[1], quad[3], quad[5], quad[7]) - y;
-
-  #    return {x, y, width, height};
-  #  }
-
-  #  /**
-  #   * @return {!Promise<?BoxModel>}
-  #   */
-  #  async boxModel() {
-  #    const result = await this._getBoxModel();
-
-  #    if (!result)
-  #      return null;
-
-  #    const {content, padding, border, margin, width, height} = result.model;
-  #    return {
-  #      content: this._fromProtocolQuad(content),
-  #      padding: this._fromProtocolQuad(padding),
-  #      border: this._fromProtocolQuad(border),
-  #      margin: this._fromProtocolQuad(margin),
-  #      width,
-  #      height
-  #    };
-  #  }
-
-  #  /**
-  #   *
-  #   * @param {!Object=} options
-  #   * @returns {!Promise<string|!Buffer>}
-  #   */
-  #  async screenshot(options = {}) {
-  #    let needsViewportReset = false;
-
-  #    let boundingBox = await this.boundingBox();
-  #    assert(boundingBox, 'Node is either not visible or not an HTMLElement');
-
-  #    const viewport = this._page.viewport();
-
-  #    if (viewport && (boundingBox.width > viewport.width || boundingBox.height > viewport.height)) {
-  #      const newViewport = {
-  #        width: Math.max(viewport.width, Math.ceil(boundingBox.width)),
-  #        height: Math.max(viewport.height, Math.ceil(boundingBox.height)),
-  #      };
-  #      await this._page.setViewport(Object.assign({}, viewport, newViewport));
+  # @return [BoundingBox|nil]
+  def bounding_box
+    if_present(box_model) do |result_model|
+      quads = result_model.border
+
+      x = quads.map(&:x).min
+      y = quads.map(&:y).min
+      BoundingBox.new(
+        x: x,
+        y: y,
+        width: quads.map(&:x).max - x,
+        height: quads.map(&:y).max - y,
+      )
+    end
+  end
 
-  #      needsViewportReset = true;
-  #    }
+  # @return [BoxModel|nil]
+  def box_model
+    if_present(@remote_object.box_model(@client)) do |result|
+      BoxModel.new(result['model'])
+    end
+  end
 
-  #    await this._scrollIntoViewIfNeeded();
+  def screenshot(options = {})
+    needs_viewport_reset = false
 
-  #    boundingBox = await this.boundingBox();
-  #    assert(boundingBox, 'Node is either not visible or not an HTMLElement');
-  #    assert(boundingBox.width !== 0, 'Node has 0 width.');
-  #    assert(boundingBox.height !== 0, 'Node has 0 height.');
+    box = bounding_box
+    unless box
+      raise ElementNotVisibleError.new
+    end
 
-  #    const { layoutViewport: { pageX, pageY } } = await this._client.send('Page.getLayoutMetrics');
+    viewport = @page.viewport
+    if viewport && (box.width > viewport.width || box.height > viewport.height)
+      new_viewport = viewport.merge(
+        width: [viewport.width, box.width.to_i].min,
+        height: [viewport.height, box.height.to_i].min,
+      )
+      @page.viewport = new_viewport
 
-  #    const clip = Object.assign({}, boundingBox);
-  #    clip.x += pageX;
-  #    clip.y += pageY;
+      needs_viewport_reset = true
+    end
+    scroll_into_view_if_needed
 
-  #    const imageData = await this._page.screenshot(Object.assign({}, {
-  #      clip
-  #    }, options));
+    box = bounding_box
+    unless box
+      raise ElementNotVisibleError.new
+    end
+    if box.width == 0
+      raise 'Node has 0 width.'
+    end
+    if box.height == 0
+      raise 'Node has 0 height.'
+    end
 
-  #    if (needsViewportReset)
-  #      await this._page.setViewport(viewport);
+    layout_metrics = @client.send_message('Page.getLayoutMetrics')
+    page_x = layout_metrics["layoutViewport"]["pageX"]
+    page_y = layout_metrics["layoutViewport"]["pageY"]
+
+    clip = {
+      x: page_x + box.x,
+      y: page_y + box.y,
+      width: box.width,
+      height: box.height,
+    }
 
-  #    return imageData;
-  #  }
+    @page.screenshot({ clip: clip }.merge(options))
+  ensure
+    if needs_viewport_reset
+      @page.viewport = viewport
+    end
+  end
 
   # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param selector [String]

data/lib/puppeteer/element_handle/bounding_box.rb

@@ -0,0 +1,12 @@
+class Puppeteer::ElementHandle < Puppeteer::JSHandle
+  class BoundingBox
+    def initialize(x:, y:, width:, height:)
+      @x = x
+      @y = y
+      @width = width
+      @height = height
+    end
+
+    attr_reader :x, :y, :width, :height
+  end
+end

data/lib/puppeteer/element_handle/box_model.rb

@@ -0,0 +1,19 @@
+class Puppeteer::ElementHandle < Puppeteer::JSHandle
+  class BoxModel
+    QUAD_ATTRIBUTE_NAMES = %i(content padding border margin)
+    # @param result [Hash]
+    def initialize(result_model)
+      QUAD_ATTRIBUTE_NAMES.each do |attr_name|
+        quad = result_model[attr_name.to_s]
+        instance_variable_set(
+          :"@#{attr_name}",
+          quad.each_slice(2).map { |x, y| Point.new(x: x, y: y) },
+        )
+      end
+      @width = result_model['width']
+      @height = result_model['height']
+    end
+    attr_reader(*QUAD_ATTRIBUTE_NAMES)
+    attr_reader :width, :height
+  end
+end

data/lib/puppeteer/element_handle/point.rb

@@ -0,0 +1,26 @@
+class Puppeteer::ElementHandle < Puppeteer::JSHandle
+  # A class to represent (x, y)-coordinates
+  # supporting + and / operators.
+  class Point
+    def initialize(x:, y:)
+      @x = x
+      @y = y
+    end
+
+    def +(other)
+      Point.new(
+        x: @x + other.x,
+        y: @y + other.y,
+      )
+    end
+
+    def /(num)
+      Point.new(
+        x: @x / num,
+        y: @y / num,
+      )
+    end
+
+    attr_reader :x, :y
+  end
+end

data/lib/puppeteer/errors.rb

@@ -1,4 +1,2 @@
-# ref: https://github.com/puppeteer/puppeteer/blob/master/lib/Errors.js
+# ref: https://github.com/puppeteer/puppeteer/blob/master/src/Errors.ts
 class Puppeteer::TimeoutError < StandardError; end
-
-class Puppeteer::WebSocktTransportError < StandardError; end

data/lib/puppeteer/page.rb

@@ -109,7 +109,7 @@ class Puppeteer::Page
     @client.on_event 'Page.fileChooserOpened' do |event|
       handle_file_chooser(event)
     end
-    @target.on_close do
+    @target.is_closed_promise.then do
       emit_event 'Events.Page.Close'
       @closed = true
     end

data/lib/puppeteer/remote_object.rb

@@ -62,6 +62,15 @@ class Puppeteer::RemoteObject
     client.send_message('DOM.getContentQuads', objectId: @object_id)
   end
 
+  # used in ElementHandle#_box_model
+  def box_model(client)
+    client.send_message('DOM.getBoxModel', objectId: @object_id)
+  rescue => err
+    debug_puts(err)
+    nil
+  end
+
+
   # helper#valueFromRemoteObject
   def value
     if @unserializable_value

data/lib/puppeteer/target.rb

@@ -37,7 +37,7 @@ class Puppeteer::Target
     @initialized_promise = @initialize_callback_promise.then do |success|
       handle_initialized(success)
     end
-    #    this._isClosedPromise = new Promise(fulfill => this._closedCallback = fulfill);
+    @is_closed_promise = resolvable_future
 
     @is_initialized = @target_info.type != 'page' || !@target_info.url.empty?
 
@@ -46,12 +46,18 @@ class Puppeteer::Target
     end
   end
 
-  attr_reader :target_id, :initialized_promise
+  attr_reader :target_id, :initialized_promise, :is_closed_promise
+
+  def closed_callback
+    @is_closed_promise.fulfill(true)
+  end
 
   class InitializeFailure < StandardError; end
 
   def ignore_initialize_callback_promise
-    @initialize_callback_promise.fulfill(false)
+    unless @initialize_callback_promise.fulfilled?
+      @initialize_callback_promise.fulfill(false)
+    end
   end
 
   private def handle_initialized(success)
@@ -70,15 +76,6 @@ class Puppeteer::Target
     true
   end
 
-  def handle_closed
-    @closed = true
-    @on_close&.call
-  end
-
-  def on_close(&block)
-    @on_close = block
-  end
-
   def initialized?
     @is_initialized
   end

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 class Puppeteer
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'
 end

data/lib/puppeteer/viewport.rb

@@ -33,4 +33,22 @@ class Puppeteer::Viewport
   def landscape?
     @is_landscape
   end
+
+  def merge(
+        width: nil,
+        height: nil,
+        device_scale_factor: nil,
+        is_mobile: nil,
+        has_touch: nil,
+        is_landscape: nil)
+
+    Puppeteer::Viewport.new(
+      width: width || @width,
+      height: height || @height,
+      device_scale_factor: device_scale_factor || @device_scale_factor,
+      is_mobile: is_mobile.nil? ? @is_mobile : is_mobile,
+      has_touch: has_touch.nil? ? @has_touch : has_touch,
+      is_landscape: is_landscape.nil? ? @is_landscape : is_landscape,
+    )
+  end
 end

data/lib/puppeteer/web_socket.rb

@@ -43,6 +43,8 @@ class Puppeteer::WebSocket
     end
   end
 
+  class TransportError < StandardError; end
+
   private def setup
     @ready_state = STATE_CONNECTING
     @driver.on(:open) do
@@ -55,7 +57,7 @@ class Puppeteer::WebSocket
     end
     @driver.on(:error) do |event|
       if !handle_on_error(error_message: event.message)
-        raise Puppeteer::WebSocktTransportError.new(event.message)
+        raise TransportError.new(event.message)
       end
     end
     @driver.on(:message) do |event|

data/lib/puppeteer/web_socket_transport.rb

@@ -11,7 +11,7 @@ class Puppeteer::WebSocketTransport
       promise.fulfill(Puppeteer::WebSocketTransport.new(ws))
     end
     ws.on_error do |error_message|
-      promise.reject(Puppeteer::WebSocktTransportError.new(error_message))
+      promise.reject(Puppeteer::WebSocket::TransportError.new(error_message))
     end
     promise.value!
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -294,6 +294,9 @@ files:
 - lib/puppeteer/devices.rb
 - lib/puppeteer/dom_world.rb
 - lib/puppeteer/element_handle.rb
+- lib/puppeteer/element_handle/bounding_box.rb
+- lib/puppeteer/element_handle/box_model.rb
+- lib/puppeteer/element_handle/point.rb
 - lib/puppeteer/emulation_manager.rb
 - lib/puppeteer/errors.rb
 - lib/puppeteer/event_callbackable.rb