playwright-ruby-client 1.27.0 → 1.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9944a15cd23ff09a56c09f396ff276ec366670740f4c79cb553a9dedec346ff8
-  data.tar.gz: 33807cddbf67539e40d8659fd565827a1c0127ccc65c7b6a2864b8e80184053b
+  metadata.gz: f6b579547c4cff2fbaf98b5c2796c8689f655f316b391b7127891fd03212cea4
+  data.tar.gz: c32a3787fa3f6c2e874844f94deef249c335cee4f6efcc8d23e8045bfd6346f1
 SHA512:
-  metadata.gz: ece68b2c84a789d011b00dd17f27a280e26b23349cc474ec04ca00eab18df2a813a1ebda61143603de02f3abec0fc988818122a09a35d57aa101fbb5429c2beb
-  data.tar.gz: 5070dd01c89f50580c98e196e1d97b5ffcc34ab1fc7856ac9943a6bfc4743e418cac2b3632566a88c24f99ed7fad1c0c3f1c7f66f873a76c02b993eb0baf74bc
+  metadata.gz: 7481f324212879e913399614beab51affce2c8dc05040ac0d506d9b583fcf48c897bd1a1f3b7f332212497db2000e538a1cf1fd19c60d5ddf7c884e2e366d687
+  data.tar.gz: 58eb07d5abb6307bd15464b6f33d8c0d0cc4110cf80c26915cecc00be911fba8e6240687cb46698c81fda29651718b4039f8ca1530661e5ccd4a7d1632bd6ef3

data/documentation/docs/api/element_handle.md

@@ -292,6 +292,7 @@ Returns element attribute value.
 def hover(
       force: nil,
       modifiers: nil,
+      noWaitAfter: nil,
       position: nil,
       timeout: nil,
       trial: nil)

data/documentation/docs/api/frame.md

@@ -435,7 +435,7 @@ def get_by_label(text, exact: nil)
 ```
 
 Allows locating input elements by the text of the associated label. For example, this method will find the input by
-label text Password in the following DOM:
+label text "Password" in the following DOM:
 
 ```html
 <label for="password-input">Password:</label>
