playwright-ruby-client 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eccb7fbb7a1fba3116ceaa61893b164850dc7f21eb45cac637da161bc137120a
-  data.tar.gz: ceeab7bc64c7a743ef3b682dda05271ff49eb3727ad7b47ed722f527aedacba0
+  metadata.gz: a8e526e28e95751a08697bc93b14ec33f4f82e827b8adf4dc45aed4bf44dd1d2
+  data.tar.gz: 647596db5628a1014a7816bb43d2ca41a21eeb6cf8c7263dea701d8f9a6ba4e7
 SHA512:
-  metadata.gz: 1414afc026223b47750708cd2f30dab6453aebb5b3ce06f97a7f4a51c793f6b2b57ef307ffc0b31df2f91158d7d7e40623f443846b1653ca8778b7a67bfe7a47
-  data.tar.gz: 33cf15f92e23a118264627067f534d4379876090b6a3bf74fb8c67253e2905b575495c548247144f82ed282b8b86a1c891e89ffdf8e51423202bd38ce03a5bb2
+  metadata.gz: 0051320ee1e574680ebc6be4d5cf359a28bd8ada9a737fc60d734f017c43142b6f267553f15d0e1ac0ed368f12d57dac5a887a39695f59a11f774344405dcfd1
+  data.tar.gz: 14f97b51a9462a8bfb587c5752eb13b3db0c132d0d56d7bdaab829389f2cb7c17bb879b171773e1e21259bb6b352f6020a5b7165be577bb147b22b5b0155c28e

data/docs/api_coverage.md

@@ -113,12 +113,12 @@
 
 * ~~snapshot~~
 
-## ~~FileChooser~~
+## FileChooser
 
-* ~~element~~
-* ~~multiple?~~
-* ~~page~~
-* ~~set_files~~
+* element
+* multiple?
+* page
+* set_files
 
 ## Frame
 
@@ -195,15 +195,15 @@
 * ~~message~~
 * ~~type~~
 
-## ~~Download~~
+## Download
 
 * ~~create_read_stream~~
-* ~~delete~~
-* ~~failure~~
-* ~~path~~
-* ~~save_as~~
-* ~~suggested_filename~~
-* ~~url~~
+* delete
+* failure
+* path
+* save_as
+* suggested_filename
+* url
 
 ## ~~Video~~
 

data/lib/playwright.rb

@@ -10,14 +10,15 @@ require 'concurrent'
 require 'playwright/errors'
 require 'playwright/events'
 require 'playwright/event_emitter'
+require 'playwright/event_emitter_proxy'
 require 'playwright/javascript'
 require 'playwright/utils'
 
+require 'playwright/api_implementation'
 require 'playwright/channel'
 require 'playwright/channel_owner'
 require 'playwright/http_headers'
 require 'playwright/input_files'
-require 'playwright/input_type'
 require 'playwright/connection'
 require 'playwright/select_option_values'
 require 'playwright/timeout_settings'
@@ -38,7 +39,7 @@ module Playwright
 
     playwright_promise = connection.async_wait_for_object_with_known_name('Playwright')
     Thread.new { connection.run }
-    playwright = PlaywrightApi.from_channel_owner(playwright_promise.value!)
+    playwright = PlaywrightApi.wrap(playwright_promise.value!)
     begin
       block.call(playwright)
     ensure

data/lib/playwright/{input_types/android_input.rb → android_input_impl.rb}

@@ -1,5 +1,9 @@
 module Playwright
-  define_input_type :AndroidInput do
+  define_api_implementation :AndroidInputImpl do
+    def initialize(channel)
+      @channel = channel
+    end
+
     def type(text)
       @channel.send_message_to_server('inputType', text: text)
     end

data/lib/playwright/api_implementation.rb

@@ -0,0 +1,18 @@
+module Playwright
+  # Each Impl class include this module.
+  # Used for detecting whether the object is a XXXXImpl or not.
+  module ApiImplementation ; end
+
+  def self.define_api_implementation(class_name, &block)
+    klass = Class.new
+    klass.include(ApiImplementation)
+    klass.class_eval(&block) if block
+    if ::Playwright.const_defined?(class_name)
+      raise ArgumentError.new("Playwright::#{class_name} already exist. Choose another class name.")
+    end
+    ::Playwright.const_set(class_name, klass)
+  end
+end
+
+# load subclasses
+Dir[File.join(__dir__, '*_impl.rb')].each { |f| require f }

