puppeteer-ruby 0.0.13 → 0.0.18

data/lib/puppeteer/element_handle.rb

@@ -3,8 +3,9 @@ require_relative './element_handle/box_model'
 require_relative './element_handle/point'
 
 class Puppeteer::ElementHandle < Puppeteer::JSHandle
+  include Puppeteer::DebugPrint
   include Puppeteer::IfPresent
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param context [Puppeteer::ExecutionContext]
   # @param client [Puppeteer::CDPSession]
@@ -23,7 +24,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   end
 
   def content_frame
-    node_info = @remote_object.node_info
+    node_info = @remote_object.node_info(@client)
     frame_id = node_info['node']['frameId']
     if frame_id.is_a?(String)
       @frame_manager.frame(frame_id)
@@ -62,7 +63,14 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   end
 
   def clickable_point
-    result = @remote_object.content_quads(@client)
+    result =
+      begin
+        @remote_object.content_quads(@client)
+      rescue => err
+        debug_puts(err)
+        nil
+      end
+
     if !result || result["quads"].empty?
       raise ElementNotVisibleError.new
     end
@@ -105,11 +113,11 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     end
   end
 
-  #  async hover() {
-  #    await this._scrollIntoViewIfNeeded();
-  #    const {x, y} = await this._clickablePoint();
-  #    await this._page.mouse.move(x, y);
-  #  }
+  def hover
+    scroll_into_view_if_needed
+    point = clickable_point
+    @page.mouse.move(point.x, point.y)
+  end
 
   # @param delay [Number]
   # @param button [String] "left"|"right"|"middle"
@@ -120,12 +128,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     @page.mouse.click(point.x, point.y, delay: delay, button: button, click_count: click_count)
   end
 
-  # @param delay [Number]
-  # @param button [String] "left"|"right"|"middle"
-  # @param click_count [Number]
-  async def async_click(delay: nil, button: nil, click_count: nil)
-    click(delay: delay, button: button, click_count: click_count)
-  end
+  define_async_method :async_click
 
   # @return [Array<String>]
   def select(*values)
@@ -195,17 +198,13 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     @page.touchscreen.tap(point.x, point.y)
   end
 
-  async def async_tap
-    tap
-  end
+  define_async_method :async_tap
 
   def focus
     evaluate('element => element.focus()')
   end
 
-  async def async_focus
-    focus
-  end
+  define_async_method :async_focus
 
   # @param text [String]
   # @param delay [number|nil]
@@ -214,26 +213,17 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     @page.keyboard.type_text(text, delay: delay)
   end
 
-  # @param text [String]
-  # @param delay [number|nil]
-  # @return [Future]
-  async def async_type_text(text, delay: nil)
-    type_text(text, delay: delay)
-  end
+  define_async_method :async_type_text
 
   # @param key [String]
+  # @param text [String]
   # @param delay [number|nil]
-  def press(key, delay: nil)
+  def press(key, delay: nil, text: nil)
     focus
-    @page.keyboard.press(key, delay: delay)
+    @page.keyboard.press(key, delay: delay, text: text)
   end
 
-  # @param key [String]
-  # @param delay [number|nil]
-  # @return [Future]
-  async def async_press(key, delay: nil)
-    press(key, delay: delay)
-  end
+  define_async_method :async_press
 
   # @return [BoundingBox|nil]
   def bounding_box
@@ -356,13 +346,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     result
   end
 
-  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param selector [String]
-  # @param page_function [String]
-  # @return [Object]
-  async def async_Seval(selector, page_function, *args)
-    Seval(selector, page_function, *args)
-  end
+  define_async_method :async_Seval
 
   # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param selector [String]
@@ -379,13 +363,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     result
   end
 
-  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param selector [String]
-  # @param page_function [String]
-  # @return [Object]
-  async def async_SSeval(selector, page_function, *args)
-    SSeval(selector, page_function, *args)
-  end
+  define_async_method :async_SSeval
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param expression [String]
@@ -408,21 +386,26 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     properties.values.map(&:as_element).compact
   end
 
