playwright-ruby-client 0.0.5 → 0.1.0

data/lib/playwright/keyboard_impl.rb

@@ -0,0 +1,36 @@
+module Playwright
+  define_api_implementation :KeyboardImpl do
+    def initialize(channel)
+      @channel = channel
+    end
+
+    def down(key)
+      @channel.send_message_to_server('keyboardDown', key: key)
+      nil
+    end
+
+    def up(key)
+      @channel.send_message_to_server('keyboardDown', key: key)
+    end
+
+    def insert_text(text)
+      @channel.send_message_to_server('keyboardInsertText', text: text)
+    end
+
+    def type(text, delay: nil)
+      params = {
+        text: text,
+        delay: delay,
+      }.compact
+      @channel.send_message_to_server('keyboardType', params)
+    end
+
+    def press(key, delay: nil)
+      params = {
+        key: key,
+        delay: delay,
+      }.compact
+      @channel.send_message_to_server('keyboardPress', params)
+    end
+  end
+end

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,36 +1,89 @@
 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).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 ChannelOwnerWrapper
+      def initialize(impl)
+        impl_class_name = impl.class.name
+        unless impl_class_name.include?("::ChannelOwners::")
+          raise "#{impl_class_name} is not ChannelOwners"
+        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)
+        klass.name.split("::ChannelOwners::").last
+      end
+
+      def superclass_exist?(klass)
+        ![::Playwright::ChannelOwner, Object].include?(klass.superclass)
+      end
+
+      def detect_class_for(klass)
+        class_name = expected_class_name_for(klass)
+        if ::Playwright.const_defined?(class_name)
+          ::Playwright.const_get(class_name)
+        elsif superclass_exist?(klass)
+          detect_class_for(klass.superclass)
+        else
+          nil
+        end
+      end
     end
 
-    class Factory
-      def initialize(channel_owner)
-        channel_owner_class_name = channel_owner.class.name
-        raise "#{channel_owner_class_name} is not a channel owner" unless channel_owner_class_name.include?('::ChannelOwners::')
+    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
 
-        @channel_owner = channel_owner
+        @impl = impl
       end
 
-      def create
-        api_class = detect_class_for(@channel_owner.class)
+      def wrap
+        api_class = detect_class_for(@impl.class)
         if api_class
-          api_class.new(@channel_owner)
+          api_class.new(@impl)
         else
-          raise NotImplementedError.new("Playwright::#{expected_class_name_for(@channel_owner.class)} is not implemented")
+          raise NotImplementedError.new("Playwright::#{expected_class_name_for(@impl.class)} is not implemented")
         end
       end
 
       private
 
       def expected_class_name_for(klass)
-        klass.name.split('::ChannelOwners::').last
+        # KeyboardImpl -> Keyboard
+        # MouseImpl -> Mouse
+        klass.name[0...-4].split("::").last
       end
 
       def detect_class_for(klass)
@@ -38,22 +91,18 @@ module Playwright
         if ::Playwright.const_defined?(class_name)
           ::Playwright.const_get(class_name)
         else
-          if [::Playwright::ChannelOwner, Object].include?(klass.superclass)
-            nil
-          else
-            detect_class_for(klass.superclass)
-          end
+          nil
         end
       end
     end
 
-    # @param channel_owner [Playwright::ChannelOwner]
-    def initialize(channel_owner)
-      @channel_owner = channel_owner
+    # @param impl [Playwright::ChannelOwner|Playwright::ApiImplementation]
+    def initialize(impl)
+      @impl = impl
     end
 
     def ==(other)
-      @channel_owner.to_s == other.instance_variable_get(:'@channel_owner').to_s
+      @impl.to_s == other.instance_variable_get(:'@impl').to_s
     end
 
     # @param block [Proc]
@@ -61,16 +110,22 @@ module Playwright
       return nil unless block.is_a?(Proc)
 
       -> (*args) {
-        wrapped_args = args.map { |arg| wrap_channel_owner(arg) }
+        wrapped_args = args.map { |arg| wrap_impl(arg) }
         block.call(*wrapped_args)
       }
     end
 
