puppeteer-ruby 0.0.16 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38a6ae4190bd04cbacb863d04f9862ebc8a37c6811fbfd690426ba051d5ea5d4
-  data.tar.gz: 60b61e143e63ed5e42b0bb6f3d9e5c27262fd2f51064c185e491056a5081707d
+  metadata.gz: f429910f146a926bd830400269da848120ca070da2a64d5dfec0c9861a6c46f4
+  data.tar.gz: e0ba66f60e283d7d0cc6263f7750dc7ddc6f9cd17ceaaaf4ae247c524f8986f8
 SHA512:
-  metadata.gz: fc3ab652476ee319fab2d691173a0175d4b03d72346329f2fb855a142c3090693f1fb5cfa52abb4badbfbadc7d4eec5028a295f63fb7ddd3e362321564a96b7c
-  data.tar.gz: 6de2484b1b939c3cab1bfa48bb2225c54686f13e7901f3df086d8e5c7b18aa9fc62afb5fd9a785a3fbbf12d2aef50cde1d085f3564ce9afab996f80a39c64936
+  metadata.gz: 1251d762934da872f78028c12c33e9e025ab331c3e09abe4bb80191e82fa1d09681c204fd1da8c1b86668cf9f317f9f7030d65c6d4aa078355afe8089ffce4eb
+  data.tar.gz: 2a28ea494da354c5658c1618806ddb291d53d4a2f2bde0579c5aefc01da523ddc17511cfa5ff6315761c09b7a83b6d9526ff0020cc2275b871788c88a19e70ed

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
@@ -13,10 +13,32 @@ jobs:
       - run:
           name: rspec
           command: |
+            DEBUG=1 bundle exec rspec --profile 10 \
+              --format RspecJunitFormatter \
+              --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 progress
+              --format documentation spec/integration/
 
   deploy:
     docker:
@@ -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
 
@@ -112,6 +119,12 @@ Style/MethodDefParentheses:
 Style/RedundantFreeze:
   Enabled: true
 
+Style/RedundantSelf:
+  Enabled: true
+
+Style/RedundantSelfAssignment:
+  Enabled: true
+
 # Use `foo {}` not `foo{}`.
 Layout/SpaceBeforeBlockBraces:
   Enabled: true
@@ -146,17 +159,44 @@ Lint/AmbiguousOperator:
 Lint/AmbiguousRegexpLiteral:
   Enabled: true
 
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
 Lint/ErbNewArguments:
   Enabled: true
 
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
 # Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
 Lint/RequireParentheses:
   Enabled: true
 
+Lint/SelfAssignment:
+  Enabled: true
+
 Lint/ShadowingOuterLocalVariable:
   Enabled: true
 
-Lint/RedundantStringCoercion:
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
   Enabled: true
 
 Lint/UriEscapeUnescape:
@@ -165,15 +205,18 @@ Lint/UriEscapeUnescape:
 Lint/UselessAssignment:
   Enabled: true
 
-Lint/DeprecatedClassMethods:
+Style/ParenthesesAroundCondition:
   Enabled: true
 
-Style/ParenthesesAroundCondition:
+Style/ExplicitBlockArgument:
   Enabled: true
 
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/GlobalStdStream:
+  Enabled: true
+
 Style/HashEachMethods:
   Enabled: true
 
@@ -198,6 +241,9 @@ Style/Semicolon:
   Enabled: true
   AllowAsExpressionSeparator: true
 
+Style/StringConcatenation:
+  Enabled: true
+
 # Prefer Foo.method over Foo::method
 Style/ColonMethodCall:
   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

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/puppeteer-ruby.svg)](https://badge.fury.io/rb/puppeteer-ruby)
+
 # Puppeteer in Ruby [UNDER HEAVY DEVELOPMENT]
 
 A Ruby port of [puppeteer](https://pptr.dev/).
@@ -45,9 +47,32 @@ 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)
 
-## Collaboration with Selenium or Capybara
+## :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

@@ -2,6 +2,8 @@ require 'concurrent'
 
 class Puppeteer; end
 
+require 'puppeteer/env'
+
 # Custom data types.
 require 'puppeteer/device'
 require 'puppeteer/errors'
@@ -22,6 +24,7 @@ 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/execution_context'
@@ -51,18 +54,14 @@ 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,
-      )
-    end
+    @puppeteer.send(method, *args, **kwargs, &block)
   end
 
   # @param project_root [String]
@@ -168,7 +167,11 @@ class Puppeteer
     }.compact
     browser = launcher.connect(options)
     if block_given?
-      yield(browser)
+      begin
+        yield(browser)
+      ensure
+        browser.disconnect
+      end
     else
       browser
     end

