playwright-ruby-client 0.9.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c0e5286a6e8faaa590ce17ed083f4e6f93c54fb6899571c5edc2a99c4148b15
-  data.tar.gz: bccd47264ec992c5c901c94faf28ec346a606d75e4636ae80828e5d64a685bf0
+  metadata.gz: d6f164b2d4296ab3f30bfb22cd5fbec86ab522df916913ab19731dd452c55efa
+  data.tar.gz: 56371e88f29c8a7e7e398582a7cda693f45d8ebbb5bf6ce6e3fa0e748a2175bc
 SHA512:
-  metadata.gz: c34792ec1bb838c99b5a540833c7e02c718147738d2b6129eb9ba63f53e6d6d1460e5abc62f9e94fecec2bc9dd07321c9badc1c4e4173ae0548151ebcbc38e12
-  data.tar.gz: 12b99906a534b8ec3a5eef041824ec4d0357fe70e3a1c696dc4f11a95c1b54edbe8c7a5d67694c7b9dc846bd34fa6e18fbb3d84f241aa345a1d89c8af4ac4a39
+  metadata.gz: d97fd45d76a1cf4202be4aae7527974b01d8f90fd1de5e4fb4ed1267d3d3eeb601d5dddc49eb70559688c6bc816df82bc8c667e6aec7d2226ce078a2e0182a25
+  data.tar.gz: 602c97a88eb16aab95590391ae26f7ba777904668d4e270e3e24fe05122606d3f23d68901e529bb28b23a91458cdf7ce165de0c87621e0ad4ef9f8a711ccaf5f

data/documentation/docs/api/accessibility.md

@@ -4,4 +4,54 @@ sidebar_position: 10
 
 # Accessibility
 
