playwright-ruby-client 0.0.3 → 0.0.8

data/lib/playwright_api/browser_type.rb

@@ -1,5 +1,7 @@
 module Playwright
-  # BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a typical example of using Playwright to drive automation:
+  # BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a
+  # typical example of using Playwright to drive automation:
+  # 
   #
   # ```js
   # const { chromium } = require('playwright');  // Or 'firefox' or 'webkit'.
@@ -12,6 +14,39 @@ module Playwright
   #   await browser.close();
   # })();
   # ```
+  # 
+  # ```python async
+  # import asyncio
+  # from playwright.async_api import async_playwright
+  # 
+  # async def run(playwright):
+  #     chromium = playwright.chromium
+  #     browser = await chromium.launch()
+  #     page = await browser.new_page()
+  #     await page.goto("https://example.com")
+  #     # other actions...
+  #     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):
+  #     chromium = playwright.chromium
+  #     browser = chromium.launch()
+  #     page = browser.new_page()
+  #     page.goto("https://example.com")
+  #     # other actions...
+  #     browser.close()
+  # 
+  # with sync_playwright() as playwright:
+  #     run(playwright)
+  # ```
   class BrowserType < PlaywrightApi
 
     # This methods attaches Playwright to an existing browser instance.
@@ -21,11 +56,13 @@ module Playwright
 
     # A path where Playwright expects to find a bundled browser executable.
     def executable_path
-      wrap_channel_owner(@channel_owner.executable_path)
+      wrap_impl(@impl.executable_path)
     end
 
     # Returns the browser instance.
+    # 
     # You can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:
+    # 
     #
     # ```js
     # const browser = await chromium.launch({  // Or 'firefox' or 'webkit'.
@@ -33,76 +70,103 @@ module Playwright
     # });
     # ```
     # 
-    # **Chromium-only** Playwright can also be used to control the Chrome browser, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use `executablePath` option with extreme caution.
-    # If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested.
-    # In `browserType.launch([options])` above, any mention of Chromium also applies to Chrome.
-    # See `this article` for a description of the differences between Chromium and Chrome. `This article` describes some differences for Linux users.
+    # ```python async
+    # browser = await playwright.chromium.launch( # or "firefox" or "webkit".
+    #     ignore_default_args=["--mute-audio"]
+    # )
+    # ```
+    # 
+    # ```python sync
+    # browser = playwright.chromium.launch( # or "firefox" or "webkit".
+    #     ignore_default_args=["--mute-audio"]
+    # )
+    # ```
+    # 
+    # > **Chromium-only** Playwright can also be used to control the Chrome browser, but it works best with the version of
+    # Chromium it is bundled with. There is no guarantee it will work with any other version. Use `executablePath` option with
+    # extreme caution.
+    # >
+    # > If Google Chrome (rather than Chromium) is preferred, a
+    # [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or
+    # [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested.
+    # >
+    # > In [`method: BrowserType.launch`] above, any mention of Chromium also applies to Chrome.
+    # >
+    # > See [`this article`](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for
+    # a description of the differences between Chromium and Chrome.
+    # [`This article`](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md)
+    # describes some differences for Linux users.
     def launch(
-          headless: nil,
-          executablePath: nil,
           args: nil,
-          ignoreDefaultArgs: nil,
-          proxy: nil,
-          downloadsPath: nil,
           chromiumSandbox: nil,
+          devtools: nil,
+          downloadsPath: nil,
+          env: nil,
+          executablePath: nil,
           firefoxUserPrefs: nil,
+          handleSIGHUP: nil,
           handleSIGINT: nil,
           handleSIGTERM: nil,
-          handleSIGHUP: nil,
+          headless: nil,
+          ignoreDefaultArgs: nil,
           logger: nil,
-          timeout: nil,
-          env: nil,
-          devtools: nil,
+          proxy: nil,
           slowMo: nil,
+          timeout: nil,
           &block)