@@ -464,6 +464,7 @@ def get_by_role(
       role,
       checked: nil,
       disabled: nil,
+      exact: nil,
       expanded: nil,
       includeHidden: nil,
       level: nil,
@@ -491,13 +492,59 @@ def get_by_test_id(testId)
 Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
 [Selectors#set_test_id_attribute](./selectors#set_test_id_attribute) to configure a different test id attribute if necessary.
 
+
+
 ## get_by_text
 
 ```
 def get_by_text(text, exact: nil)
 ```
 
-Allows locating elements that contain given text.
+Allows locating elements that contain given text. Consider the following DOM structure:
+
+```html
+<div>Hello <span>world</span></div>
+<div>Hello</div>
+```
+
+You can locate by text substring, exact string, or a regular expression:
+
+```ruby
+page.content = <<~HTML
+  <div>Hello <span>world</span></div>
+  <div>Hello</div>
+HTML
+
+# Matches <span>
+locator = page.get_by_text("world")
+expect(locator.evaluate('e => e.outerHTML')).to eq('<span>world</span>')
+
+# Matches first <div>
+locator = page.get_by_text("Hello world")
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello <span>world</span></div>')
+
+# Matches second <div>
+locator = page.get_by_text("Hello", exact: true)
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+
+# Matches both <div>s
+locator = page.get_by_text(/Hello/)
+expect(locator.count).to eq(2)
+expect(locator.first.evaluate('e => e.outerHTML')).to eq('<div>Hello <span>world</span></div>')
+expect(locator.last.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+
+# Matches second <div>
+locator = page.get_by_text(/^hello$/i)
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+```
+
+See also [Locator#filter](./locator#filter) that allows to match by another criteria, like an accessible role, and then filter
+by the text content.
+
+> NOTE: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
+one, turns line breaks into spaces and ignores leading and trailing whitespace.
+> NOTE: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
+example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
 
 ## get_by_title
 
@@ -505,7 +552,7 @@ Allows locating elements that contain given text.
 def get_by_title(text, exact: nil)
 ```
 
-Allows locating elements by their title. For example, this method will find the button by its title "Submit":
+Allows locating elements by their title. For example, this method will find the button by its title "Place the order":
 
 ```html
 <button title='Place the order'>Order Now</button>
@@ -544,6 +591,7 @@ def hover(
       selector,
       force: nil,
       modifiers: nil,
+      noWaitAfter: nil,
       position: nil,
       strict: nil,
       timeout: nil,

data/documentation/docs/api/frame_locator.md

@@ -74,7 +74,7 @@ def get_by_label(text, exact: nil)
 ```
 
 Allows locating input elements by the text of the associated label. For example, this method will find the input by
-label text Password in the following DOM:
+label text "Password" in the following DOM:
 
 ```html
 <label for="password-input">Password:</label>
@@ -103,6 +103,7 @@ def get_by_role(
       role,
       checked: nil,
       disabled: nil,
+      exact: nil,
       expanded: nil,
       includeHidden: nil,
       level: nil,
@@ -130,13 +131,59 @@ def get_by_test_id(testId)
 Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
 [Selectors#set_test_id_attribute](./selectors#set_test_id_attribute) to configure a different test id attribute if necessary.
 
+
+
 ## get_by_text
 
 ```
 def get_by_text(text, exact: nil)
 ```
 
-Allows locating elements that contain given text.
+Allows locating elements that contain given text. Consider the following DOM structure:
+
+```html
+<div>Hello <span>world</span></div>
+<div>Hello</div>
+```
+
+You can locate by text substring, exact string, or a regular expression:
+
+```ruby
+page.content = <<~HTML
+  <div>Hello <span>world</span></div>
+  <div>Hello</div>
+HTML
+
+# Matches <span>
+locator = page.get_by_text("world")
+expect(locator.evaluate('e => e.outerHTML')).to eq('<span>world</span>')
+
+# Matches first <div>
+locator = page.get_by_text("Hello world")
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello <span>world</span></div>')
+
+# Matches second <div>
+locator = page.get_by_text("Hello", exact: true)
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+
+# Matches both <div>s
+locator = page.get_by_text(/Hello/)
+expect(locator.count).to eq(2)
+expect(locator.first.evaluate('e => e.outerHTML')).to eq('<div>Hello <span>world</span></div>')
+expect(locator.last.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+
+# Matches second <div>
+locator = page.get_by_text(/^hello$/i)
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+```
+
+See also [Locator#filter](./locator#filter) that allows to match by another criteria, like an accessible role, and then filter
+by the text content.
+
+> NOTE: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
+one, turns line breaks into spaces and ignores leading and trailing whitespace.
+> NOTE: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
+example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
 
 ## get_by_title
 
@@ -144,7 +191,7 @@ Allows locating elements that contain given text.
 def get_by_title(text, exact: nil)
 ```
 
-Allows locating elements by their title. For example, this method will find the button by its title "Submit":
+Allows locating elements by their title. For example, this method will find the button by its title "Place the order":
 
 ```html
 <button title='Place the order'>Order Now</button>

data/documentation/docs/api/js_handle.md

@@ -85,10 +85,12 @@ The method returns a map with **own property names** as keys and JSHandle instan
 
 ```ruby
 page.goto('https://example.com/')
-window_handle = page.evaluate_handle("window")
-properties = window_handle.properties
+handle = page.evaluate_handle("({window, document})")
+properties = handle.properties
 puts properties
-window_handle.dispose
+window_handle = properties["window"]
+document_handle = properties["document"]
+handle.dispose
 ```
 
 

data/documentation/docs/api/keyboard.md

@@ -5,7 +5,7 @@ sidebar_position: 10
 # Keyboard
 
 Keyboard provides an api for managing a virtual keyboard. The high level api is [Keyboard#type](./keyboard#type), which takes
-raw characters and generates proper keydown, keypress/input, and keyup events on your page.
+raw characters and generates proper `keydown`, `keypress`/`input`, and `keyup` events on your page.
 
 For finer control, you can use [Keyboard#down](./keyboard#down), [Keyboard#up](./keyboard#up), and [Keyboard#insert_text](./keyboard#insert_text)
 to manually fire events as if they were generated from a real keyboard.

data/documentation/docs/api/locator.md

@@ -25,6 +25,14 @@ def all_text_contents
 
 Returns an array of `node.textContent` values for all matching nodes.
 
+## blur
+
+```
+def blur(timeout: nil)
+```
+
+Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/blur) on the element.
+
 ## bounding_box
 
 ```
@@ -79,6 +87,20 @@ 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.
 
+## clear
+
+```
+def clear(force: nil, noWaitAfter: nil, timeout: nil)
+```
+
+This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the element, clears it and triggers an
+`input` event after clearing.
+
+If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an error.
+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), the control will be cleared
+instead.
+
 ## click
 
 ```
@@ -382,7 +404,7 @@ def get_by_label(text, exact: nil)
 ```
 
 Allows locating input elements by the text of the associated label. For example, this method will find the input by
-label text Password in the following DOM:
+label text "Password" in the following DOM:
 
 ```html
 <label for="password-input">Password:</label>
@@ -411,6 +433,7 @@ def get_by_role(
       role,
       checked: nil,
       disabled: nil,
+      exact: nil,
       expanded: nil,
       includeHidden: nil,
       level: nil,
@@ -438,13 +461,59 @@ def get_by_test_id(testId)
 Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
 [Selectors#set_test_id_attribute](./selectors#set_test_id_attribute) to configure a different test id attribute if necessary.
 
+
+
 ## get_by_text
 
 ```
 def get_by_text(text, exact: nil)
 ```
 
-Allows locating elements that contain given text.
+Allows locating elements that contain given text. Consider the following DOM structure:
+
+```html
+<div>Hello <span>world</span></div>
+<div>Hello</div>
+```
+
+You can locate by text substring, exact string, or a regular expression:
+
+```ruby
+page.content = <<~HTML
+  <div>Hello <span>world</span></div>
+  <div>Hello</div>
+HTML
+
+# Matches <span>
+locator = page.get_by_text("world")
+expect(locator.evaluate('e => e.outerHTML')).to eq('<span>world</span>')
+
+# Matches first <div>
+locator = page.get_by_text("Hello world")
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello <span>world</span></div>')
+
+# Matches second <div>
+locator = page.get_by_text("Hello", exact: true)
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+
+# Matches both <div>s
+locator = page.get_by_text(/Hello/)
+expect(locator.count).to eq(2)
+expect(locator.first.evaluate('e => e.outerHTML')).to eq('<div>Hello <span>world</span></div>')
+expect(locator.last.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+
+# Matches second <div>
+locator = page.get_by_text(/^hello$/i)
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+```
+
+See also [Locator#filter](./locator#filter) that allows to match by another criteria, like an accessible role, and then filter
+by the text content.
+
+> NOTE: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
+one, turns line breaks into spaces and ignores leading and trailing whitespace.
+> NOTE: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
+example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
 
 ## get_by_title
 
@@ -452,7 +521,7 @@ Allows locating elements that contain given text.
 def get_by_title(text, exact: nil)
 ```
 
-Allows locating elements by their title. For example, this method will find the button by its title "Submit":
+Allows locating elements by their title. For example, this method will find the button by its title "Place the order":
 
 ```html
 <button title='Place the order'>Order Now</button>
@@ -474,6 +543,7 @@ Highlight the corresponding element(s) on the screen. Useful for debugging, don'
 def hover(
       force: nil,
       modifiers: nil,
+      noWaitAfter: nil,
       position: nil,
       timeout: nil,
       trial: nil)

data/documentation/docs/api/page.md

@@ -648,7 +648,7 @@ def get_by_label(text, exact: nil)
 ```
 
 Allows locating input elements by the text of the associated label. For example, this method will find the input by
-label text Password in the following DOM:
+label text "Password" in the following DOM:
 
 ```html
 <label for="password-input">Password:</label>
@@ -677,6 +677,7 @@ def get_by_role(
       role,
       checked: nil,
       disabled: nil,
+      exact: nil,
       expanded: nil,
       includeHidden: nil,
       level: nil,
@@ -704,13 +705,59 @@ def get_by_test_id(testId)
 Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
 [Selectors#set_test_id_attribute](./selectors#set_test_id_attribute) to configure a different test id attribute if necessary.
 
+
+
 ## get_by_text
 
 ```
 def get_by_text(text, exact: nil)
 ```
 
-Allows locating elements that contain given text.
+Allows locating elements that contain given text. Consider the following DOM structure:
+
+```html
+<div>Hello <span>world</span></div>
+<div>Hello</div>
+```
+
+You can locate by text substring, exact string, or a regular expression:
+
+```ruby
+page.content = <<~HTML
+  <div>Hello <span>world</span></div>
+  <div>Hello</div>
+HTML
+
+# Matches <span>
+locator = page.get_by_text("world")
+expect(locator.evaluate('e => e.outerHTML')).to eq('<span>world</span>')
+
+# Matches first <div>
+locator = page.get_by_text("Hello world")
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello <span>world</span></div>')
+
+# Matches second <div>
+locator = page.get_by_text("Hello", exact: true)
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+
+# Matches both <div>s
+locator = page.get_by_text(/Hello/)
+expect(locator.count).to eq(2)
+expect(locator.first.evaluate('e => e.outerHTML')).to eq('<div>Hello <span>world</span></div>')
+expect(locator.last.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+
+# Matches second <div>
+locator = page.get_by_text(/^hello$/i)
+expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
+```
+
+See also [Locator#filter](./locator#filter) that allows to match by another criteria, like an accessible role, and then filter
+by the text content.
+
+> NOTE: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
+one, turns line breaks into spaces and ignores leading and trailing whitespace.
+> NOTE: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
+example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
 
 ## get_by_title
 
@@ -718,7 +765,7 @@ Allows locating elements that contain given text.
 def get_by_title(text, exact: nil)
 ```
 
-Allows locating elements by their title. For example, this method will find the button by its title "Submit":
+Allows locating elements by their title. For example, this method will find the button by its title "Place the order":
 
 ```html
 <button title='Place the order'>Order Now</button>
@@ -781,6 +828,7 @@ def hover(
       selector,
       force: nil,
       modifiers: nil,
+      noWaitAfter: nil,
       position: nil,
       strict: nil,
       timeout: nil,

data/documentation/docs/api/request.md

@@ -15,7 +15,7 @@ the  [`event: Page.requestFailed`] event is emitted.
 > NOTE: HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will
 complete with `'requestfinished'` event.
 
-If request gets a 'redirect' response, the request is successfully finished with the 'requestfinished' event, and a new
+If request gets a 'redirect' response, the request is successfully finished with the `requestfinished` event, and a new
 request is  issued to a redirected url.
 
 ## all_headers

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

@@ -95,6 +95,7 @@ These parameters can be passed into `Capybara::Playwright::Driver.new`
   * record_video_dir
   * record_video_size
   * screen
+  * serviceWorkers
   * storageState
   * timezoneId
   * userAgent

data/documentation/docs/include/api_coverage.md

@@ -420,8 +420,10 @@
 
 * all_inner_texts
 * all_text_contents
+* blur
 * bounding_box
 * check
+* clear
 * click
 * count
 * dblclick
@@ -519,6 +521,7 @@
 
 ## Android
 
+* ~~connect~~
 * devices
 * ~~set_default_timeout~~
 

data/lib/playwright/channel_owner.rb

@@ -36,6 +36,7 @@ module Playwright
       @type = type
       @guid = guid
       @initializer = initializer
+      @event_to_subscription_mapping = {}
 
       after_initialize
     end
@@ -59,6 +60,46 @@ module Playwright
       @objects.clear
     end
 
+    private def set_event_to_subscription_mapping(event_to_subscription_mapping)
+      @event_to_subscription_mapping = event_to_subscription_mapping
+    end
+
+    private def update_subscription(event, enabled)
+      protocol_event = @event_to_subscription_mapping[event]
+      if protocol_event
+        payload = {
+          event: protocol_event,
+          enabled: enabled,
+        }
+        @channel.async_send_message_to_server('updateSubscription', payload)
+      end
+    end
+
+    # @override
+    def on(event, callback)
+      if listener_count(event) == 0
+        update_subscription(event, true)
+      end
+      super
+    end
+
+    # @override
+    def once(event, callback)
+      if listener_count(event) == 0
+        update_subscription(event, true)
+      end
+      super
+    end
+
+    # @override
+    def off(event, callback)
+      super
+      if listener_count(event) == 0
+        update_subscription(event, false)
+      end
+    end
+
+
     # Suppress long long inspect log and avoid RSpec from hanging up...
     def inspect
       to_s

data/lib/playwright/channel_owners/android.rb

@@ -4,8 +4,8 @@ module Playwright
       @timeout_settings = TimeoutSettings.new
     end
 
-    def devices(port: nil)
-      params = { port: port }.compact
+    def devices(host: nil, omitDriverInstall: nil, port: nil)
+      params = { host: host, port: port, omitDriverInstall: omitDriverInstall }.compact
       resp = @channel.send_message_to_server('devices', params)
       resp.map { |device| ChannelOwners::AndroidDevice.from(device) }
     end

data/lib/playwright/channel_owners/android_device.rb

@@ -4,6 +4,11 @@ module Playwright
 
     private def after_initialize
       @input = AndroidInputImpl.new(@channel)
+      @should_close_connection_on_close = false
+    end
+
+    def should_close_connection_on_close!
+      @should_close_connection_on_close = true
     end
 
     attr_reader :input
@@ -77,8 +82,12 @@ module Playwright
     end
 
     def close
-      @channel.send_message_to_server('close')
       emit(Events::AndroidDevice::Close)
+      if @should_close_connection_on_close
+        @connection.stop
+      else
+        @channel.send_message_to_server('close')
+      end
     end
 
     def shell(command)
@@ -86,60 +95,10 @@ module Playwright
       Base64.strict_decode64(resp)
     end
 
-    def launch_browser(
-          pkg: nil,
-          acceptDownloads: nil,
-          bypassCSP: nil,
-          colorScheme: nil,
-          deviceScaleFactor: nil,
-          extraHTTPHeaders: nil,
-          geolocation: nil,
-          hasTouch: nil,
-          httpCredentials: nil,
-          ignoreHTTPSErrors: nil,
-          isMobile: nil,
-          javaScriptEnabled: nil,
-          locale: nil,
-          noViewport: nil,
-          offline: nil,
-          permissions: nil,
-          proxy: nil,
-          record_har_omit_content: nil,
-          record_har_path: nil,
-          record_video_dir: nil,
-          record_video_size: nil,
-          storageState: nil,
-          timezoneId: nil,
-          userAgent: nil,
-          viewport: nil,
-          &block)
-      params = {
-        pkg: pkg,
-        acceptDownloads: acceptDownloads,
-        bypassCSP: bypassCSP,
-        colorScheme: colorScheme,
-        deviceScaleFactor: deviceScaleFactor,
-        extraHTTPHeaders: extraHTTPHeaders,
-        geolocation: geolocation,
-        hasTouch: hasTouch,
-        httpCredentials: httpCredentials,
-        ignoreHTTPSErrors: ignoreHTTPSErrors,
-        isMobile: isMobile,
-        javaScriptEnabled: javaScriptEnabled,
-        locale: locale,
-        noViewport: noViewport,
-        offline: offline,
-        permissions: permissions,
-        proxy: proxy,
-        record_har_omit_content: record_har_omit_content,
-        record_har_path: record_har_path,
-        record_video_dir: record_video_dir,
-        record_video_size: record_video_size,
-        storageState: storageState,
-        timezoneId: timezoneId,
-        userAgent: userAgent,
-        viewport: viewport,
-      }.compact
+    def launch_browser(pkg: nil, **options, &block)
+      params = options.dup
+      params[:pkg] = pkg
+      params.compact!
       prepare_browser_context_options(params)
 
       resp = @channel.send_message_to_server('launchBrowser', params)

data/lib/playwright/channel_owners/browser_context.rb

@@ -58,6 +58,12 @@ module Playwright
           ChannelOwners::Page.from_nullable(params['page']),
         )
       })
+      set_event_to_subscription_mapping({
+        Events::BrowserContext::Request => "request",
+        Events::BrowserContext::Response => "response",
+        Events::BrowserContext::RequestFinished => "requestFinished",
+        Events::BrowserContext::RequestFailed => "requestFailed",
+      })
 
       @closed_promise = Concurrent::Promises.resolvable_future
     end

data/lib/playwright/channel_owners/element_handle.rb

@@ -76,10 +76,17 @@ module Playwright
         nil
       end
 
-      def hover(force: nil, modifiers: nil, position: nil, timeout: nil, trial: nil)
+      def hover(
+            force: nil,
+            modifiers: nil,
+            noWaitAfter: nil,
+            position: nil,
+            timeout: nil,
+            trial: nil)
         params = {
           force: force,
           modifiers: modifiers,
+          noWaitAfter: noWaitAfter,
           position: position,
           timeout: timeout,
           trial: trial,