playwright-ruby-client 1.15.1 → 1.17.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36f932a83b81283925520630e54a3c4b578d3231f2540f49ce27acf206c14e1e
-  data.tar.gz: 13d5171781c20e6aba7df33828c2ec569d975328de72dff21bb31ae8d51838ea
+  metadata.gz: c2fe4b12d358a45b087eee4cdfc8aecb03b9e6df7d012158e4a04a042d290d13
+  data.tar.gz: ed57849806349f58419ead4e64164cafb94de892fa5d4be7cbf9f6e67867eb5d
 SHA512:
-  metadata.gz: e25671c14ede2650a5cd2a2a9e2542e7c629e8bb4ff64c57fff23c91cf9b6cfdfda2549944118659a3a4db968c27c037b74e18e042d5d7c74f1dac9f073a6d50
-  data.tar.gz: 05c22aaeb2cf8cdb61ed1f7ad67222ded55a8b14be33c7f1d8fb24dbb22e7040bd888216335e03b02dec716e0e3eb4f87351f9fddc28fae2dcd0cf04b311bbc8
+  metadata.gz: b4245e2cc937bf4dd85ab98848b4a56149d796d814407598e17258f64154d85f252a3f993e13c8a81bda0f0112ffc5c1fa93e699c7fb691e3bf7592f27cd6133
+  data.tar.gz: 5680b2040b8ff3927b952e9f5321355137c298c697b0ba5ecde686eb89545f8b3444e191da3fe8ba22315df6fc982e452bdff73d71774419ee32a08e9a0281ef

data/documentation/docs/api/{fetch_request.md → api_request_context.md}

@@ -2,9 +2,9 @@
 sidebar_position: 10
 ---
 
-# FetchRequest
+# APIRequestContext
 
-This API is used for Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
+This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
 environment or the service to your e2e test. When used on [Page](./page) or a [BrowserContext](./browser_context), this API will automatically use
 the cookies from the corresponding [BrowserContext](./browser_context). This means that if you log in using this API, your e2e test will be
 logged in and vice versa.

data/documentation/docs/api/browser_context.md

@@ -11,7 +11,7 @@ BrowserContexts provide a way to operate multiple independent browser sessions.
 If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser
 context.
 