-  #  /**
-  #   * @returns {!Promise<boolean>}
-  #   */
-  #  isIntersectingViewport() {
-  #    return this.evaluate(async element => {
-  #      const visibleRatio = await new Promise(resolve => {
-  #        const observer = new IntersectionObserver(entries => {
-  #          resolve(entries[0].intersectionRatio);
-  #          observer.disconnect();
-  #        });
-  #        observer.observe(element);
-  #      });
-  #      return visibleRatio > 0;
-  #    });
-  #  }
+  define_async_method :async_Sx
+
+  # in JS, #isIntersectingViewport.
+  # @return [Boolean]
+  def intersecting_viewport?
+    js = <<~JAVASCRIPT
+    async element => {
+      const visibleRatio = await new Promise(resolve => {
+        const observer = new IntersectionObserver(entries => {
+          resolve(entries[0].intersectionRatio);
+          observer.disconnect();
+        });
+        observer.observe(element);
+      });
+      return visibleRatio > 0;
+    }
+    JAVASCRIPT
+
+    evaluate(js)
+  end
 
   # @param quad [Array<Point>]
   private def compute_quad_area(quad)

data/lib/puppeteer/emulation_manager.rb

@@ -1,5 +1,5 @@
 class Puppeteer::EmulationManager
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.CDPSession} client
   def initialize(client)
@@ -38,9 +38,5 @@ class Puppeteer::EmulationManager
     reload_needed
   end
 
-  # @param viewport [Puppeteer::Viewport]
-  # @return [Future<true|false>]
-  async def async_emulate_viewport(viewport)
-    emulate_viewport(viewport)
-  end
+  define_async_method :async_emulate_viewport
 end

data/lib/puppeteer/env.rb

@@ -0,0 +1,18 @@
+class Puppeteer::Env
+  # indicates whether DEBUG=1 is specified.
+  #
+  # @return [Boolean]
+  def debug?
+    ['1', 'true'].include?(ENV['DEBUG'].to_s)
+  end
+
+  def ci?
+    ['1', 'true'].include?(ENV['CI'].to_s)
+  end
+end
+
+class Puppeteer
+  def self.env
+    Puppeteer::Env.new
+  end
+end

data/lib/puppeteer/execution_context.rb

@@ -1,6 +1,6 @@
 class Puppeteer::ExecutionContext
   include Puppeteer::IfPresent
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   EVALUATION_SCRIPT_URL = '__puppeteer_evaluation_script__'
   SOURCE_URL_REGEX = /^[\040\t]*\/\/[@#] sourceURL=\s*(\S*?)\s*$/m
@@ -16,11 +16,6 @@ class Puppeteer::ExecutionContext
 
   attr_reader :client, :world
 
-  # only used in DomWorld#delete_context
-  def _context_id
-    @context_id
-  end
-
   # @return [Puppeteer::Frame]
   def frame
     if_present(@world) do |world|

data/lib/puppeteer/frame.rb

@@ -1,5 +1,5 @@
 class Puppeteer::Frame
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!FrameManager} frameManager
   # @param {!Puppeteer.CDPSession} client
@@ -39,12 +39,7 @@ class Puppeteer::Frame
     @frame_manager.wait_for_frame_navigation(self, timeout: timeout, wait_until: wait_until)
   end
 
-  # @param timeout [number|nil]
-  # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
-  # @return [Future]
-  async def async_wait_for_navigation(timeout: nil, wait_until: nil)
-    wait_for_navigation(timeout: timeout, wait_until: wait_until)
-  end
+  define_async_method :async_wait_for_navigation
 
   def execution_context
     @main_world.execution_context
@@ -56,12 +51,16 @@ class Puppeteer::Frame
     @main_world.evaluate_handle(page_function, *args)
   end
 
+  define_async_method :async_evaluate_handle
+
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
   def evaluate(page_function, *args)
     @main_world.evaluate(page_function, *args)
   end
 
+  define_async_method :async_evaluate
+
   # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
   # @return {!Promise<?Puppeteer.ElementHandle>}
@@ -69,6 +68,7 @@ class Puppeteer::Frame
     @main_world.S(selector)
   end
 
+  define_async_method :async_S
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} expression
@@ -77,6 +77,7 @@ class Puppeteer::Frame
     @main_world.Sx(expression)
   end
 
+  define_async_method :async_Sx
 
   # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
@@ -87,6 +88,8 @@ class Puppeteer::Frame
     @main_world.Seval(selector, page_function, *args)
   end
 
+  define_async_method :async_Seval
+
   # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
   # @param {Function|string} pageFunction
@@ -96,6 +99,8 @@ class Puppeteer::Frame
     @main_world.SSeval(selector, page_function, *args)
   end
 
+  define_async_method :async_SSeval
+
   # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
@@ -103,12 +108,16 @@ class Puppeteer::Frame
     @main_world.SS(selector)
   end
 
+  define_async_method :async_SS
+
+  # @return [String]
   def content
     @secondary_world.content
   end
 
