playwright-ruby-client 0.1.0 → 0.5.3

data/lib/playwright/channel_owners/element_handle.rb

@@ -136,8 +136,19 @@ module Playwright
         nil
       end
 
-      def select_option(values, noWaitAfter: nil, timeout: nil)
-        base_params = SelectOptionValues.new(values).as_params
+      def select_option(
+            element: nil,
+            index: nil,
+            value: nil,
+            label: nil,
+            noWaitAfter: nil,
+            timeout: nil)
+        base_params = SelectOptionValues.new(
+          element: element,
+          index: index,
+          value: value,
+          label: label,
+        ).as_params
         params = base_params + { noWaitAfter: noWaitAfter, timeout: timeout }.compact
         @channel.send_message_to_server('selectOption', params)
 
@@ -168,7 +179,7 @@ module Playwright
           value: value,
           noWaitAfter: noWaitAfter,
           timeout: timeout,
-        }
+        }.compact
         @channel.send_message_to_server('fill', params)
 
         nil
@@ -219,10 +230,11 @@ module Playwright
         nil
       end
 
-      def check(force: nil, noWaitAfter: nil, timeout: nil)
+      def check(force: nil, noWaitAfter: nil, position: nil, timeout: nil)
         params = {
           force: force,
           noWaitAfter:  noWaitAfter,
+          position: position,
           timeout: timeout,
         }.compact
         @channel.send_message_to_server('check', params)
@@ -230,10 +242,11 @@ module Playwright
         nil
       end
 
-      def uncheck(force: nil, noWaitAfter: nil, timeout: nil)
+      def uncheck(force: nil, noWaitAfter: nil, position: nil, timeout: nil)
         params = {
           force: force,
           noWaitAfter:  noWaitAfter,
+          position: position,
           timeout: timeout,
         }.compact
         @channel.send_message_to_server('uncheck', params)

data/lib/playwright/channel_owners/frame.rb

@@ -1,7 +1,7 @@
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_frame.py
   define_channel_owner :Frame do
-    def after_initialize
+    private def after_initialize
       if @initializer['parentFrame']
         @parent_frame = ChannelOwners::Frame.from(@initializer['parentFrame'])
         @parent_frame.send(:append_child_frame_from_child, self)
@@ -98,6 +98,15 @@ module Playwright
       request&.response
     end
 
+    def wait_for_url(url, timeout: nil, waitUntil: nil)
+      matcher = UrlMatcher.new(url)
+      if matcher.match?(@url)
+        wait_for_load_state(state: waitUntil, timeout: timeout)
+      else
+        expect_navigation(timeout: timeout, url: url, waitUntil: waitUntil)
+      end
+    end
+
     def wait_for_load_state(state: nil, timeout: nil)
       option_state = state || 'load'
       option_timeout = timeout || @page.send(:timeout_settings).navigation_timeout
@@ -398,8 +407,20 @@ module Playwright
       nil
     end
 
-    def select_option(selector, values, noWaitAfter: nil, timeout: nil)
-      base_params = SelectOptionValues.new(values).as_params
+    def select_option(
+          selector,
+          element: nil,
+          index: nil,
+          value: nil,
+          label: nil,
+          noWaitAfter: nil,
+          timeout: nil)
+      base_params = SelectOptionValues.new(
+        element: element,
+        index: index,
+        value: value,
+        label: label,
+      ).as_params
       params = base_params + { selector: selector, noWaitAfter: noWaitAfter, timeout: timeout }.compact
       @channel.send_message_to_server('selectOption', params)
 
@@ -452,11 +473,18 @@ module Playwright
       nil
     end
 
