puppeteer-ruby 0.28.1 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61aae6f779d8c0b4566cb9fd8966ba7d5941bda2b0c43754d61616dab29ca555
-  data.tar.gz: f5394e8ac944d188795e8a4eff87a60b2b226b659d8183ac1003d2d9f1c9c27b
+  metadata.gz: 2b852a48cd11f269c3b4eec0a85583b120a5cd1b0bc204e27a6ec0e365aa33dd
+  data.tar.gz: 8864c21fe02f6e3fcbb07c6c009516e91273ecfe0636437bc41015187e9985ad
 SHA512:
-  metadata.gz: e51fc1ffce61bf542d4057803ae3f2ac811285b54a221d4bc2ce6cfccc18e9de2828ba98de82d246efa7b1fdf58c44cce8e9205ac1343889f173462b8dd8f546
-  data.tar.gz: 4b5706d9f926372415acafa3c0d9339d653dd35542642a48593d400fd929ec03f1f32cd5624d99b0c1e870471f591c385b18b02b742d8b83d501fef599f64ffc
+  metadata.gz: dd3cdb6d7b64b0b6f6e2568eb83cad62f36ea45943f0df9cd434c6e30221ccd47b161a0368cbe02cacf4a6a3c6c6ecf293bd1313829d7f02daed5d1d2c5c9f73
+  data.tar.gz: 541c2dffa4c6359dff6c2d9d03e70a039057d554c1ee6509d0574d194f17a6407a968c30153bae850f8c4c0e9fa7ade7beaea2dcc8d136a896e80b22831a436f

data/.circleci/config.yml

@@ -26,7 +26,7 @@ jobs:
 
   rspec_chrome_ruby3_0:
     docker:
-      - image: circleci/ruby:3.0.0-rc1-buster-node-browsers
+      - image: circleci/ruby:3.0.0-buster-node-browsers
     <<: *rspec_chrome_job
 
   rspec_firefox:

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Request a new feature for playwright-ruby-client
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Simple description about the feature
+
+
+### Usecase / Motivation
+
+<!-- Describe why the feature helps. -->

data/.github/workflows/reviewdog.yml

@@ -12,4 +12,4 @@ jobs:
         with:
           github_token: ${{ secrets.github_token }}
           reporter: github-pr-review
-          rubocop_version: 1.8.0
+          rubocop_version: 1.10.0

data/CHANGELOG.md

@@ -1,7 +1,14 @@
-### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.28.1...master)]
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.29.0...master)]
 
 * xxx
 
+### 0.29.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.28.1...0.29.0)]
+
+New features:
+
+* Add `AriaQueryHandler`. Now we can use "aria/...." for selectors.
+
+
 ### 0.28.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.27...0.28.1)]
 
 New features:

data/README.md

