playwright-ruby-client 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac3e5cd3487407baf16ee61f1c08e9a2a20e7463027998218c5466c853c94acf
-  data.tar.gz: add832c083cf0ce9cdf94f044649a815cfee24221385957594f3644264d97327
+  metadata.gz: b77f5e67e8a75aec27eca18c85bcaaf3236fcc0822659de3462a7f4d41d3a1a8
+  data.tar.gz: 7791bc627ddcd7fc39fa36b7ec6f393c855d0cb506b5834922b43f84839dac63
 SHA512:
-  metadata.gz: beb033e38e066d9bf459af794b0112ded024038d7c1903f89902c0d36e9ed0c57191ce72ff2880664719cb333350aa5a85747ab18f5ad113f1b5df2a781c891e
-  data.tar.gz: 5c0723a2d4bd529e30eb78adb5b44bbba44df43d1160ce48c1323aba91e064d05e19ee5fb74c1abe6c1f4ecce127fec297e45fd72172a4bde53add9ffc8376eb
+  metadata.gz: 3ffbf8ebba62b54b51534b5f33f45dd02df9f73824b267500b9265827bb09b01898849fb43c461a2798c276801ae69a6beb52018872c4d7740ba56ff8ab99686
+  data.tar.gz: 8b7acc19dd31389c0ea3361a8be430177d2319ec20284ffac65117a9421810b26808c1ab61bc33298e8bfd89c617772750f7c61b21258aebebd6db7d93598923

data/README.md

@@ -4,17 +4,20 @@
 
 A Ruby client for Playwright driver.
 
