puppeteer-ruby 0.28.1 → 0.31.3

data/lib/puppeteer/puppeteer.rb

@@ -0,0 +1,164 @@
+class Puppeteer::Puppeteer
+  # @param project_root [String]
+  # @param prefereed_revision [String]
+  # @param is_puppeteer_core [String]
+  def initialize(project_root:, preferred_revision:, is_puppeteer_core:)
+    @project_root = project_root
+    @preferred_revision = preferred_revision
+    @is_puppeteer_core = is_puppeteer_core
+  end
+
+  # @param product [String]
+  # @param executable_path [String]
+  # @param ignore_default_args [Array<String>|nil]
+  # @param handle_SIGINT [Boolean]
+  # @param handle_SIGTERM [Boolean]
+  # @param handle_SIGHUP [Boolean]
+  # @param timeout [Integer]
+  # @param dumpio [Boolean]
+  # @param env [Hash]
+  # @param pipe [Boolean]
+  # @param args [Array<String>]
+  # @param user_data_dir [String]
+  # @param devtools [Boolean]
+  # @param headless [Boolean]
+  # @param ignore_https_errors [Boolean]
+  # @param default_viewport [Puppeteer::Viewport|nil]
+  # @param slow_mo [Integer]
+  # @return [Puppeteer::Browser]
+  def launch(
+    product: nil,
+    executable_path: nil,
+    ignore_default_args: nil,
+    handle_SIGINT: nil,
+    handle_SIGTERM: nil,
+    handle_SIGHUP: nil,
+    timeout: nil,
+    dumpio: nil,
+    env: nil,
+    pipe: nil,
+    args: nil,
+    user_data_dir: nil,
+    devtools: nil,
+    headless: nil,
+    ignore_https_errors: nil,
+    default_viewport: nil,
+    slow_mo: nil
+  )
+    options = {
+      executable_path: executable_path,
+      ignore_default_args: ignore_default_args,
+      handle_SIGINT: handle_SIGINT,
+      handle_SIGTERM: handle_SIGTERM,
+      handle_SIGHUP: handle_SIGHUP,
+      timeout: timeout,
+      dumpio: dumpio,
+      env: env,
+      pipe: pipe,
+      args: args,
+      user_data_dir: user_data_dir,
+      devtools: devtools,
+      headless: headless,
+      ignore_https_errors: ignore_https_errors,
+      default_viewport: default_viewport,
+      slow_mo: slow_mo,
+    }
+
+    @product_name ||= product
+    browser = launcher.launch(options)
+    if block_given?
+      begin
+        yield(browser)
+      ensure
+        browser.close
+      end
+    else
+      browser
+    end
+  end
+
+  # @param browser_ws_endpoint [String]
+  # @param browser_url [String]
+  # @param transport [Puppeteer::WebSocketTransport]
+  # @param ignore_https_errors [Boolean]
+  # @param default_viewport [Puppeteer::Viewport|nil]
+  # @param slow_mo [Integer]
+  # @return [Puppeteer::Browser]
+  def connect(
+    browser_ws_endpoint: nil,
+    browser_url: nil,
+    transport: nil,
+    ignore_https_errors: nil,
+    default_viewport: nil,
+    slow_mo: nil
+  )
+    options = {
+      browser_ws_endpoint: browser_ws_endpoint,
+      browser_url: browser_url,
+      transport: transport,
+      ignore_https_errors: ignore_https_errors,
+      default_viewport: default_viewport,
+      slow_mo: slow_mo,
+    }.compact
+    browser = launcher.connect(options)
+    if block_given?
+      begin
+        yield(browser)
+      ensure
+        browser.disconnect
+      end
+    else
+      browser
+    end
+  end
+
+  # @return [String]
+  def executable_path
+    launcher.executable_path
+  end
+
+  private def launcher
+    @launcher ||= Puppeteer::Launcher.new(
+      project_root: @project_root,
+      preferred_revision: @preferred_revision,
+      is_puppeteer_core: @is_puppeteer_core,
+      product: @product_name,
+    )
+  end
+
+  # @return [String]
+  def product
+    launcher.product
+  end
+
+  # @return [Puppeteer::Devices]
+  def devices
+    Puppeteer::Devices
+  end
+
+  # # @return {Object}
+  # def errors
+  #   # ???
+  # end
+
+  # @param args [Array<String>]
+  # @param user_data_dir [String]
+  # @param devtools [Boolean]
+  # @param headless [Boolean]
+  # @return [Array<String>]
+  def default_args(args: nil, user_data_dir: nil, devtools: nil, headless: nil)
+    options = {
+      args: args,
+      user_data_dir: user_data_dir,
+      devtools: devtools,
+      headless: headless,
+    }.compact
+    launcher.default_args(options)
+  end
+
+  # @param {!BrowserFetcher.Options=} options
+  # @return {!BrowserFetcher}
+  def createBrowserFetcher(options = {})
+    BrowserFetcher.new(@project_root, options)
+  end
+end

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'
+module Puppeteer
+  VERSION = '0.31.3'
 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
