playwright-ruby-client 1.39.1 → 1.41.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9c0bd246e9fc2ccd9358b60aa056266dfcee1f3fd2ee0174ae7a23173a1a9cb
-  data.tar.gz: 7e68e6e420040c24cdb9514dcde89ec6a2fd68ceda91b9590ed367ef5b1e52b7
+  metadata.gz: ed3850992222f0ca034bfb21929941320408b44967cf2a6670f59697f773918f
+  data.tar.gz: 9e9137831c4e1cc10929809bd2d5f477df3c8d0e5ffdbd1f050cb697a655aa00
 SHA512:
-  metadata.gz: e67763b081ab137ab5da3cfbb0e397a664b4489574a3368e0059566b0e6c519d8685e252bedf76213cd7a8cad34cde3e0b2c4587adcc2241b255095ad1ffa3c7
-  data.tar.gz: 675f7ad040dace09c78d5d12672999d7c5a6d2ae067c89a078dd75e6f866db53191d1890a76d816f8aef797d83f0b12ed7d1311c3cbf00c90f62d38cfb407e62
+  metadata.gz: f38e9f6ab657a84cffa1d7ef20282dcc68bb2b99a142788455a1824f575f1c1ac858b0a8b3d4570f43e7df5e07c0fc965a1951afef3c419d6b4507169fcf802f
+  data.tar.gz: b2624ca693431803afe83cb77c9dbe83d9d96c30618e4c827666737210db5c296ed0b4e10abe131c3fdf1ed9f7ca166eca158d0569f6b68be74c94007f06f470

data/documentation/docs/api/api_request_context.md

@@ -85,8 +85,7 @@ def dispose
 ```
 
 
-All responses returned by [APIRequestContext#get](./api_request_context#get) and similar methods are stored in the memory, so that you can later call [APIResponse#body](./api_response#body). This method
-discards all stored responses, and makes [APIResponse#body](./api_response#body) throw "Response disposed" error.
+All responses returned by [APIRequestContext#get](./api_request_context#get) and similar methods are stored in the memory, so that you can later call [APIResponse#body](./api_response#body).This method discards all its resources, calling any method on disposed [APIRequestContext](./api_request_context) will throw an exception.
 
 ## fetch
 

data/documentation/docs/api/browser.md

@@ -31,7 +31,7 @@ Get the browser type (chromium, firefox or webkit) that the browser belongs to.
 ## close
 
 ```
-def close
+def close(reason: nil)
 ```
 
 

data/documentation/docs/api/browser_context.md

@@ -120,7 +120,7 @@ context.clear_permissions
 ## close
 
 ```
-def close
+def close(reason: nil)
 ```
 
 
@@ -441,6 +441,15 @@ def storage_state(path: nil)
 
 Returns storage state for this browser context, contains current cookies and local storage snapshot.
 
+## unroute_all
+
+```
+def unroute_all(behavior: nil)
+```
+
+
+Removes all routes created with [BrowserContext#route](./browser_context#route) and [BrowserContext#route_from_har](./browser_context#route_from_har).
+
 ## unroute
 
 ```

data/documentation/docs/api/browser_type.md

