playwright-ruby-client 1.30.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aad6731aec0fa14767336de6c50ccb1242a39edf897fe891d324af9608e254a9
-  data.tar.gz: b9fa0e7a0c050c20db856e57d3f4c04e605f0f6174430cc24bb36d018e68dc4b
+  metadata.gz: a07a47674b92ceb12d46b022a3c37fddd1a637b41de72df5c3e1cb040eb22490
+  data.tar.gz: 6ecf932e03fe4b2b7c155913d806ccd4013c57962e530bfda6dfa52f1137ba93
 SHA512:
-  metadata.gz: c6a719dcb35d59c680ee7ff9cb290360d5e06d97b9f4cda7a15418fcb7e559c5117c0e5c637e51d80bd5966a0aff1a77d29f055107c13bc8b5a6554a3727de30
-  data.tar.gz: 40b98d6f40febade8e2f733a135be4bf94e4a9858cac492a64d1cfe27d9fd30e92df9982a1465aaca181d21d3749656abdc710e451c2303ae4355f38d3fabb7e
+  metadata.gz: 06f348db3d405450347b09c7769682754cf6d2dfb14d60d1a0b15fbb092aff70e9e84dadc3376cd956a3f424f4c33e1c2839c2aaa64f8abd6cd6e14653de4a32
+  data.tar.gz: 5f57704d5329a591a88d3a174087ad304114860312437e440013cc16707511c614102bde3200a793480208a4d2f4f44c67f7eea624982a2c1cc28e7d762d735f

data/documentation/docs/api/locator.md

@@ -255,7 +255,7 @@ def dispatch_event(type, eventInit: nil, timeout: nil)
 ```
 
 
-Programmaticaly dispatch an event on the matching element.
+Programmatically dispatch an event on the matching element.
 
 **Usage**
 
@@ -950,7 +950,7 @@ def press(key, delay: nil, noWaitAfter: nil, timeout: nil)
 ```
 
 
-Focuses the mathing element and presses a combintation of the keys.
+Focuses the matching element and presses a combination of the keys.
 
 **Usage**
 

data/documentation/docs/api/page.md

@@ -1464,7 +1464,7 @@ This method taps an element matching `selector` by performing the following step
 When all steps combined have not finished during the specified `timeout`, this method throws a
 `TimeoutError`. Passing zero timeout disables this.
 
