puppeteer-ruby 0.0.26 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f76be710be28b32694ef8d21bcaa305f00b8ac0ada333d2992137f166614bd94
-  data.tar.gz: 29d4c83aaa00705db67dd1a33b62b304b125fc59bd5f826099a9f864202f3e00
+  metadata.gz: 0d7c0b6410629e9119a7f298cc3cecdd6e5640a18fdb944dc53e1b47b4c940b0
+  data.tar.gz: 4f9bf8f3e4a21a22cb89fcff1927e420bff86cbdec4a3084dbec32669530f03e
 SHA512:
-  metadata.gz: f5dbf6ee744fdb70d7645bdfaf3840088d756b31a0dfcf05109058299d07ea338967c019ee4a55f834bc388b39cfc19b147ac7f08d80762d5eb44ed8517d0f1a
-  data.tar.gz: 05a88198b74788638619bbdef3faaede3503c61a5b6574a562180265f5f927a236a564b3f0d73dfefcaa442b492227b934f7233ad72183924b98d66e242e4850
+  metadata.gz: a13874bd8b09ea00a33516f1237e3a91fcfa6b18795af251f3568dc421f026821325c2e89d2e2ee8e8211b03ed1700d8ba15c3a2d01e733ffaa378a1f97b02bc
+  data.tar.gz: 3920af1f121788b36e68ee85194da1fe92335abed949610f726d90bd368d492502da10d935087bbadb386eab13f41f259263dd7777eb42d8988fecc3e1fa83da

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

@@ -7,9 +7,12 @@ jobs:
     steps:
       - name: Check out code
         uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
       - name: rubocop
         uses: reviewdog/action-rubocop@v1
         with:
           github_token: ${{ secrets.github_token }}
           reporter: github-pr-review
-          rubocop_version: 0.90.0
+          rubocop_version: 1.11.0

data/.github/workflows/windows_check.yml

@@ -0,0 +1,40 @@
+name: Windows check
+on: [pull_request]
+jobs:
+  windows_edge_rspec:
+    name: RSpec on Windows / Edge
+    runs-on: windows-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+      - name: Install dependencies
+        run: |
+          gem uninstall bundler
+          gem install bundler -v 2.2.3
+          bundle install
+      - uses: browser-actions/setup-edge@latest
+      - name: Check example
+        run: bundle exec rspec spec/integration/example_spec.rb
+        env:
+          PUPPETEER_EXECUTABLE_PATH_RSPEC: 'C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe'
+
+  windows_chrome_rspec:
+    name: RSpec on Windows / Chrome
+    runs-on: windows-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+      - name: Install dependencies
+        run: |
+          gem uninstall bundler
+          gem install bundler -v 2.2.3
+          bundle install
+      - uses: browser-actions/setup-chrome@latest
+      - name: Check example
+        run: bundle exec rspec spec/integration/example_spec.rb

data/.gitignore

@@ -17,3 +17,5 @@
 # RubyMine
 /.idea/
 /.rakeTasks
+
+diff-*.png

data/CHANGELOG.md

@@ -1,7 +1,48 @@
-### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.25...master)]
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.0...master)]
 
 * xxx
 
+### 0.31.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.30.0...0.31.0)]
+
+New features:
+
+* Now puppeteer-ruby is compatible with Windows
+
+Bugfix:
+
+* Fix `Page#add_script_tag` and `Page#add_style_tag` to work
+
+### 0.30.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.29.0...0.30.0)]
+
+New features:
+
+* S, SS, Seval, SSeval is renamed to query_selector, query_selector_all, eval_on_selector, eval_on_selector_all
+
+### 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:

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
@@ -30,18 +46,18 @@ Puppeteer.launch(headless: false, slow_mo: 50, args: ['--guest', '--window-size=
   page.viewport = Puppeteer::Viewport.new(width: 1280, height: 800)
   page.goto("https://github.com/", wait_until: 'domcontentloaded')
 
-  form = page.S("form.js-site-search-form")
-  searchInput = form.S("input.header-search-input")
+  form = page.query_selector("form.js-site-search-form")
+  searchInput = form.query_selector("input.header-search-input")
   searchInput.type_text("puppeteer")
   await_all(
     page.async_wait_for_navigation,
     searchInput.async_press("Enter"),
   )
 
-  list = page.S("ul.repo-list")
-  items = list.SS("div.f4")
+  list = page.query_selector("ul.repo-list")
+  items = list.query_selector_all("div.f4")
   items.each do |item|
-    title = item.Seval("a", "a => a.innerText")
+    title = item.eval_on_selector("a", "a => a.innerText")
     puts("==> #{title}")
   end
 end
@@ -114,7 +130,7 @@ RSpec.describe 'hotel.testplanisphere.dev', type: :feature do
     puppeteer_page = @browser.pages.first
     puppeteer_page.wait_for_selector('li.nav-item')
 
-    reservation_link = puppeteer_page.SS('li.nav-item')[1]
+    reservation_link = puppeteer_page.query_selector_all('li.nav-item')[1]
 
     await_all(
       puppeteer_page.async_wait_for_navigation,
@@ -131,7 +147,7 @@ RSpec.describe 'hotel.testplanisphere.dev', type: :feature do
 
     # expectation with puppeteer
     puppeteer_page = @browser.pages.first
-    body_text = puppeteer_page.Seval('body', '(el) => el.textContent')
+    body_text = puppeteer_page.eval_on_selector('body', '(el) => el.textContent')
     expect(body_text).to include('宿泊プラン一覧')
   end
 ```

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_runner.rb

@@ -111,7 +111,7 @@ class Puppeteer::BrowserRunner
       end
     end
 
-    if @launch_options.handle_SIGHUP?
+    if @launch_options.handle_SIGHUP? && !Puppeteer.env.windows?
       trap(:HUP) do
         close
       end