playwright-ruby-client 0.8.1 → 0.9.0

data/documentation/docs/api/page.md

@@ -104,6 +104,7 @@ def check(
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -136,6 +137,7 @@ def click(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -194,6 +196,7 @@ def dblclick(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -217,7 +220,12 @@ Shortcut for main frame's [Frame#dblclick](./frame#dblclick).
 ## dispatch_event
 
 ```
-def dispatch_event(selector, type, eventInit: nil, timeout: nil)
+def dispatch_event(
+      selector,
+      type,
+      eventInit: nil,
+      strict: nil,
+      timeout: nil)
 ```
 
 The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,
@@ -261,6 +269,7 @@ def drag_and_drop(
       target,
       force: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -301,7 +310,7 @@ page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches") # =
 ## eval_on_selector
 
 ```
-def eval_on_selector(selector, expression, arg: nil)
+def eval_on_selector(selector, expression, arg: nil, strict: nil)
 ```
 
 The method finds an element matching the specified selector within the page and passes it as a first argument to
@@ -518,6 +527,7 @@ def fill(
       value,
       force: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -537,7 +547,7 @@ Shortcut for main frame's [Frame#fill](./frame#fill).
 ## focus
 
 ```
-def focus(selector, timeout: nil)
+def focus(selector, strict: nil, timeout: nil)
 ```
 
 This method fetches an element with `selector` and focuses it. If there's no element matching `selector`, the method
@@ -574,7 +584,7 @@ An array of all frames attached to the page.
 ## get_attribute
 
 ```
-def get_attribute(selector, name, timeout: nil)
+def get_attribute(selector, name, strict: nil, timeout: nil)
 ```
 
 Returns element attribute value.
@@ -636,6 +646,7 @@ def hover(
       force: nil,
       modifiers: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -656,7 +667,7 @@ Shortcut for main frame's [Frame#hover](./frame#hover).
 ## inner_html
 
 ```
-def inner_html(selector, timeout: nil)
+def inner_html(selector, strict: nil, timeout: nil)
 ```
 
 Returns `element.innerHTML`.
@@ -664,7 +675,7 @@ Returns `element.innerHTML`.
 ## inner_text
 
 ```
-def inner_text(selector, timeout: nil)
+def inner_text(selector, strict: nil, timeout: nil)
 ```
 
 Returns `element.innerText`.
@@ -672,7 +683,7 @@ Returns `element.innerText`.
 ## input_value
 
 ```
-def input_value(selector, timeout: nil)
+def input_value(selector, strict: nil, timeout: nil)
 ```
 
 Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws for non-input elements.
@@ -680,7 +691,7 @@ Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws
 ## checked?
 
 ```
-def checked?(selector, timeout: nil)
+def checked?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
@@ -696,7 +707,7 @@ Indicates that the page has been closed.
 ## disabled?
 
 ```
-def disabled?(selector, timeout: nil)
+def disabled?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability).
@@ -704,7 +715,7 @@ Returns whether the element is disabled, the opposite of [enabled](https://playw
 ## editable?
 
 ```
-def editable?(selector, timeout: nil)
+def editable?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is [editable](https://playwright.dev/python/docs/actionability).
@@ -712,7 +723,7 @@ Returns whether the element is [editable](https://playwright.dev/python/docs/act
 ## enabled?
 
 ```
-def enabled?(selector, timeout: nil)
+def enabled?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability).
@@ -720,7 +731,7 @@ Returns whether the element is [enabled](https://playwright.dev/python/docs/acti
 ## hidden?
 
 ```
-def hidden?(selector, timeout: nil)
+def hidden?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is hidden, the opposite of [visible](https://playwright.dev/python/docs/actionability).  `selector` that does not
@@ -729,12 +740,26 @@ match any elements is considered hidden.
 ## visible?
 
 ```
-def visible?(selector, timeout: nil)
+def visible?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is [visible](https://playwright.dev/python/docs/actionability). `selector` that does not match any elements is
 considered not visible.
 
+## locator
+
+```
+def locator(selector)
+```
+
+The method returns an element locator that can be used to perform actions on the page. 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.
+
+Shortcut for main frame's [Frame#locator](./frame#locator).
+
 ## main_frame
 
 ```
@@ -751,6 +776,21 @@ def opener
 
 Returns the opener for popup pages and `null` for others. If the opener has been closed already the returns `null`.
 
+## pause
+
+```
+def pause
+```
+
+Pauses script execution. Playwright will stop executing the script and wait for the user to either press 'Resume' button
+in the page overlay or to call `playwright.resume()` in the DevTools console.
+
+User can inspect selectors or perform manual steps while paused. Resume will continue running the original script from
+the place it was paused.
+
+> NOTE: This method requires Playwright to be started in a headed mode, with a falsy `headless` value in the
+[BrowserType#launch](./browser_type#launch).
+
 ## pdf
 
 ```
@@ -824,6 +864,7 @@ def press(
       key,
       delay: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -861,7 +902,7 @@ page.screenshot(path: "o.png")
 ## query_selector
 
 ```
-def query_selector(selector)
+def query_selector(selector, strict: nil)
 ```
 
 The method finds an element matching the specified selector within the page. If no elements match the selector, the
@@ -963,6 +1004,7 @@ def select_option(
       label: nil,
       force: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -1041,7 +1083,12 @@ The extra HTTP headers will be sent with every request the page initiates.
 ## set_input_files
 
 ```
-def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
+def set_input_files(
+      selector,
+      files,
+      noWaitAfter: nil,
+      strict: nil,
+      timeout: nil)
 ```
 
 This method expects `selector` to point to an
@@ -1079,6 +1126,7 @@ def tap_point(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -1101,7 +1149,7 @@ Shortcut for main frame's [Frame#tap_point](./frame#tap_point).
 ## text_content
 
 ```
-def text_content(selector, timeout: nil)
+def text_content(selector, strict: nil, timeout: nil)
 ```
 
 Returns `element.textContent`.
@@ -1122,6 +1170,7 @@ def type(
       text,
       delay: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -1145,6 +1194,7 @@ def uncheck(
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -1213,7 +1263,7 @@ throw an error if the page is closed before the [`event: Page.console`] event is
 def expect_download(predicate: nil, timeout: nil, &block)
 ```
 
-Performs action and waits for a new `Download`. If predicate is provided, it passes `Download` value into the
+Performs action and waits for a new [Download](./download). If predicate is provided, it passes [Download](./download) value into the
 `predicate` function and waits for `predicate(download)` to return a truthy value. Will throw an error if the page is
 closed before the download event is fired.
 
@@ -1394,7 +1444,7 @@ puts response.body
 ## wait_for_selector
 
 ```
-def wait_for_selector(selector, state: nil, timeout: nil)
+def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
 ```
 
 Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or

data/documentation/docs/article/guides/inspector.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 6
+---
+
+# Playwright inspector
+
+Playwright provides an useful inspector.
+https://playwright.dev/docs/inspector/
+
+## Overview
+
+```ruby {4,8}
+playwright.chromium.launch(headless: false) do |browser|
+  browser.new_context do |context|
+    # This method call should be put just after creating BrowserContext.
+    context.enable_debug_console!
+
+    page = context.new_pagè
+    page.goto('http://example.com/')
+    page.pause
+  end
+end
+```
+
+`page.pause` requires Playwright debug session, and it can be enabled by calling `BrowserContext#enable_debug_console!` in advance.
+
+Note that since Ruby is not officially supported in Playwright, many limitations exist. We CANNOT
+
+* Launch inspector via `PWDEBUG=1`
+* Debug without inspector UI (`PWDEBUG=console` is not working well)
+* Show Ruby code in inspector

data/documentation/docs/article/guides/playwright_on_alpine_linux.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 7
 ---
 
 # Playwright on Alpine Linux

data/documentation/docs/article/guides/semi_automation.md

@@ -14,7 +14,7 @@ Keep in mind repeatedly that persistent browser context is NOT RECOMMENDED for m
 
 ## Pause automation for manual operation
 
-`Page#pause` is not implemented yet, however we can use `binding.pry`  (with `pry-byebug` installed) instead.
+We can simply use `binding.pry`  (with `pry-byebug` installed).
 
 ```ruby {4}
 playwright.chromium.launch_persistent_context('./data/', headless: false) do |context|

data/documentation/docs/include/api_coverage.md

@@ -158,6 +158,7 @@
 * enabled?
 * hidden?
 * visible?
+* locator
 * name
 * page
 * parent_frame
@@ -205,6 +206,17 @@
 * message
 * type
 
+## Download
+
+* cancel
+* delete
+* failure
+* page
+* path
+* save_as
+* suggested_filename
+* url
+
 ## Page
 
 * add_init_script
@@ -245,9 +257,10 @@
 * enabled?
 * hidden?
 * visible?
+* locator
 * main_frame
 * opener
-* ~~pause~~
+* pause
 * pdf
 * press
 * query_selector
@@ -364,6 +377,49 @@
 * start
 * stop
 
+## Locator
+
+* all_inner_texts
+* all_text_contents
+* bounding_box
+* check
+* click
+* count
+* dblclick
+* dispatch_event
+* element_handle
+* element_handles
+* evaluate
+* evaluate_all
+* evaluate_handle
+* fill
+* first
+* focus
+* get_attribute
+* hover
+* inner_html
+* inner_text
+* input_value
+* checked?
+* disabled?
+* editable?
+* enabled?
+* hidden?
+* visible?
+* last
+* locator
+* nth
+* press
+* screenshot
+* scroll_into_view_if_needed
+* select_option
+* select_text
+* set_input_files
+* tap_point
+* text_content
+* type
+* uncheck
+
 ## Android
 
 * devices

data/lib/playwright.rb

@@ -17,7 +17,6 @@ require 'playwright/utils'
 require 'playwright/api_implementation'
 require 'playwright/channel'
 require 'playwright/channel_owner'
-require 'playwright/download'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'

data/lib/playwright/channel_owners/browser_context.rb

@@ -250,7 +250,32 @@ module Playwright
       raise unless safe_close_error?(err)
     end
 
+    # REMARK: enable_debug_console is playwright-ruby-client specific method.
+    def enable_debug_console!
+      # Ruby is not supported in Playwright officially,
+      # and causes error:
+      #
+      #  Error:
+      #  ===============================
+      #  Unsupported language: 'ruby'
+      #  ===============================
+      #
+      # So, launch inspector as Python app.
+      # NOTE: This should be used only for Page#pause at this moment.
+      @channel.send_message_to_server('recorderSupplementEnable', language: :python)
+      @debug_console_enabled = true
+    end
+
+    class DebugConsoleNotEnabledError < StandardError
+      def initialize
+        super('Debug console should be enabled in advance, by calling `browser_context.enable_debug_console!`')
+      end
+    end
+
     def pause
+      unless @debug_console_enabled
+        raise DebugConsoleNotEnabledError.new
+      end
       @channel.send_message_to_server('pause')
     end