playwright-ruby-client 1.14.beta3 → 1.15.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88c8fbe4451b00ed8eba172f656e0171fb2580d555eefb4d2aa0cc1a13f86fc4
-  data.tar.gz: 3d307147cc4a23356d561f9528ef95343984bf4623ad77ebb6e479ce4f4f9462
+  metadata.gz: '028909fb1fc1321105a1172d46c02ccafbb071e5e630b5c5b616a9e76a695a91'
+  data.tar.gz: cadf29fb85714aac062c481b0c677709dc620141af57b0641d065a379210e93b
 SHA512:
-  metadata.gz: 647702705f820c268e5b858a1cd587b0e8f32f16415df2fd7b91505a221cadc20400fc9f2db188964fe4759f4734c8b30bc15c265434d2ac2b78e0683228c192
-  data.tar.gz: b4af0552e547d28be8c9390441bb7131d61fcea36fb5d3d293fd6985d6b47d3925e1c3bf27aa5f4e59243fc03ad751355acc20cb4e63b6e7489c47abb55b1864
+  metadata.gz: efe23218fd7aa8a5eee431af6fac5046420b222f67e196cd46cf44127bafe6a4db88f3ae56f71b1fe74d874fd385f1600009335e59be9c2a5bbca0ad4eacd13a
+  data.tar.gz: d0c78be5d3f3c662cd4b68bbbbf5624ce9febdf4be39740812f26573f14e68c5111fef7777b7ae2a5839c1723d3d20b91d680a2d691c791afcec01efe3630de2

data/README.md

@@ -6,19 +6,13 @@
 
 ## Getting Started
 
-At this point, playwright-ruby-client doesn't include the downloader of playwright driver, so **we have to install [playwright](https://github.com/microsoft/playwright) in advance**.
-
-```sh
-npx playwright install
+```
+gem 'playwright-ruby-client'
 ```
 
-and then, set `playwright_cli_executable_path: "npx playwright"` at `Playwright.create`.
-
-**Prefer npm install instead of npx?**
-
-Actually `npx playwright` is a bit slow. We can also use `npm install` to setup.
+and then 'bundle install'.
 
-Instead of `npx playwright install`:
+Since playwright-ruby-client doesn't include the playwright driver, **we have to install [playwright](https://github.com/microsoft/playwright) in advance**.
 
 ```
 npm install playwright
@@ -29,14 +23,14 @@ And set `playwright_cli_executable_path: './node_modules/.bin/playwright'`
 
 **Prefer playwrighting without Node.js?**
 
-Instead of npm, you can also directly download playwright driver from playwright.azureedge.net/builds/. The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/79f6ce0a6a69c480573372706df84af5ef99c4a4/setup.py#L56-L61)
+Instead of npm, you can also directly download playwright driver from playwright.azureedge.net/builds/. The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/cb5409934629adaabc0cff1891080de2052fa778/setup.py#L73-L77)
 
 ### Capture a site
 
 ```ruby
 require 'playwright'
 
-Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
+Playwright.create(playwright_cli_executable_path: './node_modules/.bin/playwright') do |playwright|
   playwright.chromium.launch(headless: false) do |browser|
     page = browser.new_page
     page.goto('https://github.com/YusukeIwaki')
@@ -52,7 +46,7 @@ end
 ```ruby
 require 'playwright'
 
-Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
+Playwright.create(playwright_cli_executable_path: './node_modules/.bin/playwright') do |playwright|
   playwright.chromium.launch(headless: false) do |browser|
     page = browser.new_page
     page.goto('https://github.com/')
@@ -94,7 +88,7 @@ $ bundle exec ruby main.rb
 ```ruby
 require 'playwright'
 
-Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
+Playwright.create(playwright_cli_executable_path: './node_modules/.bin/playwright') do |playwright|
   devices = playwright.android.devices
   unless devices.empty?
     device = devices.last
@@ -185,6 +179,8 @@ end
 
 When `Playwright.connect_to_playwright_server` is used, playwright_cli_executable_path is not required.
 
+For more detailed instraction, refer this article: https://playwright-ruby-client.vercel.app/docs/article/guides/playwright_on_alpine_linux
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/documentation/docs/api/browser.md

@@ -81,6 +81,7 @@ def new_context(
       colorScheme: nil,
       deviceScaleFactor: nil,
       extraHTTPHeaders: nil,
+      forcedColors: nil,
       geolocation: nil,
       hasTouch: nil,
       httpCredentials: nil,
@@ -99,6 +100,7 @@ def new_context(
       reducedMotion: nil,
       screen: nil,
       storageState: nil,
+      strictSelectors: nil,
       timezoneId: nil,
       userAgent: nil,
       viewport: nil,
@@ -130,6 +132,7 @@ def new_page(
       colorScheme: nil,
       deviceScaleFactor: nil,
       extraHTTPHeaders: nil,
+      forcedColors: nil,
       geolocation: nil,
       hasTouch: nil,
       httpCredentials: nil,
@@ -148,6 +151,7 @@ def new_page(
       reducedMotion: nil,
       screen: nil,
       storageState: nil,
+      strictSelectors: nil,
       timezoneId: nil,
       userAgent: nil,
       viewport: nil,

data/documentation/docs/api/browser_context.md

@@ -265,12 +265,16 @@ Returns all open pages in the context.
 ## route
 
 ```
-def route(url, handler)
+def route(url, handler, times: nil)
 ```
 
 Routing provides the capability to modify network requests that are made by any page in the browser context. Once route
 is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
 
+> NOTE: [Page#route](./page#route) will not intercept requests intercepted by Service Worker. See
+[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
+request interception. Via `await context.addInitScript(() => delete window.navigator.serviceWorker);`
+
 An example of a naive handler that aborts all image requests:
 
 ```ruby

