apparition 0.1.0 → 0.6.0

data/lib/capybara/apparition/configuration.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Capybara::Apparition
+  class Configuration
+    class << self
+    private
+
+      def instance
+        @instance ||= new
+      end
+    end
+
+    def self.to_hash
+      instance.freeze.to_hash
+    end
+
+    def self.modify
+      raise 'All configuration must take place before the driver starts' if instance.frozen?
+    end
+
+    attr_accessor :allowed_urls
+    attr_writer :block_unknown_urls
+    attr_accessor :blocked_urls
+    attr_accessor :debug
+    attr_writer :ignore_ssl_errors
+    attr_accessor :proxy
+    attr_accessor :stderr
+    attr_accessor :timeout
+    attr_writer :skip_image_loading
+    attr_accessor :raise_javascript_errors
+
+    def initialize
+      @allowed_urls = []
+      @blocked_urls = []
+      @block_unknown_urls = false
+      @debug = false
+      @ignore_ssl_errors = false
+      @proxy = nil
+      @skip_image_loading = false
+      @stderr = $stderr
+      @timeout = -1
+      @raise_javascript_errors = false
+    end
+
+    def allow_url(url)
+      @allowed_urls << url
+    end
+
+    def block_url(url)
+      @blocked_urls << url
+    end
+
+    def block_unknown_urls
+      @block_unknown_urls = true
+    end
+
+    def block_unknown_urls?
+      @block_unknown_urls
+    end
+
+    def allow_unknown_urls
+      allow_url('*')
+    end
+
+    def ignore_ssl_errors
+      @ignore_ssl_errors = true
+    end
+
+    def ignore_ssl_errors?
+      @ignore_ssl_errors
+    end
+
+    def skip_image_loading
+      @skip_image_loading = true
+    end
+
+    def skip_image_loading?
+      @skip_image_loading
+    end
+
+    def use_proxy(proxy)
+      @proxy = proxy
+    end
+
+    def to_hash
+      {
+        url_whitelist: allowed_urls,
+        block_unknown_urls: block_unknown_urls?,
+        url_blacklist: blocked_urls,
+        debug: debug,
+        ignore_ssl_errors: ignore_ssl_errors?,
+        proxy: proxy,
+        skip_image_loading: skip_image_loading?,
+        stderr: stderr,
+        timeout: timeout,
+        js_errors: raise_javascript_errors
+      }
+    end
+  end
+end

data/lib/capybara/apparition/console.rb

@@ -8,8 +8,15 @@ module Capybara::Apparition
     end
 
     def log(type, message, **options)
+      return unless @logger
+
       @messages << OpenStruct.new(type: type, message: message, **options)
-      @logger&.puts "#{type}: #{message}"
+      message_to_log = "#{type}: #{message}"
+      if @logger.respond_to?(:puts)
+        @logger.puts(message_to_log)
+      else
+        @logger.info(message_to_log)
+      end
     end
 
     def clear

data/lib/capybara/apparition/dev_tools_protocol/remote_object.rb

@@ -19,13 +19,18 @@ module Capybara::Apparition
       def cyclic_checked_value(object_cache)
         if object?
           if array?
-            extract_properties_array(get_remote_object(object_id), object_cache)
+            extract_properties_array(get_remote_object(id), object_cache)
           elsif node?
             params
-          elsif object_class?
-            extract_properties_object(get_remote_object(object_id), object_cache)
+          elsif date?
+            res = get_date_string(id)
+            DateTime.parse(res)
           elsif window_class?
-            { object_id: object_id }
+            { object_id: id }
+          elsif validity_state?
+            extract_properties_object(get_remote_object(id, false), object_cache)
+          elsif object_class? || css_style? || classname?
+            extract_properties_object(get_remote_object(id), object_cache)
           else
             params['value']
           end
@@ -38,13 +43,17 @@ module Capybara::Apparition
 
       def object?; type == 'object' end
       def array?; subtype == 'array' end
+      def date?; subtype == 'date' end
       def node?; subtype == 'node' end
       def object_class?; classname == 'Object' end