+Note: Currently, this Gem is just a PoC (Proof of Concept). If you want to develop browser-automation for Chrome with Ruby, consider using [puppeteer-ruby](https://github.com/YusukeIwaki/puppeteer-ruby)
+
 ## Getting Started
 
 At this point, playwright-ruby-client doesn't include the downloader of playwright-cli, so **we have to install [playwright-cli](https://github.com/microsoft/playwright-cli) in advance**.
 
-via npm: `npm install -g playwright-cli`
-
-or
+```sh
+npm install playwright-cli
+./node_modules/.bin/playwright-cli install
+```
 
-direct download: `wget https://playwright.azureedge.net/builds/cli/next/playwright-cli-0.180.0-next.1608746109749-cbc13bd-mac.zip`
+and then, set `playwright_cli_executable_path: ./node_modules/.bin/playwright-cli` at `Playwright.create`.
 
-(`-mac.zip` should be replaced for another OS)
+Instead of npm install, you can also directly download playwright driver from playwright.azureedge.net/builds/. The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/79f6ce0a6a69c480573372706df84af5ef99c4a4/setup.py#L56-L61)
 
 ### Capture a site
 
@@ -30,16 +33,6 @@ Playwright.create(playwright_cli_executable_path: '/path/to/playwright-cli') do
 end
 ```
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/playwright-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/playwright/channel_owners/browser.rb

@@ -36,8 +36,8 @@ module Playwright
       context
     end
 
-    def new_page(*args)
-      context = new_context(*args)
+    def new_page(**options)
+      context = new_context(**options)
       page = context.new_page
       page.owned_context = context
       context.owner_page = page

data/lib/playwright/channel_owners/console_message.rb

@@ -0,0 +1,25 @@
+module Playwright
+  define_channel_owner :ConsoleMessage do
+    def to_s
+      @initializer['text']
+    end
+
+    def type
+      @initializer['type']
+    end
+
+    def text
+      @initializer['text']
+    end
+
+    def args
+      @initializer['args']&.map do |arg|
+        ChannelOwner.from(arg)
+      end
+    end
+
+    def location
+      @initialize['location']
+    end
+  end
+end

data/lib/playwright/channel_owners/element_handle.rb

@@ -0,0 +1,8 @@
+require_relative './js_handle'
+
+module Playwright
+  module ChannelOwners
+    class ElementHandle < JSHandle
+    end
+  end
+end

data/lib/playwright/channel_owners/js_handle.rb

@@ -0,0 +1,4 @@
+module Playwright
+  define_channel_owner :JSHandle do
+  end
+end

data/lib/playwright/channel_owners/page.rb

@@ -11,18 +11,31 @@ module Playwright
       @mouse = Mouse.new(@channel)
       @touchscreen = Touchscreen.new(@channel)
 
+      @viewport_size = @initializer['viewportSize']
       @main_frame = ChannelOwners::Frame.from(@initializer['mainFrame'])
       @main_frame.send(:update_page_from_page, self)
       @frames = Set.new
       @frames << @main_frame
     end
 
-    attr_reader :accessibility, :keyboard, :mouse, :touchscreen, :main_frame
+    attr_reader \
+      :accessibility,
+      :keyboard,
+      :mouse,
+      :touchscreen,
+      :viewport_size,
+      :main_frame
 
     def goto(url, timeout: nil, waitUntil: nil, referer: nil)
       @main_frame.goto(url, timeout: timeout,  waitUntil: waitUntil, referer: referer)
     end
 
+    def set_viewport_size(viewportSize)
+      @viewport_size = viewportSize
+      @channel.send_message_to_server('setViewportSize', { viewportSize: viewportSize })
+      nil
+    end
+
     def screenshot(
       path: nil,
       type: nil,

data/lib/playwright/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/playwright_api/accessibility.rb

@@ -1,21 +1,35 @@
 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 or switches.
-  # Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might have wildly different output.
-  # Blink - Chromium's rendering engine - has a concept of "accessibility tree", which is then translated into different platform-specific APIs. Accessibility namespace gives users access to the Blink Accessibility Tree.
-  # Most of the accessibility tree gets filtered out when converting from Blink 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.
+  # 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.
+  # 
+  # Blink - Chromium's rendering engine - has a concept of "accessibility tree", which is then translated into different
+  # platform-specific APIs. Accessibility namespace gives users access to the Blink Accessibility Tree.
+  # 
+  # Most of the accessibility tree gets filtered out when converting from Blink 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.
   class Accessibility < PlaywrightApi
 
-    # Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page.
+    # 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`.
+    # > **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);
     # ```
+    # 
     # An example of logging the focused node's name:
+    # 
     #
     # ```js
     # const snapshot = await page.accessibility.snapshot();

data/lib/playwright_api/browser.rb

@@ -1,6 +1,8 @@
 module Playwright
-  # A Browser is created when Playwright connects to a browser instance, either through `browserType.launch([options])` or `browserType.connect(params)`.
-  # An example of using a Browser to create a Page:
+  # - extends: [EventEmitter](https://nodejs.org/api/events.html#events_class_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'.
@@ -12,17 +14,24 @@ module Playwright
   #   await browser.close();
   # })();
   # ```
-  # See ChromiumBrowser, FirefoxBrowser and WebKitBrowser for browser-specific features. Note that `browserType.connect(params)` and `browserType.launch([options])` always return a specific browser instance, based on the browser being connected to or launched.
+  # 
+  # See `ChromiumBrowser`, [FirefoxBrowser] and [WebKitBrowser] for browser-specific features. Note that
+  # [`method: BrowserType.launch`] always returns a specific browser instance, based on the browser being launched.
   class Browser < PlaywrightApi
 
-    # In case this browser is obtained using `browserType.launch([options])`, closes the browser and all of its pages (if any were opened).
-    # In case this browser is obtained using `browserType.connect(params)`, 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.
+    # 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_channel_owner(@channel_owner.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();
@@ -41,6 +50,7 @@ module Playwright
     end
 
     # Creates a new browser context. It won't share cookies/cache with other browser contexts.
+    # 
     #
     # ```js
     # (async () => {
@@ -54,60 +64,63 @@ module Playwright
     # ```
     def new_context(
           acceptDownloads: nil,
-          ignoreHTTPSErrors: nil,
           bypassCSP: nil,
-          viewport: nil,
-          userAgent: nil,
+          colorScheme: nil,
           deviceScaleFactor: nil,
-          isMobile: nil,
+          extraHTTPHeaders: nil,
+          geolocation: nil,
           hasTouch: nil,
+          httpCredentials: nil,
+          ignoreHTTPSErrors: nil,
+          isMobile: 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,
-          proxy: nil,
-          storageState: nil)
-      wrap_channel_owner(@channel_owner.new_context(acceptDownloads: acceptDownloads, ignoreHTTPSErrors: ignoreHTTPSErrors, bypassCSP: bypassCSP, viewport: viewport, userAgent: userAgent, deviceScaleFactor: deviceScaleFactor, isMobile: isMobile, hasTouch: hasTouch, javaScriptEnabled: javaScriptEnabled, timezoneId: timezoneId, geolocation: geolocation, locale: locale, permissions: permissions, extraHTTPHeaders: extraHTTPHeaders, offline: offline, httpCredentials: httpCredentials, colorScheme: colorScheme, logger: logger, videosPath: videosPath, videoSize: videoSize, recordHar: recordHar, recordVideo: recordVideo, proxy: proxy, storageState: storageState))
+          storageState: nil,
+          timezoneId: nil,
+          userAgent: nil,
+          videoSize: nil,
+          videosPath: nil,
+          viewport: nil)
+      wrap_channel_owner(@channel_owner.new_context(acceptDownloads: acceptDownloads, bypassCSP: bypassCSP, colorScheme: colorScheme, deviceScaleFactor: deviceScaleFactor, extraHTTPHeaders: extraHTTPHeaders, geolocation: geolocation, hasTouch: hasTouch, httpCredentials: httpCredentials, ignoreHTTPSErrors: ignoreHTTPSErrors, isMobile: isMobile, javaScriptEnabled: javaScriptEnabled, locale: locale, logger: logger, offline: offline, permissions: permissions, proxy: proxy, recordHar: recordHar, recordVideo: recordVideo, storageState: storageState, timezoneId: timezoneId, userAgent: userAgent, videoSize: videoSize, videosPath: videosPath, viewport: viewport))
     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 `browser.newContext([options])` followed by the `browserContext.newPage()` to control their exact life times.
