playwright-ruby-client 0.6.1 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b365f47558ade3fcf3d803a070cbd61eb4eae6279f0d93c1641a53d9b50ec232
-  data.tar.gz: 353de7a190205c6d3d4542b3058afe24c0c634fe70811c15384b55d1cb464571
+  metadata.gz: 9b548b6927a468b4a1209e9002cc7ca6f20bf0ad7ad4091510336ed610d338bb
+  data.tar.gz: d8f5e411d5ee99460e77d3d922608996cde6de1a2199ee0f6425c7e3a5eb9a7b
 SHA512:
-  metadata.gz: ec905a5051716af754993c11b5a484e5bf69a9b50cdb6681f583869d0cf70d23eb3265507d6739b6d006fc8419360dea8570f6fae6fc3ac8fdd6d44ae3547fd8
-  data.tar.gz: cf06e3351a40457108080dea85af6c8e417ffda3bec6671f9280ad42bc5fde7e58cf039016fe11387a7cb3e1347e1391f1440d23c2e54e512ca70e39ba90db38
+  metadata.gz: 645bd780e189153fabc25de3a58b490ae5fb919c8ed9b81f701c8bed0e910483be9cb2c901bda8f4619153bb18924240ae43841b197479665883567980ffd29c
+  data.tar.gz: 50af6ab226985f5bd7a7631fab3959c4215a6bae7d57d32c5cd9787f7d43a8ed2bbe599443a611a9eafd73e7e8dd74ace7783781a95d04357d5a9ff4c4e69313

data/documentation/docs/api/browser.md

@@ -85,6 +85,7 @@ def new_context(
       record_har_path: nil,
       record_video_dir: nil,
       record_video_size: nil,
+      reducedMotion: nil,
       screen: nil,
       storageState: nil,
       timezoneId: nil,
@@ -132,11 +133,13 @@ def new_page(
       record_har_path: nil,
       record_video_dir: nil,
       record_video_size: nil,
+      reducedMotion: nil,
       screen: nil,
       storageState: nil,
       timezoneId: nil,
       userAgent: nil,
-      viewport: nil)
+      viewport: nil,
+      &block)
 ```
 
 Creates a new page in a new browser context. Closing this page will close the context as well.

data/documentation/docs/api/browser_context.md

@@ -131,8 +131,7 @@ The method adds a function called `name` on the `window` object of every frame i
 called, the function executes `callback` and returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) which resolves to the return value of `callback`. If
 the `callback` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), it will be awaited.
 
-The first argument of the `callback` function contains information about the caller: `{ browserContext: BrowserContext,
-page: Page, frame: Frame }`.
+The first argument of the `callback` function contains information about the caller: `{ browser_context: BrowserContext, page: Page, frame: Frame }`.
 
 See [Page#expose_binding](./page#expose_binding) for page-only version.
 
@@ -193,7 +192,7 @@ If the `callback` returns a [Promise](https://developer.mozilla.org/en-US/docs/W
 
 See [Page#expose_function](./page#expose_function) for page-only version.
 
-An example of adding an `sha256` function to all pages in the context:
+An example of adding a `sha256` function to all pages in the context:
 
 ```ruby
 require 'digest'
@@ -230,7 +229,7 @@ specified.
 ## new_page
 
 ```
-def new_page
+def new_page(&block)
 ```
 
 Creates a new page in the browser context.

data/documentation/docs/api/browser_type.md

