playwright-ruby-client 1.27.0 → 1.28.0

data/lib/playwright_api/frame_locator.rb

@@ -4,7 +4,7 @@ module Playwright
   # [`method: Locator.frameLocator`] method.
   #
   # ```python sync
-  # locator = page.frame_locator("my-frame").locator("text=Submit")
+  # locator = page.frame_locator("my-frame").get_by_text("Submit")
   # locator.click()
   # ```
   #
@@ -27,7 +27,7 @@ module Playwright
   # [`:scope`](https://developer.mozilla.org/en-US/docs/Web/CSS/:scope) CSS selector:
   #
   # ```python sync
-  # frameLocator = locator.frame_locator(":scope");
+  # frameLocator = locator.frame_locator(":scope")
   # ```
   class FrameLocator < PlaywrightApi
 
@@ -52,7 +52,7 @@ module Playwright
     end
 
     # 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>
@@ -85,13 +85,14 @@ module Playwright
           role,
           checked: nil,
           disabled: nil,
+          exact: nil,
           expanded: nil,
           includeHidden: nil,
           level: nil,
           name: nil,
           pressed: nil,
           selected: nil)
-      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), exact: unwrap_impl(exact), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
     end
 
     # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
@@ -100,12 +101,44 @@ module Playwright
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
 
-    # 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:
+    #
+    # ```python sync
+    # # Matches <span>
+    # page.get_by_text("world")
+    #
+    # # Matches first <div>
+    # page.get_by_text("Hello world")
+    #
+    # # Matches second <div>
+    # page.get_by_text("Hello", exact=True)
+    #
+    # # Matches both <div>s
+    # page.get_by_text(re.compile("Hello"))
+    #
+    # # Matches second <div>
+    # page.get_by_text(re.compile("^hello$", re.IGNORECASE))
+    # ```
+    #
+    # See also [`method: 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">`.
     def get_by_text(text, exact: nil)
       wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
-    # 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/lib/playwright_api/js_handle.rb

@@ -59,7 +59,7 @@ module Playwright
     # The method returns a map with **own property names** as keys and JSHandle instances for the property values.
     #
     # ```python sync
-    # handle = page.evaluate_handle("{window, document}")
+    # handle = page.evaluate_handle("({window, document})")
     # properties = handle.get_properties()
     # window_handle = properties.get("window")
     # document_handle = properties.get("document")
@@ -88,12 +88,6 @@ module Playwright
       wrap_impl(@impl.to_s)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -106,6 +100,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/keyboard.rb

@@ -1,6 +1,6 @@
 module Playwright
   # Keyboard provides an api for managing a virtual keyboard. The high level api is [`method: 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 [`method: Keyboard.down`], [`method: Keyboard.up`], and [`method: Keyboard.insertText`]
   # to manually fire events as if they were generated from a real keyboard.

data/lib/playwright_api/locator.rb

@@ -15,6 +15,11 @@ module Playwright
       wrap_impl(@impl.all_text_contents)
     end
 
+    # Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/blur) on the element.
+    def blur(timeout: nil)
+      wrap_impl(@impl.blur(timeout: unwrap_impl(timeout)))
+    end
+
     # This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is
     # calculated relative to the main frame viewport - which is usually the same as the browser window.
     #
