playwright-ruby-client 1.36.1 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cc19f1c59e1531ea8cef976b3992b9770bb2003f6580bbe86ca6b3b0660610f
-  data.tar.gz: 2e298d2a003093a4bf523992d54796605eea00f531b4d890415d3dc5b8ebd232
+  metadata.gz: 72247024abd6cfc5a96eb203f8f1bcbbca18dafacb48e83802dd464ed93f7d21
+  data.tar.gz: 2496de7896c09b6395f5d4c958617cfb03111f0a111ef7e50acadf8a90069e53
 SHA512:
-  metadata.gz: bc1d1208314cf332e3e1a0f085c39c38f176c1b3a81d7d586d4603aa45969ba484cc2b42938f43994d9e7ee85bd2606b7aed76125eaf76079d6eb2c915f9edbe
-  data.tar.gz: 93a116d228b3c517480ab16c013fc9d2fd830b0f45692f299f72b0f59158b3bf9eb2148ff92f67cff188bcd9e763b5b526adf834bd6da1c61938cd7f2ea20ce6
+  metadata.gz: c6e622cc2a84154728e92f524982cd5c5b62e82ce74c3c48e2806b168b9c828af3e864e99d9f4f880a394cfb9a0c911f4c9db10296fe78071038ef8fa609cb84
+  data.tar.gz: 41d756ca2590f37fffbc81fdb0306a76c06a462e1aa33aaad81e871aacc0e9d12fc6f2fb6df514f2a013fbc2afc82d1737100bfcf34f4ca4ef10c78502f2acf7

data/documentation/docs/api/browser_context.md