+      def css_style?; classname == 'CSSStyleDeclaration' end
       def window_class?; classname == 'Window' end
+      def validity_state?; classname == 'ValidityState' end
+      def classname?; !classname.nil? end
 
       def type; params['type'] end
       def subtype; params['subtype'] end
-      def object_id; params['objectId'] end
+      def id; params['objectId'] end
       def classname; params['className'] end
 
       def extract_properties_array(properties, object_cache)
@@ -80,8 +89,15 @@ module Capybara::Apparition
         end
       end
 
-      def get_remote_object(id)
-        @page.command('Runtime.getProperties', objectId: id, ownProperties: true)['result']
+      def get_remote_object(id, own_props = true)
+        @page.command('Runtime.getProperties', objectId: id, ownProperties: own_props)['result']
+      end
+
+      def get_date_string(id)
+        @page.command('Runtime.callFunctionOn',
+                      functionDeclaration: 'function(){ return this.toUTCString() }',
+                      objectId: id,
+                      returnByValue: true).dig('result', 'value')
       end
     end
   end

data/lib/capybara/apparition/dev_tools_protocol/session.rb

@@ -3,12 +3,11 @@
 module Capybara::Apparition
   module DevToolsProtocol
     class Session
-      attr_reader :browser, :connection, :target_id, :session_id
+      attr_reader :browser, :connection, :session_id
 
-      def initialize(browser, connection, target_id, session_id)
+      def initialize(browser, connection, session_id)
         @browser = browser
         @connection = connection
-        @target_id = target_id
         @session_id = session_id
         @handlers = []
       end
@@ -23,7 +22,7 @@ module Capybara::Apparition
       end
 
       def async_command(name, **params)
-        send_cmd(name, params).discard_result
+        send_cmd(name, **params).discard_result
       end
 
       def async_commands(*names)

data/lib/capybara/apparition/driver.rb

@@ -3,7 +3,8 @@
 require 'uri'
 require 'forwardable'
 require 'capybara/apparition/driver/chrome_client'
-require 'capybara/apparition/driver/launcher'
+require 'capybara/apparition/configuration'
+require 'capybara/apparition/browser/launcher'
 
 module Capybara::Apparition
   class Driver < Capybara::Driver::Base
