puppeteer-ruby 0.0.11 → 0.0.12

data/docs/top-level-namespace.html

@@ -116,7 +116,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Jun 20 17:15:05 2020 by
+  Generated on Tue Jun 23 10:24:58 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.rb

@@ -63,17 +63,33 @@ class Puppeteer
     end
   end
 
-  # @param {string} projectRoot
-  # @param {string} preferredRevision
-  # @param {boolean} isPuppeteerCore
+  # @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 {!(Launcher.LaunchOptions & Launcher.ChromeArgOptions & Launcher.BrowserOptions & {product?: string, extraPrefsFirefox?: !object})=} options
-  # @return {!Promise<!Puppeteer.Browser>}
+  # @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,
@@ -125,8 +141,13 @@ class Puppeteer
     end
   end
 
-  # @param {!(Launcher.BrowserOptions & {browserWSEndpoint?: string, browserURL?: string, transport?: !Puppeteer.ConnectionTransport})} options
-  # @return {!Promise<!Puppeteer.Browser>}
+  # @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,
@@ -151,7 +172,7 @@ class Puppeteer
     end
   end
 
-  # @return {string}
+  # @return [String]
   def executable_path
     launcher.executable_path
   end
@@ -165,12 +186,12 @@ class Puppeteer
     )
   end
 
-  # @return {string}
+  # @return [String]
   def product
     launcher.product
   end
 
-  # @return {Puppeteer::Devices}
+  # @return [Puppeteer::Devices]
   def devices
     Puppeteer::Devices
   end
@@ -180,8 +201,11 @@ class Puppeteer
   #   # ???
   # end
 
-  # @param {!Launcher.ChromeArgOptions=} options
-  # @return {!Array<string>}
+  # @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,

data/lib/puppeteer/browser.rb

@@ -207,6 +207,11 @@ class Puppeteer::Browser
     targets.first { |target| target.type == 'browser' }
   end
 
+  # used only in Target#opener
+  private def find_target_by_id(target_id)
+    @targets[target_id]
+  end
+
   # @param {function(!Target):boolean} predicate
   # @param {{timeout?: number}=} options
   # @return {!Promise<!Target>}

data/lib/puppeteer/concurrent_ruby_utils.rb

@@ -29,8 +29,12 @@ module Puppeteer::ConcurrentRubyUtils
     Concurrent::Promises.future(&block)
   end
 
-  def resolvable_future
-    Concurrent::Promises.resolvable_future
+  def resolvable_future(&block)
+    future = Concurrent::Promises.resolvable_future
+    if block
+      block.call(future)
+    end
+    future
   end
 end
 

data/lib/puppeteer/event_callbackable.rb

@@ -39,6 +39,17 @@ module Puppeteer::EventCallbackable
     end
   end
 
+  def observe_first(event_name, &block)
+    listener_id = add_event_listener(event_name) do |*args, **kwargs|
+      if kwargs.empty?
+        block.call(*args)
+      else
+        block.call(*args, **kwargs)
+      end
+      remove_event_listener(listener_id)
+    end
+  end
+
   def on_event(event_name, &block)
     @event_callbackable_handlers ||= {}
     @event_callbackable_handlers[event_name] = block

data/lib/puppeteer/launcher.rb

@@ -4,13 +4,13 @@ require_relative './launcher/chrome'
 require_relative './launcher/chrome_arg_options'
 require_relative './launcher/launch_options'
 
-# https://github.com/puppeteer/puppeteer/blob/master/lib/Launcher.js
+# https://github.com/puppeteer/puppeteer/blob/main/src/node/Launcher.ts
 module Puppeteer::Launcher
-  # @param {string} projectRoot
-  # @param {string} preferredRevision
-  # @param {boolean} isPuppeteerCore
-  # @param {string=} product
-  # @return {!Puppeteer.ProductLauncher}
+  # @param project_root [String]
+  # @param prefereed_revision [String]
+  # @param is_puppeteer_core [String]
+  # @param product [String] 'chrome' or 'firefox' (not implemented yet)
+  # @return [Puppeteer::Launcher::Chrome]
   module_function def new(project_root:, preferred_revision:, is_puppeteer_core:, product:)
     if product == 'firefox'
       raise NotImplementedError.new('FirefoxLauncher is not implemented yet.')

data/lib/puppeteer/launcher/chrome.rb