@@ -343,7 +343,7 @@ def route_from_har(
 ```
 
 
-If specified the network requests that are made in the context will be served from the HAR file. Read more about [Replaying from HAR](https://playwright.dev/python/docs/network#replaying-from-har).
+If specified the network requests that are made in the context will be served from the HAR file. Read more about [Replaying from HAR](https://playwright.dev/python/docs/mock#replaying-from-har).
 
 Playwright will not serve requests intercepted by Service Worker from the HAR file. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
 

data/documentation/docs/api/frame.md

@@ -956,6 +956,7 @@ def set_content(html, timeout: nil, waitUntil: nil)
 alias: `content=`
 
 
+This method internally calls [document.write()](https://developer.mozilla.org/en-US/docs/Web/API/Document/write), inheriting all its specific characteristics and behaviors.
 
 ## set_input_files
 

data/documentation/docs/api/locator.md

@@ -6,7 +6,7 @@ sidebar_position: 10
 
 
 Locators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent
-a way to find element(s) on the page at any moment. Locator can be created with the [Page#locator](./page#locator) method.
+a way to find element(s) on the page at any moment. A locator can be created with the [Page#locator](./page#locator) method.
 
 [Learn more about locators](https://playwright.dev/python/docs/locators).
 
@@ -17,8 +17,7 @@ def all
 ```
 
 
-When locator points to a list of elements, returns array of locators, pointing
-to respective elements.
+When the locator points to a list of elements, this returns an array of locators, pointing to their respective elements.
 
 **NOTE**: [Locator#all](./locator#all) does not wait for elements to match the locator, and instead immediately returns whatever is present in the page.
 
@@ -1255,6 +1254,8 @@ def type(text, delay: nil, noWaitAfter: nil, timeout: nil)
 ```
 
 
+**NOTE**: In most cases, you should use [Locator#fill](./locator#fill) instead. You only need to type characters if there is special keyboard handling on the page.
+
 Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
 
 To press a special key, like `Control` or `ArrowDown`, use [Locator#press](./locator#press).

data/documentation/docs/api/page.md

@@ -1273,7 +1273,7 @@ def route_from_har(
 ```
 
 
-If specified the network requests that are made in the page will be served from the HAR file. Read more about [Replaying from HAR](https://playwright.dev/python/docs/network#replaying-from-har).
+If specified the network requests that are made in the page will be served from the HAR file. Read more about [Replaying from HAR](https://playwright.dev/python/docs/mock#replaying-from-har).
 
 Playwright will not serve requests intercepted by Service Worker from the HAR file. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
 
@@ -1369,6 +1369,7 @@ def set_content(html, timeout: nil, waitUntil: nil)
 alias: `content=`
 
 
+This method internally calls [document.write()](https://developer.mozilla.org/en-US/docs/Web/API/Document/write), inheriting all its specific characteristics and behaviors.
 
 ## set_default_navigation_timeout
 

data/lib/playwright/channel_owners/artifact.rb

@@ -1,3 +1,5 @@
+require 'stringio'
+
 module Playwright
   define_channel_owner :Artifact do
     private def after_initialize
@@ -18,6 +20,11 @@ module Playwright
       stream.save_as(path)
     end
 
+    def read_into_buffer
+      stream = ChannelOwners::Stream.from(@channel.send_message_to_server('stream'))
+      stream.read_all
+    end
+
     def failure
       @channel.send_message_to_server('failure')
     end

data/lib/playwright/channel_owners/browser.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_browser.py
   define_channel_owner :Browser do
@@ -86,16 +88,23 @@ module Playwright
       params = {
         page: page&.channel,
         categories: categories,
-        path: path,
         screenshots: screenshots,
       }.compact
+      @cr_tracing_path = path
 
       @channel.send_message_to_server('startTracing', params)
     end
 
     def stop_tracing
-      encoded_binary = @channel.send_message_to_server("stopTracing")
-      return Base64.strict_decode64(encoded_binary)
+      artifact = ChannelOwners::Artifact.from(@channel.send_message_to_server("stopTracing"))
+      data = artifact.read_into_buffer
+      if @cr_tracing_path
+        File.dirname(@cr_tracing_path).tap do |dir|
+          FileUtils.mkdir_p(dir) unless File.exist?(dir)
+        end
+        File.open(@cr_tracing_path, 'wb') { |f| f.write(data) }
+      end
+      data
     end
 
     private def on_close(_ = {})

data/lib/playwright/channel_owners/local_utils.rb

@@ -43,7 +43,7 @@ module Playwright
       @channel.send_message_to_server('tracingStarted', params)
     end
 
-    def trace_discarded(stacks_id)
+    def tracing_discarded(stacks_id)
       @channel.send_message_to_server('traceDiscarded', stacksId: stacks_id)
     end
 

data/lib/playwright/channel_owners/stream.rb

@@ -4,12 +4,27 @@ module Playwright
   define_channel_owner :Stream do
     def save_as(path)
       File.open(path, 'wb') do |f|
-        loop do
-          binary = @channel.send_message_to_server('read')
-          break if !binary || binary.length == 0
-          f.write(Base64.strict_decode64(binary))
+        read_with_block do |chunk|
+          f.write(chunk)
         end
       end
     end
+
+    def read_all(&block)
+      out = StringIO.new
+      read_with_block do |chunk|
+        out.write(chunk)
+      end
+      out.string
+    end
+
+    private def read_with_block(&block)
+      loop do
+        binary = @channel.send_message_to_server('read', size: 1024 * 1024)
+        break if !binary || binary.length == 0
+        decoded_chunk = Base64.strict_decode64(binary)
+        block.call(decoded_chunk)
+      end
+    end
   end
 end

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.36.1'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.36.1'
+  VERSION = '1.37.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.37.0'
 end

data/lib/playwright_api/browser_context.rb

@@ -299,7 +299,7 @@ module Playwright
     end
 
     #
-    # If specified the network requests that are made in the context will be served from the HAR file. Read more about [Replaying from HAR](../network.md#replaying-from-har).
+    # If specified the network requests that are made in the context will be served from the HAR file. Read more about [Replaying from HAR](../mock.md#replaying-from-har).
     #
     # Playwright will not serve requests intercepted by Service Worker from the HAR file. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
     def route_from_har(

data/lib/playwright_api/browser_type.rb

@@ -21,7 +21,12 @@ module Playwright
 
     #
     # This method attaches Playwright to an existing browser instance. When connecting to another browser launched via `BrowserType.launchServer` in Node.js, the major and minor version needs to match the client version (1.2.3 → is compatible with 1.2.x).
-    def connect(wsEndpoint, headers: nil, slowMo: nil, timeout: nil)
+    def connect(
+          wsEndpoint,
+          exposeNetwork: nil,
+          headers: nil,
+          slowMo: nil,
+          timeout: nil)
       raise NotImplementedError.new('connect is not implemented yet.')
     end
 

data/lib/playwright_api/frame.rb

@@ -802,6 +802,8 @@ module Playwright
       wrap_impl(@impl.set_checked(unwrap_impl(selector), unwrap_impl(checked), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
+    #
+    # This method internally calls [document.write()](https://developer.mozilla.org/en-US/docs/Web/API/Document/write), inheriting all its specific characteristics and behaviors.
     def set_content(html, timeout: nil, waitUntil: nil)
       wrap_impl(@impl.set_content(unwrap_impl(html), timeout: unwrap_impl(timeout), waitUntil: unwrap_impl(waitUntil)))
     end

data/lib/playwright_api/locator.rb

@@ -1,14 +1,13 @@
 module Playwright
   #
   # Locators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent
-  # a way to find element(s) on the page at any moment. Locator can be created with the [`method: Page.locator`] method.
+  # a way to find element(s) on the page at any moment. A locator can be created with the [`method: Page.locator`] method.
   #
   # [Learn more about locators](../locators.md).
   class Locator < PlaywrightApi
 
     #
-    # When locator points to a list of elements, returns array of locators, pointing
-    # to respective elements.
+    # When the locator points to a list of elements, this returns an array of locators, pointing to their respective elements.
     #
     # **NOTE**: [`method: Locator.all`] does not wait for elements to match the locator, and instead immediately returns whatever is present in the page.
     #
@@ -1067,6 +1066,8 @@ module Playwright
       wrap_impl(@impl.text_content(timeout: unwrap_impl(timeout)))
     end
 
+    #
+    # **NOTE**: In most cases, you should use [`method: Locator.fill`] instead. You only need to type characters if there is special keyboard handling on the page.
     #
     # Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
     #

data/lib/playwright_api/page.rb

@@ -1133,7 +1133,7 @@ module Playwright
     end
 
     #
-    # If specified the network requests that are made in the page will be served from the HAR file. Read more about [Replaying from HAR](../network.md#replaying-from-har).
+    # If specified the network requests that are made in the page will be served from the HAR file. Read more about [Replaying from HAR](../mock.md#replaying-from-har).
     #
     # Playwright will not serve requests intercepted by Service Worker from the HAR file. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
     def route_from_har(
@@ -1221,6 +1221,8 @@ module Playwright
       wrap_impl(@impl.set_checked(unwrap_impl(selector), unwrap_impl(checked), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
+    #
+    # This method internally calls [document.write()](https://developer.mozilla.org/en-US/docs/Web/API/Document/write), inheriting all its specific characteristics and behaviors.
     def set_content(html, timeout: nil, waitUntil: nil)
       wrap_impl(@impl.set_content(unwrap_impl(html), timeout: unwrap_impl(timeout), waitUntil: unwrap_impl(waitUntil)))
     end

data/lib/playwright_api/response.rb

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

data/lib/playwright_api/worker.rb

@@ -47,13 +47,13 @@ module Playwright
     end
 
     # @nodoc
-    def context=(req)
-      wrap_impl(@impl.context=(unwrap_impl(req)))
+    def page=(req)
+      wrap_impl(@impl.page=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def page=(req)
-      wrap_impl(@impl.page=(unwrap_impl(req)))
+    def context=(req)
+      wrap_impl(@impl.context=(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.36.1
+  version: 1.37.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -401,5 +401,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.36.1
+summary: The Ruby binding of playwright driver 1.37.0
 test_files: []