puppeteer-ruby 0.0.27 → 0.31.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f606d2715459bc7986833e68c8ab501e18f2b67473773daf9a65f1baa978db
-  data.tar.gz: 074e5845c7019ae74ea66b9284e7b76ea3deb5fe03bac1fc970c5c1ff3091ade
+  metadata.gz: 4c703eeb4952a1a5102ce3616daee3333747f37d790ad65efb8c1f95ac603f8b
+  data.tar.gz: 355cf71106ffce2576aea66680ff5fbb7f35b263da8abce5dd7056ff8fdca019
 SHA512:
-  metadata.gz: 20a9d1aba0853ea1dbc54786b752d814a6f1c7764d08cc8adc1d372db15e0875dc6cdc8ba474b44f1af5a0879f12d4138d9ebb9c06fbbaf7b85a8aaee62d7ac8
-  data.tar.gz: 37a24532b303653427a30c8f1cc505d99b2eaa999c3d5ca350fbb2bcabda520e2746edc8f43ec0f965b2628b75148466c1cb1d9e26854179c078f4c75f5a05cb
+  metadata.gz: bb2f9d778d6f99c510d78025dba4f39a22ce2cdc8bdb278b6a8911e3498ee94268237fe929a6a0473a7d94a6f8f3839ad43e76a2c2825a54eb9cbc824078a980
+  data.tar.gz: 4d40e88f6ec1476854673a3a49c8598e24c5a0bd1de65c4ee09e87ef85773d96b12b415e1f28352b096d3e0fa95ae1267c81fa8ca34f30deaa3fe4308bbd45e0

data/CHANGELOG.md

@@ -1,7 +1,42 @@
-### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.27...master)]
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.1...master)]
 
 * xxx
 
+### 0.31.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.31.0...0.31.1)]
+
+Bugfix:
+
+* Fix `Page#pdf` to work on Windows.
+
+### 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:

data/README.md