-      wrap_channel_owner(@channel_owner.launch(headless: headless, executablePath: executablePath, args: args, ignoreDefaultArgs: ignoreDefaultArgs, proxy: proxy, downloadsPath: downloadsPath, chromiumSandbox: chromiumSandbox, firefoxUserPrefs: firefoxUserPrefs, handleSIGINT: handleSIGINT, handleSIGTERM: handleSIGTERM, handleSIGHUP: handleSIGHUP, logger: logger, timeout: timeout, env: env, devtools: devtools, slowMo: slowMo, &wrap_block_call(block)))
+      wrap_impl(@impl.launch(args: unwrap_impl(args), 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), logger: unwrap_impl(logger), proxy: unwrap_impl(proxy), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
     # Returns the persistent browser context instance.
-    # Launches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing this context will automatically close the browser.
+    # 
+    # Launches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing this
+    # context will automatically close the browser.
     def launch_persistent_context(
           userDataDir,
-          headless: nil,
-          executablePath: nil,
+          acceptDownloads: nil,
           args: nil,
-          ignoreDefaultArgs: nil,
-          proxy: nil,
-          downloadsPath: nil,
+          bypassCSP: nil,
           chromiumSandbox: nil,
+          colorScheme: nil,
+          deviceScaleFactor: nil,
+          devtools: nil,
+          downloadsPath: nil,
+          env: nil,
+          executablePath: nil,
+          extraHTTPHeaders: nil,
+          geolocation: nil,
+          handleSIGHUP: nil,
           handleSIGINT: nil,
           handleSIGTERM: nil,
-          handleSIGHUP: nil,
-          timeout: nil,
-          env: nil,
-          devtools: nil,
-          slowMo: nil,
-          acceptDownloads: nil,
+          hasTouch: nil,
+          headless: nil,
+          httpCredentials: nil,
+          ignoreDefaultArgs: nil,
           ignoreHTTPSErrors: nil,
-          bypassCSP: nil,
-          viewport: nil,
-          userAgent: nil,
-          deviceScaleFactor: nil,
           isMobile: nil,
-          hasTouch: nil,
           javaScriptEnabled: nil,
-          timezoneId: nil,
-          geolocation: nil,
           locale: nil,
-          permissions: nil,
-          extraHTTPHeaders: nil,
-          offline: nil,
-          httpCredentials: nil,
-          colorScheme: nil,
           logger: nil,
-          videosPath: nil,
-          videoSize: nil,
+          offline: nil,
+          permissions: nil,
+          proxy: nil,
           recordHar: nil,
-          recordVideo: nil)
+          recordVideo: nil,
+          slowMo: nil,
+          timeout: nil,
+          timezoneId: nil,
+          userAgent: nil,
+          videoSize: nil,
+          videosPath: nil,
+          viewport: nil)
       raise NotImplementedError.new('launch_persistent_context is not implemented yet.')
     end
 
     # Returns the browser app instance.
-    # Launches browser server that client can connect to. An example of launching a browser executable and connecting to it later:
+    # 
+    # Launches browser server that client can connect to. An example of launching a browser executable and connecting to it
+    # later:
+    # 
     #
     # ```js
     # const { chromium } = require('playwright');  // Or 'webkit' or 'firefox'.
@@ -117,28 +181,46 @@ module Playwright
     # })();
     # ```
     def launch_server(
-          headless: nil,
-          port: nil,
-          executablePath: nil,
           args: nil,
-          ignoreDefaultArgs: nil,
-          proxy: nil,
-          downloadsPath: nil,
           chromiumSandbox: nil,
+          devtools: nil,
+          downloadsPath: nil,
+          env: nil,
+          executablePath: nil,
           firefoxUserPrefs: nil,
+          handleSIGHUP: nil,
           handleSIGINT: nil,
           handleSIGTERM: nil,
-          handleSIGHUP: nil,
+          headless: nil,
+          ignoreDefaultArgs: nil,
           logger: nil,
-          timeout: nil,
-          env: nil,
-          devtools: nil)
+          port: nil,
+          proxy: nil,
+          timeout: nil)
       raise NotImplementedError.new('launch_server is not implemented yet.')
     end
 
     # Returns browser name. For example: `'chromium'`, `'webkit'` or `'firefox'`.
     def name
-      wrap_channel_owner(@channel_owner.name)
+      wrap_impl(@impl.name)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
     end
   end
 end

data/lib/playwright_api/cdp_session.rb

@@ -1,13 +1,15 @@
 module Playwright
-  # The `CDPSession` instances are used to talk raw Chrome Devtools Protocol:
+  # - extends: [EventEmitter]
   # 
-  # protocol methods can be called with `session.send` method.
-  # protocol events can be subscribed to with `session.on` method.
+  # The `CDPSession` instances are used to talk raw Chrome Devtools Protocol:
+  # - protocol methods can be called with `session.send` method.
+  # - protocol events can be subscribed to with `session.on` method.
   # 
   # Useful links:
-  # 
-  # Documentation on DevTools Protocol can be found here: DevTools Protocol Viewer.
-  # Getting Started with DevTools Protocol: https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
+  # - Documentation on DevTools Protocol can be found here:
+  #   [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).
+  # - Getting Started with DevTools Protocol:
+  #   https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
   # 
   #
   # ```js
@@ -20,9 +22,32 @@ module Playwright
   #   playbackRate: response.playbackRate / 2
   # });
   # ```
