playwright-ruby-client 1.37.1 → 1.39.0

data/lib/playwright_api/page.rb

@@ -8,9 +8,9 @@ module Playwright
   # This example creates a page, navigates it to a URL, and then saves a screenshot:
   #
   # ```python sync
-  # from playwright.sync_api import sync_playwright
+  # from playwright.sync_api import sync_playwright, Playwright
   #
-  # def run(playwright):
+  # def run(playwright: Playwright):
   #     webkit = playwright.webkit
   #     browser = webkit.launch()
   #     context = browser.new_context()
@@ -438,9 +438,9 @@ module Playwright
     # An example of exposing page URL to all frames in a page:
     #
     # ```python sync
-    # from playwright.sync_api import sync_playwright
+    # from playwright.sync_api import sync_playwright, Playwright
     #
-    # def run(playwright):
+    # def run(playwright: Playwright):
     #     webkit = playwright.webkit
     #     browser = webkit.launch(headless=false)
     #     context = browser.new_context()
@@ -496,7 +496,7 @@ module Playwright
     #
     # ```python sync
     # import hashlib
-    # from playwright.sync_api import sync_playwright
+    # from playwright.sync_api import sync_playwright, Playwright
     #
     # def sha256(text):
     #     m = hashlib.sha256()
@@ -504,7 +504,7 @@ module Playwright
     #     return m.hexdigest()
     #
     #
-    # def run(playwright):
+    # def run(playwright: Playwright):
     #     webkit = playwright.webkit
     #     browser = webkit.launch(headless=False)
     #     page = browser.new_page()
@@ -532,7 +532,7 @@ module Playwright
     #
     # 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 filled instead.
     #
