puppeteer-ruby 0.0.18 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63cde4d139f1dc95710efb059310822219b905ef4b44ec8a1347b4bdc97a6b2e
-  data.tar.gz: '0989de5d246bb1c2bcb5ab625eb0702f608ec6ec667db9bbcf4282cf419314fa'
+  metadata.gz: 133c14dccb0da46cc01bff747bb2e36c1de1f7619ee4a8a898e798b3eb3947af
+  data.tar.gz: a7cc95948ddef2b45cc3b4a8faa82497334daeb1e47d92c97a7cbcbf9dccd887
 SHA512:
-  metadata.gz: 96aaf3dc540e160dd983660f2ea4fa10a8c3a2126e9c56f57f9c7a11c31c956376f556473c2d6c591b4cf4253c92e91055cc564e1910fe6dbaf3eb8244d2e852
-  data.tar.gz: c2195746ce0ed09fb2be8e66cb842cc2fb9487c51cb2232e51f3970df0234aec97fce173627bbedd1c4d113cd82154c134a69d0f9eb02c23826ab0bc0ad7ee18
+  metadata.gz: de40a672ecbf7089e43463497bd877ed671e366ae022d6224bef0068c9ecbc5a949d4649454348af8d9823abf0e0effe84255ce3e73f8bd6f13c2d4ce2dd514e
+  data.tar.gz: 96821b3ec521338f6c2a08c31a65113acb1aa808e1f50b9fece78bcdcc19cb6f4072b2dd6d778a5a413f47733b1efa7d3f9ded85fdd0e0dce6c1729f53be47ab

data/.circleci/config.yml

@@ -5,7 +5,7 @@ orbs:
 jobs:
   rspec:
     docker:
-      - image: circleci/ruby:2.6.3-stretch-node-browsers
+      - image: circleci/ruby:2.6.6-buster-node-browsers
     executor: ruby/default
     steps:
       - checkout
@@ -18,6 +18,28 @@ jobs:
               --out test_results/rspec.xml \
               --format documentation
 
