playwright-ruby-client 0.6.3 → 0.6.4

data/lib/playwright/channel_owners/browser.rb

@@ -30,24 +30,28 @@ module Playwright
       @contexts << context
       context.browser = self
       context.options = params
+      return context unless block
 
-      if block
-        begin
-          block.call(context)
-        ensure
-          context.close
-        end
-      else
-        context
+      begin
+        block.call(context)
+      ensure
+        context.close
       end
     end
 
-    def new_page(**options)
+    def new_page(**options, &block)
       context = new_context(**options)
       page = context.new_page
       page.owned_context = context
       context.owner_page = page
-      page
+
+      return page unless block
+
+      begin
+        block.call(page)
+      ensure
+        page.close
+      end
     end
 
     def close

data/lib/playwright/channel_owners/browser_context.rb

@@ -113,10 +113,17 @@ module Playwright
     end
 
     # @returns [Playwright::Page]
-    def new_page
+    def new_page(&block)
       raise 'Please use browser.new_context' if @owner_page
       resp = @channel.send_message_to_server('newPage')
-      ChannelOwners::Page.from(resp)
+      page = ChannelOwners::Page.from(resp)
+      return page unless block
+
+      begin
+        block.call(page)
+      ensure
+        page.close
+      end
     end
 
     def cookies(urls: nil)

data/lib/playwright/channel_owners/browser_type.rb

@@ -11,15 +11,12 @@ module Playwright
     def launch(options, &block)
       resp = @channel.send_message_to_server('launch', options.compact)
       browser = ChannelOwners::Browser.from(resp)
+      return browser unless block
 
-      if block
-        begin
-          block.call(browser)
-        ensure
-          browser.close
-        end
-      else
-        browser
+      begin
+        block.call(browser)
+      ensure
+        browser.close
       end
     end
 

data/lib/playwright/tracing_impl.rb

@@ -15,17 +15,17 @@ module Playwright
     end
 
     # Stop tracing.
-    def stop
+    def stop(path: nil)
       @channel.send_message_to_server('tracingStop')
-    end
 
-    def export(path)
-      resp = @channel.send_message_to_server('tracingExport')
-      artifact = ChannelOwners::Artifact.from(resp)
-      # if self._context._browser:
-      #   artifact._is_remote = self._context._browser._is_remote
-      artifact.save_as(path)
-      artifact.delete
+      if path
+        resp = @channel.send_message_to_server('tracingExport')
+        artifact = ChannelOwners::Artifact.from(resp)
+        # if self._context._browser:
+        #   artifact._is_remote = self._context._browser._is_remote
+        artifact.save_as(path)
+        artifact.delete
+      end
     end
   end
 end

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '0.6.3'
+  VERSION = '0.6.4'
   COMPATIBLE_PLAYWRIGHT_VERSION = '1.12.0'
 end

data/lib/playwright_api/android.rb

@@ -1,12 +1,13 @@
 module Playwright
-  # Playwright has **experimental** support for Android automation. You can access android namespace via:
+  # Playwright has **experimental** support for Android automation. See [here](./mobile.md) for more information. You can
+  # access android namespace via:
   #
   # An example of the Android automation script would be:
   #
   # Note that since you don't need Playwright to install web browsers when testing Android, you can omit browser download
   # via setting the following environment variable when installing Playwright:
   #
-  # ```sh js
+  # ```bash js
   # PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
   # ```
   class Android < PlaywrightApi

data/lib/playwright_api/browser.rb

@@ -125,8 +125,9 @@ module Playwright
           storageState: nil,
           timezoneId: nil,
           userAgent: nil,
-          viewport: nil)
-      wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport)))
+          viewport: nil,
+          &block)
+      wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # > NOTE: Tracing is only supported on Chromium-based browsers.

data/lib/playwright_api/browser_context.rb

@@ -208,8 +208,8 @@ module Playwright
     end
 
     # Creates a new page in the browser context.
-    def new_page
-      wrap_impl(@impl.new_page)
+    def new_page(&block)
+      wrap_impl(@impl.new_page(&wrap_block_call(block)))
     end
 
     # Returns all open pages in the context.

data/lib/playwright_api/browser_type.rb

@@ -83,9 +83,9 @@ module Playwright
           proxy: nil,
           slowMo: nil,
           timeout: nil,
-          traceDir: nil,
+          tracesDir: nil,
           &block)
-      wrap_impl(@impl.launch(args: unwrap_impl(args), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), firefoxUserPrefs: unwrap_impl(firefoxUserPrefs), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), headless: unwrap_impl(headless), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), proxy: unwrap_impl(proxy), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), traceDir: unwrap_impl(traceDir), &wrap_block_call(block)))
+      wrap_impl(@impl.launch(args: unwrap_impl(args), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), firefoxUserPrefs: unwrap_impl(firefoxUserPrefs), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), headless: unwrap_impl(headless), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), proxy: unwrap_impl(proxy), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), tracesDir: unwrap_impl(tracesDir), &wrap_block_call(block)))
     end
 
     # Returns the persistent browser context instance.
@@ -131,7 +131,7 @@ module Playwright
           slowMo: nil,
           timeout: nil,
           timezoneId: nil,
-          traceDir: nil,
+          tracesDir: nil,
           userAgent: nil,
           viewport: nil)
       raise NotImplementedError.new('launch_persistent_context is not implemented yet.')

data/lib/playwright_api/tracing.rb

@@ -5,35 +5,29 @@ module Playwright
   # Start with specifying the folder traces will be stored in:
   #
   # ```python sync
-  # browser = chromium.launch(traceDir='traces')
+  # browser = chromium.launch()
   # context = browser.new_context()
-  # context.tracing.start(name="trace", screenshots=True, snapshots=True)
+  # context.tracing.start(screenshots=True, snapshots=True)
   # page.goto("https://playwright.dev")
-  # context.tracing.stop()
-  # context.tracing.export("trace.zip")
+  # context.tracing.stop(path = "trace.zip")
   # ```
   class Tracing < PlaywrightApi
 
-    # Export trace into the file with the given name. Should be called after the tracing has stopped.
-    def export(path)
-      wrap_impl(@impl.export(unwrap_impl(path)))
-    end
-
     # Start tracing.
     #
     # ```python sync
     # context.tracing.start(name="trace", screenshots=True, snapshots=True)
     # page.goto("https://playwright.dev")
     # context.tracing.stop()
-    # context.tracing.export("trace.zip")
+    # 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
 
     # Stop tracing.
-    def stop
-      wrap_impl(@impl.stop)
+    def stop(path: nil)
+      wrap_impl(@impl.stop(path: unwrap_impl(path)))
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -230,6 +230,7 @@ files:
 - documentation/docs/article/guides/download_playwright_driver.md
 - documentation/docs/article/guides/launch_browser.md
 - documentation/docs/article/guides/rails_integration.md
+- documentation/docs/article/guides/recording_video.md
 - documentation/docs/include/api_coverage.md
 - documentation/docusaurus.config.js
 - documentation/package.json