playwright-ruby-client 1.42.0 → 1.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f0696ad7f67f87dee8a131a434be9889cb7b03ba2b95ca3328eec1b1b6676ac
-  data.tar.gz: 6011f12c7a4afe3fba9685163f4e65d110f7cb71acfe01db680628bd6d97e991
+  metadata.gz: e22c38ec1a50889adfbb6664dcb445db3635bcfd3d0240113f5b7250f5a16f91
+  data.tar.gz: 74f4b27cbc4d4e0b903c46621fa7dea13249d97b17bd780436fd5635d90f3e83
 SHA512:
-  metadata.gz: 2f7e789935f337f334a98a29b777e2d48bdc7cef02ec3594a0128ab388962b934d4dfd322c48b344aee25f9d6a16da2919b652635456163a64744d85d9c705a7
-  data.tar.gz: 6cacbb799e67cd76684b9041fec310013d30a97a85668b8fa5041b868f7e3d879a922f684037e5cd7e42d6bbb85a7f5ef265b9d9d8d9b9f2b0cb7871459a8646
+  metadata.gz: f4201f5fa8a9353daecb78860b4a142a477c64b9634560b262faaea2c53491c0b5909ec3ada0e6ece917de08a91390b479a0aca34e7d607c0c14e9cf0999579a
+  data.tar.gz: 63968771197cee749d2780fa3f822f9e154088c0ea53062b86dda770f05704344a3f1f5dd696387d419252c2d1466a83e1ffbf8810ee25f069cf48c5662804ad

data/README.md

@@ -168,13 +168,13 @@ If your environment doesn't accept installing browser or creating browser proces
 For launching Playwright server, just execute:
 
 ```
-npx playwright install && npx playwright run-server --port 8080
+npx playwright install && npx playwright run-server --port 8080 --path /ws
 ```
 
 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.connect_to_playwright_server('ws://127.0.0.1:8080/ws?browser=chromium') do |playwright|
   playwright.chromium.launch do |browser|
     page = browser.new_page
     page.goto('https://github.com/YusukeIwaki')

data/documentation/docs/api/browser_context.md

@@ -91,11 +91,21 @@ Returns the browser instance of the context. If it was launched as a persistent
 ## clear_cookies
 
 ```
-def clear_cookies
+def clear_cookies(domain: nil, name: nil, path: nil)
 ```
 
 
-Clears context cookies.
+Removes cookies from context. Accepts optional filter.
+
+**Usage**
+
+```ruby
+context.clear_cookies()
+context.clear_cookies(name: "session-id")
+context.clear_cookies(domain: "my-origin.com")
+context.clear_cookies(path: "/api/v1")
+context.clear_cookies(name: "session-id", domain: "my-origin.com")
+```
 
 ## clear_permissions
 
@@ -311,14 +321,16 @@ page.goto("https://example.com")
 
 It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:
 
-```python sync title=example_c78483d1434363f907c28aecef3a1c6d83c0136d98bb07c2bd326cd19e006aa9.py
-def handle_route(route: Route):
-  if ("my-string" in route.request.post_data):
-    route.fulfill(body="mocked-data")
-  else:
-    route.continue_()
-context.route("/api/**", handle_route)
-
+```ruby
+def handle_route(route, request)
+  if request.post_data["my-string"]
+    mocked_data = request.post_data.merge({ "my-string" => 'mocked-data'})
+    route.fulfill(postData: mocked_data)
+  else
+    route.continue
+  end
+end
+context.route("/api/**", method(:handle_route))
 ```
 
 Page routes (set up with [Page#route](./page#route)) take precedence over browser context routes when request matches both

data/documentation/docs/api/frame_locator.md

@@ -26,11 +26,11 @@ page.frame_locator('.result-frame').first.get_by_role('button').click
 
 **Converting Locator to FrameLocator**
 
-If you have a [Locator](./locator) object pointing to an `iframe` it can be converted to [FrameLocator](./frame_locator) using [`:scope`](https://developer.mozilla.org/en-US/docs/Web/CSS/:scope) CSS selector:
+If you have a [Locator](./locator) object pointing to an `iframe` it can be converted to [FrameLocator](./frame_locator) using [Locator#content_frame](./locator#content_frame).
 
-```ruby
-frame_locator = locator.frame_locator(':scope')
-```
+**Converting FrameLocator to Locator**
+
+If you have a [FrameLocator](./frame_locator) object it can be converted to [Locator](./locator) pointing to the same `iframe` using [FrameLocator#owner](./frame_locator#owner).
 
 ## first
 
@@ -305,3 +305,25 @@ def nth(index)
 
 
 Returns locator to the n-th matching frame. It's zero based, `nth(0)` selects the first frame.
+
+## owner
+
+```
+def owner
+```
+
+
+Returns a [Locator](./locator) object pointing to the same `iframe` as this frame locator.
+
+Useful when you have a [FrameLocator](./frame_locator) object obtained somewhere, and later on would like to interact with the `iframe` element.
+
+For a reverse operation, use [Locator#content_frame](./locator#content_frame).
+
+**Usage**
+
+```ruby
+frame_locator = page.frame_locator('iframe[name="embedded"]')
+# ...
+locator = frame_locator.owner
+locator.get_attribute('src') # => frame1.html
+```

data/documentation/docs/api/locator.md

@@ -377,6 +377,28 @@ def element_handles
 
 Resolves given locator to all matching DOM elements. If there are no matching elements, returns an empty list.
 
+## content_frame
+
+```
+def content_frame
+```
+
+
+Returns a [FrameLocator](./frame_locator) object pointing to the same `iframe` as this locator.
+
+Useful when you have a [Locator](./locator) object obtained somewhere, and later on would like to interact with the content inside the frame.
+
+For a reverse operation, use [FrameLocator#owner](./frame_locator#owner).
+
+**Usage**
+
+```ruby
+locator = page.locator('iframe[name="embedded"]')
+# ...
+frame_locator = locator.content_frame
+frame_locator.get_by_role("button").click
+```
+
 ## evaluate
 
 ```

