playwright-ruby-client 1.22.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82040f41eb8c972a8e3415aac148c27218e9fcbb00d7e09832bd75da506d2367
-  data.tar.gz: a42be0ab4e00bb0ef36516474cca8220147d8c635e44c581c799ee65e396721f
+  metadata.gz: 8d7e01f93c5fa8ffd804062e0414e9de40204674ef1b070f296c0108259ca015
+  data.tar.gz: 75bdb822a5c3cc8ffe7e8dc011d8697c2cb00aa95895e7486068c09839a9c667
 SHA512:
-  metadata.gz: 615d15f014ca5f175d9da7504583693903d0ebd4c3d47522bf2f5c0add5aa01f26551300834b86cd944a2eacb2ef38062c341ec14f1177b7f517a16dab6e90fe
-  data.tar.gz: 97de038214b07abfbeb9eece923c0b031793b8939107df5f7b37268dbb4598c188dc88c4870766cf31d0bf28416610f46c996518a2f37fc8c73d5b672f713005
+  metadata.gz: 9499d48e15c5201718f8e4569f1e28b5f66d2bd14c11b4c3a1c98c4e4ca2c39ababc74b3af1db1e2bcabbc4234fd6034eaa0c71b09b925654c468fdf65dd0547
+  data.tar.gz: 622a2e2bd96af9e65255b1abdb52f5768091af4cc8d5a6368b60237e363a8cd3bdbc1673ef1d745d017583206b6d8011f92300228b27a14e69bdc6558392de30

data/documentation/docs/api/accessibility.md

@@ -4,6 +4,10 @@ sidebar_position: 10
 
 # Accessibility
 
