playwright-ruby-client 1.48.1 → 1.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e84153fede0ac5242bc3e0ebd9b13eda2d78b4b6c62db3a619b4cd772fa8e6ae
-  data.tar.gz: 82595f648261561b21a676c9bb2c64e578bf7ec2a6ec0402531ae8c505ef9da6
+  metadata.gz: f5e833f23292dc337b4ed19f216fd53f9ecc362426b9980e5de3a2a5a23a5542
+  data.tar.gz: e7b0ffa7a775f4b677a6102e18d9ac8718d102613ef43ef71e3fbaca3f546c6d
 SHA512:
-  metadata.gz: 0d136563ebbcb24d0baf4158848ca2946379933188d7148507ecdfd99f4c830439f9cc30a4487c8ad2e85066b718af613c5879872c1466a86225e98c62295eff
-  data.tar.gz: 8e778728dea1a2218765a0481cc6bab0901e551114b59eb3b76e8054a4522c578c43ae3c174037fb90224c60e0a1b50c81edc793797471df3f2682ffb05b2d6f
+  metadata.gz: f3b917af5bca36c7bc2adf5e2b81809d813fcf0d73126b4084ce4caaffa51b313c441f6c0c70eea41411af1228c45e83f6af24e254c4b7abf1268189d0b1f8dc
+  data.tar.gz: 76105c1d7c6a022d6e503cc17fc4261a0bb545d91890db2a67c4fcb5ae354ea45a326bdcdae4cb4990e0be6f5bb5e4f69da35ed175b76969f27ca73ce20315c5

data/documentation/docs/api/clock.md

@@ -105,6 +105,8 @@ alias: `fixed_time=`
 Makes `Date.now` and `new Date()` return fixed fake time at all times,
 keeps all the timers running.
 
