playwright-ruby-client 1.14.beta3 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88c8fbe4451b00ed8eba172f656e0171fb2580d555eefb4d2aa0cc1a13f86fc4
-  data.tar.gz: 3d307147cc4a23356d561f9528ef95343984bf4623ad77ebb6e479ce4f4f9462
+  metadata.gz: d6f164b2d4296ab3f30bfb22cd5fbec86ab522df916913ab19731dd452c55efa
+  data.tar.gz: 56371e88f29c8a7e7e398582a7cda693f45d8ebbb5bf6ce6e3fa0e748a2175bc
 SHA512:
-  metadata.gz: 647702705f820c268e5b858a1cd587b0e8f32f16415df2fd7b91505a221cadc20400fc9f2db188964fe4759f4734c8b30bc15c265434d2ac2b78e0683228c192
-  data.tar.gz: b4af0552e547d28be8c9390441bb7131d61fcea36fb5d3d293fd6985d6b47d3925e1c3bf27aa5f4e59243fc03ad751355acc20cb4e63b6e7489c47abb55b1864
+  metadata.gz: d97fd45d76a1cf4202be4aae7527974b01d8f90fd1de5e4fb4ed1267d3d3eeb601d5dddc49eb70559688c6bc816df82bc8c667e6aec7d2226ce078a2e0182a25
+  data.tar.gz: 602c97a88eb16aab95590391ae26f7ba777904668d4e270e3e24fe05122606d3f23d68901e529bb28b23a91458cdf7ce165de0c87621e0ad4ef9f8a711ccaf5f

data/documentation/docs/api/element_handle.md

@@ -641,12 +641,11 @@ become visible/hidden). If at the moment of calling the method `selector` alread
 will return immediately. If the selector doesn't satisfy the condition for the `timeout` milliseconds, the function will
 throw.
 
-```python sync title=example_3b0f6c6573db513b7b707a39d6c5bbf5ce5896b4785466d80f525968cfbd0be7.py
-page.set_content("<div><span></span></div>")
+```ruby
+page.content = "<div><span></span></div>"
 div = page.query_selector("div")
 # waiting for the "span" selector relative to the div.
-span = div.wait_for_selector("span", state="attached")
-
+span = div.wait_for_selector("span", state: "attached")
 ```
 
 > NOTE: This method does not work across navigations, use [Page#wait_for_selector](./page#wait_for_selector) instead.

data/documentation/docs/api/locator.md

@@ -7,10 +7,9 @@ sidebar_position: 10
 Locator represents a view to the element(s) on the page. It captures the logic sufficient to retrieve the element at any
 given moment. Locator can be created with the [Page#locator](./page#locator) method.
 
-```python sync title=example_9f72eed0cd4b2405e6a115b812b36ff2624e889f9086925c47665333a7edabbc.py
+```ruby
 locator = page.locator("text=Submit")
-locator.click()
-
+locator.click
 ```
 
 The difference between the Locator and [ElementHandle](./element_handle) is that the latter points to a particular element, while Locator
@@ -72,10 +71,12 @@ Elements from child frames return the bounding box relative to the main frame, u
 Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the following
 snippet should click the center of the element.
 
-```python sync title=example_4d635e937854fa2ee56b7c43151ded535940f0bbafc00cf48e8214bed86715eb.py
-box = element.bounding_box()
-page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)
-
+```ruby
+box = element.bounding_box
+page.mouse.click(
+  box["x"] + box["width"] / 2,
+  box["y"] + box["height"] / 2,
+)
 ```
 
 
@@ -177,9 +178,8 @@ The snippet below dispatches the `click` event on the element. Regardless of the
 `click` is dispatched. This is equivalent to calling
 [element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
 
-```python sync title=example_8d92b900a98c237ffdcb102ddc35660e37101bde7d107dc64d97a7edeed62a43.py
+```ruby
 element.dispatch_event("click")
-
 ```
 
 Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit` properties
@@ -196,11 +196,10 @@ Since `eventInit` is event-specific, please refer to the events documentation fo
 
 You can also specify [JSHandle](./js_handle) as the property value if you want live objects to be passed into the event:
 
-```python sync title=example_e369442a3ff291ab476da408ef63a63dacf47984dc766ff7189d82008ae2848b.py
+```ruby
 # note you can only create data_transfer in chromium and firefox
 data_transfer = page.evaluate_handle("new DataTransfer()")
-element.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})
-
+element.dispatch_event("dragstart", eventInit: { dataTransfer: data_transfer })
 ```
 
 
