playwright-ruby-client 1.48.1 → 1.50.0

data/lib/playwright_api/api_request_context.rb

@@ -294,14 +294,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/browser.rb

@@ -30,7 +30,7 @@ module Playwright
     # 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 [`method: BrowserContext.close`] on any `BrowserContext`'s you explicitly created earlier with [`method: Browser.newContext`] **before** calling [`method: Browser.close`].
+    # **NOTE**: This is similar to force-quitting the browser. To close pages gracefully and ensure you receive page close events, call [`method: BrowserContext.close`] on any `BrowserContext` instances you explicitly created earlier using [`method: Browser.newContext`] **before** calling [`method: Browser.close`].
     #
     # The `Browser` object itself is considered to be disposed and cannot be used anymore.
     def close(reason: nil)
@@ -209,14 +209,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_context.rb

@@ -463,6 +463,11 @@ module Playwright
       raise NotImplementedError.new('wait_for_event is not implemented yet.')
     end
 
+    # @nodoc
+    def enable_debug_console!
+      wrap_impl(@impl.enable_debug_console!)
+    end
+
     # @nodoc
     def pause
       wrap_impl(@impl.pause)
@@ -474,18 +479,13 @@ module Playwright
     end
 
     # @nodoc
-    def owner_page=(req)
-      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
-    end
-
-    # @nodoc
-    def enable_debug_console!
-      wrap_impl(@impl.enable_debug_console!)
+    def browser=(req)
+      wrap_impl(@impl.browser=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def browser=(req)
-      wrap_impl(@impl.browser=(unwrap_impl(req)))
+    def owner_page=(req)
+      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
     # -- inherited from EventEmitter --
@@ -496,14 +496,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_type.rb

@@ -20,13 +20,10 @@ module Playwright
   class BrowserType < PlaywrightApi
 
     #
-    # This method attaches Playwright to an existing browser instance. When connecting to another browser launched via `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is compatible with 1.2.x).
-    def connect(
-          wsEndpoint,
-          exposeNetwork: nil,
-          headers: nil,
-          slowMo: nil,
-          timeout: nil)
+    # This method attaches Playwright to an existing browser instance created via `BrowserType.launchServer` in Node.js.
+    #
+    # **NOTE**: The major and minor version of the Playwright instance that connects needs to match the version of Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).
+    def connect
       raise NotImplementedError.new('connect is not implemented yet.')
     end
 
@@ -37,6 +34,8 @@ module Playwright
     #
     # **NOTE**: Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
     #
+    # **NOTE**: This connection is significantly lower fidelity than the Playwright protocol connection via [`method: BrowserType.connect`]. If you are experiencing issues or attempting to use advanced functionality, you probably want to use [`method: BrowserType.connect`].
+    #
     # **Usage**
     #
     # ```python sync
@@ -183,14 +182,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/cdp_session.rb

@@ -39,14 +39,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/clock.rb

@@ -65,6 +65,16 @@ module Playwright
     # page.clock.pause_at(datetime.datetime(2020, 2, 2))
     # page.clock.pause_at("2020-02-02")
     # ```
+    #
+    # For best results, install the clock before navigating the page and set it to a time slightly before the intended test time. This ensures that all timers run normally during page loading, preventing the page from getting stuck. Once the page has fully loaded, you can safely use [`method: Clock.pauseAt`] to pause the clock.
+    #
+    # ```python sync
+    # # Initialize clock with some time before the test time and let the page load
+    # # naturally. `Date.now` will progress as the timers fire.
+    # page.clock.install(time=datetime.datetime(2024, 12, 10, 8, 0, 0))
+    # page.goto("http://localhost:3333")
+    # page.clock.pause_at(datetime.datetime(2024, 12, 10, 10, 0, 0))
+    # ```
     def pause_at(time)
       wrap_impl(@impl.pause_at(unwrap_impl(time)))
     end
@@ -79,6 +89,8 @@ module Playwright
     # Makes `Date.now` and `new Date()` return fixed fake time at all times,
     # keeps all the timers running.
     #
+    # Use this method for simple scenarios where you only need to test with a predefined time. For more advanced scenarios, use [`method: Clock.install`] instead. Read docs on [clock emulation](../clock.md) to learn more.
+    #
     # **Usage**
     #
     # ```python sync
@@ -92,7 +104,7 @@ module Playwright
     alias_method :fixed_time=, :set_fixed_time
 
     #
-    # Sets current system time but does not trigger any timers.
+    # Sets system time, but does not trigger any timers. Use this to test how the web page reacts to a time shift, for example switching from summer to winter time, or changing time zones.
     #
     # **Usage**
     #

data/lib/playwright_api/dialog.rb

@@ -76,14 +76,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/element_handle.rb

@@ -580,14 +580,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/frame.rb

@@ -1039,13 +1039,13 @@ module Playwright
     end
 
     # @nodoc
-    def detached=(req)
-      wrap_impl(@impl.detached=(unwrap_impl(req)))
+    def highlight(selector)
+      wrap_impl(@impl.highlight(unwrap_impl(selector)))
     end
 
     # @nodoc
-    def highlight(selector)
-      wrap_impl(@impl.highlight(unwrap_impl(selector)))
+    def detached=(req)
+      wrap_impl(@impl.detached=(unwrap_impl(req)))
     end
 
     # -- inherited from EventEmitter --
@@ -1056,14 +1056,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/js_handle.rb

@@ -106,14 +106,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/keyboard.rb

@@ -30,10 +30,7 @@ module Playwright
   # An example to trigger select-all with the keyboard
   #
   # ```python sync
-  # # on windows and linux
-  # page.keyboard.press("Control+A")
-  # # on mac_os
-  # page.keyboard.press("Meta+A")
+  # page.keyboard.press("ControlOrMeta+A")
   # ```
   class Keyboard < PlaywrightApi
 

data/lib/playwright_api/locator.rb

@@ -67,6 +67,46 @@ module Playwright
       wrap_impl(@impl.and(unwrap_impl(locator)))
     end
 
+    #
+    # Captures the aria snapshot of the given element.
+    # Read more about [aria snapshots](../aria-snapshots.md) and [`method: LocatorAssertions.toMatchAriaSnapshot`] for the corresponding assertion.
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # page.get_by_role("link").aria_snapshot()
+    # ```
+    #
+    # **Details**
+    #
+    # This method captures the aria snapshot of the given element. The snapshot is a string that represents the state of the element and its children.
+    # The snapshot can be used to assert the state of the element in the test, or to compare it to state in the future.
+    #
+    # The ARIA snapshot is represented using [YAML](https://yaml.org/spec/1.2.2/) markup language:
+    # - The keys of the objects are the roles and optional accessible names of the elements.
+    # - The values are either text content or an array of child elements.
+    # - Generic static text can be represented with the `text` key.
+    #
+    # Below is the HTML markup and the respective ARIA snapshot:
+    #
+    # ```html
+    # <ul aria-label="Links">
+    #   <li><a href="/">Home</a></li>
+    #   <li><a href="/about">About</a></li>
+    # <ul>
+    # ```
+    #
+    # ```yml
+    # - list "Links":
+    #   - listitem:
+    #     - link "Home"
+    #   - listitem:
+    #     - link "About"
+    # ```
+    def aria_snapshot(timeout: nil)
+      wrap_impl(@impl.aria_snapshot(timeout: unwrap_impl(timeout)))
+    end
+
     #
     # Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/blur) on the element.
     def blur(timeout: nil)
@@ -269,7 +309,6 @@ module Playwright
     # You can also specify `JSHandle` as the property value if you want live objects to be passed into the event:
     #
     # ```python sync
-    # # note you can only create data_transfer in chromium and firefox
     # data_transfer = page.evaluate_handle("new DataTransfer()")
     # locator.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})
     # ```
@@ -761,7 +800,7 @@ module Playwright
     end
 
     #
-    # Returns whether the element is [editable](../actionability.md#editable).
+    # Returns whether the element is [editable](../actionability.md#editable). If the target element is not an `<input>`, `<textarea>`, `<select>`, `[contenteditable]` and does not have a role allowing `[aria-readonly]`, this method throws an error.
     #
     # **NOTE**: If you need to assert that an element is editable, prefer [`method: LocatorAssertions.toBeEditable`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
     #
@@ -856,16 +895,19 @@ module Playwright
     #
     # Creates a locator matching all elements that match one or both of the two locators.
     #
-    # Note that when both locators match something, the resulting locator will have multiple matches and violate [locator strictness](../locators.md#strictness) guidelines.
+    # Note that when both locators match something, the resulting locator will have multiple matches, potentially causing a [locator strictness](../locators.md#strictness) violation.
     #
     # **Usage**
     #
     # Consider a scenario where you'd like to click on a "New email" button, but sometimes a security settings dialog shows up instead. In this case, you can wait for either a "New email" button, or a dialog and act accordingly.
     #
+    # **NOTE**: If both "New email" button and security dialog appear on screen, the "or" locator will match both of them,
+    # possibly throwing the ["strict mode violation" error](../locators.md#strictness). In this case, you can use [`method: Locator.first`] to only match one of them.
+    #
     # ```python sync
     # new_email = page.get_by_role("button", name="New")
     # dialog = page.get_by_text("Confirm security settings")
-    # expect(new_email.or_(dialog)).to_be_visible()
+    # expect(new_email.or_(dialog).first).to_be_visible()
     # if (dialog.is_visible()):
     #   page.get_by_role("button", name="Dismiss").click()
     # new_email.click()

data/lib/playwright_api/locator_assertions.rb

@@ -84,6 +84,12 @@ module Playwright
       wrap_impl(@impl.not_to_have_accessible_description(unwrap_impl(name), ignoreCase: unwrap_impl(ignoreCase), timeout: unwrap_impl(timeout)))
     end
 
+    #
+    # The opposite of [`method: LocatorAssertions.toHaveAccessibleErrorMessage`].
+    def not_to_have_accessible_error_message(errorMessage, ignoreCase: nil, timeout: nil)
+      wrap_impl(@impl.not_to_have_accessible_error_message(unwrap_impl(errorMessage), ignoreCase: unwrap_impl(ignoreCase), timeout: unwrap_impl(timeout)))
+    end
+
     #
     # The opposite of [`method: LocatorAssertions.toHaveAccessibleName`].
     def not_to_have_accessible_name(name, ignoreCase: nil, timeout: nil)
@@ -150,6 +156,12 @@ module Playwright
       wrap_impl(@impl.not_to_have_values(unwrap_impl(values), timeout: unwrap_impl(timeout)))
     end
 
+    #
+    # The opposite of [`method: LocatorAssertions.toMatchAriaSnapshot`].
+    def not_to_match_aria_snapshot(expected, timeout: nil)
+      wrap_impl(@impl.not_to_match_aria_snapshot(unwrap_impl(expected), timeout: unwrap_impl(timeout)))
+    end
+
     #
     # Ensures that `Locator` points to an element that is [connected](https://developer.mozilla.org/en-US/docs/Web/API/Node/isConnected) to a Document or a ShadowRoot.
     #
@@ -173,8 +185,8 @@ module Playwright
     # locator = page.get_by_label("Subscribe to newsletter")
     # expect(locator).to_be_checked()
     # ```
-    def to_be_checked(checked: nil, timeout: nil)
-      wrap_impl(@impl.to_be_checked(checked: unwrap_impl(checked), timeout: unwrap_impl(timeout)))
+    def to_be_checked(checked: nil, indeterminate: nil, timeout: nil)
+      wrap_impl(@impl.to_be_checked(checked: unwrap_impl(checked), indeterminate: unwrap_impl(indeterminate), timeout: unwrap_impl(timeout)))
     end
 
     #
@@ -385,6 +397,19 @@ module Playwright
       wrap_impl(@impl.to_have_accessible_description(unwrap_impl(description), ignoreCase: unwrap_impl(ignoreCase), timeout: unwrap_impl(timeout)))
     end
 
+    #
+    # Ensures the `Locator` points to an element with a given [aria errormessage](https://w3c.github.io/aria/#aria-errormessage).
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # locator = page.get_by_test_id("username-input")
+    # expect(locator).to_have_accessible_error_message("Username is required.")
+    # ```
+    def to_have_accessible_error_message(errorMessage, ignoreCase: nil, timeout: nil)
+      wrap_impl(@impl.to_have_accessible_error_message(unwrap_impl(errorMessage), ignoreCase: unwrap_impl(ignoreCase), timeout: unwrap_impl(timeout)))
+    end
+
     #
     # Ensures the `Locator` points to an element with a given [accessible name](https://w3c.github.io/accname/#dfn-accessible-name).
     #
@@ -414,24 +439,23 @@ module Playwright
     end
 
     #
-    # Ensures the `Locator` points to an element with given CSS classes. This needs to be a full match
-    # or using a relaxed regular expression.
+    # Ensures the `Locator` points to an element with given CSS classes. When a string is provided, it must fully match the element's `class` attribute. To match individual classes or perform partial matches, use a regular expression:
     #
     # **Usage**
     #
     # ```html
-    # <div class='selected row' id='component'></div>
+    # <div class='middle selected row' id='component'></div>
     # ```
     #
     # ```python sync
     # from playwright.sync_api import expect
     #
     # locator = page.locator("#component")
-    # expect(locator).to_have_class(re.compile(r"selected"))
-    # expect(locator).to_have_class("selected row")
+    # expect(locator).to_have_class(re.compile(r"(^|\\s)selected(\\s|$)"))
+    # expect(locator).to_have_class("middle selected row")
     # ```
     #
-    # Note that if array is passed as an expected value, entire lists of elements can be asserted:
+    # When an array is passed, the method asserts that the list of elements located matches the corresponding list of expected class values. Each element's class attribute is matched against the corresponding string or regular expression in the array:
     #
     # ```python sync
     # from playwright.sync_api import expect
@@ -616,5 +640,21 @@ module Playwright
     def to_have_values(values, timeout: nil)
       wrap_impl(@impl.to_have_values(unwrap_impl(values), timeout: unwrap_impl(timeout)))
     end
+
+    #
+    # Asserts that the target element matches the given [accessibility snapshot](../aria-snapshots.md).
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # page.goto("https://demo.playwright.dev/todomvc/")
+    # expect(page.locator('body')).to_match_aria_snapshot('''
+    #   - heading "todos"
+    #   - textbox "What needs to be done?"
+    # ''')
+    # ```
+    def to_match_aria_snapshot(expected, timeout: nil)
+      wrap_impl(@impl.to_match_aria_snapshot(unwrap_impl(expected), timeout: unwrap_impl(timeout)))
+    end
   end
 end

data/lib/playwright_api/page.rb

@@ -315,7 +315,6 @@ module Playwright
     # # → True
     # page.evaluate("matchMedia('(prefers-color-scheme: light)').matches")
     # # → False
-    # page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches")
     # ```
     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)))
