playwright-ruby-client 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e2dee736be02c56e75b6a89e2eab014c4d205ca23688b30084ea3854f50dfda
-  data.tar.gz: a213f955daad15c58bc1edd1b123cb6768cbc6df5ec6be0b09e537a8b6ea22ec
+  metadata.gz: 82040f41eb8c972a8e3415aac148c27218e9fcbb00d7e09832bd75da506d2367
+  data.tar.gz: a42be0ab4e00bb0ef36516474cca8220147d8c635e44c581c799ee65e396721f
 SHA512:
-  metadata.gz: eba2fed3585b9ef5aa1b068cfc3294acc0f134e1ecccec6fae465bfd8df52c2395d02d706cb8958342c8e1af8be2066b537bc7af9eb3da1fe3748536677ba0c0
-  data.tar.gz: 2264ea9fd32bd7b02e15453a17876c2ee5fa8d51fb5eca652242959254ead0fda4ee721e9c35a1a24c1dc005d42268fd49b4566bd844841499bb8933ba83b8a3
+  metadata.gz: 615d15f014ca5f175d9da7504583693903d0ebd4c3d47522bf2f5c0add5aa01f26551300834b86cd944a2eacb2ef38062c341ec14f1177b7f517a16dab6e90fe
+  data.tar.gz: 97de038214b07abfbeb9eece923c0b031793b8939107df5f7b37268dbb4598c188dc88c4870766cf31d0bf28416610f46c996518a2f37fc8c73d5b672f713005

data/documentation/docs/api/element_handle.md

@@ -330,7 +330,10 @@ Returns the `element.innerText`.
 def input_value(timeout: nil)
 ```
 
-Returns `input.value` for `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -446,11 +449,15 @@ def screenshot(
       type: nil)
 ```
 
-Returns the buffer with the captured screenshot.
+This method captures a screenshot of the page, clipped to the size and position of this particular element. If the
+element is covered by other elements, it will not be actually visible on the screenshot. If the element is a scrollable
+container, only the currently scrolled content will be visible on the screenshot.
 
 This method waits for the [actionability](https://playwright.dev/python/docs/actionability) checks, then scrolls element into view before taking a
 screenshot. If the element is detached from DOM, the method throws an error.
 
+Returns the buffer with the captured screenshot.
+
 ## scroll_into_view_if_needed
 
 ```
@@ -513,6 +520,10 @@ def select_text(force: nil, timeout: nil)
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text
 content.
 
+If the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), focuses and selects text in the
+control instead.
+
 ## set_checked
 
 ```
@@ -546,11 +557,13 @@ def set_input_files(files, noWaitAfter: nil, timeout: nil)
 ```
 alias: `input_files=`
 
-This method expects `elementHandle` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects [ElementHandle](./element_handle) to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## tap_point
 

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

@@ -33,7 +33,7 @@ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
 ## devices
 
 ```
-def devices(omitDriverInstall: nil, port: nil)
+def devices(host: nil, omitDriverInstall: nil, port: nil)
 ```
 
 Returns the list of detected Android devices.

data/documentation/docs/api/file_chooser.md

@@ -47,4 +47,4 @@ def set_files(files, noWaitAfter: nil, timeout: nil)
 alias: `files=`
 
 Sets the value of the file input this chooser is associated with. If some of the `filePaths` are relative paths, then
-they are resolved relative to the the current working directory. For empty array, clears the selected files.
+they are resolved relative to the current working directory. For empty array, clears the selected files.

data/documentation/docs/api/frame.md

@@ -486,7 +486,10 @@ Returns `element.innerText`.
 def input_value(selector, strict: nil, timeout: nil)
 ```
 
-Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -556,6 +559,8 @@ The method returns an element locator that can be used to perform actions in the
 element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
 different DOM elements. That would happen if the DOM structure between those actions has changed.
 
+[Learn more about locators](https://playwright.dev/python/docs/locators).
+
 ## name
 
 ```
@@ -724,11 +729,13 @@ def set_input_files(
       timeout: nil)
 ```
 
-This method expects `selector` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects `selector` to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## tap_point
 

data/documentation/docs/api/locator.md

@@ -285,6 +285,14 @@ instead.
 
 To send fine-grained keyboard events, use [Locator#type](./locator#type).
 
+## filter
+
+```
+def filter(has: nil, hasText: nil)
+```
+
+This method narrows existing locator according to the options, for example filters by text.
+
 ## first
 
 ```
@@ -378,7 +386,10 @@ Returns the `element.innerText`.
 def input_value(timeout: nil)
 ```
 
-Returns `input.value` for `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -442,7 +453,8 @@ Returns locator to the last matching element.
 def locator(selector, has: nil, hasText: nil)
 ```
 
-The method finds an element matching the specified selector in the [Locator](./locator)'s subtree.
+The method finds an element matching the specified selector in the [Locator](./locator)'s subtree. It also accepts filter options,
+similar to [Locator#filter](./locator#filter) method.
 
 ## nth
 
@@ -500,11 +512,15 @@ def screenshot(
       type: nil)
 ```
 