+**DEPRECATED** This class is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
+need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
+integration with Axe.
+
 The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by
 assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or
 [switches](https://en.wikipedia.org/wiki/Switch_access).
@@ -24,6 +28,10 @@ only the "interesting" nodes of the tree.
 def snapshot(interestingOnly: nil, root: nil)
 ```
 
+**DEPRECATED** This method is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
+need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
+integration with Axe.
+
 Captures the current state of the accessibility tree. The returned object represents the root accessible node of the
 page.
 

data/documentation/docs/api/api_request_context.md

@@ -13,14 +13,14 @@ possible to create a new APIRequestContext instance manually by calling [APIRequ
 
 **Cookie management**
 
-[APIRequestContext](./api_request_context) retuned by [BrowserContext#request](./browser_context#request) and [Page#request](./page#request) shares cookie storage
-with the corresponding [BrowserContext](./browser_context). Each API request will have `Cookie` header populated with the values from the
-browser context. If the API response contains `Set-Cookie` header it will automatically update [BrowserContext](./browser_context) cookies
-and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be
-logged in and vice versa.
-
-If you want API requests to not interfere with the browser cookies you shoud create a new [APIRequestContext](./api_request_context) by calling
-[APIRequest#new_context](./api_request#new_context). Such [APIRequestContext](./api_request_context) object will have its own isolated cookie storage.
+[APIRequestContext](./api_request_context) returned by [BrowserContext#request](./browser_context#request) and [Page#request](./page#request) shares cookie
+storage with the corresponding [BrowserContext](./browser_context). Each API request will have `Cookie` header populated with the values
+from the browser context. If the API response contains `Set-Cookie` header it will automatically update [BrowserContext](./browser_context)
+cookies and requests made from the page will pick them up. This means that if you log in using this API, your e2e test
+will be logged in and vice versa.
+
+If you want API requests to not interfere with the browser cookies you should create a new [APIRequestContext](./api_request_context) by
+calling [APIRequest#new_context](./api_request#new_context). Such [APIRequestContext](./api_request_context) object will have its own isolated cookie storage.
 
 ```ruby
 playwright.chromium.launch do |browser|

data/documentation/docs/api/browser.md

@@ -21,6 +21,14 @@ end
 
 
 
+## browser_type
+
+```
+def browser_type
+```
+
+Get the browser type (chromium, firefox or webkit) that the browser belongs to.
+
 ## close
 
 ```
@@ -33,6 +41,10 @@ were opened).
 In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the
 browser server.
 
+> NOTE: This is similar to force quitting the browser. Therefore, you should call [BrowserContext#close](./browser_context#close) on
+any [BrowserContext](./browser_context)'s you explicitly created earlier with [Browser#new_context](./browser#new_context) **before** calling
+[Browser#close](./browser#close).
+
 The [Browser](./browser) object itself is considered to be disposed and cannot be used anymore.
 
 ## contexts
@@ -93,12 +105,16 @@ def new_context(
       offline: nil,
       permissions: nil,
       proxy: nil,
+      record_har_content: nil,
+      record_har_mode: nil,
       record_har_omit_content: nil,
       record_har_path: nil,
+      record_har_url_filter: nil,
       record_video_dir: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,
+      serviceWorkers: nil,
       storageState: nil,
       strictSelectors: nil,
       timezoneId: nil,
@@ -109,14 +125,19 @@ def new_context(
 
 Creates a new browser context. It won't share cookies/cache with other browser contexts.
 
+> NOTE: If directly using this method to create [BrowserContext](./browser_context)s, it is best practice to explicitly close the returned
+context via [BrowserContext#close](./browser_context#close) when your code is done with the [BrowserContext](./browser_context), and before calling
+[Browser#close](./browser#close). This will ensure the `context` is closed gracefully and any artifacts—like HARs and
+videos—are fully flushed and saved.
+
 ```ruby
 playwright.firefox.launch do |browser| # or "chromium.launch" or "webkit.launch".
   # create a new incognito browser context.
-  context = browser.new_context
-
-  # create a new page in a pristine context.
-  page = context.new_page()
-  page.goto("https://example.com")
+  browser.new_context do |context|
+    # create a new page in a pristine context.
+    page = context.new_page
+    page.goto("https://example.com")
+  end
 end
 ```
 
@@ -144,12 +165,16 @@ def new_page(
       offline: nil,
       permissions: nil,
       proxy: nil,
+      record_har_content: nil,
+      record_har_mode: nil,
       record_har_omit_content: nil,
       record_har_path: nil,
+      record_har_url_filter: nil,
       record_video_dir: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,
+      serviceWorkers: nil,
       storageState: nil,
       strictSelectors: nil,
       timezoneId: nil,

data/documentation/docs/api/browser_context.md

@@ -23,7 +23,7 @@ page = context.new_page
 page.goto("https://example.com")
 
 # dispose context once it is no longer needed.
-context.close()
+context.close
 ```
 
 
@@ -161,7 +161,7 @@ page.content = <<~HTML
 <div></div>
 HTML
 
-page.click("button")
+page.locator("button").click
 ```
 
 An example of passing an element handle:
@@ -184,7 +184,7 @@ page.content = <<~HTML
 <div>Or click me</div>
 HTML
 
-page.click('div')
+page.locator('div').first.click
 ```
 
 
@@ -222,7 +222,7 @@ page.content = <<~HTML
 <button onclick="onClick()">Click me</button>
 <div></div>
 HTML
-page.click("button")
+page.locator("button").click
 ```
 
 
@@ -271,9 +271,9 @@ 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
+> NOTE: [BrowserContext#route](./browser_context#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);`
+request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
 
 An example of a naive handler that aborts all image requests:
 
@@ -315,6 +315,19 @@ To remove a route with its handler you can use [BrowserContext#unroute](./browse
 
 > NOTE: Enabling routing disables http cache.
 
+## route_from_har
+
+```
+def route_from_har(har, notFound: nil, update: nil, url: nil)
+```
+
+If specified the network requests that are made in the context will be served from the HAR file. Read more about
+[Replaying from HAR](https://playwright.dev/python/docs/network).
+
+Playwright will not serve requests intercepted by Service Worker from the HAR file. See
+[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
+request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
+
 ## service_workers
 
 ```
@@ -421,7 +434,7 @@ value. Will throw an error if the context closes before the event is fired. Retu
 
 ```ruby
 new_page = browser_context.expect_event('page') do
-  page.click('button')
+  page.locator('button').click
 end
 ```
 

data/documentation/docs/api/browser_type.md

@@ -131,12 +131,16 @@ def launch_persistent_context(
       offline: nil,
       permissions: nil,
       proxy: nil,
+      record_har_content: nil,
+      record_har_mode: nil,
       record_har_omit_content: nil,
       record_har_path: nil,
+      record_har_url_filter: nil,
       record_video_dir: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,
+      serviceWorkers: nil,
       slowMo: nil,
       strictSelectors: nil,
       timeout: nil,

data/documentation/docs/api/download.md

@@ -12,7 +12,7 @@ Download event is emitted once the download starts. Download path becomes availa
 
 ```ruby
 download = page.expect_download do
-  page.click('a')
+  page.locator('a').click
 end
 
 # wait for download to complete

data/documentation/docs/api/element_handle.md

@@ -55,7 +55,7 @@ def bounding_box
 This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is
 calculated relative to the main frame viewport - which is usually the same as the browser window.
 
-Scrolling affects the returned bonding box, similarly to
+Scrolling affects the returned bounding box, similarly to
 [Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect). That
 means `x` and/or `y` may be negative.
 
@@ -504,11 +504,6 @@ element_handle.select_option(label: "blue")
 element_handle.select_option(value: ["red", "green", "blue"])
 ```
 
-```ruby
-# multiple selection for blue, red and second option
-element_handle.select_option(value: "blue", index: 2, label: "red")
-```
-
 
 
 ## select_text

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

@@ -45,12 +45,16 @@ def launch_browser(
       noViewport: nil,
       offline: nil,
       permissions: nil,
+      record_har_content: nil,
+      record_har_mode: nil,
       record_har_omit_content: nil,
       record_har_path: nil,
+      record_har_url_filter: nil,
       record_video_dir: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,
+      serviceWorkers: nil,
       strictSelectors: nil,
       timezoneId: nil,
       userAgent: nil,

data/documentation/docs/api/file_chooser.md

@@ -8,7 +8,7 @@ sidebar_position: 10
 
 ```ruby
 file_chooser = page.expect_file_chooser do
-  page.click("upload") # action to trigger file uploading
+  page.locator("upload").click # action to trigger file uploading
 end
 file_chooser.set_files("myfile.pdf")
 ```

data/documentation/docs/api/locator.md

@@ -34,7 +34,7 @@ def bounding_box(timeout: nil)
 This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is
 calculated relative to the main frame viewport - which is usually the same as the browser window.
 
-Scrolling affects the returned bonding box, similarly to
+Scrolling affects the returned bounding box, similarly to
 [Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect). That
 means `x` and/or `y` may be negative.
 
@@ -291,7 +291,19 @@ To send fine-grained keyboard events, use [Locator#type](./locator#type).
 def filter(has: nil, hasText: nil)
 ```
 
-This method narrows existing locator according to the options, for example filters by text.
+This method narrows existing locator according to the options, for example filters by text. It can be chained to filter
+multiple times.
+
+```ruby
+row_locator = page.locator("tr")
+# ...
+row_locator.
+    filter(has_text="text in column 1").
+    filter(has=page.locator("tr", has_text="column 2 button")).
+    screenshot
+```
+
+
 
 ## first
 
@@ -330,6 +342,7 @@ locator.click
 ```
 def get_attribute(name, timeout: nil)
 ```
+alias: `[]`
 
 Returns element attribute value.
 
@@ -564,11 +577,6 @@ element.select_option(label: "blue")
 element.select_option(value: ["red", "green", "blue"])
 ```
 
-```ruby
-# multiple selection for blue, red and second option
-element.select_option(value: "blue", index: 2, label: "red")
-```
-
 
 
 ## select_text

data/documentation/docs/api/page.md

@@ -462,7 +462,7 @@ page.content = <<~HTML
 <button onclick="onClick()">Click me</button>
 <div></div>
 HTML
-page.click("button")
+page.locator("button").click
 ```
 
 An example of passing an element handle:
@@ -483,7 +483,7 @@ page.content = <<~HTML
 <div>Or click me</div>
 HTML
 
-page.click('div')
+page.locator('div').first.click
 ```
 
 
@@ -522,7 +522,7 @@ page.content = <<~HTML
 <button onclick="onClick()">Click me</button>
 <div></div>
 HTML
-page.click("button")
+page.locator("button").click
 ```
 
 
@@ -975,7 +975,7 @@ Once routing is enabled, every request matching the url pattern will stall unles
 > 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);`
+request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
 
 An example of a naive handler that aborts all image requests:
 
@@ -1013,6 +1013,19 @@ To remove a route with its handler you can use [Page#unroute](./page#unroute).
 
 > NOTE: Enabling routing disables http cache.
 
+## route_from_har
+
+```
+def route_from_har(har, notFound: nil, update: nil, url: nil)
+```
+
+If specified the network requests that are made in the page will be served from the HAR file. Read more about
+[Replaying from HAR](https://playwright.dev/python/docs/network).
+
+Playwright will not serve requests intercepted by Service Worker from the HAR file. See
+[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
+request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
+
 ## screenshot
 
 ```
@@ -1609,6 +1622,10 @@ associated with the page.
 
 ## accessibility
 
+**DEPRECATED** This property is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
+need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
+integration with Axe.
+
 ## keyboard
 
 ## mouse

data/documentation/docs/api/request.md

@@ -56,7 +56,9 @@ Returns the [Frame](./frame) that initiated this request.
 def headers
 ```
 
-**DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [Request#all_headers](./request#all_headers) instead.
+An object with the request HTTP headers. The header names are lower-cased. Note that this method does not return
+security-related headers, including cookie-related ones. You can use [Request#all_headers](./request#all_headers) for complete list of
+headers that include `cookie` information.
 
 ## headers_array
 

data/documentation/docs/api/response.md

@@ -38,13 +38,24 @@ def frame
 
 Returns the [Frame](./frame) that initiated this response.
 
+## from_service_worker
+
+```
+def from_service_worker
+```
+
+Indicates whether this Response was fulfilled by a Service Worker's Fetch Handler (i.e. via
+[FetchEvent.respondWith](https://developer.mozilla.org/en-US/docs/Web/API/FetchEvent/respondWith)).
+
 ## headers
 
 ```
 def headers
 ```
 
-**DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [Response#all_headers](./response#all_headers) instead.
+An object with the response HTTP headers. The header names are lower-cased. Note that this method does not return
+security-related headers, including cookie-related ones. You can use [Response#all_headers](./response#all_headers) for complete list
+of headers that include `cookie` information.
 
 ## headers_array
 

data/documentation/docs/api/route.md

@@ -31,6 +31,7 @@ def handle(route, request)
   headers = request.headers
   headers['foo'] = 'bar' # set "foo" header
   headers['user-agent'] = 'Unknown Browser' # modify user-agent
+  headers.delete('bar') # remove "bar" header
 
   route.continue(headers: headers)
 end
@@ -39,6 +40,70 @@ page.route("**/*", method(:handle))
 
 
 
+## fallback
+
+```
+def fallback(headers: nil, method: nil, postData: nil, url: nil)
+```
+
+When several routes match the given pattern, they run in the order opposite to their registration. That way the last
+registered route can always override all the previous ones. In the example below, request will be handled by the
+bottom-most handler first, then it'll fall back to the previous one and in the end will be aborted by the first
+registered route.
+
+```ruby
+page.route("**/*", -> (route,_) { route.abort })  # Runs last.
+page.route("**/*", -> (route,_) { route.fallback })  # Runs second.
+page.route("**/*", -> (route,_) { route.fallback })  # Runs first.
+```
+
+Registering multiple routes is useful when you want separate handlers to handle different kinds of requests, for example
+API calls vs page resources or GET requests vs POST requests as in the example below.
+
+```ruby
+# Handle GET requests.
+def handle_post(route, request)
+  if request.method != "GET"
+    route.fallback
+    return
+  end
+
+  # Handling GET only.
+  # ...
+end
+
+# Handle POST requests.
+def handle_post(route)
+  if request.method != "POST"
+    route.fallback
+    return
+  end
+
+  # Handling POST only.
+  # ...
+end
+
+page.route("**/*", handle_get)
+page.route("**/*", handle_post)
+```
+
+One can also modify request while falling back to the subsequent handler, that way intermediate route handler can modify
+url, method, headers and postData of the request.
+
+```ruby
+def handle(route, request)
+  # override headers
+  headers = request.headers
+  headers['foo'] = 'bar' # set "foo" header
+  headers['user-agent'] = 'Unknown Browser' # modify user-agent
+  headers.delete('bar') # remove "bar" header
+
+  route.fallback(headers: headers)
+end
+```
+
+
+
 ## fulfill
 
 ```

data/documentation/docs/api/selectors.md

@@ -36,9 +36,9 @@ playwright.chromium.launch do |browser|
   page.content = '<div><button>Click me</button></div>'
 
   # Use the selector prefixed with its name.
-  button = page.query_selector('tag=button')
+  button = page.locator('tag=button')
   # Combine it with other selector engines.
-  page.click('tag=div >> text="Click me"')
+  page.locator('tag=div >> text="Click me"').click
 
   # Can use it in any methods supporting selectors.
   button_count = page.locator('tag=button').count

data/documentation/docs/api/tracing.md

@@ -58,7 +58,7 @@ page = context.new_page
 page.goto("https://playwright.dev")
 
 context.tracing.start_chunk
-page.click("text=Get Started")
+page.locator("text=Get Started").click
 # Everything between start_chunk and stop_chunk will be recorded in the trace.
 context.tracing.stop_chunk(path: "trace1.zip")
 

data/documentation/docs/include/api_coverage.md

@@ -27,6 +27,7 @@
 * body
 * finished
 * frame
+* from_service_worker
 * headers
 * headers_array
 * header_value
@@ -45,6 +46,7 @@
 
 * abort
 * continue
+* fallback
 * fulfill
 * request
 
@@ -280,6 +282,7 @@
 * query_selector_all
 * reload
 * route
+* route_from_har
 * screenshot
 * select_option
 * set_checked
@@ -339,6 +342,7 @@
 * new_page
 * pages
 * route
+* route_from_har
 * service_workers
 * set_default_navigation_timeout
 * set_default_timeout
@@ -360,6 +364,7 @@
 
 ## Browser
 
+* browser_type
 * close
 * contexts
 * connected?
@@ -454,9 +459,6 @@
 * locator
 * nth
 
-## LocalUtils
-
-
 ## APIResponse
 
 * body

data/documentation/package.json

@@ -14,11 +14,11 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-beta.18",
-    "@docusaurus/preset-classic": "^2.0.0-beta.18",
+    "@docusaurus/core": "^2.0.1",
+    "@docusaurus/preset-classic": "^2.0.1",
     "@mdx-js/react": "^1.6.22",
-    "@svgr/webpack": "^6.2.1",
-    "clsx": "^1.1.1",
+    "@svgr/webpack": "^6.3.1",
+    "clsx": "^1.2.1",
     "file-loader": "^6.2.0",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",