@@ -1,15 +1,31 @@
 [![Gem Version](https://badge.fury.io/rb/puppeteer-ruby.svg)](https://badge.fury.io/rb/puppeteer-ruby)
 
-# Puppeteer in Ruby [UNDER HEAVY DEVELOPMENT]
+# Puppeteer in Ruby
 
 A Ruby port of [puppeteer](https://pptr.dev/).
 
 ![logo](puppeteer-ruby.png)
 
-REMARK: This Gem is NOT production-ready!!
+REMARK: This Gem covers just a part of Puppeteer APIs. Feedbacks and feature requests are welcome :)
 
 ## Getting Started
 
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puppeteer-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puppeteer-ruby
+
 ### Capture a site
 
 ```ruby

data/lib/puppeteer.rb

@@ -19,12 +19,14 @@ require 'puppeteer/event_callbackable'
 require 'puppeteer/if_present'
 
 # Classes & values.
+require 'puppeteer/aria_query_handler'
 require 'puppeteer/browser'
 require 'puppeteer/browser_context'
 require 'puppeteer/browser_runner'
 require 'puppeteer/cdp_session'
 require 'puppeteer/connection'
 require 'puppeteer/console_message'
+require 'puppeteer/custom_query_handler'
 require 'puppeteer/devices'
 require 'puppeteer/dialog'
 require 'puppeteer/dom_world'
@@ -41,6 +43,7 @@ require 'puppeteer/lifecycle_watcher'
 require 'puppeteer/mouse'
 require 'puppeteer/network_manager'
 require 'puppeteer/page'
+require 'puppeteer/query_handler_manager'
 require 'puppeteer/remote_object'
 require 'puppeteer/request'
 require 'puppeteer/response'

data/lib/puppeteer/aria_query_handler.rb

@@ -0,0 +1,71 @@
+class Puppeteer::AriaQueryHandler
+  private def normalize(value)
+    value.gsub(/ +/, ' ').strip
+  end
+
+  # @param selector [String]
+  private def parse_aria_selector(selector)
+    known_attributes = %w(name role)
+    query_options = {}
+    attribute_regexp = /\[\s*(?<attribute>\w+)\s*=\s*"(?<value>\\.|[^"\\]*)"\s*\]/
+    default_name = selector.gsub(attribute_regexp) do
+      attribute = $1.strip
+      value = $2
+      unless known_attributes.include?(attribute)
+        raise ArgumentError.new("Unkown aria attribute \"#{attribute}\" in selector")
+      end
+      query_options[attribute.to_sym] = normalize(value)
+      ''
+    end
+
+    if default_name.length > 0
+      query_options[:name] ||= normalize(default_name)
+    end
+
+    query_options
+  end
+
+  def query_one(element, selector)
+    context = element.execution_context
+    parse_result = parse_aria_selector(selector)
+    res = element.query_ax_tree(accessible_name: parse_result[:name], role: parse_result[:role])
+    if res.empty?
+      nil
+    else
+      context.adopt_backend_node_id(res.first['backendDOMNodeId'])
+    end
+  end
+
+  def wait_for(dom_world, selector, visible: nil, hidden: nil, timeout: nil)
+    binding_function = Puppeteer::DOMWorld::BindingFunction.new(
+      name: 'ariaQuerySelector',
+      proc: -> (selector) { query_one(dom_world.send(:document), selector) },
+    )
+    dom_world.send(:wait_for_selector_in_page,
+      '(_, selector) => globalThis.ariaQuerySelector(selector)',
+      selector,
+      visible: visible,
+      hidden: hidden,
+      timeout: timeout,
+      binding_function: binding_function)
+  end
+
+  def query_all(element, selector)
+    context = element.execution_context
+    parse_result = parse_aria_selector(selector)
+    res = element.query_ax_tree(accessible_name: parse_result[:name], role: parse_result[:role])
+    if res.empty?
+      nil
+    else
+      promises = res.map do |ax_node|
+        context.send(:async_adopt_backend_node_id, ax_node['backendDOMNodeId'])
+      end
+      await_all(*promises)
+    end
+  end
+
+  def query_all_array(element, selector)
+    element_handles = query_all(element, selector)
+    element.execution_context.evaluate_handle('(...elements) => elements', *element_handles)
+  end
+end

data/lib/puppeteer/custom_query_handler.rb

@@ -0,0 +1,51 @@
+class Puppeteer::CustomQueryHandler
+  # @param query_one [String] JS function (element: Element | Document, selector: string) => Element | null;
+  # @param query_all [String] JS function (element: Element | Document, selector: string) => Element[] | NodeListOf<Element>;
+  def initialize(query_one: nil, query_all: nil)
+    @query_one = query_one
+    @query_all = query_all
+  end
+
+  def query_one(element, selector)
+    unless @query_one
+      raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
+    end
+
+    handle = element.evaluate_handle(@query_one, selector)
+    element = handle.as_element
+
+    if element
+      return element
+    end
+    handle.dispose
+    nil
+  end
+
+  def wait_for(dom_world, selector, visible: nil, hidden: nil, timeout: nil)
+    unless @query_one
+      raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
+    end
+
+    dom_world.send(:wait_for_selector_in_page, @query_one, selector, visible: visible, hidden: hidden, timeout: timeout)
+  end
+
+  def query_all(element, selector)
+    unless @query_all
+      raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
+    end
+
+    handles = element.evaluate_handle(@query_all, selector)
+    properties = handles.properties
+    handles.dispose
+    properties.values.map(&:as_element).compact
+  end
+
+  def query_all_array(element, selector)
+    unless @query_all
+      raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
+    end
+
+    handles = element.evaluate_handle(@query_all, selector)
+    handles.evaluate_handle('(res) => Array.from(res)')
+  end
+end

data/lib/puppeteer/dom_world.rb

@@ -4,6 +4,47 @@ require 'thread'
 class Puppeteer::DOMWorld
   using Puppeteer::DefineAsyncMethod
 
+  class BindingFunction
+    def initialize(name:, proc:)
+      @name = name
+      @proc = proc
+    end
+
+    def call(*args)
+      @proc.call(*args)
+    end
+
+    attr_reader :name
+
+    def page_binding_init_string
+      <<~JAVASCRIPT
+      (type, bindingName) => {
+        /* Cast window to any here as we're about to add properties to it
+         * via win[bindingName] which TypeScript doesn't like.
+         */
+        const win = window;
+        const binding = win[bindingName];
+
+        win[bindingName] = (...args) => {
+          const me = window[bindingName];
+          let callbacks = me.callbacks;
+          if (!callbacks) {
+            callbacks = new Map();
+            me.callbacks = callbacks;
+          }
+          const seq = (me.lastSeq || 0) + 1;
+          me.lastSeq = seq;
+          const promise = new Promise((resolve, reject) =>
+            callbacks.set(seq, { resolve, reject })
+          );
+          binding(JSON.stringify({ type, name: bindingName, seq, args }));
+          return promise;
+        };
+      }
+      JAVASCRIPT
+    end
+  end
+
   # @param {!Puppeteer.FrameManager} frameManager
   # @param {!Puppeteer.Frame} frame
   # @param {!Puppeteer.TimeoutSettings} timeoutSettings
@@ -13,19 +54,29 @@ class Puppeteer::DOMWorld
     @timeout_settings = timeout_settings
     @context_promise = resolvable_future
     @wait_tasks = Set.new
+    @bound_functions = {}
+    @ctx_bindings = Set.new
     @detached = false
+
+    frame_manager.client.on_event('Runtime.bindingCalled', &method(:handle_binding_called))
   end
 
   attr_reader :frame
 
   # only used in Puppeteer::WaitTask#initialize
-  def _wait_tasks
+  private def _wait_tasks
     @wait_tasks
   end
 
+  # only used in Puppeteer::WaitTask#initialize
+  private def _bound_functions
+    @bound_functions
+  end
+
   # @param context [Puppeteer::ExecutionContext]
   def context=(context)
     if context
+      @ctx_bindings.clear
       unless @context_promise.resolved?
         @context_promise.fulfill(context)
       end
@@ -378,61 +429,127 @@ class Puppeteer::DOMWorld
   # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
   # @param timeout [Integer]
   def wait_for_selector(selector, visible: nil, hidden: nil, timeout: nil)
-    wait_for_selector_or_xpath(selector, false, visible: visible, hidden: hidden, timeout: timeout)
+    # call wait_for_selector_in_page with custom query selector.
+    query_selector_manager = Puppeteer::QueryHandlerManager.instance
+    query_selector_manager.detect_query_handler(selector).wait_for(self, visible: visible, hidden: hidden, timeout: timeout)
   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.
-  # @param timeout [Integer]
-  def wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil)
-    wait_for_selector_or_xpath(xpath, true, visible: visible, hidden: hidden, timeout: timeout)
+  private def binding_identifier(name, context)
+    "#{name}_#{context.send(:_context_id)}"
   end
 
-  # /**
-  #  * @param {Function|string} pageFunction
-  #  * @param {!{polling?: string|number, timeout?: number}=} options
-  #  * @return {!Promise<!Puppeteer.JSHandle>}
-  #  */
-  # waitForFunction(pageFunction, options = {}, ...args) {
-  #   const {
-  #     polling = 'raf',
-  #     timeout = this._timeoutSettings.timeout(),
-  #   } = options;
-  #   return new WaitTask(this, pageFunction, 'function', polling, timeout, ...args).promise;
-  # }
 
-  # @param page_function [String]
-  # @param args [Array]
-  # @param polling [Integer|String]
+  def add_binding_to_context(context, binding_function)
+    return if @ctx_bindings.include?(binding_identifier(binding_function.name, context))
+
+    expression = binding_function.page_binding_init_string
+    begin
+      context.client.send_message('Runtime.addBinding',
+        name: binding_function.name,
+        executionContextName: context.send(:_context_name))
+      context.evaluate(expression, 'internal', binding_function.name)
+    rescue => err
+      # We could have tried to evaluate in a context which was already
+      # destroyed. This happens, for example, if the page is navigated while
+      # we are trying to add the binding
+      allowed = [
+        'Execution context was destroyed',
+        'Cannot find context with specified id',
+      ]
+      if allowed.any? { |msg| err.message.include?(msg) }
+        # ignore
+      else
+        raise
+      end
+    end
+    @ctx_bindings << binding_identifier(binding_function.name, context)
+  end
+
+  private def handle_binding_called(event)
+    return unless has_context?
+    payload = JSON.parse(event['payload']) rescue nil
+    name = payload['name']
+    args = payload['args']
+
+    # The binding was either called by something in the page or it was
+    # called before our wrapper was initialized.
+    return unless payload
+    return unless payload['type'] == 'internal'
+    context = execution_context
+    return unless @ctx_bindings.include?(binding_identifier(name, context))
+    return unless context.send(:_context_id) == event['executionContextId']
+
+    result = @bound_functions[name].call(*args)
+    deliver_result_js = <<~JAVASCRIPT
+    (name, seq, result) => {
+      globalThis[name].callbacks.get(seq).resolve(result);
+      globalThis[name].callbacks.delete(seq);
+    }
+    JAVASCRIPT
+
+    begin
+      context.evaluate(deliver_result_js, name, payload['seq'], result)
+    rescue => err
+      # The WaitTask may already have been resolved by timing out, or the
+      # exection context may have been destroyed.
+      # In both caes, the promises above are rejected with a protocol error.
+      # We can safely ignores these, as the WaitTask is re-installed in
+      # the next execution context if needed.
+      return if err.message.include?('Protocol error')
+      raise
+    end
+  end
+
+  # @param query_one [String] JS function (element: Element | Document, selector: string) => Element | null;
+  # @param selector [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.
   # @param timeout [Integer]
-  # @return [Puppeteer::JSHandle]
-  def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
-    option_polling = polling || 'raf'
+  private def wait_for_selector_in_page(query_one, selector, visible: nil, hidden: nil, timeout: nil, binding_function: nil)
+    option_wait_for_visible = visible || false
+    option_wait_for_hidden = hidden || false
     option_timeout = timeout || @timeout_settings.timeout
 
-    Puppeteer::WaitTask.new(
+    polling =
+      if option_wait_for_visible || option_wait_for_hidden
+        'raf'
+      else
+        'mutation'
+      end
+    title = "selector #{selector}#{option_wait_for_hidden ? 'to be hidden' : ''}"
+
+    selector_predicate = make_predicate_string(
+      predicate_arg_def: '(selector, waitForVisible, waitForHidden)',
+      predicate_query_handler: query_one,
+      async: true,
+      predicate_body: <<~JAVASCRIPT
+        const node = await predicateQueryHandler(document, selector)
+        return checkWaitForOptions(node, waitForVisible, waitForHidden);
+      JAVASCRIPT
+    )
+
+    wait_task = Puppeteer::WaitTask.new(
       dom_world: self,
-      predicate_body: page_function,
-      title: 'function',
-      polling: option_polling,
+      predicate_body: selector_predicate,
+      title: title,
+      polling: polling,
       timeout: option_timeout,
-      args: args,
-    ).await_promise
-  end
-
-
-  # @return [String]
-  def title
-    evaluate('() => document.title')
+      args: [selector, option_wait_for_visible, option_wait_for_hidden],
+      binding_function: binding_function,
+    )
+    handle = wait_task.await_promise
+    unless handle.as_element
+      handle.dispose
+      return nil
+    end
+    handle.as_element
   end
 
-  # @param selector_or_xpath [String]
-  # @param is_xpath [Boolean]
+  # @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.
   # @param timeout [Integer]
-  private def wait_for_selector_or_xpath(selector_or_xpath, is_xpath, visible: nil, hidden: nil, timeout: nil)
+  def wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil)
     option_wait_for_visible = visible || false
     option_wait_for_hidden = hidden || false
     option_timeout = timeout || @timeout_settings.timeout
@@ -443,15 +560,23 @@ class Puppeteer::DOMWorld
       else
         'mutation'
       end
-    title = "#{is_xpath ? :XPath : :selector} #{selector_or_xpath}#{option_wait_for_hidden ? 'to be hidden' : ''}"
+    title = "XPath #{xpath}#{option_wait_for_hidden ? 'to be hidden' : ''}"
+
+    xpath_predicate = make_predicate_string(
+      predicate_arg_def: '(selector, waitForVisible, waitForHidden)',
+      predicate_body: <<~JAVASCRIPT
+        const node = document.evaluate(selector, document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
+        return checkWaitForOptions(node, waitForVisible, waitForHidden);
+      JAVASCRIPT
+    )
 
     wait_task = Puppeteer::WaitTask.new(
       dom_world: self,
-      predicate_body: PREDICATE,
+      predicate_body: xpath_predicate,
       title: title,
       polling: polling,
       timeout: option_timeout,
-      args: [selector_or_xpath, is_xpath, option_wait_for_visible, option_wait_for_hidden],
+      args: [xpath, option_wait_for_visible, option_wait_for_hidden],
     )
     handle = wait_task.await_promise
     unless handle.as_element
@@ -461,34 +586,66 @@ class Puppeteer::DOMWorld
     handle.as_element
   end
 
-  PREDICATE = <<~JAVASCRIPT
-  /**
-    * @param {string} selectorOrXPath
-    * @param {boolean} isXPath
-    * @param {boolean} waitForVisible
-    * @param {boolean} waitForHidden
-    * @return {?Node|boolean}
-    */
-  function _(selectorOrXPath, isXPath, waitForVisible, waitForHidden) {
-      const node = isXPath
-          ? document.evaluate(selectorOrXPath, document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue
-          : document.querySelector(selectorOrXPath);
-      if (!node)
-          return waitForHidden;
-      if (!waitForVisible && !waitForHidden)
-          return node;
-      const element = /** @type {Element} */ (node.nodeType === Node.TEXT_NODE ? node.parentElement : node);
-      const style = window.getComputedStyle(element);
-      const isVisible = style && style.visibility !== 'hidden' && hasVisibleBoundingBox();
-      const success = (waitForVisible === isVisible || waitForHidden === !isVisible);
-      return success ? node : null;
-      /**
-        * @return {boolean}
-        */
-      function hasVisibleBoundingBox() {
-          const rect = element.getBoundingClientRect();
-          return !!(rect.top || rect.bottom || rect.width || rect.height);
-      }
-  }
-  JAVASCRIPT
+  # @param page_function [String]
+  # @param args [Array]
+  # @param polling [Integer|String]
+  # @param timeout [Integer]
+  # @return [Puppeteer::JSHandle]
+  def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
+    option_polling = polling || 'raf'
+    option_timeout = timeout || @timeout_settings.timeout
+
+    Puppeteer::WaitTask.new(
+      dom_world: self,
+      predicate_body: page_function,
+      title: 'function',
+      polling: option_polling,
+      timeout: option_timeout,
+      args: args,
+    ).await_promise
+  end
+
+
+  # @return [String]
+  def title
+    evaluate('() => document.title')
+  end
+
+  private def make_predicate_string(predicate_arg_def:, predicate_body:, predicate_query_handler: nil, async: false)
+    predicate_query_handler_string =
+      if predicate_query_handler
+        "const predicateQueryHandler = #{predicate_query_handler}"
+      else
+        ""
+      end
+
+    <<~JAVASCRIPT
+    #{async ? 'async ' : ''}function _#{predicate_arg_def} {
+        #{predicate_query_handler_string}
+        #{predicate_body}
+
+        function checkWaitForOptions(node, waitForVisible, waitForHidden) {
+          if (!node) return waitForHidden;
+          if (!waitForVisible && !waitForHidden) return node;
+          const element =
+            node.nodeType === Node.TEXT_NODE ? node.parentElement : node;
+
+          const style = window.getComputedStyle(element);
+          const isVisible =
+            style && style.visibility !== 'hidden' && hasVisibleBoundingBox();
+          const success =
+            waitForVisible === isVisible || waitForHidden === !isVisible;
+          return success ? node : null;
+
+          /**
+          * @return {boolean}
+          */
+          function hasVisibleBoundingBox() {
+            const rect = element.getBoundingClientRect();
+            return !!(rect.top || rect.bottom || rect.width || rect.height);
+          }
+        }
+    }
+    JAVASCRIPT
+  end
 end

data/lib/puppeteer/element_handle.rb

@@ -314,32 +314,20 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     end
   end
 
+  private def query_handler_manager
+    Puppeteer::QueryHandlerManager.instance
+  end
+
   # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param selector [String]
   def S(selector)
-    handle = evaluate_handle(
-      '(element, selector) => element.querySelector(selector)',
-      selector,
-    )
-    element = handle.as_element
-
-    if element
-      return element
-    end
-    handle.dispose
-    nil
+    query_handler_manager.detect_query_handler(selector).query_one(self)
   end
 
   # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param selector [String]
   def SS(selector)
-    handles = evaluate_handle(
-      '(element, selector) => element.querySelectorAll(selector)',
-      selector,
-    )
-    properties = handles.properties
-    handles.dispose
-    properties.values.map(&:as_element).compact
+    query_handler_manager.detect_query_handler(selector).query_all(self)
   end
 
   class ElementNotFoundError < StandardError
@@ -370,10 +358,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   # @param page_function [String]
   # @return [Object]
   def SSeval(selector, page_function, *args)
-    handles = evaluate_handle(
-      '(element, selector) => Array.from(element.querySelectorAll(selector))',
-      selector,
-    )
+    handles = query_handler_manager.detect_query_handler(selector).query_all_array(self)
     result = handles.evaluate(page_function, *args)
     handles.dispose
 
@@ -430,4 +415,10 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     # https://en.wikipedia.org/wiki/Polygon#Simple_polygons
     quad.zip(quad.rotate).map { |p1, p2| (p1.x * p2.y - p2.x * p1.y) / 2 }.reduce(:+).abs
   end
+
+  # used in AriaQueryHandler
+  def query_ax_tree(accessible_name: nil, role: nil)
+    @remote_object.query_ax_tree(@client,
+    accessible_name: accessible_name, role: role)
+  end
 end

data/lib/puppeteer/execution_context.rb

@@ -12,10 +12,21 @@ class Puppeteer::ExecutionContext
     @client = client
     @world = world
     @context_id = context_payload['id']
+    @context_name = context_payload['name']
   end
 
   attr_reader :client, :world
 
+  # only used in DOMWorld
+  private def _context_id
+    @context_id
+  end
+
+  # only used in DOMWorld::BindingFunction#add_binding_to_context
+  private def _context_name
+    @context_name
+  end
+
   # @return [Puppeteer::Frame]
   def frame
     if_present(@world) do |world|
@@ -223,6 +234,7 @@ class Puppeteer::ExecutionContext
       remote_object: Puppeteer::RemoteObject.new(response["object"]),
     )
   end
+  private define_async_method :async_adopt_backend_node_id
 
   # @param element_handle [Puppeteer::ElementHandle]
   # @return [Puppeteer::ElementHandle]

data/lib/puppeteer/query_handler_manager.rb

@@ -0,0 +1,65 @@
+require 'singleton'
+
+class Puppeteer::QueryHandlerManager
+  include Singleton
+
+  def query_handlers
+    @query_handlers ||= {
+      aria: Puppeteer::AriaQueryHandler.new,
+    }
+  end
+
+  private def default_handler
+    @default_handler ||= Puppeteer::CustomQueryHandler.new(
+      query_one: '(element, selector) => element.querySelector(selector)',
+      query_all: '(element, selector) => element.querySelectorAll(selector)',
+    )
+  end
+
+  class Result
+    def initialize(query_handler:, selector:)
+      @query_handler = query_handler
+      @selector = selector
+    end
+
+    def query_one(element_handle)
+      @query_handler.query_one(element_handle, @selector)
+    end
+
+    def wait_for(dom_world, visible:, hidden:, timeout:)
+      @query_handler.wait_for(dom_world, @selector, visible: visible, hidden: hidden, timeout: timeout)
+    end
+
+    def query_all(element_handle)
+      @query_handler.query_all(element_handle, @selector)
+    end
+
+    def query_all_array(element_handle)
+      @query_handler.query_all_array(element_handle, @selector)
+    end
+  end
+
+  def detect_query_handler(selector)
+    unless /^[a-zA-Z]+\// =~ selector
+      return Result.new(
+        query_handler: default_handler,
+        selector: selector,
+      )
+    end
+
+    chunk = selector.split("/")
+    name = chunk.shift
+    updated_selector = chunk.join("/")
+
+    query_handler = query_handlers[name.to_sym]
+
+    unless query_handler
+      raise ArgumentError.new("Query set to use \"#{name}\", but no query handler of that name was found")
+    end
+
+    Result.new(
+      query_handler: query_handler,
+      selector: updated_selector,
+    )
+  end
+end

data/lib/puppeteer/remote_object.rb

@@ -97,6 +97,18 @@ class Puppeteer::RemoteObject
     nil
   end
 
+  # used in ElementHandle#query_ax_tree
+  def query_ax_tree(client, accessible_name: nil, role: nil)
+    result = client.send_message('Accessibility.queryAXTree', {
+      objectId: @object_id,
+      accessibleName: accessible_name,
+      role: role,
+    }.compact)
+
+    result['nodes'].reject do |node|
+      node['role']['value'] == 'text'
+    end
+  end
 
   # helper#valueFromRemoteObject
   def value

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 class Puppeteer
-  VERSION = '0.28.1'
+  VERSION = '0.29.0'
 end

data/lib/puppeteer/wait_task.rb

@@ -9,7 +9,7 @@ class Puppeteer::WaitTask
     end
   end
 
-  def initialize(dom_world:, predicate_body:, title:, polling:, timeout:, args: [])
+  def initialize(dom_world:, predicate_body:, title:, polling:, timeout:, args: [], binding_function: nil)
     if polling.is_a?(String)
       if polling != 'raf' && polling != 'mutation'
         raise ArgumentError.new("Unknown polling option: #{polling}")
@@ -27,8 +27,12 @@ class Puppeteer::WaitTask
     @timeout = timeout
     @predicate_body = "return (#{predicate_body})(...args);"
     @args = args
+    @binding_function = binding_function
     @run_count = 0
-    @dom_world._wait_tasks.add(self)
+    @dom_world.send(:_wait_tasks).add(self)
+    if binding_function
+      @dom_world.send(:_bound_functions)[binding_function.name] = binding_function
+    end
     @promise = resolvable_future
 
     # Since page navigation requires us to re-install the pageScript, we should track
@@ -53,8 +57,16 @@ class Puppeteer::WaitTask
 
   def rerun
     run_count = (@run_count += 1)
+    context = @dom_world.execution_context
+
+    return if @terminated || run_count != @run_count
+    if @binding_function
+      @dom_world.add_binding_to_context(context, @binding_function)
+    end
+    return if @terminated || run_count != @run_count
+
     begin
-      success = @dom_world.execution_context.evaluate_handle(
+      success = context.evaluate_handle(
         WAIT_FOR_PREDICATE_PAGE_FUNCTION,
         @predicate_body,
         @polling,
@@ -103,7 +115,7 @@ class Puppeteer::WaitTask
 
   private def cleanup
     @timeout_cleared = true
-    @dom_world._wait_tasks.delete(self)
+    @dom_world.send(:_wait_tasks).delete(self)
   end
 
   private define_async_method :async_rerun

data/puppeteer-ruby.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0.3'
   spec.add_development_dependency 'rspec', '~> 3.10.0 '
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
-  spec.add_development_dependency 'rubocop', '~> 1.8.0'
+  spec.add_development_dependency 'rubocop', '~> 1.10.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'webrick'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.28.1
+  version: 0.29.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -215,6 +215,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/stale.yml"
 - ".github/workflows/docs.yml"
 - ".github/workflows/reviewdog.yml"
@@ -231,6 +232,7 @@ files:
 - bin/setup
 - docker-compose.yml
 - lib/puppeteer.rb
+- lib/puppeteer/aria_query_handler.rb
 - lib/puppeteer/browser.rb
 - lib/puppeteer/browser_context.rb
 - lib/puppeteer/browser_fetcher.rb
@@ -239,6 +241,7 @@ files:
 - lib/puppeteer/concurrent_ruby_utils.rb
 - lib/puppeteer/connection.rb
 - lib/puppeteer/console_message.rb
+- lib/puppeteer/custom_query_handler.rb
 - lib/puppeteer/debug_print.rb
 - lib/puppeteer/define_async_method.rb
 - lib/puppeteer/device.rb
@@ -279,6 +282,7 @@ files:
 - lib/puppeteer/page/pdf_options.rb
 - lib/puppeteer/page/screenshot_options.rb
 - lib/puppeteer/page/screenshot_task_queue.rb
+- lib/puppeteer/query_handler_manager.rb
 - lib/puppeteer/remote_object.rb
 - lib/puppeteer/request.rb
 - lib/puppeteer/response.rb