playwright-ruby-client 1.38.1 → 1.39.0

data/lib/playwright_api/locator.rb

@@ -28,6 +28,8 @@ module Playwright
     #
     # Returns an array of `node.innerText` values for all matching nodes.
     #
+    # **NOTE**: If you need to assert text on the page, prefer [`method: LocatorAssertions.toHaveText`] with `useInnerText` option to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
+    #
     # **Usage**
     #
     # ```python sync
@@ -40,6 +42,8 @@ module Playwright
     #
     # Returns an array of `node.textContent` values for all matching nodes.
     #
+    # **NOTE**: If you need to assert text on the page, prefer [`method: LocatorAssertions.toHaveText`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
+    #
     # **Usage**
     #
     # ```python sync
@@ -192,6 +196,8 @@ module Playwright
     #
     # Returns the number of elements matching the locator.
     #
+    # **NOTE**: If you need to assert the number of elements on the page, prefer [`method: LocatorAssertions.toHaveCount`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
+    #
     # **Usage**
     #
     # ```python sync
@@ -441,6 +447,8 @@ module Playwright
 
     #
     # Returns the matching element's attribute value.
+    #
+    # **NOTE**: If you need to assert an element's attribute, prefer [`method: LocatorAssertions.toHaveAttribute`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
     def get_attribute(name, timeout: nil)
       wrap_impl(@impl.get_attribute(unwrap_impl(name), timeout: unwrap_impl(timeout)))
     end
@@ -681,6 +689,8 @@ module Playwright
 
     #
     # Returns the [`element.innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText).
+    #
+    # **NOTE**: If you need to assert text on the page, prefer [`method: LocatorAssertions.toHaveText`] with `useInnerText` option to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
     def inner_text(timeout: nil)
       wrap_impl(@impl.inner_text(timeout: unwrap_impl(timeout)))
     end
@@ -688,6 +698,8 @@ module Playwright
     #
     # Returns the value for the matching `<input>` or `<textarea>` or `<select>` element.
     #
+    # **NOTE**: If you need to assert input value, prefer [`method: LocatorAssertions.toHaveValue`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
+    #
     # **Usage**
     #
     # ```python sync
@@ -704,6 +716,8 @@ module Playwright
     #
     # Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
     #
+    # **NOTE**: If you need to assert that checkbox is checked, prefer [`method: LocatorAssertions.toBeChecked`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
+    #
     # **Usage**
     #
     # ```python sync
@@ -716,6 +730,8 @@ module Playwright
     #
     # Returns whether the element is disabled, the opposite of [enabled](../actionability.md#enabled).
     #
+    # **NOTE**: If you need to assert that an element is disabled, prefer [`method: LocatorAssertions.toBeDisabled`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
+    #
     # **Usage**
     #
     # ```python sync
@@ -728,6 +744,8 @@ module Playwright
     #
     # Returns whether the element is [editable](../actionability.md#editable).
     #
+    # **NOTE**: If you need to assert that an element is editable, prefer [`method: LocatorAssertions.toBeEditable`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
+    #
     # **Usage**
     #
     # ```python sync
@@ -740,6 +758,8 @@ module Playwright
     #
     # Returns whether the element is [enabled](../actionability.md#enabled).
     #
+    # **NOTE**: If you need to assert that an element is enabled, prefer [`method: LocatorAssertions.toBeEnabled`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
+    #
     # **Usage**
     #
     # ```python sync
@@ -752,6 +772,8 @@ module Playwright
     #
     # Returns whether the element is hidden, the opposite of [visible](../actionability.md#visible).
     #
+    # **NOTE**: If you need to assert that element is hidden, prefer [`method: LocatorAssertions.toBeHidden`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
+    #
     # **Usage**
     #
     # ```python sync
@@ -764,6 +786,8 @@ module Playwright
     #
     # Returns whether the element is [visible](../actionability.md#visible).
     #
+    # **NOTE**: If you need to assert that element is visible, prefer [`method: LocatorAssertions.toBeVisible`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
+    #
     # **Usage**
     #
     # ```python sync
@@ -1087,6 +1111,8 @@ module Playwright
 
     #
     # Returns the [`node.textContent`](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent).
+    #
+    # **NOTE**: If you need to assert text on the page, prefer [`method: LocatorAssertions.toHaveText`] to avoid flakiness. See [assertions guide](../test-assertions.md) for more details.
     def text_content(timeout: nil)
       wrap_impl(@impl.text_content(timeout: unwrap_impl(timeout)))
     end
@@ -1149,11 +1175,6 @@ module Playwright
       wrap_impl(@impl.wait_for(state: unwrap_impl(state), timeout: unwrap_impl(timeout)))
     end
 
-    # @nodoc
-    def expect(expression, options)
-      wrap_impl(@impl.expect(unwrap_impl(expression), unwrap_impl(options)))
-    end
-
     # @nodoc
     def to_s
       wrap_impl(@impl.to_s)

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()
@@ -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")
@@ -1441,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()
@@ -1587,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()
@@ -1671,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/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/sig/playwright.rbs

@@ -538,49 +538,6 @@ module Playwright
     def put: (String url, ?data: (String | String | untyped), ?failOnStatusCode: bool, ?form: Hash[untyped, untyped], ?headers: Hash[untyped, untyped], ?ignoreHTTPSErrors: bool, ?maxRedirects: Integer, ?multipart: Hash[untyped, untyped], ?params: Hash[untyped, untyped], ?timeout: Float) -> APIResponse
   end
 