@@ -58,6 +63,17 @@ module Playwright
       wrap_impl(@impl.check(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
+    # This method waits for [actionability](../actionability.md) 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.
+    def clear(force: nil, noWaitAfter: nil, timeout: nil)
+      wrap_impl(@impl.clear(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
+    end
+
     # This method clicks the element by performing the following steps:
     # 1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.
     # 1. Scroll the element into view if needed.
@@ -291,7 +307,7 @@ module Playwright
     end
 
     # 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>
@@ -324,13 +340,14 @@ module Playwright
           role,
           checked: nil,
           disabled: nil,
+          exact: nil,
           expanded: nil,
           includeHidden: nil,
           level: nil,
           name: nil,
           pressed: nil,
           selected: nil)
-      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), exact: unwrap_impl(exact), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
     end
 
     # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
@@ -339,12 +356,44 @@ module Playwright
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
 
-    # 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:
+    #
+    # ```python sync
+    # # Matches <span>
+    # page.get_by_text("world")
+    #
+    # # Matches first <div>
+    # page.get_by_text("Hello world")
+    #
+    # # Matches second <div>
+    # page.get_by_text("Hello", exact=True)
+    #
+    # # Matches both <div>s
+    # page.get_by_text(re.compile("Hello"))
+    #
+    # # Matches second <div>
+    # page.get_by_text(re.compile("^hello$", re.IGNORECASE))
+    # ```
+    #
+    # See also [`method: 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">`.
     def get_by_text(text, exact: nil)
       wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
-    # 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>
@@ -372,10 +421,11 @@ module Playwright
     def hover(
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns the `element.innerHTML`.

data/lib/playwright_api/page.rb

@@ -593,7 +593,7 @@ module Playwright
     end
 
     # 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>
@@ -626,13 +626,14 @@ module Playwright
           role,
           checked: nil,
           disabled: nil,
+          exact: nil,
           expanded: nil,
           includeHidden: nil,
           level: nil,
           name: nil,
           pressed: nil,
           selected: nil)
-      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), exact: unwrap_impl(exact), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
     end
 
     # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
@@ -641,12 +642,44 @@ module Playwright
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
 
-    # 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:
+    #
+    # ```python sync
+    # # Matches <span>
+    # page.get_by_text("world")
+    #
+    # # Matches first <div>
+    # page.get_by_text("Hello world")
+    #
+    # # Matches second <div>
+    # page.get_by_text("Hello", exact=True)
+    #
+    # # Matches both <div>s
+    # page.get_by_text(re.compile("Hello"))
+    #
+    # # Matches second <div>
+    # page.get_by_text(re.compile("^hello$", re.IGNORECASE))
+    # ```
+    #
+    # See also [`method: 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">`.
     def get_by_text(text, exact: nil)
       wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
-    # 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>
@@ -711,11 +744,12 @@ module Playwright
           selector,
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           strict: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns `element.innerHTML`.
@@ -1520,12 +1554,6 @@ module Playwright
       wrap_impl(@impl.stop_css_coverage)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -1538,6 +1566,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/playwright.rb

@@ -96,12 +96,6 @@ module Playwright
       wrap_impl(@impl.electron)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -114,6 +108,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/request.rb

@@ -10,7 +10,7 @@ module Playwright
   # > 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.
   class Request < PlaywrightApi
 
@@ -161,12 +161,6 @@ module Playwright
       wrap_impl(@impl.apply_fallback_overrides(unwrap_impl(overrides)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -179,6 +173,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/response.rb

@@ -110,12 +110,6 @@ module Playwright
       wrap_impl(@impl.from_service_worker?)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -128,6 +122,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/route.rb

@@ -118,12 +118,6 @@ module Playwright
       wrap_impl(@impl.redirect_navigation_request(unwrap_impl(url)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -136,6 +130,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/selectors.rb

@@ -54,12 +54,6 @@ module Playwright
       wrap_impl(@impl.text_id_attribute=(unwrap_impl(attribute_name)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -72,6 +66,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/tracing.rb

@@ -64,12 +64,6 @@ module Playwright
       wrap_impl(@impl.stop_chunk(path: unwrap_impl(path)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -82,6 +76,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/web_socket.rb

@@ -27,12 +27,6 @@ module Playwright
       wrap_impl(@impl.wait_for_event(unwrap_impl(event), predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -45,6 +39,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/worker.rb

@@ -53,12 +53,6 @@ module Playwright
       wrap_impl(@impl.page=(unwrap_impl(req)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -71,6 +65,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.27.0
+  version: 1.28.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2022-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -397,8 +397,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.27.0
+summary: The Ruby binding of playwright driver 1.28.1
 test_files: []