playwright-ruby-client 1.55.0 → 1.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6503261c50eaabe9ee7f02dfd5762e7e8bc26c472e3aeb2a0ba715036b97819e
-  data.tar.gz: 3474c967a82b5eabe36b445ccf4132585847b11932c0b08d0429148172584eac
+  metadata.gz: 430aa6a1bab67d9edca2cce8f72c76578402ec3aab93f296366335d23894d3dd
+  data.tar.gz: 0efe7aba9e4c2e45f6374c957dad31630e66157124f4b1b5dc2589815d39e6fc
 SHA512:
-  metadata.gz: a1ffd17d14ed76ce2cdda0350fddc987e2420e447d15c0c4defd315b91790886a53bcb5536829c05e10b6c9583e1aca806cd0b0262607e66316182de66ad343d
-  data.tar.gz: 66631908582bf6017ef4fae6e0444e4219df00f0c735eb76c5fc357f19b50dabbd74230d4214d3b09c9d1f8dced7f9a2ab4c1e28275fd558cbbe9c280175ff32
+  metadata.gz: 5d19738002e6edef932c3eba936a99ffc3b54d805640a806cb3e255542d56b72be7526cf69c6752ed409c1337899f9c132494335c76b0231601c5cd7a596a677
+  data.tar.gz: 5864d506cb7f6cfc4d0a35a65900241ca7a686f2b5e59716f16e4d4f588e832153bcff19bf71fae82bda9b91e55a7c9ee1f974e33d1541ad1a49e78a51e4b341

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Thanks for your interest in contributing to `playwright-ruby-client`!
+
+For development setup instructions and guidelines, please see [development/README.md](development/README.md).

data/README.md

@@ -187,6 +187,10 @@ When `Playwright.connect_to_playwright_server` is used, playwright_cli_executabl
 
 For more detailed instraction, refer this article: https://playwright-ruby-client.vercel.app/docs/article/guides/playwright_on_alpine_linux
 
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contributing guidelines.
+
 ## 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_context.md

@@ -73,10 +73,14 @@ browser_context.add_init_script(path: "preload.js")
 def background_pages
 ```
 
+:::warning
 
-**NOTE**: Background pages are only supported on Chromium-based browsers.
+Background pages have been removed from Chromium together with Manifest V2 extensions.
 
-All existing background pages in the context.
+:::
+
+
+Returns an empty list.
 
 ## browser
 

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,
@@ -994,6 +995,24 @@ def visible?(selector, strict: nil, timeout: nil)
 
 Returns whether the element is [visible](https://playwright.dev/python/docs/actionability#visible). `selector` that does not match any elements is considered not visible.
 
+## console_messages
+
+```
+def console_messages
+```
+
+
+Returns up to (currently) 200 last console messages from this page. See [`event: Page.console`] for more details.
+
+## page_errors
+
+```
+def page_errors
+```
+
+
+Returns up to (currently) 200 last page errors from this page. See [`event: Page.pageError`] for more details.
+
 ## locator
 
 ```
@@ -1179,6 +1198,19 @@ def query_selector_all(selector)
 The method finds all elements matching the specified selector within the page. If no elements match the selector, the
 return value resolves to `[]`.
 
+## requests
+
+```
+def requests
+```
+
+
+Returns up to (currently) 100 last network request from this page. See [`event: Page.request`] for more details.
+
+Returned requests should be accessed immediately, otherwise they might be collected to prevent unbounded memory growth as new requests come in. Once collected, retrieving most information about the request is impossible.
+
+Note that requests reported through the [`event: Page.request`] request are not collected, so there is a trade off between efficient memory usage with [Page#requests](./page#requests) and the amount of available information reported through [`event: Page.request`].
+
 ## reload
 
 ```
@@ -1901,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
 
@@ -301,6 +299,8 @@
 * enabled?
 * hidden?
 * visible?
+* console_messages
+* page_errors
 * locator
 * main_frame
 * opener
@@ -309,6 +309,7 @@
 * press
 * query_selector
 * query_selector_all
+* requests
 * ~~add_locator_handler~~
 * ~~remove_locator_handler~~
 * reload
@@ -353,7 +354,6 @@
 * workers
 * ~~wait_for_event~~
 * clock
-* accessibility
 * keyboard
 * mouse
 * request
@@ -456,6 +456,7 @@
 * count
 * dblclick
 * describe
+* description
 * dispatch_event
 * drag_to
 * element_handle

data/documentation/package.json

@@ -14,9 +14,9 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.1.1",
-    "@docusaurus/preset-classic": "^3.1.1",
-    "@mdx-js/react": "^3.0.0",
+    "@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",
     "file-loader": "^6.2.0",