-  class LocatorAssertions
-    def not_to_be_attached: (?attached: bool, ?timeout: Float) -> void
-    def not_to_be_checked: (?timeout: Float) -> void
-    def not_to_be_disabled: (?timeout: Float) -> void
-    def not_to_be_editable: (?editable: bool, ?timeout: Float) -> void
-    def not_to_be_empty: (?timeout: Float) -> void
-    def not_to_be_enabled: (?enabled: bool, ?timeout: Float) -> void
-    def not_to_be_focused: (?timeout: Float) -> void
-    def not_to_be_hidden: (?timeout: Float) -> void
-    def not_to_be_in_viewport: (?ratio: Float, ?timeout: Float) -> void
-    def not_to_be_visible: (?timeout: Float, ?visible: bool) -> void
-    def not_to_contain_text: ((String | Regexp | Array[untyped] | Array[untyped] | Array[untyped]) expected, ?ignoreCase: bool, ?timeout: Float, ?useInnerText: bool) -> void
-    def not_to_have_attribute: (String name, (String | Regexp) value, ?timeout: Float) -> void
-    def not_to_have_class: ((String | Regexp | Array[untyped] | Array[untyped] | Array[untyped]) expected, ?timeout: Float) -> void
-    def not_to_have_count: (Integer count, ?timeout: Float) -> void
-    def not_to_have_css: (String name, (String | Regexp) value, ?timeout: Float) -> void
-    def not_to_have_id: ((String | Regexp) id, ?timeout: Float) -> void
-    def not_to_have_js_property: (String name, untyped value, ?timeout: Float) -> void
-    def not_to_have_text: ((String | Regexp | Array[untyped] | Array[untyped] | Array[untyped]) expected, ?ignoreCase: bool, ?timeout: Float, ?useInnerText: bool) -> void
-    def not_to_have_value: ((String | Regexp) value, ?timeout: Float) -> void
-    def not_to_have_values: ((Array[untyped] | Array[untyped] | Array[untyped]) values, ?timeout: Float) -> void
-    def to_be_attached: (?attached: bool, ?timeout: Float) -> void
-    def to_be_checked: (?checked: bool, ?timeout: Float) -> void
-    def to_be_disabled: (?timeout: Float) -> void
-    def to_be_editable: (?editable: bool, ?timeout: Float) -> void
-    def to_be_empty: (?timeout: Float) -> void
-    def to_be_enabled: (?enabled: bool, ?timeout: Float) -> void
-    def to_be_focused: (?timeout: Float) -> void
-    def to_be_hidden: (?timeout: Float) -> void
-    def to_be_in_viewport: (?ratio: Float, ?timeout: Float) -> void
-    def to_be_visible: (?timeout: Float, ?visible: bool) -> void
-    def to_contain_text: ((String | Regexp | Array[untyped] | Array[untyped] | Array[untyped]) expected, ?ignoreCase: bool, ?timeout: Float, ?useInnerText: bool) -> void
-    def to_have_attribute: (String name, (String | Regexp) value, ?timeout: Float) -> void
-    def to_have_class: ((String | Regexp | Array[untyped] | Array[untyped] | Array[untyped]) expected, ?timeout: Float) -> void
-    def to_have_count: (Integer count, ?timeout: Float) -> void
-    def to_have_css: (String name, (String | Regexp) value, ?timeout: Float) -> void
-    def to_have_id: ((String | Regexp) id, ?timeout: Float) -> void
-    def to_have_js_property: (String name, untyped value, ?timeout: Float) -> void
-    def to_have_text: ((String | Regexp | Array[untyped] | Array[untyped] | Array[untyped]) expected, ?ignoreCase: bool, ?timeout: Float, ?useInnerText: bool) -> void
-    def to_have_value: ((String | Regexp) value, ?timeout: Float) -> void
-    def to_have_values: ((Array[untyped] | Array[untyped] | Array[untyped]) values, ?timeout: Float) -> void
-  end
-
   class Android
     def devices: (?host: String, ?omitDriverInstall: bool, ?port: Integer) -> Array[untyped]
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.38.1
+  version: 1.39.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-05 00:00:00.000000000 Z
+date: 2023-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -233,7 +233,6 @@ files:
 - documentation/docs/api/js_handle.md
 - documentation/docs/api/keyboard.md
 - documentation/docs/api/locator.md
-- documentation/docs/api/locator_assertions.md
 - documentation/docs/api/mouse.md
 - documentation/docs/api/page.md
 - documentation/docs/api/playwright.md
@@ -290,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
@@ -310,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
@@ -327,7 +326,6 @@ files:
 - lib/playwright/javascript/value_serializer.rb
 - lib/playwright/javascript/visitor_info.rb
 - lib/playwright/keyboard_impl.rb
-- lib/playwright/locator_assertions_impl.rb
 - lib/playwright/locator_impl.rb
 - lib/playwright/locator_utils.rb
 - lib/playwright/mouse_impl.rb
@@ -335,7 +333,6 @@ files:
 - lib/playwright/raw_headers.rb
 - lib/playwright/route_handler.rb
 - lib/playwright/select_option_values.rb
-- lib/playwright/test.rb
 - lib/playwright/timeout_settings.rb
 - lib/playwright/touchscreen_impl.rb
 - lib/playwright/transport.rb
@@ -369,7 +366,6 @@ files:
 - lib/playwright_api/js_handle.rb
 - lib/playwright_api/keyboard.rb
 - lib/playwright_api/locator.rb
-- lib/playwright_api/locator_assertions.rb
 - lib/playwright_api/mouse.rb
 - lib/playwright_api/page.rb
 - lib/playwright_api/playwright.rb
@@ -405,5 +401,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.38.1
+summary: The Ruby binding of playwright driver 1.39.0
 test_files: []