playwright-ruby-client 1.15.beta1 → 1.15.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae7bd712526c9e50089204c128fc6aff20ff430e2f58d04faea66d429ab53357
-  data.tar.gz: 95cb87802b32b1ce4487f6bc7a0fe897c5cdf285cef09700dc9472b8caea46d1
+  metadata.gz: 2247f39a5fa4881e45ad884606295d7003b3e42ca9db5436b223d921649e5553
+  data.tar.gz: f7f57d5044c66e300912578faa1d8114ee98f2eb1de736eac3da698e7851b9d6
 SHA512:
-  metadata.gz: b6854306d49f2bdf5a2f51bcfc639297043a52d9f0c38b3eb1b8db3931462cd98c42f0d45a35867352dccce25637efcc414b5c14edfe9d332c176d10a9fe9723
-  data.tar.gz: 4e1e89f99491cb4d2cc3ef1092b5a95fcd7486b2b19cd45dcc01d2d25ac5884c4ab6ba956172f41017561aee74013c2902ac787d0d5a1d6b71ef5eacf8740056
+  metadata.gz: 86b2003368d06755bfef64cebe40c716ef9d0156d6bd21f18fddc79cef07ffee5a48f562294c32b956dd664b5480326587736ee56334c76e80e8a8e2b89dfb72
+  data.tar.gz: 20697ed55fb7ce54856d04dc0f9568316d5941b0b103ce5c0138e680a28aeda1b7876a3cf4d358f006a2b5d7115a267ed8e7c689064bf54f65e6797848d69a2f

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,
@@ -131,6 +132,7 @@ def new_page(
       colorScheme: nil,
       deviceScaleFactor: nil,
       extraHTTPHeaders: nil,
+      forcedColors: nil,
       geolocation: nil,
       hasTouch: nil,
       httpCredentials: 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,

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

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,

data/documentation/docs/api/frame.md

@@ -649,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

@@ -45,6 +45,9 @@ 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
 ```
 
 
@@ -553,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
 
 ```

data/documentation/docs/api/page.md

@@ -281,7 +281,7 @@ def drag_and_drop(
 ## emulate_media
 
 ```
-def emulate_media(colorScheme: nil, media: nil, reducedMotion: nil)
+def emulate_media(colorScheme: nil, forcedColors: nil, media: nil, reducedMotion: nil)
 ```
 
 This method changes the `CSS media type` through the `media` argument, and/or the `'prefers-colors-scheme'` media
@@ -933,7 +933,7 @@ last redirect.
 ## route
 
 ```
-def route(url, handler)
+def route(url, handler, times: nil)
 ```
 
 Routing provides the capability to modify network requests that are made by a page.
@@ -941,6 +941,9 @@ Routing provides the capability to modify network requests that are made by a pa
 Once routing is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
 
 > NOTE: The handler will only be called for the first url if the response is a redirect.
+> 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:
 
@@ -1030,6 +1033,36 @@ page.select_option("select#colors", value: ["red", "green", "blue"])
 
 Shortcut for main frame's [Frame#select_option](./frame#select_option).
 
+## 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.
+
+Shortcut for main frame's [Frame#set_checked](./frame#set_checked).
+
 ## set_content
 
 ```

data/documentation/docs/api/request.md

@@ -18,6 +18,14 @@ complete with `'requestfinished'` event.
 If request gets a 'redirect' response, the request is successfully finished with the 'requestfinished' event, and a new
 request is  issued to a redirected url.
 
+## all_headers
+
+```
+def all_headers
+```
+
+An object with all the request HTTP headers associated with this request. The header names are lower-cased.
+
 ## failure
 
 ```
@@ -48,7 +56,16 @@ Returns the [Frame](./frame) that initiated this request.
 def headers
 ```
 
-An object with HTTP headers associated with the request. All header names are lower-case.
+**DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [Request#all_headers](./request#all_headers) instead.
+
+## headers_array
+
+```
+def headers_array
+```
+
+An array with all the request HTTP headers associated with this request. Unlike [Request#all_headers](./request#all_headers), header
+names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
 
 ## navigation_request?
 
@@ -156,6 +173,15 @@ def response
 
 Returns the matching [Response](./response) object, or `null` if the response was not received due to error.
 
+## sizes
+
+```
+def sizes
+```
+
+Returns resource size information for given request. Requires the response to be finished via
+[Response#finished](./response#finished) to ensure the info is available.
+
 ## timing
 
 ```

data/documentation/docs/api/response.md

@@ -6,6 +6,14 @@ sidebar_position: 10
 
 [Response](./response) class represents responses which are received by page.
 
+## all_headers
+
+```
+def all_headers
+```
+
+An object with all the response HTTP headers associated with this response.
+
 ## body
 
 ```
@@ -36,7 +44,16 @@ Returns the [Frame](./frame) that initiated this response.
 def headers
 ```
 
-Returns the object with HTTP headers associated with the response. All header names are lower-case.
+**DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [Response#all_headers](./response#all_headers) instead.
+
+## headers_array
+
+```
+def headers_array
+```
+
+An array with all the request HTTP headers associated with this response. Unlike [Response#all_headers](./response#all_headers), header
+names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
 
 ## json
 

data/documentation/docs/api/tracing.md

@@ -4,16 +4,15 @@ sidebar_position: 10
 
 # Tracing
 
-API for collecting and saving Playwright traces. Playwright traces can be opened using the Playwright CLI after
-Playwright script runs.
+API for collecting and saving Playwright traces. Playwright traces can be opened in [Trace Viewer](https://playwright.dev/python/docs/trace-viewer)
+after Playwright script runs.
 
-Start with specifying the folder traces will be stored in:
+Start recording a trace before performing actions. At the end, stop tracing and save it to a file.
 
 ```ruby
-browser.new_page do |page|
-  context = page.context
-
+browser.new_context do |context|
   context.tracing.start(screenshots: true, snapshots: true)
+  page = context.new_page
   page.goto('https://playwright.dev')
   context.tracing.stop(path: 'trace.zip')
 end
@@ -30,15 +29,42 @@ def start(name: nil, screenshots: nil, snapshots: nil)
 Start tracing.
 
 ```ruby
-context = page.context
-
 context.tracing.start(name: 'trace', screenshots: true, snapshots: true)
+page = context.new_page
 page.goto('https://playwright.dev')
 context.tracing.stop(path: 'trace.zip')
 ```
 
 
 
+## start_chunk
+
+```
+def start_chunk
+```
+
+Start a new trace chunk. If you'd like to record multiple traces on the same [BrowserContext](./browser_context), use
+[Tracing#start](./tracing#start) once, and then create multiple trace chunks with [Tracing#start_chunk](./tracing#start_chunk) and
+[Tracing#stop_chunk](./tracing#stop_chunk).
+
+```ruby
+context.tracing.start(name: "trace", screenshots: true, snapshots: true)
+page = context.new_page
+page.goto("https://playwright.dev")
+
+context.tracing.start_chunk
+page.click("text=Get Started")
+# Everything between start_chunk and stop_chunk will be recorded in the trace.
+context.tracing.stop_chunk(path: "trace1.zip")
+
+context.tracing.start_chunk
+page.goto("http://example.com")
+# Save a second trace file with different actions.
+context.tracing.stop_chunk(path: "trace2.zip")
+```
+
+
+
 ## stop
 
 ```
@@ -46,3 +72,11 @@ def stop(path: nil)
 ```
 
 Stop tracing.
+
+## stop_chunk
+
+```
+def stop_chunk(path: nil)
+```
+
+Stop the trace chunk. See [Tracing#start_chunk](./tracing#start_chunk) for more details about multiple trace chunks.