-Not Implemented
+The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by
+assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or
+[switches](https://en.wikipedia.org/wiki/Switch_access).
+
+Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might
+have wildly different output.
+
+Rendering engines of Chromium, Firefox and WebKit have a concept of "accessibility tree", which is then translated into
+different platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
+
+Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific
+AX-Tree or by assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing
+only the "interesting" nodes of the tree.
+
+## snapshot
+
+```
+def snapshot(interestingOnly: nil, root: nil)
+```
+
+Captures the current state of the accessibility tree. The returned object represents the root accessible node of the
+page.
+
+> NOTE: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers.
+Playwright will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
+
+An example of dumping the entire accessibility tree:
+
+```ruby
+snapshot = page.accessibility.snapshot
+puts snapshot
+```
+
+An example of logging the focused node's name:
+
+```ruby
+def find_focused_node(node)
+  if node['focused']
+    node
+  else
+    node['children']&.find do |child|
+      find_focused_node(child)
+    end
+  end
+end
+
+snapshot = page.accessibility.snapshot
+node = find_focused_node(snapshot)
+puts node['name']
+```
+

data/documentation/docs/api/browser_context.md

@@ -67,6 +67,16 @@ browser_context.add_init_script(path: "preload.js")
 > NOTE: The order of evaluation of multiple scripts installed via [BrowserContext#add_init_script](./browser_context#add_init_script) and
 [Page#add_init_script](./page#add_init_script) is not defined.
 
+## background_pages
+
+```
+def background_pages
+```
+
+> NOTE: Background pages are only supported on Chromium-based browsers.
+
+All existing background pages in the context.
+
 ## browser
 
 ```
@@ -301,6 +311,16 @@ To remove a route with its handler you can use [BrowserContext#unroute](./browse
 
 > NOTE: Enabling routing disables http cache.
 
+## service_workers
+
+```
+def service_workers
+```
+
+> NOTE: Service workers are only supported on Chromium-based browsers.
+
+All existing service workers in the context.
+
 ## set_default_navigation_timeout
 
 ```
@@ -369,6 +389,14 @@ alias: `offline=`
 
 
 
+## storage_state
+
+```
+def storage_state(path: nil)
+```
+
+Returns storage state for this browser context, contains current cookies and local storage snapshot.
+
 ## unroute
 
 ```

data/documentation/docs/api/element_handle.md

@@ -331,7 +331,7 @@ Returns the `element.innerText`.
 def input_value(timeout: nil)
 ```
 
-Returns `input.value` for `<input>` or `<textarea>` element. Throws for non-input elements.
+Returns `input.value` for `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
 
 ## checked?
 
@@ -641,12 +641,11 @@ become visible/hidden). If at the moment of calling the method `selector` alread
 will return immediately. If the selector doesn't satisfy the condition for the `timeout` milliseconds, the function will
 throw.
 
-```python sync title=example_3b0f6c6573db513b7b707a39d6c5bbf5ce5896b4785466d80f525968cfbd0be7.py
-page.set_content("<div><span></span></div>")
+```ruby
+page.content = "<div><span></span></div>"
 div = page.query_selector("div")
 # waiting for the "span" selector relative to the div.
-span = div.wait_for_selector("span", state="attached")
-
+span = div.wait_for_selector("span", state: "attached")
 ```
 
 > NOTE: This method does not work across navigations, use [Page#wait_for_selector](./page#wait_for_selector) instead.

data/documentation/docs/api/experimental/android.md

@@ -4,8 +4,21 @@ sidebar_position: 10
 
 # Android
 
-Playwright has **experimental** support for Android automation. See [here](https://playwright.dev/python/docs/mobile) for more information. You can
-access android namespace via:
+Playwright has **experimental** support for Android automation. This includes Chrome for Android and Android WebView.
+
+*Requirements*
+- Android device or AVD Emulator.
+- [ADB daemon](https://developer.android.com/studio/command-line/adb) running and authenticated with your device.
+  Typically running `adb devices` is all you need to do.
+- [`Chrome 87`](https://play.google.com/store/apps/details?id=com.android.chrome) or newer installed on the device
+- "Enable command line on non-rooted devices" enabled in `chrome://flags`.
+
+*Known limitations*
+- Raw USB operation is not yet supported, so you need ADB.
+- Device needs to be awake to produce screenshots. Enabling "Stay awake" developer mode will help.
+- We didn't run all the tests against the device, so not everything works.
+
+*How to run*
 
 An example of the Android automation script would be:
 

data/documentation/docs/api/frame.md

@@ -16,25 +16,16 @@ At every point of time, page exposes its current frame tree via the [Page#main_f
 
 An example of dumping frame tree:
 
-```python sync title=example_a4a9e01d1e0879958d591c4bc9061574f5c035e821a94214e650d15564d77bf4.py
-from playwright.sync_api import sync_playwright
-
-def run(playwright):
-    firefox = playwright.firefox
-    browser = firefox.launch()
-    page = browser.new_page()
-    page.goto("https://www.theverge.com")
-    dump_frame_tree(page.main_frame, "")
-    browser.close()
-
-def dump_frame_tree(frame, indent):
-    print(indent + frame.name + '@' + frame.url)
-    for child in frame.child_frames:
-        dump_frame_tree(child, indent + "    ")
-
-with sync_playwright() as playwright:
-    run(playwright)
+```ruby
+def dump_frame_tree(frame, indent = 0)
+  puts "#{' ' * indent}#{frame.name}@#{frame.url}"
+  frame.child_frames.each do |child|
+    dump_frame_tree(child, indent + 2)
+  end
+end
 
+page.goto("https://www.theverge.com")
+dump_frame_tree(page.main_frame)
 ```
 
 
@@ -176,9 +167,8 @@ The snippet below dispatches the `click` event on the element. Regardless of the
 `click` is dispatched. This is equivalent to calling
 [element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
 
-```python sync title=example_de439a4f4839a9b1bc72dbe0890d6b989c437620ba1b88a2150faa79f98184fc.py
+```ruby
 frame.dispatch_event("button#submit", "click")
-
 ```
 
 Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit` properties
@@ -195,11 +185,10 @@ Since `eventInit` is event-specific, please refer to the events documentation fo
 
 You can also specify [JSHandle](./js_handle) as the property value if you want live objects to be passed into the event:
 
-```python sync title=example_5410f49339561b3cc9d91c7548c8195a570c8be704bb62f45d90c68f869d450d.py
+```ruby
 # note you can only create data_transfer in chromium and firefox
 data_transfer = frame.evaluate_handle("new DataTransfer()")
-frame.dispatch_event("#source", "dragstart", { "dataTransfer": data_transfer })
-
+frame.dispatch_event("#source", "dragstart", eventInit: { dataTransfer: data_transfer })
 ```
 
 
@@ -212,7 +201,9 @@ def drag_and_drop(
       target,
       force: nil,
       noWaitAfter: nil,
+      sourcePosition: nil,
       strict: nil,
+      targetPosition: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -236,11 +227,10 @@ return its value.
 
 Examples:
 
-```python sync title=example_6814d0e91763f4d27a0d6a380c36d62b551e4c3e902d1157012dde0a49122abe.py
+```ruby
 search_value = frame.eval_on_selector("#search", "el => el.value")
 preload_href = frame.eval_on_selector("link[rel=preload]", "el => el.href")
-html = frame.eval_on_selector(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello")
-
+html = frame.eval_on_selector(".main-container", "(e, suffix) => e.outerHTML + suffix", arg: "hello")
 ```
 
 
@@ -261,9 +251,8 @@ return its value.
 
 Examples:
 
-```python sync title=example_618e7f8f681d1c4a1c0c9b8d23892e37cbbef013bf3d8906fd4311c51d9819d7.py
-divs_counts = frame.eval_on_selector_all("div", "(divs, min) => divs.length >= min", 10)
-
+```ruby
+divs_counts = frame.eval_on_selector_all("div", "(divs, min) => divs.length >= min", arg: 10)
 ```
 
 
@@ -283,28 +272,25 @@ If the function passed to the [Frame#evaluate](./frame#evaluate) returns a non-[
 [Frame#evaluate](./frame#evaluate) returns `undefined`. Playwright also supports transferring some additional values that are
 not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
 
-```python sync title=example_15a235841cd1bc56fad6e3c8aaea2a30e352fedd8238017f22f97fc70e058d2b.py
-result = frame.evaluate("([x, y]) => Promise.resolve(x * y)", [7, 8])
-print(result) # prints "56"
-
+```ruby
+result = frame.evaluate("([x, y]) => Promise.resolve(x * y)", arg: [7, 8])
+puts result # => "56"
 ```
 
 A string can also be passed in instead of a function.
 
-```python sync title=example_9c73167b900498bca191abc2ce2627e063f84b0abc8ce3a117416cb734602760.py
-print(frame.evaluate("1 + 2")) # prints "3"
+```ruby
+puts frame.evaluate("1 + 2") # => 3
 x = 10
-print(frame.evaluate(f"1 + {x}")) # prints "11"
-
+puts frame.evaluate("1 + #{x}") # => "11"
 ```
 
 [ElementHandle](./element_handle) instances can be passed as an argument to the [Frame#evaluate](./frame#evaluate):
 
-```python sync title=example_05568c81173717fa6841099571d8a66e14fc0853e01684630d1622baedc25f67.py
+```ruby
 body_handle = frame.query_selector("body")
-html = frame.evaluate("([body, suffix]) => body.innerHTML + suffix", [body_handle, "hello"])
-body_handle.dispose()
-
+html = frame.evaluate("([body, suffix]) => body.innerHTML + suffix", arg: [body_handle, "hello"])
+body_handle.dispose
 ```
 
 
@@ -323,10 +309,9 @@ The only difference between [Frame#evaluate](./frame#evaluate) and [Frame#evalua
 If the function, passed to the [Frame#evaluate_handle](./frame#evaluate_handle), returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then
 [Frame#evaluate_handle](./frame#evaluate_handle) would wait for the promise to resolve and return its value.
 
-```python sync title=example_a1c8e837e826079359d01d6f7eecc64092a45d8c74280d23ee9039c379132c51.py
+```ruby
 a_window_handle = frame.evaluate_handle("Promise.resolve(window)")
 a_window_handle # handle for the window object.
-
 ```
 
 A string can also be passed in instead of a function.
@@ -391,11 +376,10 @@ frame.
 
 This method throws an error if the frame has been detached before `frameElement()` returns.
 
-```python sync title=example_e6b4fdef29a401d84b17acfa319bee08f39e1f28e07c435463622220c6a24747.py
-frame_element = frame.frame_element()
-content_frame = frame_element.content_frame()
-assert frame == content_frame
-
+```ruby
+frame_element = frame.frame_element
+content_frame = frame_element.content_frame
+puts frame == content_frame # => true
 ```
 
 
@@ -479,7 +463,7 @@ Returns `element.innerText`.
 def input_value(selector, strict: nil, timeout: nil)
 ```
 
-Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
 
 ## checked?
 
@@ -656,14 +640,13 @@ Returns the array of option values that have been successfully selected.
 
 Triggers a `change` and `input` event once all the provided options have been selected.
 
-```python sync title=example_230c12044664b222bf35d6163b1e415c011d87d9911a4d39648c7f601b344a31.py
+```ruby
 # single selection matching the value
-frame.select_option("select#colors", "blue")
+frame.select_option("select#colors", value: "blue")
 # single selection matching both the label
-frame.select_option("select#colors", label="blue")
+frame.select_option("select#colors", label: "blue")
 # multiple selection
-frame.select_option("select#colors", value=["red", "green", "blue"])
-
+frame.select_option("select#colors", value: ["red", "green", "blue"])
 ```
 
 
@@ -754,10 +737,9 @@ send fine-grained keyboard events. To fill values in form fields, use [Frame#fil
 
 To press a special key, like `Control` or `ArrowDown`, use [Keyboard#press](./keyboard#press).
 
-```python sync title=example_beae7f0d11663c3c98b9d3a8e6ab76b762578cf2856e3b04ad8e42bfb23bb1e1.py
+```ruby
 frame.type("#mytextarea", "hello") # types instantly
-frame.type("#mytextarea", "world", delay=100) # types slower, like a user
-
+frame.type("#mytextarea", "world", delay: 100) # types slower, like a user
 ```
 
 
@@ -807,28 +789,16 @@ Returns when the `expression` returns a truthy value, returns that value.
 
 The [Frame#wait_for_function](./frame#wait_for_function) can be used to observe viewport size change:
 
-```python sync title=example_2f82dcf15fa9338be87a4faf7fe7de3c542040924db1e1ad1c98468ec0f425ce.py
-from playwright.sync_api import sync_playwright
-
-def run(playwright):
-    webkit = playwright.webkit
-    browser = webkit.launch()
-    page = browser.new_page()
-    page.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);")
-    page.main_frame.wait_for_function("() => window.x > 0")
-    browser.close()
-
-with sync_playwright() as playwright:
-    run(playwright)
-
+```ruby
+frame.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);")
+frame.wait_for_function("() => window.x > 0")
 ```
 
 To pass an argument to the predicate of `frame.waitForFunction` function:
 
-```python sync title=example_8b95be0fb4d149890f7817d9473428a50dc631d3a75baf89846648ca6a157562.py
+```ruby
 selector = ".foo"
-frame.wait_for_function("selector => !!document.querySelector(selector)", selector)
-
+frame.wait_for_function("selector => !!document.querySelector(selector)", arg: selector)
 ```
 
 
@@ -844,10 +814,9 @@ Waits for the required load state to be reached.
 This returns when the frame reaches a required load state, `load` by default. The navigation must have been committed
 when this method is called. If current document has already reached the required state, resolves immediately.
 
-```python sync title=example_fe41b79b58d046cda4673ededd4d216cb97a63204fcba69375ce8a84ea3f6894.py
+```ruby
 frame.click("button") # click triggers navigation.
-frame.wait_for_load_state() # the promise resolves after "load" event.
-
+frame.wait_for_load_state # the promise resolves after "load" event.
 ```
 
 
@@ -865,11 +834,10 @@ History API usage, the navigation will resolve with `null`.
 This method waits for the frame to navigate to a new URL. It is useful for when you run code which will indirectly cause
 the frame to navigate. Consider this example:
 
-```python sync title=example_03f0ac17eb6c1ce8780cfa83c4ae15a9ddbfde3f96c96f36fdf3fbf9aac721f7.py
-with frame.expect_navigation():
-    frame.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
-# Resolves after navigation has finished
-
+```ruby
+frame.expect_navigation do
+  frame.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
+end # Resolves after navigation has finished
 ```
 
 > NOTE: Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is
@@ -890,25 +858,27 @@ selector doesn't satisfy the condition for the `timeout` milliseconds, the funct
 
 This method works across navigations:
 
-```python sync title=example_a5b9dd4745d45ac630e5953be1c1815ae8e8ab03399fb35f45ea77c434f17eea.py
-from playwright.sync_api import sync_playwright
+```ruby
+%w[https://google.com https://bbc.com].each do |current_url|
+  page.goto(current_url, waitUntil: "domcontentloaded")
+  frame = page.main_frame
+  element = frame.wait_for_selector("img")
+  puts "Loaded image: #{element["src"]}"
+end
+```
+
 
-def run(playwright):
-    chromium = playwright.chromium
-    browser = chromium.launch()
-    page = browser.new_page()
-    for current_url in ["https://google.com", "https://bbc.com"]:
-        page.goto(current_url, wait_until="domcontentloaded")
-        element = page.main_frame.wait_for_selector("img")
-        print("Loaded image: " + str(element.get_attribute("src")))
-    browser.close()
 
-with sync_playwright() as playwright:
-    run(playwright)
+## wait_for_timeout
 
+```
+def wait_for_timeout(timeout)
 ```
 
+Waits for the given `timeout` in milliseconds.
 
+Note that `frame.waitForTimeout()` should only be used for debugging. Tests using the timer in production are going to
+be flaky. Use signals such as network events, selectors becoming visible and others instead.
 
 ## wait_for_url
 
@@ -918,10 +888,9 @@ def wait_for_url(url, timeout: nil, waitUntil: nil)
 
 Waits for the frame to navigate to the given URL.
 
-```python sync title=example_86a9a19ec4c41e1a5ac302fbca9a3d3d6dca3fe3314e065b8062ddf5f75abfbd.py
+```ruby
 frame.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
 frame.wait_for_url("**/target.html")
-
 ```