@@ -65,7 +65,7 @@ def launch(
       proxy: nil,
       slowMo: nil,
       timeout: nil,
-      traceDir: nil,
+      tracesDir: nil,
       &block)
 ```
 
@@ -96,6 +96,59 @@ differences between Chromium and Chrome.
 [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md)
 describes some differences for Linux users.
 
+## launch_persistent_context
+
+```
+def launch_persistent_context(
+      userDataDir,
+      acceptDownloads: nil,
+      args: nil,
+      bypassCSP: nil,
+      channel: nil,
+      chromiumSandbox: nil,
+      colorScheme: nil,
+      deviceScaleFactor: nil,
+      devtools: nil,
+      downloadsPath: nil,
+      env: nil,
+      executablePath: nil,
+      extraHTTPHeaders: nil,
+      geolocation: nil,
+      handleSIGHUP: nil,
+      handleSIGINT: nil,
+      handleSIGTERM: nil,
+      hasTouch: nil,
+      headless: nil,
+      httpCredentials: nil,
+      ignoreDefaultArgs: nil,
+      ignoreHTTPSErrors: nil,
+      isMobile: nil,
+      javaScriptEnabled: nil,
+      locale: nil,
+      noViewport: nil,
+      offline: nil,
+      permissions: nil,
+      proxy: nil,
+      record_har_omit_content: nil,
+      record_har_path: nil,
+      record_video_dir: nil,
+      record_video_size: nil,
+      reducedMotion: nil,
+      screen: nil,
+      slowMo: nil,
+      timeout: nil,
+      timezoneId: nil,
+      tracesDir: nil,
+      userAgent: nil,
+      viewport: nil,
+      &block)
+```
+
+Returns the persistent browser context instance.
+
+Launches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing this
+context will automatically close the browser.
+
 ## name
 
 ```

data/documentation/docs/api/dialog.md

@@ -8,24 +8,21 @@ sidebar_position: 10
 
 An example of using [Dialog](./dialog) class:
 
-```python sync title=example_c954c35627e62be69e1f138f25d7377b13e18d08039d476946217827fa95db52.py
-from playwright.sync_api import sync_playwright
-
-def handle_dialog(dialog):
-    print(dialog.message)
-    dialog.dismiss()
-
-def run(playwright):
-    chromium = playwright.chromium
-    browser = chromium.launch()
-    page = browser.new_page()
-    page.on("dialog", handle_dialog)
-    page.evaluate("alert('1')")
-    browser.close()
-
-with sync_playwright() as playwright:
-    run(playwright)
-
+```ruby
+def handle_dialog(dialog)
+  puts "[#{dialog.type}] #{dialog.message}"
+  if dialog.message =~ /foo/
+    dialog.accept_async
+  else
+    dialog.dismiss
+  end
+end
+
+page.on("dialog", method(:handle_dialog))
+page.evaluate("confirm('foo')") # will be accepted
+# => [confirm] foo
+page.evaluate("alert('bar')") # will be dismissed
+# => [alert] bar
 ```
 
 > NOTE: Dialogs are dismissed automatically, unless there is a [`event: Page.dialog`] listener. When listener is

data/documentation/docs/api/element_handle.md

@@ -9,21 +9,11 @@ sidebar_position: 10
 ElementHandle represents an in-page DOM element. ElementHandles can be created with the [Page#query_selector](./page#query_selector)
 method.
 
-```python sync title=example_5ba38bdc5d9e5ce7cfc9c8841eb0176efbb4690d18962066f9ee67f1e8b7b050.py
-from playwright.sync_api import sync_playwright
-
-def run(playwright):
-    chromium = playwright.chromium
-    browser = chromium.launch()
-    page = browser.new_page()
-    page.goto("https://example.com")
-    href_element = page.query_selector("a")
-    href_element.click()
-    # ...
-
-with sync_playwright() as playwright:
-    run(playwright)
-
+```ruby
+page.goto("https://example.com")
+href_element = page.query_selector("a")
+href_element.click
+# ...
 ```
 
 ElementHandle prevents DOM element from garbage collection unless the handle is disposed with
@@ -51,10 +41,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_8382aa7cfb42a9a17e348e2f738279f1bd9a038f1ea35cc3cb244cc64d768f93.py
-box = element_handle.bounding_box()
-page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)
-
+```ruby
+box = element_handle.bounding_box
+page.mouse.click(
+  box["x"] + box["width"] / 2,
+  box["y"] + box["height"] / 2,
+)
 ```
 
 
@@ -156,9 +148,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_3b86add6ce355082cd43f4ac0ba9e69c15960bbd7ca601d0618355fe53aa8902.py
+```ruby
 element_handle.dispatch_event("click")
-
 ```
 
 Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit` properties
@@ -175,11 +166,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_6b70ea4cf0c7ae9c82cf0ed22ab0dbbb563e2d1419b35d04aa513cf91f0856f9.py
+```ruby
 # note you can only create data_transfer in chromium and firefox
 data_transfer = page.evaluate_handle("new DataTransfer()")