+  rspec_firefox:
+    docker:
+      - image: circleci/ruby:2.6.6-buster-node-browsers
+    executor: ruby/default
+    steps:
+      - checkout
+      - ruby/bundle-install
+      - run:
+          name: install firefox-nightly
+          command: |
+            wget -O nightly.tar.bz2 "https://download.mozilla.org/?product=firefox-nightly-latest-ssl&os=linux64&lang=en-US"
+            tar xf nightly.tar.bz2
+      - run:
+          name: rspec
+          command: |
+            DEBUG=1 PUPPETEER_PRODUCT_RSPEC=firefox \
+            PUPPETEER_EXECUTABLE_PATH_RSPEC=${CIRCLE_WORKING_DIRECTORY/#\~/$HOME}/firefox/firefox \
+            bundle exec rspec --profile 10 \
+              --format RspecJunitFormatter \
+              --out test_results/rspec.xml \
+              --format documentation spec/integration/
+
   deploy:
     docker:
       - image: circleci/ruby:2.6.3-stretch-node
@@ -49,6 +71,7 @@ workflows:
   ci:
     jobs:
       - rspec
+      - rspec_firefox
   rubygems-deploy:
     jobs:
       - deploy:

data/.github/workflows/reviewdog.yml

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

data/.rubocop.yml

@@ -35,6 +35,9 @@ Layout/EndAlignment:
 Layout/EmptyLineAfterMagicComment:
   Enabled: true
 
+Layout/EmptyLineAfterMultilineCondition:
+  Enabled: true
+
 Layout/EmptyLinesAroundAccessModifier:
   Enabled: true
   EnforcedStyle: only_before
@@ -102,6 +105,10 @@ Layout/SpaceBeforeComment:
 Layout/SpaceBeforeFirstArg:
   Enabled: true
 
+Style/ClassMethodsDefinitions:
+  Enabled: true
+  EnforcedStyle: def_self
+
 Style/DefWithParentheses:
   Enabled: true
 
@@ -109,9 +116,52 @@ Style/DefWithParentheses:
 Style/MethodDefParentheses:
   Enabled: true
 
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  IgnoredMethods:
+    # Gemfile, gemspec
+    - source
+    - add_dependency
+    - add_development_dependency
+
+    # include/require
+    - require
+    - require_relative
+    - include
+
+    # fundamental methods
+    - raise
+    - sleep
+
+    # RSpec
+    - describe
+    - it
+    - to
+    - not_to
+    - be
+    - eq
+
+    # async/await
+    - define_async_method
+    - await
+    - future
+
+    # utils
+    - debug_print
+    - debug_puts
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
 Style/RedundantFreeze:
   Enabled: true
 
+Style/RedundantSelf:
+  Enabled: true
+
+Style/RedundantSelfAssignment:
+  Enabled: true
+
 # Use `foo {}` not `foo{}`.
 Layout/SpaceBeforeBlockBraces:
   Enabled: true
@@ -164,9 +214,6 @@ Lint/EmptyConditionalBody:
 Lint/FloatComparison:
   Enabled: true
 
-Lint/MissingSuper:
-  Enabled: true
-
 Lint/OutOfRangeRegexpRef:
   Enabled: true
 

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM circleci/ruby:2.6.6-buster-node-browsers
+
+USER root
+
+RUN wget -O nightly.tar.bz2 "https://download.mozilla.org/?product=firefox-nightly-latest-ssl&os=linux64&lang=en-US" \
+    && tar xf nightly.tar.bz2 \
+    && ln -s $(pwd)/firefox/firefox /usr/bin/firefox
+
+USER circleci

data/README.md

@@ -47,8 +47,46 @@ Puppeteer.launch(headless: false, slow_mo: 50, args: ['--guest', '--window-size=
 end
 ```
 
+### Evaluate JavaScript
+
+```ruby
+Puppeteer.launch do |browser|
+  page = browser.pages.last || browser.new_page
+  page.goto 'https://github.com/YusukeIwaki'
+
+  # Get the "viewport" of the page, as reported by the page.
+  dimensions = page.evaluate(<<~JAVASCRIPT)
+  () => {
+    return {
+      width: document.documentElement.clientWidth,
+      height: document.documentElement.clientHeight,
+      deviceScaleFactor: window.devicePixelRatio
+    };
+  }
+  JAVASCRIPT
+
+  puts "dimensions: #{dimensions}"
+  # => dimensions: {"width"=>800, "height"=>600, "deviceScaleFactor"=>1}
+end
+```
+
 More usage examples can be found [here](https://github.com/YusukeIwaki/puppeteer-ruby-example)
 
+## :whale: Running in Docker
+
+Following packages are required.
+
+* Google Chrome or Chromium
+  * In Debian-based images, `google-chrome-stable`
+  * In Alpine-based images, `chromium`
+
+Also, CJK font will be required for Chinese, Japanese, Korean sites.
+
+### References
+
+* Puppeteer official README: https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#running-puppeteer-in-docker
+* puppeteer-ruby example: https://github.com/YusukeIwaki/puppeteer-ruby-example/tree/master/docker_chromium
+
 ## :bulb: Collaboration with Selenium or Capybara
 
 It is really remarkable that we can use puppeteer functions in existing Selenium or Capybara codes, with a few configuration in advance.

data/docker-compose.yml

@@ -0,0 +1,34 @@
+version: "3"
+services:
+  chrome:
+    tty: true
+    stdin_open: true
+    build: .
+    environment:
+      BUNDLE_PATH: /usr/local/bundle
+      DEBUG: 1
+      CI: 1
+    volumes:
+      - .:/puppeteer-ruby
+      - bundle-data:/usr/local/bundle
+    working_dir: /puppeteer-ruby
+    command: bundle exec rspec
+
+  firefox:
+    tty: true
+    stdin_open: true
+    build: .
+    environment:
+      BUNDLE_PATH: /usr/local/bundle
+      PUPPETEER_PRODUCT_RSPEC: firefox
+      DEBUG: 1
+      CI: 1
+    volumes:
+      - .:/puppeteer-ruby
+      - bundle-data:/usr/local/bundle
+    working_dir: /puppeteer-ruby
+    command: bundle exec rspec spec/integration/
+
+volumes:
+  bundle-data:
+    driver: local

data/lib/puppeteer.rb

@@ -6,7 +6,9 @@ require 'puppeteer/env'
 
 # Custom data types.
 require 'puppeteer/device'
+require 'puppeteer/events'
 require 'puppeteer/errors'
+require 'puppeteer/geolocation'
 require 'puppeteer/viewport'
 
 # Modules
@@ -24,8 +26,10 @@ require 'puppeteer/cdp_session'
 require 'puppeteer/connection'
 require 'puppeteer/console_message'
 require 'puppeteer/devices'
+require 'puppeteer/dialog'
 require 'puppeteer/dom_world'
 require 'puppeteer/emulation_manager'
+require 'puppeteer/exception_details'
 require 'puppeteer/execution_context'
 require 'puppeteer/file_chooser'
 require 'puppeteer/frame'
@@ -53,17 +57,17 @@ require 'puppeteer/element_handle'
 
 # ref: https://github.com/puppeteer/puppeteer/blob/master/lib/Puppeteer.js
 class Puppeteer
-  class << self
-    def method_missing(method, *args, **kwargs, &block)
-      instance.send(method, *args, **kwargs, &block)
-    end
+  def self.method_missing(method, *args, **kwargs, &block)
+    @puppeteer ||= Puppeteer.new(
+      project_root: __dir__,
+      preferred_revision: '706915',
+      is_puppeteer_core: true,
+    )
 
-    def instance
-      @instance ||= Puppeteer.new(
-        project_root: __dir__,
-        preferred_revision: '706915',
-        is_puppeteer_core: true,
-      )
+    if kwargs.empty? # for Ruby < 2.7
+      @puppeteer.public_send(method, *args, &block)
+    else
+      @puppeteer.public_send(method, *args, **kwargs, &block)
     end
   end
 
@@ -130,7 +134,7 @@ class Puppeteer
       ignore_https_errors: ignore_https_errors,
       default_viewport: default_viewport,
       slow_mo: slow_mo,
-    }.compact
+    }
 
     @product_name ||= product
     browser = launcher.launch(options)

data/lib/puppeteer/browser.rb

@@ -46,37 +46,30 @@ class Puppeteer::Browser
       @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self, context_id)
     end
     @targets = {}
-    @connection.on_event 'Events.Connection.Disconnected' do
-      emit_event 'Events.Browser.Disconnected'
+    @connection.on_event(ConnectionEmittedEvents::Disconnected) do
+      emit_event(BrowserEmittedEvents::Disconnected)
     end
-    @connection.on_event 'Target.targetCreated', &method(:handle_target_created)
-    @connection.on_event 'Target.targetDestroyed', &method(:handle_target_destroyed)
-    @connection.on_event 'Target.targetInfoChanged', &method(:handle_target_info_changed)
+    @connection.on_event('Target.targetCreated', &method(:handle_target_created))
+    @connection.on_event('Target.targetDestroyed', &method(:handle_target_destroyed))
+    @connection.on_event('Target.targetInfoChanged', &method(:handle_target_info_changed))
   end
 
-  EVENT_MAPPINGS = {
-    disconnected: 'Events.Browser.Disconnected',
-    targetcreated: 'Events.Browser.TargetCreated',
-    targetchanged: 'Events.Browser.TargetChanged',
-    targetdestroyed: 'Events.Browser.TargetDestroyed',
-  }
-
   # @param event_name [Symbol] either of :disconnected, :targetcreated, :targetchanged, :targetdestroyed
   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(", ")}")
+    unless BrowserEmittedEvents.values.include?(event_name.to_s)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserEmittedEvents.values.to_a.join(", ")}")
     end
 
-    add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
+    super(event_name.to_s, &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(", ")}")
+    unless BrowserEmittedEvents.values.include?(event_name.to_s)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserEmittedEvents.values.to_a.join(", ")}")
     end
 
-    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+    super(event_name.to_s, &block)
   end
 
   # @return [Puppeteer::BrowserRunner::BrowserProcess]
@@ -137,8 +130,8 @@ class Puppeteer::Browser
     #   assert(!this._targets.has(event.targetInfo.targetId), 'Target should not exist before targetCreated');
     @targets[target_info.target_id] = target
     if await target.initialized_promise
-      emit_event 'Events.Browser.TargetCreated', target
-      context.emit_event 'Events.BrowserContext.TargetCreated', target
+      emit_event(BrowserEmittedEvents::TargetCreated, target)
+      context.emit_event(BrowserContextEmittedEvents::TargetCreated, target)
     end
   end
 
@@ -150,8 +143,8 @@ class Puppeteer::Browser
     @targets.delete(target_id)
     target.closed_callback
     if await target.initialized_promise
-      emit_event 'Events.Browser.TargetDestroyed', target
-      target.browser_context.emit_event 'Events.BrowserContext.TargetDestroyed', target
+      emit_event(BrowserEmittedEvents::TargetDestroyed, target)
+      target.browser_context.emit_event(BrowserContextEmittedEvents::TargetDestroyed, target)
     end
   end
 
@@ -169,8 +162,8 @@ class Puppeteer::Browser
     was_initialized = target.initialized?
     target.handle_target_info_changed(target_info)
     if was_initialized && previous_url != target.url
-      emit_event 'Events.Browser.TargetChanged', target
-      target.browser_context.emit_event 'Events.BrowserContext.TargetChanged', target
+      emit_event(BrowserEmittedEvents::TargetChanged, target)
+      target.browser_context.emit_event(BrowserContextEmittedEvents::TargetChanged, target)
     end
   end
 
@@ -222,12 +215,12 @@ class Puppeteer::Browser
 
     event_listening_ids = []
     target_promise = resolvable_future
-    event_listening_ids << add_event_listener('Events.Browser.TargetCreated') do |target|
+    event_listening_ids << add_event_listener(BrowserEmittedEvents::TargetCreated) do |target|
       if predicate.call(target)
         target_promise.fulfill(target)
       end
     end
-    event_listening_ids << add_event_listener('Events.Browser.TargetChanged') do |target|
+    event_listening_ids << add_event_listener(BrowserEmittedEvents::TargetChanged) do |target|
       if predicate.call(target)
         target_promise.fulfill(target)
       end

data/lib/puppeteer/browser_context.rb

@@ -11,29 +11,22 @@ class Puppeteer::BrowserContext
     @id = context_id
   end
 
-  EVENT_MAPPINGS = {
-    disconnected: 'Events.BrowserContext.Disconnected',
-    targetcreated: 'Events.BrowserContext.TargetCreated',
-    targetchanged: 'Events.BrowserContext.TargetChanged',
-    targetdestroyed: 'Events.BrowserContext.TargetDestroyed',
-  }
-
   # @param event_name [Symbol] either of :disconnected, :targetcreated, :targetchanged, :targetdestroyed
   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(", ")}")
+    unless BrowserContextEmittedEvents.values.include?(event_name.to_s)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserContextEmittedEvents.values.to_a.join(", ")}")
     end
 
-    add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
+    super(event_name.to_s, &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(", ")}")
+    unless BrowserContextEmittedEvents.values.include?(event_name.to_s)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserContextEmittedEvents.values.to_a.join(", ")}")
     end
 
-    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+    super(event_name.to_s, &block)
   end
 
   # @return {!Array<!Target>} target
@@ -64,42 +57,48 @@ class Puppeteer::BrowserContext
     !!@id
   end
 
-  # /**
-  #  * @param {string} origin
-  #  * @param {!Array<string>} permissions
-  #  */
-  # async overridePermissions(origin, permissions) {
-  #   const webPermissionToProtocol = new Map([
-  #     ['geolocation', 'geolocation'],
-  #     ['midi', 'midi'],
-  #     ['notifications', 'notifications'],
-  #     ['push', 'push'],
-  #     ['camera', 'videoCapture'],
-  #     ['microphone', 'audioCapture'],
-  #     ['background-sync', 'backgroundSync'],
-  #     ['ambient-light-sensor', 'sensors'],
-  #     ['accelerometer', 'sensors'],
-  #     ['gyroscope', 'sensors'],
-  #     ['magnetometer', 'sensors'],
-  #     ['accessibility-events', 'accessibilityEvents'],
-  #     ['clipboard-read', 'clipboardRead'],
-  #     ['clipboard-write', 'clipboardWrite'],
-  #     ['payment-handler', 'paymentHandler'],
-  #     // chrome-specific permissions we have.
-  #     ['midi-sysex', 'midiSysex'],
-  #   ]);
-  #   permissions = permissions.map(permission => {
-  #     const protocolPermission = webPermissionToProtocol.get(permission);
-  #     if (!protocolPermission)
-  #       throw new Error('Unknown permission: ' + permission);
-  #     return protocolPermission;
-  #   });
-  #   await this._connection.send('Browser.grantPermissions', {origin, browserContextId: this._id || undefined, permissions});
-  # }
-
-  # async clearPermissionOverrides() {
-  #   await this._connection.send('Browser.resetPermissions', {browserContextId: this._id || undefined});
-  # }
+  WEB_PERMISSION_TO_PROTOCOL = {
+    'geolocation' => 'geolocation',
+    'midi' => 'midi',
+    'notifications' => 'notifications',
+    # TODO: push isn't a valid type?
+    # 'push' => 'push',
+    'camera' => 'videoCapture',
+    'microphone' => 'audioCapture',
+    'background-sync' => 'backgroundSync',
+    'ambient-light-sensor' => 'sensors',
+    'accelerometer' => 'sensors',
+    'gyroscope' => 'sensors',
+    'magnetometer' => 'sensors',
+    'accessibility-events' => 'accessibilityEvents',
+    'clipboard-read' => 'clipboardReadWrite',
+    'clipboard-write' => 'clipboardReadWrite',
+    'payment-handler' => 'paymentHandler',
+    'idle-detection' => 'idleDetection',
+    # chrome-specific permissions we have.
+    'midi-sysex' => 'midiSysex',
+  }.freeze
+
+  # @param origin [String]
+  # @param permissions [Array<String>]
+  def override_permissions(origin, permissions)
+    protocol_permissions = permissions.map do |permission|
+      WEB_PERMISSION_TO_PROTOCOL[permission] or raise ArgumentError.new("Unknown permission: #{permission}")
+    end
+    @connection.send_message('Browser.grantPermissions', {
+      origin: origin,
+      browserContextId: @id,
+      permissions: protocol_permissions,
+    }.compact)
+  end
+
+  def clear_permission_overrides
+    if @id
+      @connection.send_message('Browser.resetPermissions', browserContextId: @id)
+    else
+      @connection.send_message('Browser.resetPermissions')
+    end
+  end
 
   # @return [Future<Puppeteer::Page>]
   def new_page