puppeteer-ruby 0.0.23 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 133c14dccb0da46cc01bff747bb2e36c1de1f7619ee4a8a898e798b3eb3947af
-  data.tar.gz: a7cc95948ddef2b45cc3b4a8faa82497334daeb1e47d92c97a7cbcbf9dccd887
+  metadata.gz: 2b852a48cd11f269c3b4eec0a85583b120a5cd1b0bc204e27a6ec0e365aa33dd
+  data.tar.gz: 8864c21fe02f6e3fcbb07c6c009516e91273ecfe0636437bc41015187e9985ad
 SHA512:
-  metadata.gz: de40a672ecbf7089e43463497bd877ed671e366ae022d6224bef0068c9ecbc5a949d4649454348af8d9823abf0e0effe84255ce3e73f8bd6f13c2d4ce2dd514e
-  data.tar.gz: 96821b3ec521338f6c2a08c31a65113acb1aa808e1f50b9fece78bcdcc19cb6f4072b2dd6d778a5a413f47733b1efa7d3f9ded85fdd0e0dce6c1729f53be47ab
+  metadata.gz: dd3cdb6d7b64b0b6f6e2568eb83cad62f36ea45943f0df9cd434c6e30221ccd47b161a0368cbe02cacf4a6a3c6c6ecf293bd1313829d7f02daed5d1d2c5c9f73
+  data.tar.gz: 541c2dffa4c6359dff6c2d9d03e70a039057d554c1ee6509d0574d194f17a6407a968c30153bae850f8c4c0e9fa7ade7beaea2dcc8d136a896e80b22831a436f

data/.circleci/config.yml

@@ -1,30 +1,41 @@
 version: 2.1
-orbs:
-  ruby: circleci/ruby@0.1.2
+
+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:
+  rspec_chrome_ruby2_6:
     docker:
       - image: circleci/ruby:2.6.6-buster-node-browsers
-    executor: ruby/default
-    steps:
-      - checkout
-      - ruby/bundle-install
-      - run:
-          name: rspec
-          command: |
-            DEBUG=1 bundle exec rspec --profile 10 \
-              --format RspecJunitFormatter \
-              --out test_results/rspec.xml \
-              --format documentation
+    <<: *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.6.6-buster-node-browsers
-    executor: ruby/default
+      - image: circleci/ruby:2.7.2-buster-node-browsers
     steps:
       - checkout
-      - ruby/bundle-install
+      - run:
+          command: gem install bundler:2.2.3 && bundle install
       - run:
           name: install firefox-nightly
           command: |
@@ -43,13 +54,10 @@ jobs:
   deploy:
     docker:
       - image: circleci/ruby:2.6.3-stretch-node
-    executor: ruby/default
     steps:
       - checkout
       - run:
-          name: Which bundler?
-          command: bundle -v
-      - ruby/bundle-install
+          command: gem install bundler:2.2.3 && bundle install
       - run:
           name: rake build
           command: rake build
@@ -70,7 +78,9 @@ jobs:
 workflows:
   ci:
     jobs:
-      - rspec
+      - rspec_chrome_ruby2_6
+      - rspec_chrome_ruby2_7
+      - rspec_chrome_ruby3_0
       - rspec_firefox
   rubygems-deploy:
     jobs:

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,17 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Step To Reproduce / Observed behavior
+
+
+### Expected behavior
+
+### Environment
+
+Paste the output of `ruby --version`

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Request a new feature for playwright-ruby-client
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Simple description about the feature
+
+
+### Usecase / Motivation
+
+<!-- Describe why the feature helps. -->

data/.github/workflows/docs.yml

@@ -16,12 +16,12 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.6
+          ruby-version: 2.7
 
       - name: Install dependencies
         run: |
           gem uninstall bundler
-          gem install bundler -v 1.17
+          gem install bundler -v 2.2.3
           bundle install
 
       - name: Deploy Configuration

data/.github/workflows/reviewdog.yml

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

data/CHANGELOG.md

