playwright-ruby-client 0.5.6 → 0.6.0

data/lib/playwright_api/browser_type.rb

@@ -64,8 +64,46 @@ module Playwright
   # with sync_playwright() as playwright:
   #     run(playwright)
   # ```
+  # 
+  # ```csharp
+  # using Microsoft.Playwright;
+  # using System.Threading.Tasks;
+  # 
+  # class BrowserTypeExamples
+  # {
+  #     public static async Task Run()
+  #     {
+  #         using var playwright = await Playwright.CreateAsync();
+  #         var chromium = playwright.Chromium;
+  #         var browser = await chromium.LaunchAsync();
+  #         var page = await browser.NewPageAsync();
+  #         await page.GoToAsync("https://www.bing.com");
+  #         // other actions
+  #         await browser.CloseAsync();
+  #     }
+  # }
+  # ```
   class BrowserType < PlaywrightApi
 
+    # This methods attaches Playwright to an existing browser instance.
+    def connect(wsEndpoint, headers: nil, slowMo: nil, timeout: nil)
+      raise NotImplementedError.new('connect is not implemented yet.')
+    end
+
+    # This methods attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
+    # 
+    # The default browser context is accessible via [`method: Browser.contexts`].
+    # 
+    # > NOTE: Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
+    def connect_over_cdp(
+          endpointURL,
+          headers: nil,
+          slowMo: nil,
+          timeout: nil,
+          &block)
+      wrap_impl(@impl.connect_over_cdp(unwrap_impl(endpointURL), headers: unwrap_impl(headers), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
+    end
+
     # A path where Playwright expects to find a bundled browser executable.
     def executable_path
       wrap_impl(@impl.executable_path)
@@ -100,6 +138,10 @@ module Playwright
     # )
     # ```
     # 
+    # ```csharp
+    # var browser = await playwright.Chromium.LaunchAsync(ignoreDefaultArgs: new[] { "--mute-audio" })
+    # ```
+    # 
     # > **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.
@@ -131,8 +173,9 @@ module Playwright
           proxy: nil,
           slowMo: nil,
           timeout: nil,
+          traceDir: nil,
           &block)
-      wrap_impl(@impl.launch(args: unwrap_impl(args), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), firefoxUserPrefs: unwrap_impl(firefoxUserPrefs), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), headless: unwrap_impl(headless), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), proxy: unwrap_impl(proxy), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
+      wrap_impl(@impl.launch(args: unwrap_impl(args), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), firefoxUserPrefs: unwrap_impl(firefoxUserPrefs), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), headless: unwrap_impl(headless), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), proxy: unwrap_impl(proxy), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), traceDir: unwrap_impl(traceDir), &wrap_block_call(block)))
     end
 
     # Returns the persistent browser context instance.
@@ -177,6 +220,7 @@ module Playwright
           slowMo: nil,
           timeout: nil,
           timezoneId: nil,
+          traceDir: nil,
           userAgent: nil,
           viewport: nil)
       raise NotImplementedError.new('launch_persistent_context is not implemented yet.')