@@ -123,18 +135,17 @@ class Puppeteer::WaitTask
       /**
        * @return {!Promise<*>}
        */
-      function pollMutation() {
-          const success = predicate(...args);
-          if (success)
-              return Promise.resolve(success);
+      async function pollMutation() {
+          const success = await predicate(...args);
+          if (success) return Promise.resolve(success);
           let fulfill;
           const result = new Promise((x) => (fulfill = x));
-          const observer = new MutationObserver(() => {
+          const observer = new MutationObserver(async () => {
               if (timedOut) {
                   observer.disconnect();
                   fulfill();
               }
-              const success = predicate(...args);
+              const success = await predicate(...args);
               if (success) {
                   observer.disconnect();
                   fulfill(success);
@@ -147,38 +158,34 @@ class Puppeteer::WaitTask
           });
           return result;
       }
-      function pollRaf() {
+      async function pollRaf() {
           let fulfill;
           const result = new Promise((x) => (fulfill = x));
-          onRaf();
+          await onRaf();
           return result;
-          function onRaf() {
+          async function onRaf() {
               if (timedOut) {
                   fulfill();
                   return;
               }
-              const success = predicate(...args);
-              if (success)
-                  fulfill(success);
-              else
-                  requestAnimationFrame(onRaf);
+              const success = await predicate(...args);
+              if (success) fulfill(success);
+              else requestAnimationFrame(onRaf);
           }
       }
-      function pollInterval(pollInterval) {
+      async function pollInterval(pollInterval) {
           let fulfill;
           const result = new Promise((x) => (fulfill = x));
-          onTimeout();
+          await onTimeout();
           return result;
-          function onTimeout() {
+          async function onTimeout() {
               if (timedOut) {
                   fulfill();
                   return;
               }
-              const success = predicate(...args);
-              if (success)
-                  fulfill(success);
-              else
-                  setTimeout(onTimeout, pollInterval);
+              const success = await predicate(...args);
+              if (success) fulfill(success);
+              else setTimeout(onTimeout, pollInterval);
           }
       }
   }

data/lib/puppeteer/web_socket.rb

@@ -18,6 +18,8 @@ class Puppeteer::WebSocket
       @socket.write(data)
     rescue Errno::EPIPE
       raise EOFError.new('already closed')
+    rescue Errno::ECONNRESET
+      raise EOFError.new('closed by remote')
     end
 
     def readpartial(maxlen = 1024)

data/lib/puppeteer/web_socket_transport.rb

@@ -37,6 +37,8 @@ class Puppeteer::WebSocketTransport
 
   def close
     @ws.close
+  rescue EOFError
+    # ignore EOLError. The connection is already closed.
   end
 
   def on_close(&block)

data/puppeteer-ruby.gemspec

@@ -12,7 +12,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/YusukeIwaki/puppeteer-ruby'
 
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/}) || f.include?(".git") || f.include?(".circleci") || f.start_with?("development/")
+    end
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -23,11 +25,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'mime-types', '>= 3.0'
   spec.add_development_dependency 'bundler', '~> 2.2.3'
   spec.add_development_dependency 'chunky_png'
+  spec.add_development_dependency 'dry-inflector'
   spec.add_development_dependency 'pry-byebug'
   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.12.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.31.3
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -213,15 +227,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/stale.yml"
-- ".github/workflows/docs.yml"
-- ".github/workflows/reviewdog.yml"
-- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
@@ -230,7 +237,9 @@ files:
 - bin/console
 - bin/setup
 - docker-compose.yml
+- docs/api_coverage.md
 - 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 +248,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 +289,8 @@ files:
 - lib/puppeteer/page/pdf_options.rb
 - lib/puppeteer/page/screenshot_options.rb
 - lib/puppeteer/page/screenshot_task_queue.rb
+- lib/puppeteer/puppeteer.rb
+- lib/puppeteer/query_handler_manager.rb
 - lib/puppeteer/remote_object.rb
 - lib/puppeteer/request.rb
 - lib/puppeteer/response.rb