data/lib/puppeteer/browser.rb

@@ -43,7 +43,7 @@ class Puppeteer::Browser
     @default_context = Puppeteer::BrowserContext.new(@connection, self, nil)
     @contexts = {}
     context_ids.each do |context_id|
-      @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self. context_id)
+      @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self, context_id)
     end
     @targets = {}
     @connection.on_event 'Events.Connection.Disconnected' do
@@ -70,6 +70,15 @@ class Puppeteer::Browser
     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
+
   # @return [Puppeteer::BrowserRunner::BrowserProcess]
   def process
     @process
@@ -94,7 +103,7 @@ class Puppeteer::Browser
   # @param context_id [String]
   def dispose_context(context_id)
     @connection.send_message('Target.disposeBrowserContext', browserContextId: context_id)
-    @contexts.remove(context_id)
+    @contexts.delete(context_id)
   end
 
   class TargetAlreadyExistError < StandardError
@@ -166,7 +175,7 @@ class Puppeteer::Browser
   end
 
   # @return [String]
-  def websocket_endpoint
+  def ws_endpoint
     @connection.url
   end
 
@@ -196,7 +205,7 @@ class Puppeteer::Browser
 
   # @return {!Target}
   def target
-    targets.first { |target| target.type == 'browser' }
+    targets.find { |target| target.type == 'browser' }
   end
 
   # used only in Target#opener
@@ -204,12 +213,11 @@ class Puppeteer::Browser
     @targets[target_id]
   end
 
-  # @param {function(!Target):boolean} predicate
-  # @param {{timeout?: number}=} options
-  # @return {!Promise<!Target>}
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  # @return [Puppeteer::Target]
   def wait_for_target(predicate:, timeout: nil)
     timeout_in_sec = (timeout || 30000).to_i / 1000.0
-    existing_target = targets.first { |target| predicate.call(target) }
+    existing_target = targets.find { |target| predicate.call(target) }
     return existing_target if existing_target
 
     event_listening_ids = []
@@ -233,11 +241,18 @@ class Puppeteer::Browser
       else
         target_promise.value!
       end
+    rescue Timeout::Error
+      raise Puppeteer::TimeoutError.new("waiting for target failed: timeout #{timeout}ms exceeded")
     ensure
       remove_event_listener(*event_listening_ids)
     end
   end
 
+  # @!method async_wait_for_target(predicate:, timeout: nil)
+  #
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  define_async_method :async_wait_for_target
+
   # @return {!Promise<!Array<!Puppeteer.Page>>}
   def pages
     browser_contexts.flat_map(&:pages)
@@ -266,7 +281,19 @@ class Puppeteer::Browser
     !@connection.closed?
   end
 
+  class Version
+    def initialize(hash)
+      @protocol_version = hash['protocolVersion']
+      @product = hash['product']
+      @revision = hash['revision']
+      @user_agent = hash['userAgent']
+      @js_version = hash['jsVersion']
+    end
+
+    attr_reader :protocol_version, :product, :revision, :user_agent, :js_version
+  end
+
   private def get_version
-    @connection.send_message('Browser.getVersion')
+    Version.new(@connection.send_message('Browser.getVersion'))
   end
 end

data/lib/puppeteer/browser_context.rb

@@ -1,5 +1,6 @@
 class Puppeteer::BrowserContext
   include Puppeteer::EventCallbackable
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.Connection} connection
   # @param {!Browser} browser
@@ -10,14 +11,38 @@ 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(", ")}")
+    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
+
   # @return {!Array<!Target>} target
   def targets
     @browser.targets.select { |target| target.browser_context == self }
   end
 
-  # @param {function(!Target):boolean} predicate
-  # @param {{timeout?: number}=} options
-  # @return {!Promise<!Target>}
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  # @return [Puppeteer::Target]
   def wait_for_target(predicate:, timeout: nil)
     @browser.wait_for_target(
       predicate: ->(target) { target.browser_context == self && predicate.call(target) },
@@ -25,13 +50,18 @@ class Puppeteer::BrowserContext
     )
   end
 
+  # @!method async_wait_for_target(predicate:, timeout: nil)
+  #
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  define_async_method :async_wait_for_target
+
   # @return {!Promise<!Array<!Puppeteer.Page>>}
   def pages
     targets.select { |target| target.type == 'page' }.map(&:page).reject { |page| !page }
   end
 
   def incognito?
-    !@id
+    !!@id
   end
 
   # /**
@@ -82,7 +112,7 @@ class Puppeteer::BrowserContext
   end
 
   def close
-    if !@id
+    unless @id
       raise 'Non-incognito profiles cannot be closed!'
     end
     @browser.dispose_context(@id)