puppeteer-ruby 0.29.0 → 0.31.4

data/lib/puppeteer/page/pdf_options.rb

@@ -52,24 +52,24 @@ class Puppeteer::Page
     end
 
     PAPER_FORMATS = {
-      letter: PaperSize.new(width: 8.5, height: 11),
-      legal: PaperSize.new(width: 8.5, height: 14),
-      tabloid: PaperSize.new(width: 11, height: 17),
-      ledger: PaperSize.new(width: 17, height: 11),
-      a0: PaperSize.new(width: 33.1, height: 46.8),
-      a1: PaperSize.new(width: 23.4, height: 33.1),
-      a2: PaperSize.new(width: 16.54, height: 23.4),
-      a3: PaperSize.new(width: 11.7, height: 16.54),
-      a4: PaperSize.new(width: 8.27, height: 11.7),
-      a5: PaperSize.new(width: 5.83, height: 8.27),
-      a6: PaperSize.new(width: 4.13, height: 5.83),
+      'letter' => PaperSize.new(width: 8.5, height: 11),
+      'legal' => PaperSize.new(width: 8.5, height: 14),
+      'tabloid' => PaperSize.new(width: 11, height: 17),
+      'ledger' => PaperSize.new(width: 17, height: 11),
+      'a0' => PaperSize.new(width: 33.1, height: 46.8),
+      'a1' => PaperSize.new(width: 23.4, height: 33.1),
+      'a2' => PaperSize.new(width: 16.54, height: 23.4),
+      'a3' => PaperSize.new(width: 11.7, height: 16.54),
+      'a4' => PaperSize.new(width: 8.27, height: 11.7),
+      'a5' => PaperSize.new(width: 5.83, height: 8.27),
+      'a6' => PaperSize.new(width: 4.13, height: 5.83),
     }
 
     UNIT_TO_PIXELS = {
-      px: 1,
-      in: 96,
-      cm: 37.8,
-      mm: 3.78,
+      'px' => 1,
+      'in' => 96,
+      'cm' => 37.8,
+      'mm' => 3.78,
     }
 
     # @param parameter [String|Integer|nil]

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/version.rb

@@ -1,3 +1,3 @@
-class Puppeteer
-  VERSION = '0.29.0'
+module Puppeteer
+  VERSION = '0.31.4'
 end

data/lib/puppeteer/wait_task.rb

@@ -135,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);
@@ -159,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.10.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.29.0
+  version: 0.31.4
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-03-27 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.10.0
+        version: 1.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -213,16 +227,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/stale.yml"
-- ".github/workflows/docs.yml"
-- ".github/workflows/reviewdog.yml"
-- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
@@ -231,6 +237,7 @@ 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
@@ -282,6 +289,7 @@ 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

data/.circleci/config.yml

@@ -1,92 +0,0 @@
-version: 2.1
-
-rspec_chrome_job: &rspec_chrome_job
-  steps:
-    - checkout
-    - run:
-        command: gem install bundler:2.2.3 && bundle install
-    - run:
-        name: rspec
-        command: |
-          DEBUG=1 bundle exec rspec --profile 10 \
-            --format RspecJunitFormatter \
-            --out test_results/rspec.xml \
-            --format documentation
-
-jobs:
-  rspec_chrome_ruby2_6:
-    docker:
-      - image: circleci/ruby:2.6.6-buster-node-browsers
-    <<: *rspec_chrome_job
-
-  rspec_chrome_ruby2_7:
-    docker:
-      - image: circleci/ruby:2.7.2-buster-node-browsers
-    <<: *rspec_chrome_job
-
-  rspec_chrome_ruby3_0:
-    docker:
-      - image: circleci/ruby:3.0.0-buster-node-browsers
-    <<: *rspec_chrome_job
-
-  rspec_firefox:
-    docker:
-      - image: circleci/ruby:2.7.2-buster-node-browsers
-    steps:
-      - checkout
-      - run:
-          command: gem install bundler:2.2.3 && 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
-    steps:
-      - checkout
-      - run:
-          command: gem install bundler:2.2.3 && bundle install
-      - run:
-          name: rake build
-          command: rake build
-      - run:
-          name: setup API key
-          command: |
-            mkdir -p ~/.gem/
-            echo "---" > ~/.gem/credentials
-            echo ":rubygems_api_key: $RUBYGEMS_API_KEY" >> ~/.gem/credentials
-            chmod 600 ~/.gem/credentials
-      - run:
-          name: Check Puppeteer::version
-          command: bundle exec ruby -e 'raise "invalid Puppeteer::VERSION" unless Puppeteer::VERSION == ENV["CIRCLE_TAG"]'
-      - run:
-          name: gem push
-          command: gem push pkg/puppeteer-ruby-$CIRCLE_TAG.gem
-
-workflows:
-  ci:
-    jobs:
-      - rspec_chrome_ruby2_6
-      - rspec_chrome_ruby2_7
-      - rspec_chrome_ruby3_0
-      - rspec_firefox
-  rubygems-deploy:
-    jobs:
-      - deploy:
-          filters:
-            tags:
-              only: /^[0-9]\.[0-9]+\.[0-9].*/
-            branches:
-              ignore: /.*/