playwright-ruby-client 0.6.6 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b548b6927a468b4a1209e9002cc7ca6f20bf0ad7ad4091510336ed610d338bb
-  data.tar.gz: d8f5e411d5ee99460e77d3d922608996cde6de1a2199ee0f6425c7e3a5eb9a7b
+  metadata.gz: 2e631604c0af31dc184fd1bfe6953be910d4f19be8613e8a2a11c83a3d5e9049
+  data.tar.gz: b320853082ae065cc09195f09e35f9a5bf18edc3105c729c9bd4a4daeb804948
 SHA512:
-  metadata.gz: 645bd780e189153fabc25de3a58b490ae5fb919c8ed9b81f701c8bed0e910483be9cb2c901bda8f4619153bb18924240ae43841b197479665883567980ffd29c
-  data.tar.gz: 50af6ab226985f5bd7a7631fab3959c4215a6bae7d57d32c5cd9787f7d43a8ed2bbe599443a611a9eafd73e7e8dd74ace7783781a95d04357d5a9ff4c4e69313
+  metadata.gz: 1ea608b469db2082b899c3b4c10cbfea703f222a79fb255a0d07d03eb46eacbd0274cb98c1c32a9241f120f5059bdb20fbc82a65a072c05e616bdbd4b76586aa
+  data.tar.gz: 50ea41552e79e96add337084c9a38961bae124dfcaf04c9fe3ab61ceb2cd5e8738f0ae6fffdb6e04157416593f351bc7177e03e0da75cf51a80e929e1bce3f42

data/README.md