data/documentation/docs/api/page.md

@@ -1246,14 +1246,16 @@ page.goto("https://example.com")
 
 It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:
 
-```python sync title=example_0ef62eead1348f28a69716a047f3b75c979d3230569d3720d4e7bdd0a22ef647.py
-def handle_route(route: Route):
-  if ("my-string" in route.request.post_data):
-    route.fulfill(body="mocked-data")
-  else:
-    route.continue_()
-page.route("/api/**", handle_route)
-
+```ruby
+def handle_route(route, request)
+  if request.post_data["my-string"]
+    mocked_data = request.post_data.merge({ "my-string" => 'mocked-data'})
+    route.fulfill(postData: mocked_data)
+  else
+    route.continue
+  end
+end
+page.route("/api/**", method(:handle_route))
 ```
 
 Page routes take precedence over browser context routes (set up with [BrowserContext#route](./browser_context#route)) when request

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

@@ -8,16 +8,16 @@ sidebar_position: 1
 
 Choose any of the three ways as you prefer to download the driver:
 
-* `npx`: suitable for playground use, and not suitable for continuous usage.
-* `npm install`: the best choice for most use cases, with existing Node.js environment.
-* Direct download: maybe a good choice for Docker :whale: integration.
+- `npx`: suitable for playground use, and not suitable for continuous usage.
+- `npm install`: the best choice for most use cases, with existing Node.js environment.
+- Direct download: maybe a good choice for Docker :whale: integration.
 
 :::note
 
 Also the article [Playwright on Alpine Linux](./playwright_on_alpine_linux) would be helpful if you plan to
 
-* Build a browser server/container like Selenium Grid
-* Run automation scripts on Alpine Linux
+- Build a browser server/container like Selenium Grid
+- Run automation scripts on Alpine Linux
 
 :::
 
@@ -29,7 +29,6 @@ $ npx playwright install
 
 and then set `playwright_cli_executable_path: "npx playwright"` at `Playwright.create`.
 
-
 ## Using `npm install`
 
 Actually `npx playwright` is a bit slow. We can also use `npm install` to setup.
@@ -44,15 +43,13 @@ $ ./node_modules/.bin/playwright install
 
 and then set `playwright_cli_executable_path: './node_modules/.bin/playwright'`
 
-
 ## Directly download driver without Node.js installation.
 
-Instead of npm, you can also directly download playwright driver from playwright.azureedge.net.  (The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/cfc1030a69d1e934cac579687a680eac53d4b9ee/setup.py#L75))
-
+Instead of npm, you can also directly download playwright driver from playwright.azureedge.net. (The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/cfc1030a69d1e934cac579687a680eac53d4b9ee/setup.py#L75))
 
 ```shell
 $ export PLAYWRIGHT_CLI_VERSION=$(bundle exec ruby -e 'puts Playwright::COMPATIBLE_PLAYWRIGHT_VERSION.strip')
 $ wget https://playwright.azureedge.net/builds/driver/playwright-$PLAYWRIGHT_CLI_VERSION-linux.zip
 ```
 
-and then extract it, and set `playwright_cli_executable_path: '/path/to/playwright-1.11.0-linux/playwright.sh'`
+and then extract it, and set `playwright_cli_executable_path: '/path/to/playwright-$PLAYWRIGHT_CLI_VERSION-linux/node /path/to/playwright-$PLAYWRIGHT_CLI_VERSION-linux/package/cli.js'`

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

@@ -62,7 +62,7 @@ Many example uses `Playwright#create`, which internally uses Pipe (stdin/stdout)
 ```ruby {3}
 require 'playwright'
 
-Playwright.connect_to_playwright_server('wss://example.com:8888/ws') do |playwright|
+Playwright.connect_to_playwright_server('wss://example.com:8888/ws?browser=chromium') do |playwright|
   playwright.chromium.launch do |browser|
     page = browser.new_page
     page.goto('https://github.com/microsoft/playwright')
@@ -73,6 +73,8 @@ 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"`.
 
+Note that `?browser=chromium` is important for server to determine which browser to prepare.
+
 ### Server code
 
 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 --path /ws`. (`$PORT` is a port number of the server)

data/documentation/docs/include/api_coverage.md

@@ -440,6 +440,7 @@
 * drag_to
 * element_handle
 * element_handles
+* content_frame
 * evaluate
 * evaluate_all
 * evaluate_handle
@@ -500,6 +501,7 @@
 * last
 * locator
 * nth
+* owner
 
 ## APIResponse
 

data/documentation/docusaurus.config.js

@@ -86,6 +86,12 @@ module.exports = {
     prism: {
       additionalLanguages: ['bash', 'ruby'],
     },
+    algolia: {
+      appId: '00PBL1OR8R',
+      apiKey: '38d9bd4fef84d709547a1ca466ee8241',
+      indexName: 'playwright-ruby-client',
+      contextualSearch: false,
+    }
   },
   presets: [
     [

data/documentation/package.json

@@ -14,8 +14,8 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.0.0",
-    "@docusaurus/preset-classic": "^3.0.0",
+    "@docusaurus/core": "^3.1.1",
+    "@docusaurus/preset-classic": "^3.1.1",
     "@mdx-js/react": "^3.0.0",
     "@svgr/webpack": "^8.1.0",
     "clsx": "^2.0.0",