apparition 0.1.0 → 0.6.0

data/lib/capybara/apparition/driver/chrome_client.rb

@@ -92,7 +92,7 @@ module Capybara::Apparition
     def send_msg(command, params)
       msg_id, msg = generate_msg(command, params)
       @send_mutex.synchronize do
-        puts "#{Time.now.to_i}: sending msg: #{msg}" if ENV['DEBUG']
+        puts "#{Time.now.to_i}: sending msg: #{msg}" if ENV['DEBUG'] == 'V'
         @ws.send_msg(msg)
       end
       msg_id
@@ -141,7 +141,7 @@ module Capybara::Apparition
 
     def read_msg
       msg = JSON.parse(@ws.read_msg)
-      puts "#{Time.now.to_i}: got msg: #{msg}" if ENV['DEBUG']
+      puts "#{Time.now.to_i}: got msg: #{msg}" if ENV['DEBUG'] == 'V'
       # Check if it's an event and push on event queue
       @events.push msg.dup if msg['method']
 
@@ -162,7 +162,7 @@ module Capybara::Apparition
         @msg_mutex.synchronize do
           @message_available.wait(@msg_mutex, 0.1)
           (@responses.keys & @async_ids).each do |msg_id|
-            puts "Cleaning up response for #{msg_id}" if ENV['DEBUG'] == 'v'
+            puts "Cleaning up response for #{msg_id}" if ENV['DEBUG'] == 'V'
             @responses.delete(msg_id)
             @async_ids.delete(msg_id)
           end
@@ -206,7 +206,7 @@ module Capybara::Apparition
       event_name = event['method']
       handlers[event_name].each do |handler|
         puts "Calling handler for #{event_name}" if ENV['DEBUG'] == 'V'
-        handler.call(event['params'])
+        handler.call(**event['params'].transform_keys(&method(:snake_sym)))
       end
     end
 
@@ -222,12 +222,17 @@ module Capybara::Apparition
       @async_response_handler.abort_on_exception = true
 
       @listener = Thread.new do
-        begin
-          listen
-        rescue EOFError # rubocop:disable Lint/HandleExceptions
-        end
+        listen
+      rescue EOFError # rubocop:disable Lint/SuppressedException
       end
       # @listener.abort_on_exception = true
     end
+
+    def snake_sym(str)
+      str.gsub(/([a-z\d])([A-Z])/, '\1_\2')
+         .tr('-', '_')
+         .downcase
+         .to_sym
+    end
   end
 end

data/lib/capybara/apparition/driver/response.rb

@@ -15,7 +15,7 @@ module Capybara::Apparition
           handle_error(resp['error']) if resp['error']
           resp
         end.last
-        puts "Processed msg: #{@msg_ids.last} in #{Time.now - @send_time} seconds" if ENV['DEBUG']
+        puts "Processed msg: #{@msg_ids.last} in #{Time.now - @send_time} seconds" if ENV['DEBUG'] == 'V'
 
         response['result']
       end

data/lib/capybara/apparition/driver/web_socket_client.rb

@@ -63,6 +63,7 @@ module Capybara::Apparition
 
   class Socket
     attr_reader :url
+
     def initialize(url)
       @url = url
       uri = URI.parse(url)

data/lib/capybara/apparition/errors.rb

@@ -45,7 +45,7 @@ module Capybara
       end
 
       def message
-        'There was an error inside the Puppeteer portion of Apparition. ' \
+        'There was an error inside Apparition. ' \
           'If this is the error returned, and not the cause of a more detailed error response, ' \
           'this is probably a bug, so please report it. ' \
           "\n\n#{name}: #{error_parameters}"
@@ -57,7 +57,7 @@ module Capybara
       #   response['args'].first.map { |data| JSErrorItem.new(data['message'], data['stack']) }
       # end
       def javascript_errors
-        [response]
+        [message: response]
       end
 
       def message
@@ -65,7 +65,7 @@ module Capybara
           "If you don't care about these errors, you can ignore them by " \
           'setting js_errors: false in your Apparition configuration (see ' \
           'documentation for details).' \
-          "\n\n#{javascript_errors.map(&:to_s).join("\n")}"
+          "\n\n#{javascript_errors.map { |err| err[:message] }.join("\n")}"
       end
     end
 

data/lib/capybara/apparition/network_traffic/error.rb

@@ -3,6 +3,7 @@
 module Capybara::Apparition::NetworkTraffic
   class Error
     attr_reader :url, :code, :description
+
     def initialize(url:, code:, description:)
       @url = url
       @code = code

data/lib/capybara/apparition/network_traffic/request.rb

@@ -17,23 +17,23 @@ module Capybara::Apparition::NetworkTraffic
     end
 
     def request_id
