playwright-ruby-client 1.18.3 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61c1d2ea0171ac16b6687a7e48411d1c8ec0f61e40794628c1ac4e248fdce06a
-  data.tar.gz: 0ebea8c18299effd7f13ab1f7f8f96b043bb0ef2c215481943a8ba4df96abb7c
+  metadata.gz: 4fa3fb99ecc1273e529e04b47bebf13546ecfcfc930b10b14c5fe3d0816af724
+  data.tar.gz: 6c74c799eccc9cf4c0c7dd120e10cdd0bfdc8dbd3e23713d2a0842fc53edb6f2
 SHA512:
-  metadata.gz: 11c4ee9385a617b09ac668f9659193062b77b6d273c24c7ee73038f5a0279a811420fd2a13f1bee86d83f5e2ddbbf9720ad362ca6514ba445d3b4a1e5c77c372
-  data.tar.gz: cb0ddd6cad0c1d289014c0fddf2b2336885c46410c3501444d80fbee9947603f46b8d6e72a9e0244d1a8adf4550f25c0297d0263508cb8e918d93ded9063827e
+  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/api_request_context.md

@@ -28,7 +28,17 @@ playwright.chromium.launch do |browser|
     data: { name: 'test-repo-1' },
   )
   response.ok? # => true
-  response.json['name'] # => "tes≈-repo-1"
+  response.json['name'] # => "test-repo-1"
+
+  # Delete a repository.
+  response = api_request_context.delete(
+    "/repos/YourName/test-repo-1",
+    headers: {
+      "Accept": "application/vnd.github.v3+json",
+      "Authorization": "Bearer #{API_TOKEN}",
+    },
+  )
+  response.ok? # => true
 end
 ```
 

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/frame.md

@@ -549,7 +549,7 @@ considered not visible.
 ## locator
 
 ```
-def locator(selector, hasText: nil)
+def locator(selector, has: nil, hasText: nil)
 ```
 
 The method returns an element locator that can be used to perform actions in the frame. Locator is resolved to the

data/documentation/docs/api/frame_locator.md

@@ -65,7 +65,7 @@ Returns locator to the last matching frame.
 ## locator
 
 ```
-def locator(selector, hasText: nil)
+def locator(selector, has: nil, hasText: nil)
 ```
 
 The method finds an element matching the specified selector in the FrameLocator's subtree.

data/documentation/docs/api/locator.md

@@ -311,7 +311,7 @@ When working with iframes, you can create a frame locator that will enter the if
 that iframe:
 
 ```ruby
-locator = page.frame_locator("text=Submit").locator("text=Submit")
+locator = page.frame_locator("iframe").locator("text=Submit")
 locator.click
 ```
 
@@ -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
 
 ```
@@ -430,7 +439,7 @@ Returns locator to the last matching element.
 ## locator
 
 ```
-def locator(selector, hasText: nil)
+def locator(selector, has: nil, hasText: nil)
 ```
 
 The method finds an element matching the specified selector in the [Locator](./locator)'s subtree.
@@ -443,6 +452,14 @@ def nth(index)
 
 Returns locator to the n-th matching element.
 
+## page
+
+```
+def page
+```
+
+A page this locator belongs to.
+
 ## press
 
 ```
@@ -472,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

@@ -774,7 +774,7 @@ considered not visible.
 ## locator
 
 ```
-def locator(selector, hasText: nil)
+def locator(selector, has: nil, hasText: nil)
 ```
 
 The method returns an element locator that can be used to perform actions on the page. Locator is resolved to the
@@ -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 }
@@ -1491,6 +1494,9 @@ response = page.expect_response(/example.com\/resource/) do
   page.click("input")
 end
 puts response.body
+puts response.ok?
+
+page.wait_for_load_state # wait for request finished.
 
 # or with a predicate
 page.content = '<form action="https://example.com/resource"><input type="submit" /></form>'
@@ -1498,6 +1504,7 @@ response = page.expect_response(->(res) { res.url.start_with? 'https://example.c
   page.click("input")
 end
 puts response.body
+puts response.ok?
 ```
 
 

data/documentation/docs/api/route.md

@@ -45,6 +45,7 @@ def fulfill(
       contentType: nil,
       headers: nil,
       path: nil,
+      response: nil,
       status: nil)
 ```
 

data/documentation/docs/api/tracing.md

@@ -23,7 +23,12 @@ end
 ## start
 
 ```