+    # 
+    # 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.
     def new_page(
           acceptDownloads: nil,
-          ignoreHTTPSErrors: nil,
           bypassCSP: nil,
-          viewport: nil,
-          userAgent: nil,
+          colorScheme: nil,
           deviceScaleFactor: nil,
-          isMobile: nil,
+          extraHTTPHeaders: nil,
+          geolocation: nil,
           hasTouch: nil,
+          httpCredentials: nil,
+          ignoreHTTPSErrors: nil,
+          isMobile: 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,
-          proxy: nil,
-          storageState: nil)
-      wrap_channel_owner(@channel_owner.new_page(acceptDownloads: acceptDownloads, ignoreHTTPSErrors: ignoreHTTPSErrors, bypassCSP: bypassCSP, viewport: viewport, userAgent: userAgent, deviceScaleFactor: deviceScaleFactor, isMobile: isMobile, hasTouch: hasTouch, javaScriptEnabled: javaScriptEnabled, timezoneId: timezoneId, geolocation: geolocation, locale: locale, permissions: permissions, extraHTTPHeaders: extraHTTPHeaders, offline: offline, httpCredentials: httpCredentials, colorScheme: colorScheme, logger: logger, videosPath: videosPath, videoSize: videoSize, recordHar: recordHar, recordVideo: recordVideo, proxy: proxy, storageState: storageState))
+          storageState: nil,
+          timezoneId: nil,
+          userAgent: nil,
+          videoSize: nil,
+          videosPath: nil,
+          viewport: nil)
+      wrap_channel_owner(@channel_owner.new_page(acceptDownloads: acceptDownloads, bypassCSP: bypassCSP, colorScheme: colorScheme, deviceScaleFactor: deviceScaleFactor, extraHTTPHeaders: extraHTTPHeaders, geolocation: geolocation, hasTouch: hasTouch, httpCredentials: httpCredentials, ignoreHTTPSErrors: ignoreHTTPSErrors, isMobile: isMobile, javaScriptEnabled: javaScriptEnabled, locale: locale, logger: logger, offline: offline, permissions: permissions, proxy: proxy, recordHar: recordHar, recordVideo: recordVideo, storageState: storageState, timezoneId: timezoneId, userAgent: userAgent, videoSize: videoSize, videosPath: videosPath, viewport: viewport))
     end
 
     # Returns the browser version.

data/lib/playwright_api/browser_context.rb

@@ -1,7 +1,14 @@
 module Playwright
+  # - extends: [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter)
+  # 
   # BrowserContexts provide a way to operate multiple independent browser sessions.