data/lib/playwright/channel.rb

@@ -24,5 +24,12 @@ module Playwright
         nil
       end
     end
+
+    # @param method [String]
+    # @param params [Hash]
+    def send_no_reply(method, params)
+      @connection.async_send_message_to_server(@guid, method, params)
+      nil
+    end
   end
 end

data/lib/playwright/channel_owners/android_device.rb

@@ -3,7 +3,7 @@ module Playwright
     include Utils::PrepareBrowserContextOptions
 
     def after_initialize
-      @input = InputTypes::AndroidInput.new(@channel)
+      @input = AndroidInputImpl.new(@channel)
     end
 
     attr_reader :input

data/lib/playwright/channel_owners/download.rb

@@ -0,0 +1,27 @@
+module Playwright
+  define_channel_owner :Download do
+    def url
+      @initializer['url']
+    end
+
+    def suggested_filename
+      @initializer['suggestedFilename']
+    end
+
+    def delete
+      @channel.send_message_to_server('delete')
+    end
+
+    def failure
+      @channel.send_message_to_server('failure')
+    end
+
+    def path
+      @channel.send_message_to_server('path')
+    end
+
+    def save_as(path)
+      @channel.send_message_to_server('saveAs', path: path)
+    end
+  end
+end

data/lib/playwright/channel_owners/element_handle.rb

@@ -182,8 +182,8 @@ module Playwright
       end
 
       def set_input_files(files, noWaitAfter: nil, timeout: nil)
-        base_params = InputFiles.new(values).as_params
-        params = base_params + { noWaitAfter: noWaitAfter, timeout: timeout }.compact
+        file_payloads = InputFiles.new(files).as_params
+        params = { files: file_payloads, noWaitAfter: noWaitAfter, timeout: timeout }.compact
         @channel.send_message_to_server('setInputFiles', params)
 
         nil

data/lib/playwright/channel_owners/frame.rb

@@ -407,8 +407,8 @@ module Playwright
     end
 
     def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
-      base_params = InputFiles.new(values).as_params
-      params = base_params + { selector: selector, noWaitAfter: noWaitAfter, timeout: timeout }.compact
+      file_payloads = InputFiles.new(files).as_params
+      params = { files: file_payloads, selector: selector, noWaitAfter: noWaitAfter, timeout: timeout }.compact
       @channel.send_message_to_server('setInputFiles', params)
 
       nil

data/lib/playwright/channel_owners/page.rb

@@ -10,9 +10,9 @@ module Playwright
       @browser_context = @parent
       @timeout_settings = TimeoutSettings.new(@browser_context.send(:_timeout_settings))
       @accessibility = Accessibility.new(@channel)
-      @keyboard = InputTypes::Keyboard.new(@channel)
-      @mouse = InputTypes::Mouse.new(@channel)
-      @touchscreen = InputTypes::Touchscreen.new(@channel)
+      @keyboard = KeyboardImpl.new(@channel)
+      @mouse = MouseImpl.new(@channel)
+      @touchscreen = TouchscreenImpl.new(@channel)
 
       @viewport_size = @initializer['viewportSize']
       @closed = false
@@ -32,6 +32,13 @@ module Playwright
       @channel.on('download', ->(params) {
         emit(Events::Page::Download, ChannelOwners::Download.from(params['download']))
       })
+      @channel.on('fileChooser', ->(params) {
+        chooser = FileChooserImpl.new(
+                    page: self,
+                    element_handle: ChannelOwners::ElementHandle.from(params['element']),
+                    is_multiple: params['isMultiple'])
+        emit(Events::Page::FileChooser, chooser)
+      })
       @channel.on('frameAttached', ->(params) {
         on_frame_attached(ChannelOwners::Frame.from(params['frame']))
       })
