puppeteer-ruby 0.0.17 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2277fda99720c2566927af9a2acfc56da2b8e87ee10521871c368fd4a05649b2
-  data.tar.gz: 59636e168935b0fb6c964cd62355ae3becf8199ed2ee1af58cb512ccacc9d7cb
+  metadata.gz: 627b2272803511db582250101edac0b5f1f0191abdf86255c6f16d0f088cc82e
+  data.tar.gz: 70458a316f8ecce1b784bd84595c3f0fa248c77e671e4458384c494a1471c196
 SHA512:
-  metadata.gz: b45495a2ae160e740e242bc04bb81bfa493c1101583393f78e8e7ff3d065c00594fe0196b8225ac73e281a17428127597d11c8f8323ba6b58d64b437e2979d97
-  data.tar.gz: 72c9bd1ca17f37927ceb51a79904583c638066e29cdb08cc2534e77bcc7b3ee348e53e69546ecd579917bd6d8db9c4413d4a63cf617ffa33b8c69c756603439e
+  metadata.gz: 2baf0cb4769fc7100495b3dc590293085e3219c661bd164cdb28f0aad1975f18cba17890029156a08873f879ef370c196c3d995bfd040d073d42d0b49acbeef3
+  data.tar.gz: 67a23e46e7d439b76f438c59d062fe5daea0d216469e79ea1b4af2b8d60c4f9070455de22e51b9523fde2a67692919420bce2b05becf948120b71d426c4c560f

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
 
@@ -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

@@ -24,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'
@@ -53,17 +54,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 +131,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_runner.rb

@@ -21,9 +21,18 @@ class Puppeteer::BrowserRunner
 
   class BrowserProcess
     def initialize(env, executable_path, args)
+      @spawnargs =
+        if args && !args.empty?
+          [executable_path] + args
+        else
+          [executable_path]
+        end
+
       stdin, @stdout, @stderr, @thread = Open3.popen3(env, executable_path, *args)
       stdin.close
       @pid = @thread.pid
+    rescue Errno::ENOENT => err
+      raise LaunchError.new(err.message)
     end
 
     def kill
@@ -37,7 +46,13 @@ class Puppeteer::BrowserRunner
       @thread.join
     end
 
-    attr_reader :stdout, :stderr
+    attr_reader :stdout, :stderr, :spawnargs
+  end
+
+  class LaunchError < StandardError
+    def initialize(reason)
+      super("Failed to launch browser! #{reason}")
+    end
   end
 
   # @param {!(Launcher.LaunchOptions)=} options
@@ -123,12 +138,12 @@ class Puppeteer::BrowserRunner
 
   # @return {Promise}
   def kill
-    unless @closed
-      @proc.kill
-    end
     if @temp_directory
       FileUtils.rm_rf(@temp_directory)
     end
+    unless @closed
+      @proc.kill
+    end
   end
 
 
@@ -156,6 +171,6 @@ class Puppeteer::BrowserRunner
       end
     end
   rescue Timeout::Error
-    raise Puppeteer::TimeoutError.new("Timed out after #{timeout} ms while trying to connect to the browser! Only Chrome at revision r#{preferredRevision} is guaranteed to work.")
+    raise Puppeteer::TimeoutError.new("Timed out after #{timeout} ms while trying to connect to the browser! Only Chrome at revision r#{preferred_revision} is guaranteed to work.")
   end
 end

data/lib/puppeteer/cdp_session.rb

@@ -81,4 +81,14 @@ class Puppeteer::CDPSession
     @connection = nil
     emit_event 'Events.CDPSession.Disconnected'
   end
+
+  # @param event_name [String]
+  def on(event_name, &block)
+    add_event_listener(event_name, &block)
+  end
+
+  # @param event_name [String]
+  def once(event_name, &block)
+    observe_first(event_name, &block)
+  end
 end

data/lib/puppeteer/concurrent_ruby_utils.rb

@@ -4,9 +4,13 @@ module Puppeteer::ConcurrentRubyUtils
   # REMARK: This method doesn't assure the order of calling.
   # for example, await_all(async1, async2) calls calls2 -> calls1 often.
   def await_all(*args)
-    if args.length == 1 && args[0].is_a?(Enumerable)
-      Concurrent::Promises.zip(*(args[0])).value!
+    if args.length == 1 && args.first.is_a?(Enumerable)
+      await_all(*args.first)
     else
+      if args.any? { |arg| !arg.is_a?(Concurrent::Promises::Future) }
+        raise ArgumentError.new("All argument must be a Future: #{args}")
+      end
+
       Concurrent::Promises.zip(*args).value!
     end
   end
@@ -15,9 +19,13 @@ module Puppeteer::ConcurrentRubyUtils
   # REMARK: This method doesn't assure the order of calling.
   # for example, await_all(async1, async2) calls calls2 -> calls1 often.
   def await_any(*args)
-    if args.length == 1 && args[0].is_a?(Enumerable)
-      Concurrent::Promises.any(*(args[0])).value!
+    if args.length == 1 && args.first.is_a?(Enumerable)
+      await_any(*args.first)
     else
+      if args.any? { |arg| !arg.is_a?(Concurrent::Promises::Future) }
+        raise ArgumentError.new("All argument must be a Future: #{args}")
+      end
+
       Concurrent::Promises.any(*args).value!
     end
   end
@@ -32,7 +40,12 @@ module Puppeteer::ConcurrentRubyUtils
   end
 
   def future(&block)
-    Concurrent::Promises.future(&block)
+    Concurrent::Promises.future do
+      block.call
+    rescue => err
+      Logger.new($stderr).warn(err)
+      raise err
+    end
   end
 
   def resolvable_future(&block)

data/lib/puppeteer/connection.rb

@@ -204,8 +204,8 @@ class Puppeteer::Connection
           callback.reject(
             ProtocolError.new(
               method: callback.method,
-              error_message: response['error']['message'],
-              error_data: response['error']['data']))
+              error_message: message['error']['message'],
+              error_data: message['error']['data']))
         else
           callback.resolve(message['result'])
         end

data/lib/puppeteer/debug_print.rb

@@ -3,7 +3,7 @@ require 'logger'
 module Puppeteer::DebugPrint
   if Puppeteer.env.debug?
     def debug_puts(*args, **kwargs)
-      @__debug_logger ||= Logger.new(STDOUT)
+      @__debug_logger ||= Logger.new($stdout)
       @__debug_logger.debug(*args, **kwargs)
     end
 

data/lib/puppeteer/define_async_method.rb

@@ -14,7 +14,7 @@ module Puppeteer::DefineAsyncMethod
         Concurrent::Promises.future do
           original_method.bind(self).call(*args)
         rescue => err
-          Logger.new(STDERR).warn(err)
+          Logger.new($stderr).warn(err)
           raise err
         end
       end