@@ -958,8 +957,6 @@ module Playwright
     #
     # Returns the PDF buffer.
     #
-    # **NOTE**: Generating a pdf is currently only supported in Chromium headless.
-    #
     # `page.pdf()` generates a pdf of the page with `print` css media. To generate a pdf with `screen` media, call
     # [`method: Page.emulateMedia`] before calling `page.pdf()`:
     #
@@ -1796,13 +1793,13 @@ module Playwright
     end
 
     # @nodoc
-    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
-      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
+    def stop_js_coverage
+      wrap_impl(@impl.stop_js_coverage)
     end
 
     # @nodoc
-    def stop_js_coverage
-      wrap_impl(@impl.stop_js_coverage)
+    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
     # @nodoc
@@ -1811,13 +1808,13 @@ module Playwright
     end
 
     # @nodoc
-    def guid
-      wrap_impl(@impl.guid)
+    def owned_context=(req)
+      wrap_impl(@impl.owned_context=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def owned_context=(req)
-      wrap_impl(@impl.owned_context=(unwrap_impl(req)))
+    def guid
+      wrap_impl(@impl.guid)
     end
 
     # -- inherited from EventEmitter --
@@ -1828,14 +1825,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/playwright.rb

@@ -111,14 +111,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/request.rb

@@ -213,14 +213,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy

data/lib/playwright_api/response.rb

@@ -135,14 +135,14 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(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
 
     private def event_emitter_proxy