playwright-ruby-client 1.55.0 → 1.57.0

data/lib/playwright_api/page.rb

@@ -49,10 +49,6 @@ module Playwright
       wrap_impl(@impl.clock)
     end
 
-    def accessibility # property
-      wrap_impl(@impl.accessibility)
-    end
-
     def keyboard # property
       wrap_impl(@impl.keyboard)
     end
@@ -278,11 +274,12 @@ module Playwright
           force: nil,
           noWaitAfter: nil,
           sourcePosition: nil,
+          steps: nil,
           strict: nil,
           targetPosition: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.drag_and_drop(unwrap_impl(source), unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), sourcePosition: unwrap_impl(sourcePosition), strict: unwrap_impl(strict), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.drag_and_drop(unwrap_impl(source), unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), sourcePosition: unwrap_impl(sourcePosition), steps: unwrap_impl(steps), strict: unwrap_impl(strict), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     #
@@ -922,6 +919,18 @@ module Playwright
       wrap_impl(@impl.visible?(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
+    # Returns up to (currently) 200 last console messages from this page. See [`event: Page.console`] for more details.
+    def console_messages
+      wrap_impl(@impl.console_messages)
+    end
+
+    #
+    # Returns up to (currently) 200 last page errors from this page. See [`event: Page.pageError`] for more details.
+    def page_errors
+      wrap_impl(@impl.page_errors)
+    end
+
     #
     # The method returns an element locator that can be used to perform actions on this page / frame.
     # Locator is resolved to the 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.
@@ -1085,6 +1094,16 @@ module Playwright
       wrap_impl(@impl.query_selector_all(unwrap_impl(selector)))
     end
 
+    #
+    # Returns up to (currently) 100 last network request from this page. See [`event: Page.request`] for more details.
+    #
+    # Returned requests should be accessed immediately, otherwise they might be collected to prevent unbounded memory growth as new requests come in. Once collected, retrieving most information about the request is impossible.
+    #
+    # Note that requests reported through the [`event: Page.request`] request are not collected, so there is a trade off between efficient memory usage with [`method: Page.requests`] and the amount of available information reported through [`event: Page.request`].
+    def requests
+      wrap_impl(@impl.requests)
+    end
+
     #
     # When testing a web page, sometimes unexpected overlays like a "Sign up" dialog appear and block actions you want to automate, e.g. clicking a button. These overlays don't always show up in the same way or at the same time, making them tricky to handle in automated tests.
     #
@@ -1799,8 +1818,8 @@ module Playwright
     end
 
     # @nodoc
-    def snapshot_for_ai(timeout: nil)
-      wrap_impl(@impl.snapshot_for_ai(timeout: unwrap_impl(timeout)))
+    def snapshot_for_ai(timeout: nil, mode: nil, track: nil)
+      wrap_impl(@impl.snapshot_for_ai(timeout: unwrap_impl(timeout), mode: unwrap_impl(mode), track: unwrap_impl(track)))
     end
 
     # @nodoc
@@ -1808,11 +1827,6 @@ module Playwright
       wrap_impl(@impl.start_js_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
-    # @nodoc
-    def stop_js_coverage
-      wrap_impl(@impl.stop_js_coverage)
-    end
-
     # @nodoc
     def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
       wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
@@ -1828,6 +1842,11 @@ module Playwright
       wrap_impl(@impl.owned_context=(unwrap_impl(req)))
     end
 
+    # @nodoc
+    def stop_js_coverage
+      wrap_impl(@impl.stop_js_coverage)
+    end
+
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)

data/lib/playwright_api/worker.rb

@@ -46,9 +46,21 @@ module Playwright
       wrap_impl(@impl.url)
     end
 
-    # @nodoc
-    def page=(req)
-      wrap_impl(@impl.page=(unwrap_impl(req)))
+    #
+    # Waits for event to fire and passes its value into the predicate function.
+    # Returns when the predicate returns truthy value.
+    # Will throw an error if the page is closed before the event is fired.
+    # Returns the event data value.
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # with worker.expect_event("console") as event_info:
+    #     worker.evaluate("console.log(42)")
+    # message = event_info.value
+    # ```
+    def expect_event(event, predicate: nil, timeout: nil, &block)
+      wrap_impl(@impl.expect_event(unwrap_impl(event), predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
     # @nodoc
@@ -56,6 +68,11 @@ module Playwright
       wrap_impl(@impl.context=(unwrap_impl(req)))
     end
 
+    # @nodoc
+    def page=(req)
+      wrap_impl(@impl.page=(unwrap_impl(req)))
+    end
+
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)

data/sig/playwright.rbs

@@ -94,9 +94,9 @@ module Playwright
   class ElementHandle < JSHandle
     def bounding_box: -> (nil | Hash[untyped, untyped])
     def check: (?force: bool, ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
-    def click: (?button: ("left" | "right" | "middle"), ?clickCount: Integer, ?delay: Float, ?force: bool, ?modifiers: Array[untyped], ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
+    def click: (?button: ("left" | "right" | "middle"), ?clickCount: Integer, ?delay: Float, ?force: bool, ?modifiers: Array[untyped], ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?steps: Integer, ?timeout: Float, ?trial: bool) -> void
     def content_frame: -> (nil | Frame)
-    def dblclick: (?button: ("left" | "right" | "middle"), ?delay: Float, ?force: bool, ?modifiers: Array[untyped], ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
+    def dblclick: (?button: ("left" | "right" | "middle"), ?delay: Float, ?force: bool, ?modifiers: Array[untyped], ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?steps: Integer, ?timeout: Float, ?trial: bool) -> void
     def dispatch_event: (String type_, ?eventInit: untyped) -> void
     def eval_on_selector: (String selector, String expression, ?arg: untyped) -> untyped
     def eval_on_selector_all: (String selector, String expression, ?arg: untyped) -> untyped
@@ -134,10 +134,6 @@ module Playwright
     def wait_for_selector: (String selector, ?state: ("attached" | "detached" | "visible" | "hidden"), ?strict: bool, ?timeout: Float) -> (nil | ElementHandle)
   end
 
-  class Accessibility
-    def snapshot: (?interestingOnly: bool, ?root: ElementHandle) -> (nil | Hash[untyped, untyped])
-  end
-
   class FileChooser
     def element: -> ElementHandle
     def multiple?: -> bool
@@ -155,7 +151,7 @@ module Playwright
     def content: -> String
     def dblclick: (String selector, ?button: ("left" | "right" | "middle"), ?delay: Float, ?force: bool, ?modifiers: Array[untyped], ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?strict: bool, ?timeout: Float, ?trial: bool) -> void
     def dispatch_event: (String selector, String type_, ?eventInit: untyped, ?strict: bool, ?timeout: Float) -> void
-    def drag_and_drop: (String source, String target, ?force: bool, ?noWaitAfter: bool, ?sourcePosition: Hash[untyped, untyped], ?strict: bool, ?targetPosition: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
+    def drag_and_drop: (String source, String target, ?force: bool, ?noWaitAfter: bool, ?sourcePosition: Hash[untyped, untyped], ?steps: Integer, ?strict: bool, ?targetPosition: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
     def eval_on_selector: (String selector, String expression, ?arg: untyped, ?strict: bool) -> untyped
     def eval_on_selector_all: (String selector, String expression, ?arg: untyped) -> untyped
     def evaluate: (String expression, ?arg: untyped) -> untyped
@@ -215,6 +211,7 @@ module Playwright
     def evaluate: (String expression, ?arg: untyped) -> untyped
     def evaluate_handle: (String expression, ?arg: untyped) -> JSHandle
     def url: -> String
+    def expect_event: (String event, ?predicate: function, ?timeout: Float) { () -> void } -> untyped
   end
 
   class Selectors
@@ -241,6 +238,7 @@ module Playwright
     def page: -> (nil | Page)
     def text: -> String
     def type: -> ("log" | "debug" | "info" | "error" | "warning" | "dir" | "dirxml" | "table" | "trace" | "clear" | "startGroup" | "startGroupCollapsed" | "endGroup" | "assert" | "profile" | "profileEnd" | "count" | "timeEnd")
+    def worker: -> (nil | Worker)
   end
 
   class Dialog
@@ -275,7 +273,7 @@ module Playwright
     def context: -> BrowserContext
     def dblclick: (String selector, ?button: ("left" | "right" | "middle"), ?delay: Float, ?force: bool, ?modifiers: Array[untyped], ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?strict: bool, ?timeout: Float, ?trial: bool) -> void
     def dispatch_event: (String selector, String type_, ?eventInit: untyped, ?strict: bool, ?timeout: Float) -> void
-    def drag_and_drop: (String source, String target, ?force: bool, ?noWaitAfter: bool, ?sourcePosition: Hash[untyped, untyped], ?strict: bool, ?targetPosition: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
+    def drag_and_drop: (String source, String target, ?force: bool, ?noWaitAfter: bool, ?sourcePosition: Hash[untyped, untyped], ?steps: Integer, ?strict: bool, ?targetPosition: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
     def emulate_media: (?colorScheme: ("light" | "dark" | "no-preference" | "null"), ?contrast: ("no-preference" | "more" | "null"), ?forcedColors: ("active" | "none" | "null"), ?media: ("screen" | "print" | "null"), ?reducedMotion: ("reduce" | "no-preference" | "null")) -> void
     def eval_on_selector: (String selector, String expression, ?arg: untyped, ?strict: bool) -> untyped
     def eval_on_selector_all: (String selector, String expression, ?arg: untyped) -> untyped
@@ -311,6 +309,8 @@ module Playwright
     def enabled?: (String selector, ?strict: bool, ?timeout: Float) -> bool
     def hidden?: (String selector, ?strict: bool, ?timeout: Float) -> bool
     def visible?: (String selector, ?strict: bool, ?timeout: Float) -> bool
+    def console_messages: -> Array[untyped]
+    def page_errors: -> Array[untyped]
     def locator: (String selector, ?has: Locator, ?hasNot: Locator, ?hasNotText: (String | Regexp), ?hasText: (String | Regexp)) -> Locator
     def main_frame: -> Frame
     def opener: -> (nil | Page)
@@ -319,6 +319,7 @@ module Playwright
     def press: (String selector, String key, ?delay: Float, ?noWaitAfter: bool, ?strict: bool, ?timeout: Float) -> void
     def query_selector: (String selector, ?strict: bool) -> (nil | ElementHandle)
     def query_selector_all: (String selector) -> Array[untyped]
+    def requests: -> Array[untyped]
     def reload: (?timeout: Float, ?waitUntil: ("load" | "domcontentloaded" | "networkidle" | "commit")) -> (nil | Response)
     def route: ((String | Regexp | function) url, function handler, ?times: Integer) -> void
     def route_from_har: ((String | File) har, ?notFound: ("abort" | "fallback"), ?update: bool, ?updateContent: ("embed" | "attach"), ?updateMode: ("full" | "minimal"), ?url: (String | Regexp)) -> void
@@ -365,7 +366,6 @@ module Playwright
     def workers: -> Array[untyped]
 
     attr_reader clock: Clock
-    attr_reader accessibility: Accessibility
     attr_reader keyboard: Keyboard
     attr_reader mouse: Mouse
     attr_reader request: APIRequestContext
@@ -465,12 +465,13 @@ module Playwright
     def bounding_box: (?timeout: Float) -> (nil | Hash[untyped, untyped])
     def check: (?force: bool, ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
     def clear: (?force: bool, ?noWaitAfter: bool, ?timeout: Float) -> void
-    def click: (?button: ("left" | "right" | "middle"), ?clickCount: Integer, ?delay: Float, ?force: bool, ?modifiers: Array[untyped], ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
+    def click: (?button: ("left" | "right" | "middle"), ?clickCount: Integer, ?delay: Float, ?force: bool, ?modifiers: Array[untyped], ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?steps: Integer, ?timeout: Float, ?trial: bool) -> void
     def count: -> Integer
-    def dblclick: (?button: ("left" | "right" | "middle"), ?delay: Float, ?force: bool, ?modifiers: Array[untyped], ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
+    def dblclick: (?button: ("left" | "right" | "middle"), ?delay: Float, ?force: bool, ?modifiers: Array[untyped], ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?steps: Integer, ?timeout: Float, ?trial: bool) -> void
     def describe: (String description) -> Locator
+    def description: -> (nil | String)
     def dispatch_event: (String type_, ?eventInit: untyped, ?timeout: Float) -> void
-    def drag_to: (Locator target, ?force: bool, ?noWaitAfter: bool, ?sourcePosition: Hash[untyped, untyped], ?targetPosition: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
+    def drag_to: (Locator target, ?force: bool, ?noWaitAfter: bool, ?sourcePosition: Hash[untyped, untyped], ?steps: Integer, ?targetPosition: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
     def element_handle: (?timeout: Float) -> ElementHandle
     def element_handles: -> Array[untyped]
     def content_frame: -> FrameLocator

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.55.0
+  version: 1.57.0
 platform: ruby
 authors:
 - YusukeIwaki
@@ -199,6 +199,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -207,7 +208,6 @@ files:
 - bin/setup
 - documentation/README.md
 - documentation/babel.config.js
-- documentation/docs/api/accessibility.md
 - documentation/docs/api/api_request.md
 - documentation/docs/api/api_request_context.md
 - documentation/docs/api/api_response.md
@@ -276,7 +276,6 @@ files:
 - documentation/static/img/undraw_windows.svg
 - documentation/yarn.lock
 - lib/playwright.rb
-- lib/playwright/accessibility_impl.rb
 - lib/playwright/android_input_impl.rb
 - lib/playwright/api_implementation.rb
 - lib/playwright/api_response_impl.rb
@@ -350,7 +349,6 @@ files:
 - lib/playwright/waiter.rb
 - lib/playwright/web_socket_client.rb
 - lib/playwright/web_socket_transport.rb
-- lib/playwright_api/accessibility.rb
 - lib/playwright_api/android.rb
 - lib/playwright_api/android_device.rb
 - lib/playwright_api/android_input.rb
@@ -409,5 +407,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.55.0
+summary: The Ruby binding of playwright driver 1.57.0
 test_files: []

data/documentation/docs/api/accessibility.md

@@ -1,66 +0,0 @@
----
-sidebar_position: 10
----
-
-# Accessibility
-
-
-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).
-
-Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might
-have wildly different output.
-
-Rendering engines of Chromium, Firefox and WebKit have a concept of "accessibility tree", which is then translated into different
-platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
-
-Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific AX-Tree or by
-assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing only the
-"interesting" nodes of the tree.
-
-## snapshot
-
-```
-def snapshot(interestingOnly: nil, root: nil)
-```
-
-:::warning
-
-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.
-
-**NOTE**: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Playwright
-will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
-
-**Usage**
-
-An example of dumping the entire accessibility tree:
-
-```ruby
-snapshot = page.accessibility.snapshot
-puts snapshot
-```
-
-An example of logging the focused node's name:
-
-```ruby
-def find_focused_node(node)
-  if node['focused']
-    node
-  else
-    node['children']&.find do |child|
-      find_focused_node(child)
-    end
-  end
-end
-
-snapshot = page.accessibility.snapshot
-node = find_focused_node(snapshot)
-puts node['name']
-```

data/lib/playwright/accessibility_impl.rb

@@ -1,50 +0,0 @@
-module Playwright
-  define_api_implementation :AccessibilityImpl do
-    def initialize(channel)
-      @channel = channel
-    end
-
-    def snapshot(interestingOnly: nil, root: nil)
-      params = {
-        interestingOnly: interestingOnly,
-        root: root&.channel,
-      }.compact
-      result = @channel.send_message_to_server('accessibilitySnapshot', params)
-      format_ax_node_from_protocol(result) if result
-      result
-    end
-
-    # original JS implementation create a new Hash from ax_node,
-    # but this implementation directly modify ax_node and don't return hash.
-    private def format_ax_node_from_protocol(ax_node)
-      value = ax_node.delete('valueNumber') || ax_node.delete('valueString')
-      ax_node['value'] = value unless value.nil?
-
-      checked =
-        case ax_node['checked']
-        when 'checked'
-          true
-        when 'unchecked'
-          false
-        else
-          ax_node['checked']
-        end
-      ax_node['checked'] = checked unless checked.nil?
-
-      pressed =
-        case ax_node['pressed']
-        when 'pressed'
-          true
-        when 'released'
-          false
-        else
-          ax_node['pressed']
-        end
-      ax_node['pressed'] = pressed unless pressed.nil?
-
-      ax_node['children']&.each do |child|
-        format_ax_node_from_protocol(child)
-      end
-    end
-  end
-end

data/lib/playwright_api/accessibility.rb

@@ -1,57 +0,0 @@
-module Playwright
-  #
-  # 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).
-  #
-  # Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might
-  # have wildly different output.
-  #
-  # Rendering engines of Chromium, Firefox and WebKit have a concept of "accessibility tree", which is then translated into different
-  # platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
-  #
-  # Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific AX-Tree or by
-  # assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing only the
-  # "interesting" nodes of the tree.
-  class Accessibility < PlaywrightApi
-
-    #
-    # Captures the current state of the accessibility tree. The returned object represents the root accessible node of the
-    # page.
-    #
-    # **NOTE**: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Playwright
-    # will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
-    #
-    # **Usage**
-    #
-    # An example of dumping the entire accessibility tree:
-    #
-    # ```python sync
-    # snapshot = page.accessibility.snapshot()
-    # print(snapshot)
-    # ```
-    #
-    # An example of logging the focused node's name:
-    #
-    # ```python sync
-    # def find_focused_node(node):
-    #     if node.get("focused"):
-    #         return node
-    #     for child in (node.get("children") or []):
-    #         found_node = find_focused_node(child)
-    #         if found_node:
-    #             return found_node
-    #     return None
-    #
-    # snapshot = page.accessibility.snapshot()
-    # node = find_focused_node(snapshot)
-    # if node:
-    #     print(node["name"])
-    # ```
-    #
-    # @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.
-    def snapshot(interestingOnly: nil, root: nil)
-      wrap_impl(@impl.snapshot(interestingOnly: unwrap_impl(interestingOnly), root: unwrap_impl(root)))
-    end
-  end
-end