data/documentation/docs/api/browser_type.md

@@ -114,6 +114,7 @@ def launch_persistent_context(
       env: nil,
       executablePath: nil,
       extraHTTPHeaders: nil,
+      forcedColors: nil,
       geolocation: nil,
       handleSIGHUP: nil,
       handleSIGINT: nil,
@@ -137,6 +138,7 @@ def launch_persistent_context(
       reducedMotion: nil,
       screen: nil,
       slowMo: nil,
+      strictSelectors: nil,
       timeout: nil,
       timezoneId: nil,
       tracesDir: nil,

data/documentation/docs/api/element_handle.md

@@ -510,6 +510,32 @@ def select_text(force: nil, timeout: nil)
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text
 content.
 
+## set_checked
+
+```
+def set_checked(
+      checked,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil,
+      trial: nil)
+```
+alias: `checked=`
+
+This method checks or unchecks an element by performing the following steps:
+1. Ensure that element is a checkbox or a radio input. If not, this method throws.
+1. If the element already has the right checked state, this method returns immediately.
+1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the
+   element is detached during the checks, the whole action is retried.
+1. Scroll the element into view if needed.
+1. Use [Page#mouse](./page#mouse) to click in the center of the element.
+1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
+1. Ensure that the element is now checked or unchecked. If not, this method throws.
+
+When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
+zero timeout disables this.
+
 ## set_input_files
 
 ```
@@ -630,7 +656,7 @@ If the element does not satisfy the condition for the `timeout` milliseconds, th
 ## wait_for_selector
 
 ```
-def wait_for_selector(selector, state: nil, timeout: nil)
+def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
 ```
 
 Returns element specified by selector when it satisfies `state` option. Returns `null` if waiting for `hidden` or
@@ -641,12 +667,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/experimental/android_device.md

@@ -34,6 +34,7 @@ def launch_browser(
       command: nil,
       deviceScaleFactor: nil,
       extraHTTPHeaders: nil,
+      forcedColors: nil,
       geolocation: nil,
       hasTouch: nil,
       httpCredentials: nil,
@@ -50,6 +51,7 @@ def launch_browser(
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,
+      strictSelectors: nil,
       timezoneId: nil,
       userAgent: nil,
       viewport: nil,

data/documentation/docs/api/frame.md

@@ -401,18 +401,18 @@ def goto(url, referer: nil, timeout: nil, waitUntil: nil)
 Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
 last redirect.
 
-`frame.goto` will throw an error if:
+The method will throw an error if:
 - there's an SSL error (e.g. in case of self-signed certificates).
 - target URL is invalid.
 - the `timeout` is exceeded during navigation.
 - the remote server does not respond or is unreachable.
 - the main resource failed to load.
 
-`frame.goto` will not throw an error when any valid HTTP status code is returned by the remote server, including 404
-"Not Found" and 500 "Internal Server Error".  The status code for such responses can be retrieved by calling
+The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not
+Found" and 500 "Internal Server Error".  The status code for such responses can be retrieved by calling
 [Response#status](./response#status).
 
-> NOTE: `frame.goto` either throws an error or returns a main resource response. The only exceptions are navigation to
+> NOTE: The method either throws an error or returns a main resource response. The only exceptions are navigation to
 `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`.
 > NOTE: Headless mode doesn't support navigation to a PDF document. See the
 [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
@@ -533,8 +533,6 @@ The method returns an element locator that can be used to perform actions in the
 element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
 different DOM elements. That would happen if the DOM structure between those actions has changed.
 
-Note that locator always implies visibility, so it will always be locating visible elements.
-
 ## name
 
 ```
@@ -651,6 +649,34 @@ frame.select_option("select#colors", value: ["red", "green", "blue"])
 
 
 
+## set_checked
+
+```
+def set_checked(
+      selector,
+      checked,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      strict: nil,
+      timeout: nil,
+      trial: nil)
+```
+
+This method checks or unchecks an element matching `selector` by performing the following steps:
+1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
+1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
+1. If the element already has the right checked state, this method returns immediately.
+1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the
+   element is detached during the checks, the whole action is retried.
+1. Scroll the element into view if needed.
+1. Use [Page#mouse](./page#mouse) to click in the center of the element.
+1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
+1. Ensure that the element is now checked or unchecked. If not, this method throws.
+
+When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
+zero timeout disables this.
+
 ## set_content
 
 ```

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
@@ -35,6 +34,22 @@ locator.hover
 locator.click
 ```
 
+**Strictness**
+
+Locators are strict. This means that all operations on locators that imply some target DOM element will throw if more
+than one element matches given selector.
+
+```ruby
+# Throws if there are several buttons in DOM:
+page.locator('button').click
+
+# Works because we explicitly tell locator to pick the first element:
+page.locator('button').first.click
+
+# Works because count knows what to do with multiple matches:
+page.locator('button').count
+```
+
 
 
 ## all_inner_texts
@@ -72,10 +87,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 +194,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 +212,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 +251,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 +272,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 +531,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")
 ```
 
 
@@ -551,6 +556,32 @@ def select_text(force: nil, timeout: nil)
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text
 content.
 
+## set_checked
+
+```
+def set_checked(
+      checked,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil,
+      trial: nil)
+```
+alias: `checked=`
+
+This method checks or unchecks an element by performing the following steps:
+1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
+1. If the element already has the right checked state, this method returns immediately.
+1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the
+   element is detached during the checks, the whole action is retried.
+1. Scroll the element into view if needed.
+1. Use [Page#mouse](./page#mouse) to click in the center of the element.
+1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
+1. Ensure that the element is now checked or unchecked. If not, this method throws.
+
+When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
+zero timeout disables this.
+
 ## set_input_files
 
 ```
@@ -607,19 +638,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")
-
 ```