-Returns the buffer with the captured screenshot.
+This method captures a screenshot of the page, clipped to the size and position of a particular element matching the
+locator. If the element is covered by other elements, it will not be actually visible on the screenshot. If the element
+is a scrollable container, only the currently scrolled content will be visible on the screenshot.
 
 This method waits for the [actionability](https://playwright.dev/python/docs/actionability) checks, then scrolls element into view before taking a
 screenshot. If the element is detached from DOM, the method throws an error.
 
+Returns the buffer with the captured screenshot.
+
 ## scroll_into_view_if_needed
 
 ```
@@ -564,6 +580,10 @@ def select_text(force: nil, timeout: nil)
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text
 content.
 
+If the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), focuses and selects text in the
+control instead.
+
 ## set_checked
 
 ```
@@ -597,11 +617,13 @@ def set_input_files(files, noWaitAfter: nil, timeout: nil)
 ```
 alias: `input_files=`
 
-This method expects `element` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects [Locator](./locator) to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## tap_point
 

data/documentation/docs/api/page.md

@@ -642,8 +642,8 @@ Navigate to the next page in history.
 def goto(url, referer: nil, 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.
+Returns the main resource response. In case of multiple redirects, the navigation will resolve with the first
+non-redirect response.
 
 The method will throw an error if:
 - there's an SSL error (e.g. in case of self-signed certificates).
@@ -711,7 +711,10 @@ Returns `element.innerText`.
 def input_value(selector, strict: nil, timeout: nil)
 ```
 
-Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
+
+Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
 
 ## checked?
 
@@ -781,6 +784,8 @@ The method returns an element locator that can be used to perform actions on the
 element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
 different DOM elements. That would happen if the DOM structure between those actions has changed.
 
+[Learn more about locators](https://playwright.dev/python/docs/locators).
+
 Shortcut for main frame's [Frame#locator](./frame#locator).
 
 ## main_frame
@@ -1155,11 +1160,13 @@ def set_input_files(
       timeout: nil)
 ```
 
-This method expects `selector` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
-
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
-are resolved relative to the the current working directory. For empty array, clears the selected files.
+are resolved relative to the current working directory. For empty array, clears the selected files.
+
+This method expects `selector` to point to an
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
+`<label>` element that has an associated
+[control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
 
 ## set_viewport_size
 

data/documentation/docs/api/route.md

@@ -7,6 +7,8 @@ sidebar_position: 10
 Whenever a network route is set up with [Page#route](./page#route) or [BrowserContext#route](./browser_context#route), the [Route](./route) object
 allows to handle the route.
 
+Learn more about [networking](https://playwright.dev/python/docs/network).
+
 ## abort
 
 ```

data/documentation/docs/include/api_coverage.md

@@ -413,6 +413,7 @@
 * evaluate_all
 * evaluate_handle
 * fill
+* filter
 * first
 * focus
 * frame_locator

data/lib/playwright/javascript/value_parser.rb

@@ -5,6 +5,7 @@ module Playwright
     class ValueParser
       def initialize(hash)
         @hash = hash
+        @refs = {}
       end
 
       # @return [Hash]
@@ -23,6 +24,10 @@ module Playwright
           return hash[key] if hash.key?(key)
         end
 
+        if hash.key?('ref')
+          return @refs[hash['ref']]
+        end
+
         if hash.key?('v')
           return case hash['v']
                  when 'undefined'
@@ -55,11 +60,21 @@ module Playwright
         end
 
         if hash.key?('a')
-          return hash['a'].map { |value| parse_hash(value) }
+          result = []
+          if hash['id']
+            @refs[hash['id']] = result
+          end
+          hash['a'].each { |value| result << parse_hash(value) }
+          return result
         end
 
         if hash.key?('o')
-          return hash['o'].map { |obj| [obj['k'], parse_hash(obj['v'])] }.to_h
+          result = {}
+          if hash['id']
+            @refs[hash['id']] = result
+          end
+          hash['o'].each { |obj| result[obj['k']] = parse_hash(obj['v']) }
+          return result
         end
 
         if hash.key?('h')

data/lib/playwright/javascript/value_serializer.rb

@@ -1,8 +1,11 @@
+require_relative './visitor_info'
+
 module Playwright
   module JavaScript
     class ValueSerializer
       def initialize(ruby_value)
         @value = ruby_value
+        @visited = VisitorInfo.new
       end
 
       # @return [Hash]
@@ -41,10 +44,18 @@ module Playwright
           flags << 'ms' if (value.options & Regexp::MULTILINE) != 0
           flags << 'i' if (value.options & Regexp::IGNORECASE) != 0
           { r: { p: value.source, f: flags.join('') } }
+        when -> (value) { @visited.ref(value) }
+          { ref: @visited.ref(value) }
         when Array
-          { a: value.map { |v| serialize_value(v) } }
+          id = @visited.log(value)
+          result = []
+          value.each { |v| result << serialize_value(v) }
+          { a: result, id: id }
         when Hash
-          { o: value.map { |key, v| { k: key, v: serialize_value(v) } } }
+          id = @visited.log(value)
+          result = []
+          value.each { |key, v| result << { k: key, v: serialize_value(v) } }
+          { o: result, id: id }
         else
           raise ArgumentError.new("Unexpected value: #{value}")
         end

data/lib/playwright/javascript/visitor_info.rb

@@ -0,0 +1,26 @@
+module Playwright
+  module JavaScript
+    class VisitorInfo
+      def initialize
+        @data = {}
+        @last_id = 0
+      end
+
+      # returns [Integer|nil]
+      def ref(object)
+        @data[object]
+      end
+
+      def log(object)
+        if @data[object]
+          raise ArgumentError.new("Already visited")
+        end
+
+        id = @last_id + 1
+        @last_id = id # FIXME: should thread-safe
+
+        @data[object] = id
+      end
+    end
+  end
+end

data/lib/playwright/locator_impl.rb

@@ -239,6 +239,16 @@ module Playwright
       @frame.query_selector_all(@selector)
     end
 
+    def filter(has: nil, hasText: nil)
+      LocatorImpl.new(
+        frame: @frame,
+        timeout_settings: @timeout_settings,
+        selector: @selector,
+        hasText: hasText,
+        has: has,
+      )
+    end
+
     def first
       LocatorImpl.new(
         frame: @frame,

data/lib/playwright/playwright_api.rb

@@ -122,21 +122,41 @@ module Playwright
       }
     end
 
-    private def wrap_impl(object)
+    private def wrap_impl(object, visited: {})
       if object.is_a?(Array)
-        object.map { |obj| wrap_impl(obj) }
+        unless visited[object]
+          visited[object] = []
+          object.each { |obj| visited[object] << wrap_impl(obj) }
+        end
+        visited[object]
       elsif object.is_a?(Hash)
-        object.map { |key, obj| [key, wrap_impl(obj)] }.to_h
+        unless visited[object]
+          visited[object] = {}
+          object.each do |key, obj|
+            visited[object][key] = wrap_impl(obj, visited: visited)
+          end
+        end
+        visited[object]
       else
         ::Playwright::PlaywrightApi.wrap(object)
       end
     end
 
-    private def unwrap_impl(object)
+    private def unwrap_impl(object, visited: {})
       if object.is_a?(Array)
-        object.map { |obj| unwrap_impl(obj) }
+        unless visited[object]
+          visited[object] = []
+          object.each { |obj| visited[object] << unwrap_impl(obj) }
+        end
+        visited[object]
       elsif object.is_a?(Hash)
-        object.map { |key, obj| [key, unwrap_impl(obj)] }.to_h
+        unless visited[object]
+          visited[object] = {}
+          object.each do |key, obj|
+            visited[object][key] = unwrap_impl(obj, visited: visited)
+          end
+        end
+        visited[object]
       elsif object.is_a?(PlaywrightApi)
         ::Playwright::PlaywrightApi.unwrap(object)
       else

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.21.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.21.1'
+  VERSION = '1.22.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.22.1'
 end

data/lib/playwright_api/android.rb

@@ -26,8 +26,8 @@ module Playwright
   class Android < PlaywrightApi
 
     # Returns the list of detected Android devices.
-    def devices(omitDriverInstall: nil, port: nil)
-      wrap_impl(@impl.devices(omitDriverInstall: unwrap_impl(omitDriverInstall), port: unwrap_impl(port)))
+    def devices(host: nil, omitDriverInstall: nil, port: nil)
+      wrap_impl(@impl.devices(host: unwrap_impl(host), omitDriverInstall: unwrap_impl(omitDriverInstall), port: unwrap_impl(port)))
     end
 
     # This setting will change the default maximum time for all the methods accepting `timeout` option.
@@ -38,20 +38,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/android_device.rb

@@ -171,20 +171,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/api_request_context.rb

@@ -186,20 +186,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/browser.rb

@@ -168,20 +168,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_context.rb

@@ -372,13 +372,13 @@ module Playwright
     end
 
     # @nodoc
-    def pause
-      wrap_impl(@impl.pause)
+    def options=(req)
+      wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def options=(req)
-      wrap_impl(@impl.options=(unwrap_impl(req)))
+    def pause
+      wrap_impl(@impl.pause)
     end
 
     # @nodoc
@@ -398,20 +398,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_type.rb

@@ -148,20 +148,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy