playwright-ruby-client 0.7.0 → 0.9.0

data/documentation/docs/api/page.md

@@ -104,6 +104,7 @@ def check(
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -136,6 +137,7 @@ def click(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -194,6 +196,7 @@ def dblclick(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -217,7 +220,12 @@ Shortcut for main frame's [Frame#dblclick](./frame#dblclick).
 ## dispatch_event
 
 ```
-def dispatch_event(selector, type, eventInit: nil, timeout: nil)
+def dispatch_event(
+      selector,
+      type,
+      eventInit: nil,
+      strict: nil,
+      timeout: nil)
 ```
 
 The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,
@@ -253,6 +261,21 @@ page.dispatch_event("#source", "dragstart", eventInit: { dataTransfer: data_tran
 
 
 
+## drag_and_drop
+
+```
+def drag_and_drop(
+      source,
+      target,
+      force: nil,
+      noWaitAfter: nil,
+      strict: nil,
+      timeout: nil,
+      trial: nil)
+```
+
+
+
 ## emulate_media
 
 ```
@@ -287,7 +310,7 @@ page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches") # =
 ## eval_on_selector
 
 ```
-def eval_on_selector(selector, expression, arg: nil)
+def eval_on_selector(selector, expression, arg: nil, strict: nil)
 ```
 
 The method finds an element matching the specified selector within the page and passes it as a first argument to
@@ -499,7 +522,13 @@ page.click("button")
 ## fill
 
 ```
-def fill(selector, value, noWaitAfter: nil, timeout: nil)
+def fill(
+      selector,
+      value,
+      force: nil,
+      noWaitAfter: nil,
+      strict: nil,
+      timeout: nil)
 ```
 
 This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the
@@ -518,7 +547,7 @@ Shortcut for main frame's [Frame#fill](./frame#fill).
 ## focus
 
 ```
-def focus(selector, timeout: nil)
+def focus(selector, strict: nil, timeout: nil)
 ```
 
 This method fetches an element with `selector` and focuses it. If there's no element matching `selector`, the method
@@ -555,7 +584,7 @@ An array of all frames attached to the page.
 ## get_attribute
 
 ```
-def get_attribute(selector, name, timeout: nil)
+def get_attribute(selector, name, strict: nil, timeout: nil)
 ```
 
 Returns element attribute value.
@@ -617,6 +646,7 @@ def hover(
       force: nil,
       modifiers: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -637,7 +667,7 @@ Shortcut for main frame's [Frame#hover](./frame#hover).
 ## inner_html
 
 ```
-def inner_html(selector, timeout: nil)
+def inner_html(selector, strict: nil, timeout: nil)
 ```
 
 Returns `element.innerHTML`.
@@ -645,15 +675,23 @@ Returns `element.innerHTML`.
 ## inner_text
 
 ```
-def inner_text(selector, timeout: nil)
+def inner_text(selector, strict: nil, timeout: nil)
 ```
 
 Returns `element.innerText`.
 
+## input_value
+
+```
+def input_value(selector, strict: nil, timeout: nil)
+```
+
+Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws for non-input elements.
+
 ## checked?
 
 ```
-def checked?(selector, timeout: nil)
+def checked?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
@@ -669,7 +707,7 @@ Indicates that the page has been closed.
 ## disabled?
 
 ```
-def disabled?(selector, timeout: nil)
+def disabled?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability).
@@ -677,7 +715,7 @@ Returns whether the element is disabled, the opposite of [enabled](https://playw
 ## editable?
 
 ```
-def editable?(selector, timeout: nil)
+def editable?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is [editable](https://playwright.dev/python/docs/actionability).
@@ -685,7 +723,7 @@ Returns whether the element is [editable](https://playwright.dev/python/docs/act
 ## enabled?
 
 ```
-def enabled?(selector, timeout: nil)
+def enabled?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability).
@@ -693,7 +731,7 @@ Returns whether the element is [enabled](https://playwright.dev/python/docs/acti
 ## hidden?
 
 ```
-def hidden?(selector, timeout: nil)
+def hidden?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is hidden, the opposite of [visible](https://playwright.dev/python/docs/actionability).  `selector` that does not
@@ -702,12 +740,26 @@ match any elements is considered hidden.
 ## visible?
 
 ```
-def visible?(selector, timeout: nil)
+def visible?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is [visible](https://playwright.dev/python/docs/actionability). `selector` that does not match any elements is
 considered not visible.
 
+## locator
+
+```
+def locator(selector)
+```
+
+The method returns an element locator that can be used to perform actions on the page. Locator is resolved to the
+element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
+different DOM elements. That would happen if the DOM structure between those actions has changed.
+
+Note that locator always implies visibility, so it will always be locating visible elements.
+
+Shortcut for main frame's [Frame#locator](./frame#locator).
+
 ## main_frame
 
 ```
@@ -724,6 +776,21 @@ def opener
 
 Returns the opener for popup pages and `null` for others. If the opener has been closed already the returns `null`.
 
+## pause
+
+```
+def pause
+```
+
+Pauses script execution. Playwright will stop executing the script and wait for the user to either press 'Resume' button
+in the page overlay or to call `playwright.resume()` in the DevTools console.
+
+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 `headless` value in the
+[BrowserType#launch](./browser_type#launch).
+
 ## pdf
 
 ```
@@ -797,6 +864,7 @@ def press(
       key,
       delay: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -834,7 +902,7 @@ page.screenshot(path: "o.png")
 ## query_selector
 
 ```
-def query_selector(selector)
+def query_selector(selector, strict: nil)
 ```
 
 The method finds an element matching the specified selector within the page. If no elements match the selector, the
@@ -934,7 +1002,9 @@ def select_option(
       index: nil,
       value: nil,
       label: nil,
+      force: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -1013,7 +1083,12 @@ The extra HTTP headers will be sent with every request the page initiates.
 ## set_input_files
 
 ```
-def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
+def set_input_files(
+      selector,
+      files,
+      noWaitAfter: nil,
+      strict: nil,
+      timeout: nil)
 ```
 
 This method expects `selector` to point to an
@@ -1051,6 +1126,7 @@ def tap_point(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -1073,7 +1149,7 @@ Shortcut for main frame's [Frame#tap_point](./frame#tap_point).
 ## text_content
 
 ```
-def text_content(selector, timeout: nil)
+def text_content(selector, strict: nil, timeout: nil)
 ```
 
 Returns `element.textContent`.
@@ -1094,6 +1170,7 @@ def type(
       text,
       delay: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -1117,6 +1194,7 @@ def uncheck(
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -1185,7 +1263,7 @@ throw an error if the page is closed before the [`event: Page.console`] event is
 def expect_download(predicate: nil, timeout: nil, &block)
 ```
 
-Performs action and waits for a new `Download`. If predicate is provided, it passes `Download` value into the
+Performs action and waits for a new [Download](./download). If predicate is provided, it passes [Download](./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.
 
@@ -1306,7 +1384,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 +1406,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
 
 ```
@@ -1356,7 +1444,7 @@ puts response.body
 ## wait_for_selector
 
 ```
-def wait_for_selector(selector, state: nil, timeout: nil)
+def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
 ```
 
 Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or

data/documentation/docs/api/response.md

@@ -64,6 +64,22 @@ def request
 
 Returns the matching [Request](./request) object.
 
+## security_details
+
+```
+def security_details
+```
+
+Returns SSL and other security information.
+
+## server_addr
+
+```
+def server_addr
+```
+
+Returns the IP address and port of the server.
+
 ## status
 
 ```

data/documentation/docs/article/guides/inspector.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 6
+---
+
+# Playwright inspector
+
+Playwright provides an useful inspector.
+https://playwright.dev/docs/inspector/
+
+## Overview
+
+```ruby {4,8}
+playwright.chromium.launch(headless: false) do |browser|
+  browser.new_context do |context|
+    # This method call should be put just after creating BrowserContext.
+    context.enable_debug_console!
+
+    page = context.new_pagè
+    page.goto('http://example.com/')
+    page.pause
+  end
+end
+```
+
+`page.pause` requires Playwright debug session, and it can be enabled by calling `BrowserContext#enable_debug_console!` in advance.
+
+Note that since Ruby is not officially supported in Playwright, many limitations exist. We CANNOT
+
+* Launch inspector via `PWDEBUG=1`
+* Debug without inspector UI (`PWDEBUG=console` is not working well)
+* Show Ruby code in inspector

data/documentation/docs/article/guides/playwright_on_alpine_linux.md

@@ -0,0 +1,91 @@
+---
+sidebar_position: 7
+---
+
+# Playwright on Alpine Linux
+
+**NOTE: This feature is EXPERIMENTAL.**
+
+Playwright actually requires a permission for shell command execution, and many run-time dependencies for each browser.
+
+![all-in-one](https://user-images.githubusercontent.com/11763113/124934388-9c9c9100-e03f-11eb-8f13-324afac3be2a.png)
+
+This all-in-one architecture is reasonable for browser automation in our own computers.
+
+However we may have trouble with bringing Playwright into:
+
+* Docker
+  * Alpine Linux
+* Serverless computing
+  * AWS Lambda
+  * Google Cloud Functions
+* PaaS
+  * Heroku
+  * Google App Engine
+
+This article introduces a way to separate environments into client (for executing Playwright script) and server (for working with browsers). The main use-case assumes Docker (using Alpine Linux), however the way can be applied also into other use-cases.
+
+## Overview
+
+Playwrignt Ruby client is running on Alpine Linux. It just sends/receives JSON messages of Playwright-protocol via WebSocket.
+
+Playwright server is running on a container of [official Docker image](https://hub.docker.com/_/microsoft-playwright). It just operates browsers in response to the JSON messages from WebSocket.
+
+![overview](https://user-images.githubusercontent.com/11763113/124934448-ad4d0700-e03f-11eb-942e-b9f3282bb703.png)
+
+## Playwright client
+
+Many example uses `Playwright#create`, which internally uses Pipe (stdin/stdout) transport for Playwright-protocol messaging. Instead, **just use `Playwright#connect_to_playwright_server(endpoint)`** for WebSocket transport.
+
+```ruby {3}
+require 'playwright'
+
+Playwright.connect_to_playwright_server('wss://example.com:8888/ws') do |playwright|
+  playwright.chromium.launch do |browser|
+    page = browser.new_page
+    page.goto('https://github.com/microsoft/playwright')
+    page.screenshot(path: 'github-microsoft-playwright.png')
+  end
+end
+```
+
+`wss://example.com:8888/ws` is an example of endpoint URL of the Playwright server. In local development environment, it is typically `"ws://127.0.0.1:#{port}/ws"`.
+
+## Playwright server
+
+With the [official Docker image](https://hub.docker.com/_/microsoft-playwright) or in the local development environment with Node.js, just execute `npx playwright install && npx playwright run-server $PORT`. (`$PORT` is a port number of the server)
+
+If custom Docker image is preferred, build it as follows:
+
+```Dockerfile
+FROM mcr.microsoft.com/playwright:focal
+
+WORKDIR /root
+RUN npm install playwright@1.12.3 && ./node_modules/.bin/playwright install
+
+ENV PORT 8888
+CMD ["./node_modules/.bin/playwright", "run-server", "$PORT"]
+```
+
+## Debugging for connection
+
+The client and server are really quiet. This chapter shows how to check if the communication on the WebSocket works well or not.
+
+### Show JSON message on client
+
+Just set an environment variable `DEBUG=1`.
+
+```
+DEBUG=1 bundle exec ruby some-automation-with-playwright.rb
+```
+
+
+### Enable verbose logging on server
+
+Just set an environment variable `DEBUG=pw:*` or `DEBUG=pw:server`
+
+```
+DEBUG=pw:* npx playwright run-server 8888
+```
+
+See [the official documentation](https://playwright.dev/docs/debug/#verbose-api-logs) for details.