playwright-ruby-client 1.14.beta1 → 1.15.beta1

data/lib/playwright_api/cdp_session.rb

@@ -33,12 +33,6 @@ module Playwright
       wrap_impl(@impl.send_message(unwrap_impl(method), params: unwrap_impl(params)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -51,6 +45,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/console_message.rb

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

data/lib/playwright_api/dialog.rb

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

data/lib/playwright_api/element_handle.rb

@@ -268,7 +268,7 @@ module Playwright
       wrap_impl(@impl.inner_text)
     end
 
-    # 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.
     def input_value(timeout: nil)
       wrap_impl(@impl.input_value(timeout: unwrap_impl(timeout)))
     end
@@ -529,12 +529,6 @@ module Playwright
       wrap_impl(@impl.wait_for_selector(unwrap_impl(selector), state: unwrap_impl(state), timeout: unwrap_impl(timeout)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -547,6 +541,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/frame.rb

@@ -173,10 +173,12 @@ module Playwright
           target,
           force: nil,
           noWaitAfter: nil,
+          sourcePosition: nil,
           strict: nil,
+          targetPosition: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.drag_and_drop(unwrap_impl(source), unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.drag_and_drop(unwrap_impl(source), unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), sourcePosition: unwrap_impl(sourcePosition), strict: unwrap_impl(strict), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns the return value of `expression`.
@@ -330,18 +332,18 @@ module Playwright
     # Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
     # last redirect.
     #
-    # `frame.goto` will throw an error if:
+    # The method will throw an error if:
     # - there's an SSL error (e.g. in case of self-signed certificates).
     # - target URL is invalid.
     # - the `timeout` is exceeded during navigation.
     # - the remote server does not respond or is unreachable.
     # - the main resource failed to load.
     #
-    # `frame.goto` will not throw an error when any valid HTTP status code is returned by the remote server, including 404
-    # "Not Found" and 500 "Internal Server Error".  The status code for such responses can be retrieved by calling
+    # The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not
+    # Found" and 500 "Internal Server Error".  The status code for such responses can be retrieved by calling
     # [`method: Response.status`].
     #
-    # > NOTE: `frame.goto` either throws an error or returns a main resource response. The only exceptions are navigation to
+    # > NOTE: The method either throws an error or returns a main resource response. The only exceptions are navigation to
     # `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`.
     # > NOTE: Headless mode doesn't support navigation to a PDF document. See the
     # [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
@@ -380,7 +382,7 @@ module Playwright
       wrap_impl(@impl.inner_text(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # 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.
     def input_value(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.input_value(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
@@ -425,8 +427,6 @@ module Playwright
     # The method returns an element locator that can be used to perform actions in the frame. Locator is resolved to 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.
-    #
-    # Note that locator always implies visibility, so it will always be locating visible elements.
     def locator(selector)
       wrap_impl(@impl.locator(unwrap_impl(selector)))
     end
@@ -738,12 +738,6 @@ module Playwright
       wrap_impl(@impl.detached=(unwrap_impl(req)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -756,6 +750,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/js_handle.rb

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

data/lib/playwright_api/locator.rb

@@ -28,6 +28,19 @@ module Playwright
   # locator.hover()
   # locator.click()
   # ```
+  #
+  # **Strictness**
+  #
+  # Locators are strict. This means that all operations on locators that imply some target DOM element will throw if more
+  # than one element matches given selector.
+  #
+  # ```python sync
+  # # Throws if there are several buttons in DOM:
+  # page.locator('button').click()
+  #
+  # # Works because we explicitly tell locator to pick the first element:
+  # page.locator('button').first.click()
+  # ```
   class Locator < PlaywrightApi
 
     # Returns an array of `node.innerText` values for all matching nodes.
@@ -197,8 +210,8 @@ module Playwright
     # The method finds all elements matching the specified locator and passes an array of matched elements as a first argument
     # to `expression`. Returns the result of `expression` invocation.
     #
-    # If `expression` returns a [Promise], then [`Locator.evaluateAll`] would wait for the promise to resolve and return its
-    # value.
+    # If `expression` returns a [Promise], then [`method: Locator.evaluateAll`] would wait for the promise to resolve and
+    # return its value.
     #
     # Examples:
     #
@@ -282,7 +295,7 @@ module Playwright
       wrap_impl(@impl.inner_text(timeout: unwrap_impl(timeout)))
     end
 
-    # 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.
     def input_value(timeout: nil)
       wrap_impl(@impl.input_value(timeout: unwrap_impl(timeout)))
     end

data/lib/playwright_api/page.rb

@@ -246,10 +246,12 @@ module Playwright
           target,
           force: nil,
           noWaitAfter: nil,
+          sourcePosition: nil,
           strict: nil,
+          targetPosition: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.drag_and_drop(unwrap_impl(source), unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.drag_and_drop(unwrap_impl(source), unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), sourcePosition: unwrap_impl(sourcePosition), strict: unwrap_impl(strict), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # This method changes the `CSS media type` through the `media` argument, and/or the `'prefers-colors-scheme'` media
@@ -560,18 +562,18 @@ module Playwright
     # Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
     # last redirect.
     #
-    # `page.goto` will throw an error if:
+    # The method will throw an error if:
     # - there's an SSL error (e.g. in case of self-signed certificates).
     # - target URL is invalid.
     # - the `timeout` is exceeded during navigation.
     # - the remote server does not respond or is unreachable.
     # - the main resource failed to load.
     #
-    # `page.goto` will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not
+    # The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not
     # Found" and 500 "Internal Server Error".  The status code for such responses can be retrieved by calling
     # [`method: Response.status`].
     #
-    # > NOTE: `page.goto` either throws an error or returns a main resource response. The only exceptions are navigation to
+    # > NOTE: The method either throws an error or returns a main resource response. The only exceptions are navigation to
     # `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`.
     # > NOTE: Headless mode doesn't support navigation to a PDF document. See the
     # [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
@@ -614,7 +616,7 @@ module Playwright
       wrap_impl(@impl.inner_text(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # 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.
     def input_value(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.input_value(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
@@ -660,8 +662,6 @@ module Playwright
     # 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.
     #
-    # Note that locator always implies visibility, so it will always be locating visible elements.
-    #
     # Shortcut for main frame's [`method: Frame.locator`].
     def locator(selector)
       wrap_impl(@impl.locator(unwrap_impl(selector)))
@@ -1350,12 +1350,6 @@ module Playwright
       wrap_impl(@impl.guid)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -1368,6 +1362,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/playwright.rb

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

data/lib/playwright_api/request.rb

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

data/lib/playwright_api/response.rb

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

data/lib/playwright_api/route.rb

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

data/lib/playwright_api/selectors.rb

@@ -6,18 +6,43 @@ module Playwright
     # An example of registering selector engine that queries elements based on a tag name:
     #
     # ```python sync
-    # # FIXME: add snippet
+    # from playwright.sync_api import sync_playwright
+    #
+    # def run(playwright):
+    #     tag_selector = """
+    #       {
+    #           // Returns the first element matching given selector in the root's subtree.
+    #           query(root, selector) {
+    #               return root.querySelector(selector);
+    #           },
+    #           // Returns all elements matching given selector in the root's subtree.
+    #           queryAll(root, selector) {
+    #               return Array.from(root.querySelectorAll(selector));
+    #           }
+    #       }"""
+    #
+    #     # Register the engine. Selectors will be prefixed with "tag=".
+    #     playwright.selectors.register("tag", tag_selector)
+    #     browser = playwright.chromium.launch()
+    #     page = browser.new_page()
+    #     page.set_content('<div><button>Click me</button></div>')
+    #
+    #     # Use the selector prefixed with its name.
+    #     button = page.query_selector('tag=button')
+    #     # Combine it with other selector engines.
+    #     page.click('tag=div >> text="Click me"')
+    #     # Can use it in any methods supporting selectors.
+    #     button_count = page.eval_on_selector_all('tag=button', 'buttons => buttons.length')
+    #     print(button_count)
+    #     browser.close()
+    #
+    # with sync_playwright() as playwright:
+    #     run(playwright)
     # ```
     def register(name, contentScript: nil, path: nil, script: nil)
       wrap_impl(@impl.register(unwrap_impl(name), contentScript: unwrap_impl(contentScript), path: unwrap_impl(path), script: unwrap_impl(script)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
@@ -30,6 +55,12 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end