playwright-ruby-client 0.2.1 → 0.3.0

data/lib/playwright_api/browser_type.rb

@@ -77,19 +77,19 @@ module Playwright
     # )
     # ```
     # 
-    # > **Chromium-only** Playwright can also be used to control the Chrome browser, but it works best with the version of
-    # Chromium it is bundled with. There is no guarantee it will work with any other version. Use `executablePath` option with
-    # extreme caution.
+    # > **Chromium-only** Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works
+    # best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use
+    # `executablePath` option with extreme caution.
     # >
     # > If Google Chrome (rather than Chromium) is preferred, a
     # [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or
     # [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested.
     # >
-    # > In [`method: BrowserType.launch`] above, any mention of Chromium also applies to Chrome.
-    # >
-    # > See [`this article`](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for
-    # a description of the differences between Chromium and Chrome.
-    # [`This article`](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md)
+    # > Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for
+    # video playback. See
+    # [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for other
+    # differences between Chromium and Chrome.
+    # [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md)
     # describes some differences for Linux users.
     def launch(
           args: nil,
@@ -163,20 +163,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/chromium_browser_context.rb

@@ -36,20 +36,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

@@ -23,20 +23,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

@@ -68,27 +68,54 @@ module Playwright
 
     # Returns when the dialog has been accepted.
     def accept(promptText: nil)
-      raise NotImplementedError.new('accept is not implemented yet.')
+      wrap_impl(@impl.accept(promptText: unwrap_impl(promptText)))
     end
 
     # If dialog is prompt, returns default prompt value. Otherwise, returns empty string.
     def default_value
-      raise NotImplementedError.new('default_value is not implemented yet.')
+      wrap_impl(@impl.default_value)
     end
 
     # Returns when the dialog has been dismissed.
     def dismiss
-      raise NotImplementedError.new('dismiss is not implemented yet.')
+      wrap_impl(@impl.dismiss)
     end
 
     # A message displayed in the dialog.
     def message
-      raise NotImplementedError.new('message is not implemented yet.')
+      wrap_impl(@impl.message)
     end
 
     # Returns dialog's type, can be one of `alert`, `beforeunload`, `confirm` or `prompt`.
     def type
-      raise NotImplementedError.new('type is not implemented yet.')
+      wrap_impl(@impl.type)
+    end
+
+    # @nodoc
+    def accept_async(promptText: nil)
+      wrap_impl(@impl.accept_async(promptText: unwrap_impl(promptText)))
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      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
   end
 end

data/lib/playwright_api/download.rb

@@ -72,20 +72,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/element_handle.rb

@@ -635,20 +635,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/file_chooser.rb

@@ -1,5 +1,5 @@
 module Playwright
-  # `FileChooser` objects are dispatched by the page in the [`event: Page.filechooser`] event.
+  # `FileChooser` objects are dispatched by the page in the [`event: Page.fileChooser`] event.
   # 
   #
   # ```js

data/lib/playwright_api/frame.rb

@@ -3,10 +3,10 @@ module Playwright
   # [`method: Frame.childFrames`] methods.
   # 
   # `Frame` object's lifecycle is controlled by three events, dispatched on the page object:
-  # - [`event: Page.frameattached`] - fired when the frame gets attached to the page. A Frame can be attached to the page
+  # - [`event: Page.frameAttached`] - fired when the frame gets attached to the page. A Frame can be attached to the page
   #   only once.
-  # - [`event: Page.framenavigated`] - fired when the frame commits navigation to a different URL.
-  # - [`event: Page.framedetached`] - fired when the frame gets detached from the page.  A Frame can be detached from the
+  # - [`event: Page.frameNavigated`] - fired when the frame commits navigation to a different URL.
+  # - [`event: Page.frameDetached`] - fired when the frame gets detached from the page.  A Frame can be detached from the
   #   page only once.
   # 
   # An example of dumping frame tree:
@@ -539,12 +539,14 @@ module Playwright
       wrap_impl(@impl.enabled?(unwrap_impl(selector), timeout: unwrap_impl(timeout)))
     end
 
-    # Returns whether the element is hidden, the opposite of [visible](./actionability.md#visible).
+    # Returns whether the element is hidden, the opposite of [visible](./actionability.md#visible).  `selector` that does not
+    # match any elements is considered hidden.
     def hidden?(selector, timeout: nil)
       wrap_impl(@impl.hidden?(unwrap_impl(selector), timeout: unwrap_impl(timeout)))
     end
 
-    # Returns whether the element is [visible](./actionability.md#visible).
+    # Returns whether the element is [visible](./actionability.md#visible). `selector` that does not match any elements is
+    # considered not visible.
     def visible?(selector, timeout: nil)
       wrap_impl(@impl.visible?(unwrap_impl(selector), timeout: unwrap_impl(timeout)))
     end
@@ -962,20 +964,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/js_handle.rb

@@ -124,20 +124,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/page.rb

@@ -984,12 +984,14 @@ module Playwright
       wrap_impl(@impl.enabled?(unwrap_impl(selector), timeout: unwrap_impl(timeout)))
     end
 
-    # Returns whether the element is hidden, the opposite of [visible](./actionability.md#visible).
+    # Returns whether the element is hidden, the opposite of [visible](./actionability.md#visible).  `selector` that does not
+    # match any elements is considered hidden.
     def hidden?(selector, timeout: nil)
       wrap_impl(@impl.hidden?(unwrap_impl(selector), timeout: unwrap_impl(timeout)))
     end
 
-    # Returns whether the element is [visible](./actionability.md#visible).
+    # Returns whether the element is [visible](./actionability.md#visible). `selector` that does not match any elements is
+    # considered not visible.
     def visible?(selector, timeout: nil)
       wrap_impl(@impl.visible?(unwrap_impl(selector), timeout: unwrap_impl(timeout)))
     end
@@ -1010,7 +1012,7 @@ module Playwright
     # User can inspect selectors or perform manual steps while paused. Resume will continue running the original script from
     # the place it was paused.
     # 
-    # > NOTE: This method requires Playwright to be started in a headed mode, with a falsy [`options: headless`] value in the
+    # > NOTE: This method requires Playwright to be started in a headed mode, with a falsy `headless` value in the
     # [`method: BrowserType.launch`].
     def pause
       raise NotImplementedError.new('pause is not implemented yet.')
@@ -1236,7 +1238,7 @@ module Playwright
     # 
     # > NOTE: Enabling routing disables http cache.
     def route(url, handler)
-      raise NotImplementedError.new('route is not implemented yet.')
+      wrap_impl(@impl.route(unwrap_impl(url), unwrap_impl(handler)))
     end
 
     # Returns the buffer with the captured screenshot.
@@ -1467,7 +1469,7 @@ module Playwright
 
     # Removes a route created with [`method: Page.route`]. When `handler` is not specified, removes all routes for the `url`.
     def unroute(url, handler: nil)
-      raise NotImplementedError.new('unroute is not implemented yet.')
+      wrap_impl(@impl.unroute(unwrap_impl(url), handler: unwrap_impl(handler)))
     end
 
     # Shortcut for main frame's [`method: Frame.url`].
@@ -1484,6 +1486,20 @@ module Playwright
       wrap_impl(@impl.viewport_size)
     end
 
+    # Performs action and waits for a [ConoleMessage] to be logged by in the page. If predicate is provided, it passes
+    # `ConsoleMessage` value into the `predicate` function and waits for `predicate(message)` to return a truthy value. Will
+    # throw an error if the page is closed before the console event is fired.
+    def expect_console_message(predicate: nil, timeout: nil, &block)
+      wrap_impl(@impl.expect_console_message(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
+    end
+
+    # Performs action and waits for a new `Download`. If predicate is provided, it passes `Download` value into the
+    # `predicate` function and waits for `predicate(download)` to return a truthy value. Will throw an error if the page is
+    # closed before the download event is fired.
+    def expect_download(predicate: nil, timeout: nil, &block)
+      wrap_impl(@impl.expect_download(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
+    end
+
     # 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.
     # 
@@ -1510,6 +1526,13 @@ module Playwright
       wrap_impl(@impl.expect_event(unwrap_impl(event), predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
+    # Performs action and waits for a new `FileChooser` to be created. If predicate is provided, it passes `FileChooser` value
+    # into the `predicate` function and waits for `predicate(fileChooser)` to return a truthy value. Will throw an error if
+    # the page is closed before the file chooser is opened.
+    def expect_file_chooser(predicate: nil, timeout: nil, &block)
+      wrap_impl(@impl.expect_file_chooser(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
+    end
+
     # Returns when the `expression` returns a truthy value. It resolves to a JSHandle of the truthy value.
     # 
     # The [`method: Page.waitForFunction`] can be used to observe viewport size change:
@@ -1674,6 +1697,13 @@ module Playwright
       wrap_impl(@impl.expect_navigation(timeout: unwrap_impl(timeout), url: unwrap_impl(url), waitUntil: unwrap_impl(waitUntil), &wrap_block_call(block)))
     end
 
+    # Performs action and waits for a popup `Page`. If predicate is provided, it passes [Popup] value into the `predicate`
+    # function and waits for `predicate(page)` to return a truthy value. Will throw an error if the page is closed before the
+    # popup event is fired.
+    def expect_popup(predicate: nil, timeout: nil, &block)
+      wrap_impl(@impl.expect_popup(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
+    end
+
     # Waits for the matching request and returns it.
     # 
     #
@@ -1826,6 +1856,13 @@ module Playwright
       raise NotImplementedError.new('wait_for_timeout is not implemented yet.')
     end
 
+    # Performs action and waits for a new `Worker`. If predicate is provided, it passes `Worker` value into the `predicate`
+    # function and waits for `predicate(worker)` to return a truthy value. Will throw an error if the page is closed before
+    # the worker event is fired.
+    def expect_worker(predicate: nil, timeout: nil)
+      raise NotImplementedError.new('expect_worker is not implemented yet.')
+    end
+
     # This method returns all of the dedicated [WebWorkers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)
     # associated with the page.
     # 
@@ -1834,41 +1871,6 @@ module Playwright
       raise NotImplementedError.new('workers is not implemented yet.')
     end
 
-    # Performs action and waits for `download` event to fire. If predicate is provided, it passes `Download` value into the
-    # `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if the page is
-    # closed before the download event is fired.
-    def expect_download(predicate: nil, timeout: nil, &block)
-      wrap_impl(@impl.expect_download(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
-    end
-
-    # Performs action and waits for `popup` event to fire. If predicate is provided, it passes [Popup] value into the
-    # `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if the page is
-    # closed before the popup event is fired.
-    def expect_popup(predicate: nil, timeout: nil, &block)
-      wrap_impl(@impl.expect_popup(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
-    end
-
-    # Performs action and waits for `worker` event to fire. If predicate is provided, it passes `Worker` value into the
-    # `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if the page is
-    # closed before the worker event is fired.
-    def expect_worker(predicate: nil, timeout: nil)
-      raise NotImplementedError.new('expect_worker is not implemented yet.')
-    end
-
-    # Performs action and waits for `console` event to fire. If predicate is provided, it passes `ConsoleMessage` value into
-    # the `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if the page is
-    # closed before the worker event is fired.
-    def expect_console_message(predicate: nil, timeout: nil, &block)
-      wrap_impl(@impl.expect_console_message(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
-    end
-
-    # Performs action and waits for `filechooser` event to fire. If predicate is provided, it passes `FileChooser` value into
-    # the `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if the page is
-    # closed before the worker event is fired.
-    def expect_file_chooser(predicate: nil, timeout: nil, &block)
-      wrap_impl(@impl.expect_file_chooser(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
-    end
-
     # > NOTE: In most cases, you should use [`method: Page.waitForEvent`].
     # 
     # Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function and
@@ -1885,20 +1887,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