-  # If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser context.
-  # Playwright allows creation of "incognito" browser contexts with `browser.newContext()` method. "Incognito" browser contexts don't write any browsing data to disk.
+  # 
+  # If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser
+  # context.
+  # 
+  # Playwright allows creation of "incognito" browser contexts with `browser.newContext()` method. "Incognito" browser
+  # contexts don't write any browsing data to disk.
+  # 
   #
   # ```js
   # // Create a new incognito browser context
@@ -14,7 +21,9 @@ module Playwright
   # ```
   class BrowserContext < PlaywrightApi
 
-    # Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be obtained via `browserContext.cookies([urls])`.
+    # Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be
+    # obtained via [`method: BrowserContext.cookies`].
+    # 
     #
     # ```js
     # await browserContext.addCookies([cookieObject1, cookieObject2]);
@@ -24,17 +33,21 @@ module Playwright
     end
 
     # Adds a script which would be evaluated in one of the following scenarios:
+    # - Whenever a page is created in the browser context or is navigated.
+    # - Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is
+    #   evaluated in the context of the newly attached frame.
     # 
-    # Whenever a page is created in the browser context or is navigated.
-    # Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is evaluated in the context of the newly attached frame.
+    # The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend
+    # the JavaScript environment, e.g. to seed `Math.random`.
     # 
-    # The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed `Math.random`.
     # An example of overriding `Math.random` before the page loads:
+    # 
     #
     # ```js
     # // preload.js
     # Math.random = () => 42;
     # ```
+    # 
     #
     # ```js
     # // In your playwright script, assuming the preload.js file is in same directory.
@@ -43,7 +56,8 @@ module Playwright
     # });
     # ```
     # 
-    # **NOTE** The order of evaluation of multiple scripts installed via `browserContext.addInitScript(script[, arg])` and `page.addInitScript(script[, arg])` is not defined.
+    # > **NOTE** The order of evaluation of multiple scripts installed via [`method: BrowserContext.addInitScript`] and
+    # [`method: Page.addInitScript`] is not defined.
     def add_init_script(script, arg: nil)
       raise NotImplementedError.new('add_init_script is not implemented yet.')
     end
@@ -59,6 +73,7 @@ module Playwright
     end
 
     # Clears all permission overrides for the browser context.
+    # 
     #
     # ```js
     # const context = await browser.newContext();
@@ -72,20 +87,28 @@ module Playwright
 
     # Closes the browser context. All the pages that belong to the browser context will be closed.
     # 
-    # **NOTE** the default browser context cannot be closed.
+    # > **NOTE** the default browser context cannot be closed.
     def close
       raise NotImplementedError.new('close is not implemented yet.')
     end
 
-    # If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs are returned.
+    # If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs
+    # are returned.
     def cookies(urls: nil)
       raise NotImplementedError.new('cookies is not implemented yet.')
     end
 
-    # The method adds a function called `name` on the `window` object of every frame in every page in the context. When called, the function executes `playwrightBinding` and returns a Promise which resolves to the return value of `playwrightBinding`. If the `playwrightBinding` returns a Promise, it will be awaited.
-    # The first argument of the `playwrightBinding` function contains information about the caller: `{ browserContext: BrowserContext, page: Page, frame: Frame }`.
-    # See `page.exposeBinding(name, playwrightBinding[, options])` for page-only version.
+    # The method adds a function called `name` on the `window` object of every frame in every page in the context. When
+    # called, the function executes `callback` and returns a [Promise] which resolves to the return value of `callback`. If
+    # the `callback` returns a [Promise], it will be awaited.
+    # 
+    # The first argument of the `callback` function contains information about the caller: `{ browserContext: BrowserContext,
+    # page: Page, frame: Frame }`.
+    # 
+    # See [`method: Page.exposeBinding`] for page-only version.
+    # 
     # An example of exposing page URL to all frames in all pages in the context:
+    # 
     #
     # ```js
     # const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
@@ -107,7 +130,9 @@ module Playwright
     #   await page.click('button');
     # })();
     # ```
+    # 
     # An example of passing an element handle:
+    # 
     #
     # ```js
     # await context.exposeBinding('clicked', async (source, element) => {
@@ -121,14 +146,19 @@ module Playwright
     #   <div>Or click me</div>
     # `);
     # ```
-    def expose_binding(name, playwrightBinding, handle: nil)
+    def expose_binding(name, callback, handle: nil)
       raise NotImplementedError.new('expose_binding is not implemented yet.')
     end
 