-element_handle.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})
-
+element_handle.dispatch_event("dragstart", eventInit: { dataTransfer: data_transfer })
 ```
 
 
@@ -201,11 +191,10 @@ and return its value.
 
 Examples:
 
-```python sync title=example_f6a83ec555fcf23877c11cf55f02a8c89a7fc11d3324859feda42e592e129f4f.py
+```ruby
 tweet_handle = page.query_selector(".tweet")
-assert tweet_handle.eval_on_selector(".like", "node => node.innerText") == "100"
-assert tweet_handle.eval_on_selector(".retweets", "node => node.innerText") = "10"
-
+tweet_handle.eval_on_selector(".like", "node => node.innerText") # => "100"
+tweet_handle.eval_on_selector(".retweets", "node => node.innerText") # => "10"
 ```
 
 
@@ -233,10 +222,9 @@ Examples:
 </div>
 ```
 
-```python sync title=example_11b54bf5ec18a0d0ceee0868651bb41ab5cd3afcc6b20d5c44f90d835c8d6f81.py
+```ruby
 feed_handle = page.query_selector(".feed")
-assert feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)") == ["hello!", "hi!"]
-
+feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)") # => ["hello!", "hi!"]
 ```
 
 
@@ -463,26 +451,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_dc2ce38846b91d234483ed8b915b785ffbd9403213279465acd6605f314fe736.py
+```ruby
 # single selection matching the value
-handle.select_option("blue")
+element_handle.select_option(value: "blue")
 # single selection matching both the label
-handle.select_option(label="blue")
+element_handle.select_option(label: "blue")
 # multiple selection
-handle.select_option(value=["red", "green", "blue"])
-
+element_handle.select_option(value: ["red", "green", "blue"])
 ```
 
-```python sync title=example_b4cdd4a1a4d0392c2d430e0fb5fc670df2d728b6907553650690a2d0377662e4.py
-# single selection matching the value
-handle.select_option("blue")
-# single selection matching both the value and the label
-handle.select_option(label="blue")
-# multiple selection
-handle.select_option("red", "green", "blue")
+```ruby
 # multiple selection for blue, red and second option