@@ -187,9 +231,10 @@ module Playwright
       wrap_impl(@impl.name)
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def connect_over_cdp(endpointURL, slowMo: nil, timeout: nil, &block)
-      wrap_impl(@impl.connect_over_cdp(unwrap_impl(endpointURL), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -204,12 +249,6 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/console_message.rb

@@ -2,6 +2,7 @@ module Playwright
   # `ConsoleMessage` objects are dispatched by page via the [`event: Page.console`] event.
   class ConsoleMessage < PlaywrightApi
 
+    # List of arguments passed to a `console` function call. See also [`event: Page.console`].
     def args
       wrap_impl(@impl.args)
     end
@@ -10,6 +11,7 @@ module Playwright
       wrap_impl(@impl.location)
     end
 
+    # The text of the console message.
     def text
       wrap_impl(@impl.text)
     end
@@ -23,20 +25,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

@@ -80,6 +80,29 @@ module Playwright
   #     run(playwright)
   # ```
   # 
+  # ```csharp
+  # using Microsoft.Playwright;
+  # using System.Threading.Tasks;
+  # 
+  # class DialogExample
+  # {
+  #     public static async Task Run()
+  #     {
+  #         using var playwright = await Playwright.CreateAsync();
+  #         await using var browser = await playwright.Chromium.LaunchAsync();
+  #         var page = await browser.NewPageAsync();
+  # 
+  #         page.Dialog += async (_, dialog) =>
+  #         {
+  #             System.Console.WriteLine(dialog.Message);
+  #             await dialog.DismissAsync();
+  #         };
+  # 
+  #         await page.EvaluateAsync("alert('1');");
+  #     }
+  # }
+  # ```
+  # 
   # > 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
@@ -118,20 +141,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

@@ -73,6 +73,24 @@ module Playwright
   #     run(playwright)
   # ```
   # 
+  # ```csharp
+  # using Microsoft.Playwright;
+  # using System.Threading.Tasks;
+  # 
+  # class HandleExamples
+  # {
+  #     public static async Task Run()
+  #     {
+  #         using var playwright = await Playwright.CreateAsync();
+  #         var browser = await playwright.Chromium.LaunchAsync(headless: false);
+  #         var page = await browser.NewPageAsync();
+  #         await page.GotoAsync("https://www.bing.com");
+  #         var handle = await page.QuerySelectorAsync("a");
+  #         await handle.ClickAsync();
+  #     }
+  # }
+  # ```
+  # 
   # ElementHandle prevents DOM element from garbage collection unless the handle is disposed with
   # [`method: JSHandle.dispose`]. ElementHandles are auto-disposed when their origin frame gets navigated.
   # 
@@ -113,6 +131,11 @@ module Playwright
     # box = element_handle.bounding_box()
     # page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)
     # ```
+    # 
+    # ```csharp
+    # var box = await elementHandle.BoundingBoxAsync();
+    # await page.Mouse.ClickAsync(box.X + box.Width / 2, box.Y + box.Height / 2);
+    # ```
     def bounding_box
       wrap_impl(@impl.bounding_box)
     end
@@ -130,8 +153,13 @@ module Playwright
     # 
     # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
     # zero timeout disables this.
-    def check(force: nil, noWaitAfter: nil, position: nil, timeout: nil)
-      wrap_impl(@impl.check(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+    def check(
+          force: nil,
+          noWaitAfter: nil,
+          position: nil,
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.check(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # This method clicks the element by performing the following steps:
@@ -152,8 +180,9 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
-      wrap_impl(@impl.click(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.click(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns the content frame for element handles referencing iframe nodes, or `null` otherwise
@@ -181,8 +210,9 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
-      wrap_impl(@impl.dblclick(button: unwrap_impl(button), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.dblclick(button: unwrap_impl(button), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,
@@ -206,6 +236,10 @@ module Playwright
     # element_handle.dispatch_event("click")
     # ```
     # 
+    # ```csharp
+    # await elementHandle.DispatchEventAsync("click");
+    # ```
+    # 
     # Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit` properties
     # and dispatches it on the element. Events are `composed`, `cancelable` and bubble by default.
     # 
@@ -246,6 +280,14 @@ module Playwright
     # data_transfer = page.evaluate_handle("new DataTransfer()")
     # element_handle.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})
     # ```
+    # 
+    # ```csharp
+    # var handle = await page.EvaluateHandleAsync("() => new DataTransfer()");
+    # await handle.AsElement.DispatchEventAsync("dragstart", new Dictionary<string, object>
+    # {
+    #     { "dataTransfer", dataTransfer }
+    # });
+    # ```
     def dispatch_event(type, eventInit: nil)
       wrap_impl(@impl.dispatch_event(unwrap_impl(type), eventInit: unwrap_impl(eventInit)))
     end
@@ -285,6 +327,12 @@ module Playwright
     # assert tweet_handle.eval_on_selector(".like", "node => node.innerText") == "100"
     # assert tweet_handle.eval_on_selector(".retweets", "node => node.innerText") = "10"
     # ```
+    # 
+    # ```csharp
+    # var tweetHandle = await page.QuerySelectorAsync(".tweet");
+    # Assert.Equals("100", await tweetHandle.EvalOnSelectorAsync(".like", "node => node.innerText"));
+    # Assert.Equals("10", await tweetHandle.EvalOnSelectorAsync(".retweets", "node => node.innerText"));
+    # ```
     def eval_on_selector(selector, expression, arg: nil)
       wrap_impl(@impl.eval_on_selector(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
@@ -326,15 +374,24 @@ module Playwright
     # feed_handle = page.query_selector(".feed")
     # assert feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)") == ["hello!", "hi!"]
     # ```
+    # 
+    # ```csharp
+    # var feedHandle = await page.QuerySelectorAsync(".feed");
+    # Assert.Equals(new [] { "Hello!", "Hi!" }, await feedHandle.EvalOnSelectorAllAsync<string[]>(".tweet", "nodes => nodes.map(n => n.innerText)"));
+    # ```
     def eval_on_selector_all(selector, expression, arg: nil)
       wrap_impl(@impl.eval_on_selector_all(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
 
     # This method waits for [actionability](./actionability.md) checks, focuses the element, fills it and triggers an `input`
-    # event after filling. If the element is inside the `<label>` element that has associated
-    # [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), that control will be filled
-    # instead. If the element to be filled is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method
-    # throws an error. Note that you can pass an empty string to clear the input field.
+    # event after filling. Note that you can pass an empty string to clear the input field.
+    # 
+    # If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an error.
+    # However, if the element is inside the `<label>` element that has an associated
+    # [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled
+    # instead.
+    # 
+    # To send fine-grained keyboard events, use [`method: ElementHandle.type`].
     def fill(value, noWaitAfter: nil, timeout: nil)
       wrap_impl(@impl.fill(unwrap_impl(value), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
     end
@@ -360,8 +417,13 @@ module Playwright
     # 
     # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
     # zero timeout disables this.
-    def hover(force: nil, modifiers: nil, position: nil, timeout: nil)
-      wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+    def hover(
+          force: nil,
+          modifiers: nil,
+          position: nil,
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns the `element.innerHTML`.
@@ -466,12 +528,16 @@ module Playwright
       wrap_impl(@impl.scroll_into_view_if_needed(timeout: unwrap_impl(timeout)))
     end
 
-    # Returns the array of option values that have been successfully selected.
+    # This method waits for [actionability](./actionability.md) checks, waits until all specified options are present in the
+    # `<select>` element and selects these options.
+    # 
+    # If the target element is not a `<select>` element, this method throws an error. However, if the element is inside the
+    # `<label>` element that has an associated
+    # [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be used instead.
     # 
-    # Triggers a `change` and `input` event once all the provided options have been selected. If element is not a `<select>`
-    # element, the method throws an error.
+    # Returns the array of option values that have been successfully selected.
     # 
-    # Will wait until all specified options are present in the `<select>` element.
+    # Triggers a `change` and `input` event once all the provided options have been selected.
     # 
     #
     # ```js
@@ -522,6 +588,20 @@ module Playwright
     # # multiple selection for blue, red and second option
     # handle.select_option(value="blue", { index: 2 }, "red")
     # ```
+    # 
+    # ```csharp
+    # // single selection matching the value
+    # await handle.SelectOptionAsync(new[] { "blue" });
+    # // single selection matching the label
+    # await handle.SelectOptionAsync(new[] { new SelectOptionValue() { Label = "blue" } });
+    # // multiple selection
+    # await handle.SelectOptionAsync(new[] { "red", "green", "blue" });
+    # // multiple selection for blue, red and second option
+    # await handle.SelectOptionAsync(new[] {
+    #     new SelectOptionValue() { Label = "blue" },
+    #     new SelectOptionValue() { Index = 2 },
+    #     new SelectOptionValue() { Value = "red" }});
+    # ```
     def select_option(
           element: nil,
           index: nil,
@@ -565,8 +645,9 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
-      wrap_impl(@impl.tap_point(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.tap_point(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns the `node.textContent`.
@@ -599,6 +680,11 @@ module Playwright
     # element_handle.type("world", delay=100) # types slower, like a user
     # ```
     # 
+    # ```csharp
+    # await elementHandle.TypeAsync("Hello"); // Types instantly
+    # await elementHandle.TypeAsync("World", delay: 100); // Types slower, like a user
+    # ```
+    # 
     # An example of typing into a text field and then submitting the form:
     # 
     #
@@ -625,6 +711,12 @@ module Playwright
     # element_handle.type("some text")
     # element_handle.press("Enter")
     # ```
+    # 
+    # ```csharp
+    # var elementHandle = await page.QuerySelectorAsync("input");
+    # await elementHandle.TypeAsync("some text");
+    # await elementHandle.PressAsync("Enter");
+    # ```
     def type(text, delay: nil, noWaitAfter: nil, timeout: nil)
       wrap_impl(@impl.type(unwrap_impl(text), delay: unwrap_impl(delay), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
     end
@@ -642,8 +734,13 @@ module Playwright
     # 
     # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
     # zero timeout disables this.
-    def uncheck(force: nil, noWaitAfter: nil, position: nil, timeout: nil)
-      wrap_impl(@impl.uncheck(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+    def uncheck(
+          force: nil,
+          noWaitAfter: nil,
+          position: nil,
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.uncheck(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns when the element satisfies the `state`.
@@ -702,6 +799,13 @@ module Playwright
     # span = div.wait_for_selector("span", state="attached")
     # ```
     # 
+    # ```csharp
+    # await page.SetContentAsync("<div><span></span></div>");
+    # var div = await page.QuerySelectorAsync("div");
+    # // Waiting for the "span" selector relative to the div.
+    # var span = await page.WaitForSelectorAsync("span", WaitForSelectorState.Attached);
+    # ```
+    # 
     # > 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)))
@@ -709,20 +813,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