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

data/lib/playwright_api/mouse.rb

@@ -45,5 +45,13 @@ module Playwright
     def up(button: nil, clickCount: nil)
       wrap_impl(@impl.up(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount)))
     end
+
+    # Dispatches a `wheel` event.
+    #
+    # > NOTE: Wheel events may cause scrolling if they are not handled, and this method does not wait for the scrolling to
+    # finish before returning.
+    def wheel(deltaX, deltaY)
+      wrap_impl(@impl.wheel(unwrap_impl(deltaX), unwrap_impl(deltaY)))
+    end
   end
 end

data/lib/playwright_api/page.rb

@@ -284,8 +284,8 @@ module Playwright
     # # → False
     # page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches")
     # ```
-    def emulate_media(colorScheme: nil, media: nil, reducedMotion: nil)
-      wrap_impl(@impl.emulate_media(colorScheme: unwrap_impl(colorScheme), media: unwrap_impl(media), reducedMotion: unwrap_impl(reducedMotion)))
+    def emulate_media(colorScheme: nil, forcedColors: nil, media: nil, reducedMotion: nil)
+      wrap_impl(@impl.emulate_media(colorScheme: unwrap_impl(colorScheme), forcedColors: unwrap_impl(forcedColors), media: unwrap_impl(media), reducedMotion: unwrap_impl(reducedMotion)))
     end
 
     # The method finds an element matching the specified selector within the page and passes it as a first argument to
@@ -562,18 +562,18 @@ module Playwright
     # Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
     # last redirect.
     #
-    # `page.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.
     #
-    # `page.goto` will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not
+    # 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
     # [`method: Response.status`].
     #
-    # > NOTE: `page.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).
@@ -662,8 +662,6 @@ module Playwright
     # 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.
-    #
     # Shortcut for main frame's [`method: Frame.locator`].
     def locator(selector)
       wrap_impl(@impl.locator(unwrap_impl(selector)))
@@ -820,6 +818,9 @@ module Playwright
     # 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: [`method: 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:
     #
@@ -857,8 +858,8 @@ module Playwright
     # To remove a route with its handler you can use [`method: Page.unroute`].
     #
     # > NOTE: Enabling routing disables http cache.
-    def route(url, handler)
-      wrap_impl(@impl.route(unwrap_impl(url), unwrap_impl(handler)))
+    def route(url, handler, times: nil)
+      wrap_impl(@impl.route(unwrap_impl(url), unwrap_impl(handler), times: unwrap_impl(times)))
     end
 
     # Returns the buffer with the captured screenshot.