@@ -236,10 +235,9 @@ If `expression` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web
 
 Examples:
 
-```python sync title=example_df39b3df921f81e7cfb71cd873b76a5e91e46b4aa41e1f164128cb322aa38305.py
-tweets = page.locator(".tweet .retweets")
-assert tweets.evaluate("node => node.innerText") == "10 retweets"
-
+```ruby
+tweet = page.query_selector(".tweet .retweets")
+tweet.evaluate("node => node.innerText") # => "10 retweets"
 ```
 
 
@@ -258,10 +256,9 @@ return its value.
 
 Examples:
 
-```python sync title=example_32478e941514ed28b6ac221e6d54b55cf117038ecac6f4191db676480ab68d44.py
+```ruby
 elements = page.locator("div")
-div_counts = elements("(divs, min) => divs.length >= min", 10)
-
+elements.evaluate_all("(divs, min) => divs.length >= min", arg: 10)
 ```
 
 
@@ -518,26 +515,18 @@ Returns the array of option values that have been successfully selected.
 
 Triggers a `change` and `input` event once all the provided options have been selected.
 
-```python sync title=example_2825b0a50091868d1ce3ea0752d94ba32d826d504c1ac6842522796ca405913e.py
+```ruby
 # single selection matching the value
-element.select_option("blue")
+element.select_option(value: "blue")
 # single selection matching both the label
-element.select_option(label="blue")
+element.select_option(label: "blue")
 # multiple selection
-element.select_option(value=["red", "green", "blue"])
-
+element.select_option(value: ["red", "green", "blue"])
 ```
 
-```python sync title=example_3aaff4985dc38e64fad34696c88a6a68a633e26aabee6fc749125f3ee1784e34.py
-# single selection matching the value
-element.select_option("blue")
-# single selection matching both the value and the label
-element.select_option(label="blue")
-# multiple selection
-element.select_option("red", "green", "blue")
+```ruby
 # multiple selection for blue, red and second option
-element.select_option(value="blue", { index: 2 }, "red")
-
+element.select_option(value: "blue", index: 2, label: "red")
 ```
 
 
@@ -607,19 +596,17 @@ Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup`
 
 To press a special key, like `Control` or `ArrowDown`, use [Locator#press](./locator#press).
 
-```python sync title=example_fa1712c0b6ceb96fcaa74790d33f2c2eefe2bd1f06e61b78e0bb84a6f22c7961.py
+```ruby
 element.type("hello") # types instantly
-element.type("world", delay=100) # types slower, like a user
-
+element.type("world", delay: 100) # types slower, like a user
 ```
 
 An example of typing into a text field and then submitting the form:
 
-```python sync title=example_adefe90dee78708d4375c20f081f12f2b71f2becb472a2e0d4fdc8cc49c37809.py
+```ruby
 element = page.locator("input")
 element.type("some text")
 element.press("Enter")
-
 ```
 
 

data/documentation/docs/api/worker.md

@@ -8,17 +8,18 @@ The Worker class represents a [WebWorker](https://developer.mozilla.org/en-US/do
 event is emitted on the page object to signal a worker creation. `close` event is emitted on the worker object when the
 worker is gone.
 
-```py title=example_29716fdd4471a97923a64eebeee96330ab508226a496ae8fd13f12eb07d55ee6.py
-def handle_worker(worker):
-    print("worker created: " + worker.url)
-    worker.on("close", lambda: print("worker destroyed: " + worker.url))
-
-page.on('worker', handle_worker)
-
-print("current workers:")
-for worker in page.workers:
-    print("    " + worker.url)
-
+```ruby
+def handle_worker(worker)
+  puts "worker created: #{worker.url}"
+  worker.once("close", -> (w) { puts "worker destroyed: #{w.url}" })
+end
+
+page.on('worker', method(:handle_worker))
+
+puts "current workers:"
+page.workers.each do |worker|
+  puts "    #{worker.url}"
+end
 ```
 
 

data/documentation/docs/article/guides/inspector.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 7
 ---
 
 # Playwright inspector

