playwright-ruby-client 1.56.0 → 1.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8640cc3446239876e19fb40cfca695bde42bfe4e88d2bbd6659ccde5ff6d99d4
-  data.tar.gz: e8b748b832438a286de6786e8a44317aae282604815d9b7803f19fe47d24b876
+  metadata.gz: 430aa6a1bab67d9edca2cce8f72c76578402ec3aab93f296366335d23894d3dd
+  data.tar.gz: 0efe7aba9e4c2e45f6374c957dad31630e66157124f4b1b5dc2589815d39e6fc
 SHA512:
-  metadata.gz: 39c49ab82a8bb4fe056dbbba337aa266a9b1b25ec8227fbffa8b2c7e4c19ef4f63148928d42bf3252784617efc99ea7571f32a98d6a77752079e97465a402e37
-  data.tar.gz: 20d89735083a1dc2e533cffdfc41da1fe366c9ff1d309138d2894dbca1d506252f579aff1f475caea8565e8229970e3601b4d7a52e5a97de9f7593b1f8f9c744
+  metadata.gz: 5d19738002e6edef932c3eba936a99ffc3b54d805640a806cb3e255542d56b72be7526cf69c6752ed409c1337899f9c132494335c76b0231601c5cd7a596a677
+  data.tar.gz: 5864d506cb7f6cfc4d0a35a65900241ca7a686f2b5e59716f16e4d4f588e832153bcff19bf71fae82bda9b91e55a7c9ee1f974e33d1541ad1a49e78a51e4b341

data/documentation/docs/api/console_message.md

@@ -74,3 +74,12 @@ def type
 ```
 
 
+
+## worker
+
+```
+def worker
+```
+
+
+The web worker or service worker that produced this console message, if any. Note that console messages from web workers also have non-null [ConsoleMessage#page](./console_message#page).

data/documentation/docs/api/element_handle.md

@@ -103,6 +103,7 @@ def click(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      steps: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -138,6 +139,7 @@ def dblclick(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      steps: nil,
       timeout: nil,
       trial: nil)
 ```

data/documentation/docs/api/frame.md