-    # The method adds a function called `name` on the `window` object of every frame in every page in the context. When called, the function executes `playwrightFunction` and returns a Promise which resolves to the return value of `playwrightFunction`.
-    # If the `playwrightFunction` returns a Promise, it will be awaited.
-    # See `page.exposeFunction(name, playwrightFunction)` for page-only version.
+    # The method adds a function called `name` on the `window` object of every frame in every page in the context. When
+    # called, the function executes `callback` and returns a [Promise] which resolves to the return value of `callback`.
+    # 
+    # If the `callback` returns a [Promise], it will be awaited.
+    # 
+    # See [`method: Page.exposeFunction`] for page-only version.
+    # 
     # An example of adding an `md5` function to all pages in the context:
+    # 
     #
     # ```js
     # const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
@@ -151,11 +181,12 @@ module Playwright
     #   await page.click('button');
     # })();
     # ```
-    def expose_function(name, playwrightFunction)
+    def expose_function(name, callback)
       raise NotImplementedError.new('expose_function is not implemented yet.')
     end
 
-    # Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if specified.
+    # Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if
+    # specified.
     def grant_permissions(permissions, origin: nil)
       raise NotImplementedError.new('grant_permissions is not implemented yet.')
     end
@@ -165,13 +196,17 @@ module Playwright
       wrap_channel_owner(@channel_owner.new_page)
     end
 
-    # Returns all open pages in the context. Non visible pages, such as `"background_page"`, will not be listed here. You can find them using `chromiumBrowserContext.backgroundPages()`.
+    # Returns all open pages in the context. Non visible pages, such as `"background_page"`, will not be listed here. You can
+    # find them using [`method: ChromiumBrowserContext.backgroundPages`].
     def pages
       raise NotImplementedError.new('pages is not implemented yet.')
     end
 
-    # Routing provides the capability to modify network requests that are made by any page in the browser context. Once route is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
+    # Routing provides the capability to modify network requests that are made by any page in the browser context. Once route
+    # is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
+    # 
     # An example of a naïve handler that aborts all image requests:
+    # 
     #
     # ```js
     # const context = await browser.newContext();
@@ -180,7 +215,9 @@ module Playwright
     # await page.goto('https://example.com');
     # await browser.close();
     # ```
+    # 
     # or the same snippet using a regex pattern instead:
+    # 
     #
     # ```js
     # const context = await browser.newContext();
@@ -189,75 +226,88 @@ module Playwright
     # await page.goto('https://example.com');
     # await browser.close();
     # ```
-    # Page routes (set up with `page.route(url, handler)`) take precedence over browser context routes when request matches both handlers.
     # 
-    # **NOTE** Enabling routing disables http cache.
+    # Page routes (set up with [`method: Page.route`]) take precedence over browser context routes when request matches both
+    # handlers.
+    # 
+    # > **NOTE** Enabling routing disables http cache.
     def route(url, handler)
       raise NotImplementedError.new('route is not implemented yet.')
     end
 
     # This setting will change the default maximum navigation time for the following methods and related shortcuts:
+    # - [`method: Page.goBack`]
+    # - [`method: Page.goForward`]
+    # - [`method: Page.goto`]
+    # - [`method: Page.reload`]
+    # - [`method: Page.setContent`]
+    # - [`method: Page.waitForNavigation`]
     # 
-    # `page.goBack([options])`
-    # `page.goForward([options])`
-    # `page.goto(url[, options])`
-    # `page.reload([options])`
-    # `page.setContent(html[, options])`
-    # `page.waitForNavigation([options])`
-    # 
-    # 
-    # **NOTE** `page.setDefaultNavigationTimeout(timeout)` and `page.setDefaultTimeout(timeout)` take priority over `browserContext.setDefaultNavigationTimeout(timeout)`.
+    # > **NOTE** [`method: Page.setDefaultNavigationTimeout`] and [`method: Page.setDefaultTimeout`] take priority over
+    # [`method: BrowserContext.setDefaultNavigationTimeout`].
     def set_default_navigation_timeout(timeout)
       raise NotImplementedError.new('set_default_navigation_timeout is not implemented yet.')
     end
+    alias_method :default_navigation_timeout=, :set_default_navigation_timeout
 
     # This setting will change the default maximum time for all the methods accepting `timeout` option.
     # 