-    # To send fine-grained keyboard events, use [`method: Page.type`].
+    # To send fine-grained keyboard events, use [`method: Locator.pressSequentially`].
     def fill(
           selector,
           value,
@@ -1176,7 +1176,7 @@ module Playwright
     # **Usage**
     #
     # ```python sync
-    # # single selection matching the value
+    # # Single selection matching the value or label
     # page.select_option("select#colors", "blue")
     # # single selection matching both the label
     # page.select_option("select#colors", label="blue")
@@ -1340,11 +1340,6 @@ module Playwright
     # To press a special key, like `Control` or `ArrowDown`, use [`method: Keyboard.press`].
     #
     # **Usage**
-    #
-    # ```python sync
-    # page.type("#mytextarea", "hello") # types instantly
-    # page.type("#mytextarea", "world", delay=100) # types slower, like a user
-    # ```
     def type(
           selector,
           text,
@@ -1446,9 +1441,9 @@ module Playwright
     # The [`method: Page.waitForFunction`] can be used to observe viewport size change:
     #
     # ```python sync
-    # from playwright.sync_api import sync_playwright
+    # from playwright.sync_api import sync_playwright, Playwright
     #
-    # def run(playwright):
+    # def run(playwright: Playwright):
     #     webkit = playwright.webkit
     #     browser = webkit.launch()
     #     page = browser.new_page()
@@ -1592,9 +1587,9 @@ module Playwright
     # This method works across navigations:
     #
     # ```python sync
-    # from playwright.sync_api import sync_playwright
+    # from playwright.sync_api import sync_playwright, Playwright
     #
-    # def run(playwright):
+    # def run(playwright: Playwright):
     #     chromium = playwright.chromium
     #     browser = chromium.launch()
     #     page = browser.new_page()
@@ -1676,33 +1671,33 @@ module Playwright
     end
 
     # @nodoc
-    def owned_context=(req)
-      wrap_impl(@impl.owned_context=(unwrap_impl(req)))
+    def stop_css_coverage
+      wrap_impl(@impl.stop_css_coverage)
     end
 
     # @nodoc
-    def guid
-      wrap_impl(@impl.guid)
+    def stop_js_coverage
+      wrap_impl(@impl.stop_js_coverage)
     end
 
     # @nodoc
-    def start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
-      wrap_impl(@impl.start_js_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
+    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
     # @nodoc
-    def stop_js_coverage
-      wrap_impl(@impl.stop_js_coverage)
+    def owned_context=(req)
+      wrap_impl(@impl.owned_context=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
-      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
+    def guid
+      wrap_impl(@impl.guid)
     end
 
     # @nodoc
-    def stop_css_coverage
-      wrap_impl(@impl.stop_css_coverage)
+    def start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      wrap_impl(@impl.start_js_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/playwright.rb

@@ -4,9 +4,9 @@ module Playwright
   # to drive automation:
   #
   # ```python sync
-  # from playwright.sync_api import sync_playwright
+  # from playwright.sync_api import sync_playwright, Playwright
   #
-  # def run(playwright):
+  # def run(playwright: Playwright):
   #     chromium = playwright.chromium # or "firefox" or "webkit".
   #     browser = chromium.launch()
   #     page = browser.new_page()
@@ -29,9 +29,9 @@ module Playwright
     # Returns a dictionary of devices to be used with [`method: Browser.newContext`] or [`method: Browser.newPage`].
     #
     # ```python sync
-    # from playwright.sync_api import sync_playwright
+    # from playwright.sync_api import sync_playwright, Playwright
     #
-    # def run(playwright):
+    # def run(playwright: Playwright):
     #     webkit = playwright.webkit
     #     iphone = playwright.devices["iPhone 6"]
     #     browser = webkit.launch()

data/lib/playwright_api/request.rb

@@ -37,6 +37,20 @@ module Playwright
 
     #
     # Returns the `Frame` that initiated this request.
+    #
+    # **Usage**
+    #
+    # ```py
+    # frame_url = request.frame.url
+    # ```
+    #
+    # **Details**
+    #
+    # Note that in some cases the frame is not available, and this method will throw.
+    # - When request originates in the Service Worker. You can use `request.serviceWorker()` to check that.
+    # - When navigation request is issued before the corresponding frame is created. You can use [`method: Request.isNavigationRequest`] to check that.
+    #
+    # Here is an example that handles all the cases:
     def frame
       wrap_impl(@impl.frame)
     end
@@ -64,6 +78,9 @@ module Playwright
 
     #
     # Whether this request is driving frame's navigation.
+    #
+    # Some navigation requests are issued before the corresponding frame is created, and therefore
+    # do not have [`method: Request.frame`] available.
     def navigation_request?
       wrap_impl(@impl.navigation_request?)
     end

data/lib/playwright_api/selectors.rb

@@ -12,9 +12,9 @@ module Playwright
     # An example of registering selector engine that queries elements based on a tag name:
     #
     # ```python sync
-    # from playwright.sync_api import sync_playwright
+    # from playwright.sync_api import sync_playwright, Playwright
     #
-    # def run(playwright):
+    # def run(playwright: Playwright):
     #     tag_selector = """
     #       {
     #           // Returns the first element matching given selector in the root's subtree.

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

@@ -483,6 +483,7 @@ module Playwright
     def or: (Locator locator) -> Locator
     def page: -> Page
     def press: (String key, ?delay: Float, ?noWaitAfter: bool, ?timeout: Float) -> void
+    def press_sequentially: (String text, ?delay: Float, ?noWaitAfter: bool, ?timeout: Float) -> void
     def screenshot: (?animations: ("disabled" | "allow"), ?caret: ("hide" | "initial"), ?mask: Array[untyped], ?maskColor: String, ?omitBackground: bool, ?path: (String | File), ?quality: Integer, ?scale: ("css" | "device"), ?timeout: Float, ?type: ("png" | "jpeg")) -> String
     def scroll_into_view_if_needed: (?timeout: Float) -> void
     def select_option: (?element: (ElementHandle | Array[untyped]), ?index: (Integer | Array[untyped]), ?value: (String | Array[untyped]), ?label: (String | Array[untyped]), ?force: bool, ?noWaitAfter: bool, ?timeout: Float) -> Array[untyped]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.37.1
+  version: 1.39.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -289,7 +289,6 @@ files:
 - lib/playwright/channel_owners/browser_context.rb
 - lib/playwright/channel_owners/browser_type.rb
 - lib/playwright/channel_owners/cdp_session.rb
-- lib/playwright/channel_owners/console_message.rb
 - lib/playwright/channel_owners/dialog.rb
 - lib/playwright/channel_owners/electron.rb
 - lib/playwright/channel_owners/element_handle.rb
@@ -309,6 +308,7 @@ files:
 - lib/playwright/channel_owners/worker.rb
 - lib/playwright/channel_owners/writable_stream.rb
 - lib/playwright/connection.rb
+- lib/playwright/console_message_impl.rb
 - lib/playwright/download_impl.rb
 - lib/playwright/errors.rb
 - lib/playwright/event_emitter.rb
@@ -401,5 +401,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.37.0
+summary: The Ruby binding of playwright driver 1.39.0
 test_files: []

data/lib/playwright/channel_owners/console_message.rb

@@ -1,25 +0,0 @@
-module Playwright
-  define_channel_owner :ConsoleMessage do
-    def page
-      @page ||= ChannelOwners::Page.from_nullable(@initializer['page'])
-    end
-
-    def type
-      @initializer['type']
-    end
-
-    def text
-      @initializer['text']
-    end
-
-    def args
-      @initializer['args']&.map do |arg|
-        ChannelOwner.from(arg)
-      end
-    end
-
-    def location
-      @initialize['location']
-    end
-  end
-end