+  # 
+  # ```python async
+  # client = await page.context().new_cdp_session(page)
+  # await client.send("animation.enable")
+  # client.on("animation.animation_created", lambda: print("animation created!"))
+  # response = await client.send("animation.get_playback_rate")
+  # print("playback rate is " + response["playback_rate"])
+  # await client.send("animation.set_playback_rate", {
+  #     playback_rate: response["playback_rate"] / 2
+  # })
+  # ```
+  # 
+  # ```python sync
+  # client = page.context().new_cdp_session(page)
+  # client.send("animation.enable")
+  # client.on("animation.animation_created", lambda: print("animation created!"))
+  # response = client.send("animation.get_playback_rate")
+  # print("playback rate is " + response["playback_rate"])
+  # client.send("animation.set_playback_rate", {
+  #     playback_rate: response["playback_rate"] / 2
+  # })
+  # ```
   class CDPSession < PlaywrightApi
 
-    # Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used to send messages.
+    # Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used to
+    # send messages.
     def detach
       raise NotImplementedError.new('detach is not implemented yet.')
     end

data/lib/playwright_api/chromium_browser_context.rb

@@ -1,11 +1,24 @@
 require_relative './browser_context.rb'
 
 module Playwright
+  # - extends: `BrowserContext`
+  # 
   # Chromium-specific features including background pages, service worker support, etc.
+  # 
   #
   # ```js
   # const backgroundPage = await context.waitForEvent('backgroundpage');
   # ```
+  # 
+  # ```python async
+  # # FIXME
+  # background_page = await context.wait_for_event("backgroundpage")
+  # ```
+  # 
+  # ```python sync
+  # # FIXME
+  # background_page = context.wait_for_event("backgroundpage")
+  # ```
   class ChromiumBrowserContext < BrowserContext
 
     # All existing background pages in the context.
@@ -22,5 +35,23 @@ module Playwright
     def service_workers
       raise NotImplementedError.new('service_workers is not implemented yet.')
     end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
+    end
   end
 end

data/lib/playwright_api/console_message.rb

@@ -1,22 +1,42 @@
 module Playwright
-  # ConsoleMessage objects are dispatched by page via the page.on('console') event.
+  # `ConsoleMessage` objects are dispatched by page via the [`event: Page.console`] event.
   class ConsoleMessage < PlaywrightApi
 
     def args
-      raise NotImplementedError.new('args is not implemented yet.')
+      wrap_impl(@impl.args)
     end
 
     def location
-      raise NotImplementedError.new('location is not implemented yet.')
+      wrap_impl(@impl.location)
     end
 
     def text
-      raise NotImplementedError.new('text is not implemented yet.')
+      wrap_impl(@impl.text)
     end
 
-    # One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`, `'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`, `'count'`, `'timeEnd'`.
-    def type_text
-      raise NotImplementedError.new('type_text is not implemented yet.')
+    # One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`,
+    # `'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`,
+    # `'count'`, `'timeEnd'`.
+    def type
+      wrap_impl(@impl.type)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
     end
   end
 end

data/lib/playwright_api/dialog.rb

@@ -1,6 +1,8 @@
 module Playwright
-  # Dialog objects are dispatched by page via the page.on('dialog') event.
+  # `Dialog` objects are dispatched by page via the [`event: Page.dialog`] event.
+  # 
   # An example of using `Dialog` class:
+  # 
   #
   # ```js
   # const { chromium } = require('playwright');  // Or 'firefox' or 'webkit'.
@@ -16,6 +18,48 @@ module Playwright
   #   page.evaluate(() => alert('1'));
   # })();
   # ```
+  # 
+  # ```python async
+  # import asyncio
+  # from playwright.async_api import async_playwright
+  # 
+  # async def handle_dialog(dialog):
+  #     print(dialog.message)
+  #     await dialog.dismiss()
+  # 
+  # async def run(playwright):
+  #     chromium = playwright.chromium
+  #     browser = await chromium.launch()
+  #     page = await browser.new_page()
+  #     page.on("dialog", handle_dialog)
+  #     page.evaluate("alert('1')")
+  #     await browser.close()
+  # 
+  # async def main():
+  #     async with async_playwright() as playwright:
+  #         await run(playwright)
+  # asyncio.run(main())
+  # ```
+  # 
+  # ```python sync
+  # # FIXME
+  # from playwright.sync_api import sync_playwright
+  # 
+  # def handle_dialog(dialog):
+  #     print(dialog.message)
+  #     dialog.dismiss()
+  # 
+  # def run(playwright):
+  #     chromium = playwright.chromium
+  #     browser = chromium.launch()
+  #     page = browser.new_page()
+  #     page.on("dialog", handle_dialog)
+  #     page.evaluate("alert('1')")
+  #     browser.close()
+  # 
+  # with sync_playwright() as playwright:
+  #     run(playwright)
+  # ```
   class Dialog < PlaywrightApi
 
     # Returns when the dialog has been accepted.
@@ -39,8 +83,8 @@ module Playwright
     end
 
     # Returns dialog's type, can be one of `alert`, `beforeunload`, `confirm` or `prompt`.
-    def type_text
-      raise NotImplementedError.new('type_text is not implemented yet.')
+    def type
+      raise NotImplementedError.new('type is not implemented yet.')
     end
   end
 end