-    def check(selector, force: nil, noWaitAfter: nil, timeout: nil)
+    def check(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
       params = {
         selector: selector,
         force: force,
         noWaitAfter:  noWaitAfter,
+        position: position,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('check', params)
@@ -464,11 +492,18 @@ module Playwright
       nil
     end
 
-    def uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil)
+    def uncheck(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
       params = {
         selector: selector,
         force: force,
         noWaitAfter:  noWaitAfter,
+        position: position,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('uncheck', params)

data/lib/playwright/channel_owners/js_handle.rb

@@ -1,6 +1,6 @@
 module Playwright
   define_channel_owner :JSHandle do
-    def after_initialize
+    private def after_initialize
       @preview = @initializer['preview']
       @channel.on('previewUpdated', method(:on_preview_updated))
     end
@@ -9,8 +9,8 @@ module Playwright
       @preview
     end
 
-    private def on_preview_updated(preview)
-      @preview = preview
+    private def on_preview_updated(params)
+      @preview = params['preview']
     end
 
     def evaluate(pageFunction, arg: nil)

data/lib/playwright/channel_owners/page.rb

@@ -6,7 +6,7 @@ module Playwright
     include Utils::Errors::SafeCloseError
     attr_writer :owned_context
 
-    def after_initialize
+    private def after_initialize
       @browser_context = @parent
       @timeout_settings = TimeoutSettings.new(@browser_context.send(:_timeout_settings))
       @accessibility = Accessibility.new(@channel)
@@ -14,12 +14,21 @@ module Playwright
       @mouse = MouseImpl.new(@channel)
       @touchscreen = TouchscreenImpl.new(@channel)
 
-      @viewport_size = @initializer['viewportSize']
+      if @initializer['viewportSize']
+        @viewport_size = {
+          width: @initializer['viewportSize']['width'],
+          height: @initializer['viewportSize']['height'],
+        }
+      end
       @closed = false
+      @bindings = {}
+      @routes = Set.new
+
       @main_frame = ChannelOwners::Frame.from(@initializer['mainFrame'])
       @main_frame.send(:update_page_from_page, self)
       @frames = Set.new
       @frames << @main_frame
+      @opener = ChannelOwners::Page.from_nullable(@initializer['opener'])
 
       @channel.once('close', ->(_) { on_close })
       @channel.on('console', ->(params) {
@@ -29,9 +38,7 @@ module Playwright
       @channel.on('crash', ->(_) { emit(Events::Page::Crash) })
       @channel.on('dialog', method(:on_dialog))
       @channel.on('domcontentloaded', ->(_) { emit(Events::Page::DOMContentLoaded) })
-      @channel.on('download', ->(params) {
-        emit(Events::Page::Download, ChannelOwners::Download.from(params['download']))
-      })
+      @channel.on('download', method(:on_download))
       @channel.on('fileChooser', ->(params) {
         chooser = FileChooserImpl.new(
                     page: self,
@@ -49,9 +56,6 @@ module Playwright
       @channel.on('pageError', ->(params) {
         emit(Events::Page::PageError, Error.parse(params['error']['error']))
       })
-      @channel.on('popup', ->(params) {
-        emit(Events::Page::Popup, ChannelOwners::Page.from(params['page']))
-      })
       @channel.on('request', ->(params) {
         emit(Events::Page::Request, ChannelOwners::Request.from(params['request']))
       })
@@ -74,9 +78,7 @@ module Playwright
       @channel.on('route', ->(params) {
         on_route(ChannelOwners::Route.from(params['route']), ChannelOwners::Request.from(params['request']))
       })
-      @channel.on('video', ->(params) {
-        video.send(:update_relative_path, params['relativePath'])
-      })
+      @channel.on('video', method(:on_video))
       @channel.on('webSocket', ->(params) {
         emit(Events::Page::WebSocket, ChannelOwners::WebSocket.from(params['webSocket']))
       })
@@ -96,12 +98,12 @@ module Playwright
     private def on_request_failed(request, response_end_timing, failure_text)
       request.send(:update_failure_text, failure_text)
       request.send(:update_response_end_timing, response_end_timing)
-      emit(Events::Page::RequestFailed)
+      emit(Events::Page::RequestFailed, request)
     end
 
     private def on_request_finished(request, response_end_timing)
       request.send(:update_response_end_timing, response_end_timing)
-      emit(Events::Page::RequestFinished)
+      emit(Events::Page::RequestFinished, request)
     end
 
     private def on_frame_attached(frame)
@@ -117,8 +119,15 @@ module Playwright
     end
 
     private def on_route(route, request)
-      # @routes.each ...
-      @browser_context.send(:on_route, route, request)
+      # It is not desired to use PlaywrightApi.wrap directly.
+      # However it is a little difficult to define wrapper for `handler` parameter in generate_api.
+      # Just a workaround...
+      wrapped_route = PlaywrightApi.wrap(route)
+      wrapped_request = PlaywrightApi.wrap(request)
+
+      if @routes.none? { |handler_entry| handler_entry.handle(wrapped_route, wrapped_request) }
+        @browser_context.send(:on_route, route, request)
+      end
     end
 
     private def on_close
@@ -130,14 +139,28 @@ module Playwright
     private def on_dialog(params)
       dialog = ChannelOwners::Dialog.from(params['dialog'])
       unless emit(Events::Page::Dialog, dialog)
-        dialog.dismiss # FIXME: this should be asynchronous
+        dialog.dismiss
       end
     end
 
+    private def on_download(params)
+      download = Download.new(
+        url: params['url'],
+        suggested_filename: params['suggestedFilename'],
+        artifact: ChannelOwners::Artifact.from(params['artifact']),
+      )
+      emit(Events::Page::Download, download)
+    end
+
+    private def on_video(params)
+      artifact = ChannelOwners::Artifact.from(params['artifact'])
+      video.send(:set_artifact, artifact)
+    end
+
     # @override
     def on(event, callback)
       if event == Events::Page::FileChooser && listener_count(event) == 0
-        @channel.send_no_reply('setFileChooserInterceptedNoReply', intercepted: true)
+        @channel.async_send_message_to_server('setFileChooserInterceptedNoReply', intercepted: true)
       end
       super
     end
@@ -145,7 +168,7 @@ module Playwright
     # @override
     def once(event, callback)
       if event == Events::Page::FileChooser && listener_count(event) == 0
-        @channel.send_no_reply('setFileChooserInterceptedNoReply', intercepted: true)
+        @channel.async_send_message_to_server('setFileChooserInterceptedNoReply', intercepted: true)
       end
       super
     end
@@ -154,7 +177,7 @@ module Playwright
     def off(event, callback)
       super
       if event == Events::Page::FileChooser && listener_count(event) == 0
-        @channel.send_no_reply('setFileChooserInterceptedNoReply', intercepted: false)
+        @channel.async_send_message_to_server('setFileChooserInterceptedNoReply', intercepted: false)
       end
     end
 
@@ -163,18 +186,20 @@ module Playwright
     end
 
     def opener
-      resp = @channel.send_message_to_server('opener')
-      ChannelOwners::Page.from(resp)
+      if @opener&.closed?
+        nil
+      else
+        @opener
+      end
     end
 
-    def frame(frameSelector)
-      name, url =
-        if frameSelector.is_a?(Hash)
-          [frameSelector[:name], frameSelector[:url]]
-        else
-          [frameSelector, nil]
-        end
+    private def emit_popup_event_from_browser_context
+      if @opener && !@opener.closed?
+        @opener.emit(Events::Page::Popup, self)
+      end
+    end
 
+    def frame(name: nil, url: nil)
       if name
         @frames.find { |f| f.name == name }
       elsif url
@@ -318,6 +343,10 @@ module Playwright
       @main_frame.wait_for_load_state(state: state, timeout: timeout)
     end
 
+    def wait_for_url(url, timeout: nil, waitUntil: nil)
+      @main_frame.wait_for_url(url, timeout: timeout,  waitUntil: waitUntil)
+    end
+
     def go_back(timeout: nil, waitUntil: nil)
       params = { timeout: timeout, waitUntil: waitUntil }.compact
       resp = @channel.send_message_to_server('goBack', params)
@@ -351,12 +380,37 @@ module Playwright
       nil
     end
 
-    def add_init_script(script, arg: nil)
+    def add_init_script(path: nil, script: nil)
+      source =
+        if path
+          File.read(path)
+        elsif script
+          script
+        else
+          raise ArgumentError.new('Either path or script parameter must be specified')
+        end
+
       @channel.send_message_to_server('addInitScript', source: script)
-      # FIXME: handling `arg` for function `script`
       nil
     end
 
+    def route(url, handler)
+      entry = RouteHandlerEntry.new(url, handler)
+      @routes << entry
+      if @routes.count >= 1
+        @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: true)
+      end
+    end
+
+    def unroute(url, handler: nil)
+      @routes.reject! do |handler_entry|
+        handler_entry.same_value?(url: url, handler: handler)
+      end
+      if @routes.count == 0
+        @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
+      end
+    end
+
     def screenshot(
       path: nil,
       type: nil,
@@ -502,8 +556,23 @@ module Playwright
       )
     end
 
-    def select_option(selector, values, noWaitAfter: nil, timeout: nil)
-      @main_frame.select_option(selector, values, noWaitAfter: noWaitAfter, timeout: timeout)
+    def select_option(
+          selector,
+          element: nil,
+          index: nil,
+          value: nil,
+          label: nil,
+          noWaitAfter: nil,
+          timeout: nil)
+      @main_frame.select_option(
+        selector,
+        element: element,
+        index: index,
+        value: value,
+        label: label,
+        noWaitAfter: noWaitAfter,
+        timeout: timeout,
+      )
     end
 
     def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
@@ -530,12 +599,24 @@ module Playwright
       @main_frame.press(selector, key, delay: delay, noWaitAfter: noWaitAfter, timeout: timeout)
     end
 
-    def check(selector, force: nil, noWaitAfter: nil, timeout: nil)
-      @main_frame.check(selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
+    def check(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
+      @main_frame.check(selector, force: force, noWaitAfter: noWaitAfter, position: position, timeout: timeout)
     end
 
-    def uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil)
-      @main_frame.uncheck(selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
+    def uncheck(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
+      @main_frame.uncheck(selector, force: force, noWaitAfter: noWaitAfter, position: position, timeout: timeout)
     end
 
     def wait_for_function(pageFunction, arg: nil, polling: nil, timeout: nil)
@@ -581,6 +662,36 @@ module Playwright
       decoded_binary
     end
 
+    def video
+      return nil unless @browser_context.send(:has_record_video_option?)
+      @video ||= Video.new(self)
+    end
+
+    def start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      params = {
+        resetOnNavigation: resetOnNavigation,
+        reportAnonymousScripts: reportAnonymousScripts,
+      }.compact
+
+      @channel.send_message_to_server('startJSCoverage', params)
+    end
+
+    def stop_js_coverage
+      @channel.send_message_to_server('stopJSCoverage')
+    end
+
+    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      params = {
+        resetOnNavigation: resetOnNavigation,
+      }.compact
+
+      @channel.send_message_to_server('startCSSCoverage', params)
+    end
+
+    def stop_css_coverage
+      @channel.send_message_to_server('stopCSSCoverage')
+    end
+
     class CrashedError < StandardError
       def initialize
         super('Page crashed')
@@ -599,20 +710,9 @@ module Playwright
       end
     end
 
-    def expect_event(event, optionsOrPredicate: nil, &block)
-      predicate, timeout =
-        case optionsOrPredicate
-        when Proc
-          [optionsOrPredicate, nil]
-        when Hash
-          [optionsOrPredicate[:predicate], optionsOrPredicate[:timeout]]
-        else
-          [nil, nil]
-        end
-      timeout ||= @timeout_settings.timeout
-
+    def expect_event(event, predicate: nil, timeout: nil, &block)
       wait_helper = WaitHelper.new
-      wait_helper.reject_on_timeout(timeout, "Timeout while waiting for event \"#{event}\"")
+      wait_helper.reject_on_timeout(timeout || @timeout_settings.timeout, "Timeout while waiting for event \"#{event}\"")
 
       unless event == Events::Page::Crash
         wait_helper.reject_on_event(self, Events::Page::Crash, CrashedError.new)
@@ -629,6 +729,18 @@ module Playwright
       wait_helper.promise.value!
     end
 
+    def expect_console_message(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::Console, predicate: predicate, timeout: timeout, &block)
+    end
+
+    def expect_download(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::Download, predicate: predicate, timeout: timeout, &block)
+    end
+
+    def expect_file_chooser(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::FileChooser, predicate: predicate, timeout: timeout, &block)
+    end
+
     def expect_navigation(timeout: nil, url: nil, waitUntil: nil, &block)
       @main_frame.expect_navigation(
         timeout: timeout,
@@ -637,6 +749,10 @@ module Playwright
         &block)
     end
 
+    def expect_popup(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::Popup, predicate: predicate, timeout: timeout, &block)
+    end
+
     def expect_request(urlOrPredicate, timeout: nil)
       predicate =
         case urlOrPredicate
@@ -649,7 +765,7 @@ module Playwright
           -> (_) { true }
         end
 
-      expect_event(Events::Page::Request, optionsOrPredicate: { predicate: predicate, timeout: timeout})
+      expect_event(Events::Page::Request, predicate: predicate, timeout: timeout)
     end
 
     def expect_response(urlOrPredicate, timeout: nil)
@@ -664,7 +780,7 @@ module Playwright
           -> (_) { true }
         end
 
-      expect_event(Events::Page::Response, optionsOrPredicate: { predicate: predicate, timeout: timeout})
+      expect_event(Events::Page::Response, predicate: predicate, timeout: timeout)
     end
 
     # called from BrowserContext#on_page with send(:update_browser_context, page), so keep private.
@@ -677,5 +793,10 @@ module Playwright
     private def timeout_settings
       @timeout_settings
     end
+
+    # called from BrowserContext#expose_binding
+    private def has_bindings?(name)
+      @bindings.key?(name)
+    end
   end
 end