@@ -1,18 +1,36 @@
 [![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. See [API Coverage list](./docs/api_coverage.md) for detail. 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
+require 'puppeteer'
+
 Puppeteer.launch(headless: false) do |browser|
   page = browser.pages.first || browser.new_page
   page.goto("https://github.com/YusukeIwaki")
@@ -30,18 +48,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
@@ -50,6 +68,8 @@ end
 ### Evaluate JavaScript
 
 ```ruby
+require 'puppeteer'
+
 Puppeteer.launch do |browser|
   page = browser.pages.last || browser.new_page
   page.goto 'https://github.com/YusukeIwaki'
@@ -114,7 +134,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 +151,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/docs/api_coverage.md

@@ -0,0 +1,359 @@
+# API coverages
+- Puppeteer version: v8.0.0
+- puppeteer-ruby version: 0.31.1
+
+## Puppeteer
+
+* ~~clearCustomQueryHandlers~~
+* connect
+* ~~createBrowserFetcher~~
+* ~~customQueryHandlerNames~~
+* defaultArgs => `#default_args`
+* devices
+* ~~errors~~
+* executablePath => `#executable_path`
+* launch
+* ~~networkConditions~~
+* product
+* ~~registerCustomQueryHandler~~
+* ~~unregisterCustomQueryHandler~~
+
+## ~~BrowserFetcher~~
+
+* ~~canDownload~~
+* ~~download~~
+* ~~host~~
+* ~~localRevisions~~
+* ~~platform~~
+* ~~product~~
+* ~~remove~~
+* ~~revisionInfo~~
+
+## Browser
+
+* browserContexts => `#browser_contexts`
+* close
+* createIncognitoBrowserContext => `#create_incognito_browser_context`
+* defaultBrowserContext => `#default_browser_context`
+* disconnect
+* isConnected => `#connected?`
+* newPage => `#new_page`
+* pages
+* process
+* target
+* targets
+* userAgent => `#user_agent`
+* version
+* waitForTarget => `#wait_for_target`
+* wsEndpoint => `#ws_endpoint`
+
+## BrowserContext
+
+* browser
+* clearPermissionOverrides => `#clear_permission_overrides`
+* close
+* isIncognito => `#incognito?`
+* newPage => `#new_page`
+* overridePermissions => `#override_permissions`
+* pages
+* targets
+* waitForTarget => `#wait_for_target`
+
+## Page
+
+* $ => `#query_selector`
+* $$ => `#query_selector_all`
+* $$eval => `#eval_on_selector_all`
+* $eval => `#eval_on_selector`
+* $x => `#Sx`
+* accessibility
+* addScriptTag => `#add_script_tag`
+* addStyleTag => `#add_style_tag`
+* authenticate
+* ~~bringToFront~~
+* browser
+* browserContext => `#browser_context`
+* click
+* close
+* content
+* cookies
+* coverage
+* deleteCookie => `#delete_cookie`
+* emulate
+* emulateIdleState => `#emulate_idle_state`
+* ~~emulateMediaFeatures~~
+* emulateMediaType => `#emulate_media_type`
+* ~~emulateNetworkConditions~~
+* emulateTimezone => `#emulate_timezone`
+* ~~emulateVisionDeficiency~~
+* evaluate
+* evaluateHandle => `#evaluate_handle`
+* evaluateOnNewDocument => `#evaluate_on_new_document`
+* ~~exposeFunction~~
+* focus
+* frames
+* goBack => `#go_back`
+* goForward => `#go_forward`
+* goto
+* hover
+* isClosed => `#closed?`
+* isJavaScriptEnabled => `#javascript_enabled?`
+* keyboard
+* mainFrame => `#main_frame`
+* ~~metrics~~
+* mouse
+* pdf
+* queryObjects => `#query_objects`
+* reload
+* screenshot
+* select
+* setBypassCSP => `#bypass_csp=`
+* setCacheEnabled => `#cache_enabled=`
+* setContent => `#content=`
+* setCookie => `#set_cookie`
+* setDefaultNavigationTimeout => `#default_navigation_timeout=`
+* setDefaultTimeout => `#default_timeout=`
+* setExtraHTTPHeaders => `#extra_http_headers=`
+* setGeolocation => `#geolocation=`
+* setJavaScriptEnabled => `#javascript_enabled=`
+* setOfflineMode => `#offline_mode=`
+* setRequestInterception => `#request_interception=`
+* setUserAgent => `#user_agent=`
+* setViewport => `#viewport=`
+* tap
+* target
+* title
+* ~~touchscreen~~
+* ~~tracing~~
+* type => `#type_text`
+* url
+* viewport
+* ~~waitFor~~
+* waitForFileChooser => `#wait_for_file_chooser`
+* waitForFunction => `#wait_for_function`
+* waitForNavigation => `#async_wait_for_navigation`
+* waitForRequest => `#async_wait_for_request`
+* waitForResponse => `#async_wait_for_response`
+* waitForSelector => `#wait_for_selector`
+* waitForTimeout => `#wait_for_timeout`
+* waitForXPath => `#wait_for_xpath`
+* workers
+
+## ~~WebWorker~~
+
+* ~~evaluate~~
+* ~~evaluateHandle~~
+* ~~executionContext~~
+* ~~url~~
+
+## ~~Accessibility~~
+
+* ~~snapshot~~
+
+## Keyboard
+
+* down
+* press
+* sendCharacter => `#send_character`
+* type => `#type_text`
+* up
+
+## Mouse
+
+* click
+* down
+* move
+* up
+* wheel
+
+## ~~Touchscreen~~
+
+* ~~tap~~
+
+## ~~Tracing~~
+
+* ~~start~~
+* ~~stop~~
+
+## FileChooser
+
+* accept
+* cancel
+* isMultiple => `#multiple?`
+
+## Dialog
+
+* accept
+* defaultValue => `#default_value`
+* dismiss
+* message
+* type
+
+## ConsoleMessage
+
+* args
+* location
+* ~~stackTrace~~
+* text
+* ~~type~~
+
+## Frame
+
+* $ => `#query_selector`
+* $$ => `#query_selector_all`
+* $$eval => `#eval_on_selector_all`
+* $eval => `#eval_on_selector`
+* $x => `#Sx`
+* addScriptTag => `#add_script_tag`
+* addStyleTag => `#add_style_tag`
+* childFrames => `#child_frames`
+* click
+* content
+* evaluate
+* evaluateHandle => `#evaluate_handle`
+* executionContext => `#execution_context`
+* focus
+* goto
+* hover
+* isDetached => `#detached?`
+* name
+* parentFrame => `#parent_frame`
+* select
+* setContent => `#set_content`
+* tap
+* title
+* type => `#type_text`
+* url
+* ~~waitFor~~
+* waitForFunction => `#wait_for_function`
+* waitForNavigation => `#async_wait_for_navigation`
+* waitForSelector => `#wait_for_selector`
+* waitForTimeout => `#wait_for_timeout`
+* waitForXPath => `#wait_for_xpath`
+
+## ExecutionContext
+
+* evaluate
+* evaluateHandle => `#evaluate_handle`
+* frame
+* ~~queryObjects~~
+
+## JSHandle
+
+* asElement => `#as_element`
+* dispose
+* evaluate
+* evaluateHandle => `#evaluate_handle`
+* executionContext => `#execution_context`
+* getProperties => `#properties`
+* getProperty => `#[]`
+* jsonValue => `#json_value`
+
+## ElementHandle
+
+* $ => `#query_selector`
+* $$ => `#query_selector_all`
+* $$eval => `#eval_on_selector_all`
+* $eval => `#eval_on_selector`
+* $x => `#Sx`
+* asElement => `#as_element`
+* boundingBox => `#bounding_box`
+* boxModel => `#box_model`
+* click
+* contentFrame => `#content_frame`
+* dispose
+* evaluate
+* evaluateHandle => `#evaluate_handle`
+* executionContext => `#execution_context`
+* focus
+* getProperties => `#properties`
+* getProperty => `#[]`
+* hover
+* isIntersectingViewport => `#intersecting_viewport?`
+* jsonValue => `#json_value`
+* press
+* screenshot
+* select
+* tap
+* ~~toString~~
+* type => `#type_text`
+* uploadFile => `#upload_file`
+
+## ~~HTTPRequest~~
+
+* ~~abort~~
+* ~~continue~~
+* ~~failure~~
+* ~~frame~~
+* ~~headers~~
+* ~~isNavigationRequest~~
+* ~~method~~
+* ~~postData~~
+* ~~redirectChain~~
+* ~~resourceType~~
+* ~~respond~~
+* ~~response~~
+* ~~url~~
+
+## ~~HTTPResponse~~
+
+* ~~buffer~~
+* ~~frame~~
+* ~~fromCache~~
+* ~~fromServiceWorker~~
+* ~~headers~~
+* ~~json~~
+* ~~ok~~
+* ~~remoteAddress~~
+* ~~request~~
+* ~~securityDetails~~
+* ~~status~~
+* ~~statusText~~
+* ~~text~~
+* ~~url~~
+
+## ~~SecurityDetails~~
+
+* ~~issuer~~
+* ~~protocol~~
+* ~~subjectAlternativeNames~~
+* ~~subjectName~~
+* ~~validFrom~~
+* ~~validTo~~
+
+## Target
+
+* browser
+* browserContext => `#browser_context`
+* createCDPSession => `#create_cdp_session`
+* opener
+* page
+* type
+* url
+* ~~worker~~
+
+## CDPSession
+
+* detach
+* send
+
+## ~~Coverage~~
+
+* ~~startCSSCoverage~~
+* ~~startJSCoverage~~
+* ~~stopCSSCoverage~~
+* ~~stopJSCoverage~~
+
+## TimeoutError
+
+
+## ~~EventEmitter~~
+
+* ~~addListener~~
+* ~~emit~~
+* ~~listenerCount~~
+* ~~off~~
+* ~~on~~
+* ~~once~~
+* ~~removeAllListeners~~
+* ~~removeListener~~