@@ -0,0 +1,88 @@
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.29.0...master)]
+
+* xxx
+
+### 0.29.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.28.1...0.29.0)]
+
+New features:
+
+* Add `AriaQueryHandler`. Now we can use "aria/...." for selectors.
+
+
+### 0.28.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.27...0.28.1)]
+
+New features:
+
+* Add `Page#emulate_idle_state`
+* Change versioning rule.
+
+### 0.0.27 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.26...0.0.27)]
+
+New features:
+
+* Now puppeteer-ruby is Ruby 3.0 compatible!
+
+### 0.0.26 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.25...0.0.26)]
+
+Bugfix:
+
+* Fix `Page#screenshot` working correctly with `quality` parameter.
+
+### 0.0.25 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.23...0.0.25)]
+
+New feature:
+
+* **Cookie** feature: `Page#set_cookie`, `Page#cookies`
+
+### 0.0.23 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.22...0.0.23)]
+
+New feature:
+
+* **GeoLocation** feature
+* grant/clear permission
+
+Bugfix/Improvement:
+
+* Refactoring for events ([#31](https://github.com/YusukeIwaki/puppeteer-ruby/pull/31))
+* Improve SEND/RECV handling in CDPSession ([#34](https://github.com/YusukeIwaki/puppeteer-ruby/pull/34))
+
+### 0.0.22 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.21...0.0.22)]
+
+Bugfix
+
+* Make `Puppeteer#default_args` to work
+* Respect Firefox launch options
+* Respect `default_viewport: nil`
+
+### 0.0.21 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.20...0.0.21)]
+
+Bugfix/Improvement:
+
+* Update DeviceDescriptors (list of emulatable devices)
+* Fix bug on inputing "(" ([#25](https://github.com/YusukeIwaki/puppeteer-ruby/pull/25))
+
+### 0.0.20 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.19...0.0.20)]
+
+New feature
+
+* Dialog-handling feature
+
+### 0.0.19 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.18...0.0.19)]
+
+New feature
+
+* **Firefox support**
+
+Bugfix/Improvement
+
+* Allow `Page#keyboard` with block ([#18](https://github.com/YusukeIwaki/puppeteer-ruby/pull/18))
+
+### 0.0.18 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.17...0.0.18)]
+
+New feature
+
+* **Firefox support**
+
+Bugfix/Improvement
+
+* Allow `Page#keyboard` with block ([#18](https://github.com/YusukeIwaki/puppeteer-ruby/pull/18))

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM circleci/ruby:2.6.6-buster-node-browsers
+FROM circleci/ruby:3.0.0-rc1-buster-node-browsers
 
 USER root
 

data/README.md

@@ -1,15 +1,31 @@
 [![Gem Version](https://badge.fury.io/rb/puppeteer-ruby.svg)](https://badge.fury.io/rb/puppeteer-ruby)
 
-# Puppeteer in Ruby [UNDER HEAVY DEVELOPMENT]
+# Puppeteer in Ruby
 
 A Ruby port of [puppeteer](https://pptr.dev/).
 
 ![logo](puppeteer-ruby.png)
 
-REMARK: This Gem is NOT production-ready!!
+REMARK: This Gem covers just a part of Puppeteer APIs. Feedbacks and feature requests are welcome :)
 
 ## Getting Started
 
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puppeteer-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puppeteer-ruby
+
 ### Capture a site
 
 ```ruby

data/lib/puppeteer.rb

@@ -19,12 +19,14 @@ require 'puppeteer/event_callbackable'
 require 'puppeteer/if_present'
 
 # Classes & values.
+require 'puppeteer/aria_query_handler'
 require 'puppeteer/browser'
 require 'puppeteer/browser_context'
 require 'puppeteer/browser_runner'
 require 'puppeteer/cdp_session'
 require 'puppeteer/connection'
 require 'puppeteer/console_message'
+require 'puppeteer/custom_query_handler'
 require 'puppeteer/devices'
 require 'puppeteer/dialog'
 require 'puppeteer/dom_world'
@@ -41,6 +43,7 @@ require 'puppeteer/lifecycle_watcher'
 require 'puppeteer/mouse'
 require 'puppeteer/network_manager'
 require 'puppeteer/page'
+require 'puppeteer/query_handler_manager'
 require 'puppeteer/remote_object'
 require 'puppeteer/request'
 require 'puppeteer/response'

data/lib/puppeteer/aria_query_handler.rb

@@ -0,0 +1,71 @@
+class Puppeteer::AriaQueryHandler
+  private def normalize(value)
+    value.gsub(/ +/, ' ').strip
+  end
+
+  # @param selector [String]
+  private def parse_aria_selector(selector)
+    known_attributes = %w(name role)
+    query_options = {}
+    attribute_regexp = /\[\s*(?<attribute>\w+)\s*=\s*"(?<value>\\.|[^"\\]*)"\s*\]/
+    default_name = selector.gsub(attribute_regexp) do
+      attribute = $1.strip
+      value = $2
+      unless known_attributes.include?(attribute)
+        raise ArgumentError.new("Unkown aria attribute \"#{attribute}\" in selector")
+      end
+      query_options[attribute.to_sym] = normalize(value)
+      ''
+    end
+
+    if default_name.length > 0
+      query_options[:name] ||= normalize(default_name)
+    end
+
+    query_options
+  end
+
+  def query_one(element, selector)
+    context = element.execution_context
+    parse_result = parse_aria_selector(selector)
+    res = element.query_ax_tree(accessible_name: parse_result[:name], role: parse_result[:role])
+    if res.empty?
+      nil
+    else
+      context.adopt_backend_node_id(res.first['backendDOMNodeId'])
+    end
+  end
+
+  def wait_for(dom_world, selector, visible: nil, hidden: nil, timeout: nil)
+    binding_function = Puppeteer::DOMWorld::BindingFunction.new(
+      name: 'ariaQuerySelector',
+      proc: -> (selector) { query_one(dom_world.send(:document), selector) },
+    )
+    dom_world.send(:wait_for_selector_in_page,
+      '(_, selector) => globalThis.ariaQuerySelector(selector)',
+      selector,
+      visible: visible,
+      hidden: hidden,
+      timeout: timeout,
+      binding_function: binding_function)
+  end
+
+  def query_all(element, selector)
+    context = element.execution_context
+    parse_result = parse_aria_selector(selector)
+    res = element.query_ax_tree(accessible_name: parse_result[:name], role: parse_result[:role])
+    if res.empty?
+      nil
+    else
+      promises = res.map do |ax_node|
+        context.send(:async_adopt_backend_node_id, ax_node['backendDOMNodeId'])
+      end
+      await_all(*promises)
+    end
+  end
+
+  def query_all_array(element, selector)
+    element_handles = query_all(element, selector)
+    element.execution_context.evaluate_handle('(...elements) => elements', *element_handles)
+  end
+end

data/lib/puppeteer/browser.rb

@@ -36,7 +36,6 @@ class Puppeteer::Browser
     @ignore_https_errors = ignore_https_errors
     @default_viewport = default_viewport
     @process = process
-    # @screenshot_task_queue = TaskQueue.new
     @connection = connection
     @close_callback = close_callback
 
@@ -125,7 +124,6 @@ class Puppeteer::Browser
       session_factory: -> { @connection.create_session(target_info) },
       ignore_https_errors: @ignore_https_errors,
       default_viewport: @default_viewport,
-      screenshot_task_queue: @screenshot_task_queue,
     )
     #   assert(!this._targets.has(event.targetInfo.targetId), 'Target should not exist before targetCreated');
     @targets[target_info.target_id] = target

data/lib/puppeteer/concurrent_ruby_utils.rb

@@ -39,9 +39,12 @@ module Puppeteer::ConcurrentRubyUtils
     end
   end
 
-  def future(&block)
-    Concurrent::Promises.future do
-      block.call
+  def future(*args, &block)
+    Concurrent::Promises.future(*args) do |*block_args|
+      block.call(*block_args)
+    rescue Puppeteer::TimeoutError
+      # suppress error logging
+      raise
     rescue => err
       Logger.new($stderr).warn(err)
       raise err

data/lib/puppeteer/custom_query_handler.rb

@@ -0,0 +1,51 @@
+class Puppeteer::CustomQueryHandler
+  # @param query_one [String] JS function (element: Element | Document, selector: string) => Element | null;
+  # @param query_all [String] JS function (element: Element | Document, selector: string) => Element[] | NodeListOf<Element>;
+  def initialize(query_one: nil, query_all: nil)
+    @query_one = query_one
+    @query_all = query_all
+  end
+
+  def query_one(element, selector)
+    unless @query_one
+      raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
+    end
+
+    handle = element.evaluate_handle(@query_one, selector)
+    element = handle.as_element
+
+    if element
+      return element
+    end
+    handle.dispose
+    nil
+  end
+
+  def wait_for(dom_world, selector, visible: nil, hidden: nil, timeout: nil)
+    unless @query_one
+      raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
+    end
+
+    dom_world.send(:wait_for_selector_in_page, @query_one, selector, visible: visible, hidden: hidden, timeout: timeout)
+  end
+
+  def query_all(element, selector)
+    unless @query_all
+      raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
+    end
+
+    handles = element.evaluate_handle(@query_all, selector)
+    properties = handles.properties
+    handles.dispose
+    properties.values.map(&:as_element).compact
+  end
+
+  def query_all_array(element, selector)
+    unless @query_all
+      raise NotImplementedError.new("#{self.class}##{__method__} is not implemented.")
+    end
+
+    handles = element.evaluate_handle(@query_all, selector)
+    handles.evaluate_handle('(res) => Array.from(res)')
+  end
+end