-  # @param {string} html
-  # @param {!{timeout?: number, waitUntil?: string|!Array<string>}=} options
+  # @param html [String]
+  # @param timeout [Integer]
+  # @param wait_until [String|Array<String>]
   def set_content(html, timeout: nil, wait_until: nil)
     @secondary_world.set_content(html, timeout: timeout, wait_until: wait_until)
   end
@@ -133,7 +142,7 @@ class Puppeteer::Frame
   end
 
   def child_frames
-    @child_frames.dup
+    @child_frames.to_a
   end
 
   def detached?
@@ -152,15 +161,6 @@ class Puppeteer::Frame
     @main_world.add_style_tag(style_tag)
   end
 
-  # @param selector [String]
-  # @param delay [Number]
-  # @param button [String] "left"|"right"|"middle"
-  # @param click_count [Number]
-  # @return [Future]
-  async def async_click(selector, delay: nil, button: nil, click_count: nil)
-    click(selector, delay: delay, button: button, click_count: click_count)
-  end
-
   # @param selector [String]
   # @param delay [Number]
   # @param button [String] "left"|"right"|"middle"
@@ -169,11 +169,15 @@ class Puppeteer::Frame
     @secondary_world.click(selector, delay: delay, button: button, click_count: click_count)
   end
 
+  define_async_method :async_click
+
   # @param {string} selector
   def focus(selector)
     @secondary_world.focus(selector)
   end
 
+  define_async_method :async_focus
+
   # @param {string} selector
   def hover(selector)
     @secondary_world.hover(selector)
@@ -186,11 +190,15 @@ class Puppeteer::Frame
     @secondary_world.select(selector, *values)
   end
 
+  define_async_method :async_select
+
   # @param {string} selector
   def tap(selector)
     @secondary_world.tap(selector)
   end
 
+  define_async_method :async_tap
+
   # @param selector [String]
   # @param text [String]
   # @param delay [Number]
@@ -198,27 +206,7 @@ class Puppeteer::Frame
     @main_world.type_text(selector, text, delay: delay)
   end
 
-  # /**
-  #  * @param {(string|number|Function)} selectorOrFunctionOrTimeout
-  #  * @param {!Object=} options
-  #  * @param {!Array<*>} args
-  #  * @return {!Promise<?Puppeteer.JSHandle>}
-  #  */
-  # waitFor(selectorOrFunctionOrTimeout, options = {}, ...args) {
-  #   const xPathPattern = '//';
-
-  #   if (helper.isString(selectorOrFunctionOrTimeout)) {
-  #     const string = /** @type {string} */ (selectorOrFunctionOrTimeout);
-  #     if (string.startsWith(xPathPattern))
-  #       return this.waitForXPath(string, options);
-  #     return this.waitForSelector(string, options);
-  #   }
-  #   if (helper.isNumber(selectorOrFunctionOrTimeout))
-  #     return new Promise(fulfill => setTimeout(fulfill, /** @type {number} */ (selectorOrFunctionOrTimeout)));
-  #   if (typeof selectorOrFunctionOrTimeout === 'function')
-  #     return this.waitForFunction(selectorOrFunctionOrTimeout, options, ...args);
-  #   return Promise.reject(new Error('Unsupported target type: ' + (typeof selectorOrFunctionOrTimeout)));
-  # }
+  define_async_method :async_type_text
 
   # @param selector [String]
   # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
@@ -235,6 +223,13 @@ class Puppeteer::Frame
     result
   end
 
+  define_async_method :async_wait_for_selector
+
+  # @param milliseconds [Integer] the number of milliseconds to wait.
+  def wait_for_timeout(milliseconds)
+    sleep(milliseconds / 1000.0)
+  end
+
   # @param xpath [String]
   # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
   # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
@@ -250,14 +245,19 @@ class Puppeteer::Frame
     result
   end
 
-  # @param {Function|string} pageFunction
-  # @param {!{polling?: string|number, timeout?: number}=} options
-  # @param {!Array<*>} args
-  # @return {!Promise<!Puppeteer.JSHandle>}
-  def wait_for_function(page_function, options = {}, *args)
-    @main_world.wait_for_function(page_function, options, *args)
+  define_async_method :async_wait_for_xpath
+
+  # @param page_function [String]
+  # @param args [Integer|Array]
+  # @param polling [String]
+  # @param timeout [Integer]
+  # @return [Puppeteer::JSHandle]
+  def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
+    @main_world.wait_for_function(page_function, args: args, polling: polling, timeout: timeout)
   end
 
+  define_async_method :async_wait_for_function
+
   # @return [String]
   def title
     @secondary_world.title