playwright-ruby-client 0.0.5 → 0.0.6

data/lib/playwright_api/browser_context.rb

@@ -1,5 +1,5 @@
 module Playwright
-  # - extends: [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter)
+  # - extends: [EventEmitter]
   # 
   # BrowserContexts provide a way to operate multiple independent browser sessions.
   # 
@@ -19,6 +19,26 @@ module Playwright
   # // Dispose context once it's no longer needed.
   # await context.close();
   # ```
+  # 
+  # ```python async
+  # # create a new incognito browser context
+  # context = await browser.new_context()
+  # # create a new page inside context.
+  # page = await context.new_page()
+  # await page.goto("https://example.com")
+  # # dispose context once it"s no longer needed.
+  # await context.close()
+  # ```
+  # 
+  # ```python sync
+  # # create a new incognito browser context
+  # context = browser.new_context()
+  # # create a new page inside context.
+  # page = context.new_page()
+  # page.goto("https://example.com")
+  # # dispose context once it"s no longer needed.
+  # context.close()
+  # ```
   class BrowserContext < PlaywrightApi
 
     # Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be
@@ -28,6 +48,14 @@ module Playwright
     # ```js
     # await browserContext.addCookies([cookieObject1, cookieObject2]);
     # ```
+    # 
+    # ```python async
+    # await browser_context.add_cookies([cookie_object1, cookie_object2])
+    # ```
+    # 
+    # ```python sync
+    # browser_context.add_cookies([cookie_object1, cookie_object2])
+    # ```
     def add_cookies(cookies)
       raise NotImplementedError.new('add_cookies is not implemented yet.')
     end
@@ -43,7 +71,7 @@ module Playwright
     # An example of overriding `Math.random` before the page loads:
     # 
     #
-    # ```js
+    # ```js browser
     # // preload.js
     # Math.random = () => 42;
     # ```
@@ -56,7 +84,17 @@ module Playwright
     # });
     # ```
     # 
-    # > **NOTE** The order of evaluation of multiple scripts installed via [`method: BrowserContext.addInitScript`] and
+    # ```python async
+    # # in your playwright script, assuming the preload.js file is in same directory.
+    # await browser_context.add_init_script(path="preload.js")
+    # ```
+    # 
+    # ```python sync
+    # # in your playwright script, assuming the preload.js file is in same directory.
+    # browser_context.add_init_script(path="preload.js")
+    # ```
+    # 
+    # > 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.')
@@ -81,15 +119,29 @@ module Playwright
     # // do stuff ..
     # context.clearPermissions();
     # ```
+    # 
+    # ```python async
+    # context = await browser.new_context()
+    # await context.grant_permissions(["clipboard-read"])
+    # # do stuff ..
+    # context.clear_permissions()
+    # ```
+    # 
+    # ```python sync
+    # context = browser.new_context()
+    # context.grant_permissions(["clipboard-read"])
+    # # do stuff ..
+    # context.clear_permissions()
+    # ```
     def clear_permissions
       raise NotImplementedError.new('clear_permissions is not implemented yet.')
     end
 
     # 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
-      wrap_channel_owner(@channel_owner.close)
+      wrap_impl(@impl.close)
     end
 
     # If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs
@@ -131,6 +183,57 @@ module Playwright
     # })();
     # ```
     # 
+    # ```python async
+    # import asyncio
+    # from playwright.async_api import async_playwright
+    # 
+    # async def run(playwright):
+    #     webkit = playwright.webkit
+    #     browser = await webkit.launch(headless=false)
+    #     context = await browser.new_context()
+    #     await context.expose_binding("pageURL", lambda source: source["page"].url)
+    #     page = await context.new_page()
+    #     await page.set_content("""
+    #     <script>
+    #       async function onClick() {
+    #         document.querySelector('div').textContent = await window.pageURL();
+    #       }
+    #     </script>
+    #     <button onclick="onClick()">Click me</button>
+    #     <div></div>
+    #     """)
+    #     await page.click("button")
+    # 
+    # 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):
+    #     webkit = playwright.webkit
+    #     browser = webkit.launch(headless=false)
+    #     context = browser.new_context()
+    #     context.expose_binding("pageURL", lambda source: source["page"].url)
+    #     page = context.new_page()
+    #     page.set_content("""
+    #     <script>
+    #       async function onClick() {
+    #         document.querySelector('div').textContent = await window.pageURL();
+    #       }
+    #     </script>
+    #     <button onclick="onClick()">Click me</button>
+    #     <div></div>
+    #     """)
+    #     page.click("button")
+    # 
+    # with sync_playwright() as playwright:
+    #     run(playwright)
+    # ```
+    # 
     # An example of passing an element handle:
     # 
     #