@@ -127,6 +127,7 @@ def launch_persistent_context(
       env: nil,
       executablePath: nil,
       extraHTTPHeaders: nil,
+      firefoxUserPrefs: nil,
       forcedColors: nil,
       geolocation: nil,
       handleSIGHUP: nil,

data/documentation/docs/api/download.md

@@ -68,8 +68,7 @@ def path
 ```
 
 
-Returns path to the downloaded file in case of successful download. The method will
-wait for the download to finish if necessary. The method throws when connected remotely.
+Returns path to the downloaded file for a successful download, or throws for a failed/canceled download. The method will wait for the download to finish if necessary. The method throws when connected remotely.
 
 Note that the download's file name is a random GUID, use [Download#suggested_filename](./download#suggested_filename)
 to get suggested file name.

data/documentation/docs/api/element_handle.md

@@ -180,13 +180,16 @@ default.
 
 Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial
 properties:
+- [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/DeviceMotionEvent)
+- [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent/DeviceOrientationEvent)
 - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
+- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
 - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
 - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
 - [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
 - [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
 - [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
-- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
+- [WheelEvent](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/WheelEvent)
 
 You can also specify [JSHandle](./js_handle) as the property value if you want live objects to be passed into the event:
 
@@ -455,6 +458,7 @@ def screenshot(
       path: nil,
       quality: nil,
       scale: nil,
+      style: nil,
       timeout: nil,
       type: nil)
 ```

data/documentation/docs/api/frame.md

@@ -178,13 +178,16 @@ default.
 
 Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial
 properties:
+- [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/DeviceMotionEvent)
+- [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent/DeviceOrientationEvent)
 - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
+- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
 - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
 - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
 - [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
 - [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
 - [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
-- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
+- [WheelEvent](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/WheelEvent)
 
 You can also specify [JSHandle](./js_handle) as the property value if you want live objects to be passed into the event:
 

data/documentation/docs/api/locator.md

@@ -303,13 +303,16 @@ default.
 
 Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial
 properties:
+- [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/DeviceMotionEvent)
+- [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent/DeviceOrientationEvent)
 - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
+- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
 - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
 - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
 - [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
 - [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
 - [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
-- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
+- [WheelEvent](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/WheelEvent)
 
 You can also specify [JSHandle](./js_handle) as the property value if you want live objects to be passed into the event:
 
@@ -1096,6 +1099,7 @@ def screenshot(
       path: nil,
       quality: nil,
       scale: nil,
+      style: nil,
       timeout: nil,
       type: nil)
 ```

data/documentation/docs/api/locator_assertions.md

@@ -128,7 +128,7 @@ The opposite of [LocatorAssertions#to_contain_text](./locator_assertions#to_cont
 ## not_to_have_attribute
 
 ```ruby
-expect(locator).not_to have_attribute(name, value, timeout: nil)
+expect(locator).not_to have_attribute(name, value, ignoreCase: nil, timeout: nil)
 ```
 
 
@@ -400,6 +400,11 @@ expect(locator).to contain_text(expected, ignoreCase: nil, timeout: nil, useInne
 
 Ensures the [Locator](./locator) points to an element that contains the given text. You can use regular expressions for the value as well.
 
+**Details**
+
+When `expected` parameter is a string, Playwright will normalize whitespaces and line breaks both in the actual text and
+in the expected string before matching. When regular expression is used, the actual text is matched as is.
+
 **Usage**
 
 ```ruby
@@ -443,7 +448,7 @@ expect(page.locator("ul")).to contain_text(["Text 3"])
 ## to_have_attribute
 
 ```ruby
-expect(locator).to have_attribute(name, value, timeout: nil)
+expect(locator).to have_attribute(name, value, ignoreCase: nil, timeout: nil)
 ```
 
 
@@ -559,6 +564,11 @@ expect(locator).to have_text(expected, ignoreCase: nil, timeout: nil, useInnerTe
 
 Ensures the [Locator](./locator) points to an element with the given text. You can use regular expressions for the value as well.
 
+**Details**
+
+When `expected` parameter is a string, Playwright will normalize whitespaces and line breaks both in the actual text and
+in the expected string before matching. When regular expression is used, the actual text is matched as is.
+
 **Usage**
 
 ```ruby

data/documentation/docs/api/page.md

@@ -152,7 +152,7 @@ When all steps combined have not finished during the specified `timeout`, this m
 ## close
 
 ```
-def close(runBeforeUnload: nil)
+def close(reason: nil, runBeforeUnload: nil)
 ```
 
 
@@ -240,13 +240,16 @@ default.
 
 Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial
 properties:
+- [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/DeviceMotionEvent)
+- [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent/DeviceOrientationEvent)
 - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
+- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
 - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
 - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
 - [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
 - [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
 - [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
-- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
+- [WheelEvent](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/WheelEvent)
 
 You can also specify [JSHandle](./js_handle) as the property value if you want live objects to be passed into the event:
 
@@ -473,7 +476,7 @@ page.content = <<~HTML
 <button onclick="onClick()">Click me</button>
 <div></div>
 HTML
-page.locator("button").click
+page.click("button")
 ```
 
 An example of passing an element handle:
@@ -1291,6 +1294,7 @@ def screenshot(
       path: nil,
       quality: nil,
       scale: nil,
+      style: nil,
       timeout: nil,
       type: nil)
 ```
@@ -1545,6 +1549,15 @@ This method unchecks an element matching `selector` by performing the following
 When all steps combined have not finished during the specified `timeout`, this method throws a
 `TimeoutError`. Passing zero timeout disables this.
 
+## unroute_all
+
+```
+def unroute_all(behavior: nil)
+```
+
+
+Removes all routes created with [Page#route](./page#route) and [Page#route_from_har](./page#route_from_har).
+
 ## unroute
 
 ```

data/documentation/docs/api/tracing.md

@@ -35,7 +35,7 @@ Start tracing.
 **Usage**
 
 ```ruby
-context.tracing.start(name: 'trace', screenshots: true, snapshots: true)
+context.tracing.start(screenshots: true, snapshots: true)
 page = context.new_page
 page.goto('https://playwright.dev')
 context.tracing.stop(path: 'trace.zip')
@@ -53,7 +53,7 @@ Start a new trace chunk. If you'd like to record multiple traces on the same [Br
 **Usage**
 
 ```ruby
-context.tracing.start(name: "trace", screenshots: true, snapshots: true)
+context.tracing.start(screenshots: true, snapshots: true)
 page = context.new_page
 page.goto("https://playwright.dev")
 

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

@@ -33,7 +33,7 @@ end
 
 ### Update timeout
 
-Capybara sets the default value of timeout to *2 seconds*. Generally it is too short to wait for HTTP responses.
+Capybara sets the default value of timeout to _2 seconds_. Generally it is too short to wait for HTTP responses.
 
 It is recommended to set the timeout to 15-30 seconds for Playwright driver.
 
@@ -56,50 +56,50 @@ It is not mandatry. Without changing the default driver, you can still use Playw
 
 These parameters can be passed into `Capybara::Playwright::Driver.new`
 
-* `playwright_cli_executable_path`
-  * Refer [this article](./download_playwright_driver) to understand what to specify.
-* `browser_type`
-  * `:chromium` (default), `:firefox`, or `:webkit`
-* Parameters for [Playwright::BrowserType#launch](/docs/api/browser_type#launch)
-  * args
-  * channel
-    * `chrome`, `msedge`, `chrome-beta`, `chrome-dev`, `chrome-canary`, `msedge-beta`, `msedge-dev` Browser distribution channel. Read more about using [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge)
-  * devtools
-  * downloadsPath
-  * env
-  * executablePath
-  * firefoxUserPrefs
-  * headless
-  * ignoreDefaultArgs
-  * proxy
-  * slowMo
-  * timeout
-* Parameters for [Playwright::Browser#new_context](/docs/api/browser#new_context)
-  * bypassCSP
-  * colorScheme
-  * deviceScaleFactor
-  * extraHTTPHeaders
-  * geolocation
-  * hasTouch
-  * httpCredentials
-  * ignoreHTTPSErrors
-  * isMobile
-  * javaScriptEnabled
-  * locale
-  * noViewport
-  * offline
-  * permissions
-  * proxy
-  * record_har_omit_content
-  * record_har_path
-  * record_video_dir
-  * record_video_size
-  * screen
-  * serviceWorkers
-  * storageState
-  * timezoneId
-  * userAgent
-  * viewport
+- `playwright_cli_executable_path`
+  - Refer [this article](./download_playwright_driver) to understand what to specify.
+- `browser_type`
+  - `:chromium` (default), `:firefox`, or `:webkit`
+- Parameters for [Playwright::BrowserType#launch](/docs/api/browser_type#launch)
+  - args
+  - channel
+    - `chrome`, `msedge`, `chrome-beta`, `chrome-dev`, `chrome-canary`, `msedge-beta`, `msedge-dev` Browser distribution channel. Read more about using [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge)
+  - devtools
+  - downloadsPath
+  - env
+  - executablePath
+  - firefoxUserPrefs
+  - headless
+  - ignoreDefaultArgs
+  - proxy
+  - slowMo
+  - timeout
+- Parameters for [Playwright::Browser#new_context](/docs/api/browser#new_context)
+  - bypassCSP
+  - colorScheme
+  - deviceScaleFactor
+  - extraHTTPHeaders
+  - geolocation
+  - hasTouch
+  - httpCredentials
+  - ignoreHTTPSErrors
+  - isMobile
+  - javaScriptEnabled
+  - locale
+  - noViewport
+  - offline
+  - permissions
+  - proxy
+  - record_har_omit_content
+  - record_har_path
+  - record_video_dir
+  - record_video_size
+  - screen
+  - serviceWorkers
+  - storageState
+  - timezoneId
+  - userAgent
+  - viewport
 
 ```ruby
 driver_opts = {
@@ -119,14 +119,13 @@ driver_opts = {
 Capybara::Playwright::Driver.new(app, driver_opts)
 ```
 
-
 ## Available functions and Limitations
 
 ### Capybara DSL
 
 Most of the methods of `Capybara::Session` and `Capybara::Node::Element` are available. However the following method is not yet implemented.
 
-* `Capybara::Node::Element#drop`
+- `Capybara::Node::Element#drop`
 
 ### Playwright-native scripting
 
@@ -181,7 +180,6 @@ end
 
 For more details, refer [Recording video](./recording_video.md#using-screen-recording-from-capybara-driver)
 
-
 ### Screenshot just before teardown
 
 In addition to `Capybara::Session#save_screenshot`, capybara-playwright-driver have another method for storing last screen state just before teardown.
@@ -201,8 +199,39 @@ before do |example|
 end
 ```
 
+### Tracing for postmortem
+
+Playwright users often expect to see what happened in the browser when the test failed. `capybara-playwright-driver` provides a feature to store the trace easily.
+
+```ruby
+before do |example|
+  Capybara.current_session.driver.on_save_trace do |trace_zip_path|
+    Allure.add_attachment(
+      name: "trace - #{example.description}",
+      source: File.read(trace_zip_path),
+      type: 'application/zip',
+      test_case: true,
+    )
+  end
+end
+```
+
+This example code would attach the trace zip file to Allure report for each test case.
+
+![add trace image](https://user-images.githubusercontent.com/11763113/282307106-520d800b-67ac-4e14-98bb-75a8bbb98a1f.png)
+
+We can download and show the trace with `playwright show-trace` command.
+
+```
+npx playwright show-trace ababcdcdefef.zip
+```
+
+![show-trace image](https://user-images.githubusercontent.com/11763113/282307098-a4167c32-d5e7-4631-a3b6-62d278efbeef.png)
+
+Instead of the easy configuration using `on_save_trace`, we can also use `page.driver.start_tracing` / `page.driver.stop_tracing` or `page.driver.with_trace do { ... }` for storing the trace with detailed options. See [the PR](https://github.com/YusukeIwaki/capybara-playwright-driver/pull/66) for more details including example codes for RSpec.
+
 ### Limitations
 
-* Playwright doesn't allow clicking invisible DOM elements or moving elements. `click` sometimes doesn't work as Selenium does. See the detail in https://playwright.dev/docs/actionability/
-* `current_window.maximize` and `current_window.fullscreen` work only on headful (non-headless) mode, as selenium driver does.
-* `Capybara::Node::Element#drag_to` does not accept `html5` parameter. HTML5 drag and drop is not fully supported in Playwright.
+- Playwright doesn't allow clicking invisible DOM elements or moving elements. `click` sometimes doesn't work as Selenium does. See the detail in https://playwright.dev/docs/actionability/
+- `current_window.maximize` and `current_window.fullscreen` work only on headful (non-headless) mode, as selenium driver does.
+- `Capybara::Node::Element#drag_to` does not accept `html5` parameter. HTML5 drag and drop is not fully supported in Playwright.

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

@@ -0,0 +1,59 @@
+---
+sidebar_position: 5
+---
+
+# Web-First assertions for RSpec
+
+Playwright introduces clever assertions for E2E testing, so called [web-first assertions](https://playwright.dev/docs/test-assertions).
+
+```ruby
+it 'should show username after login' do
+  page.fill('input[name="username"]', 'playwright')
+  page.fill('input[name="password"]', 'password123')
+  page.expect_navigation do
+    page.locator('button[type="submit"]').click
+  end
+
+  dashboard_container = page.locator('.dashboard')
+
+  # Not web-first assertion
+  expect(dashboard_container.text_content).to include('Hi, playwright!')
+
+  # Web-first assertion
+  expect(dashboard_container).to have_text('Hi, playwright!')
+end
+```
+
+The spec above have 2 similar expectations. The first one is a normal assertion, which is not web-first. The second one is a web-first assertion, which is introduced by Playwright.
+
+Imagine the case that 'Hi, playwright!' is shown after loading some data from API server. In this case, the first assertion may fail because 'Hi, playwright!' is not present soon after login. On the other hand, the second assertion automatically waits for the 'Hi, playwright!' to be shown.
+
+## Configure
+
+For avoiding matcher name conflicts, web-first assertions are not loaded by default. To enable web-first assertions, we have to configure RSpec as below:
+
+```ruby title=spec/support/web_first_assertion.rb
+require 'playwright/test'
+
+RSpec.configure do |config|
+  # include web-first assertions just for feature specs.
+  config.include Playwright::RSpec::Matchers, type: :feature
+end
+```
+
+If you want to use web-first assertions only for some specs, you can include `Playwright::RSpec::Matchers` in the spec file directly.
+
+```ruby title=spec/system/example_spec.rb
+require 'rails_helper'
+require 'playwright/test'
+
+describe 'example' do
+  include Playwright::RSpec::Matchers
+
+  it 'should work' do
+    ...
+```
+
+## Matchers
+
+Please refer to [API doc](/docs/api/locator_assertions).

data/documentation/docs/include/api_coverage.md

@@ -315,6 +315,7 @@
 * title
 * type
 * uncheck
+* unroute_all
 * unroute
 * url
 * video
@@ -368,6 +369,7 @@
 * set_geolocation
 * set_offline
 * storage_state
+* unroute_all
 * unroute
 * expect_console_message
 * expect_event

data/documentation/docusaurus.config.js

@@ -81,7 +81,7 @@ module.exports = {
           ],
         },
       ],
-      copyright: `Copyright © ${new Date().getFullYear()} @YusukeIwaki. <p>Built with <a href="https://v2.docusaurus.io/">Docusaurus</a>.</p>`,
+      copyright: `Copyright © ${new Date().getFullYear()} @YusukeIwaki. <p>Built with <a href="https://docusaurus.io/">Docusaurus</a>.</p>`,
     },
     prism: {
       additionalLanguages: ['bash', 'ruby'],

data/documentation/package.json

@@ -14,14 +14,14 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.1",
-    "@docusaurus/preset-classic": "^2.0.1",
-    "@mdx-js/react": "^1.6.22",
-    "@svgr/webpack": "^6.3.1",
-    "clsx": "^1.2.1",
+    "@docusaurus/core": "^3.0.0",
+    "@docusaurus/preset-classic": "^3.0.0",
+    "@mdx-js/react": "^3.0.0",
+    "@svgr/webpack": "^8.1.0",
+    "clsx": "^2.0.0",
     "file-loader": "^6.2.0",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "url-loader": "^4.1.1"
   },
   "browserslist": {