@@ -1,6 +1,6 @@
 require 'tmpdir'
 
-# https://github.com/puppeteer/puppeteer/blob/master/lib/Launcher.js
+# https://github.com/puppeteer/puppeteer/blob/main/src/node/Launcher.ts
 module Puppeteer::Launcher
   class Chrome < Base
     # @param {!(Launcher.LaunchOptions & Launcher.ChromeArgOptions & Launcher.BrowserOptions)=} options

data/lib/puppeteer/page.rb

@@ -124,6 +124,45 @@ class Puppeteer::Page
     )
   end
 
+  EVENT_MAPPINGS = {
+    close: 'Events.Page.Close',
+    # console: 'Events.Page.Console',
+    # dialog: 'Events.Page.Dialog',
+    domcontentloaded: 'Events.Page.DOMContentLoaded',
+    # error:
+    frameattached: 'Events.Page.FrameAttached',
+    framedetached: 'Events.Page.FrameDetached',
+    framenavigated: 'Events.Page.FrameNavigated',
+    load: 'Events.Page.Load',
+    # metrics: 'Events.Page.Metrics',
+    # pageerror: 'Events.Page.PageError',
+    popup: 'Events.Page.Popup',
+    request: 'Events.Page.Request',
+    requestfailed: 'Events.Page.RequestFailed',
+    requestfinished: 'Events.Page.RequestFinished',
+    response: 'Events.Page.Response',
+    # workercreated: 'Events.Page.WorkerCreated',
+    # workerdestroyed: 'Events.Page.WorkerDestroyed',
+  }
+
+  # @param event_name [Symbol]
+  def on(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
+  # @param event_name [Symbol]
+  def once(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
   def handle_file_chooser(event)
     return if @file_chooser_interceptors.empty?
 

data/lib/puppeteer/target.rb

@@ -135,7 +135,7 @@ class Puppeteer::Target
   def opener
     opener_id = @target_info.opener_id
     return nil if opener_id.nil?
-    browser.targets[opener_id]
+    browser.send(:find_target_by_id, opener_id)
   end
 
   # @param {!Protocol.Target.TargetInfo} targetInfo

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 class Puppeteer
-  VERSION = '0.0.11'
+  VERSION = '0.0.12'
 end

data/lib/puppeteer/web_socket_transport.rb

@@ -6,14 +6,14 @@ class Puppeteer::WebSocketTransport
       url: url,
       max_payload_size: 256 * 1024 * 1024, # 256MB
     )
-    promise = resolvable_future
-    ws.on_open do
-      promise.fulfill(Puppeteer::WebSocketTransport.new(ws))
-    end
-    ws.on_error do |error_message|
-      promise.reject(Puppeteer::WebSocket::TransportError.new(error_message))
-    end
-    promise.value!
+    (resolvable_future do |future|
+      ws.on_open do
+        future.fulfill(Puppeteer::WebSocketTransport.new(ws))
+      end
+      ws.on_error do |error_message|
+        future.reject(Puppeteer::WebSocket::TransportError.new(error_message))
+      end
+    end).value!
   end
 
   # @param {!WebSocket::Driver} web_socket

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-20 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -177,13 +177,11 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
-- Dockerfile
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- docker-compose.yml
 - docs/Puppeteer.html
 - docs/Puppeteer/AsyncAwaitBehavior.html
 - docs/Puppeteer/Browser.html
@@ -333,6 +331,7 @@ files:
 - lib/puppeteer/web_socket.rb
 - lib/puppeteer/web_socket_transport.rb
 - puppeteer-ruby.gemspec
+- puppeteer-ruby.png
 homepage: https://github.com/YusukeIwaki/puppeteer-ruby
 licenses: []
 metadata: {}

data/Dockerfile

@@ -1,6 +0,0 @@
-FROM ruby:2.6.5
-
-RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
-    && sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
-    && apt-get update && apt-get install -y google-chrome-stable --no-install-recommends \
-    && rm -rf /var/lib/apt/lists/*

data/docker-compose.yml

@@ -1,15 +0,0 @@
-version: "3"
-services:
-  dev:
-    image: ruby-with-chrome:2.6
-    build:
-      context: .
-      dockerfile: Dockerfile
-    volumes:
-      - .:/usr/src/app
-      - bundler-cache:/usr/local/bundle
-    working_dir: /usr/src/app
-
-volumes:
-  bundler-cache:
-    driver: local