playwright-ruby-client 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e87b002bd3cd1dfaf592f6be37902b0a0604553d419b8b7516e0e887584125a
-  data.tar.gz: 5b956c57000f12dc8399df4382dd301a7ef1d47551782afff0fae0871892c630
+  metadata.gz: 8d7e01f93c5fa8ffd804062e0414e9de40204674ef1b070f296c0108259ca015
+  data.tar.gz: 75bdb822a5c3cc8ffe7e8dc011d8697c2cb00aa95895e7486068c09839a9c667
 SHA512:
-  metadata.gz: e3a418d6d40392a157016b164455e8cdc83bffb696c182d68d2ce10cb1e7315be151fb4be78e5b985871ba75ef1882be262d05c93a0b3a65a3c3b8b9c7373fb2
-  data.tar.gz: db086e5ff1cdbc8cee9d1aea80601e2f9664c4806478aa556fd91e6b647bc71d23b9f0862ed60711365e06e67d513717c5e01b3d7b60c1a5b9438535ef8394e5
+  metadata.gz: 9499d48e15c5201718f8e4569f1e28b5f66d2bd14c11b4c3a1c98c4e4ca2c39ababc74b3af1db1e2bcabbc4234fd6034eaa0c71b09b925654c468fdf65dd0547
+  data.tar.gz: 622a2e2bd96af9e65255b1abdb52f5768091af4cc8d5a6368b60237e363a8cd3bdbc1673ef1d745d017583206b6d8011f92300228b27a14e69bdc6558392de30

data/documentation/docs/api/accessibility.md

@@ -4,6 +4,10 @@ sidebar_position: 10
 
 # Accessibility
 
