playwright-ruby-client 0.5.7 → 0.6.1

data/lib/playwright_api/js_handle.rb

@@ -1,32 +1,16 @@
 module Playwright
   # JSHandle represents an in-page JavaScript object. JSHandles can be created with the [`method: Page.evaluateHandle`]
   # method.
-  # 
   #
-  # ```js
-  # const windowHandle = await page.evaluateHandle(() => window);
-  # // ...
-  # ```
-  # 
-  # ```java
-  # JSHandle windowHandle = page.evaluateHandle("() => window");
-  # // ...
-  # ```
-  # 
-  # ```python async
-  # window_handle = await page.evaluate_handle("window")
-  # # ...
-  # ```
-  # 
   # ```python sync
   # window_handle = page.evaluate_handle("window")
   # # ...
   # ```
-  # 
+  #
   # JSHandle prevents the referenced JavaScript object being garbage collected unless the handle is exposed with
   # [`method: JSHandle.dispose`]. JSHandles are auto-disposed when their origin frame gets navigated or the parent context
   # gets destroyed.
-  # 
+  #
   # JSHandle instances can be used as an argument in [`method: Page.evalOnSelector`], [`method: Page.evaluate`] and
   # [`method: Page.evaluateHandle`] methods.
   class JSHandle < PlaywrightApi
@@ -42,29 +26,13 @@ module Playwright
     end
 
     # Returns the return value of `expression`.
-    # 
+    #
     # This method passes this handle as the first argument to `expression`.
-    # 
+    #
     # If `expression` returns a [Promise], then `handle.evaluate` would wait for the promise to resolve and return its value.
-    # 
+    #
     # Examples:
-    # 
     #
-    # ```js
-    # const tweetHandle = await page.$('.tweet .retweets');
-    # expect(await tweetHandle.evaluate(node => node.innerText)).toBe('10 retweets');
-    # ```
-    # 
-    # ```java
-    # ElementHandle tweetHandle = page.querySelector(".tweet .retweets");
-    # assertEquals("10 retweets", tweetHandle.evaluate("node => node.innerText"));
-    # ```
-    # 
-    # ```python async
-    # tweet_handle = await page.query_selector(".tweet .retweets")
-    # assert await tweet_handle.evaluate("node => node.innerText") == "10 retweets"
-    # ```
-    # 
     # ```python sync
     # tweet_handle = page.query_selector(".tweet .retweets")
     # assert tweet_handle.evaluate("node => node.innerText") == "10 retweets"
@@ -74,47 +42,22 @@ module Playwright
     end
 
     # Returns the return value of `expression` as a `JSHandle`.
-    # 
+    #
     # This method passes this handle as the first argument to `expression`.
-    # 
+    #
     # The only difference between `jsHandle.evaluate` and `jsHandle.evaluateHandle` is that `jsHandle.evaluateHandle` returns
     # `JSHandle`.
-    # 
+    #
     # If the function passed to the `jsHandle.evaluateHandle` returns a [Promise], then `jsHandle.evaluateHandle` would wait
     # for the promise to resolve and return its value.