@@ -146,6 +249,34 @@ module Playwright
     #   <div>Or click me</div>
     # `);
     # ```
+    # 
+    # ```python async
+    # async def print(source, element):
+    #     print(await element.text_content())
+    # 
+    # await context.expose_binding("clicked", print, handle=true)
+    # await page.set_content("""
+    #   <script>
+    #     document.addEventListener('click', event => window.clicked(event.target));
+    #   </script>
+    #   <div>Click me</div>
+    #   <div>Or click me</div>
+    # """)
+    # ```
+    # 
+    # ```python sync
+    # def print(source, element):
+    #     print(element.text_content())
+    # 
+    # context.expose_binding("clicked", print, handle=true)
+    # page.set_content("""
+    #   <script>
+    #     document.addEventListener('click', event => window.clicked(event.target));
+    #   </script>
+    #   <div>Click me</div>
+    #   <div>Or click me</div>
+    # """)
+    # ```
     def expose_binding(name, callback, handle: nil)
       raise NotImplementedError.new('expose_binding is not implemented yet.')
     end
@@ -181,6 +312,72 @@ module Playwright
     #   await page.click('button');
     # })();
     # ```
+    # 
+    # ```python async
+    # import asyncio
+    # import hashlib
+    # from playwright.async_api import async_playwright
+    # 
+    # async def sha1(text):
+    #     m = hashlib.sha1()
+    #     m.update(bytes(text, "utf8"))
+    #     return m.hexdigest()
+    # 
+    # 
+    # async def run(playwright):
+    #     webkit = playwright.webkit
+    #     browser = await webkit.launch(headless=False)
+    #     context = await browser.new_context()
+    #     await context.expose_function("sha1", sha1)
+    #     page = await context.new_page()
+    #     await page.set_content("""
+    #         <script>
+    #           async function onClick() {
+    #             document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');
+    #           }
+    #         </script>
+    #         <button onclick="onClick()">Click me</button>
+    #         <div></div>
+    #     """)
+    #     await page.click("button")
+    # 
+    # async def main():
+    #     async with async_playwright() as playwright:
+    #         await run(playwright)
+    # asyncio.run(main())
+    # ```
+    # 
+    # ```python sync
+    # import hashlib
+    # from playwright.sync_api import sync_playwright
+    # 
+    # def sha1(text):
+    #     m = hashlib.sha1()
+    #     m.update(bytes(text, "utf8"))
+    #     return m.hexdigest()
+    # 
+    # 
+    # def run(playwright):
+    #     webkit = playwright.webkit
+    #     browser = webkit.launch(headless=False)
+    #     context = browser.new_context()
+    #     context.expose_function("sha1", sha1)
+    #     page = context.new_page()
+    #     page.expose_function("sha1", sha1)
+    #     page.set_content("""
+    #         <script>
+    #           async function onClick() {
+    #             document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');
+    #           }
+    #         </script>
+    #         <button onclick="onClick()">Click me</button>
+    #         <div></div>
+    #     """)
+    #     page.click("button")
+    # 
+    # with sync_playwright() as playwright:
+    #     run(playwright)
+    # ```
     def expose_function(name, callback)
       raise NotImplementedError.new('expose_function is not implemented yet.')
     end
@@ -193,13 +390,13 @@ module Playwright
 
     # Creates a new page in the browser context.
     def new_page