-Playwright allows creation of "incognito" browser contexts with [Browser#new_context](./browser#new_context) method. "Incognito" browser
+Playwright allows creating "incognito" browser contexts with [Browser#new_context](./browser#new_context) method. "Incognito" browser
 contexts don't write any browsing data to disk.
 
 ```ruby

data/documentation/docs/api/element_handle.md

@@ -9,6 +9,8 @@ sidebar_position: 10
 ElementHandle represents an in-page DOM element. ElementHandles can be created with the [Page#query_selector](./page#query_selector)
 method.
 
+> NOTE: The use of ElementHandle is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 ```ruby
 href_element = page.query_selector("a")
 href_element.click
@@ -20,9 +22,6 @@ ElementHandle prevents DOM element from garbage collection unless the handle is
 ElementHandle instances can be used as an argument in [Page#eval_on_selector](./page#eval_on_selector) and [Page#evaluate](./page#evaluate)
 methods.
 
-> NOTE: In most cases, you would want to use the [Locator](./locator) object instead. You should only use [ElementHandle](./element_handle) if you
-want to retain a handle to a particular DOM Node that you intend to pass into [Page#evaluate](./page#evaluate) as an argument.
-
 The difference between the [Locator](./locator) and ElementHandle is that the ElementHandle points to a particular element, while
 [Locator](./locator) captures the logic of how to retrieve an element.
 

data/documentation/docs/api/frame.md

@@ -218,6 +218,9 @@ def eval_on_selector(selector, expression, arg: nil, strict: nil)
 
 Returns the return value of `expression`.
 
+> NOTE: This method does not wait for the element to pass actionability checks and therefore can lead to the flaky
+tests. Use [Locator#evaluate](./locator#evaluate), other [Locator](./locator) helper methods or web-first assertions instead.
+
 The method finds an element matching the specified selector within the frame and passes it as a first argument to
 `expression`. See [Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, the
 method throws an error.
@@ -243,6 +246,9 @@ def eval_on_selector_all(selector, expression, arg: nil)
 
 Returns the return value of `expression`.
 
+> NOTE: In most cases, [Locator#evaluate_all](./locator#evaluate_all), other [Locator](./locator) helper methods and web-first assertions do a
+better job.
+
 The method finds all elements matching the specified selector within the frame and passes an array of matched elements
 as a first argument to `expression`. See [Working with selectors](https://playwright.dev/python/docs/selectors) for more details.
 
@@ -384,6 +390,23 @@ puts frame == content_frame # => true
 
 
 
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe. Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe
+id="my-frame">`:
+
+```ruby
+locator = frame.frame_locator("#my-iframe").locator("text=Submit")
+locator.click
+```
+
+
+
 ## get_attribute
 
 ```
@@ -598,6 +621,8 @@ def query_selector(selector, strict: nil)
 
 Returns the ElementHandle pointing to the frame element.
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 The method finds an element matching the specified selector within the frame. See
 [Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, returns `null`.
 
@@ -609,6 +634,8 @@ def query_selector_all(selector)
 
 Returns the ElementHandles pointing to the frame elements.
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects instead.
+
 The method finds all elements matching the specified selector within the frame. See
 [Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, returns empty array.
 
@@ -878,6 +905,9 @@ 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
 `detached`.
 
+> NOTE: Playwright automatically waits for element to be ready before performing an action. Using [Locator](./locator) objects and
+web-first assertions make the code wait-for-selector-free.
+
 Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
 the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the
 selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.

data/documentation/docs/api/frame_locator.md

@@ -0,0 +1,70 @@
+---
+sidebar_position: 10
+---
+
+# FrameLocator
+
+FrameLocator represents a view to the `iframe` on the page. It captures the logic sufficient to retrieve the `iframe`
+and locate elements in that iframe. FrameLocator can be created with either [Page#frame_locator](./page#frame_locator) or
+[Locator#frame_locator](./locator#frame_locator) method.
+
+```ruby
+locator = page.frame_locator("my-frame").locator("text=Submit")
+locator.click
+```
+
+**Strictness**
+
+Frame locators are strict. This means that all operations on frame locators will throw if more than one element matches
+given selector.
+
+```ruby
+# Throws if there are several frames in DOM:
+page.frame_locator('.result-frame').locator('button').click
+
+# Works because we explicitly tell locator to pick the first frame:
+page.frame_locator('.result-frame').first.locator('button').click
+```
+
+
+
+## first
+
+```
+def first
+```
+
+Returns locator to the first matching frame.
+
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe.
+
+## last
+
+```
+def last
+```
+
+Returns locator to the last matching frame.
+
+## locator
+
+```
+def locator(selector)
+```
+
+The method finds an element matching the specified selector in the FrameLocator's subtree.
+
+## nth
+
+```
+def nth(index)
+```
+
+Returns locator to the n-th matching frame.

data/documentation/docs/api/locator.md

@@ -329,6 +329,22 @@ def focus(timeout: nil)
 
 Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
 
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe:
+
+```ruby
+locator = page.frame_locator("text=Submit").locator("text=Submit")
+locator.click
+```
+
+
+
 ## get_attribute
 
 ```
@@ -445,8 +461,7 @@ Returns locator to the last matching element.
 def locator(selector)
 ```
 
-The method finds an element matching the specified selector in the [Locator](./locator)'s subtree. See
-[Working with selectors](https://playwright.dev/python/docs/selectors) for more details.
+The method finds an element matching the specified selector in the [Locator](./locator)'s subtree.
 
 ## nth
 
@@ -677,3 +692,21 @@ If the element is detached from the DOM at any moment during the action, this me
 
 When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
 zero timeout disables this.
+
+## wait_for
+
+```
+def wait_for(state: nil, timeout: nil)
+```
+
+Returns when element specified by locator satisfies the `state` option.
+
+If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to `timeout`
+milliseconds until the condition is met.
+
+```ruby
+order_sent = page.locator("#order-sent")
+order_sent.wait_for
+```
+
+

data/documentation/docs/api/page.md

@@ -315,6 +315,9 @@ page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches") # =
 def eval_on_selector(selector, expression, arg: nil, strict: nil)
 ```
 
+> NOTE: This method does not wait for the element to pass actionability checks and therefore can lead to the flaky
+tests. Use [Locator#evaluate](./locator#evaluate), other [Locator](./locator) helper methods or web-first assertions instead.
+
 The method finds an element matching the specified selector within the page and passes it as a first argument to
 `expression`. If no elements match the selector, the method throws an error. Returns the value of `expression`.
 
@@ -337,6 +340,9 @@ Shortcut for main frame's [Frame#eval_on_selector](./frame#eval_on_selector).
 def eval_on_selector_all(selector, expression, arg: nil)
 ```
 
+> NOTE: In most cases, [Locator#evaluate_all](./locator#evaluate_all), other [Locator](./locator) helper methods and web-first assertions do a
+better job.
+
 The method finds all elements matching the specified selector within the page and passes an array of matched elements as
 a first argument to `expression`. Returns the result of `expression` invocation.
 
@@ -575,6 +581,23 @@ frame = page.frame(url: /.*domain.*/)
 
 
 
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe. Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe
+id="my-frame">`:
+
+```ruby
+locator = page.frame_locator("#my-iframe").locator("text=Submit")
+locator.click
+```
+
+
+
 ## frames
 
 ```
@@ -905,8 +928,10 @@ page.screenshot(path: "o.png")
 def query_selector(selector, strict: nil)
 ```
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 The method finds an element matching the specified selector within the page. If no elements match the selector, the
-return value resolves to `null`. To wait for an element on the page, use [Page#wait_for_selector](./page#wait_for_selector).
+return value resolves to `null`. To wait for an element on the page, use [Locator#wait_for](./locator#wait_for).
 
 Shortcut for main frame's [Frame#query_selector](./frame#query_selector).
 
@@ -916,6 +941,8 @@ Shortcut for main frame's [Frame#query_selector](./frame#query_selector).
 def query_selector_all(selector)
 ```
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 The method finds all elements matching the specified selector within the page. If no elements match the selector, the
 return value resolves to `[]`.
 
@@ -927,8 +954,8 @@ Shortcut for main frame's [Frame#query_selector_all](./frame#query_selector_all)
 def reload(timeout: nil, waitUntil: nil)
 ```
 
-Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
-last redirect.
+This method reloads the current page, in the same way as if the user had triggered a browser refresh. Returns the main
+resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
 
 ## route
 
@@ -1141,7 +1168,8 @@ In the case of multiple pages in a single browser, each page can have its own vi
 [Browser#new_context](./browser#new_context) allows to set viewport size (and more) for all pages in the context at once.
 
 `page.setViewportSize` will resize the page. A lot of websites don't expect phones to change size, so you should set the
-viewport size before navigating to the page.
+viewport size before navigating to the page. [Page#set_viewport_size](./page#set_viewport_size) will also reset `screen` size, use
+[Browser#new_context](./browser#new_context) with `screen` and `viewport` parameters if you need better control of these properties.
 
 ```ruby
 page.viewport_size = { width: 640, height: 480 }
@@ -1483,6 +1511,9 @@ 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
 `detached`.
 
+> NOTE: Playwright automatically waits for element to be ready before performing an action. Using [Locator](./locator) objects and
+web-first assertions make the code wait-for-selector-free.
+
 Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
 the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the
 selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.

data/documentation/docs/api/request.md

@@ -127,10 +127,10 @@ def redirected_from
 Request that was redirected by the server to this one, if any.
 
 When the server responds with a redirect, Playwright creates a new [Request](./request) object. The two requests are connected by
-`redirectedFrom()` and `redirectedTo()` methods. When multiple server redirects has happened, it is possible to
-construct the whole redirect chain by repeatedly calling `redirectedFrom()`.
+[redirected_from](./request#redirected_from) and [redirected_to](./request#redirected_to) methods. When multiple server redirects has happened, it is possible to
+construct the whole redirect chain by repeatedly calling [redirected_from](./request#redirected_from).
 
-For example, if the website `http://example.com` redirects to `https://example.com`:
+For example, if the website `http://github.com` redirects to `https://github.com`:
 
 ```ruby
 response = page.goto("http://github.com")

data/documentation/docs/api/selectors.md

@@ -41,7 +41,7 @@ playwright.chromium.launch do |browser|
   page.click('tag=div >> text="Click me"')
 
   # Can use it in any methods supporting selectors.
-  button_count = page.eval_on_selector_all('tag=button', 'buttons => buttons.length')
+  button_count = page.locator('tag=button').count
   button_count # => 1
 end
 ```

data/documentation/docs/api/tracing.md

@@ -23,7 +23,7 @@ end
 ## start
 
 ```
-def start(name: nil, screenshots: nil, snapshots: nil)
+def start(name: nil, screenshots: nil, snapshots: nil, title: nil)
 ```
 
 Start tracing.
@@ -40,7 +40,7 @@ context.tracing.stop(path: 'trace.zip')
 ## start_chunk
 
 ```
-def start_chunk
+def start_chunk(title: nil)
 ```
 
 Start a new trace chunk. If you'd like to record multiple traces on the same [BrowserContext](./browser_context), use

data/documentation/docs/include/api_coverage.md

@@ -1,5 +1,17 @@
 # API coverages
 
+## APIRequestContext
+
+* ~~delete~~
+* ~~dispose~~
+* ~~fetch~~
+* ~~get~~
+* ~~head~~
+* ~~patch~~
+* ~~post~~
+* ~~put~~
+* ~~storage_state~~
+
 ## Request
 
 * all_headers
@@ -48,13 +60,6 @@
 * fulfill
 * request
 
-## FetchRequest
-
-* ~~dispose~~
-* ~~fetch~~
-* ~~get~~
-* ~~post~~
-
 ## WebSocket
 
 * closed?
@@ -162,6 +167,7 @@
 * fill
 * focus
 * frame_element
+* frame_locator
 * get_attribute
 * goto
 * hover
@@ -259,6 +265,7 @@
 * fill
 * focus
 * frame
+* frame_locator
 * frames
 * get_attribute
 * go_back
@@ -354,6 +361,7 @@
 * expect_event
 * expect_page
 * ~~wait_for_event~~
+* ~~request~~
 * tracing
 
 ## CDPSession
@@ -388,6 +396,7 @@
 * chromium
 * devices
 * firefox
+* ~~request~~
 * selectors
 * webkit
 
@@ -416,6 +425,7 @@
 * fill
 * first
 * focus
+* frame_locator
 * get_attribute
 * hover
 * inner_html
@@ -441,6 +451,15 @@
 * text_content
 * type
 * uncheck
+* wait_for
+
+## FrameLocator
+
+* first
+* frame_locator
+* last
+* locator
+* nth
 
 ## Android
 

data/documentation/package.json

@@ -14,8 +14,8 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-beta.5",
-    "@docusaurus/preset-classic": "^2.0.0-beta.5",
+    "@docusaurus/core": "^2.0.0-beta.6",
+    "@docusaurus/preset-classic": "^2.0.0-beta.6",
     "@mdx-js/react": "^1.6.21",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",