playwright-ruby-client 0.6.0 → 0.6.5

data/lib/playwright_api/selectors.rb

@@ -4,111 +4,14 @@ 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)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -121,6 +24,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/tracing.rb

@@ -1,99 +1,33 @@
 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')
+  # browser = chromium.launch()
   # context = browser.new_context()
-  # context.tracing.start(name="trace", screenshots=True, snapshots=True)
+  # context.tracing.start(screenshots=True, snapshots=True)
   # page.goto("https://playwright.dev")
-  # context.tracing.stop()
-  # context.tracing.export("trace.zip")
+  # context.tracing.stop(path = "trace.zip")
   # ```
   class Tracing < PlaywrightApi
 
-    # Export trace into the file with the given name. Should be called after the tracing has stopped.
-    def export(path)
-      wrap_impl(@impl.export(unwrap_impl(path)))
-    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")
     # context.tracing.stop()
-    # context.tracing.export("trace.zip")
+    # context.tracing.stop(path = "trace.zip")
     # ```
     def start(name: nil, screenshots: nil, snapshots: nil)
       wrap_impl(@impl.start(name: unwrap_impl(name), screenshots: unwrap_impl(screenshots), snapshots: unwrap_impl(snapshots)))
     end
 
     # Stop tracing.
-    def stop
-      wrap_impl(@impl.stop)
+    def stop(path: nil)
+      wrap_impl(@impl.stop(path: unwrap_impl(path)))
     end
   end
 end

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)
@@ -78,5 +42,27 @@ module Playwright
     def url
       raise NotImplementedError.new('url is not implemented yet.')
     end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.5
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -193,7 +193,60 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- docs/api_coverage.md
+- documentation/README.md
+- documentation/babel.config.js
+- documentation/docs/api/accessibility.md
+- documentation/docs/api/browser.md
+- documentation/docs/api/browser_context.md
+- documentation/docs/api/browser_type.md
+- documentation/docs/api/cdp_session.md
+- documentation/docs/api/console_message.md
+- documentation/docs/api/dialog.md
+- documentation/docs/api/element_handle.md
+- documentation/docs/api/experimental/_category_.yml
+- documentation/docs/api/experimental/android.md
+- documentation/docs/api/experimental/android_device.md
+- documentation/docs/api/experimental/android_input.md
+- documentation/docs/api/experimental/android_socket.md
+- documentation/docs/api/experimental/android_web_view.md
+- documentation/docs/api/file_chooser.md
+- documentation/docs/api/frame.md
+- documentation/docs/api/js_handle.md
+- documentation/docs/api/keyboard.md
+- documentation/docs/api/mouse.md
+- documentation/docs/api/page.md
+- documentation/docs/api/playwright.md
+- documentation/docs/api/request.md
+- documentation/docs/api/response.md
+- documentation/docs/api/route.md
+- documentation/docs/api/selectors.md
+- documentation/docs/api/touchscreen.md
+- documentation/docs/api/tracing.md
+- documentation/docs/api/web_socket.md
+- documentation/docs/api/worker.md
+- documentation/docs/article/api_coverage.mdx
+- documentation/docs/article/getting_started.md
+- documentation/docs/article/guides/_category_.yml
+- documentation/docs/article/guides/download_playwright_driver.md
+- documentation/docs/article/guides/launch_browser.md
+- documentation/docs/article/guides/rails_integration.md
+- documentation/docs/article/guides/recording_video.md
+- documentation/docs/include/api_coverage.md
+- documentation/docusaurus.config.js
+- documentation/package.json
+- documentation/sidebars.js
+- documentation/src/components/HomepageFeatures.js
+- documentation/src/components/HomepageFeatures.module.css
+- documentation/src/css/custom.css
+- documentation/src/pages/index.js
+- documentation/src/pages/index.module.css
+- documentation/src/pages/markdown-page.md
+- documentation/static/.nojekyll
+- documentation/static/img/playwright-logo.svg
+- documentation/static/img/undraw_dropdown_menu.svg
+- documentation/static/img/undraw_web_development.svg
+- documentation/static/img/undraw_windows.svg
+- documentation/yarn.lock
 - lib/playwright.rb
 - lib/playwright/android_input_impl.rb
 - lib/playwright/api_implementation.rb
@@ -219,6 +272,7 @@ files:
 - lib/playwright/channel_owners/route.rb
 - lib/playwright/channel_owners/selectors.rb
 - lib/playwright/channel_owners/stream.rb
+- lib/playwright/channel_owners/worker.rb
 - lib/playwright/connection.rb
 - lib/playwright/download.rb
 - lib/playwright/errors.rb
@@ -230,7 +284,6 @@ files:
 - lib/playwright/input_files.rb
 - lib/playwright/javascript.rb
 - lib/playwright/javascript/expression.rb
-- lib/playwright/javascript/function.rb
 - lib/playwright/javascript/value_parser.rb
 - lib/playwright/javascript/value_serializer.rb
 - lib/playwright/keyboard_impl.rb

data/lib/playwright/javascript/function.rb

@@ -1,67 +0,0 @@
-module Playwright
-  module JavaScript
-    class Function
-      def initialize(definition, arg)
-        @definition = definition
-        @serialized_arg = ValueSerializer.new(arg).serialize
-      end
-
-      def evaluate(channel)
-        value = channel.send_message_to_server(
-          'evaluateExpression',
-          expression: @definition,
-          isFunction: true,
-          arg: @serialized_arg,
-        )
-        ValueParser.new(value).parse
-      end
-
-      def evaluate_handle(channel)
-        resp = channel.send_message_to_server(
-          'evaluateExpressionHandle',
-          expression: @definition,
-          isFunction: true,
-          arg: @serialized_arg,
-        )
-        ::Playwright::ChannelOwner.from(resp)
-      end
-
-      def eval_on_selector(channel, selector)
-        value = channel.send_message_to_server(
-          'evalOnSelector',
-          selector: selector,
-          expression: @definition,
-          isFunction: true,
-          arg: @serialized_arg,
-        )
-        ValueParser.new(value).parse
-      end
-
-      def eval_on_selector_all(channel, selector)
-        value = channel.send_message_to_server(
-          'evalOnSelectorAll',
-          selector: selector,
-          expression: @definition,
-          isFunction: true,
-          arg: @serialized_arg,
-        )
-        ValueParser.new(value).parse
-      end
-
-      def wait_for_function(channel, polling:, timeout:)
-        params = {
-          expression: @definition,
-          isFunction: true,
-          arg: @serialized_arg,
-          polling: polling,
-          timeout: timeout,
-        }.compact
-        if polling.is_a?(Numeric)
-          params[:pollingInterval] = polling
-        end
-        resp = channel.send_message_to_server('waitForFunction', params)
-        ChannelOwners::JSHandle.from(resp)
-      end
-    end
-  end
-end