-      wrap_channel_owner(@channel_owner.new_page)
+      wrap_impl(@impl.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 [`method: ChromiumBrowserContext.backgroundPages`].
     def pages
-      wrap_channel_owner(@channel_owner.pages)
+      wrap_impl(@impl.pages)
     end
 
     # Routing provides the capability to modify network requests that are made by any page in the browser context. Once route
@@ -216,6 +413,22 @@ module Playwright
     # await browser.close();
     # ```
     # 
+    # ```python async
+    # context = await browser.new_context()
+    # page = await context.new_page()
+    # await context.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
+    # await page.goto("https://example.com")
+    # await browser.close()
+    # ```
+    # 
+    # ```python sync
+    # context = browser.new_context()
+    # page = context.new_page()
+    # context.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
+    # page.goto("https://example.com")
+    # browser.close()
+    # ```
+    # 
     # or the same snippet using a regex pattern instead:
     # 
     #
@@ -227,10 +440,29 @@ module Playwright
     # await browser.close();
     # ```
     # 
+    # ```python async
+    # context = await browser.new_context()
+    # page = await context.new_page()
+    # await context.route(re.compile(r"(\.png$)|(\.jpg$)"), lambda route: route.abort())
+    # page = await context.new_page()
+    # await page.goto("https://example.com")
+    # await browser.close()
+    # ```
+    # 
+    # ```python sync
+    # context = browser.new_context()
+    # page = context.new_page()
+    # context.route(re.compile(r"(\.png$)|(\.jpg$)"), lambda route: route.abort())
+    # page = await context.new_page()
+    # page = context.new_page()
+    # page.goto("https://example.com")
+    # browser.close()
+    # ```
+    # 
     # 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.
+    # > NOTE: Enabling routing disables http cache.
     def route(url, handler)
       raise NotImplementedError.new('route is not implemented yet.')
     end
@@ -243,7 +475,7 @@ module Playwright
     # - [`method: Page.setContent`]
     # - [`method: Page.waitForNavigation`]
     # 
-    # > **NOTE** [`method: Page.setDefaultNavigationTimeout`] and [`method: Page.setDefaultTimeout`] take priority over
+    # > 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.')
@@ -252,7 +484,7 @@ module Playwright
 
     # This setting will change the default maximum time for all the methods accepting `timeout` option.
     # 
-    # > **NOTE** [`method: Page.setDefaultNavigationTimeout`], [`method: Page.setDefaultTimeout`] and
+    # > 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.')
@@ -263,7 +495,7 @@ module Playwright
     # 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: [`method: 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
@@ -276,8 +508,16 @@ module Playwright
     # await browserContext.setGeolocation({latitude: 59.95, longitude: 30.31667});
     # ```
     # 
-    # > **NOTE** Consider using [`method: BrowserContext.grantPermissions`] to grant permissions for the browser context pages
-    # to read its geolocation.
+    # ```python async
+    # await browser_context.set_geolocation({"latitude": 59.95, "longitude": 30.31667})
+    # ```
+    # 
+    # ```python sync
+    # browser_context.set_geolocation({"latitude": 59.95, "longitude": 30.31667})
+    # ```
+    # 
+    # > 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
@@ -310,49 +550,63 @@ module Playwright
     # 
     #
     # ```js
-    # const context = await browser.newContext();
-    # await context.grantPermissions(['geolocation']);
+    # const [page, _] = await Promise.all([
+    #   context.waitForEvent('page'),
+    #   page.click('button')
+    # ]);
     # ```
-    def wait_for_event(event, optionsOrPredicate: nil)
-      raise NotImplementedError.new('wait_for_event is not implemented yet.')
+    # 
+    # ```python async
+    # async with context.expect_event("page") as event_info:
+    #     await page.click("button")
+    # page = await event_info.value
+    # ```
+    # 
+    # ```python sync
+    # with context.expect_event("page") as event_info:
+    #     page.click("button")
+    # page = event_info.value
+    # ```
+    def expect_event(event, optionsOrPredicate: nil)
+      raise NotImplementedError.new('expect_event is not implemented yet.')
     end
 
     # @nodoc
-    def browser=(req)
-      wrap_channel_owner(@channel_owner.browser=(req))
+    def owner_page=(req)
+      wrap_impl(@impl.owner_page=(req))
     end
 
     # @nodoc
-    def owner_page=(req)
-      wrap_channel_owner(@channel_owner.owner_page=(req))
+    def after_initialize
+      wrap_impl(@impl.after_initialize)
     end
 
     # @nodoc
-    def after_initialize
-      wrap_channel_owner(@channel_owner.after_initialize)
+    def browser=(req)
+      wrap_impl(@impl.browser=(req))
     end
 
     # @nodoc
     def options=(req)
-      wrap_channel_owner(@channel_owner.options=(req))
+      wrap_impl(@impl.options=(req))
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      wrap_channel_owner(@channel_owner.off(event, callback))
+    def on(event, callback)
+      wrap_impl(@impl.on(event, callback))
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      wrap_channel_owner(@channel_owner.once(event, callback))
+    def off(event, callback)
+      wrap_impl(@impl.off(event, callback))
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      wrap_channel_owner(@channel_owner.on(event, callback))
+    def once(event, callback)
+      wrap_impl(@impl.once(event, callback))
     end
   end
 end