-    # **NOTE** `page.setDefaultNavigationTimeout(timeout)`, `page.setDefaultTimeout(timeout)` and `browserContext.setDefaultNavigationTimeout(timeout)` take priority over `browserContext.setDefaultTimeout(timeout)`.
+    # > **NOTE** [`method: Page.setDefaultNavigationTimeout`], [`method: Page.setDefaultTimeout`] and
+    # [`method: BrowserContext.setDefaultNavigationTimeout`] take priority over [`method: BrowserContext.setDefaultTimeout`].
     def set_default_timeout(timeout)
       raise NotImplementedError.new('set_default_timeout is not implemented yet.')
     end
+    alias_method :default_timeout=, :set_default_timeout
 
-    # The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are merged with page-specific extra HTTP headers set with `page.setExtraHTTPHeaders(headers)`. If page overrides a particular header, page-specific header value will be used instead of the browser context header value.
+    # The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are merged
+    # with page-specific extra HTTP headers set with [`method: Page.setExtraHTTPHeaders`]. If page overrides a particular
+    # header, page-specific header value will be used instead of the browser context header value.
     # 
-    # **NOTE** `browserContext.setExtraHTTPHeaders` does not guarantee the order of headers in the outgoing requests.
+    # > **NOTE** `browserContext.setExtraHTTPHeaders` does not guarantee the order of headers in the outgoing requests.
     def set_extra_http_headers(headers)
       raise NotImplementedError.new('set_extra_http_headers is not implemented yet.')
     end
+    alias_method :extra_http_headers=, :set_extra_http_headers
 
     # Sets the context's geolocation. Passing `null` or `undefined` emulates position unavailable.
+    # 
     #
     # ```js
     # await browserContext.setGeolocation({latitude: 59.95, longitude: 30.31667});
     # ```
     # 
-    # **NOTE** Consider using `browserContext.grantPermissions(permissions[, options])` to grant permissions for the browser context pages to read its geolocation.
+    # > **NOTE** Consider using [`method: BrowserContext.grantPermissions`] to grant permissions for the browser context pages
+    # to read its geolocation.
     def set_geolocation(geolocation)
       raise NotImplementedError.new('set_geolocation is not implemented yet.')
     end
+    alias_method :geolocation=, :set_geolocation
 
-    # Provide credentials for HTTP authentication.
-    # 
-    # **NOTE** Browsers may cache credentials after successful authentication. Passing different credentials or passing `null` to disable authentication will be unreliable. To remove or replace credentials, create a new browser context instead.
+    # **DEPRECATED** Browsers may cache credentials after successful authentication. Create a new browser context instead.
     def set_http_credentials(httpCredentials)
       raise NotImplementedError.new('set_http_credentials is not implemented yet.')
     end
+    alias_method :http_credentials=, :set_http_credentials
 
     def set_offline(offline)
       raise NotImplementedError.new('set_offline is not implemented yet.')
     end
+    alias_method :offline=, :set_offline
 
     # Returns storage state for this browser context, contains current cookies and local storage snapshot.
     def storage_state(path: nil)
       raise NotImplementedError.new('storage_state is not implemented yet.')
     end
 
-    # Removes a route created with `browserContext.route(url, handler)`. When `handler` is not specified, removes all routes for the `url`.
+    # Removes a route created with [`method: BrowserContext.route`]. When `handler` is not specified, removes all routes for
+    # the `url`.
     def unroute(url, handler: nil)
       raise NotImplementedError.new('unroute is not implemented yet.')
     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 context closes before the event is fired. Returns the event data value.
+    # 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 context closes before the event is fired. Returns the event data value.
+    # 
     #
     # ```js
     # const context = await browser.newContext();
@@ -268,13 +318,13 @@ module Playwright
     end
 
     # @nodoc
-    def browser=(req)
-      wrap_channel_owner(@channel_owner.browser=(req))
+    def owner_page=(req)
+      wrap_channel_owner(@channel_owner.owner_page=(req))
     end
 
     # @nodoc
-    def owner_page=(req)
-      wrap_channel_owner(@channel_owner.owner_page=(req))
+    def browser=(req)
+      wrap_channel_owner(@channel_owner.browser=(req))
     end
 
     # @nodoc