playwright-ruby-client 1.53.0 → 1.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ec489327d6ba1f70552c2ff0d73b41e4a4ba6c02a898aa608dfe86cfdb3b14
-  data.tar.gz: e41e3084aae362754ad8980bde6ef20e178edc87db72d4e845844802af02d77d
+  metadata.gz: d26f10b0192fbc1b4fd2e1724fca389df99b9857388d57b35f30913f15bb3767
+  data.tar.gz: 6d13481a4553b0a91dc138179254973afdcaf27e06071a703aec338894f13266
 SHA512:
-  metadata.gz: 3232bcc3f42fc1ab80c1027f1b2af825d21903c9024c8253015d5892dc1f5022a2ef31a9689350e33a4a9e6ce9425a31e55dc38ed75e0142e674c66135ca82f8
-  data.tar.gz: 29497adfd1e1bbcbef55eda2cdbc496e9a270d4500a082a071024afd519f01a9976bae5cc06c63a9c2f1825ca5afe86ed618017356add5015a5e0f15128bc72d
+  metadata.gz: d4ec72f8748fc736afa98fdfb0f01022170714422fc1be92b024cb88f87a40aa7539850c3b0127c935ab0cb848c0c6a9a4f7841021dca6c4669a2ac9c8600bd0
+  data.tar.gz: 530c3ac3a4dd1343ccac9af49d7f1fa85c45e296f496f398bb1d6d05532e66d7d6ecab0f27a5810801f41d3d04bfea29de8bc3709462a5d94598b3fa1e3bfe47

data/documentation/docs/api/browser_context.md

@@ -85,7 +85,7 @@ def browser
 ```
 
 
-Returns the browser instance of the context. If it was launched as a persistent context null gets returned.
+Gets the browser instance that owns the context. Returns `null` if the context is created outside of normal browser, e.g. Android or Electron.
 
 ## clear_cookies
 

data/documentation/docs/api/console_message.md

@@ -74,6 +74,3 @@ def type
 ```
 
 
-One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`,
-`'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`,
-`'count'`, `'timeEnd'`.

data/documentation/docs/api/frame.md