@@ -127,6 +134,29 @@ module Playwright
       end
     end
 
+    # @override
+    def on(event, callback)
+      if event == Events::Page::FileChooser && listener_count(event) == 0
+        @channel.send_no_reply('setFileChooserInterceptedNoReply', intercepted: true)
+      end
+      super
+    end
+
+    # @override
+    def once(event, callback)
+      if event == Events::Page::FileChooser && listener_count(event) == 0
+        @channel.send_no_reply('setFileChooserInterceptedNoReply', intercepted: true)
+      end
+      super
+    end
+
+    # @override
+    def off(event, callback)
+      super
+      if event == Events::Page::FileChooser && listener_count(event) == 0
+        @channel.send_no_reply('setFileChooserInterceptedNoReply', intercepted: false)
+      end
+    end
 
     def context
       @browser_context

data/lib/playwright/errors.rb

@@ -28,7 +28,7 @@ module Playwright
   end
 
   class TimeoutError < Error
-    def initialize(message:, stack:)
+    def initialize(message:, stack: [])
       super(name: 'TimeoutError', message: message, stack: stack)
     end
   end

data/lib/playwright/event_emitter.rb

@@ -44,6 +44,10 @@ module Playwright
       handled
     end
 
+    private def listener_count(event)
+      ((@__event_emitter ||= {})[event.to_s] ||= Set.new).count
+    end
+
     # @param event [String]
     # @param callback [Proc]
     def on(event, callback)

data/lib/playwright/event_emitter_proxy.rb

@@ -0,0 +1,49 @@
+module Playwright
+  class EventEmitterProxy
+    include EventEmitter
+
+    # @param src [PlaywrightApi]
+    # @param dest [EventEmitter]
+    def initialize(api, impl)
+      @api = api
+      @impl = impl
+      @listeners = {}
+    end
+
+    def on(event, callback)
+      if listener_count(event) == 0
+        subscribe(event)
+      end
+      super
+    end
+
+    def once(event, callback)
+      if listener_count(event) == 0
+        subscribe(event)
+      end
+      super
+    end
+
+    def off(event, callback)
+      super
+      if listener_count(event) == 0
+        unsubscribe(event)
+      end
+    end
+
+    private def subscribe(event)
+      @listeners[event] = ->(*args) {
+        wrapped_args = args.map { |arg| ::Playwright::PlaywrightApi.wrap(arg) }
+        emit(event, *wrapped_args)
+      }
+      @impl.on(event, @listeners[event])
+    end
+
+    private def unsubscribe(event)
+      listener = @listeners.delete(event)
+      if listener
+        @impl.off(event, listener)
+      end
+    end
+  end
+end

data/lib/playwright/file_chooser_impl.rb

@@ -0,0 +1,23 @@
+module Playwright
+  define_api_implementation :FileChooserImpl do
+    def initialize(page:, element_handle:, is_multiple:)
+      @page = page
+      @element_handle = element_handle
+      @is_multiple = is_multiple
+    end
+
+    attr_reader :page
+
+    def element
+      @element_handle
+    end
+
+    def multiple?
+      @is_multiple
+    end
+
+    def set_files(files, noWaitAfter: nil, timeout: nil)
+      @element_handle.set_input_files(files, noWaitAfter: noWaitAfter, timeout: timeout)
+    end
+  end
+end

data/lib/playwright/input_files.rb

@@ -36,7 +36,7 @@ module Playwright
 
     private def mime_type_for(filepath)
       mime_types = MIME::Types.type_for(filepath)
-      mime_types.first || 'application/octet-stream'
+      mime_types.first.to_s || 'application/octet-stream'
     end
   end
 end

data/lib/playwright/{input_types/keyboard.rb → keyboard_impl.rb}

@@ -1,5 +1,9 @@
 module Playwright
-  define_input_type :Keyboard do
+  define_api_implementation :KeyboardImpl do
+    def initialize(channel)
+      @channel = channel
+    end
+
     def down(key)
       @channel.send_message_to_server('keyboardDown', key: key)
       nil

data/lib/playwright/mouse_impl.rb

@@ -0,0 +1,7 @@
+module Playwright
+  define_api_implementation :MouseImpl do
+    def initialize(channel)
+      @channel = channel
+    end
+  end
+end

data/lib/playwright/playwright_api.rb

@@ -1,27 +1,34 @@
 module Playwright
   class PlaywrightApi
-    # Wrap ChannelOwner.
+    # Wrap ChannelOwner / ApiImplementation.
     # Playwright::ChannelOwners::XXXXX will be wrapped as Playwright::XXXXX
+    # Playwright::YYYYImpl will be wrapped as Playwright::YYYY
     # Playwright::XXXXX is automatically generated by development/generate_api
     #
-    # @param channel_owner [ChannelOwner]
+    # @param channel_owner [ChannelOwner|ApiImplementation]
     # @note Intended for internal use only.
-    def self.from_channel_owner(channel_owner)
-      Factory.new(channel_owner, 'ChannelOwners').create
+    def self.wrap(channel_owner_or_api_implementation)
+      case channel_owner_or_api_implementation
+      when ChannelOwner
+        ChannelOwnerWrapper.new(channel_owner_or_api_implementation).wrap
+      when ApiImplementation
+        ApiImplementationWrapper.new(channel_owner_or_api_implementation).wrap
+      else
+        nil
+      end
     end
 
-    class Factory
-      def initialize(impl, module_name)
+    class ChannelOwnerWrapper
+      def initialize(impl)
         impl_class_name = impl.class.name
-        unless impl_class_name.include?("::#{module_name}::")
-          raise "#{impl_class_name} is not #{module_name}"
+        unless impl_class_name.include?("::ChannelOwners::")
+          raise "#{impl_class_name} is not ChannelOwners"
         end
 
         @impl = impl
-        @module_name = module_name
       end
 
-      def create
+      def wrap
         api_class = detect_class_for(@impl.class)
         if api_class
           api_class.new(@impl)
@@ -33,11 +40,11 @@ module Playwright
       private
 
       def expected_class_name_for(klass)
-        klass.name.split("::#{@module_name}::").last
+        klass.name.split("::ChannelOwners::").last
       end
 
       def superclass_exist?(klass)
-        ![::Playwright::ChannelOwner, ::Playwright::InputType, Object].include?(klass.superclass)
+        ![::Playwright::ChannelOwner, Object].include?(klass.superclass)
       end
 
       def detect_class_for(klass)
@@ -52,7 +59,44 @@ module Playwright
       end
     end
 
-    # @param impl [Playwright::ChannelOwner|Playwright::InputType]
+    class ApiImplementationWrapper
+      def initialize(impl)
+        impl_class_name = impl.class.name
+        unless impl_class_name.end_with?("Impl")
+          raise "#{impl_class_name} is not Impl"
+        end
+
+        @impl = impl
+      end
+
+      def wrap
+        api_class = detect_class_for(@impl.class)
+        if api_class
+          api_class.new(@impl)
+        else
+          raise NotImplementedError.new("Playwright::#{expected_class_name_for(@impl.class)} is not implemented")
+        end
+      end
+
+      private
+
+      def expected_class_name_for(klass)
+        # KeyboardImpl -> Keyboard
+        # MouseImpl -> Mouse
+        klass.name[0...-4].split("::").last
+      end
+
+      def detect_class_for(klass)
+        class_name = expected_class_name_for(klass)
+        if ::Playwright.const_defined?(class_name)
+          ::Playwright.const_get(class_name)
+        else
+          nil
+        end
+      end
+    end
+
+    # @param impl [Playwright::ChannelOwner|Playwright::ApiImplementation]
     def initialize(impl)
       @impl = impl
     end
@@ -72,15 +116,10 @@ module Playwright
     end
 
     private def wrap_impl(object)
-      case object
-      when ChannelOwner
-        PlaywrightApi.from_channel_owner(object)
-      when InputType
-        Factory.new(object, 'InputTypes').create
-      when Array
+      if object.is_a?(Array)
         object.map { |obj| wrap_impl(obj) }
       else
-        object
+        ::Playwright::PlaywrightApi.wrap(object) || object
       end
     end