@@ -907,6 +908,33 @@ module Playwright
       wrap_impl(@impl.select_option(unwrap_impl(selector), element: unwrap_impl(element), index: unwrap_impl(index), value: unwrap_impl(value), label: unwrap_impl(label), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    # 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](./actionability.md) 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 [`property: 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 [`method: Frame.setChecked`].
+    def set_checked(
+          selector,
+          checked,
+          force: nil,
+          noWaitAfter: nil,
+          position: nil,
+          strict: nil,
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.set_checked(unwrap_impl(selector), unwrap_impl(checked), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+    end
+
     def set_content(html, timeout: nil, waitUntil: nil)
       wrap_impl(@impl.set_content(unwrap_impl(html), timeout: unwrap_impl(timeout), waitUntil: unwrap_impl(waitUntil)))
     end
@@ -1354,20 +1382,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/playwright.rb

@@ -93,20 +93,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/request.rb

@@ -14,6 +14,11 @@ module Playwright
   # request is  issued to a redirected url.
   class Request < PlaywrightApi
 
+    # An object with all the request HTTP headers associated with this request. The header names are lower-cased.
+    def all_headers
+      wrap_impl(@impl.all_headers)
+    end
+
     # The method returns `null` unless this request has failed, as reported by `requestfailed` event.
     #
     # Example of logging of all the failed requests:
@@ -30,11 +35,22 @@ module Playwright
       wrap_impl(@impl.frame)
     end
 
-    # 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 [`method: Request.allHeaders`] instead.
     def headers
       wrap_impl(@impl.headers)
     end
 
+    # An array with all the request HTTP headers associated with this request. Unlike [`method: Request.allHeaders`], header
+    # names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+    def headers_array
+      wrap_impl(@impl.headers_array)
+    end
+
+    # Returns the value of the header matching the name. The name is case insensitive.
+    def header_value(name)
+      wrap_impl(@impl.header_value(unwrap_impl(name)))
+    end
+
     # Whether this request is driving frame's navigation.
     def navigation_request?
       wrap_impl(@impl.navigation_request?)
@@ -109,6 +125,11 @@ module Playwright
       wrap_impl(@impl.response)
     end
 
+    # Returns resource size information for given request.
+    def sizes
+      wrap_impl(@impl.sizes)
+    end
+
     # Returns resource timing information for given request. Most of the timing values become available upon the response,
     # `responseEnd` becomes available when request finishes. Find more information at
     # [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
@@ -128,22 +149,27 @@ module Playwright
       wrap_impl(@impl.url)
     end
 
+    # @nodoc
+    def header_values(name)
+      wrap_impl(@impl.header_values(unwrap_impl(name)))
+    end
+
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/response.rb

@@ -2,12 +2,17 @@ module Playwright
   # `Response` class represents responses which are received by page.
   class Response < PlaywrightApi
 
+    # An object with all the response HTTP headers associated with this response.
+    def all_headers
+      wrap_impl(@impl.all_headers)
+    end
+
     # Returns the buffer with response body.
     def body
       wrap_impl(@impl.body)
     end
 
-    # Waits for this response to finish, returns failure error if request failed.
+    # Waits for this response to finish, returns always `null`.
     def finished
       wrap_impl(@impl.finished)
     end
@@ -17,11 +22,29 @@ module Playwright
       wrap_impl(@impl.frame)
     end
 
-    # 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 [`method: Response.allHeaders`] instead.
     def headers
       wrap_impl(@impl.headers)
     end
 
+    # An array with all the request HTTP headers associated with this response. Unlike [`method: Response.allHeaders`], header
+    # names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+    def headers_array
+      wrap_impl(@impl.headers_array)
+    end
+
+    # Returns the value of the header matching the name. The name is case insensitive. If multiple headers have the same name
+    # (except `set-cookie`), they are returned as a list separated by `, `. For `set-cookie`, the `\n` separator is used. If
+    # no headers are found, `null` is returned.
+    def header_value(name)
+      wrap_impl(@impl.header_value(unwrap_impl(name)))
+    end
+
+    # Returns all values of the headers matching the name, for example `set-cookie`. The name is case insensitive.
+    def header_values(name)
+      wrap_impl(@impl.header_values(unwrap_impl(name)))
+    end
+
     # Returns the JSON representation of response body.
     #
     # This method will throw if the response body is not parsable via `JSON.parse`.
@@ -76,20 +99,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/route.rb

@@ -58,20 +58,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/selectors.rb

@@ -6,7 +6,38 @@ module Playwright
     # An example of registering selector engine that queries elements based on a tag name:
     #
     # ```python sync
-    # # FIXME: add snippet
+    # from playwright.sync_api import sync_playwright
+    #
+    # def run(playwright):
+    #     tag_selector = """
+    #       {
+    #           // Returns the first element matching given selector in the root's subtree.
+    #           query(root, selector) {
+    #               return root.querySelector(selector);
+    #           },
+    #           // Returns all elements matching given selector in the root's subtree.
+    #           queryAll(root, selector) {
+    #               return Array.from(root.querySelectorAll(selector));
+    #           }
+    #       }"""
+    #
+    #     # Register the engine. Selectors will be prefixed with "tag=".
+    #     playwright.selectors.register("tag", tag_selector)
+    #     browser = playwright.chromium.launch()
+    #     page = browser.new_page()
+    #     page.set_content('<div><button>Click me</button></div>')
+    #
+    #     # Use the selector prefixed with its name.
+    #     button = page.query_selector('tag=button')
+    #     # Combine it with other selector engines.
+    #     page.click('tag=div >> text="Click me"')
+    #     # Can use it in any methods supporting selectors.
+    #     button_count = page.eval_on_selector_all('tag=button', 'buttons => buttons.length')
+    #     print(button_count)
+    #     browser.close()
+    #
+    # with sync_playwright() as playwright:
+    #     run(playwright)
     # ```
     def register(name, contentScript: nil, path: nil, script: nil)
       wrap_impl(@impl.register(unwrap_impl(name), contentScript: unwrap_impl(contentScript), path: unwrap_impl(path), script: unwrap_impl(script)))
@@ -14,20 +45,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/tracing.rb

@@ -1,13 +1,14 @@
 module Playwright
-  # 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](./trace-viewer.md)
+  # 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.
   #
   # ```python sync
   # browser = chromium.launch()
   # context = browser.new_context()
   # context.tracing.start(screenshots=True, snapshots=True)
+  # page = context.new_page()
   # page.goto("https://playwright.dev")
   # context.tracing.stop(path = "trace.zip")
   # ```
@@ -17,17 +18,45 @@ module Playwright
     #
     # ```python sync
     # context.tracing.start(name="trace", screenshots=True, snapshots=True)
+    # page = context.new_page()
     # page.goto("https://playwright.dev")
-    # context.tracing.stop()
     # context.tracing.stop(path = "trace.zip")
     # ```
     def start(name: nil, screenshots: nil, snapshots: nil)
       wrap_impl(@impl.start(name: unwrap_impl(name), screenshots: unwrap_impl(screenshots), snapshots: unwrap_impl(snapshots)))
     end
 
+    # Start a new trace chunk. If you'd like to record multiple traces on the same `BrowserContext`, use
+    # [`method: Tracing.start`] once, and then create multiple trace chunks with [`method: Tracing.startChunk`] and
+    # [`method: Tracing.stopChunk`].
+    #
+    # ```python sync
+    # 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")
+    # ```
+    def start_chunk
+      wrap_impl(@impl.start_chunk)
+    end
+
     # Stop tracing.
     def stop(path: nil)
       wrap_impl(@impl.stop(path: unwrap_impl(path)))
     end
+
+    # Stop the trace chunk. See [`method: Tracing.startChunk`] for more details about multiple trace chunks.
+    def stop_chunk(path: nil)
+      wrap_impl(@impl.stop_chunk(path: unwrap_impl(path)))
+    end
   end
 end