+**DEPRECATED** This class is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
+need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
+integration with Axe.
+
 The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by
 assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or
 [switches](https://en.wikipedia.org/wiki/Switch_access).
@@ -24,6 +28,10 @@ only the "interesting" nodes of the tree.
 def snapshot(interestingOnly: nil, root: nil)
 ```
 
+**DEPRECATED** This method is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
+need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
+integration with Axe.
+
 Captures the current state of the accessibility tree. The returned object represents the root accessible node of the
 page.
 

data/documentation/docs/api/api_request_context.md

@@ -13,14 +13,14 @@ possible to create a new APIRequestContext instance manually by calling [APIRequ
 
 **Cookie management**
 
-[APIRequestContext](./api_request_context) retuned by [BrowserContext#request](./browser_context#request) and [Page#request](./page#request) shares cookie storage
-with the corresponding [BrowserContext](./browser_context). Each API request will have `Cookie` header populated with the values from the
-browser context. If the API response contains `Set-Cookie` header it will automatically update [BrowserContext](./browser_context) cookies
-and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be
-logged in and vice versa.
-
-If you want API requests to not interfere with the browser cookies you shoud create a new [APIRequestContext](./api_request_context) by calling
-[APIRequest#new_context](./api_request#new_context). Such [APIRequestContext](./api_request_context) object will have its own isolated cookie storage.
+[APIRequestContext](./api_request_context) returned by [BrowserContext#request](./browser_context#request) and [Page#request](./page#request) shares cookie
+storage with the corresponding [BrowserContext](./browser_context). Each API request will have `Cookie` header populated with the values
+from the browser context. If the API response contains `Set-Cookie` header it will automatically update [BrowserContext](./browser_context)
+cookies and requests made from the page will pick them up. This means that if you log in using this API, your e2e test
+will be logged in and vice versa.
+
+If you want API requests to not interfere with the browser cookies you should create a new [APIRequestContext](./api_request_context) by
+calling [APIRequest#new_context](./api_request#new_context). Such [APIRequestContext](./api_request_context) object will have its own isolated cookie storage.
 
 ```ruby
 playwright.chromium.launch do |browser|

data/documentation/docs/api/browser.md

@@ -125,7 +125,7 @@ def new_context(
 
 Creates a new browser context. It won't share cookies/cache with other browser contexts.
 
-> NOTE: If directly using this method to create [BrowserContext](./browser_context)s, it is best practice to explicilty close the returned
+> NOTE: If directly using this method to create [BrowserContext](./browser_context)s, it is best practice to explicitly close the returned
 context via [BrowserContext#close](./browser_context#close) when your code is done with the [BrowserContext](./browser_context), and before calling
 [Browser#close](./browser#close). This will ensure the `context` is closed gracefully and any artifacts—like HARs and
 videos—are fully flushed and saved.

data/documentation/docs/api/page.md

@@ -1622,6 +1622,10 @@ associated with the page.
 
 ## accessibility
 
+**DEPRECATED** This property is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
+need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
+integration with Axe.
+
 ## keyboard
 
 ## mouse

data/documentation/docs/api/response.md

@@ -44,7 +44,7 @@ Returns the [Frame](./frame) that initiated this response.
 def from_service_worker
 ```
 
-Indicates whether this Response was fullfilled by a Service Worker's Fetch Handler (i.e. via
+Indicates whether this Response was fulfilled by a Service Worker's Fetch Handler (i.e. via
 [FetchEvent.respondWith](https://developer.mozilla.org/en-US/docs/Web/API/FetchEvent/respondWith)).
 
 ## headers

data/lib/playwright/channel_owner.rb

@@ -42,10 +42,16 @@ module Playwright
 
     attr_reader :channel
 
+    private def adopt!(child)
+      unless child.is_a?(ChannelOwner)
+        raise ArgumentError.new("child must be a ChannelOwner: #{child.inspect}")
+      end
+      child.send(:update_parent, self)
+    end
+
     # used only from Connection. Not intended for public use. So keep private.
     private def dispose!
       # Clean up from parent and connection.
-      @parent&.send(:delete_object_from_child, @guid)
       @connection.send(:delete_object_from_channel_owner, @guid)
 
       # Dispose all children.
@@ -65,6 +71,12 @@ module Playwright
     private def after_initialize
     end
 
+    private def update_parent(new_parent)
+      @parent.send(:delete_object_from_child, @guid)
+      new_parent.send(:update_object_from_child, @guid, self)
+      @parent = new_parent
+    end
+
     private def update_object_from_child(guid, child)
       @objects[guid] = child
     end

data/lib/playwright/channel_owners/browser_context.rb

@@ -18,7 +18,7 @@ module Playwright
       @owner_page = nil
 
       @tracing = ChannelOwners::Tracing.from(@initializer['tracing'])
-      @request = ChannelOwners::APIRequestContext.from(@initializer['APIRequestContext'])
+      @request = ChannelOwners::APIRequestContext.from(@initializer['requestContext'])
       @har_recorders = {}
 
       @channel.on('bindingCall', ->(params) { on_binding(ChannelOwners::BindingCall.from(params['binding'])) })

data/lib/playwright/connection.rb

@@ -141,19 +141,25 @@ module Playwright
         return
       end
 
-      if method == "__dispose__"
-        object = @objects[guid]
-        unless object
-          raise "Cannot find object to dispose: #{guid}"
+      object = @objects[guid]
+      unless object
+        raise "Cannot find object to \"#{method}\": #{guid}"
+      end
+
+      if method == "__adopt__"
+        child = @objects[params["guid"]]
+        unless child
+          raise "Unknown new child: #{params['guid']}"
         end
-        object.send(:dispose!)
+        object.send(:adopt!, child)
         return
       end
 
-      object = @objects[guid]
-      unless object
-        raise "Cannot find object to emit \"#{method}\": #{guid}"
+      if method == "__dispose__"
+        object.send(:dispose!)
+        return
       end
+
       object.channel.emit(method, replace_guids_with_channels(params))
     end
 

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.24.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.24.2'
+  VERSION = '1.25.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.25.0'
 end

data/lib/playwright_api/accessibility.rb

@@ -1,4 +1,8 @@
 module Playwright
+  # **DEPRECATED** This class is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
+  # need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
+  # integration with Axe.
+  #
   # The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by
   # assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or
   # [switches](https://en.wikipedia.org/wiki/Switch_access).
@@ -14,6 +18,10 @@ module Playwright
   # only the "interesting" nodes of the tree.
   class Accessibility < PlaywrightApi
 
+    # **DEPRECATED** This method is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
+    # need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
+    # integration with Axe.
+    #
     # Captures the current state of the accessibility tree. The returned object represents the root accessible node of the
     # page.
     #

data/lib/playwright_api/api_request_context.rb

@@ -8,14 +8,14 @@ module Playwright
   #
   # **Cookie management**
   #
-  # `APIRequestContext` retuned by [`property: BrowserContext.request`] and [`property: Page.request`] shares cookie storage
-  # with the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the values from the
-  # browser context. If the API response contains `Set-Cookie` header it will automatically update `BrowserContext` cookies
-  # and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be
-  # logged in and vice versa.
+  # `APIRequestContext` returned by [`property: BrowserContext.request`] and [`property: Page.request`] shares cookie
+  # storage with the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the values
+  # from the browser context. If the API response contains `Set-Cookie` header it will automatically update `BrowserContext`
+  # cookies and requests made from the page will pick them up. This means that if you log in using this API, your e2e test
+  # will be logged in and vice versa.
   #
-  # If you want API requests to not interfere with the browser cookies you shoud create a new `APIRequestContext` by calling
-  # [`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie storage.
+  # If you want API requests to not interfere with the browser cookies you should create a new `APIRequestContext` by
+  # calling [`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie storage.
   #
   # ```python sync
   # import os
@@ -28,7 +28,7 @@ module Playwright
   # with sync_playwright() as p:
   #     # 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.
+  #     # it will automatically set the cookies to the browser page and vice versa.
   #     browser = p.chromium.launch()
   #     context = browser.new_context(base_url="https://api.github.com")
   #     api_request_context = context.request

data/lib/playwright_api/browser.rb

@@ -64,7 +64,7 @@ module Playwright
 
     # Creates a new browser context. It won't share cookies/cache with other browser contexts.
     #
-    # > NOTE: If directly using this method to create `BrowserContext`s, it is best practice to explicilty close the returned
+    # > NOTE: If directly using this method to create `BrowserContext`s, it is best practice to explicitly close the returned
     # context via [`method: BrowserContext.close`] when your code is done with the `BrowserContext`, and before calling
     # [`method: Browser.close`]. This will ensure the `context` is closed gracefully and any artifacts—like HARs and
     # videos—are fully flushed and saved.

data/lib/playwright_api/browser_type.rb

@@ -18,7 +18,9 @@ module Playwright
   # ```
   class BrowserType < PlaywrightApi
 
-    # This method attaches Playwright to an existing browser instance.
+    # 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)
       raise NotImplementedError.new('connect is not implemented yet.')
     end

data/lib/playwright_api/page.rb

@@ -44,6 +44,9 @@ module Playwright
   # ```
   class Page < PlaywrightApi
 
+    # **DEPRECATED** This property is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
+    # need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
+    # integration with Axe.
     def accessibility # property
       wrap_impl(@impl.accessibility)
     end
@@ -1410,13 +1413,13 @@ 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 guid
+      wrap_impl(@impl.guid)
     end
 
     # @nodoc
-    def guid
-      wrap_impl(@impl.guid)
+    def start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      wrap_impl(@impl.start_js_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
     # @nodoc

data/lib/playwright_api/response.rb

@@ -22,7 +22,7 @@ module Playwright
       wrap_impl(@impl.frame)
     end
 
-    # Indicates whether this Response was fullfilled by a Service Worker's Fetch Handler (i.e. via
+    # Indicates whether this Response was fulfilled by a Service Worker's Fetch Handler (i.e. via
     # [FetchEvent.respondWith](https://developer.mozilla.org/en-US/docs/Web/API/FetchEvent/respondWith)).
     def from_service_worker
       wrap_impl(@impl.from_service_worker)

data/lib/playwright_api/worker.rb

@@ -44,13 +44,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.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-13 00:00:00.000000000 Z
+date: 2022-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -399,5 +399,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.24.2
+summary: The Ruby binding of playwright driver 1.25.0
 test_files: []