playwright-ruby-client 0.5.6 → 0.6.0

data/lib/playwright_api/playwright.rb

@@ -64,6 +64,24 @@ module Playwright
   # with sync_playwright() as playwright:
   #     run(playwright)
   # ```
+  # 
+  # ```csharp
+  # using Microsoft.Playwright;
+  # using System.Threading.Tasks;
+  # 
+  # class PlaywrightExample
+  # {
+  #     public static async Task Main()
+  #     {
+  #         using var playwright = await Playwright.CreateAsync();
+  #         await using var browser = await playwright.Chromium.LaunchAsync();
+  #         var page = await browser.NewPageAsync();
+  # 
+  #         await page.GotoAsync("https://www.microsoft.com");
+  #         // other actions...
+  #     }
+  # }
+  # ```
   class Playwright < PlaywrightApi
 
     # This object can be used to launch or connect to Chromium, returning instances of `Browser`.
@@ -178,20 +196,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/request.rb

@@ -34,6 +34,13 @@ module Playwright
     # ```py
     # page.on("requestfailed", lambda request: print(request.url + " " + request.failure))
     # ```
+    # 
+    # ```csharp
+    # page.RequestFailed += (_, request) =>
+    # {
+    #     Console.WriteLine(request.Failure);
+    # };
+    # ```
     def failure
       wrap_impl(@impl.failure)
     end
@@ -105,6 +112,11 @@ module Playwright
     # print(response.request.redirected_from.url) # "http://example.com"
     # ```
     # 
+    # ```csharp
+    # var response = await page.GotoAsync("http://www.microsoft.com");
+    # Console.WriteLine(response.Request.RedirectedFrom?.Url); // http://www.microsoft.com
+    # ```
+    # 
     # If the website `https://google.com` has no redirects:
     # 
     #
@@ -127,6 +139,11 @@ module Playwright
     # response = page.goto("https://google.com")
     # print(response.request.redirected_from) # None
     # ```
+    # 
+    # ```csharp
+    # var response = await page.GotoAsync("https://www.google.com");
+    # Console.WriteLine(response.Request.RedirectedFrom?.Url); // null
+    # ```
     def redirected_from
       wrap_impl(@impl.redirected_from)
     end
@@ -147,6 +164,10 @@ module Playwright
     # ```py
     # assert request.redirected_from.redirected_to == request
     # ```
+    # 
+    # ```csharp
+    # Console.WriteLine(request.RedirectedFrom?.RedirectedTo == request); // True
+    # ```
     def redirected_to
       wrap_impl(@impl.redirected_to)
     end
@@ -197,6 +218,13 @@ module Playwright
     # request = request_info.value
     # print(request.timing)
     # ```
+    # 
+    # ```csharp
+    # var waitForEventTask = page.WaitForEventAsync(PageEvent.RequestFinished);
+    # await page.GotoAsync("https://www.microsoft.com");
+    # var request = await waitForEventTask;
+    # Console.WriteLine(request.Timing.ResponseEnd);
+    # ```
     def timing
       wrap_impl(@impl.timing)
     end
@@ -208,20 +236,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/response.rb

@@ -59,14 +59,20 @@ module Playwright
       wrap_impl(@impl.url)
     end
 
+    # @nodoc
+    def after_initialize
+      wrap_impl(@impl.after_initialize)
+    end
+
     # @nodoc
     def ok?
       wrap_impl(@impl.ok?)
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def after_initialize
-      wrap_impl(@impl.after_initialize)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -81,12 +87,6 @@ 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/route.rb

@@ -41,7 +41,7 @@ module Playwright
     #         "foo": "bar" # set "foo" header
     #         "origin": None # remove "origin" header
     #     }
-    #     await route.continue(headers=headers)
+    #     await route.continue_(headers=headers)
     # }
     # await page.route("**/*", handle)
     # ```
@@ -54,10 +54,19 @@ module Playwright
     #         "foo": "bar" # set "foo" header
     #         "origin": None # remove "origin" header
     #     }
-    #     route.continue(headers=headers)
+    #     route.continue_(headers=headers)
     # }
     # 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
@@ -100,6 +109,13 @@ module Playwright
     #     body="not found!"))
     # ```
     # 
+    # ```csharp
+    # await page.RouteAsync("**/*", route => route.FulfillAsync(
+    #     status: 404,
+    #     contentType: "text/plain", 
+    #     body: "Not Found!"));
+    # ```
+    # 
     # An example of serving static file:
     # 
     #
@@ -119,6 +135,10 @@ module Playwright
     # ```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,
@@ -135,20 +155,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/selectors.rb

@@ -74,26 +74,51 @@ module Playwright
     # ```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 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/tracing.rb

@@ -0,0 +1,99 @@
+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()
+  # context.tracing.start(name="trace", screenshots=True, snapshots=True)
+  # page.goto("https://playwright.dev")
+  # context.tracing.stop()
+  # context.tracing.export("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")
+    # ```
+    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)
+    end
+  end
+end

data/lib/playwright_api/worker.rb

@@ -38,14 +38,14 @@ module Playwright
   # ```
   # 
   # ```csharp
-  # Page.Worker += (_, worker) =>
+  # 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)
+  # foreach(var pageWorker in page.Workers)
   # {
   #     Console.WriteLine($"\tWorker: {pageWorker.Url}");
   # }

data/playwright.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['YusukeIwaki']
   spec.email         = ['q7w8e9w8q7w8e9@yahoo.co.jp']
 
-  spec.summary       = 'The Ruby binding of playwright driver'
+  spec.summary       = "The Ruby binding of playwright driver #{Playwright::COMPATIBLE_PLAYWRIGHT_VERSION}"
   spec.homepage      = 'https://github.com/YusukeIwaki/playwright-ruby-client'
   spec.license       = 'MIT'
 
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.4'
   spec.add_dependency 'concurrent-ruby', '>= 1.1.6'
   spec.add_dependency 'mime-types', '>= 3.0'
   spec.add_development_dependency 'bundler', '~> 2.2.3'
@@ -33,7 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0.3'
   spec.add_development_dependency 'rspec', '~> 3.10.0 '
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
-  spec.add_development_dependency 'rubocop', '~> 1.7.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'webrick'