-def start(name: nil, screenshots: nil, snapshots: nil, title: nil)
+def start(
+      name: nil,
+      screenshots: nil,
+      snapshots: nil,
+      sources: nil,
+      title: nil)
 ```
 
 Start tracing.

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
@@ -430,6 +431,7 @@
 * last
 * locator
 * nth
+* page
 * press
 * screenshot
 * scroll_into_view_if_needed

data/lib/playwright/api_response_impl.rb

@@ -66,6 +66,10 @@ module Playwright
       @request.channel.send_message_to_server("disposeAPIResponse", fetchUid: fetch_uid)
     end
 
+    private def _request
+      @request
+    end
+
     private def fetch_uid
       @initializer['fetchUid']
     end

data/lib/playwright/channel_owner.rb

@@ -72,6 +72,10 @@ module Playwright
     private def delete_object_from_child(guid)
       @objects.delete(guid)
     end
+
+    private def same_connection?(other)
+      @connection == other.instance_variable_get(:@connection)
+    end
   end
 
   class RootChannelOwner < ChannelOwner

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/api_request_context.rb

@@ -2,6 +2,10 @@ require 'base64'
 
 module Playwright
   define_channel_owner :APIRequestContext do
+    private def after_initialize
+      @tracing = ChannelOwners::Tracing.from(@initializer['tracing'])
+    end
+
     def dispose
       @channel.send_message_to_server('dispose')
     end

data/lib/playwright/channel_owners/browser_context.rb

@@ -14,7 +14,7 @@ module Playwright
       @service_workers = Set.new
       @background_pages = Set.new
 
-      @tracing = TracingImpl.new(@channel, self)
+      @tracing = ChannelOwners::Tracing.from(@initializer['tracing'])
       @request = ChannelOwners::APIRequestContext.from(@initializer['APIRequestContext'])
 
       @channel.on('bindingCall', ->(params) { on_binding(ChannelOwners::BindingCall.from(params['binding'])) })
@@ -72,13 +72,19 @@ module Playwright
       wrapped_route = PlaywrightApi.wrap(route)
       wrapped_request = PlaywrightApi.wrap(request)
 
-      if @routes.none? { |handler_entry| handler_entry.handle(wrapped_route, wrapped_request) }
-        route.continue
-      else
+      handler_entry = @routes.find do |entry|
+        entry.match?(request.url)
+      end
+
+      if handler_entry
+        handler_entry.async_handle(wrapped_route, wrapped_request)
+
         @routes.reject!(&:expired?)
         if @routes.count == 0
           @channel.async_send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
         end
+      else
+        route.continue
       end
     end
 
@@ -360,10 +366,5 @@ module Playwright
     private def base_url
       @options[:baseURL]
     end
-
-    # called from Tracing
-    private def remote_connection?
-      @connection.remote?
-    end
   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

@@ -400,8 +400,8 @@ module Playwright
       nil
     end
 
-    def locator(selector, hasText: nil)
-      LocatorImpl.new(frame: self, timeout_settings: @page.send(:timeout_settings), selector: selector, hasText: hasText)
+    def locator(selector, hasText: nil, has: nil)
+      LocatorImpl.new(frame: self, timeout_settings: @page.send(:timeout_settings), selector: selector, hasText: hasText, has: has)
     end
 
     def frame_locator(selector)
@@ -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

@@ -98,13 +98,19 @@ module Playwright
       wrapped_route = PlaywrightApi.wrap(route)
       wrapped_request = PlaywrightApi.wrap(request)
 
-      if @routes.none? { |handler_entry| handler_entry.handle(wrapped_route, wrapped_request) }
-        @browser_context.send(:on_route, route, request)
-      else
+      handler_entry = @routes.find do |entry|
+        entry.match?(request.url)
+      end
+
+      if handler_entry
+        handler_entry.async_handle(wrapped_route, wrapped_request)
+
         @routes.reject!(&:expired?)
         if @routes.count == 0
           @channel.async_send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
         end
+      else
+        @browser_context.send(:on_route, route, request)
       end
     end
 
@@ -408,6 +414,8 @@ module Playwright
       fullPage: nil,
       clip: nil,
       omitBackground: nil,
+      animations: nil,
+      mask: nil,
       timeout: nil)
 
       params = {
@@ -416,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
@@ -558,8 +572,8 @@ module Playwright
         timeout: timeout)
     end
 
-    def locator(selector, hasText: nil)
-      @main_frame.locator(selector, hasText: hasText)
+    def locator(selector, hasText: nil, has: nil)
+      @main_frame.locator(selector, hasText: hasText, has: has)
     end
 
     def frame_locator(selector)

data/lib/playwright/channel_owners/route.rb

@@ -17,16 +17,30 @@ module Playwright
           contentType: nil,
           headers: nil,
           path: nil,
-          status: nil)
+          status: nil,
+          response: nil)
       params = {
         contentType: contentType,
         status: status,
       }.compact
+      option_body = body
+
+      if response
+        params[:status] ||= response.status
+        params[:headers] ||= response.headers
+
+        if !body && !path && response.is_a?(APIResponse)
+          if response.send(:_request).send(:same_connection?, self)
+            params[:fetchResponseUid] = response.send(:fetch_uid)
+          else
+            option_body = response.body
+          end
+        end
+      end
 
-      length = 0
       content =
-        if body
-          body
+        if option_body
+          option_body
         elsif path
           File.read(path)
         else

data/lib/playwright/{tracing_impl.rb → channel_owners/tracing.rb}

@@ -1,15 +1,11 @@
 module Playwright
-  define_api_implementation :TracingImpl do
-    def initialize(channel, context)
-      @channel = channel
-      @context = context
-    end
-
-    def start(name: nil, title: nil, screenshots: nil, snapshots: nil)
+  define_channel_owner :Tracing do
+    def start(name: nil, title: nil, screenshots: nil, snapshots: nil, sources: nil)
       params = {
         name: name,
         screenshots: screenshots,
         snapshots: snapshots,
+        sources: sources,
       }.compact
       @channel.send_message_to_server('tracingStart', params)
       @channel.send_message_to_server('tracingStartChunk', { title: title }.compact)
@@ -31,7 +27,7 @@ module Playwright
     private def do_stop_chunk(file_path:)
       mode = 'doNotSave'
       if file_path
-        if @context.send(:remote_connection?)
+        if @connection.remote?
           mode = 'compressTrace'
         else
           mode = 'compressTraceAndSources'

data/lib/playwright/frame_locator_impl.rb

@@ -6,12 +6,13 @@ module Playwright
       @frame_selector = frame_selector
     end
 
-    def locator(selector, hasText: nil)
+    def locator(selector, hasText: nil, has: nil)
       LocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
         selector: "#{@frame_selector} >> control=enter-frame >> #{selector}",
         hasText: hasText,
+        has: has,
       )
     end
 

data/lib/playwright/locator_impl.rb

@@ -24,29 +24,58 @@ module Playwright
   end
 
   define_api_implementation :LocatorImpl do
-    def initialize(frame:, timeout_settings:, selector:, hasText: nil)
+    def initialize(frame:, timeout_settings:, selector:, hasText: nil, has: nil)
       @frame = frame
       @timeout_settings = timeout_settings
-      @selector =
-        case hasText
-        when Regexp
-          source = EscapeWithQuotes.new(hasText.source, '"')
-          flags = []
-          flags << 'ms' if (hasText.options & Regexp::MULTILINE) != 0
-          flags << 'i' if (hasText.options & Regexp::IGNORECASE) != 0
-          "#{selector} >> :scope:text-matches(#{source}, \"#{flags.join('')}\")"
-        when String
-          text = EscapeWithQuotes.new(hasText, '"')
-          "#{selector} >> :scope:has-text(#{text})"
-        else
-          selector
+      selector_scopes = [selector]
+
+      case hasText
+      when Regexp
+        source = EscapeWithQuotes.new(hasText.source, '"')
+        flags = []
+        flags << 'ms' if (hasText.options & Regexp::MULTILINE) != 0
+        flags << 'i' if (hasText.options & Regexp::IGNORECASE) != 0
+        selector_scopes << ":scope:text-matches(#{source}, \"#{flags.join('')}\")"
+      when String
+        text = EscapeWithQuotes.new(hasText, '"')
+        selector_scopes << ":scope:has-text(#{text})"
+      end
+
+      if has
+        unless same_frame?(has)
+          raise DifferentFrameError.new
         end
+        selector_scopes << "has=#{has.send(:selector_json)}"
+      end
+
+      @selector = selector_scopes.join(' >> ')
     end
 
     def to_s
       "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.')
+      end
+    end
+
+    private def same_frame?(other)
+      @frame == other.instance_variable_get(:@frame)
+    end
+
+    private def selector_json
+      @selector.to_json
+    end
+
     private def with_element(timeout: nil, &block)
       timeout_or_default = @timeout_settings.timeout(timeout)
       start_time = Time.now
@@ -67,6 +96,10 @@ module Playwright
       end
     end
 
+    def page
+      @frame.page
+    end
+
     def bounding_box(timeout: nil)
       with_element(timeout: timeout) do |handle|
         handle.bounding_box
@@ -180,12 +213,13 @@ module Playwright
       @frame.fill(@selector, value, strict: true, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
     end
 
-    def locator(selector, hasText: nil)
+    def locator(selector, hasText: nil, has: nil)
       LocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
         selector: "#{@selector} >> #{selector}",
         hasText: hasText,
+        has: has,
       )
     end
 
@@ -279,6 +313,8 @@ module Playwright
     end
 
     def screenshot(
+          animations: nil,
+          mask: nil,
           omitBackground: nil,
           path: nil,
           quality: nil,
@@ -286,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,
@@ -389,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/route_handler.rb

@@ -5,7 +5,7 @@ module Playwright
         @count = count
       end
 
-      def handle
+      def increment
         return false if expired?
 
         @count = @count - 1
@@ -18,7 +18,7 @@ module Playwright
     end
 
     class StubCounter
-      def handle
+      def increment
         true
       end
 
@@ -43,14 +43,17 @@ module Playwright
         end
     end
 
-    def handle(route, request)
-      return false unless @counter.handle
+    def match?(url)
+      @url_matcher.match?(url)
+    end
+
+    def async_handle(route, request)
+      @counter.increment
 
-      if @url_matcher.match?(request.url)
+      Concurrent::Promises.future do
         @handler.call(route, request)
-        true
-      else
-        false
+      rescue => err
+        puts err, err.backtrace
       end
     end
 

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.18.3'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.18.1'
+  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/api_request_context.rb

@@ -16,13 +16,13 @@ module Playwright
   #     # This will launch a new browser, create a context and page. When making HTTP
   #     # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)
   #     # it will automatically set the cookies to the browser page and vise versa.
-  #     browser = playwright.chromium.launch()
+  #     browser = p.chromium.launch()
   #     context = browser.new_context(base_url="https://api.github.com")
   #     api_request_context = context.request
   #     page = context.new_page()
   #
   #     # Alternatively you can create a APIRequestContext manually without having a browser context attached:
-  #     # api_request_context = playwright.request.new_context(base_url="https://api.github.com")
+  #     # api_request_context = p.request.new_context(base_url="https://api.github.com")
   #
   #
   #     # Create a repository.

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

@@ -445,8 +445,8 @@ module Playwright
     # The method returns an element locator that can be used to perform actions in the frame. 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.
-    def locator(selector, hasText: nil)
-      wrap_impl(@impl.locator(unwrap_impl(selector), hasText: unwrap_impl(hasText)))
+    def locator(selector, has: nil, hasText: nil)
+      wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end
 
     # Returns frame's name attribute as specified in the tag.
@@ -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/frame_locator.rb

@@ -48,8 +48,8 @@ module Playwright
     end
 
     # The method finds an element matching the specified selector in the FrameLocator's subtree.
-    def locator(selector, hasText: nil)
-      wrap_impl(@impl.locator(unwrap_impl(selector), hasText: unwrap_impl(hasText)))
+    def locator(selector, has: nil, hasText: nil)
+      wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end
 
     # Returns locator to the n-th matching frame.

data/lib/playwright_api/locator.rb

@@ -238,7 +238,7 @@ module Playwright
     # that iframe:
     #
     # ```python sync
