playwright-ruby-client 1.35.0 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bd6b36250957e5968a5314944dc9327980d93e225a9aea86d3958268f8e089c
-  data.tar.gz: e787bb96692cb1d47b1f56d359d3ed63559f477993f1d14250398403a08359e9
+  metadata.gz: 72247024abd6cfc5a96eb203f8f1bcbbca18dafacb48e83802dd464ed93f7d21
+  data.tar.gz: 2496de7896c09b6395f5d4c958617cfb03111f0a111ef7e50acadf8a90069e53
 SHA512:
-  metadata.gz: 5a9e9da2b00c688fb256a770cacb32e9762ccd1df1965f30653d30c62810e6c3fae54c9838006461d02427520a071bec13000c754c4790fe85f1f9086592436c
-  data.tar.gz: e9e74a9558c418ce736ccbc0aa61ba6cac55b484ba961255de8dc8e22bdbf67db90f3c00de470b3cd94846c9fb5b76afcf3773f2680e9f8ba5d317f2cf318474
+  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
 
@@ -1741,7 +1742,7 @@ Waits for the matching request and returns it. See [waiting for event](https://p
 ```ruby
 page.content = '<form action="https://example.com/resource"><input type="submit" value="trigger request" /></form>'
 request = page.expect_request(/example.com\/resource/) do
-  page.get_by_text("trigger request").click()
+  page.get_by_text("trigger request").click
 end
 puts request.headers
 
@@ -1750,7 +1751,7 @@ page.wait_for_load_state # wait for request finished.
 # or with a predicate
 page.content = '<form action="https://example.com/resource"><input type="submit" value="trigger request" /></form>'
 request = page.expect_request(->(req) { req.url.start_with? 'https://example.com/resource' }) do
-  page.get_by_text("trigger request").click()
+  page.get_by_text("trigger request").click
 end
 puts request.headers
 ```
@@ -1780,7 +1781,7 @@ Returns the matched response. See [waiting for event](https://playwright.dev/pyt
 ```ruby
 page.content = '<form action="https://example.com/resource"><input type="submit" value="trigger response" /></form>'
 response = page.expect_response(/example.com\/resource/) do
-  page.get_by_text("trigger response").click()
+  page.get_by_text("trigger response").click
 end
 puts response.body
 puts response.ok?
@@ -1790,7 +1791,7 @@ page.wait_for_load_state # wait for request finished.
 # or with a predicate
 page.content = '<form action="https://example.com/resource"><input type="submit" value="trigger response" /></form>'
 response = page.expect_response(->(res) { res.url.start_with? 'https://example.com/resource' }) do
-  page.get_by_text("trigger response").click()
+  page.get_by_text("trigger response").click
 end
 puts response.body
 puts response.ok?

data/documentation/docs/api/selectors.md

@@ -38,7 +38,7 @@ JAVASCRIPT
 # Register the engine. Selectors will be prefixed with "tag=".
 playwright.selectors.register("tag", script: tag_selector)
 playwright.chromium.launch do |browser|
-  page = browser.new_page()
+  page = browser.new_page
   page.content = '<div><button>Click me</button></div>'
 
   # Use the selector prefixed with its name.

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/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/javascript/value_parser.rb

@@ -52,6 +52,10 @@ module Playwright
           return URI(hash['u'])
         end
 
+        if hash.key?('bi')
+          return hash['bi'].to_i
+        end
+
         if hash.key?('r')
           # @see https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/RegExp
           # @see https://docs.ruby-lang.org/ja/latest/class/Regexp.html

data/lib/playwright/javascript/value_serializer.rb

@@ -34,7 +34,11 @@ module Playwright
         when true, false
           { b: value }
         when Numeric
-          { n: value }
+          if !value.is_a?(Integer) || (-9007199254740992..9007199254740991).include?(value)
+            { n: value }
+          else
+            { bi: value.to_s }
+          end
         when String
           { s: value }
         when Time

data/lib/playwright/version.rb

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

data/lib/playwright_api/accessibility.rb

@@ -35,11 +35,11 @@ module Playwright
     #
     # ```python sync
     # def find_focused_node(node):
-    #     if (node.get("focused"))
+    #     if node.get("focused"):
     #         return node
     #     for child in (node.get("children") or []):
     #         found_node = find_focused_node(child)
-    #         if (found_node)
+    #         if found_node:
     #             return found_node
     #     return None
     #

data/lib/playwright_api/browser_context.rb

@@ -281,9 +281,9 @@ module Playwright
     #
     # ```python sync
     # def handle_route(route):
-    #   if ("my-string" in route.request.post_data)
+    #   if ("my-string" in route.request.post_data):
     #     route.fulfill(body="mocked-data")
-    #   else
+    #   else:
     #     route.continue_()
     # context.route("/api/**", handle_route)
     # ```
@@ -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/element_handle.rb

@@ -187,7 +187,7 @@ module Playwright
     # ```python sync
     # tweet_handle = page.query_selector(".tweet")
     # assert tweet_handle.eval_on_selector(".like", "node => node.innerText") == "100"
-    # assert tweet_handle.eval_on_selector(".retweets", "node => node.innerText") = "10"
+    # assert tweet_handle.eval_on_selector(".retweets", "node => node.innerText") == "10"
     # ```
     def eval_on_selector(selector, expression, arg: nil)
       wrap_impl(@impl.eval_on_selector(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg)))

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

@@ -67,7 +67,7 @@ module Playwright
     # **Usage**
     #
     # ```python sync
-    # handle = page.evaluate_handle("({window, document})")
+    # handle = page.evaluate_handle("({ window, document })")
     # properties = handle.get_properties()
     # window_handle = properties.get("window")
     # document_handle = properties.get("document")

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.
     #
@@ -406,10 +405,9 @@ module Playwright
     # ```python sync
     # row_locator = page.locator("tr")
     # # ...
-    # row_locator
-    #     .filter(has_text="text in column 1")
-    #     .filter(has=page.get_by_role("button", name="column 2 button"))
-    #     .screenshot()
+    # row_locator.filter(has_text="text in column 1").filter(
+    #     has=page.get_by_role("button", name="column 2 button")
+    # ).screenshot()
     # ```
     def filter(has: nil, hasNot: nil, hasNotText: nil, hasText: nil)
       wrap_impl(@impl.filter(has: unwrap_impl(has), hasNot: unwrap_impl(hasNot), hasNotText: unwrap_impl(hasNotText), hasText: unwrap_impl(hasText)))
@@ -823,7 +821,7 @@ module Playwright
     # new_email = page.get_by_role("button", name="New")
     # dialog = page.get_by_text("Confirm security settings")
     # expect(new_email.or_(dialog)).to_be_visible()
-    # if (dialog.is_visible())
+    # if (dialog.is_visible()):
     #   page.get_by_role("button", name="Dismiss").click()
     # new_email.click()
     # ```
@@ -1068,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

@@ -1115,9 +1115,9 @@ module Playwright
     #
     # ```python sync
     # def handle_route(route):
-    #   if ("my-string" in route.request.post_data)
+    #   if ("my-string" in route.request.post_data):
     #     route.fulfill(body="mocked-data")
-    #   else
+    #   else:
     #     route.continue_()
     # page.route("/api/**", handle_route)
     # ```
@@ -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/playwright.rb

@@ -77,17 +77,17 @@ module Playwright
     # Terminates this instance of Playwright in case it was created bypassing the Python context manager. This is useful in REPL applications.
     #
     # ```py
-    # >>> from playwright.sync_api import sync_playwright
+    # from playwright.sync_api import sync_playwright
     #
-    # >>> playwright = sync_playwright().start()
+    # playwright = sync_playwright().start()
     #
-    # >>> browser = playwright.chromium.launch()
-    # >>> page = browser.new_page()
-    # >>> page.goto("https://playwright.dev/")
-    # >>> page.screenshot(path="example.png")
-    # >>> browser.close()
+    # browser = playwright.chromium.launch()
+    # page = browser.new_page()
+    # page.goto("https://playwright.dev/")
+    # page.screenshot(path="example.png")
+    # browser.close()
     #
-    # >>> playwright.stop()
+    # playwright.stop()
     # ```
     def stop
       raise NotImplementedError.new('stop is not implemented yet.')

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

@@ -22,7 +22,7 @@ module Playwright
     #     # override headers
     #     headers = {
     #         **request.headers,
-    #         "foo": "foo-value" # set "foo" header
+    #         "foo": "foo-value", # set "foo" header
     #         "bar": None # remove "bar" header
     #     }
     #     route.continue_(headers=headers)
@@ -84,7 +84,7 @@ module Playwright
     #     # override headers
     #     headers = {
     #         **request.headers,
-    #         "foo": "foo-value" # set "foo" header
+    #         "foo": "foo-value", # set "foo" header
     #         "bar": None # remove "bar" header
     #     }
     #     route.fallback(headers=headers)

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.35.0
+  version: 1.37.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-21 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.35.0
+summary: The Ruby binding of playwright driver 1.37.0
 test_files: []