data/documentation/docs/article/guides/playwright_on_alpine_linux.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 7
+sidebar_position: 8
 ---
 
 # Playwright on Alpine Linux

data/documentation/docs/article/guides/semi_automation.md

@@ -10,7 +10,7 @@ This allow us to intermediate into automation, for example
 * Authenticate with OAuth2 manually before automation
 * Testing a page after some chrome extensions are installed manually
 
-Keep in mind repeatedly that persistent browser context is NOT RECOMMENDED for most cases because it would bring many side effects.
+Keep in mind repeatedly that persistent browser context is NOT RECOMMENDED for most cases because it would bring many side effects. Consider [reusing cookie and local storage](./use_storage_state) when you just want to keep authenticated across browser contexts.
 
 ## Pause automation for manual operation
 

data/documentation/docs/article/guides/use_storage_state.md

@@ -0,0 +1,78 @@
+---
+sidebar_position: 6
+---
+
+# Reuse Cookie and LocalStorage
+
+In most cases, authentication state is stored in cookie or local storage. When we just want to keep authenticated, it is a good solution to dump/load 'storage state' (= Cookie + LocalStorage).
+https://playwright.dev/docs/next/auth#reuse-authentication-state
+
+* Dump storage state using [BrowserContext#storage_state](/docs/api/browser_context#storage_state) with `path: /path/to/state.json`
+* Load storage state by specifying the parameter `storageState: /path/to/state.json` into [Browser#new_context](/docs/api/browser#new_context) or [Browser#new_page](/docs/api/browser#new_page)
+
+## Example
+
+Generally in browser automation, it is very difficult to bypass 2FA or reCAPTCHA in login screen. In such cases, we would consider
+
+* Authenticate manually by hand
+* Resume automation with the authentication result
+
+
+```ruby {16,21}
+require 'playwright'
+require 'pry'
+
+force_login = !File.exist?('github_state.json')
+
+Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
+  if force_login
+    # Use headful mode for manual operation.
+    playwright.chromium.launch(headless: false, channel: 'chrome') do |browser|
+      page = browser.new_page
+      page.goto('https://github.com/login')
+
+      # Login manually.
+      binding.pry
+
+      page.context.storage_state(path: 'github_state.json')
+    end
+  end
+
+  playwright.chromium.launch do |browser|
+    page = browser.new_page(storageState: 'github_state.json')
+    page.goto('https://github.com/notifications')
+    page.screenshot(path: 'github_notification.png')
+  end
+end
+```
+
+When we execute this script at the first time (without github_state.json), login screen is shown:
+
+![login screen is shown](https://user-images.githubusercontent.com/11763113/129394130-7a248f6a-56f0-40b0-a4dd-f0f65d71b3a9.png)
+
+and input credentials manually:
+
+![input credentials manually](https://user-images.githubusercontent.com/11763113/129394155-fccc280e-5e6b-46c7-8a4d-a99d7db02c7f.png)
+
+and hit `exit` in Pry console.
+
+```
+
+     9:
+    10:     # Login manually. Hit `exit` in Pry console after authenticated.
+    11:     require 'pry'
+    12:     binding.pry
+    13:
+ => 14:     page.context.storage_state(path: 'github_state.json')
+    15:   end if force_login
+    16:
+    17:   playwright.chromium.launch do |browser|
+    18:     page = browser.new_page(storageState: 'github_state.json')
+    19:     page.goto('https://github.com/notifications')
+
+[1] pry(main)> exit
+```
+
+then we can enjoy automation with keeping authenticated. Login screen is never shown until github_state.json is deleted :)
+
+![github_notification.png](https://user-images.githubusercontent.com/11763113/129394879-838797eb-135f-41ab-b965-8d6fabde6109.png)

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.14.beta3'
+  VERSION = '1.14.0'
   COMPATIBLE_PLAYWRIGHT_VERSION = '1.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.14.beta3
+  version: 1.14.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -250,6 +250,7 @@ files:
 - documentation/docs/article/guides/rails_integration.md
 - documentation/docs/article/guides/recording_video.md
 - documentation/docs/article/guides/semi_automation.md
+- documentation/docs/article/guides/use_storage_state.md
 - documentation/docs/include/api_coverage.md
 - documentation/docusaurus.config.js
 - documentation/package.json
@@ -371,9 +372,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.22
 signing_key: