playwright-ruby-client 0.0.6 → 0.2.0

data/lib/playwright_api/playwright.rb

@@ -113,49 +113,13 @@ module Playwright
       wrap_impl(@impl.devices)
     end
 
-    # Playwright methods might throw errors if they are unable to fulfill a request. For example,
-    # [`method: Page.waitForSelector`] might fail if the selector doesn't match any nodes during the given timeframe.
-    # 
-    # For certain types of errors Playwright uses specific error classes. These classes are available via
-    # [`playwright.errors`](#playwrighterrors).
-    # 
-    # An example of handling a timeout error:
-    # 
-    #
-    # ```js
-    # try {
-    #   await page.waitForSelector('.foo');
-    # } catch (e) {
-    #   if (e instanceof playwright.errors.TimeoutError) {
-    #     // Do something if this is a timeout.
-    #   }
-    # }
-    # ```
-    # 
-    # ```python async
-    # try:
-    #     await page.wait_for_selector(".foo")
-    # except TimeoutError as e:
-    #     # do something if this is a timeout.
-    # ```
-    # 
-    # ```python sync
-    # try:
-    #     page.wait_for_selector(".foo")
-    # except TimeoutError as e:
-    #     # do something if this is a timeout.
-    # ```
-    def errors # property
-      raise NotImplementedError.new('errors is not implemented yet.')
-    end
-
     # This object can be used to launch or connect to Firefox, returning instances of `FirefoxBrowser`.
     def firefox # property
       wrap_impl(@impl.firefox)
     end
 
-    # Selectors can be used to install custom selector engines. See
-    # [Working with selectors](./selectors.md#working-with-selectors) for more information.
+    # Selectors can be used to install custom selector engines. See [Working with selectors](./selectors.md) for more
+    # information.
     def selectors # property
       raise NotImplementedError.new('selectors is not implemented yet.')
     end
@@ -165,32 +129,56 @@ module Playwright
       wrap_impl(@impl.webkit)
     end
 
+    # Terminates this instance of Playwright in case it was created bypassing the Python context manager. This is useful in
+    # REPL applications.
+    # 
+    # ```py
+    # >>> from playwright.sync_api import sync_playwright
+    # 
+    # >>> playwright = sync_playwright().start()
+    # 
+    # >>> browser = playwright.chromium.launch()
+    # >>> page = browser.new_page()
+    # >>> page.goto("http://whatsmyuseragent.org/")
+    # >>> page.screenshot(path="example.png")
+    # >>> browser.close()
+    # 
+    # >>> playwright.stop()
+    # ```
+    def stop
+      raise NotImplementedError.new('stop is not implemented yet.')
+    end
+
+    # @nodoc
+    def android
+      wrap_impl(@impl.android)
+    end
+
     # @nodoc
     def electron
       wrap_impl(@impl.electron)
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def android
-      wrap_impl(@impl.android)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
-      wrap_impl(@impl.on(event, callback))
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
-      wrap_impl(@impl.off(event, callback))
+      event_emitter_proxy.off(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      wrap_impl(@impl.once(event, callback))
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end
   end
 end

data/lib/playwright_api/request.rb

@@ -178,27 +178,26 @@ module Playwright
       wrap_impl(@impl.url)
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def after_initialize
-      wrap_impl(@impl.after_initialize)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
-      wrap_impl(@impl.on(event, callback))
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
-      wrap_impl(@impl.off(event, callback))
+      event_emitter_proxy.off(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      wrap_impl(@impl.once(event, callback))
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end
   end
 end

data/lib/playwright_api/response.rb

@@ -61,20 +61,24 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      wrap_impl(@impl.on(event, callback))
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      wrap_impl(@impl.off(event, callback))
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      wrap_impl(@impl.once(event, callback))
+    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

data/lib/playwright_api/selectors.rb

@@ -1,6 +1,6 @@
 module Playwright
-  # Selectors can be used to install custom selector engines. See
-  # [Working with selectors](./selectors.md#working-with-selectors) for more information.
+  # Selectors can be used to install custom selector engines. See [Working with selectors](./selectors.md) for more
+  # information.
   class Selectors < PlaywrightApi
 
     # An example of registering selector engine that queries elements based on a tag name:
@@ -48,26 +48,30 @@ module Playwright
     # ```python sync
     # # FIXME: add snippet
     # ```
-    def register(name, script, contentScript: nil)
+    def register(name, contentScript: nil, path: nil, script: nil)
       raise NotImplementedError.new('register is not implemented yet.')
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      wrap_impl(@impl.on(event, callback))
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      wrap_impl(@impl.off(event, callback))
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      wrap_impl(@impl.once(event, callback))
+    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

data/lib/playwright_api/web_socket.rb

@@ -14,8 +14,17 @@ module Playwright
 
     # 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 webSocket is closed before the event is fired. Returns the event data value.
-    def expect_event(event, optionsOrPredicate: nil)
+    def expect_event(event, predicate: nil, timeout: nil)
       raise NotImplementedError.new('expect_event is not implemented yet.')
     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.
+    def wait_for_event(event, predicate: nil, timeout: nil)
+      raise NotImplementedError.new('wait_for_event is not implemented yet.')
+    end
   end
 end

data/lib/playwright_api/worker.rb

@@ -28,26 +28,26 @@ module Playwright
   # ```
   class Worker < PlaywrightApi
 
-    # Returns the return value of `pageFunction`
+    # Returns the return value of `expression`.
     # 
-    # If the function passed to the `worker.evaluate` returns a [Promise], then `worker.evaluate` would wait for the promise
-    # to resolve and return its value.
+    # 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 `worker.evaluate` returns a non-[Serializable] value, then `worker.evaluate` returns
-    # `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`:
-    # `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
-    def evaluate(pageFunction, arg: nil)
+    # 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`.
+    def evaluate(expression, arg: nil)
       raise NotImplementedError.new('evaluate is not implemented yet.')
     end
 
-    # Returns the return value of `pageFunction` as in-page object (JSHandle).
+    # Returns the return value of `expression` as a `JSHandle`.
     # 
-    # The only difference between `worker.evaluate` and `worker.evaluateHandle` is that `worker.evaluateHandle` returns
-    # in-page object (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 `worker.evaluateHandle` returns a [Promise], then `worker.evaluateHandle` would wait for
-    # the promise to resolve and return its value.
-    def evaluate_handle(pageFunction, arg: nil)
+    # 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)
       raise NotImplementedError.new('evaluate_handle is not implemented yet.')
     end
 

data/playwright.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'mime-types', '>= 3.0'
   spec.add_development_dependency 'bundler', '~> 2.2.3'
   spec.add_development_dependency 'dry-inflector'
   spec.add_development_dependency 'pry-byebug'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.2.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -165,10 +179,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/api_coverage.md
 - lib/playwright.rb
+- lib/playwright/android_input_impl.rb
+- lib/playwright/api_implementation.rb
 - lib/playwright/channel.rb
 - lib/playwright/channel_owner.rb
 - lib/playwright/channel_owners/android.rb
+- lib/playwright/channel_owners/android_device.rb
 - lib/playwright/channel_owners/binding_call.rb
 - lib/playwright/channel_owners/browser.rb
 - lib/playwright/channel_owners/browser_context.rb
@@ -176,6 +194,7 @@ files:
 - lib/playwright/channel_owners/chromium_browser.rb
 - lib/playwright/channel_owners/chromium_browser_context.rb
 - lib/playwright/channel_owners/console_message.rb
+- lib/playwright/channel_owners/download.rb
 - lib/playwright/channel_owners/electron.rb
 - lib/playwright/channel_owners/element_handle.rb
 - lib/playwright/channel_owners/firefox_browser.rb
@@ -190,24 +209,31 @@ files:
 - lib/playwright/connection.rb
 - lib/playwright/errors.rb
 - lib/playwright/event_emitter.rb
+- lib/playwright/event_emitter_proxy.rb
 - lib/playwright/events.rb
-- lib/playwright/input_type.rb
-- lib/playwright/input_types/keyboard.rb
-- lib/playwright/input_types/mouse.rb
-- lib/playwright/input_types/touchscreen.rb
+- lib/playwright/file_chooser_impl.rb
+- lib/playwright/http_headers.rb
+- 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
+- lib/playwright/mouse_impl.rb
 - lib/playwright/playwright_api.rb
+- lib/playwright/select_option_values.rb
 - lib/playwright/timeout_settings.rb
+- lib/playwright/touchscreen_impl.rb
 - lib/playwright/transport.rb
 - lib/playwright/url_matcher.rb
 - lib/playwright/utils.rb
 - lib/playwright/version.rb
 - lib/playwright/wait_helper.rb
 - lib/playwright_api/accessibility.rb
+- lib/playwright_api/android.rb
+- lib/playwright_api/android_device.rb
+- lib/playwright_api/android_input.rb
 - lib/playwright_api/binding_call.rb
 - lib/playwright_api/browser.rb
 - lib/playwright_api/browser_context.rb

data/lib/playwright/input_type.rb

@@ -1,19 +0,0 @@
-module Playwright
-  class InputType
-    def initialize(channel)
-      @channel = channel
-    end
-  end
-
-  # namespace declaration
-  module InputTypes ; end
-
-  def self.define_input_type(class_name, &block)
-    klass = Class.new(InputType)
-    klass.class_eval(&block) if block
-    InputTypes.const_set(class_name, klass)
-  end
-end
-
-# load subclasses
-Dir[File.join(__dir__, 'input_types', '*.rb')].each { |f| require f }

data/lib/playwright/input_types/mouse.rb

@@ -1,4 +0,0 @@
-module Playwright
-  define_input_type :Mouse do
-  end
-end

data/lib/playwright/input_types/touchscreen.rb

@@ -1,4 +0,0 @@
-module Playwright
-  define_input_type :Touchscreen do
-  end
-end