playwright-ruby-client 1.28.1 → 1.29.1.alpha1

data/lib/playwright_api/cdp_session.rb

@@ -6,10 +6,8 @@ module Playwright
   # - protocol events can be subscribed to with `session.on` method.
   #
   # Useful links:
-  # - Documentation on DevTools Protocol can be found here:
-  #   [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).
-  # - Getting Started with DevTools Protocol:
-  #   https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
+  # - Documentation on DevTools Protocol can be found here: [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).
+  # - Getting Started with DevTools Protocol: https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
   #
   # ```python sync
   # client = page.context.new_cdp_session(page)
@@ -23,6 +21,7 @@ module Playwright
   # ```
   class CDPSession < PlaywrightApi
 
+    #
     # Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used to
     # send messages.
     def detach
@@ -35,20 +34,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/console_message.rb

@@ -1,6 +1,8 @@
 module Playwright
-  # `ConsoleMessage` objects are dispatched by page via the [`event: Page.console`] event. For each console messages logged
-  # in the page there will be corresponding event in the Playwright context.
+  #
+  # `ConsoleMessage` objects are dispatched by page via the [`event: Page.console`] event.
+  # For each console messages logged in the page there will be corresponding event in the Playwright
+  # context.
   #
   # ```python sync
   # # Listen for all console logs
@@ -21,6 +23,7 @@ module Playwright
   # ```
   class ConsoleMessage < PlaywrightApi
 
+    #
     # List of arguments passed to a `console` function call. See also [`event: Page.console`].
     def args
       wrap_impl(@impl.args)
@@ -30,11 +33,13 @@ module Playwright
       wrap_impl(@impl.location)
     end
 
+    #
     # The text of the console message.
     def text
       wrap_impl(@impl.text)
     end
 
+    #
     # One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`,
     # `'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`,
     # `'count'`, `'timeEnd'`.
@@ -44,20 +49,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/dialog.rb

@@ -1,4 +1,5 @@
 module Playwright
+  #
   # `Dialog` objects are dispatched by page via the [`event: Page.dialog`] event.
   #
   # An example of using `Dialog` class:
@@ -22,32 +23,35 @@ module Playwright
   #     run(playwright)
   # ```
   #
-  # > NOTE: Dialogs are dismissed automatically, unless there is a [`event: Page.dialog`] listener. When listener is
-  # present, it **must** either [`method: Dialog.accept`] or [`method: Dialog.dismiss`] the dialog - otherwise the page will
-  # [freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the dialog, and
-  # actions like click will never finish.
+  # **NOTE**: Dialogs are dismissed automatically, unless there is a [`event: Page.dialog`] listener.
+  # When listener is present, it **must** either [`method: Dialog.accept`] or [`method: Dialog.dismiss`] the dialog - otherwise the page will [freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the dialog, and actions like click will never finish.
   class Dialog < PlaywrightApi
 
+    #
     # Returns when the dialog has been accepted.
     def accept(promptText: nil)
       wrap_impl(@impl.accept(promptText: unwrap_impl(promptText)))
     end
 
+    #
     # If dialog is prompt, returns default prompt value. Otherwise, returns empty string.
     def default_value
       wrap_impl(@impl.default_value)
     end
 
+    #
     # Returns when the dialog has been dismissed.
     def dismiss
       wrap_impl(@impl.dismiss)
     end
 
+    #
     # A message displayed in the dialog.
     def message
       wrap_impl(@impl.message)
     end
 
+    #
     # Returns dialog's type, can be one of `alert`, `beforeunload`, `confirm` or `prompt`.
     def type
       wrap_impl(@impl.type)
@@ -60,20 +64,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/download.rb

@@ -1,7 +1,9 @@
 module Playwright
+  #
   # `Download` objects are dispatched by page via the [`event: Page.download`] event.
   #
-  # All the downloaded files belonging to the browser context are deleted when the browser context is closed.
+  # All the downloaded files belonging to the browser context are deleted when the
+  # browser context is closed.
   #
   # Download event is emitted once the download starts. Download path becomes available once download completes:
   #
@@ -14,42 +16,49 @@ module Playwright
   # ```
   class Download < PlaywrightApi
 
-    # Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations,
-    # `download.failure()` would resolve to `'canceled'`.
+    #
+    # Cancels a download. Will not fail if the download is already finished or canceled.
+    # Upon successful cancellations, `download.failure()` would resolve to `'canceled'`.
     def cancel
       wrap_impl(@impl.cancel)
     end
 
+    #
     # Deletes the downloaded file. Will wait for the download to finish if necessary.
     def delete
       wrap_impl(@impl.delete)
     end
 
+    #
     # Returns download error if any. Will wait for the download to finish if necessary.
     def failure
       wrap_impl(@impl.failure)
     end
 
+    #
     # Get the page that the download belongs to.
     def page
       wrap_impl(@impl.page)
     end
 
-    # Returns path to the downloaded file in case of successful download. The method will wait for the download to finish if
-    # necessary. The method throws when connected remotely.
     #
-    # Note that the download's file name is a random GUID, use [`method: Download.suggestedFilename`] to get suggested file
-    # name.
+    # Returns path to the downloaded file in case of successful download. The method will
+    # wait for the download to finish if necessary. The method throws when connected remotely.
+    #
+    # Note that the download's file name is a random GUID, use [`method: Download.suggestedFilename`]
+    # to get suggested file name.
     def path
       wrap_impl(@impl.path)
     end
 
-    # Copy the download to a user-specified path. It is safe to call this method while the download is still in progress. Will
-    # wait for the download to finish if necessary.
+    #
+    # Copy the download to a user-specified path. It is safe to call this method while the download
+    # is still in progress. Will wait for the download to finish if necessary.
     def save_as(path)
       wrap_impl(@impl.save_as(unwrap_impl(path)))
     end
 
+    #
     # Returns suggested filename for this download. It is typically computed by the browser from the
     # [`Content-Disposition`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) response header
     # or the `download` attribute. See the spec on [whatwg](https://html.spec.whatwg.org/#downloading-resources). Different
@@ -58,6 +67,7 @@ module Playwright
       wrap_impl(@impl.suggested_filename)
     end
 
+    #
     # Returns downloaded url.
     def url
       wrap_impl(@impl.url)