+Use this method for simple scenarios where you only need to test with a predefined time. For more advanced scenarios, use [Clock#install](./clock#install) instead. Read docs on [clock emulation](https://playwright.dev/python/docs/clock) to learn more.
+
 **Usage**
 
 ```ruby
@@ -126,7 +128,7 @@ def set_system_time(time)
 alias: `system_time=`
 
 
-Sets current system time but does not trigger any timers.
+Sets system time, but does not trigger any timers. Use this to test how the web page reacts to a time shift, for example switching from summer to winter time, or changing time zones.
 
 **Usage**
 

data/documentation/docs/api/keyboard.md

@@ -34,9 +34,12 @@ page.keyboard.press("Shift+A")
 An example to trigger select-all with the keyboard
 
 ```ruby
-# on windows and linux
+# RECOMMENDED
+page.keyboard.press("ControlOrMeta+A")
+
+# or just on windows and linux
 page.keyboard.press("Control+A")
-# on mac_os
+# or just on macOS
 page.keyboard.press("Meta+A")
 ```
 

data/documentation/docs/api/locator.md

@@ -84,6 +84,49 @@ The following example finds a button with a specific title.
 button = page.get_by_role("button").and(page.get_by_title("Subscribe"))
 ```
 
+## aria_snapshot
+
+```
+def aria_snapshot(timeout: nil)
+```
+
+
+Captures the aria snapshot of the given element.
+Read more about [aria snapshots](https://playwright.dev/python/docs/aria-snapshots) and [LocatorAssertions#to_match_aria_snapshot](./locator_assertions#to_match_aria_snapshot) for the corresponding assertion.
+
+**Usage**
+
+```ruby
+page.get_by_role("link").aria_snapshot
+```
+
+**Details**
+
+This method captures the aria snapshot of the given element. The snapshot is a string that represents the state of the element and its children.
+The snapshot can be used to assert the state of the element in the test, or to compare it to state in the future.
+
+The ARIA snapshot is represented using [YAML](https://yaml.org/spec/1.2.2/) markup language:
+- The keys of the objects are the roles and optional accessible names of the elements.
+- The values are either text content or an array of child elements.
+- Generic static text can be represented with the `text` key.
+
+Below is the HTML markup and the respective ARIA snapshot:
+
+```html
+<ul aria-label="Links">
+  <li><a href="/">Home</a></li>
+  <li><a href="/about">About</a></li>
+<ul>
+```
+
+```yml
+- list "Links":
+  - listitem:
+    - link "Home"
+  - listitem:
+    - link "About"
+```
+
 ## blur
 
 ```

data/documentation/docs/api/locator_assertions.md

@@ -727,3 +727,22 @@ locator = page.locator("id=favorite-colors")
 locator.select_option(["R", "G"])
 expect(locator).to have_values([/R/, /G/])
 ```
+
+## to_match_aria_snapshot
+
+```ruby
+expect(locator).to match_aria_snapshot(expected, timeout: nil)
+```
+
+
+Asserts that the target element matches the given [accessibility snapshot](https://playwright.dev/python/docs/aria-snapshots).
+
+**Usage**
+
+```ruby
+page.goto('https://demo.playwright.dev/todomvc/')
+expect(page.locator('body')).to_match_aria_snapshot(<<~YAML)
+- heading "todos"
+- textbox "What needs to be done?"
+YAML
+```

data/documentation/docs/api/page.md

@@ -316,10 +316,9 @@ page.evaluate("matchMedia('print').matches") # => false
 ```
 
 ```ruby
-page.emulate_media(colorScheme="dark")
+page.emulate_media(colorScheme: "dark")
 page.evaluate("matchMedia('(prefers-color-scheme: dark)').matches") # => true
 page.evaluate("matchMedia('(prefers-color-scheme: light)').matches") # => false
-page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches") # => false
 ```
 
 ## eval_on_selector

data/documentation/docs/api/route.md

@@ -45,7 +45,7 @@ page.route("**/*", method(:handle))
 
 **Details**
 
-Note that any overrides such as `url` or `headers` only apply to the request being routed. If this request results in a redirect, overrides will not be applied to the new redirected request. If you want to propagate a header through redirects, use the combination of [Route#fetch](./route#fetch) and [Route#fulfill](./route#fulfill) instead.
+The `headers` option applies to both the routed request and any redirects it initiates. However, `url`, `method`, and `postData` only apply to the original request and are not carried over to redirected requests.
 
 [Route#continue](./route#continue) will immediately send the request to the network, other matching handlers won't be invoked. Use [Route#fallback](./route#fallback) If you want next matching handler in the chain to be invoked.
 

data/documentation/docs/api/tracing.md

@@ -68,6 +68,40 @@ page.goto("http://example.com")
 context.tracing.stop_chunk(path: "trace2.zip")
 ```
 
+## group
+
+```
+def group(name, location: nil)
+```
+
+
+**NOTE**: Use `test.step` instead when available.
+
+Creates a new group within the trace, assigning any subsequent API calls to this group, until [Tracing#group_end](./tracing#group_end) is called. Groups can be nested and will be visible in the trace viewer.
+
+**Usage**
+
+```ruby
+# All actions between group and group_end
+# will be shown in the trace viewer as a group.
+context.tracing.group("Open Playwright.dev > API")
+
+page = context.new_page
+page.goto("https://playwright.dev/")
+page.get_by_role("link", name: "API").click
+
+context.tracing.group_end
+```
+
+## group_end
+
+```
+def group_end
+```
+
+
+Closes the last group created by [Tracing#group](./tracing#group).
+
 ## stop
 
 ```

data/documentation/docs/include/api_coverage.md

@@ -436,6 +436,8 @@
 
 * start
 * start_chunk
+* group
+* group_end
 * stop
 * stop_chunk
 
@@ -445,6 +447,7 @@
 * all_inner_texts
 * all_text_contents
 * and
+* aria_snapshot
 * blur
 * bounding_box
 * check
@@ -596,6 +599,7 @@
 * to_have_text
 * to_have_value
 * to_have_values
+* to_match_aria_snapshot
 
 ## PageAssertions
 

data/lib/playwright/channel_owners/tracing.rb

@@ -92,5 +92,17 @@ module Playwright
     private def update_traces_dir(traces_dir)
       @traces_dir = traces_dir
     end
+
+    def group(name, location: nil)
+      params = {
+        name: name,
+        location: location,
+      }.compact
+      @channel.send_message_to_server('tracingGroup', params)
+    end
+
+    def group_end
+      @channel.send_message_to_server('tracingGroupEnd')
+    end
   end
 end

data/lib/playwright/locator_assertions_impl.rb

@@ -361,6 +361,18 @@ module Playwright
     end
     _define_negation :to_have_text
 
+    def to_match_aria_snapshot(expected, timeout: nil)
+      expect_impl(
+        'to.match.aria',
+        {
+          expectedValue: expected,
+          timeout: timeout,
+        },
+        expected,
+        'Locator expected to match Aria snapshot',
+      )
+    end
+
     def to_be_attached(attached: nil, timeout: nil)
       expect_impl(
         (attached || attached.nil?) ? "to.be.attached" : "to.be.detached",

data/lib/playwright/locator_impl.rb

@@ -391,6 +391,13 @@ module Playwright
       end
     end
 
+    def aria_snapshot(timeout: nil)
+      @frame.channel.send_message_to_server('ariaSnapshot', {
+        selector: @selector,
+        timeout: timeout,
+      }.compact)
+    end
+
     def scroll_into_view_if_needed(timeout: nil)
       with_element(timeout: timeout) do |handle, options|
         handle.scroll_into_view_if_needed(timeout: options[:timeout])

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.48.1'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.48.2'
+  VERSION = '1.49.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.49.0'
 end

data/lib/playwright_api/clock.rb

@@ -79,6 +79,8 @@ module Playwright
     # Makes `Date.now` and `new Date()` return fixed fake time at all times,
     # keeps all the timers running.
     #
+    # Use this method for simple scenarios where you only need to test with a predefined time. For more advanced scenarios, use [`method: Clock.install`] instead. Read docs on [clock emulation](../clock.md) to learn more.
+    #
     # **Usage**
     #
     # ```python sync
@@ -92,7 +94,7 @@ module Playwright
     alias_method :fixed_time=, :set_fixed_time
 
     #
-    # Sets current system time but does not trigger any timers.
+    # Sets system time, but does not trigger any timers. Use this to test how the web page reacts to a time shift, for example switching from summer to winter time, or changing time zones.
     #
     # **Usage**
     #

data/lib/playwright_api/keyboard.rb

@@ -30,10 +30,7 @@ module Playwright
   # An example to trigger select-all with the keyboard
   #
   # ```python sync
-  # # on windows and linux
-  # page.keyboard.press("Control+A")
-  # # on mac_os
-  # page.keyboard.press("Meta+A")
+  # page.keyboard.press("ControlOrMeta+A")
   # ```
   class Keyboard < PlaywrightApi
 

data/lib/playwright_api/locator.rb

@@ -67,6 +67,46 @@ module Playwright
       wrap_impl(@impl.and(unwrap_impl(locator)))
     end
 
+    #
+    # Captures the aria snapshot of the given element.
+    # Read more about [aria snapshots](../aria-snapshots.md) and [`method: LocatorAssertions.toMatchAriaSnapshot`] for the corresponding assertion.
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # page.get_by_role("link").aria_snapshot()
+    # ```
+    #
+    # **Details**
+    #
+    # This method captures the aria snapshot of the given element. The snapshot is a string that represents the state of the element and its children.
+    # The snapshot can be used to assert the state of the element in the test, or to compare it to state in the future.
+    #
+    # The ARIA snapshot is represented using [YAML](https://yaml.org/spec/1.2.2/) markup language:
+    # - The keys of the objects are the roles and optional accessible names of the elements.
+    # - The values are either text content or an array of child elements.
+    # - Generic static text can be represented with the `text` key.
+    #
+    # Below is the HTML markup and the respective ARIA snapshot:
+    #
+    # ```html
+    # <ul aria-label="Links">
+    #   <li><a href="/">Home</a></li>
+    #   <li><a href="/about">About</a></li>
+    # <ul>
+    # ```
+    #
+    # ```yml
+    # - list "Links":
+    #   - listitem:
+    #     - link "Home"
+    #   - listitem:
+    #     - link "About"
+    # ```
+    def aria_snapshot(timeout: nil)
+      wrap_impl(@impl.aria_snapshot(timeout: unwrap_impl(timeout)))
+    end
+
     #
     # Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/blur) on the element.
     def blur(timeout: nil)

data/lib/playwright_api/locator_assertions.rb

@@ -616,5 +616,21 @@ module Playwright
     def to_have_values(values, timeout: nil)
       wrap_impl(@impl.to_have_values(unwrap_impl(values), timeout: unwrap_impl(timeout)))
     end
+
+    #
+    # Asserts that the target element matches the given [accessibility snapshot](../aria-snapshots.md).
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # page.goto('https://demo.playwright.dev/todomvc/')
+    # expect(page.locator('body')).to_match_aria_snapshot('''
+    #   - heading "todos"
+    #   - textbox "What needs to be done?"
+    # ''')
+    # ```
+    def to_match_aria_snapshot(expected, timeout: nil)
+      wrap_impl(@impl.to_match_aria_snapshot(unwrap_impl(expected), timeout: unwrap_impl(timeout)))
+    end
   end
 end

data/lib/playwright_api/page.rb

@@ -315,7 +315,6 @@ module Playwright
     # # → True
     # page.evaluate("matchMedia('(prefers-color-scheme: light)').matches")
     # # → False
-    # page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches")
     # ```
     def emulate_media(colorScheme: nil, forcedColors: nil, media: nil, reducedMotion: nil)
       wrap_impl(@impl.emulate_media(colorScheme: unwrap_impl(colorScheme), forcedColors: unwrap_impl(forcedColors), media: unwrap_impl(media), reducedMotion: unwrap_impl(reducedMotion)))

data/lib/playwright_api/route.rb

@@ -32,7 +32,7 @@ module Playwright
     #
     # **Details**
     #
-    # Note that any overrides such as `url` or `headers` only apply to the request being routed. If this request results in a redirect, overrides will not be applied to the new redirected request. If you want to propagate a header through redirects, use the combination of [`method: Route.fetch`] and [`method: Route.fulfill`] instead.
+    # The `headers` option applies to both the routed request and any redirects it initiates. However, `url`, `method`, and `postData` only apply to the original request and are not carried over to redirected requests.
     #
     # [`method: Route.continue`] will immediately send the request to the network, other matching handlers won't be invoked. Use [`method: Route.fallback`] If you want next matching handler in the chain to be invoked.
     def continue(headers: nil, method: nil, postData: nil, url: nil)

data/lib/playwright_api/tracing.rb

@@ -58,6 +58,31 @@ module Playwright
       wrap_impl(@impl.start_chunk(name: unwrap_impl(name), title: unwrap_impl(title)))
     end
 
+    #
+    # **NOTE**: Use `test.step` instead when available.
+    #
+    # Creates a new group within the trace, assigning any subsequent API calls to this group, until [`method: Tracing.groupEnd`] is called. Groups can be nested and will be visible in the trace viewer.
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # # All actions between group and group_end
+    # # will be shown in the trace viewer as a group.
+    # page.context.tracing.group("Open Playwright.dev > API")
+    # page.goto("https://playwright.dev/")
+    # page.get_by_role("link", name="API").click()
+    # page.context.tracing.group_end()
+    # ```
+    def group(name, location: nil)
+      wrap_impl(@impl.group(unwrap_impl(name), location: unwrap_impl(location)))
+    end
+
+    #
+    # Closes the last group created by [`method: Tracing.group`].
+    def group_end
+      wrap_impl(@impl.group_end)
+    end
+
     #
     # Stop tracing.
     def stop(path: nil)

data/lib/playwright_api/worker.rb

@@ -47,13 +47,13 @@ module Playwright
     end
 
     # @nodoc
-    def page=(req)
-      wrap_impl(@impl.page=(unwrap_impl(req)))
+    def context=(req)
+      wrap_impl(@impl.context=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def context=(req)
-      wrap_impl(@impl.context=(unwrap_impl(req)))
+    def page=(req)
+      wrap_impl(@impl.page=(unwrap_impl(req)))
     end
 
     # -- inherited from EventEmitter --

data/sig/playwright.rbs

@@ -445,6 +445,8 @@ module Playwright
   class Tracing
     def start: (?name: String, ?screenshots: bool, ?snapshots: bool, ?sources: bool, ?title: String) -> void
     def start_chunk: (?name: String, ?title: String) -> void
+    def group: (String name, ?location: Hash[untyped, untyped]) -> void
+    def group_end: -> void
     def stop: (?path: (String | File)) -> void
     def stop_chunk: (?path: (String | File)) -> void
   end
@@ -454,6 +456,7 @@ module Playwright
     def all_inner_texts: -> Array[untyped]
     def all_text_contents: -> Array[untyped]
     def and: (Locator locator) -> Locator
+    def aria_snapshot: (?timeout: Float) -> String
     def blur: (?timeout: Float) -> void
     def bounding_box: (?timeout: Float) -> (nil | Hash[untyped, untyped])
     def check: (?force: bool, ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
@@ -603,6 +606,7 @@ module Playwright
     def to_have_text: ((String | Regexp | Array[untyped] | Array[untyped] | Array[untyped]) expected, ?ignoreCase: bool, ?timeout: Float, ?useInnerText: bool) -> void
     def to_have_value: ((String | Regexp) value, ?timeout: Float) -> void
     def to_have_values: ((Array[untyped] | Array[untyped] | Array[untyped]) values, ?timeout: Float) -> void
+    def to_match_aria_snapshot: (String expected, ?timeout: Float) -> void
   end
 
   class PageAssertions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.48.1
+  version: 1.49.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-30 00:00:00.000000000 Z
+date: 2024-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -413,5 +413,5 @@ requirements: []
 rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.48.2
+summary: The Ruby binding of playwright driver 1.49.0
 test_files: []