@@ -15,7 +16,7 @@ module Capybara::Apparition
 
     delegate %i[restart current_url status_code body
                 title frame_title frame_url switch_to_frame
-                window_handles close_window open_new_window switch_to_window within_window
+                window_handles close_window switch_to_window
                 paper_size= zoom_factor=
                 scroll_to
                 network_traffic clear_network_traffic
@@ -32,6 +33,7 @@ module Capybara::Apparition
       @browser   = nil
       @inspector = nil
       @client    = nil
+      @launcher  = nil
       @started   = false
     end
 
@@ -45,14 +47,14 @@ module Capybara::Apparition
 
     def browser
       @browser ||= begin
-        browser = Browser.new(client, browser_logger)
-        browser.js_errors = options.fetch(:js_errors, true)
-        browser.ignore_https_errors = options.fetch(:ignore_https_errors, false)
-        browser.extensions = options.fetch(:extensions, [])
-        browser.debug      = options.fetch(:debug, false)
-        browser.url_blacklist = options[:url_blacklist] || []
-        browser.url_whitelist = options[:url_whitelist] || []
-        browser
+        Browser.new(client, browser_logger) do |browser|
+          browser.js_errors = options.fetch(:js_errors, true)
+          browser.ignore_https_errors = options.fetch(:ignore_https_errors, false)
+          browser.extensions = options.fetch(:extensions, [])
+          browser.debug      = options.fetch(:debug, false)
+          browser.url_blacklist = options[:url_blacklist] || []
+          browser.url_whitelist = options[:url_whitelist] || []
+        end
       end
     end
 
@@ -62,10 +64,7 @@ module Capybara::Apparition
 
     def client
       @client ||= begin
-        @launcher ||= Browser::Launcher.start(
-          headless: options.fetch(:headless, true),
-          browser_options: browser_options
-        )
+        @launcher ||= Browser::Launcher.start(options)
         ws_url = @launcher.ws_url
         ::Capybara::Apparition::ChromeClient.client(ws_url.to_s)
       end
@@ -98,7 +97,9 @@ module Capybara::Apparition
     end
 
     def find(method, selector)
-      browser.find(method, selector).map { |page_id, id| Capybara::Apparition::Node.new(self, page_id, id) }
+      browser.find(method, selector).map do |page_id, id, attrs|
+        Capybara::Apparition::Node.new(self, page_id, id, attrs)
+      end
     end
 
     def find_xpath(selector)
@@ -114,20 +115,26 @@ module Capybara::Apparition
     end
 
     def evaluate_script(script, *args)
-      unwrap_script_result(browser.evaluate(script, *native_args(args)))
+      retry_if_wrong_world do
+        unwrap_script_result(browser.evaluate(script, *native_args(args)))
+      end
     end
 
     def evaluate_async_script(script, *args)
-      unwrap_script_result(browser.evaluate_async(script, session_wait_time, *native_args(args)))
+      retry_if_wrong_world do
+        unwrap_script_result(browser.evaluate_async(script, session_wait_time, *native_args(args)))
+      end
     end
 
     def execute_script(script, *args)
-      browser.execute(script, *native_args(args))
+      retry_if_wrong_world do
+        browser.execute(script, *native_args(args))
+      end
       nil
     end
 
     def current_window_handle
-      browser.window_handle
+      browser.current_window_handle
     end
 
     def no_such_window_error
@@ -158,28 +165,33 @@ module Capybara::Apparition
     def resize(width, height)
       browser.resize(width, height, screen: options[:screen_size])
     end
-    alias resize_window resize
+
+    def resize_window(width, height)
+      warn '[DEPRECATION] Capybara::Apparition::Driver#resize_window ' \
+        'is deprecated. Please use Capybara::Window#resize_to instead.'
+      resize(width, height)
+    end
 
     def resize_window_to(handle, width, height)
-      within_window(handle) do
+      _within_window(handle) do
         resize(width, height)
       end
     end
 
     def maximize_window(handle)
-      within_window(handle) do
+      _within_window(handle) do
         browser.maximize
       end
     end
 
     def fullscreen_window(handle)
-      within_window(handle) do
+      _within_window(handle) do
         browser.fullscreen
       end
     end
 
     def window_size(handle)
-      within_window(handle) do
+      _within_window(handle) do
         evaluate_script('[window.innerWidth, window.innerHeight]')
       end
     end
@@ -201,14 +213,12 @@ module Capybara::Apparition
     end
 
     def add_header(name, value, options = {})
-      browser.add_header({ name => value }, { permanent: true }.merge(options))
+      browser.add_header({ name => value }, **{ permanent: true }.merge(options))
     end
     alias_method :header, :add_header
 
     def response_headers
-      browser.response_headers.each_with_object({}) do |(key, value), hsh|
-        hsh[key.split('-').map(&:capitalize).join('-')] = value
-      end
+      browser.response_headers.transform_keys { |key| key.split('-').map(&:capitalize).join('-') }
     end
 
     def set_cookie(name, value = nil, options = {})
@@ -228,7 +238,7 @@ module Capybara::Apparition
     end
 
     def proxy_authorize(user = nil, password = nil)
-      browser.set_proxy_aauth(user, password)
+      browser.set_proxy_auth(user, password)
     end
 
     def basic_authorize(user = nil, password = nil)
@@ -266,12 +276,12 @@ module Capybara::Apparition
         write.close
       end
 
-      STDERR.puts "Apparition execution paused. Press enter (or run 'kill -CONT #{Process.pid}') to continue."
+      STDERR.puts "Apparition execution paused. Press enter (or run 'kill -CONT #{Process.pid}') to continue." # rubocop:disable Style/StderrPuts
 
       signal = false
       old_trap = trap('SIGCONT') do
         signal = true
-        STDERR.puts "\nSignal SIGCONT received"
+        STDERR.puts "\nSignal SIGCONT received" # rubocop:disable Style/StderrPuts
       end
       # wait for data on STDIN or signal SIGCONT received
       keyboard = IO.select([read], nil, nil, 1) until keyboard || signal
@@ -280,13 +290,13 @@ module Capybara::Apparition
         begin
           input = read.read_nonblock(80) # clear out the read buffer
           puts unless input&.end_with?("\n")
-        rescue EOFError, IO::WaitReadable # rubocop:disable Lint/HandleExceptions
+        rescue EOFError, IO::WaitReadable
           # Ignore problems reading from STDIN.
         end
       end
     ensure
       trap('SIGCONT', old_trap) # Restore the previous signal handler, if there was one.
-      STDERR.puts 'Continuing'
+      STDERR.puts 'Continuing' # rubocop:disable Style/StderrPuts
     end
 
     def wait?
@@ -336,8 +346,53 @@ module Capybara::Apparition
       console_messages('error')
     end
 
+    def within_window(selector, &block)
+      warn 'Driver#within_window is deprecated, please switch to using Session#within_window instead.'
+      _within_window(selector, &block)
+      orig_window = current_window_handle
+      switch_to_window(selector)
+      begin
+        yield
+      ensure
+        switch_to_window(orig_window)
+      end
+    end
+
+    def version
+      chrome_version = browser.command('Browser.getVersion')
+      format(VERSION_STRING,
+             capybara: Capybara::VERSION,
+             apparition: Capybara::Apparition::VERSION,
+             chrome: chrome_version['product'])
+    end
+
+    def open_new_window
+      # needed because Capybara does arity detection on this method
+      browser.open_new_window
+    end
+
   private
 
+    def retry_if_wrong_world
+      timer = Capybara::Helpers.timer(expire_in: session_wait_time)
+      begin
+        yield
+      rescue WrongWorld
+        retry unless timer.expired?
+        raise
+      end
+    end
+
+    def _within_window(selector)
+      orig_window = current_window_handle
+      switch_to_window(selector)
+      begin
+        yield
+      ensure
+        switch_to_window(orig_window)
+      end
+    end
+
     def browser_options
       @options[:browser_options]
     end
@@ -363,7 +418,16 @@ module Capybara::Apparition
       if @options[:skip_image_loading]
         browser_options['blink-settings'] = [browser_options['blink-settings'], 'imagesEnabled=false'].compact.join(',')
       end
+
       @options[:browser_options] = browser_options
+      process_cw_options(@options[:cw_options])
+    end
+
+    def process_cw_options(cw_options)
+      return if cw_options.nil?
+
+      (options[:url_blacklist] ||= []).concat cw_options[:url_blacklist]
+      options[:js_errors] ||= cw_options[:js_errors]
     end
 
     def process_browser_options(options)
@@ -377,7 +441,7 @@ module Capybara::Apparition
           end
         end
       when Hash
-        options.each_with_object({}) { |(option, val), hsh| hsh[option.to_s.tr('_', '-')] = val }
+        options.transform_keys { |option| option.to_s.tr('_', '-') }
       else
         raise ArgumentError, 'browser_options must be an Array or a Hash'
       end
@@ -454,7 +518,8 @@ module Capybara::Apparition
         object_cache[arg]
       when Hash
         if (arg['subtype'] == 'node') && arg['objectId']
-          Capybara::Apparition::Node.new(self, browser.current_page, arg['objectId'])
+          tag_name = arg['description'].split(/[.#]/, 2)[0]
+          Capybara::Apparition::Node.new(self, browser.current_page, arg['objectId'], tag_name: tag_name)
         else
           object_cache[arg] = {}
           arg.each { |k, v| object_cache[arg][k] = unwrap_script_result(v, object_cache) }
@@ -464,5 +529,12 @@ module Capybara::Apparition
         arg
       end
     end
+
+    VERSION_STRING = <<~VERSION
+      Versions in use:
+      Capybara: %<capybara>s
+      Apparition: %<apparition>s
+      Chrome: %<chrome>s
+    VERSION
   end
 end