playwright-ruby-client 0.5.8 → 0.6.2

data/lib/playwright/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '0.5.8'
+  VERSION = '0.6.2'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.12.0'
 end

data/lib/playwright_api/accessibility.rb

@@ -2,13 +2,13 @@ module Playwright
   # 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).
-  # 
+  #
   # Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might
   # have wildly different output.
-  # 
+  #
   # Rendering engines of Chromium, Firefox and WebKit have a concept of "accessibility tree", which is then translated into
   # different platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
-  # 
+  #
   # Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific
   # AX-Tree or by assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing
   # only the "interesting" nodes of the tree.
@@ -16,100 +16,19 @@ module Playwright
 
     # Captures the current state of the accessibility tree. The returned object represents the root accessible node of the
     # page.
-    # 
+    #
     # > NOTE: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers.
     # Playwright will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
-    # 
+    #
     # An example of dumping the entire accessibility tree:
-    # 
     #
-    # ```js
-    # const snapshot = await page.accessibility.snapshot();
-    # console.log(snapshot);
-    # ```
-    # 
-    # ```java
-    # String snapshot = page.accessibility().snapshot();
-    # System.out.println(snapshot);
-    # ```
-    # 
-    # ```python async
-    # snapshot = await page.accessibility.snapshot()
-    # print(snapshot)
-    # ```
-    # 
     # ```python sync
     # snapshot = page.accessibility.snapshot()
     # print(snapshot)
     # ```
-    # 
-    # ```csharp
-    # var accessibilitySnapshot = await Page.Accessibility.SnapshotAsync();
-    # Console.WriteLine(accessibilitySnapshot);
-    # ```
-    # 
+    #
     # An example of logging the focused node's name:
-    # 
     #
-    # ```js
-    # const snapshot = await page.accessibility.snapshot();
-    # const node = findFocusedNode(snapshot);
-    # console.log(node && node.name);
-    # 
-    # function findFocusedNode(node) {
-    #   if (node.focused)
-    #     return node;
-    #   for (const child of node.children || []) {
-    #     const foundNode = findFocusedNode(child);
-    #     return foundNode;
-    #   }
-    #   return null;
-    # }
-    # ```
-    # 
-    # ```csharp
-    # Func<AccessibilitySnapshotResult, AccessibilitySnapshotResult> findFocusedNode = root =>
-    # {
-    #     var nodes = new Stack<AccessibilitySnapshotResult>(new[] { root });
-    #     while (nodes.Count > 0)
-    #     {
-    #         var node = nodes.Pop();
-    #         if (node.Focused) return node;
-    #         foreach (var innerNode in node.Children)
-    #         {
-    #             nodes.Push(innerNode);
-    #         }
-    #     }
-    # 
-    #     return null;
-    # };
-    # 
-    # var accessibilitySnapshot = await Page.Accessibility.SnapshotAsync();
-    # var focusedNode = findFocusedNode(accessibilitySnapshot);
-    # if(focusedNode != null)
-    #   Console.WriteLine(focusedNode.Name);
-    # ```
-    # 
-    # ```java
-    # // FIXME
-    # String snapshot = page.accessibility().snapshot();
-    # ```
-    # 
-    # ```python async
-    # def find_focused_node(node):
-    #     if (node.get("focused"))
-    #         return node
-    #     for child in (node.get("children") or []):
-    #         found_node = find_focused_node(child)
-    #         return found_node
-    #     return None
-    # 
-    # snapshot = await page.accessibility.snapshot()
-    # node = find_focused_node(snapshot)
-    # if node:
-    #     print(node["name"])
-    # ```
-    # 
     # ```python sync
     # def find_focused_node(node):
     #     if (node.get("focused"))
@@ -118,7 +37,7 @@ module Playwright
     #         found_node = find_focused_node(child)
     #         return found_node
     #     return None
-    # 
+    #
     # snapshot = page.accessibility.snapshot()
     # node = find_focused_node(snapshot)
     # if node:

data/lib/playwright_api/android.rb

@@ -1,70 +1,13 @@
 module Playwright
   # Playwright has **experimental** support for Android automation. You can access android namespace via:
-  # 
   #
-  # ```js
-  # const { _android: android } = require('playwright');
-  # ```
-  # 
   # An example of the Android automation script would be:
-  # 
   #
