playwright-ruby-client 0.6.0 → 0.6.1

data/lib/playwright_api/route.rb

@@ -9,43 +9,7 @@ module Playwright
     end
 
     # Continues route's request with optional overrides.
-    # 
     #
-    # ```js
-    # await page.route('**/*', (route, request) => {
-    #   // Override headers
-    #   const headers = {
-    #     ...request.headers(),
-    #     foo: 'bar', // set "foo" header
-    #     origin: undefined, // remove "origin" header
-    #   };
-    #   route.continue({headers});
-    # });
-    # ```
-    # 
-    # ```java
-    # page.route("**/*", route -> {
-    #   // Override headers
-    #   Map<String, String> headers = new HashMap<>(route.request().headers());
-    #   headers.put("foo", "bar"); // set "foo" header
-    #   headers.remove("origin"); // remove "origin" header
-    #   route.resume(new Route.ResumeOptions().setHeaders(headers));
-    # });
-    # ```
-    # 
-    # ```python async
-    # async def handle(route, request):
-    #     # override headers
-    #     headers = {
-    #         **request.headers,
-    #         "foo": "bar" # set "foo" header
-    #         "origin": None # remove "origin" header
-    #     }
-    #     await route.continue_(headers=headers)
-    # }
-    # await page.route("**/*", handle)
-    # ```
-    # 
     # ```python sync
     # def handle(route, request):
     #     # override headers
@@ -58,87 +22,26 @@ module Playwright
     # }
     # page.route("**/*", handle)
     # ```
-    # 
-    # ```csharp
-    # await page.RouteAsync("**/*", route =>
-    # {
-    #     var headers = new Dictionary<string, string>(route.Request.Headers) { { "foo", "bar" } };
-    #     headers.Remove("origin");
-    #     route.ContinueAsync(headers);
-    # });
-    # ```
     def continue(headers: nil, method: nil, postData: nil, url: nil)
       wrap_impl(@impl.continue(headers: unwrap_impl(headers), method: unwrap_impl(method), postData: unwrap_impl(postData), url: unwrap_impl(url)))
     end
 
     # Fulfills route's request with given response.
-    # 
+    #
     # An example of fulfilling all requests with 404 responses:
-    # 
     #
-    # ```js
-    # await page.route('**/*', route => {
-    #   route.fulfill({
-    #     status: 404,
-    #     contentType: 'text/plain',
-    #     body: 'Not Found!'
-    #   });
-    # });
-    # ```
-    # 
-    # ```java
-    # page.route("**/*", route -> {
-    #   route.fulfill(new Route.FulfillOptions()
-    #     .setStatus(404)
-    #     .setContentType("text/plain")
-    #     .setBody("Not Found!"));
-    # });
-    # ```
-    # 
-    # ```python async
-    # await page.route("**/*", lambda route: route.fulfill(
-    #     status=404,
-    #     content_type="text/plain",
-    #     body="not found!"))
-    # ```
-    # 
     # ```python sync
     # page.route("**/*", lambda route: route.fulfill(
     #     status=404,
     #     content_type="text/plain",
     #     body="not found!"))
     # ```
-    # 
-    # ```csharp
-    # await page.RouteAsync("**/*", route => route.FulfillAsync(
-    #     status: 404,
-    #     contentType: "text/plain", 
-    #     body: "Not Found!"));
-    # ```
-    # 
+    #
     # An example of serving static file:
-    # 
     #
-    # ```js
-    # await page.route('**/xhr_endpoint', route => route.fulfill({ path: 'mock_data.json' }));
-    # ```
-    # 
-    # ```java
-    # page.route("**/xhr_endpoint", route -> route.fulfill(
-    #   new Route.FulfillOptions().setPath(Paths.get("mock_data.json")));
-    # ```
-    # 
-    # ```python async
-    # await page.route("**/xhr_endpoint", lambda route: route.fulfill(path="mock_data.json"))
-    # ```
-    # 
     # ```python sync
     # page.route("**/xhr_endpoint", lambda route: route.fulfill(path="mock_data.json"))
     # ```