-    # locator = page.frame_locator("text=Submit").locator("text=Submit")
+    # locator = page.frame_locator("iframe").locator("text=Submit")
     # locator.click()
     # ```
     def frame_locator(selector)
@@ -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.
@@ -320,8 +326,8 @@ module Playwright
     end
 
     # The method finds an element matching the specified selector in the `Locator`'s subtree.
-    def locator(selector, hasText: nil)
-      wrap_impl(@impl.locator(unwrap_impl(selector), hasText: unwrap_impl(hasText)))
+    def locator(selector, has: nil, hasText: nil)
+      wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end
 
     # Returns locator to the n-th matching element.
@@ -329,6 +335,11 @@ module Playwright
       wrap_impl(@impl.nth(unwrap_impl(index)))
     end
 
+    # A page this locator belongs to.
+    def page
+      wrap_impl(@impl.page)
+    end
+
     # Focuses the element, and then uses [`method: Keyboard.down`] and [`method: Keyboard.up`].
     #
     # `key` can specify the intended [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key)
@@ -356,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

@@ -686,8 +686,8 @@ module Playwright
     # different DOM elements. That would happen if the DOM structure between those actions has changed.
     #
     # Shortcut for main frame's [`method: Frame.locator`].
-    def locator(selector, hasText: nil)
-      wrap_impl(@impl.locator(unwrap_impl(selector), hasText: unwrap_impl(hasText)))
+    def locator(selector, has: nil, hasText: nil)
+      wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end
 
     # The page's main frame. Page is guaranteed to have a main frame which persists during navigations.