-    # 
+    #
     # See [`method: Page.evaluateHandle`] for more details.
     def evaluate_handle(expression, arg: nil)
       wrap_impl(@impl.evaluate_handle(unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
 
     # The method returns a map with **own property names** as keys and JSHandle instances for the property values.
-    # 
     #
-    # ```js
-    # const handle = await page.evaluateHandle(() => ({window, document}));
-    # const properties = await handle.getProperties();
-    # const windowHandle = properties.get('window');
-    # const documentHandle = properties.get('document');
-    # await handle.dispose();
-    # ```
-    # 
-    # ```java
-    # JSHandle handle = page.evaluateHandle("() => ({window, document}"););
-    # Map<String, JSHandle> properties = handle.getProperties();
-    # JSHandle windowHandle = properties.get("window");
-    # JSHandle documentHandle = properties.get("document");
-    # handle.dispose();
-    # ```
-    # 
-    # ```python async
-    # handle = await page.evaluate_handle("{window, document}")
-    # properties = await handle.get_properties()
-    # window_handle = properties.get("window")
-    # document_handle = properties.get("document")
-    # await handle.dispose()
-    # ```
-    # 
     # ```python sync
     # handle = page.evaluate_handle("{window, document}")
     # properties = handle.get_properties()
@@ -133,7 +76,7 @@ module Playwright
     end
 
     # Returns a JSON representation of the object. If the object has a `toJSON` function, it **will not be called**.
-    # 
+    #
     # > NOTE: The method will return an empty JSON object if the referenced object is not stringifiable. It will throw an
     # error if the object has circular references.
     def json_value
@@ -145,12 +88,6 @@ module Playwright
       wrap_impl(@impl.to_s)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -163,6 +100,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/keyboard.rb

@@ -1,48 +1,12 @@
 module Playwright
   # Keyboard provides an api for managing a virtual keyboard. The high level api is [`method: Keyboard.type`], which takes
   # raw characters and generates proper keydown, keypress/input, and keyup events on your page.
-  # 
+  #
   # For finer control, you can use [`method: Keyboard.down`], [`method: Keyboard.up`], and [`method: Keyboard.insertText`]
   # to manually fire events as if they were generated from a real keyboard.
-  # 
+  #
   # An example of holding down `Shift` in order to select and delete some text:
-  # 
   #
-  # ```js
-  # await page.keyboard.type('Hello World!');
-  # await page.keyboard.press('ArrowLeft');
-  # 
-  # await page.keyboard.down('Shift');
-  # for (let i = 0; i < ' World'.length; i++)
-  #   await page.keyboard.press('ArrowLeft');
-  # await page.keyboard.up('Shift');
-  # 
-  # await page.keyboard.press('Backspace');
-  # // Result text will end up saying 'Hello!'
-  # ```
-  # 
-  # ```java
-  # page.keyboard().type("Hello World!");
-  # page.keyboard().press("ArrowLeft");
-  # page.keyboard().down("Shift");
-  # for (int i = 0; i < " World".length(); i++)
-  #   page.keyboard().press("ArrowLeft");
-  # page.keyboard().up("Shift");
-  # page.keyboard().press("Backspace");
-  # // Result text will end up saying "Hello!"
-  # ```
-  # 
-  # ```python async
-  # await page.keyboard.type("Hello World!")
-  # await page.keyboard.press("ArrowLeft")
-  # await page.keyboard.down("Shift")
-  # for i in range(6):
-  #     await page.keyboard.press("ArrowLeft")
-  # await page.keyboard.up("Shift")
-  # await page.keyboard.press("Backspace")
-  # # result text will end up saying "Hello!"
-  # ```
-  # 
   # ```python sync
   # page.keyboard.type("Hello World!")
   # page.keyboard.press("ArrowLeft")
@@ -53,58 +17,17 @@ module Playwright
   # page.keyboard.press("Backspace")
   # # result text will end up saying "Hello!"
   # ```
-  # 
+  #
   # An example of pressing uppercase `A`
-  # 
   #
-  # ```js
-  # await page.keyboard.press('Shift+KeyA');
-  # // or
-  # await page.keyboard.press('Shift+A');
-  # ```
-  # 
-  # ```java
-  # page.keyboard().press("Shift+KeyA");
-  # // or
-  # page.keyboard().press("Shift+A");
-  # ```
-  # 
-  # ```python async
-  # await page.keyboard.press("Shift+KeyA")
-  # # or
-  # await page.keyboard.press("Shift+A")
-  # ```
-  # 
   # ```python sync
   # page.keyboard.press("Shift+KeyA")
   # # or
   # page.keyboard.press("Shift+A")
   # ```
-  # 
+  #
   # An example to trigger select-all with the keyboard
-  # 
   #
-  # ```js
-  # // on Windows and Linux
-  # await page.keyboard.press('Control+A');
-  # // on macOS
-  # await page.keyboard.press('Meta+A');
-  # ```
-  # 
-  # ```java
-  # // on Windows and Linux
-  # page.keyboard().press("Control+A");
-  # // on macOS
-  # page.keyboard().press("Meta+A");
-  # ```
-  # 
-  # ```python async
-  # # on windows and linux
-  # await page.keyboard.press("Control+A")
-  # # on mac_os
-  # await page.keyboard.press("Meta+A")
-  # ```
-  # 
   # ```python sync
   # # on windows and linux
   # page.keyboard.press("Control+A")
@@ -114,52 +37,39 @@ module Playwright
   class Keyboard < PlaywrightApi
 
     # Dispatches a `keydown` event.
-    # 
+    #
     # `key` can specify the intended [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key)
     # value or a single character to generate the text for. A superset of the `key` values can be found
     # [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:
-    # 
+    #
     # `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`,
     # `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`, etc.
-    # 
+    #
     # Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`.
-    # 
+    #
     # Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
-    # 
+    #
     # If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective
     # texts.
-    # 
+    #
     # If `key` is a modifier key, `Shift`, `Meta`, `Control`, or `Alt`, subsequent key presses will be sent with that modifier
     # active. To release the modifier key, use [`method: Keyboard.up`].
-    # 
+    #
     # After the key is pressed once, subsequent calls to [`method: Keyboard.down`] will have
     # [repeat](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/repeat) set to true. To release the key, use
     # [`method: Keyboard.up`].
-    # 
+    #
     # > NOTE: Modifier keys DO influence `keyboard.down`. Holding down `Shift` will type the text in upper case.
     def down(key)
       wrap_impl(@impl.down(unwrap_impl(key)))
     end
 
     # Dispatches only `input` event, does not emit the `keydown`, `keyup` or `keypress` events.
-    # 
     #
-    # ```js
-    # page.keyboard.insertText('嗨');
-    # ```
-    # 
-    # ```java
-    # page.keyboard().insertText("嗨");
-    # ```
-    # 
-    # ```python async
-    # await page.keyboard.insert_text("嗨")
-    # ```
-    # 
     # ```python sync
     # page.keyboard.insert_text("嗨")
     # ```
-    # 
+    #
     # > NOTE: Modifier keys DO NOT effect `keyboard.insertText`. Holding down `Shift` will not type the text in upper case.
     def insert_text(text)
       wrap_impl(@impl.insert_text(unwrap_impl(text)))
@@ -168,57 +78,20 @@ module Playwright
     # `key` can specify the intended [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key)
     # value or a single character to generate the text for. A superset of the `key` values can be found
     # [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:
-    # 
+    #
     # `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`,
     # `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`, etc.
-    # 
+    #
     # Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`.
-    # 
+    #
     # Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
-    # 
+    #
     # If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective
     # texts.
-    # 
+    #
     # Shortcuts such as `key: "Control+o"` or `key: "Control+Shift+T"` are supported as well. When specified with the
     # modifier, modifier is pressed and being held while the subsequent key is being pressed.
-    # 
     #
-    # ```js
-    # const page = await browser.newPage();
-    # await page.goto('https://keycode.info');
-    # await page.keyboard.press('A');
-    # await page.screenshot({ path: 'A.png' });
-    # await page.keyboard.press('ArrowLeft');
-    # await page.screenshot({ path: 'ArrowLeft.png' });
-    # await page.keyboard.press('Shift+O');
-    # await page.screenshot({ path: 'O.png' });
-    # await browser.close();
-    # ```
-    # 
-    # ```java
-    # Page page = browser.newPage();
-    # page.navigate("https://keycode.info");
-    # page.keyboard().press("A");
-    # page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("A.png"));
-    # page.keyboard().press("ArrowLeft");
-    # page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("ArrowLeft.png")));
-    # page.keyboard().press("Shift+O");
-    # page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("O.png")));
-    # browser.close();
-    # ```
-    # 
-    # ```python async
-    # page = await browser.new_page()
-    # await page.goto("https://keycode.info")
-    # await page.keyboard.press("a")
-    # await page.screenshot(path="a.png")
-    # await page.keyboard.press("ArrowLeft")
-    # await page.screenshot(path="arrow_left.png")
-    # await page.keyboard.press("Shift+O")
-    # await page.screenshot(path="o.png")
-    # await browser.close()
-    # ```
-    # 
     # ```python sync
     # page = browser.new_page()
     # page.goto("https://keycode.info")
@@ -230,40 +103,23 @@ module Playwright
     # page.screenshot(path="o.png")
     # browser.close()
     # ```
-    # 
+    #
     # Shortcut for [`method: Keyboard.down`] and [`method: Keyboard.up`].
     def press(key, delay: nil)
       wrap_impl(@impl.press(unwrap_impl(key), delay: unwrap_impl(delay)))
     end
 
     # Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
-    # 
+    #
     # To press a special key, like `Control` or `ArrowDown`, use [`method: Keyboard.press`].
-    # 
     #
-    # ```js
-    # await page.keyboard.type('Hello'); // Types instantly
-    # await page.keyboard.type('World', {delay: 100}); // Types slower, like a user
-    # ```
-    # 
-    # ```java
-    # // Types instantly
-    # page.keyboard().type("Hello");
-    # // Types slower, like a user
-    # page.keyboard().type("World", new Keyboard.TypeOptions().setDelay(100));
-    # ```
-    # 
-    # ```python async
-    # await page.keyboard.type("Hello") # types instantly
-    # await page.keyboard.type("World", delay=100) # types slower, like a user
-    # ```
-    # 
     # ```python sync
     # page.keyboard.type("Hello") # types instantly
     # page.keyboard.type("World", delay=100) # types slower, like a user
     # ```
-    # 
+    #
     # > NOTE: Modifier keys DO NOT effect `keyboard.type`. Holding down `Shift` will not type the text in upper case.
+    # > NOTE: For characters that are not on a US keyboard, only an `input` event will be sent.
     def type(text, delay: nil)
       wrap_impl(@impl.type(unwrap_impl(text), delay: unwrap_impl(delay)))
     end

data/lib/playwright_api/mouse.rb

@@ -1,42 +1,8 @@
 module Playwright
   # The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.
-  # 
+  #
   # Every `page` object has its own Mouse, accessible with [`property: Page.mouse`].
-  # 
   #
-  # ```js
-  # // Using ‘page.mouse’ to trace a 100x100 square.
-  # await page.mouse.move(0, 0);
-  # await page.mouse.down();
-  # await page.mouse.move(0, 100);
-  # await page.mouse.move(100, 100);
-  # await page.mouse.move(100, 0);
-  # await page.mouse.move(0, 0);
-  # await page.mouse.up();
-  # ```
-  # 
-  # ```java
-  # // Using ‘page.mouse’ to trace a 100x100 square.
-  # page.mouse().move(0, 0);
-  # page.mouse().down();
-  # page.mouse().move(0, 100);
-  # page.mouse().move(100, 100);
-  # page.mouse().move(100, 0);
-  # page.mouse().move(0, 0);
-  # page.mouse().up();
-  # ```
-  # 
-  # ```python async
-  # # using ‘page.mouse’ to trace a 100x100 square.
-  # await page.mouse.move(0, 0)
-  # await page.mouse.down()
-  # await page.mouse.move(0, 100)
-  # await page.mouse.move(100, 100)
-  # await page.mouse.move(100, 0)
-  # await page.mouse.move(0, 0)
-  # await page.mouse.up()
-  # ```
-  # 
   # ```python sync
   # # using ‘page.mouse’ to trace a 100x100 square.
   # page.mouse.move(0, 0)
@@ -47,16 +13,6 @@ module Playwright
   # page.mouse.move(0, 0)
   # page.mouse.up()
   # ```
-  # 
-  # ```csharp
-  # await Page.Mouse.MoveAsync(0, 0);
-  # await Page.Mouse.DownAsync();
-  # await Page.Mouse.MoveAsync(0, 100);
-  # await Page.Mouse.MoveAsync(100, 100);
-  # await Page.Mouse.MoveAsync(100, 0);
-  # await Page.Mouse.MoveAsync(0, 0);
-  # await Page.Mouse.UpAsync();
-  # ```
   class Mouse < PlaywrightApi
 
     # Shortcut for [`method: Mouse.move`], [`method: Mouse.down`], [`method: Mouse.up`].