-handle.select_option(value="blue", { index: 2 }, "red")
-
+element_handle.select_option(value: "blue", index: 2, label: "red")
 ```
 
 
@@ -552,19 +532,17 @@ Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup`
 
 To press a special key, like `Control` or `ArrowDown`, use [ElementHandle#press](./element_handle#press).
 
-```python sync title=example_2dc9720467640fd8bc581ed65159742e51ff91b209cb176fef8b95f14eaad54e.py
+```ruby
 element_handle.type("hello") # types instantly
-element_handle.type("world", delay=100) # types slower, like a user
-
+element_handle.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_d13faaf53454653ce45371b5cf337082a82bf7bbb0aada7e97f47d14963bd6b0.py
+```ruby
 element_handle = page.query_selector("input")
 element_handle.type("some text")
 element_handle.press("Enter")
-
 ```
 
 

data/documentation/docs/api/experimental/android.md

@@ -4,14 +4,15 @@ sidebar_position: 10
 
 # Android
 
-Playwright has **experimental** support for Android automation. You can access android namespace via:
+Playwright has **experimental** support for Android automation. See [here](https://playwright.dev/python/docs/mobile) for more information. You can
+access android namespace via:
 
 An example of the Android automation script would be:
 
 Note that since you don't need Playwright to install web browsers when testing Android, you can omit browser download
 via setting the following environment variable when installing Playwright:
 
-```sh js
+```bash js
 PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
 ```
 

data/documentation/docs/api/experimental/android_device.md

@@ -47,6 +47,7 @@ def launch_browser(
       record_har_path: nil,
       record_video_dir: nil,
       record_video_size: nil,
+      reducedMotion: nil,
       screen: nil,
       timezoneId: nil,
       userAgent: nil,

data/documentation/docs/api/file_chooser.md

@@ -6,12 +6,11 @@ sidebar_position: 10
 
 [FileChooser](./file_chooser) objects are dispatched by the page in the [`event: Page.fileChooser`] event.
 
-```python sync title=example_371975841dd417527a865b1501e3a8ba40f905b895cf3317ca90d9890e980843.py
-with page.expect_file_chooser() as fc_info:
-    page.click("upload")
-file_chooser = fc_info.value
+```ruby
+file_chooser = page.expect_file_chooser do
+  page.click("upload") # action to trigger file uploading
+end
 file_chooser.set_files("myfile.pdf")
-
 ```
 
 

data/documentation/docs/api/frame.md

@@ -308,9 +308,8 @@ a_window_handle # handle for the window object.
 
 A string can also be passed in instead of a function.
 
-```python sync title=example_9daa37cfd3d747c9360d9544f64786bf49d291a6887b0efccc813215b62ae4c6.py
+```ruby
 a_handle = page.evaluate_handle("document") # handle for the "document"
-
 ```
 
 [JSHandle](./js_handle) instances can be passed as an argument to the [Frame#evaluate_handle](./frame#evaluate_handle):
@@ -318,8 +317,8 @@ a_handle = page.evaluate_handle("document") # handle for the "document"
 ```ruby
 body_handle = page.evaluate_handle("document.body")
 result_handle = page.evaluate_handle("body => body.innerHTML", arg: body_handle)
-puts result_handle.json_value()
-result_handle.dispose()
+puts result_handle.json_value
+result_handle.dispose
 ```
 
 

data/documentation/docs/api/js_handle.md

@@ -7,10 +7,9 @@ sidebar_position: 10
 JSHandle represents an in-page JavaScript object. JSHandles can be created with the [Page#evaluate_handle](./page#evaluate_handle)
 method.
 
-```python sync title=example_c408a96b8ac9c9bd54d915009c8b477eb75b7bf9e879fd76b32f3d4b6340a667.py
+```ruby
 window_handle = page.evaluate_handle("window")
 # ...
-
 ```
 
 JSHandle prevents the referenced JavaScript object being garbage collected unless the handle is exposed with
@@ -50,10 +49,9 @@ If `expression` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web
 
 Examples:
 
-```python sync title=example_2400f96eaaed3bc6ef6b0a16ba48e83d38a166c7d55a5dba0025472cffc6f2be.py
+```ruby
 tweet_handle = page.query_selector(".tweet .retweets")
-assert tweet_handle.evaluate("node => node.innerText") == "10 retweets"
-
+tweet_handle.evaluate("node => node.innerText") # => "10 retweets"
 ```
 
 
@@ -68,10 +66,10 @@ Returns the return value of `expression` as a [JSHandle](./js_handle).
 
 This method passes this handle as the first argument to `expression`.
 
-The only difference between `jsHandle.evaluate` and `jsHandle.evaluateHandle` is that `jsHandle.evaluateHandle` returns
+The only difference between [JSHandle#evaluate](./js_handle#evaluate) and [JSHandle#evaluate_handle](./js_handle#evaluate_handle) is that [JSHandle#evaluate_handle](./js_handle#evaluate_handle) returns
 [JSHandle](./js_handle).
 
-If the function passed to the `jsHandle.evaluateHandle` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then `jsHandle.evaluateHandle` would wait
+If the function passed to the [JSHandle#evaluate_handle](./js_handle#evaluate_handle) returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [JSHandle#evaluate_handle](./js_handle#evaluate_handle) would wait
 for the promise to resolve and return its value.
 
 See [Page#evaluate_handle](./page#evaluate_handle) for more details.
@@ -85,13 +83,12 @@ alias: `properties`
 
 The method returns a map with **own property names** as keys and JSHandle instances for the property values.
 
-```python sync title=example_8292f0e8974d97d20be9bb303d55ccd2d50e42f954e0ada4958ddbef2c6c2977.py
-handle = page.evaluate_handle("{window, document}")
-properties = handle.get_properties()
-window_handle = properties.get("window")
-document_handle = properties.get("document")
-handle.dispose()
-
+```ruby
+page.goto('https://example.com/')
+window_handle = page.evaluate_handle("window")
+properties = window_handle.properties
+puts properties
+window_handle.dispose
 ```