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

data/lib/playwright_api/console_message.rb

@@ -23,12 +23,6 @@ module Playwright
       wrap_impl(@impl.type)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -41,6 +35,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/dialog.rb

@@ -58,12 +58,6 @@ module Playwright
       wrap_impl(@impl.accept_async(promptText: unwrap_impl(promptText)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -76,6 +70,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/element_handle.rb

@@ -412,6 +412,29 @@ module Playwright
       wrap_impl(@impl.select_text(force: unwrap_impl(force), timeout: unwrap_impl(timeout)))
     end
 
+    # 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](./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.
+    def set_checked(
+          checked,
+          force: nil,
+          noWaitAfter: nil,
+          position: nil,
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.set_checked(unwrap_impl(checked), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+    end
+    alias_method :checked=, :set_checked
+
     # This method expects `elementHandle` to point to an
     # [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
     #
@@ -525,14 +548,8 @@ module Playwright
     # ```
     #
     # > NOTE: This method does not work across navigations, use [`method: Page.waitForSelector`] instead.
-    def wait_for_selector(selector, state: nil, timeout: nil)
-      wrap_impl(@impl.wait_for_selector(unwrap_impl(selector), state: unwrap_impl(state), timeout: unwrap_impl(timeout)))
-    end
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
+      wrap_impl(@impl.wait_for_selector(unwrap_impl(selector), state: unwrap_impl(state), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
     # -- inherited from EventEmitter --
@@ -547,6 +564,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/frame.rb

@@ -524,6 +524,31 @@ 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.
+    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
@@ -738,12 +763,6 @@ module Playwright
       wrap_impl(@impl.detached=(unwrap_impl(req)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -756,6 +775,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/js_handle.rb

@@ -88,12 +88,6 @@ module Playwright
       wrap_impl(@impl.to_s)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -106,6 +100,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/locator.rb

@@ -40,6 +40,9 @@ module Playwright
   #
   # # 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()
   # ```
   class Locator < PlaywrightApi
 
@@ -435,6 +438,29 @@ module Playwright
       wrap_impl(@impl.select_text(force: unwrap_impl(force), timeout: unwrap_impl(timeout)))
     end
 
+    # 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](./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.
+    def set_checked(
+          checked,
+          force: nil,
+          noWaitAfter: nil,
+          position: nil,
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.set_checked(unwrap_impl(checked), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+    end
+    alias_method :checked=, :set_checked
+
     # This method expects `element` to point to an
     # [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
     #

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
@@ -818,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:
     #
@@ -855,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.
@@ -905,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
@@ -1350,12 +1380,6 @@ module Playwright
       wrap_impl(@impl.guid)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -1368,6 +1392,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/playwright.rb

@@ -91,12 +91,6 @@ module Playwright
       wrap_impl(@impl.electron)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -109,6 +103,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

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,17 @@ 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
+
     # Whether this request is driving frame's navigation.
     def navigation_request?
       wrap_impl(@impl.navigation_request?)
@@ -109,6 +120,12 @@ module Playwright
       wrap_impl(@impl.response)
     end
 
+    # Returns resource size information for given request. Requires the response to be finished via
+    # [`method: Response.finished`] to ensure the info is available.
+    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,10 +145,9 @@ module Playwright
       wrap_impl(@impl.url)
     end
 
-    # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def parse_headers_as_array(serialized_headers, downcase)
+      wrap_impl(@impl.parse_headers_as_array(unwrap_impl(serialized_headers), unwrap_impl(downcase)))
     end
 
     # -- inherited from EventEmitter --
@@ -146,6 +162,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/response.rb

@@ -2,6 +2,11 @@ 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)
@@ -17,11 +22,17 @@ 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 JSON representation of response body.
     #
     # This method will throw if the response body is not parsable via `JSON.parse`.
@@ -74,10 +85,9 @@ module Playwright
       wrap_impl(@impl.ok?)
     end
 
-    # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def parse_headers_as_array(serialized_headers, downcase)
+      wrap_impl(@impl.parse_headers_as_array(unwrap_impl(serialized_headers), unwrap_impl(downcase)))
     end
 
     # -- inherited from EventEmitter --
@@ -92,6 +102,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end