-      @data['requestId']
+      @data[:request_id]
     end
 
     def url
-      @data.dig('request', 'url')
+      @data[:request]&.dig('url')
     end
 
     def method
-      @data.dig('request', 'method')
+      @data[:request]&.dig('method')
     end
 
     def headers
-      @data.dig('requst', 'headers')
+      @data[:request]&.dig('headers')
     end
 
     def time
-      @data['timestamp'] && Time.parse(@data['timestamp'])
+      @data[:timestamp] && Time.parse(@data[:timestamp])
     end
 
     def blocked?

data/lib/capybara/apparition/node.rb

@@ -11,8 +11,8 @@ module Capybara::Apparition
 
     attr_reader :page_id
 
-    def initialize(driver, page, remote_object)
-      super(driver, self)
+    def initialize(driver, page, remote_object, initial_cache)
+      super(driver, self, initial_cache)
       @page = page
       @remote_object = remote_object
     end
@@ -30,12 +30,13 @@ module Capybara::Apparition
     def find(method, selector)
       js = method == :css ? FIND_CSS_JS : FIND_XPATH_JS
       evaluate_on(js, value: selector).map do |r_o|
-        Capybara::Apparition::Node.new(driver, @page, r_o['objectId'])
+        tag_name = r_o['description'].split(/[.#]/, 2)[0]
+        Capybara::Apparition::Node.new(driver, @page, r_o['objectId'], tag_name: tag_name)
       end
     rescue ::Capybara::Apparition::BrowserError => e
-      raise unless e.name =~ /is not a valid (XPath expression|selector)/
+      raise unless /is not a valid (XPath expression|selector)/.match? e.name
 
-      raise Capybara::Apparition::InvalidSelector, [method, selector]
+      raise Capybara::Apparition::InvalidSelector, 'args' => [method, selector]
     end
 
     def find_xpath(selector)
@@ -71,6 +72,18 @@ module Capybara::Apparition
       visible_text
     end
 
+    # capybara-webkit method
+    def inner_html
+      self[:innerHTML]
+    end
+
+    # capybara-webkit method
+    def inner_html=(value)
+      driver.execute_script <<~JS, self, value
+        arguments[0].innerHTML = arguments[1]
+      JS
+    end
+
     def property(name)
       evaluate_on('name => this[name]', value: name)
     end
@@ -117,11 +130,18 @@ module Capybara::Apparition
           set_time(value)
         when 'datetime-local'
           set_datetime_local(value)
+        when 'color'
+          set_color(value)
+        when 'range'
+          set_range(value)
         else
-          set_text(value.to_s, delay: options.fetch(:delay, 0))
+          set_text(value.to_s, **{ delay: 0 }.merge(options))
         end
       elsif tag_name == 'textarea'
         set_text(value.to_s)
+      elsif tag_name == 'select'
+        warn "Setting the value of a select element via 'set' is deprecated, please use 'select' or 'select_option'."
+        evaluate_on '()=>{ this.value = arguments[0] }', value: value.to_s
       elsif self[:isContentEditable]
         delete_text
         send_keys(value.to_s, delay: options.fetch(:delay, 0))
@@ -150,6 +170,21 @@ module Capybara::Apparition
       evaluate_on VISIBLE_JS
     end
 
+    def obscured?(**)
+      pos = visible_center(allow_scroll: false)
+      return true if pos.nil?
+
+      hit_node = @page.element_from_point(**pos)
+      return true if hit_node.nil?
+
+      begin
+        return evaluate_on('el => !this.contains(el)', objectId: hit_node['objectId'])
+      rescue WrongWorld # rubocop:disable Lint/SuppressedException
+      end
+
+      true
+    end
+
     def checked?
       self[:checked]
     end
@@ -162,20 +197,23 @@ module Capybara::Apparition
       evaluate_on ELEMENT_DISABLED_JS
     end
 
-    def click(keys = [], button: 'left', count: 1, **options)
-      pos = element_click_pos(options)
+    def click(keys = [], button: 'left', count: 1, delay: 0, **options)
+      pos = element_click_pos(**options)
       raise ::Capybara::Apparition::MouseEventImpossible.new(self, 'args' => ['click']) if pos.nil?
 
-      test = mouse_event_test(pos)
+      test = mouse_event_test(**pos)
       raise ::Capybara::Apparition::MouseEventImpossible.new(self, 'args' => ['click']) if test.nil?
-      raise ::Capybara::Apparition::MouseEventFailed.new(self, 'args' => ['click', test.selector, pos]) unless test.success
 
-      @page.mouse.click_at pos.merge(button: button, count: count, modifiers: keys)
+      unless options[:x] && options[:y]
+        raise ::Capybara::Apparition::MouseEventFailed.new(self, 'args' => ['click', test.selector, pos]) unless test.success
+      end
+
+      @page.mouse.click_at(**pos.merge(button: button, count: count, modifiers: keys, delay: delay))
       if ENV['DEBUG']
         begin
-          new_pos = element_click_pos(options)
+          new_pos = element_click_pos(**options)
           puts "Element moved from #{pos} to #{new_pos}" unless pos == new_pos
-        rescue WrongWorld # rubocop:disable Lint/HandleExceptions
+        rescue WrongWorld # rubocop:disable Lint/SuppressedException
         end
       end
       # Wait a short time to see if click triggers page load
@@ -195,7 +233,7 @@ module Capybara::Apparition
       pos = visible_center
       raise ::Capybara::Apparition::MouseEventImpossible.new(self, 'args' => ['hover']) if pos.nil?
 
-      @page.mouse.move_to(pos)
+      @page.mouse.move_to(**pos)
     end
 
     EVENTS = {
@@ -227,15 +265,19 @@ module Capybara::Apparition
       evaluate_on DISPATCH_EVENT_JS, { value: event_type }, { value: name }, value: opts.merge(options)
     end
 
+    def submit
+      evaluate_on '()=>{ this.submit() }'
+    end
+
     def ==(other)
       evaluate_on('el => this == el', objectId: other.id)
     rescue ObsoleteNode
       false
     end
 
-    def send_keys(*keys, delay: 0, **_opts)
+    def send_keys(*keys, delay: 0, **opts)
       click unless evaluate_on CURRENT_NODE_SELECTED_JS
-      @page.keyboard.type(keys, delay: delay)
+      _send_keys(*keys, delay: delay, **opts)
     end
     alias_method :send_key, :send_keys
 
@@ -243,9 +285,13 @@ module Capybara::Apparition
       evaluate_on GET_PATH_JS
     end
 
-    def element_click_pos(x: nil, y: nil, **)
+    def element_click_pos(x: nil, y: nil, offset: nil, **)
       if x && y
-        visible_top_left.tap do |p|
+        if offset == :center
+          visible_center
+        else
+          visible_top_left
+        end.tap do |p|
           p[:x] += x
           p[:y] += y
         end
@@ -255,7 +301,7 @@ module Capybara::Apparition
     end
 
     def visible_top_left
-      rect = in_view_bounding_rect
+      rect = in_view_client_rect
       return nil if rect.nil?
 
       frame_offset = @page.current_frame_offset
@@ -288,8 +334,8 @@ module Capybara::Apparition
       end
     end
 
-    def visible_center
-      rect = in_view_bounding_rect
+    def visible_center(allow_scroll: true)
+      rect = in_view_client_rect(allow_scroll: allow_scroll)
       return nil if rect.nil?
 
       frame_offset = @page.current_frame_offset
@@ -332,12 +378,16 @@ module Capybara::Apparition
     end
 
     def top_left
-      result = evaluate_on GET_BOUNDING_CLIENT_RECT_JS
+      result = evaluate_on GET_CLIENT_RECT_JS
       return nil if result.nil?
 
       { x: result['x'], y: result['y'] }
     end
 
+    def rect
+      evaluate_on GET_CLIENT_RECT_JS
+    end
+
     def scroll_by(x, y)
       evaluate_on <<~JS, { value: x }, value: y
         (x, y) => this.scrollBy(x,y)
@@ -382,9 +432,39 @@ module Capybara::Apparition
 
   private
 
-    def in_view_bounding_rect
-      evaluate_on('() => this.scrollIntoViewIfNeeded()')
-      result = evaluate_on GET_BOUNDING_CLIENT_RECT_JS
+    def focus
+      @page.command('DOM.focus', objectId: id)
+    end
+
+    def keys_to_send(value, clear)
+      case clear
+      when :backspace
+        # Clear field by sending the correct number of backspace keys.
+        [:end] + ([:backspace] * self.value.to_s.length) + [value]
+      when :none
+        [value]
+      when Array
+        clear << value
+      else
+        # Clear field by JavaScript assignment of the value property.
+        # Script can change a readonly element which user input cannot, so
+        # don't execute if readonly.
+        driver.execute_script <<~JS, self
+          if (!arguments[0].readOnly) {
+            arguments[0].value = ''
+          }
+        JS
+        [value]
+      end
+    end
+
+    def _send_keys(*keys, delay: 0, **_opts)
+      @page.keyboard.type(keys, delay: delay)
+    end
+
+    def in_view_client_rect(allow_scroll: true)
+      evaluate_on('() => this.scrollIntoViewIfNeeded()') if allow_scroll
+      result = evaluate_on GET_CLIENT_RECT_JS
       result = result['model'] if result && result['model']
       result
     end
@@ -410,26 +490,21 @@ module Capybara::Apparition
       DevToolsProtocol::RemoteObject.new(@page, response['result'] || response['object']).value
     end
 
-    def set_text(value, clear: nil, delay: 0, **_unused)
+    def set_text(value, clear: nil, delay: 0, rapid: nil, **_unused)
       value = value.to_s
       if value.empty? && clear.nil?
         evaluate_on CLEAR_ELEMENT_JS
-      elsif clear == :backspace
-        # Clear field by sending the correct number of backspace keys.
-        backspaces = [:backspace] * self.value.to_s.length
-        send_keys(*([:end] + backspaces + [value]), delay: delay)
-      elsif clear.is_a? Array
-        send_keys(*clear, value, delay: delay)
       else
-        # Clear field by JavaScript assignment of the value property.
-        # Script can change a readonly element which user input cannot, so
-        # don't execute if readonly.
-        driver.execute_script <<~JS, self unless clear == :none
-          if (!arguments[0].readOnly) {
-            arguments[0].value = ''
-          }
-        JS
-        send_keys(value, delay: delay)
+        focus
+        if (rapid && (value.length >= 6)) || ((value.length > 30) && rapid != false)
+          _send_keys(*keys_to_send(value[0..2], clear), delay: delay)
+          driver.execute_script <<~JS, self, value[0...-3]
+            arguments[0].value = arguments[1]
+          JS
+          _send_keys(*keys_to_send(value[-3..-1], :none), delay: delay)
+        else
+          _send_keys(*keys_to_send(value, clear), delay: delay)
+        end
       end
     end
 
@@ -465,6 +540,14 @@ module Capybara::Apparition
       update_value_js(value.to_datetime_str)
     end
 
+    def set_color(value)
+      update_value_js(value.to_s)
+    end
+
+    def set_range(value)
+      update_value_js(value.to_s)
+    end
+
     def update_value_js(value)
       evaluate_on(<<~JS, value: value)
         value => {
@@ -488,7 +571,8 @@ module Capybara::Apparition
       r_o = @page.element_from_point(x: x, y: y)
       return nil unless r_o && r_o['objectId']
 
-      hit_node = Capybara::Apparition::Node.new(driver, @page, r_o['objectId'])
+      tag_name = r_o['description'].split(/[.#]/, 2)[0]
+      hit_node = Capybara::Apparition::Node.new(driver, @page, r_o['objectId'], tag_name: tag_name)
       result = begin
         evaluate_on(<<~JS, objectId: hit_node.id)
           (hit_node) => {
@@ -658,11 +742,14 @@ module Capybara::Apparition
           sel = sel.parentNode;
         }
         let event_options = { bubbles: true, cancelable: true };
+        sel.dispatchEvent(new MouseEvent('mousedown', event_options));
         sel.dispatchEvent(new FocusEvent('focus', event_options));
-
-        this.selected = true
-
-        sel.dispatchEvent(new Event('change', event_options));
+        if (this.selected == false){
+          this.selected = true;
+          sel.dispatchEvent(new Event('change', event_options));
+        }
+        sel.dispatchEvent(new MouseEvent('mouseup', event_options));
+        sel.dispatchEvent(new MouseEvent('click', event_options));
         sel.dispatchEvent(new FocusEvent('blur', event_options));
       }
     JS
@@ -686,7 +773,7 @@ module Capybara::Apparition
     # if an area element, check visibility of relevant image
     VISIBLE_JS = <<~JS
       function(){
-        el = this;
+        let el = this;
         if (el.tagName == 'AREA'){
           const map_name = document.evaluate('./ancestor::map/@name', el, null, XPathResult.STRING_TYPE, null).stringValue;
           el = document.querySelector(`img[usemap='#${map_name}']`);
@@ -704,7 +791,11 @@ module Capybara::Apparition
               (parseFloat(style.opacity) == 0)) {
             return false;
           }
-          el = el.parentElement;
+          var parent = el.parentElement;
+          if (parent && (parent.tagName == 'DETAILS') && !parent.open && (el.tagName != 'SUMMARY')) {
+            return false;
+          }
+          el = parent;
         }
         return true;
       }
@@ -721,9 +812,10 @@ module Capybara::Apparition
       }
     JS
 
-    GET_BOUNDING_CLIENT_RECT_JS = <<~JS
+    GET_CLIENT_RECT_JS = <<~JS
       function(){
-        rect = this.getBoundingClientRect();
+        var rects = [...this.getClientRects()]
+        var rect = rects.find(r => (r.height && r.width)) || this.getBoundingClientRect();
         return rect.toJSON();
       }
     JS