playwright-ruby-client 1.28.1 → 1.29.1.alpha1

data/lib/playwright_api/tracing.rb

@@ -1,6 +1,6 @@
 module Playwright
-  # API for collecting and saving Playwright traces. Playwright traces can be opened in [Trace Viewer](../trace-viewer.md)
-  # after Playwright script runs.
+  #
+  # API for collecting and saving Playwright traces. Playwright traces can be opened in [Trace Viewer](../trace-viewer.md) after Playwright script runs.
   #
   # Start recording a trace before performing actions. At the end, stop tracing and save it to a file.
   #
@@ -14,8 +14,11 @@ module Playwright
   # ```
   class Tracing < PlaywrightApi
 
+    #
     # Start tracing.
     #
+    # **Usage**
+    #
     # ```python sync
     # context.tracing.start(name="trace", screenshots=True, snapshots=True)
     # page = context.new_page()
@@ -31,9 +34,10 @@ module Playwright
       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
-    # [`method: Tracing.start`] once, and then create multiple trace chunks with [`method: Tracing.startChunk`] and
-    # [`method: Tracing.stopChunk`].
+    #
+    # Start a new trace chunk. If you'd like to record multiple traces on the same `BrowserContext`, use [`method: Tracing.start`] once, and then create multiple trace chunks with [`method: Tracing.startChunk`] and [`method: Tracing.stopChunk`].
+    #
+    # **Usage**
     #
     # ```python sync
     # context.tracing.start(name="trace", screenshots=True, snapshots=True)
@@ -54,11 +58,13 @@ module Playwright
       wrap_impl(@impl.start_chunk(title: unwrap_impl(title)))
     end
 
+    #
     # Stop tracing.
     def stop(path: nil)
       wrap_impl(@impl.stop(path: unwrap_impl(path)))
     end
 
+    #
     # Stop the trace chunk. See [`method: Tracing.startChunk`] for more details about multiple trace chunks.
     def stop_chunk(path: nil)
       wrap_impl(@impl.stop_chunk(path: unwrap_impl(path)))
@@ -66,20 +72,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/web_socket.rb

@@ -1,48 +1,53 @@
 module Playwright
+  #
   # The `WebSocket` class represents websocket connections in the page.
   class WebSocket < PlaywrightApi
 
+    #
     # Indicates that the web socket has been closed.
     def closed?
       wrap_impl(@impl.closed?)
     end
 
+    #
     # Contains the URL of the WebSocket.
     def url
       wrap_impl(@impl.url)
     end
 
+    #
     # Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
     # value. Will throw an error if the webSocket is closed before the event is fired. Returns the event data value.
     def expect_event(event, predicate: nil, timeout: nil, &block)
       wrap_impl(@impl.expect_event(unwrap_impl(event), predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
-    # > NOTE: In most cases, you should use [`method: WebSocket.waitForEvent`].
     #
-    # Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function and
-    # waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
-    # fired.
+    # **NOTE**: In most cases, you should use [`method: WebSocket.waitForEvent`].
+    #
+    # Waits for given `event` to fire. If predicate is provided, it passes
+    # event's value into the `predicate` function and waits for `predicate(event)` to return a truthy value.
+    # Will throw an error if the socket is closed before the `event` is fired.
     def wait_for_event(event, predicate: nil, timeout: nil, &block)
       wrap_impl(@impl.wait_for_event(unwrap_impl(event), predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/worker.rb

@@ -1,4 +1,5 @@
 module Playwright
+  #
   # The Worker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). `worker`
   # event is emitted on the page object to signal a worker creation. `close` event is emitted on the worker object when the
   # worker is gone.
@@ -16,25 +17,27 @@ module Playwright
   # ```
   class Worker < PlaywrightApi
 
+    #
     # Returns the return value of `expression`.
     #
-    # If the function passed to the [`method: Worker.evaluate`] returns a [Promise], then [`method: Worker.evaluate`] would
-    # wait for the promise to resolve and return its value.
+    # If the function passed to the [`method: Worker.evaluate`] returns a [Promise], then [`method: Worker.evaluate`] would wait for the promise
+    # to resolve and return its value.
     #
-    # If the function passed to the [`method: Worker.evaluate`] returns a non-[Serializable] value, then
-    # [`method: Worker.evaluate`] returns `undefined`. Playwright also supports transferring some additional values that are
-    # not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
+    # If the function passed to the [`method: Worker.evaluate`] returns a non-[Serializable] value, then [`method: Worker.evaluate`] returns `undefined`. Playwright also supports transferring some
+    # additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
     def evaluate(expression, arg: nil)
       wrap_impl(@impl.evaluate(unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
 
+    #
     # Returns the return value of `expression` as a `JSHandle`.
     #
-    # The only difference between [`method: Worker.evaluate`] and [`method: Worker.evaluateHandle`] is that
-    # [`method: Worker.evaluateHandle`] returns `JSHandle`.
+    # The only difference between [`method: Worker.evaluate`] and
+    # [`method: Worker.evaluateHandle`] is that [`method: Worker.evaluateHandle`]
+    # returns `JSHandle`.
     #
-    # If the function passed to the [`method: Worker.evaluateHandle`] returns a [Promise], then
-    # [`method: Worker.evaluateHandle`] would wait for the promise to resolve and return its value.
+    # If the function passed to the [`method: Worker.evaluateHandle`] returns a [Promise], then [`method: Worker.evaluateHandle`] would wait for
+    # the promise to resolve and return its value.
     def evaluate_handle(expression, arg: nil)
       wrap_impl(@impl.evaluate_handle(unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
@@ -43,14 +46,20 @@ module Playwright
       wrap_impl(@impl.url)
     end
 
+    # @nodoc
+    def page=(req)
+      wrap_impl(@impl.page=(unwrap_impl(req)))
+    end
+
     # @nodoc
     def context=(req)
       wrap_impl(@impl.context=(unwrap_impl(req)))
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def page=(req)
-      wrap_impl(@impl.page=(unwrap_impl(req)))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -65,12 +74,6 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/playwright.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject do |f|
       f.match(%r{^(test|spec|features)/}) || f.include?(".git") || f.include?(".circleci") || f.start_with?("development/")
     end
-  end + `find lib/playwright_api -name *.rb -type f`.split("\n")
+  end + `find lib/playwright_api -name *.rb -type f`.split("\n") + `find sig -name *.rbs -type f`.split("\n")
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.4'
   spec.add_dependency 'concurrent-ruby', '>= 1.1.6'
   spec.add_dependency 'mime-types', '>= 3.0'
-  spec.add_development_dependency 'bundler', '~> 2.3.0'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'chunky_png'
   spec.add_development_dependency 'dry-inflector'
   spec.add_development_dependency 'faye-websocket'