-    private def wrap_channel_owner(object)
-      if object.is_a?(ChannelOwner)
-        PlaywrightApi.from_channel_owner(object)
-      elsif object.is_a?(Array)
-        object.map { |obj| wrap_channel_owner(obj) }
+    private def wrap_impl(object)
+      if object.is_a?(Array)
+        object.map { |obj| wrap_impl(obj) }
+      else
+        ::Playwright::PlaywrightApi.wrap(object) || object
+      end
+    end
+
+    private def unwrap_impl(object)
+      if object.is_a?(PlaywrightApi)
+        object.instance_variable_get(:@impl)
       else
         object
       end

data/lib/playwright/select_option_values.rb

@@ -0,0 +1,32 @@
+module Playwright
+  class SelectOptionValues
+    def initialize(values)
+      @params = convert(values)
+    end
+
+    # @return [Hash]
+    def as_params
+      @params
+    end
+
+    private def convert(values)
+      return {} unless values
+      return convert([values]) unless values.is_a?('Array')
+      return {} if values.empty?
+      values.each_with_index do |value, index|
+        unless values
+          raise ArgumentError.new("options[#{index}]: expected object, got null")
+        end
+      end
+
+      case values.first
+      when ElementHandle
+        { elements: values.map(&:channel) }
+      when String
+        { options: values.map { |value| { value: value } } }
+      else
+        { options: values }
+      end
+    end
+  end
+end

data/lib/playwright/timeout_settings.rb

@@ -9,11 +9,11 @@ module Playwright
     attr_writer :default_timeout, :default_navigation_timeout
 
     def navigation_timeout
-      @default_navigation_timeout || @default_timeout || @parent&.navigation_timeout || EFAULT_TIMEOUT
+      @default_navigation_timeout || @default_timeout || @parent&.navigation_timeout || DEFAULT_TIMEOUT
     end
 
     def timeout
-      @default_timeout || @parent&.navigation_timeout || DEFAULT_TIMEOUT
+      @default_timeout || @parent&.timeout || DEFAULT_TIMEOUT
     end
   end
 end

data/lib/playwright/touchscreen_impl.rb

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

data/lib/playwright/url_matcher.rb

@@ -0,0 +1,19 @@
+module Playwright
+  class UrlMatcher
+    # @param url [String|Regexp]
+    def initialize(url)
+      @url = url
+    end
+
+    def match?(target_url)
+      case @url
+      when String
+        @url == target_url
+      when Regexp
+        @url.match?(target_url)
+      else
+        false
+      end
+    end
+  end
+end

data/lib/playwright/utils.rb

@@ -1,5 +1,23 @@
 module Playwright
   module Utils
+    module PrepareBrowserContextOptions
+      # @see https://github.com/microsoft/playwright/blob/5a2cfdbd47ed3c3deff77bb73e5fac34241f649d/src/client/browserContext.ts#L265
+      private def prepare_browser_context_options(params)
+        if params[:viewport] == 0
+          params.delete(:viewport)
+          params[:noDefaultViewport] = true
+        end
+        if params[:extraHTTPHeaders]
+          params[:extraHTTPHeaders] = ::Playwright::HttpHeaders.new(params[:extraHTTPHeaders]).as_serialized
+        end
+        if params[:storageState].is_a?(String)
+          params[:storageState] = JSON.parse(File.read(params[:storageState]))
+        end
+
+        params
+      end
+    end
+
     module Errors
       module SafeCloseError
         # @param err [Exception]

data/lib/playwright/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/lib/playwright/wait_helper.rb

@@ -23,7 +23,7 @@ module Playwright
       return if timeout_ms <= 0
 
       Concurrent::Promises.schedule(timeout_ms / 1000.0) {
-        reject(TimeoutError.new(message))
+        reject(TimeoutError.new(message: message))
       }
 
       self

data/lib/playwright_api/accessibility.rb

@@ -6,18 +6,18 @@ module Playwright
   # Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might
   # have wildly different output.
   # 
-  # Blink - Chromium's rendering engine - has a concept of "accessibility tree", which is then translated into different
-  # platform-specific APIs. Accessibility namespace gives users access to the Blink Accessibility Tree.
+  # Rendering engines of Chromium, Firefox and Webkit have a concept of "accessibility tree", which is then translated into
+  # different platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
   # 
-  # Most of the accessibility tree gets filtered out when converting from Blink AX Tree to Platform-specific AX-Tree or by
-  # assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing only the
-  # "interesting" nodes of the tree.
+  # Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific
+  # AX-Tree or by assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing
+  # only the "interesting" nodes of the tree.
   class Accessibility < PlaywrightApi
 
     # Captures the current state of the accessibility tree. The returned object represents the root accessible node of the
     # page.
     # 