@@ -530,6 +530,7 @@ Many html elements have an implicitly [defined role](https://w3c.github.io/html-
 ```
 def get_by_test_id(testId)
 ```
+alias: `get_by_testid`
 
 
 Locate element by the test id.

data/documentation/docs/api/frame_locator.md

@@ -176,6 +176,7 @@ Many html elements have an implicitly [defined role](https://w3c.github.io/html-
 ```
 def get_by_test_id(testId)
 ```
+alias: `get_by_testid`
 
 
 Locate element by the test id.

data/documentation/docs/api/locator.md

@@ -741,6 +741,7 @@ Many html elements have an implicitly [defined role](https://w3c.github.io/html-
 ```
 def get_by_test_id(testId)
 ```
+alias: `get_by_testid`
 
 
 Locate element by the test id.

data/documentation/docs/api/mouse.md

@@ -7,6 +7,8 @@ sidebar_position: 10
 
 The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.
 
+**NOTE**: If you want to debug where the mouse moved, you can use the [Trace viewer](https://playwright.dev/python/docs/trace-viewer-intro) or [Playwright Inspector](https://playwright.dev/python/docs/running-tests). A red dot showing the location of the mouse will be shown for every mouse action.
+
 Every `page` object has its own Mouse, accessible with [Page#mouse](./page#mouse).
 
 ```ruby

data/documentation/docs/api/page.md

@@ -724,6 +724,7 @@ Many html elements have an implicitly [defined role](https://w3c.github.io/html-
 ```
 def get_by_test_id(testId)
 ```
+alias: `get_by_testid`
 
 
 Locate element by the test id.

data/lib/playwright/channel_owners/frame.rb

@@ -666,7 +666,7 @@ module Playwright
     end
 
     def wait_for_timeout(timeout)
-      @channel.send_message_to_server('waitForTimeout', timeout: timeout)
+      @channel.send_message_to_server('waitForTimeout', waitTimeout: timeout)
 
       nil
     end
@@ -688,6 +688,30 @@ module Playwright
       @channel.send_message_to_server('highlight', selector: selector)
     end
 
+    def expect(selector, expression, options, title)
+      if options.key?(:expectedValue)
+        options[:expectedValue] = JavaScript::ValueSerializer
+          .new(options[:expectedValue])
+          .serialize
+      end
+
+      result = @channel.send_message_to_server_result(
+        title, # title
+        "expect", # method
+        { # params
+          selector: selector,
+          expression: expression,
+          **options,
+        }.compact
+      )
+
+      if result.key?('received')
+        result['received'] = JavaScript::ValueParser.new(result['received']).parse
+      end
+
+      result
+    end
+
     # @param page [Page]
     # @note This method should be used internally. Accessed via .send method, so keep private!
     private def update_page_from_page(page)

data/lib/playwright/locator_impl.rb

@@ -335,9 +335,7 @@ module Playwright
     end
 
     def generate_locator_string
-      with_element(timeout: nil) do |handle, _|
-        handle.channel.send_message_to_server('generateLocatorString')
-      end
+      @frame.channel.send_message_to_server('generateLocatorString', { selector: @selector })
     end
 
     def hover(
@@ -520,27 +518,7 @@ module Playwright
     end
 
     def expect(expression, options, title)
-      if options.key?(:expectedValue)
-        options[:expectedValue] = JavaScript::ValueSerializer
-          .new(options[:expectedValue])
-          .serialize
-      end
-
-      result = @frame.channel.send_message_to_server_result(
-        title, # title
-        "expect", # method
-        { # params
-          selector: @selector,
-          expression: expression,
-          **options,
-        }
-      )
-
-      if result.key?('received')
-        result['received'] = JavaScript::ValueParser.new(result['received']).parse
-      end
-
-      result
+      @frame.expect(@selector, expression, options, title)
     end
   end
 end

data/lib/playwright/page_assertions_impl.rb

@@ -13,7 +13,7 @@ module Playwright
 
     def initialize(page, default_expect_timeout, is_not, message)
       @page = PlaywrightApi.unwrap(page)
-      @locator = @page.locator(":root")
+      @frame = @page.main_frame
       @default_expect_timeout = default_expect_timeout
       @is_not = is_not
       @custom_message = message
@@ -25,7 +25,7 @@ module Playwright
       message.gsub!("expected to", "not expected to") if @is_not
       expect_options.delete(:useInnerText) if expect_options.key?(:useInnerText) && expect_options[:useInnerText].nil?
 
-      result = @locator.expect(expression, expect_options, title)
+      result = @frame.expect(nil, expression, expect_options, title)
 
       if result["matches"] == @is_not
         actual = result["received"]

data/lib/playwright/transport.rb

@@ -43,7 +43,7 @@ module Playwright
     # Terminate playwright-cli driver.
     def stop
       [@stdin, @stdout, @stderr].each { |io| io.close unless io.closed? }
-      @thread&.terminate
+      @thread&.join
     end
 
     # Start `playwright-cli run-driver`

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.53.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.53.0'
+  VERSION = '1.54.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.54.1'
 end

data/lib/playwright_api/browser_context.rb

@@ -80,7 +80,7 @@ module Playwright
     end
 
     #
-    # Returns the browser instance of the context. If it was launched as a persistent context null gets returned.
+    # Gets the browser instance that owns the context. Returns `null` if the context is created outside of normal browser, e.g. Android or Electron.
     def browser
       wrap_impl(@impl.browser)
     end

data/lib/playwright_api/console_message.rb

@@ -45,10 +45,6 @@ module Playwright
       wrap_impl(@impl.text)
     end
 
-    #
-    # One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`,
-    # `'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`,
-    # `'count'`, `'timeEnd'`.
     def type
       wrap_impl(@impl.type)
     end

data/lib/playwright_api/frame.rb

@@ -487,6 +487,7 @@ module Playwright
     def get_by_test_id(testId)
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
+    alias_method :get_by_testid, :get_by_test_id
 
     #
     # Allows locating elements that contain given text.
@@ -1038,14 +1039,19 @@ module Playwright
       wrap_impl(@impl.wait_for_url(unwrap_impl(url), timeout: unwrap_impl(timeout), waitUntil: unwrap_impl(waitUntil)))
     end
 
+    # @nodoc
+    def detached=(req)
+      wrap_impl(@impl.detached=(unwrap_impl(req)))
+    end
+
     # @nodoc
     def highlight(selector)
       wrap_impl(@impl.highlight(unwrap_impl(selector)))
     end
 
     # @nodoc
-    def detached=(req)
-      wrap_impl(@impl.detached=(unwrap_impl(req)))
+    def expect(selector, expression, options, title)
+      wrap_impl(@impl.expect(unwrap_impl(selector), unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/frame_locator.rb

@@ -170,6 +170,7 @@ module Playwright
     def get_by_test_id(testId)
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
+    alias_method :get_by_testid, :get_by_test_id
 
     #
     # Allows locating elements that contain given text.

data/lib/playwright_api/locator.rb

@@ -661,6 +661,7 @@ module Playwright
     def get_by_test_id(testId)
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
+    alias_method :get_by_testid, :get_by_test_id
 
     #
     # Allows locating elements that contain given text.

data/lib/playwright_api/mouse.rb

@@ -2,6 +2,8 @@ module Playwright
   #
   # The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.
   #
+  # **NOTE**: If you want to debug where the mouse moved, you can use the [Trace viewer](../trace-viewer-intro.md) or [Playwright Inspector](../running-tests.md). A red dot showing the location of the mouse will be shown for every mouse action.
+  #
   # Every `page` object has its own Mouse, accessible with [`property: Page.mouse`].
   #
   # ```python sync

data/lib/playwright_api/page.rb

@@ -716,6 +716,7 @@ module Playwright
     def get_by_test_id(testId)
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
+    alias_method :get_by_testid, :get_by_test_id
 
     #
     # Allows locating elements that contain given text.

data/lib/playwright_api/playwright.rb

@@ -94,13 +94,13 @@ module Playwright
     end
 
     # @nodoc
-    def android
-      wrap_impl(@impl.android)
+    def electron
+      wrap_impl(@impl.electron)
     end
 
     # @nodoc
-    def electron
-      wrap_impl(@impl.electron)
+    def android
+      wrap_impl(@impl.android)
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/response.rb

@@ -118,13 +118,13 @@ module Playwright
     end
 
     # @nodoc
-    def ok?
-      wrap_impl(@impl.ok?)
+    def from_service_worker?
+      wrap_impl(@impl.from_service_worker?)
     end
 
     # @nodoc
-    def from_service_worker?
-      wrap_impl(@impl.from_service_worker?)
+    def ok?
+      wrap_impl(@impl.ok?)
     end
 
     # -- inherited from EventEmitter --

data/sig/playwright.rbs

@@ -170,6 +170,7 @@ module Playwright
     def get_by_placeholder: ((String | Regexp) text, ?exact: bool) -> Locator
     def get_by_role: (("alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem") role, ?checked: bool, ?disabled: bool, ?exact: bool, ?expanded: bool, ?includeHidden: bool, ?level: Integer, ?name: (String | Regexp), ?pressed: bool, ?selected: bool) -> Locator
     def get_by_test_id: ((String | Regexp) testId) -> Locator
+    def get_by_testid: ((String | Regexp) testId) -> Locator
     def get_by_text: ((String | Regexp) text, ?exact: bool) -> Locator
     def get_by_title: ((String | Regexp) text, ?exact: bool) -> Locator
     def goto: (String url, ?referer: String, ?timeout: Float, ?waitUntil: ("load" | "domcontentloaded" | "networkidle" | "commit")) -> (nil | Response)
@@ -239,7 +240,7 @@ module Playwright
     def location: -> Hash[untyped, untyped]
     def page: -> (nil | Page)
     def text: -> String
-    def type: -> String
+    def type: -> ("log" | "debug" | "info" | "error" | "warning" | "dir" | "dirxml" | "table" | "trace" | "clear" | "startGroup" | "startGroupCollapsed" | "endGroup" | "assert" | "profile" | "profileEnd" | "count" | "timeEnd")
   end
 
   class Dialog
@@ -293,6 +294,7 @@ module Playwright
     def get_by_placeholder: ((String | Regexp) text, ?exact: bool) -> Locator
     def get_by_role: (("alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem") role, ?checked: bool, ?disabled: bool, ?exact: bool, ?expanded: bool, ?includeHidden: bool, ?level: Integer, ?name: (String | Regexp), ?pressed: bool, ?selected: bool) -> Locator
     def get_by_test_id: ((String | Regexp) testId) -> Locator
+    def get_by_testid: ((String | Regexp) testId) -> Locator
     def get_by_text: ((String | Regexp) text, ?exact: bool) -> Locator
     def get_by_title: ((String | Regexp) text, ?exact: bool) -> Locator
     def go_back: (?timeout: Float, ?waitUntil: ("load" | "domcontentloaded" | "networkidle" | "commit")) -> (nil | Response)
@@ -487,6 +489,7 @@ module Playwright
     def get_by_placeholder: ((String | Regexp) text, ?exact: bool) -> Locator
     def get_by_role: (("alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem") role, ?checked: bool, ?disabled: bool, ?exact: bool, ?expanded: bool, ?includeHidden: bool, ?level: Integer, ?name: (String | Regexp), ?pressed: bool, ?selected: bool) -> Locator
     def get_by_test_id: ((String | Regexp) testId) -> Locator
+    def get_by_testid: ((String | Regexp) testId) -> Locator
     def get_by_text: ((String | Regexp) text, ?exact: bool) -> Locator
     def get_by_title: ((String | Regexp) text, ?exact: bool) -> Locator
     def highlight: -> void
@@ -530,6 +533,7 @@ module Playwright
     def get_by_placeholder: ((String | Regexp) text, ?exact: bool) -> Locator
     def get_by_role: (("alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem") role, ?checked: bool, ?disabled: bool, ?exact: bool, ?expanded: bool, ?includeHidden: bool, ?level: Integer, ?name: (String | Regexp), ?pressed: bool, ?selected: bool) -> Locator
     def get_by_test_id: ((String | Regexp) testId) -> Locator
+    def get_by_testid: ((String | Regexp) testId) -> Locator
     def get_by_text: ((String | Regexp) text, ?exact: bool) -> Locator
     def get_by_title: ((String | Regexp) text, ?exact: bool) -> Locator
     def last: -> FrameLocator

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.53.0
+  version: 1.54.0
 platform: ruby
 authors:
 - YusukeIwaki
@@ -409,5 +409,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.53.0
+summary: The Ruby binding of playwright driver 1.54.1
 test_files: []