-  # ```js
-  # const { _android: android } = require('playwright');
-  # 
-  # (async () => {
-  #   // Connect to the device.
-  #   const [device] = await android.devices();
-  #   console.log(`Model: ${device.model()}`);
-  #   console.log(`Serial: ${device.serial()}`);
-  #   // Take screenshot of the whole device.
-  #   await device.screenshot({ path: 'device.png' });
-  # 
-  #   {
-  #     // --------------------- WebView -----------------------
-  # 
-  #     // Launch an application with WebView.
-  #     await device.shell('am force-stop org.chromium.webview_shell');
-  #     await device.shell('am start org.chromium.webview_shell/.WebViewBrowserActivity');
-  #     // Get the WebView.
-  #     const webview = await device.webView({ pkg: 'org.chromium.webview_shell' });
-  # 
-  #     // Fill the input box.
-  #     await device.fill({ res: 'org.chromium.webview_shell:id/url_field' }, 'github.com/microsoft/playwright');
-  #     await device.press({ res: 'org.chromium.webview_shell:id/url_field' }, 'Enter');
-  # 
-  #     // Work with WebView's page as usual.
-  #     const page = await webview.page();
-  #     await page.waitForNavigation({ url: /.*microsoft\/playwright.*/ });
-  #     console.log(await page.title());
-  #   }
-  # 
-  #   {
-  #     // --------------------- Browser -----------------------
-  # 
-  #     // Launch Chrome browser.
-  #     await device.shell('am force-stop com.android.chrome');
-  #     const context = await device.launchBrowser();
-  # 
-  #     // Use BrowserContext as usual.
-  #     const page = await context.newPage();
-  #     await page.goto('https://webkit.org/');
-  #     console.log(await page.evaluate(() => window.location.href));
-  #     await page.screenshot({ path: 'page.png' });
-  # 
-  #     await context.close();
-  #   }
-  # 
-  #   // Close the device.
-  #   await device.close();
-  # })();
-  # ```
-  # 
   # 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
-  # $ PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
+  # PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
   # ```
   class Android < PlaywrightApi
 

data/lib/playwright_api/android_device.rb

@@ -59,12 +59,13 @@ module Playwright
           record_har_path: nil,
           record_video_dir: nil,
           record_video_size: nil,
+          reducedMotion: nil,
           screen: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), 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), 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), screen: unwrap_impl(screen), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), 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), 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), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # Performs a long tap on the widget defined by `selector`.
@@ -161,13 +162,13 @@ module Playwright
     end
 
     # @nodoc
-    def tap_on(selector, duration: nil, timeout: nil)
-      wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
+    def tree
+      wrap_impl(@impl.tree)
     end
 
     # @nodoc
-    def tree
-      wrap_impl(@impl.tree)
+    def tap_on(selector, duration: nil, timeout: nil)
+      wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/browser.rb

@@ -1,63 +1,18 @@
 module Playwright
   # - extends: [EventEmitter]
-  # 
+  #
   # A Browser is created via [`method: BrowserType.launch`]. An example of using a `Browser` to create a `Page`:
-  # 
   #
-  # ```js
-  # const { firefox } = require('playwright');  // Or 'chromium' or 'webkit'.
-  # 
-  # (async () => {
-  #   const browser = await firefox.launch();
-  #   const page = await browser.newPage();
-  #   await page.goto('https://example.com');
-  #   await browser.close();
-  # })();
-  # ```
-  # 
-  # ```java
-  # import com.microsoft.playwright.*;
-  # 
-  # public class Example {
-  #   public static void main(String[] args) {
-  #     try (Playwright playwright = Playwright.create()) {
-  #       BrowserType firefox = playwright.firefox()
-  #       Browser browser = firefox.launch();
-  #       Page page = browser.newPage();
-  #       page.navigate('https://example.com');
-  #       browser.close();
-  #     }
-  #   }
-  # }
-  # ```
-  # 
-  # ```python async
-  # import asyncio
-  # from playwright.async_api import async_playwright
-  # 
-  # async def run(playwright):
-  #     firefox = playwright.firefox
-  #     browser = await firefox.launch()
-  #     page = await browser.new_page()
-  #     await page.goto("https://example.com")
-  #     await browser.close()
-  # 
-  # async def main():
-  #     async with async_playwright() as playwright:
-  #         await run(playwright)
-  # asyncio.run(main())
-  # ```
-  # 
   # ```python sync
   # from playwright.sync_api import sync_playwright
-  # 
+  #
   # def run(playwright):
   #     firefox = playwright.firefox
   #     browser = firefox.launch()
   #     page = browser.new_page()
   #     page.goto("https://example.com")
   #     browser.close()
-  # 
+  #
   # with sync_playwright() as playwright:
   #     run(playwright)
   # ```
@@ -65,40 +20,17 @@ module Playwright
 
     # In case this browser is obtained using [`method: BrowserType.launch`], closes the browser and all of its pages (if any
     # were opened).
