playwright-ruby-client 1.15.beta1 → 1.15.1

data/lib/playwright_api/locator.rb

@@ -40,6 +40,9 @@ module Playwright
   #
   # # Works because we explicitly tell locator to pick the first element:
   # page.locator('button').first.click()
+  #
+  # # Works because count knows what to do with multiple matches:
+  # page.locator('button').count()
   # ```
   class Locator < PlaywrightApi
 
@@ -435,6 +438,29 @@ module Playwright
       wrap_impl(@impl.select_text(force: unwrap_impl(force), timeout: unwrap_impl(timeout)))
     end
 
+    # This method checks or unchecks an element by performing the following steps:
+    # 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
+    # 1. If the element already has the right checked state, this method returns immediately.
+    # 1. Wait for [actionability](./actionability.md) checks on the matched element, unless `force` option is set. If the
+    #    element is detached during the checks, the whole action is retried.
+    # 1. Scroll the element into view if needed.
+    # 1. Use [`property: Page.mouse`] to click in the center of the element.
+    # 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
+    # 1. Ensure that the element is now checked or unchecked. If not, this method throws.
+    #
+    # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
+    # zero timeout disables this.
+    def set_checked(
+          checked,
+          force: nil,
+          noWaitAfter: nil,
+          position: nil,
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.set_checked(unwrap_impl(checked), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+    end
+    alias_method :checked=, :set_checked
+
     # This method expects `element` to point to an
     # [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input).
     #

data/lib/playwright_api/mouse.rb

@@ -45,5 +45,13 @@ module Playwright
     def up(button: nil, clickCount: nil)
       wrap_impl(@impl.up(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount)))
     end
+
+    # Dispatches a `wheel` event.
+    #
+    # > NOTE: Wheel events may cause scrolling if they are not handled, and this method does not wait for the scrolling to
+    # finish before returning.
+    def wheel(deltaX, deltaY)
+      wrap_impl(@impl.wheel(unwrap_impl(deltaX), unwrap_impl(deltaY)))
+    end
   end
 end

data/lib/playwright_api/page.rb

@@ -284,8 +284,8 @@ module Playwright
     # # → False
     # page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches")
     # ```
-    def emulate_media(colorScheme: nil, media: nil, reducedMotion: nil)
-      wrap_impl(@impl.emulate_media(colorScheme: unwrap_impl(colorScheme), media: unwrap_impl(media), reducedMotion: unwrap_impl(reducedMotion)))
+    def emulate_media(colorScheme: nil, forcedColors: nil, media: nil, reducedMotion: nil)
+      wrap_impl(@impl.emulate_media(colorScheme: unwrap_impl(colorScheme), forcedColors: unwrap_impl(forcedColors), media: unwrap_impl(media), reducedMotion: unwrap_impl(reducedMotion)))
     end
 
     # The method finds an element matching the specified selector within the page and passes it as a first argument to
@@ -818,6 +818,9 @@ module Playwright
     # Once routing is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
     #
     # > NOTE: The handler will only be called for the first url if the response is a redirect.
+    # > NOTE: [`method: Page.route`] will not intercept requests intercepted by Service Worker. See
+    # [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
+    # request interception. Via `await context.addInitScript(() => delete window.navigator.serviceWorker);`
     #
     # An example of a naive handler that aborts all image requests:
     #
@@ -855,8 +858,8 @@ module Playwright
     # To remove a route with its handler you can use [`method: Page.unroute`].
     #
     # > NOTE: Enabling routing disables http cache.
-    def route(url, handler)
-      wrap_impl(@impl.route(unwrap_impl(url), unwrap_impl(handler)))
+    def route(url, handler, times: nil)
+      wrap_impl(@impl.route(unwrap_impl(url), unwrap_impl(handler), times: unwrap_impl(times)))
     end
 
     # Returns the buffer with the captured screenshot.
@@ -905,6 +908,33 @@ module Playwright
       wrap_impl(@impl.select_option(unwrap_impl(selector), element: unwrap_impl(element), index: unwrap_impl(index), value: unwrap_impl(value), label: unwrap_impl(label), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    # This method checks or unchecks an element matching `selector` by performing the following steps:
+    # 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
+    # 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
+    # 1. If the element already has the right checked state, this method returns immediately.
+    # 1. Wait for [actionability](./actionability.md) checks on the matched element, unless `force` option is set. If the
+    #    element is detached during the checks, the whole action is retried.
+    # 1. Scroll the element into view if needed.
+    # 1. Use [`property: Page.mouse`] to click in the center of the element.
+    # 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
+    # 1. Ensure that the element is now checked or unchecked. If not, this method throws.
+    #
+    # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
+    # zero timeout disables this.
+    #
+    # Shortcut for main frame's [`method: Frame.setChecked`].
+    def set_checked(
+          selector,
+          checked,
+          force: nil,
+          noWaitAfter: nil,
+          position: nil,
+          strict: nil,
+          timeout: nil,
+          trial: nil)
+      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
+
     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
@@ -1350,12 +1380,6 @@ module Playwright
       wrap_impl(@impl.guid)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -1368,6 +1392,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/playwright.rb

@@ -91,12 +91,6 @@ module Playwright
       wrap_impl(@impl.electron)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -109,6 +103,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/request.rb

@@ -14,6 +14,11 @@ module Playwright
   # request is  issued to a redirected url.
   class Request < PlaywrightApi
 
+    # An object with all the request HTTP headers associated with this request. The header names are lower-cased.
+    def all_headers
+      wrap_impl(@impl.all_headers)
+    end
+
     # The method returns `null` unless this request has failed, as reported by `requestfailed` event.
     #
     # Example of logging of all the failed requests:
@@ -30,11 +35,22 @@ module Playwright
       wrap_impl(@impl.frame)
     end
 
-    # An object with HTTP headers associated with the request. All header names are lower-case.
+    # **DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [`method: Request.allHeaders`] instead.
     def headers
       wrap_impl(@impl.headers)
     end
 
+    # An array with all the request HTTP headers associated with this request. Unlike [`method: Request.allHeaders`], header
+    # names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+    def headers_array
+      wrap_impl(@impl.headers_array)
+    end
+
+    # Returns the value of the header matching the name. The name is case insensitive.
+    def header_value(name)
+      wrap_impl(@impl.header_value(unwrap_impl(name)))
+    end
+
     # Whether this request is driving frame's navigation.
     def navigation_request?
       wrap_impl(@impl.navigation_request?)
@@ -109,6 +125,11 @@ module Playwright
       wrap_impl(@impl.response)
     end
 
+    # Returns resource size information for given request.
+    def sizes
+      wrap_impl(@impl.sizes)
+    end
+
     # Returns resource timing information for given request. Most of the timing values become available upon the response,
     # `responseEnd` becomes available when request finishes. Find more information at
     # [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
@@ -128,10 +149,9 @@ module Playwright
       wrap_impl(@impl.url)
     end
 
-    # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def header_values(name)
+      wrap_impl(@impl.header_values(unwrap_impl(name)))
     end
 
     # -- inherited from EventEmitter --
@@ -146,6 +166,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/response.rb

@@ -2,12 +2,17 @@ module Playwright
   # `Response` class represents responses which are received by page.
   class Response < PlaywrightApi
 
+    # An object with all the response HTTP headers associated with this response.
+    def all_headers
+      wrap_impl(@impl.all_headers)
+    end
+
     # Returns the buffer with response body.
     def body
       wrap_impl(@impl.body)
     end
 
-    # Waits for this response to finish, returns failure error if request failed.
+    # Waits for this response to finish, returns always `null`.
     def finished
       wrap_impl(@impl.finished)
     end
@@ -17,11 +22,29 @@ module Playwright
       wrap_impl(@impl.frame)
     end
 
-    # Returns the object with HTTP headers associated with the response. All header names are lower-case.
+    # **DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [`method: Response.allHeaders`] instead.
     def headers
       wrap_impl(@impl.headers)
     end
 
+    # An array with all the request HTTP headers associated with this response. Unlike [`method: Response.allHeaders`], header
+    # names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+    def headers_array
+      wrap_impl(@impl.headers_array)
+    end
+
+    # Returns the value of the header matching the name. The name is case insensitive. If multiple headers have the same name
+    # (except `set-cookie`), they are returned as a list separated by `, `. For `set-cookie`, the `\n` separator is used. If
+    # no headers are found, `null` is returned.
+    def header_value(name)
+      wrap_impl(@impl.header_value(unwrap_impl(name)))
+    end
+
+    # Returns all values of the headers matching the name, for example `set-cookie`. The name is case insensitive.
+    def header_values(name)
+      wrap_impl(@impl.header_values(unwrap_impl(name)))
+    end
+
     # Returns the JSON representation of response body.
     #
     # This method will throw if the response body is not parsable via `JSON.parse`.
@@ -74,12 +97,6 @@ module Playwright
       wrap_impl(@impl.ok?)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -92,6 +109,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/route.rb

@@ -56,12 +56,6 @@ module Playwright
       wrap_impl(@impl.request)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -74,6 +68,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/selectors.rb

@@ -43,12 +43,6 @@ module Playwright
       wrap_impl(@impl.register(unwrap_impl(name), contentScript: unwrap_impl(contentScript), path: unwrap_impl(path), script: unwrap_impl(script)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -61,6 +55,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/tracing.rb

@@ -1,13 +1,14 @@
 module Playwright
-  # API for collecting and saving Playwright traces. Playwright traces can be opened using the Playwright CLI 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 with specifying the folder traces will be stored in:
+  # Start recording a trace before performing actions. At the end, stop tracing and save it to a file.
   #
   # ```python sync
   # browser = chromium.launch()
   # context = browser.new_context()
   # context.tracing.start(screenshots=True, snapshots=True)
+  # page = context.new_page()
   # page.goto("https://playwright.dev")
   # context.tracing.stop(path = "trace.zip")
   # ```
@@ -17,17 +18,45 @@ module Playwright
     #
     # ```python sync
     # context.tracing.start(name="trace", screenshots=True, snapshots=True)
+    # page = context.new_page()
     # page.goto("https://playwright.dev")
-    # context.tracing.stop()
     # context.tracing.stop(path = "trace.zip")
     # ```
     def start(name: nil, screenshots: nil, snapshots: nil)
       wrap_impl(@impl.start(name: unwrap_impl(name), screenshots: unwrap_impl(screenshots), snapshots: unwrap_impl(snapshots)))
     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`].
+    #
+    # ```python sync
+    # context.tracing.start(name="trace", screenshots=True, snapshots=True)
+    # page = context.new_page()
+    # page.goto("https://playwright.dev")
+    #
+    # context.tracing.start_chunk()
+    # page.click("text=Get Started")
+    # # Everything between start_chunk and stop_chunk will be recorded in the trace.
+    # context.tracing.stop_chunk(path = "trace1.zip")
+    #
+    # context.tracing.start_chunk()
+    # page.goto("http://example.com")
+    # # Save a second trace file with different actions.
+    # context.tracing.stop_chunk(path = "trace2.zip")
+    # ```
+    def start_chunk
+      wrap_impl(@impl.start_chunk)
+    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)))
+    end
   end
 end

data/lib/playwright_api/web_socket.rb

@@ -27,12 +27,6 @@ module Playwright
       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 on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -45,6 +39,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/worker.rb

@@ -53,12 +53,6 @@ module Playwright
       wrap_impl(@impl.page=(unwrap_impl(req)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
@@ -71,6 +65,12 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.15.beta1
+  version: 1.15.1
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2021-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -224,6 +224,7 @@ files:
 - documentation/docs/api/experimental/android_input.md
 - documentation/docs/api/experimental/android_socket.md
 - documentation/docs/api/experimental/android_web_view.md
+- documentation/docs/api/fetch_request.md
 - documentation/docs/api/file_chooser.md
 - documentation/docs/api/frame.md
 - documentation/docs/api/js_handle.md
@@ -248,6 +249,7 @@ files:
 - documentation/docs/article/guides/launch_browser.md
 - documentation/docs/article/guides/playwright_on_alpine_linux.md
 - documentation/docs/article/guides/rails_integration.md
+- documentation/docs/article/guides/rails_integration_with_null_driver.md
 - documentation/docs/article/guides/recording_video.md
 - documentation/docs/article/guides/semi_automation.md
 - documentation/docs/article/guides/use_storage_state.md
@@ -263,6 +265,7 @@ files:
 - documentation/src/pages/markdown-page.md
 - documentation/static/.nojekyll
 - documentation/static/img/playwright-logo.svg
+- documentation/static/img/playwright-ruby-client.png
 - documentation/static/img/undraw_dropdown_menu.svg
 - documentation/static/img/undraw_web_development.svg
 - documentation/static/img/undraw_windows.svg
@@ -285,6 +288,7 @@ files:
 - lib/playwright/channel_owners/dialog.rb
 - lib/playwright/channel_owners/electron.rb
 - lib/playwright/channel_owners/element_handle.rb
+- lib/playwright/channel_owners/fetch_request.rb
 - lib/playwright/channel_owners/frame.rb
 - lib/playwright/channel_owners/js_handle.rb
 - lib/playwright/channel_owners/page.rb
@@ -313,7 +317,8 @@ files:
 - lib/playwright/locator_impl.rb
 - lib/playwright/mouse_impl.rb
 - lib/playwright/playwright_api.rb
-- lib/playwright/route_handler_entry.rb
+- lib/playwright/raw_headers.rb
+- lib/playwright/route_handler.rb
 - lib/playwright/select_option_values.rb
 - lib/playwright/timeout_settings.rb
 - lib/playwright/touchscreen_impl.rb
@@ -340,6 +345,7 @@ files:
 - lib/playwright_api/dialog.rb
 - lib/playwright_api/download.rb
 - lib/playwright_api/element_handle.rb
+- lib/playwright_api/fetch_request.rb
 - lib/playwright_api/file_chooser.rb
 - lib/playwright_api/frame.rb
 - lib/playwright_api/js_handle.rb
@@ -372,12 +378,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.15.0
+summary: The Ruby binding of playwright driver 1.15.2
 test_files: []