@@ -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()
@@ -1282,7 +1285,7 @@ module Playwright
     # return response.ok
     #
     # # or with a lambda
-    # with page.expect_response(lambda response: response.url == "https://example.com" and response.status === 200) as response_info:
+    # with page.expect_response(lambda response: response.url == "https://example.com" and response.status == 200) as response_info:
     #     page.click("input")
     # response = response_info.value
     # return response.ok
@@ -1392,8 +1395,8 @@ module Playwright
     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_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
-      wrap_impl(@impl.start_css_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/route.rb

@@ -47,8 +47,9 @@ module Playwright
           contentType: nil,
           headers: nil,
           path: nil,
+          response: nil,
           status: nil)
-      wrap_impl(@impl.fulfill(body: unwrap_impl(body), contentType: unwrap_impl(contentType), headers: unwrap_impl(headers), path: unwrap_impl(path), status: unwrap_impl(status)))
+      wrap_impl(@impl.fulfill(body: unwrap_impl(body), contentType: unwrap_impl(contentType), headers: unwrap_impl(headers), path: unwrap_impl(path), response: unwrap_impl(response), status: unwrap_impl(status)))
     end
 
     # A request to be routed.

data/lib/playwright_api/tracing.rb

@@ -22,8 +22,13 @@ module Playwright
     # page.goto("https://playwright.dev")
     # context.tracing.stop(path = "trace.zip")
     # ```