-    # > **NOTE** The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers.
+    # > NOTE: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers.
     # Playwright will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
     # 
     # An example of dumping the entire accessibility tree:
@@ -28,6 +28,16 @@ module Playwright
     # console.log(snapshot);
     # ```
     # 
+    # ```python async
+    # snapshot = await page.accessibility.snapshot()
+    # print(snapshot)
+    # ```
+    # 
+    # ```python sync
+    # snapshot = page.accessibility.snapshot()
+    # print(snapshot)
+    # ```
+    # 
     # An example of logging the focused node's name:
     # 
     #
@@ -46,6 +56,36 @@ module Playwright
     #   return null;
     # }
     # ```
+    # 
+    # ```python async
+    # def find_focused_node(node):
+    #     if (node.get("focused"))
+    #         return node
+    #     for child in (node.get("children") or []):
+    #         found_node = find_focused_node(child)
+    #         return found_node
+    #     return None
+    # 
+    # snapshot = await page.accessibility.snapshot()
+    # node = find_focused_node(snapshot)
+    # if node:
+    #     print(node["name"])
+    # ```
+    # 
+    # ```python sync
+    # def find_focused_node(node):
+    #     if (node.get("focused"))
+    #         return node
+    #     for child in (node.get("children") or []):
+    #         found_node = find_focused_node(child)
+    #         return found_node
+    #     return None
+    # 
+    # snapshot = page.accessibility.snapshot()
+    # node = find_focused_node(snapshot)
+    # if node:
+    #     print(node["name"])
+    # ```
     def snapshot(interestingOnly: nil, root: nil)
       raise NotImplementedError.new('snapshot is not implemented yet.')
     end

data/lib/playwright_api/android.rb

@@ -0,0 +1,37 @@
+module Playwright
+  # @nodoc
+  class Android < PlaywrightApi
+
+    # @nodoc
+    def devices
+      wrap_impl(@impl.devices)
+    end
+
+    # @nodoc
+    def after_initialize
+      wrap_impl(@impl.after_initialize)
+    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

data/lib/playwright_api/android_device.rb

@@ -0,0 +1,82 @@
+module Playwright
+  # @nodoc
+  class AndroidDevice < PlaywrightApi
+
+    # @nodoc
+    def tree
+      wrap_impl(@impl.tree)
+    end
+
+    # @nodoc
+    def close
+      wrap_impl(@impl.close)
+    end
+
+    # @nodoc
+    def after_initialize
+      wrap_impl(@impl.after_initialize)
+    end
+
+    # @nodoc
+    def tap_on(selector, duration: nil, timeout: nil)
+      wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
+    end
+
+    # @nodoc
+    def screenshot(path: nil)
+      wrap_impl(@impl.screenshot(path: unwrap_impl(path)))
+    end
+
+    # @nodoc
+    def shell(command)
+      wrap_impl(@impl.shell(unwrap_impl(command)))
+    end
+
+    # @nodoc
+    def input
+      wrap_impl(@impl.input)
+    end
+
+    # @nodoc
+    def launch_browser(pkg: nil, acceptDownloads: nil, bypassCSP: nil, colorScheme: nil, deviceScaleFactor: nil, extraHTTPHeaders: nil, geolocation: nil, hasTouch: nil, httpCredentials: nil, ignoreHTTPSErrors: nil, isMobile: nil, javaScriptEnabled: nil, locale: nil, logger: nil, offline: nil, permissions: nil, proxy: nil, recordHar: nil, recordVideo: nil, storageState: nil, timezoneId: nil, userAgent: nil, videoSize: nil, videosPath: nil, viewport: nil, &block)
+      wrap_impl(@impl.launch_browser(pkg: unwrap_impl(pkg), acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), logger: unwrap_impl(logger), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), recordHar: unwrap_impl(recordHar), recordVideo: unwrap_impl(recordVideo), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), videoSize: unwrap_impl(videoSize), videosPath: unwrap_impl(videosPath), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+    end
+
+    # @nodoc
+    def info(selector)
+      wrap_impl(@impl.info(unwrap_impl(selector)))
+    end
+
+    # @nodoc
+    def serial
+      wrap_impl(@impl.serial)
+    end
+
+    # @nodoc
+    def model
+      wrap_impl(@impl.model)
+    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