playwright-ruby-client 1.19.1 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68d737d7d01fd92889e417be20bca72ee6247258d07dc8b18f44a1b07967a2c1
-  data.tar.gz: 18522777dc4ef3e19a9be4a17710cfdef404fc441dcf2a5a28b82138175dfebd
+  metadata.gz: 4fa3fb99ecc1273e529e04b47bebf13546ecfcfc930b10b14c5fe3d0816af724
+  data.tar.gz: 6c74c799eccc9cf4c0c7dd120e10cdd0bfdc8dbd3e23713d2a0842fc53edb6f2
 SHA512:
-  metadata.gz: bf0887d285eabec5cf17b380d99e566f1b1399e089614adf23d99a38f0975e5f1b9fb6eb8891d67857b21945b5ad00772202caf337aeac53439407f20f5386f9
-  data.tar.gz: 95553f620063bbd52ded34d1f260a920fd82ba127868f1c85c43ac0b466ed9e93a1fce5d6319805e8f13ade1f3ad3c0aa03795be4387b3354664e26c2c1f4e00
+  metadata.gz: bcf0cf470b95f65380b584a3f6d4489be51f5479d23695ca8f6dd16549df1d9a4af07b112a5e5ca779d7915b86cd77b5644becea1b58fdddf527638e547734e3
+  data.tar.gz: 389a1c2b5e73fa6cd62703d487b864af1135822aaeaebeedcef24a6911c23cdd4f39e4353ea3d36a7ca367b5ae4fe8d88b65eb98336bd2a4afcfe5740dea3866

data/README.md

@@ -162,7 +162,7 @@ If your environment doesn't accept installing browser or creating browser proces
 For launching Playwright server, just execute:
 
 ```
-npx playwright install && npx playwright run-server 8080
+npx playwright install && npx playwright run-server --port 8080
 ```
 
 and we can connect to the server with the code like this:

data/documentation/docs/api/element_handle.md