@@ -203,6 +203,7 @@ def drag_and_drop(
       force: nil,
       noWaitAfter: nil,
       sourcePosition: nil,
+      steps: nil,
       strict: nil,
       targetPosition: nil,
       timeout: nil,

data/documentation/docs/api/locator.md

@@ -235,6 +235,7 @@ def click(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      steps: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -296,6 +297,7 @@ def dblclick(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      steps: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -334,6 +336,25 @@ button = page.get_by_test_id("btn-sub").describe("Subscribe button")
 button.click
 ```
 
+## description
+
+```
+def description
+```
+
+
+Returns locator description previously set with [Locator#describe](./locator#describe). Returns `null` if no custom description has been set. Prefer `Locator.toString()` for a human-readable representation, as it uses the description when available.
+
+**Usage**
+
+```ruby
+button = page.get_by_role("button").describe("Subscribe button")
+puts button.description # => "Subscribe button"
+
+input = page.get_by_role("textbox")
+puts input.description # => nil
+```
+
 ## dispatch_event
 
 ```
@@ -387,6 +408,7 @@ def drag_to(
       force: nil,
       noWaitAfter: nil,
       sourcePosition: nil,
+      steps: nil,
       targetPosition: nil,
       timeout: nil,
       trial: nil)

data/documentation/docs/api/page.md

@@ -266,6 +266,7 @@ def drag_and_drop(
       force: nil,
       noWaitAfter: nil,
       sourcePosition: nil,
+      steps: nil,
       strict: nil,
       targetPosition: nil,
       timeout: nil,
@@ -1932,8 +1933,6 @@ associated with the page.
 
 Playwright has ability to mock clock and passage of time.
 
-## accessibility
-
 ## keyboard
 
 ## mouse

data/documentation/docs/api/worker.md

@@ -61,3 +61,23 @@ def url
 ```
 
 
+
+## expect_event
+
+```
+def expect_event(event, predicate: nil, timeout: nil, &block)
+```
+
+
+Waits for event to fire and passes its value into the predicate function.
+Returns when the predicate returns truthy value.
+Will throw an error if the page is closed before the event is fired.
+Returns the event data value.
+
+**Usage**
+
+```ruby
+message = worker.expect_event("console") do
+  worker.evaluate("console.log(42)")
+end
+```

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

@@ -54,6 +54,25 @@ 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"`.
 
+We can also pass launchOptions parameters using a `launch-options` query string like this:
+
+```ruby {3-4}
+require 'json'
+
+launch_params = { headless: false }
+Playwright.connect_to_browser_server("wss://example.com:8888/ws?launch-options=#{launch_params.to_json}") do |browser|
+  page = browser.new_page
+  page.goto('https://github.com/microsoft/playwright')
+  page.screenshot(path: 'github-microsoft-playwright_headful.png')
+end
+
+Playwright.connect_to_browser_server('wss://example.com:8888/ws') do |browser|
+  page = browser.new_page
+  page.goto('https://github.com/microsoft/playwright')
+  page.screenshot(path: 'github-microsoft-playwright_headless.png')
+end
+```
+
 ### 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/article/guides/rails_integration.md

@@ -23,7 +23,7 @@ Note that capybara-playwright-driver does not depend on Selenium. But `selenium-
 ## Register and configure Capybara driver
 
 ```rb
-Capybara.register_driver(:playwright) do |app|
+Capybara.register_driver(:customized_playwright) do |app|
   Capybara::Playwright::Driver.new(app,
     browser_type: :chromium, # :chromium (default) or :firefox, :webkit
     headless: false, # true for headless mode (default), false for headful mode.
@@ -31,6 +31,38 @@ Capybara.register_driver(:playwright) do |app|
 end
 ```
 
+:::note
+
+Rails itself (since Rails 6.1) reserves the driver name `:playwright` for its built‑in integration (see [rails/rails#39987](https://github.com/rails/rails/issues/39987) and [YusukeIwaki/capybara-playwright-driver#93](https://github.com/YusukeIwaki/capybara-playwright-driver/issues/93)). **If you call `Capybara.register_driver(:playwright) { ... }` and then use `driven_by :playwright`, Rails' built‑in Playwright driver will be selected** instead of the one defined by `Capybara.register_driver(:playwright) { ... }`. Therefore, when you want to use the driver from this gem with custom options, register it with another name such as `:customized_playwright`.
+
+:::
+
+### When running Playwright in a container
+
+If Playwright is running in an independent container, with docker-compose.yaml config like this
+
+```
+  playwright: # this is our PLAYWRIGHT_HOST value
+    image: mcr.microsoft.com/playwright:v1.56.1-noble
+    command: >
+      /bin/sh -c "npx -y playwright@1.56.1 run-server --port 3000 --host 0.0.0.0 --path /ws"
+    init: true
+    restart: unless-stopped
+```
+
+Configure capybara to use the `browser_server_endpoint_url`
+
+```rb
+Capybara.register_driver(:playwright_remote) do |app|
+  Capybara::Playwright::Driver.new(
+    app,
+    browser_type: :chromium,
+    headless: true,
+    browser_server_endpoint_url: "ws://#{ENV.fetch('PLAYWRIGHT_HOST')}:3000/ws"
+  )
+end
+```
+
 ### Update timeout
 
 Capybara sets the default value of timeout to _2 seconds_. Generally it is too short to wait for HTTP responses.
@@ -50,7 +82,16 @@ Capybara.default_driver = :playwright
 Capybara.javascript_driver = :playwright
 ```
 
-It is not mandatry. Without changing the default driver, you can still use Playwright driver by specifying `Capybara.current_driver = :playwright` (or `driven_by :playwright` in system spec) explicitly.
+If you registered a customized driver (e.g. `:customized_playwright` as above) and want that to be the default, set:
+
+```rb
+Capybara.default_driver = :customized_playwright
+Capybara.javascript_driver = :customized_playwright
+```
+
+Remember: choosing `:playwright` here will use Rails' built‑in driver, not the customized one from this gem.
+
+It is not mandatory. Without changing the default driver, you can still use the customized Playwright driver by specifying `Capybara.current_driver = :customized_playwright` (or `driven_by :customized_playwright` in system spec) explicitly. Use `:playwright` only if you intend to run against Rails' built‑in Playwright driver (see issues: https://github.com/YusukeIwaki/capybara-playwright-driver/issues/93, https://github.com/rails/rails/issues/39987).
 
 ### (reference) Available driver options
 

data/documentation/docs/include/api_coverage.md

@@ -129,10 +129,6 @@
 * wait_for_element_state
 * wait_for_selector
 
-## Accessibility
-
-* snapshot
-
 ## FileChooser
 
 * element
@@ -208,6 +204,7 @@
 * evaluate
 * evaluate_handle
 * url
+* expect_event
 
 ## Selectors
 
@@ -231,6 +228,7 @@
 * page
 * text
 * type
+* worker
 
 ## Dialog
 
@@ -356,7 +354,6 @@
 * workers
 * ~~wait_for_event~~
 * clock
-* accessibility
 * keyboard
 * mouse
 * request
@@ -459,6 +456,7 @@
 * count
 * dblclick
 * describe
+* description
 * dispatch_event
 * drag_to
 * element_handle

data/documentation/package.json

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