@@ -159,6 +159,32 @@ end
 
 ```
 
+### Communicate with Playwright server
+
+If your environment doesn't accept installing browser or creating browser process, consider separating Ruby client and Playwright server.
+
+![structure](https://user-images.githubusercontent.com/11763113/124934448-ad4d0700-e03f-11eb-942e-b9f3282bb703.png)
+
+For launching Playwright server, just execute:
+
+```
+npx playwright install && npx playwright run-server 8080
+```
+
+and we can connect to the server with the code like this:
+
+```ruby
+Playwright.connect_to_playwright_server('ws://127.0.0.1:8080') do |playwright|
+  playwright.chromium.launch do |browser|
+    page = browser.new_page
+    page.goto('https://github.com/YusukeIwaki')
+    page.screenshot(path: './YusukeIwaki.png')
+  end
+end
+```
+
+When `Playwright.connect_to_playwright_server` is used, playwright_cli_executable_path is not required.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/documentation/docs/api/browser.md

@@ -61,11 +61,22 @@ def connected?
 
 Indicates that the browser is connected.
 
+## new_browser_cdp_session
+
+```
+def new_browser_cdp_session
+```
+
+> NOTE: CDP Sessions are only supported on Chromium-based browsers.
+
+Returns the newly created browser session.
+
 ## new_context
 
 ```
 def new_context(
       acceptDownloads: nil,
+      baseURL: nil,
       bypassCSP: nil,
       colorScheme: nil,
       deviceScaleFactor: nil,
@@ -114,6 +125,7 @@ end
 ```
 def new_page(
       acceptDownloads: nil,
+      baseURL: nil,
       bypassCSP: nil,
       colorScheme: nil,
       deviceScaleFactor: nil,
@@ -154,7 +166,9 @@ testing frameworks should explicitly create [Browser#new_context](./browser#new_
 def start_tracing(page: nil, categories: nil, path: nil, screenshots: nil)
 ```
 
-> NOTE: Tracing is only supported on Chromium-based browsers.
+> NOTE: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool)
+which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](https://playwright.dev/python/docs/trace-viewer) could be
+found [here](./tracing).
 
 You can use [Browser#start_tracing](./browser#start_tracing) and [Browser#stop_tracing](./browser#stop_tracing) to create a trace file that can be
 opened in Chrome DevTools performance panel.
@@ -175,7 +189,9 @@ end
 def stop_tracing
 ```
 
-> NOTE: Tracing is only supported on Chromium-based browsers.
+> NOTE: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool)
+which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](https://playwright.dev/python/docs/trace-viewer) could be
+found [here](./tracing).
 
 Returns the buffer with trace data.
 

data/documentation/docs/api/browser_context.md

@@ -226,6 +226,16 @@ def grant_permissions(permissions, origin: nil)
 Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if
 specified.
 
+## new_cdp_session
+
+```
+def new_cdp_session(page)
+```
+
+> NOTE: CDP sessions are only supported on Chromium-based browsers.
+
+Returns the newly created session.
+
 ## new_page
 
 ```

data/documentation/docs/api/browser_type.md

@@ -103,6 +103,7 @@ def launch_persistent_context(
       userDataDir,
       acceptDownloads: nil,
       args: nil,
+      baseURL: nil,
       bypassCSP: nil,
       channel: nil,
       chromiumSandbox: nil,

data/documentation/docs/api/cdp_session.md

@@ -4,4 +4,44 @@ sidebar_position: 10
 
 # CDPSession
 
-Not Implemented
+- extends: [EventEmitter]
+
+The [CDPSession](./cdp_session) instances are used to talk raw Chrome Devtools Protocol:
+- protocol methods can be called with `session.send_message` method.
+- 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
+
+```ruby
+client = page.context.new_cdp_session(page)
+client.send_message('Animation.enable')
+client.on('Animation.animationCreated', -> (_) { puts 'Animation Created' })
+response = client.send_message('Animation.getPlaybackRate')
+puts "Playback rate is #{response['playbackRate']}"
+client.send_message(
+  'Animation.setPlaybackRate',
+  params: { playbackRate: response['playbackRate'] / 2.0 },
+)
+```
+
+
+## detach
+
+```
+def detach
+```
+
+Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used to
+send messages.
+
+## send_message
+
+```
+def send_message(method, params: nil)
+```
+
+

data/documentation/docs/api/element_handle.md

@@ -232,7 +232,7 @@ feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)
 ## fill
 
 ```
-def fill(value, noWaitAfter: nil, timeout: nil)
+def fill(value, force: nil, noWaitAfter: nil, timeout: nil)
 ```
 
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the element, fills it and triggers an `input`
@@ -300,6 +300,14 @@ def inner_text
 
 Returns the `element.innerText`.
 
+## input_value
+
+```
+def input_value(timeout: nil)
+```
+
+Returns `input.value` for `<input>` or `<textarea>` element. Throws for non-input elements.
+
 ## checked?
 
 ```
@@ -436,6 +444,7 @@ def select_option(
       index: nil,
       value: nil,
       label: nil,
+      force: nil,
       noWaitAfter: nil,
       timeout: nil)
 ```
@@ -470,7 +479,7 @@ element_handle.select_option(value: "blue", index: 2, label: "red")
 ## select_text
 
 ```
-def select_text(timeout: nil)
+def select_text(force: nil, timeout: nil)
 ```
 
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text

data/documentation/docs/api/experimental/android_device.md

@@ -28,6 +28,7 @@ Returns information about a widget defined by `selector`.
 ```
 def launch_browser(
       acceptDownloads: nil,
+      baseURL: nil,
       bypassCSP: nil,
       colorScheme: nil,
       command: nil,

data/documentation/docs/api/frame.md

@@ -196,6 +196,20 @@ frame.dispatch_event("#source", "dragstart", { "dataTransfer": data_transfer })
 
 
 
+## drag_and_drop
+
+```
+def drag_and_drop(
+      source,
+      target,
+      force: nil,
+      noWaitAfter: nil,
+      timeout: nil,
+      trial: nil)
+```
+
+
+
 ## eval_on_selector
 
 ```
@@ -326,7 +340,12 @@ result_handle.dispose
 ## fill
 
 ```
-def fill(selector, value, noWaitAfter: nil, timeout: nil)
+def fill(
+      selector,
+      value,
+      force: nil,
+      noWaitAfter: nil,
+      timeout: nil)
 ```
 
 This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the
@@ -443,6 +462,14 @@ def inner_text(selector, timeout: nil)
 
 Returns `element.innerText`.
 
+## input_value
+
+```
+def input_value(selector, timeout: nil)
+```
+
+Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws for non-input elements.
+
 ## checked?
 
 ```
@@ -588,6 +615,7 @@ def select_option(
       index: nil,
       value: nil,
       label: nil,
+      force: nil,
       noWaitAfter: nil,
       timeout: nil)
 ```

data/documentation/docs/api/keyboard.md

@@ -12,35 +12,31 @@ 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:
 
-```python sync title=example_575870a45e4fe08d3e06be3420e8a11be03f85791cd8174f27198c016031ae72.py
+```ruby
 page.keyboard.type("Hello World!")
 page.keyboard.press("ArrowLeft")
 page.keyboard.down("Shift")
-for i in range(6):
-    page.keyboard.press("ArrowLeft")
+6.times { page.keyboard.press("ArrowLeft") }
 page.keyboard.up("Shift")
 page.keyboard.press("Backspace")
 # result text will end up saying "Hello!"
-
 ```
 
 An example of pressing uppercase `A`
 
-```python sync title=example_a4f00f0cd486431b7eca785304f4e9715522da45b66dda7f3a5f6899b889b9fd.py
+```ruby
 page.keyboard.press("Shift+KeyA")
 # or
 page.keyboard.press("Shift+A")
-
 ```
 
 An example to trigger select-all with the keyboard
 
-```python sync title=example_2deda0786a20a28cec9e8b438078a5fc567f7c7e5cf369419ab3c4d80a319ff6.py
+```ruby
 # on windows and linux
 page.keyboard.press("Control+A")
 # on mac_os
 page.keyboard.press("Meta+A")
-
 ```
 
 
@@ -84,9 +80,8 @@ def insert_text(text)
 
 Dispatches only `input` event, does not emit the `keydown`, `keyup` or `keypress` events.
 
-```python sync title=example_a9cc2667e9f3e3b8c619649d7e4a7f5db9463e0b76d67a5e588158093a9e9124.py
+```ruby
 page.keyboard.insert_text("嗨")
-
 ```
 
 > NOTE: Modifier keys DO NOT effect `keyboard.insertText`. Holding down `Shift` will not type the text in upper case.
@@ -114,17 +109,14 @@ 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.
 
-```python sync title=example_88943eb85c1ac7c261601e6edbdead07a31c2784326c496e10667ede1a853bab.py
-page = browser.new_page()
+```ruby
 page.goto("https://keycode.info")
 page.keyboard.press("a")
-page.screenshot(path="a.png")
+page.screenshot(path: "a.png")
 page.keyboard.press("ArrowLeft")
-page.screenshot(path="arrow_left.png")
+page.screenshot(path: "arrow_left.png")
 page.keyboard.press("Shift+O")
-page.screenshot(path="o.png")
-browser.close()
-
+page.screenshot(path: "o.png")
 ```
 
 Shortcut for [Keyboard#down](./keyboard#down) and [Keyboard#up](./keyboard#up).
@@ -139,10 +131,9 @@ Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in t
 
 To press a special key, like `Control` or `ArrowDown`, use [Keyboard#press](./keyboard#press).
 
-```python sync title=example_d9ced919f139961fd2b795c71375ca96f788a19c1f8e1479c5ec905fb5c02d43.py
+```ruby
 page.keyboard.type("Hello") # types instantly
-page.keyboard.type("World", delay=100) # types slower, like a user
-
+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.

data/documentation/docs/api/page.md

@@ -253,6 +253,20 @@ page.dispatch_event("#source", "dragstart", eventInit: { dataTransfer: data_tran
 
 
 
+## drag_and_drop
+
+```
+def drag_and_drop(
+      source,
+      target,
+      force: nil,
+      noWaitAfter: nil,
+      timeout: nil,
+      trial: nil)
+```
+
+
+
 ## emulate_media
 
 ```
@@ -499,7 +513,12 @@ page.click("button")
 ## fill
 
 ```
-def fill(selector, value, noWaitAfter: nil, timeout: nil)
+def fill(
+      selector,
+      value,
+      force: nil,
+      noWaitAfter: nil,
+      timeout: nil)
 ```
 
 This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the
@@ -650,6 +669,14 @@ def inner_text(selector, timeout: nil)
 
 Returns `element.innerText`.
 
+## input_value
+
+```
+def input_value(selector, timeout: nil)
+```
+
+Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws for non-input elements.
+
 ## checked?
 
 ```
@@ -934,6 +961,7 @@ def select_option(
       index: nil,
       value: nil,
       label: nil,
+      force: nil,
       noWaitAfter: nil,
       timeout: nil)
 ```
@@ -1306,7 +1334,7 @@ Performs action and waits for a popup [Page](./page). If predicate is provided,
 def expect_request(urlOrPredicate, timeout: nil, &block)
 ```
 
-Waits for the matching request and returns it.  See [waiting for event](https://playwright.dev/python/docs/events) for more details
+Waits for the matching request and returns it. See [waiting for event](https://playwright.dev/python/docs/events) for more details
 about events.
 
 ```ruby
@@ -1328,6 +1356,16 @@ puts request.headers
 
 
 
+## expect_request_finished
+
+```
+def expect_request_finished(predicate: nil, timeout: nil, &block)
+```
+
+Performs action and waits for a [Request](./request) to finish loading. If predicate is provided, it passes [Request](./request) value into
+the `predicate` function and waits for `predicate(request)` to return a truthy value. Will throw an error if the page is
+closed before the [`event: Page.requestFinished`] event is fired.
+
 ## expect_response
 
 ```
@@ -1393,6 +1431,14 @@ page.wait_for_url("**/target.html")
 
 Shortcut for main frame's [Frame#wait_for_url](./frame#wait_for_url).
 
+## expect_websocket
+
+```
+def expect_websocket(predicate: nil, timeout: nil, &block)
+```
+
+Performs action and waits for a new [WebSocket](./web_socket). If predicate is provided, it passes [WebSocket](./web_socket) value into the `predicate` function and waits for `predicate.call(web_socket)` to return a truthy value. Will throw an error if the page is closed before the WebSocket event is fired.
+
 ## accessibility
 
 ## keyboard