-**NOTE**: [Page#tap_point](./page#tap_point) requires that the `hasTouch` option of the browser context be set to true.
+**NOTE**: [Page#tap_point](./page#tap_point) the method will throw if `hasTouch` option of the browser context is false.
 
 ## text_content
 

data/documentation/docs/api/route.md

@@ -43,6 +43,10 @@ end
 page.route("**/*", method(:handle))
 ```
 
+**Details**
+
+Note that any overrides such as `url` or `headers` only apply to the request being routed. If this request results in a redirect, overrides will not be applied to the new redirected request. If you want to propagate a header through redirects, use the combination of [Route#fetch](./route#fetch) and [Route#fulfill](./route#fulfill) instead.
+
 ## fallback
 
 ```
@@ -113,7 +117,12 @@ page.route("**/*", method(:handle))
 ## fetch
 
 ```
-def fetch(headers: nil, method: nil, postData: nil, url: nil)
+def fetch(
+      headers: nil,
+      maxRedirects: nil,
+      method: nil,
+      postData: nil,
+      url: nil)
 ```
 
 
@@ -133,6 +142,10 @@ end
 page.route("https://dog.ceo/api/breeds/list/all", method(:handle))
 ```
 
+**Details**
+
+Note that `headers` option will apply to the fetched request as well as any redirects initiated by it. If you want to only apply `headers` to the original request, but not to redirects, look into [Route#continue](./route#continue) instead.
+
 ## fulfill
 
 ```

data/documentation/docs/api/selectors.md

@@ -11,10 +11,12 @@ information.
 ## register
 
 ```
-def register(name, contentScript: nil, path: nil, script: nil)
+def register(name, script: nil, contentScript: nil, path: nil)
 ```
 
 
+Selectors must be registered before creating the page.
+
 **Usage**
 
 An example of registering selector engine that queries elements based on a tag name:
@@ -42,7 +44,7 @@ playwright.chromium.launch do |browser|
   # Use the selector prefixed with its name.
   button = page.locator('tag=button')
   # Combine it with other selector engines.
-  page.locator('tag=div >> text="Click me"').click
+  page.locator('tag=div').get_by_text('Click me').click
 
   # Can use it in any methods supporting selectors.
   button_count = page.locator('tag=button').count

data/documentation/docs/api/touchscreen.md

@@ -16,3 +16,5 @@ def tap_point(x, y)
 
 
 Dispatches a `touchstart` and `touchend` event with a single touch at the position (`x`,`y`).
+
+**NOTE**: [Page#tap_point](./page#tap_point) the method will throw if `hasTouch` option of the browser context is false.

data/lib/playwright/channel_owners/browser_context.rb

@@ -104,7 +104,7 @@ module Playwright
 
         @routes.reject!(&:expired?)
         if @routes.count == 0
-          @channel.async_send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
+          async_update_interception_patterns
         end
 
         unless handled
@@ -280,18 +280,14 @@ module Playwright
     def route(url, handler, times: nil)
       entry = RouteHandler.new(url, base_url, handler, times)
       @routes.unshift(entry)
-      if @routes.count >= 1
-        @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: true)
-      end
+      update_interception_patterns
     end
 
     def unroute(url, handler: nil)
       @routes.reject! do |handler_entry|
         handler_entry.same_value?(url: url, handler: handler)
       end
-      if @routes.count == 0
-        @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
-      end
+      update_interception_patterns
     end
 
     private def record_into_har(har, page, notFound:, url:)
@@ -325,6 +321,16 @@ module Playwright
       router.add_context_route(self)
     end
 
+    private def async_update_interception_patterns
+      patterns = RouteHandler.prepare_interception_patterns(@routes)
+      @channel.async_send_message_to_server('setNetworkInterceptionPatterns', patterns: patterns)
+    end
+
+    private def update_interception_patterns
+      patterns = RouteHandler.prepare_interception_patterns(@routes)
+      @channel.send_message_to_server('setNetworkInterceptionPatterns', patterns: patterns)
+    end
+
     def expect_event(event, predicate: nil, timeout: nil, &block)
       wait_helper = WaitHelper.new
       wait_helper.reject_on_timeout(timeout || @timeout_settings.timeout, "Timeout while waiting for event \"#{event}\"")

data/lib/playwright/channel_owners/page.rb

@@ -119,7 +119,7 @@ module Playwright
 
         @routes.reject!(&:expired?)
         if @routes.count == 0
-          @channel.async_send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
+          async_update_interception_patterns
         end
 
         unless handled
@@ -407,18 +407,14 @@ module Playwright
     def route(url, handler, times: nil)
       entry = RouteHandler.new(url, @browser_context.send(:base_url), handler, times)
       @routes.unshift(entry)
-      if @routes.count >= 1
-        @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: true)
-      end
+      update_interception_patterns
     end
 
     def unroute(url, handler: nil)
       @routes.reject! do |handler_entry|
         handler_entry.same_value?(url: url, handler: handler)
       end
-      if @routes.count == 0
-        @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
-      end
+      update_interception_patterns
     end
 
     def route_from_har(har, notFound: nil, update: nil, url: nil)
@@ -436,6 +432,16 @@ module Playwright
       router.add_page_route(self)
     end
 
+    private def async_update_interception_patterns
+      patterns = RouteHandler.prepare_interception_patterns(@routes)
+      @channel.async_send_message_to_server('setNetworkInterceptionPatterns', patterns: patterns)
+    end
+
+    private def update_interception_patterns
+      patterns = RouteHandler.prepare_interception_patterns(@routes)
+      @channel.send_message_to_server('setNetworkInterceptionPatterns', patterns: patterns)
+    end
+
     def screenshot(
       animations: nil,
       caret: nil,

data/lib/playwright/channel_owners/route.rb

@@ -109,7 +109,7 @@ module Playwright
       end
     end
 
-    def fetch(headers: nil, method: nil, postData: nil, url: nil)
+    def fetch(headers: nil, method: nil, postData: nil, url: nil, maxRedirects: nil)
       api_request_context = request.frame.page.context.request
       api_request_context.send(:_inner_fetch,
         request,
@@ -117,6 +117,7 @@ module Playwright
         headers: headers,
         method: method,
         data: postData,
+        maxRedirects: maxRedirects,
       )
     end
 

data/lib/playwright/locator_utils.rb

@@ -111,6 +111,7 @@ module Playwright
 
     # @param text [Regexp|String]
     private def escape_for_attribute_selector_or_regex(text, exact)
+      puts "escape_for_attribute_selector_or_regex #{text}"
       if text.is_a?(Regexp)
         regex = JavaScript::Regex.new(text)
         "/#{regex.source}/#{regex.flag}"
@@ -125,7 +126,7 @@ module Playwright
       # cssEscape(value).replace(/\\ /g, ' ')
       # However, our attribute selectors do not conform to CSS parsing spec,
       # so we escape them differently.
-      _text = text.gsub(/["]/, '\\"')
+      _text = text.gsub(/\\/) { "\\\\" }.gsub(/["]/, '\\"')
       if exact
         "\"#{_text}\""
       else

data/lib/playwright/route_handler.rb

@@ -43,6 +43,10 @@ module Playwright
         end
     end
 
+    def as_pattern
+      @url_matcher.as_pattern
+    end
+
     def match?(url)
       @url_matcher.match?(url)
     end
@@ -66,5 +70,9 @@ module Playwright
         @url_value == url
       end
     end
+
+    def self.prepare_interception_patterns(handlers)
+      handlers.map(&:as_pattern).compact
+    end
   end
 end

data/lib/playwright/url_matcher.rb

@@ -7,6 +7,18 @@ module Playwright
       @base_url = base_url
     end
 
+    def as_pattern
+      case @url
+      when String
+        { glob: @url }
+      when Regexp
+        regex = JavaScript::Regex.new(@url)
+        { regexSource: regex.source, regexFlags: regex.flag }
+      else
+        nil
+      end
+    end
+
     def match?(target_url)
       case @url
       when String

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.30.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.30.0'
+  VERSION = '1.31.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.31.1'
 end

data/lib/playwright_api/browser_context.rb

@@ -428,11 +428,6 @@ module Playwright
       wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
-    # @nodoc
-    def enable_debug_console!
-      wrap_impl(@impl.enable_debug_console!)
-    end
-
     # @nodoc
     def browser=(req)
       wrap_impl(@impl.browser=(unwrap_impl(req)))
@@ -443,6 +438,11 @@ module Playwright
       wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
+    # @nodoc
+    def enable_debug_console!
+      wrap_impl(@impl.enable_debug_console!)
+    end
+
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)

data/lib/playwright_api/locator.rb

@@ -212,7 +212,7 @@ module Playwright
     end
 
     #
-    # Programmaticaly dispatch an event on the matching element.
+    # Programmatically dispatch an event on the matching element.
     #
     # **Usage**
     #
@@ -792,7 +792,7 @@ module Playwright
     end
 
     #
-    # Focuses the mathing element and presses a combintation of the keys.
+    # Focuses the matching element and presses a combination of the keys.
     #
     # **Usage**
     #

data/lib/playwright_api/page.rb

@@ -1292,7 +1292,7 @@ module Playwright
     # When all steps combined have not finished during the specified `timeout`, this method throws a
     # `TimeoutError`. Passing zero timeout disables this.
     #
-    # **NOTE**: [`method: Page.tap`] requires that the `hasTouch` option of the browser context be set to true.
+    # **NOTE**: [`method: Page.tap`] the method will throw if `hasTouch` option of the browser context is false.
     def tap_point(
           selector,
           force: nil,

data/lib/playwright_api/route.rb

@@ -29,6 +29,10 @@ module Playwright
     #
     # page.route("**/*", handle)
     # ```
+    #
+    # **Details**
+    #
+    # Note that any overrides such as `url` or `headers` only apply to the request being routed. If this request results in a redirect, overrides will not be applied to the new redirected request. If you want to propagate a header through redirects, use the combination of [`method: Route.fetch`] and [`method: Route.fulfill`] instead.
     def continue(headers: nil, method: nil, postData: nil, url: nil)
       wrap_impl(@impl.continue(headers: unwrap_impl(headers), method: unwrap_impl(method), postData: unwrap_impl(postData), url: unwrap_impl(url)))
     end
@@ -106,8 +110,17 @@ module Playwright
     #
     # page.route("https://dog.ceo/api/breeds/list/all", handle)
     # ```
-    def fetch(headers: nil, method: nil, postData: nil, url: nil)
-      wrap_impl(@impl.fetch(headers: unwrap_impl(headers), method: unwrap_impl(method), postData: unwrap_impl(postData), url: unwrap_impl(url)))
+    #
+    # **Details**
+    #
+    # Note that `headers` option will apply to the fetched request as well as any redirects initiated by it. If you want to only apply `headers` to the original request, but not to redirects, look into [`method: Route.continue`] instead.
+    def fetch(
+          headers: nil,
+          maxRedirects: nil,
+          method: nil,
+          postData: nil,
+          url: nil)
+      wrap_impl(@impl.fetch(headers: unwrap_impl(headers), maxRedirects: unwrap_impl(maxRedirects), method: unwrap_impl(method), postData: unwrap_impl(postData), url: unwrap_impl(url)))
     end
 
     #

data/lib/playwright_api/selectors.rb

@@ -4,6 +4,8 @@ module Playwright
   # information.
   class Selectors < PlaywrightApi
 
+    #
+    # Selectors must be registered before creating the page.
     #
     # **Usage**
     #
@@ -33,8 +35,8 @@ module Playwright
     #
     #     # Use the selector prefixed with its name.
     #     button = page.locator('tag=button')
-    #     # Combine it with other selector engines.
-    #     page.locator('tag=div >> text="Click me"').click()
+    #     # Combine it with built-in locators.
+    #     page.locator('tag=div').get_by_text('Click me').click()
     #     # Can use it in any methods supporting selectors.
     #     button_count = page.locator('tag=button').count()
     #     print(button_count)
@@ -43,8 +45,8 @@ module Playwright
     # with sync_playwright() as playwright:
     #     run(playwright)
     # ```
-    def register(name, contentScript: nil, path: nil, script: nil)
-      wrap_impl(@impl.register(unwrap_impl(name), contentScript: unwrap_impl(contentScript), path: unwrap_impl(path), script: unwrap_impl(script)))
+    def register(name, script: nil, contentScript: nil, path: nil)
+      wrap_impl(@impl.register(unwrap_impl(name), script: unwrap_impl(script), contentScript: unwrap_impl(contentScript), path: unwrap_impl(path)))
     end
 
     #

data/lib/playwright_api/touchscreen.rb

@@ -6,6 +6,8 @@ module Playwright
 
     #
     # Dispatches a `touchstart` and `touchend` event with a single touch at the position (`x`,`y`).
+    #
+    # **NOTE**: [`method: Page.tap`] the method will throw if `hasTouch` option of the browser context is false.
     def tap_point(x, y)
       wrap_impl(@impl.tap_point(unwrap_impl(x), unwrap_impl(y)))
     end

data/sig/playwright.rbs

@@ -47,7 +47,7 @@ module Playwright
     def abort: (?errorCode: String) -> void
     def continue: (?headers: Hash[untyped, untyped], ?method: String, ?postData: (String | String | untyped), ?url: String) -> void
     def fallback: (?headers: Hash[untyped, untyped], ?method: String, ?postData: (String | String | untyped), ?url: String) -> void
-    def fetch: (?headers: Hash[untyped, untyped], ?method: String, ?postData: (String | String | untyped), ?url: String) -> APIResponse
+    def fetch: (?headers: Hash[untyped, untyped], ?maxRedirects: Integer, ?method: String, ?postData: (String | String | untyped), ?url: String) -> APIResponse
     def fulfill: (?body: (String | String), ?contentType: String, ?headers: Hash[untyped, untyped], ?json: untyped, ?path: (String | File), ?response: APIResponse, ?status: Integer) -> void
     def request: -> Request
   end
@@ -217,7 +217,7 @@ module Playwright
   end
 
   class Selectors
-    def register: (String name, ?contentScript: bool, ?path: (String | File), ?script: String) -> void
+    def register: (String name, ?script: String, ?contentScript: bool, ?path: (String | File)) -> void
   end
 
   class ConsoleMessage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.30.0
+  version: 1.31.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-25 00:00:00.000000000 Z
+date: 2023-03-02 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.30.0
+summary: The Ruby binding of playwright driver 1.31.1
 test_files: []