@@ -435,6 +435,8 @@ The method finds all elements matching the specified selector in the [ElementHan
 
 ```
 def screenshot(
+      animations: nil,
+      mask: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,

data/documentation/docs/api/experimental/android.md

@@ -33,7 +33,7 @@ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
 ## devices
 
 ```
-def devices
+def devices(port: nil)
 ```
 
 Returns the list of detected Android devices.

data/documentation/docs/api/locator.md

@@ -325,6 +325,15 @@ def get_attribute(name, timeout: nil)
 
 Returns element attribute value.
 
+## highlight
+
+```
+def highlight
+```
+
+Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses
+[Locator#highlight](./locator#highlight).
+
 ## hover
 
 ```
@@ -480,6 +489,8 @@ modifier, modifier is pressed and being held while the subsequent key is being p
 
 ```
 def screenshot(
+      animations: nil,
+      mask: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,

data/documentation/docs/api/page.md

@@ -1012,8 +1012,10 @@ To remove a route with its handler you can use [Page#unroute](./page#unroute).
 
 ```
 def screenshot(
+      animations: nil,
       clip: nil,
       fullPage: nil,
+      mask: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,
@@ -1167,9 +1169,10 @@ alias: `viewport_size=`
 In the case of multiple pages in a single browser, each page can have its own viewport size. However,
 [Browser#new_context](./browser#new_context) allows to set viewport size (and more) for all pages in the context at once.
 
-`page.setViewportSize` will resize the page. A lot of websites don't expect phones to change size, so you should set the
-viewport size before navigating to the page. [Page#set_viewport_size](./page#set_viewport_size) will also reset `screen` size, use
-[Browser#new_context](./browser#new_context) with `screen` and `viewport` parameters if you need better control of these properties.
+[Page#set_viewport_size](./page#set_viewport_size) will resize the page. A lot of websites don't expect phones to change size, so you
+should set the viewport size before navigating to the page. [Page#set_viewport_size](./page#set_viewport_size) will also reset `screen`
+size, use [Browser#new_context](./browser#new_context) with `screen` and `viewport` parameters if you need better control of these
+properties.
 
 ```ruby
 page.viewport_size = { width: 640, height: 480 }

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

@@ -27,7 +27,7 @@ This article introduces a way to separate environments into client (for executin
 
 ## Overview
 
-Playwrignt Ruby client is running on Alpine Linux. It just sends/receives JSON messages of Playwright-protocol via WebSocket.
+Playwright Ruby client is running on Alpine Linux. It just sends/receives JSON messages of Playwright-protocol via WebSocket.
 
 Playwright server is running on a container of [official Docker image](https://hub.docker.com/_/microsoft-playwright). It just operates browsers in response to the JSON messages from WebSocket.
 
@@ -69,7 +69,7 @@ end
 
 ### Server code
 
-With the [official Docker image](https://hub.docker.com/_/microsoft-playwright) or in the local development environment with Node.js, just execute `npx playwright install && npx playwright run-server $PORT`. (`$PORT` is a port number of the server)
+With the [official Docker image](https://hub.docker.com/_/microsoft-playwright) or in the local development environment with Node.js, just execute `npx playwright install && npx playwright run-server --port $PORT --path /ws`. (`$PORT` is a port number of the server)
 
 If custom Docker image is preferred, build it as follows:
 
@@ -80,7 +80,7 @@ WORKDIR /root
 RUN npm install playwright@1.12.3 && ./node_modules/.bin/playwright install
 
 ENV PORT 8888
-CMD ["./node_modules/.bin/playwright", "run-server", "$PORT"]
+CMD ["./node_modules/.bin/playwright", "run-server", "--port", "$PORT", "--path", "/ws"]
 ```
 
 ## Browser server/client
@@ -100,7 +100,7 @@ end
 
 ### Server code
 
-For instant use, `npx playwright launch-server chromium` generates a WebSocket endpoint URL with a random path.
+For instant use, `npx playwright launch-server --browser chromium` generates a WebSocket endpoint URL with a random path.
 
 More customization can be done by implementing JavaScript server like below:
 
@@ -138,7 +138,7 @@ DEBUG=1 bundle exec ruby some-automation-with-playwright.rb
 Just set an environment variable `DEBUG=pw:*` or `DEBUG=pw:server`
 
 ```
-DEBUG=pw:* npx playwright run-server 8888
+DEBUG=pw:* npx playwright run-server --port 8888 --path /ws
 ```
 
 See [the official documentation](https://playwright.dev/docs/debug/#verbose-api-logs) for details.

data/documentation/docs/include/api_coverage.md

@@ -417,6 +417,7 @@
 * focus
 * frame_locator
 * get_attribute
+* highlight
 * hover
 * inner_html
 * inner_text

data/lib/playwright/channel_owners/android.rb

@@ -4,8 +4,8 @@ module Playwright
       @timeout_settings = TimeoutSettings.new
     end
 
-    def devices
-      resp = @channel.send_message_to_server('devices')
+    def devices(port: nil)
+      resp = @channel.send_message_to_server('devices', port: port)
       resp.map { |device| ChannelOwners::AndroidDevice.from(device) }
     end
   end

data/lib/playwright/channel_owners/element_handle.rb

@@ -281,6 +281,8 @@ module Playwright
       end
 
       def screenshot(
+        animations: nil,
+        mask: nil,
         omitBackground: nil,
         path: nil,
         quality: nil,
@@ -288,12 +290,18 @@ module Playwright
         type: nil)
 
         params = {
+          animations: animations,
           omitBackground: omitBackground,
           path: path,
           quality: quality,
           timeout: timeout,
           type: type,
         }.compact
+        if mask.is_a?(Enumerable)
+          params[:mask] = mask.map do |locator|
+            locator.send(:to_protocol)
+          end
+        end
         encoded_binary = @channel.send_message_to_server('screenshot', params)
         decoded_binary = Base64.strict_decode64(encoded_binary)
         if path

data/lib/playwright/channel_owners/frame.rb

@@ -615,6 +615,10 @@ module Playwright
       @channel.send_message_to_server('title')
     end
 
+    def highlight(selector)
+      @channel.send_message_to_server('highlight', selector: selector)
+    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/channel_owners/page.rb

@@ -414,6 +414,8 @@ module Playwright
       fullPage: nil,
       clip: nil,
       omitBackground: nil,
+      animations: nil,
+      mask: nil,
       timeout: nil)
 
       params = {
@@ -422,8 +424,14 @@ module Playwright
         fullPage: fullPage,
         clip: clip,
         omitBackground: omitBackground,
+        animations: animations,
         timeout: timeout,
       }.compact
+      if mask.is_a?(Enumerable)
+        params[:mask] = mask.map do |locator|
+          locator.send(:to_protocol)
+        end
+      end
       encoded_binary = @channel.send_message_to_server('screenshot', params)
       decoded_binary = Base64.strict_decode64(encoded_binary)
       if path

data/lib/playwright/locator_impl.rb

@@ -55,6 +55,13 @@ module Playwright
       "Locator@#{@selector}"
     end
 
+    private def to_protocol
+      {
+        frame: @frame.channel,
+        selector: @selector,
+      }
+    end
+
     class DifferentFrameError < StandardError
       def initialize
         super('Inner "has" locator must belong to the same frame.')
@@ -306,6 +313,8 @@ module Playwright
     end
 
     def screenshot(
+          animations: nil,
+          mask: nil,
           omitBackground: nil,
           path: nil,
           quality: nil,
@@ -313,6 +322,8 @@ module Playwright
           type: nil)
       with_element(timeout: timeout) do |handle, options|
         handle.screenshot(
+          animations: animations,
+          mask: mask,
           omitBackground: omitBackground,
           path: path,
           quality: quality,
@@ -416,5 +427,9 @@ module Playwright
     def all_text_contents
       @frame.eval_on_selector_all(@selector, "ee => ee.map(e => e.textContent || '')")
     end
+
+    def highlight
+      @frame.highlight(@selector)
+    end
   end
 end

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.19.1'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.19.2'
+  VERSION = '1.20.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.20.0'
 end

data/lib/playwright_api/android.rb

@@ -26,8 +26,8 @@ module Playwright
   class Android < PlaywrightApi
 
     # Returns the list of detected Android devices.
-    def devices
-      wrap_impl(@impl.devices)
+    def devices(port: nil)
+      wrap_impl(@impl.devices(port: unwrap_impl(port)))
     end
 
     # This setting will change the default maximum time for all the methods accepting `timeout` option.

data/lib/playwright_api/element_handle.rb

@@ -346,12 +346,14 @@ module Playwright
     # This method waits for the [actionability](./actionability.md) checks, then scrolls element into view before taking a
     # screenshot. If the element is detached from DOM, the method throws an error.
     def screenshot(
+          animations: nil,
+          mask: nil,
           omitBackground: nil,
           path: nil,
           quality: nil,
           timeout: nil,
           type: nil)
-      wrap_impl(@impl.screenshot(omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
+      wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), mask: unwrap_impl(mask), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
     end
 
     # This method waits for [actionability](./actionability.md) checks, then tries to scroll element into view, unless it is

data/lib/playwright_api/frame.rb

@@ -788,6 +788,11 @@ module Playwright
       wrap_impl(@impl.detached=(unwrap_impl(req)))
     end
 
+    # @nodoc
+    def highlight(selector)
+      wrap_impl(@impl.highlight(unwrap_impl(selector)))
+    end
+
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)

data/lib/playwright_api/locator.rb

@@ -250,6 +250,12 @@ module Playwright
       wrap_impl(@impl.get_attribute(unwrap_impl(name), timeout: unwrap_impl(timeout)))
     end
 
+    # Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses
+    # [`method: Locator.highlight`].
+    def highlight
+      wrap_impl(@impl.highlight)
+    end
+
     # This method hovers over the element by performing the following steps:
     # 1. Wait for [actionability](./actionability.md) checks on the element, unless `force` option is set.
     # 1. Scroll the element into view if needed.
@@ -361,12 +367,14 @@ module Playwright
     # This method waits for the [actionability](./actionability.md) checks, then scrolls element into view before taking a
     # screenshot. If the element is detached from DOM, the method throws an error.
     def screenshot(
+          animations: nil,
+          mask: nil,
           omitBackground: nil,
           path: nil,
           quality: nil,
           timeout: nil,
           type: nil)
-      wrap_impl(@impl.screenshot(omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
+      wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), mask: unwrap_impl(mask), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
     end
 
     # This method waits for [actionability](./actionability.md) checks, then tries to scroll element into view, unless it is

data/lib/playwright_api/page.rb

@@ -891,14 +891,16 @@ module Playwright
 
     # Returns the buffer with the captured screenshot.
     def screenshot(
+          animations: nil,
           clip: nil,
           fullPage: nil,
+          mask: nil,
           omitBackground: nil,
           path: nil,
           quality: nil,
           timeout: nil,
           type: nil)
-      wrap_impl(@impl.screenshot(clip: unwrap_impl(clip), fullPage: unwrap_impl(fullPage), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
+      wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), clip: unwrap_impl(clip), fullPage: unwrap_impl(fullPage), mask: unwrap_impl(mask), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
     end
 
     # This method waits for an element matching `selector`, waits for [actionability](./actionability.md) checks, waits until
@@ -1016,9 +1018,10 @@ module Playwright
     # In the case of multiple pages in a single browser, each page can have its own viewport size. However,
     # [`method: Browser.newContext`] allows to set viewport size (and more) for all pages in the context at once.
     #
-    # `page.setViewportSize` will resize the page. A lot of websites don't expect phones to change size, so you should set the
-    # viewport size before navigating to the page. [`method: Page.setViewportSize`] will also reset `screen` size, use
-    # [`method: Browser.newContext`] with `screen` and `viewport` parameters if you need better control of these properties.
+    # [`method: Page.setViewportSize`] will resize the page. A lot of websites don't expect phones to change size, so you
+    # should set the viewport size before navigating to the page. [`method: Page.setViewportSize`] will also reset `screen`
+    # size, use [`method: Browser.newContext`] with `screen` and `viewport` parameters if you need better control of these
+    # properties.
     #
     # ```python sync
     # page = browser.new_page()
@@ -1387,13 +1390,13 @@ module Playwright
     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 start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      wrap_impl(@impl.start_js_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
     # @nodoc
-    def stop_css_coverage
-      wrap_impl(@impl.stop_css_coverage)
+    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
     # @nodoc
@@ -1402,8 +1405,8 @@ module Playwright
     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 stop_css_coverage
+      wrap_impl(@impl.stop_css_coverage)
     end
 
     # @nodoc

data/lib/playwright_api/worker.rb

@@ -44,13 +44,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 --

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.19.1
+  version: 1.20.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -396,5 +396,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.19.2
+summary: The Ruby binding of playwright driver 1.20.0
 test_files: []