-    # 
-    # ```csharp
-    # await page.RouteAsync("**/xhr_endpoint", route => route.FulfillAsync(path: "mock_data.json"));
-    # ```
     def fulfill(
           body: nil,
           contentType: nil,
@@ -155,20 +58,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/selectors.rb

@@ -4,121 +4,30 @@ module Playwright
   class Selectors < PlaywrightApi
 
     # An example of registering selector engine that queries elements based on a tag name:
-    # 
     #
-    # ```js
-    # const { selectors, firefox } = require('playwright');  // Or 'chromium' or 'webkit'.
-    # 
-    # (async () => {
-    #   // Must be a function that evaluates to a selector engine instance.
-    #   const createTagNameEngine = () => ({
-    #     // Returns the first element matching given selector in the root's subtree.
-    #     query(root, selector) {
-    #       return root.querySelector(selector);
-    #     },
-    # 
-    #     // Returns all elements matching given selector in the root's subtree.
-    #     queryAll(root, selector) {
-    #       return Array.from(root.querySelectorAll(selector));
-    #     }
-    #   });
-    # 
-    #   // Register the engine. Selectors will be prefixed with "tag=".
-    #   await selectors.register('tag', createTagNameEngine);
-    # 
-    #   const browser = await firefox.launch();
-    #   const page = await browser.newPage();
-    #   await page.setContent(`<div><button>Click me</button></div>`);
-    # 
-    #   // Use the selector prefixed with its name.
-    #   const button = await page.$('tag=button');
-    #   // Combine it with other selector engines.
-    #   await page.click('tag=div >> text="Click me"');
-    #   // Can use it in any methods supporting selectors.
-    #   const buttonCount = await page.$$eval('tag=button', buttons => buttons.length);
-    # 
-    #   await browser.close();
-    # })();
-    # ```
-    # 
-    # ```java
-    # // Script that evaluates to a selector engine instance.
-    # String createTagNameEngine = "{\n" +
-    #   "  // Returns the first element matching given selector in the root's subtree.\n" +
-    #   "  query(root, selector) {\n" +
-    #   "    return root.querySelector(selector);\n" +
-    #   "  },\n" +
-    #   "  // Returns all elements matching given selector in the root's subtree.\n" +
-    #   "  queryAll(root, selector) {\n" +
-    #   "    return Array.from(root.querySelectorAll(selector));\n" +
-    #   "  }\n" +
-    #   "}";
-    # // Register the engine. Selectors will be prefixed with "tag=".
-    # playwright.selectors().register("tag", createTagNameEngine);
-    # Browser browser = playwright.firefox().launch();
-    # Page page = browser.newPage();
-    # page.setContent("<div><button>Click me</button></div>");
-    # // Use the selector prefixed with its name.
-    # ElementHandle button = page.querySelector("tag=button");
-    # // Combine it with other selector engines.
-    # page.click("tag=div >> text=\"Click me\"");
-    # // Can use it in any methods supporting selectors.
-    # int buttonCount = (int) page.evalOnSelectorAll("tag=button", "buttons => buttons.length");
-    # browser.close();
-    # ```
-    # 
-    # ```python async
-    # # FIXME: add snippet
-    # ```
-    # 
     # ```python sync
     # # FIXME: add snippet
     # ```
-    # 
-    # ```csharp
-    # using var playwright = await Playwright.CreateAsync();
-    # // Script that evaluates to a selector engine instance.
-    # await playwright.Selectors.RegisterAsync("tag", @"{
-    # // Returns the first element matching given selector in the root's subtree.
-    # query(root, selector) {
-    #     return root.querySelector(selector);
-    #   },
-    #   // Returns all elements matching given selector in the root's subtree.
-    #   queryAll(root, selector) {
-    #     return Array.from(root.querySelectorAll(selector));
-    #   }
-    # }");
-    # 
-    # await using var browser = await playwright.Chromium.LaunchAsync();
-    # var page = await browser.NewPageAsync();
-    # await page.SetContentAsync("<div><button>Click me</button></div>");
-    # // Use the selector prefixed with its name.
-    # var button = await page.QuerySelectorAsync("tag=button");
-    # // Combine it with other selector engines.
-    # await page.ClickAsync("tag=div >> text=\"Click me\"");
-    # // Can use it in any methods supporting selectors.
-    # int buttonCount = await page.EvalOnSelectorAllAsync<int>("tag=button", "buttons => buttons.length");
-    # ```
     def register(name, contentScript: nil, path: nil, script: nil)
       wrap_impl(@impl.register(unwrap_impl(name), contentScript: unwrap_impl(contentScript), path: unwrap_impl(path), script: unwrap_impl(script)))
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/tracing.rb

@@ -1,42 +1,9 @@
 module Playwright
   # API for collecting and saving Playwright traces. Playwright traces can be opened using the Playwright CLI after
   # Playwright script runs.
-  # 
+  #
   # Start with specifying the folder traces will be stored in:
-  # 
   #
-  # ```js
-  # const browser = await chromium.launch({ traceDir: 'traces' });
-  # const context = await browser.newContext();
-  # await context.tracing.start({ name: 'trace', screenshots: true, snapshots: true });
-  # const page = await context.newPage();
-  # await page.goto('https://playwright.dev');
-  # await context.tracing.stop();
-  # await context.tracing.export('trace.zip');
-  # ```
-  # 
-  # ```java
-  # Browser browser = chromium.launch(new BrowserType.LaunchOptions().setTraceDir("trace"));
-  # BrowserContext context = browser.newContext();
-  # context.tracing.start(page, new Tracing.StartOptions()
-  #   .setName("trace")
-  #   .setScreenshots(true)
-  #   .setSnapshots(true);
-  # Page page = context.newPage();
-  # page.goto("https://playwright.dev");
-  # context.tracing.stop();
-  # context.tracing.export(Paths.get("trace.zip")))
-  # ```
-  # 
-  # ```python async
-  # browser = await chromium.launch(traceDir='traces')
-  # context = await browser.new_context()
-  # await context.tracing.start(name="trace", screenshots=True, snapshots=True)
-  # await page.goto("https://playwright.dev")
-  # await context.tracing.stop()
-  # await context.tracing.export("trace.zip")
-  # ```
-  # 
   # ```python sync
   # browser = chromium.launch(traceDir='traces')
   # context = browser.new_context()
@@ -53,34 +20,7 @@ module Playwright
     end
 
     # Start tracing.
-    # 
     #
-    # ```js
-    # await context.tracing.start({ name: 'trace', screenshots: true, snapshots: true });
-    # const page = await context.newPage();
-    # await page.goto('https://playwright.dev');
-    # await context.tracing.stop();
-    # await context.tracing.export('trace.zip');
-    # ```
-    # 
-    # ```java
-    # context.tracing.start(page, new Tracing.StartOptions()
-    #   .setName("trace")
-    #   .setScreenshots(true)
-    #   .setSnapshots(true);
-    # Page page = context.newPage();
-    # page.goto('https://playwright.dev');
-    # context.tracing.stop();
-    # context.tracing.export(Paths.get("trace.zip")))
-    # ```
-    # 
-    # ```python async
-    # await context.tracing.start(name="trace", screenshots=True, snapshots=True)
-    # await page.goto("https://playwright.dev")
-    # await context.tracing.stop()
-    # await context.tracing.export("trace.zip")
-    # ```
-    # 
     # ```python sync
     # context.tracing.start(name="trace", screenshots=True, snapshots=True)
     # page.goto("https://playwright.dev")

data/lib/playwright_api/web_socket.rb

@@ -19,7 +19,7 @@ module Playwright
     end
 
     # > NOTE: In most cases, you should use [`method: WebSocket.waitForEvent`].
-    # 
+    #
     # Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function and
     # waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
     # fired.

data/lib/playwright_api/worker.rb

@@ -2,61 +2,25 @@ module Playwright
   # The Worker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). `worker`
   # event is emitted on the page object to signal a worker creation. `close` event is emitted on the worker object when the
   # worker is gone.
-  # 
   #
-  # ```js
-  # page.on('worker', worker => {
-  #   console.log('Worker created: ' + worker.url());
-  #   worker.on('close', worker => console.log('Worker destroyed: ' + worker.url()));
-  # });
-  # 
-  # console.log('Current workers:');
-  # for (const worker of page.workers())
-  #   console.log('  ' + worker.url());
-  # ```
-  # 
-  # ```java
-  # page.onWorker(worker -> {
-  #   System.out.println("Worker created: " + worker.url());
-  #   worker.onClose(worker1 -> System.out.println("Worker destroyed: " + worker1.url()));
-  # });
-  # System.out.println("Current workers:");
-  # for (Worker worker : page.workers())
-  #   System.out.println("  " + worker.url());
-  # ```
-  # 
   # ```py
   # def handle_worker(worker):
   #     print("worker created: " + worker.url)
   #     worker.on("close", lambda: print("worker destroyed: " + worker.url))
-  # 
+  #
   # page.on('worker', handle_worker)
-  # 
+  #
   # print("current workers:")
   # for worker in page.workers:
   #     print("    " + worker.url)
   # ```
-  # 
-  # ```csharp
-  # page.Worker += (_, worker) =>
-  # {
-  #     Console.WriteLine($"Worker created: {worker.Url}");
-  #     worker.Close += (_, _) => Console.WriteLine($"Worker closed {worker.Url}");
-  # };
-  # 
-  # Console.WriteLine("Current Workers:");
-  # foreach(var pageWorker in page.Workers)
-  # {
-  #     Console.WriteLine($"\tWorker: {pageWorker.Url}");
-  # }
-  # ```
   class Worker < PlaywrightApi
 
     # Returns the return value of `expression`.
-    # 
+    #
     # If the function passed to the [`method: Worker.evaluate`] returns a [Promise], then [`method: Worker.evaluate`] would
     # wait for the promise to resolve and return its value.
-    # 
+    #
     # If the function passed to the [`method: Worker.evaluate`] returns a non-[Serializable] value, then
     # [`method: Worker.evaluate`] returns `undefined`. Playwright also supports transferring some additional values that are
     # not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
@@ -65,10 +29,10 @@ module Playwright
     end
 
     # Returns the return value of `expression` as a `JSHandle`.
-    # 
+    #
     # The only difference between [`method: Worker.evaluate`] and [`method: Worker.evaluateHandle`] is that
     # [`method: Worker.evaluateHandle`] returns `JSHandle`.
-    # 
+    #
     # If the function passed to the [`method: Worker.evaluateHandle`] returns a [Promise], then
     # [`method: Worker.evaluateHandle`] would wait for the promise to resolve and return its value.
     def evaluate_handle(expression, arg: nil)