-    def start(name: nil, screenshots: nil, snapshots: nil, title: nil)
-      wrap_impl(@impl.start(name: unwrap_impl(name), screenshots: unwrap_impl(screenshots), snapshots: unwrap_impl(snapshots), title: unwrap_impl(title)))
+    def start(
+          name: nil,
+          screenshots: nil,
+          snapshots: nil,
+          sources: nil,
+          title: nil)
+      wrap_impl(@impl.start(name: unwrap_impl(name), screenshots: unwrap_impl(screenshots), snapshots: unwrap_impl(snapshots), sources: unwrap_impl(sources), title: unwrap_impl(title)))
     end
 
     # Start a new trace chunk. If you'd like to record multiple traces on the same `BrowserContext`, use
@@ -58,5 +63,27 @@ module Playwright
     def stop_chunk(path: nil)
       wrap_impl(@impl.stop_chunk(path: unwrap_impl(path)))
     end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.18.3
+  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
@@ -304,6 +304,7 @@ files:
 - lib/playwright/channel_owners/route.rb
 - lib/playwright/channel_owners/selectors.rb
 - lib/playwright/channel_owners/stream.rb
+- lib/playwright/channel_owners/tracing.rb
 - lib/playwright/channel_owners/web_socket.rb
 - lib/playwright/channel_owners/worker.rb
 - lib/playwright/connection.rb
@@ -329,7 +330,6 @@ files:
 - lib/playwright/select_option_values.rb
 - lib/playwright/timeout_settings.rb
 - lib/playwright/touchscreen_impl.rb
-- lib/playwright/tracing_impl.rb
 - lib/playwright/transport.rb
 - lib/playwright/url_matcher.rb
 - lib/playwright/utils.rb
@@ -396,5 +396,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.18.1
+summary: The Ruby binding of playwright driver 1.20.0
 test_files: []