-    # 
+    #
     # In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the
     # browser server.
-    # 
+    #
     # The `Browser` object itself is considered to be disposed and cannot be used anymore.
     def close
       wrap_impl(@impl.close)
     end
 
     # Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.
-    # 
     #
-    # ```js
-    # const browser = await pw.webkit.launch();
-    # console.log(browser.contexts().length); // prints `0`
-    # 
-    # const context = await browser.newContext();
-    # console.log(browser.contexts().length); // prints `1`
-    # ```
-    # 
-    # ```java
-    # Browser browser = pw.webkit().launch();
-    # System.out.println(browser.contexts().size()); // prints "0"
-    # BrowserContext context = browser.newContext();
-    # System.out.println(browser.contexts().size()); // prints "1"
-    # ```
-    # 
-    # ```python async
-    # browser = await pw.webkit.launch()
-    # print(len(browser.contexts())) # prints `0`
-    # context = await browser.new_context()
-    # print(len(browser.contexts())) # prints `1`
-    # ```
-    # 
     # ```python sync
     # browser = pw.webkit.launch()
     # print(len(browser.contexts())) # prints `0`
@@ -115,44 +47,14 @@ module Playwright
     end
 
     # > NOTE: CDP Sessions are only supported on Chromium-based browsers.
-    # 
+    #
     # Returns the newly created browser session.
     def new_browser_cdp_session
       raise NotImplementedError.new('new_browser_cdp_session is not implemented yet.')
     end
 
     # Creates a new browser context. It won't share cookies/cache with other browser contexts.
-    # 
     #
-    # ```js
-    # (async () => {
-    #   const browser = await playwright.firefox.launch();  // Or 'chromium' or 'webkit'.
-    #   // Create a new incognito browser context.
-    #   const context = await browser.newContext();
-    #   // Create a new page in a pristine context.
-    #   const page = await context.newPage();
-    #   await page.goto('https://example.com');
-    # })();
-    # ```
-    # 
-    # ```java
-    # Browser browser = playwright.firefox().launch();  // Or 'chromium' or 'webkit'.
-    # // Create a new incognito browser context.
-    # BrowserContext context = browser.newContext();
-    # // Create a new page in a pristine context.
-    # Page page = context.newPage();
-    # page.navigate('https://example.com');
-    # ```
-    # 
-    # ```python async
-    # browser = await playwright.firefox.launch() # or "chromium" or "webkit".
-    # # create a new incognito browser context.
-    # context = await browser.new_context()
-    # # create a new page in a pristine context.
-    # page = await context.new_page()
-    # await page.goto("https://example.com")
-    # ```
-    # 
     # ```python sync
     # browser = playwright.firefox.launch() # or "chromium" or "webkit".
     # # create a new incognito browser context.
@@ -182,17 +84,18 @@ module Playwright
           record_har_path: nil,
           record_video_dir: nil,
           record_video_size: nil,
+          reducedMotion: nil,
           screen: nil,
           storageState: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.new_context(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), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.new_context(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
 
     # Creates a new page in a new browser context. Closing this page will close the context as well.
-    # 
+    #
     # This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and
     # testing frameworks should explicitly create [`method: Browser.newContext`] followed by the
     # [`method: BrowserContext.newPage`] to control their exact life times.
@@ -217,32 +120,20 @@ module Playwright
           record_har_path: nil,
           record_video_dir: nil,
           record_video_size: nil,
+          reducedMotion: nil,
           screen: nil,
           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), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport)))
+      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)))
     end
 
     # > NOTE: Tracing is only supported on Chromium-based browsers.
-    # 
+    #
     # You can use [`method: Browser.startTracing`] and [`method: Browser.stopTracing`] to create a trace file that can be
     # opened in Chrome DevTools performance panel.
-    # 
     #
-    # ```js
-    # await browser.startTracing(page, {path: 'trace.json'});
-    # await page.goto('https://www.google.com');
-    # await browser.stopTracing();
-    # ```
-    # 
-    # ```python async
-    # await browser.start_tracing(page, path="trace.json")
-    # await page.goto("https://www.google.com")
-    # await browser.stop_tracing()
-    # ```
-    # 
     # ```python sync
     # browser.start_tracing(page, path="trace.json")
     # page.goto("https://www.google.com")
@@ -253,7 +144,7 @@ module Playwright
     end
 
     # > NOTE: Tracing is only supported on Chromium-based browsers.
-    # 
+    #
     # Returns the buffer with trace data.
     def stop_tracing
       wrap_impl(@impl.stop_tracing)