capybara-chrome 0.1.22

data/lib/capybara/chrome/configuration.rb

@@ -0,0 +1,77 @@
+module Capybara::Chrome
+  class Configuration
+
+    DEFAULT_ALLOWED_URLS = [
+      %r(.*127\.0\.0\.1),
+      %r(.*localhost),
+      "data:*,*"
+    ].freeze
+    DEFAULT_MAX_WAIT_TIME = 10
+    DEFAULT_DOWNLOAD_PATH = "/tmp"
+    # set Capybara::Chrome::Configuration.chrome_port = 9222 for easy debugging
+    DEFAULT_CHROME_PORT = nil
+    DEFAULT_TRAP_INTERRUPT = true
+    DEFAULT_DEBUG = false
+
+    attr_accessor :max_wait_time, :download_path, :chrome_port, :trap_interrupt, :debug
+
+    def initialize
+      @allowed_urls = DEFAULT_ALLOWED_URLS.dup
+      @blocked_urls = []
+      @max_wait_time = DEFAULT_MAX_WAIT_TIME
+      @download_path = DEFAULT_DOWNLOAD_PATH
+      @chrome_port = DEFAULT_CHROME_PORT
+      @trap_interrupt = DEFAULT_TRAP_INTERRUPT
+      @debug = DEFAULT_DEBUG
+    end
+
+    def block_unknown_urls
+      @block_unknown_urls = true
+    end
+
+    def allow_unknown_urls
+      allow_url(/.*/)
+    end
+
+    def re_url(url)
+      url.is_a?(Regexp) ? url : Regexp.new(Regexp.escape(url))
+    end
+
+    def allow_url(url)
+      @allowed_urls << re_url(url)
+    end
+
+    def block_url(url)
+      @blocked_urls << re_url(url)
+    end
+
+    def url_match?(pattern, url)
+      pattern === url
+    end
+
+    def url_allowed?(url)
+      @allowed_urls.detect {|pattern| url_match?(pattern, url)}
+    end
+
+    def block_url?(url)
+      if url_allowed?(url)
+        false
+      else
+        @block_unknown_urls || @blocked_urls.detect {|pattern| url_match?(pattern, url)}
+      end
+    end
+
+    def skip_image_loading
+      @skip_image_loading = true
+    end
+
+    def skip_image_loading?
+      @skip_image_loading
+    end
+
+    def trap_interrupt?
+      @trap_interrupt
+    end
+
+  end
+end

data/lib/capybara/chrome/debug.rb

@@ -0,0 +1,17 @@
+module Capybara
+  module Chrome
+    module Debug
+      def debug(*args)
+        if Capybara::Chrome.configuration.debug
+          p [caller_locations(1,1)[0].label, *args, Time.now.to_i]
+        end
+        return args[0]
+      end
+
+      def info(*args)
+        p [caller_locations(1,1)[0].label, *args, Time.now.to_i]
+        return args[0]
+      end
+    end
+  end
+end

data/lib/capybara/chrome/driver.rb

@@ -0,0 +1,38 @@
+module Capybara::Chrome
+  class Driver < Capybara::Driver::Base
+    extend Forwardable
+
+    def initialize(app, options={})
+      @app = app
+      @options = options
+      @session = nil
+    end
+
+    def_delegators :browser, :visit, :find_css, :html, :evaluate_script, :evaluate_async_script, :execute_script, :status_code, :save_screenshot, :render, :current_url, :header, :console_messages, :error_messages, :dismiss_modal, :accept_modal, :title, :unrecognized_scheme_requests, :wait_for_load
+
+    def browser
+      @browser ||= Browser.new(self, port: @options[:port])
+    end
+
+    def find_xpath(query)
+      nodes = browser.find_xpath(query)
+    end
+
+    def start
+      browser.start
+    end
+
+    def needs_server?
+      true
+    end
+
+    def wait?
+      true
+    end
+
+    def reset!
+      browser.reset
+    end
+
+  end
+end

data/lib/capybara/chrome/errors.rb

@@ -0,0 +1,15 @@
+module Capybara::Chrome
+
+  class Error < StandardError
+  end
+
+  class JSException < Error
+  end
+
+  class ResponseTimeoutError < Error
+  end
+
+  class WebSocketError < Error
+  end
+
+end

data/lib/capybara/chrome/node.rb

@@ -0,0 +1,343 @@
+module Capybara::Chrome
+  class Node < ::Capybara::Driver::Node
+    include Debug
+    attr_reader :browser, :id
+
+    KEY_DATA = Hash.new do |h, k|
+      h[k] = {text: k.to_s}
+    end.merge!({
+      cancel: { key_code: 3, code: "Abort", key: "Cancel"},
+      help: { key_code: 6, code: "Help", key: "Help"},
+      backspace: { key_code: 8, code: "Backspace", key: "Backspace"},
+      tab: { key_code: 9, code: "Tab", key: "Tab"},
+      delete: { key_code: 46, code: "Delete", key: "Delete"},
+      home: { key_code: 36, code: "Home", key: "Home"},
+      end: { key_code: 35, code: "End", key: "End"},
+      left: { key_code: 37, code: "ArrowLeft", key: "ArrowLeft"},
+      right: { key_code: 39, code: "ArrowRight", key: "ArrowRight"},
+      up: { key_code: 38, code: "ArrowUp", key: "ArrowUp"},
+      down: { key_code: 40, code: "ArrowDown", key: "ArrowDown"},
+      return: { key_code: 13, code: "Enter", key: "Enter"},
+      enter: { key_code: 13, code: "Enter", key: "Enter"},
+      "\r" => { key_code: 13, code: "Enter", key: "Enter", text: "\r"},
+      "\n" => { key_code: 13, code: "Enter", key: "Enter", text: "\r"},
+      space: { key_code: 32, code: "Space", key: " ", text: " "},
+      shift: { key_code: 16, code: "Shift", key: "ShiftLeft", location: 1},
+      control: { key_code: 17, code: "ControlLeft", key: "Control", text: "\r"},
+      alt: { key_code: 18, code: "AltLeft", key: "Alt", location: 1},
+      meta: { key_code: 91, code: "MetaLeft", key: "Meta", location: 1},
+    })
+
+    def initialize(driver, browser, id)
+      raise "hell" if id == 0
+      @driver = driver
+      @browser = browser
+      @id = id
+      @mouse_x = 0
+      @mouse_y = 0
+    end
+
+    def html
+      browser.evaluate_script %( ChromeRemoteHelper.waitDOMContentLoaded(); )
+      browser.evaluate_script %( ChromeRemoteHelper.onSelfValue(#{id}, "outerHTML") )
+    end
+
+    def all_text
+      browser.evaluate_script %( ChromeRemoteHelper.waitDOMContentLoaded(); )
+      text = browser.evaluate_script %( ChromeRemoteHelper.onSelfValue(#{id}, "textContent") )
+      if Capybara::VERSION.to_f < 3.0
+        Capybara::Helpers.normalize_whitespace(text)
+      else
+        text.gsub(/[\u200b\u200e\u200f]/, '')
+          .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
+          .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
+          .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
+          .tr("\u00a0", ' ')
+      end
+    end
+
+    def visible_text
+      raw_text.to_s.gsub(/\ +/, ' ')
+        .gsub(/[\ \n]*\n[\ \n]*/, "\n")
+        .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
+        .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
+        .tr("\u00a0", ' ')
+    end
+    alias text visible_text
+
+    def raw_text
+      browser.evaluate_script %( ChromeRemoteHelper.nodeText(#{id}) )
+    end
+
+    def visible?
+      browser.evaluate_script %( ChromeRemoteHelper.nodeVisible(#{id}) )
+    end
+
+    def is_connected?
+      # on_self_value %( return this.isConnected )
+      val = browser.evaluate_script %( ChromeRemoteHelper.onSelfValue(#{id}, "isConnected") )
+    end
+
+    def get_dimensions
+      browser.wait_for_load
+      val = browser.evaluate_script %( ChromeRemoteHelper.nodeGetDimensions(#{id}) )
+      val = JSON.parse(val) rescue {}
+      val
+    end
+
+    def expect_node_at_position(x,y)
+      in_position = browser.evaluate_script %( ChromeRemoteHelper.nodeIsNodeAtPosition(#{id}, {relativeX: #{x}, relativeY: #{y}}) )
+      if !in_position
+        raise "Element '<#{tag_name}>' not at expected position: #{x},#{y}"
+      end
+    end
+
+    def move_mouse(x, y, steps: 1)
+      if steps >= 1
+        (0..x).step(steps).each do |dx|
+          send_cmd! "Input.dispatchMouseEvent", type: "mouseMoved", x: dx, y: 0
+        end
+        (0..y).step(steps).each do |dy|
+          send_cmd! "Input.dispatchMouseEvent", type: "mouseMoved", x: x, y: dy
+        end
+      end
+      send_cmd! "Input.dispatchMouseEvent", type: "mouseMoved", x: x, y: y
+    end
+
+    def click
+      browser.with_retry do
+        on_self("this.scrollIntoViewIfNeeded();");
+        dim = get_dimensions
+        if dim["width"] == 0 && dim["height"] == 0
+          puts "DIM IS 0"
+          puts html
+          raise Capybara::ElementNotFound
+        end
+        xd = [1, dim["width"]/2, dim["width"]/3]
+        yd = [1, dim["height"]/2, dim["height"]/3]
+        strategy = rand(0..xd.size-1)
+        cx = (dim["x"] + xd[strategy]).floor
+        cy = (dim["y"] + yd[strategy]).floor
+        move_mouse(cx, cy, steps: 0)
+        expect_node_at_position(cx, cy)
+        send_cmd! "Input.dispatchMouseEvent", type: "mousePressed", x: cx, y: cy, clickCount: 1, button: "left"
+        send_cmd! "Input.dispatchMouseEvent", type: "mouseReleased", x: cx, y: cy, clickCount: 1, button: "left"
+        vv = browser.wait_for_load
+      end
+    end
+
+    def find_css(query)
+      browser.query_selector_all(query, id)
+    end
+
+    def find_xpath(query)
+      browser.find_xpath query, id
+    end
+
+    def path
+      browser.evaluate_script %( ChromeRemoteHelper.nodePathForNode(#{id}) )
+    end
+    alias get_xpath path
+
+    def disabled?
+      val = browser.evaluate_script %( ChromeRemoteHelper.onSelfValue(#{id}, "disabled") )
+      debug val
+      val
+    end
+
+    TEXT_TYPES = %w(date email number password search tel text textarea url)
+    def set(value, options={})
+      value = value.to_s.gsub('"', '\"')
+      type = browser.evaluate_script %( ChromeRemoteHelper.nodeSetType(#{id}) )
+
+      if type == "file"
+        send_cmd "DOM.setFileInputFiles", files: [value.to_s], nodeId: node_id
+      elsif TEXT_TYPES.include?(type)
+        script = "this.value = ''; this.focus();"
+        if value.blank?
+          script << %(ChromeRemoteHelper.dispatchEvent(this, "change"))
+        end
+        on_self script
+        type_string(value.to_s)
+      else
+        browser.evaluate_script %( ChromeRemoteHelper.nodeSet(#{id}, "#{value}", "#{type}") )
+      end
+    end
+
+    def node_id
+      browser.get_document
+      val = browser.execute_script %(ChromeRemoteHelper.onSelf(#{id}, "return this;"))
+      send_cmd("DOM.requestNode", objectId: val["result"]["objectId"])["nodeId"]
+    end
+
+    def type_string(string)
+      ary = string.chars
+      ary.each do |char|
+        char.tr!("\n", "\r")
+        send_cmd! "Input.dispatchKeyEvent", {type: "keyDown", text: char}
+        send_cmd! "Input.dispatchKeyEvent", {type: "keyUp"}
+      end
+    end
+
+    def send_keys(*keys)
+      keys.each do |key|
+        if key.is_a? Array
+          mods, new_keys = get_modifiers(key)
+          new_keys.each do |k|
+            send_key_data(get_key_data(k), modifiers: mods)
+          end
+        else
+          send_key_data(get_key_data(key))
+        end
+      end
+    end
+
+    def get_key_data(key)
+      KEY_DATA[key]
+    end
+
+    def send_key_data(data, modifiers: 0)
+      type = data[:text] ? "keyDown" : "rawKeyDown"
+      send_cmd! "Input.dispatchKeyEvent", {type: type, text: data[:text].to_s, windowsVirtualKeyCode: data[:key_code].to_i, code: data[:code].to_s, key: data[:key].to_s, modifiers: modifiers}
+      send_cmd! "Input.dispatchKeyEvent", {type: "keyUp", modifiers: modifiers}
+    end
+
+    def get_modifiers(ary)
+      mods = []
+      keys = []
+      ary.each do |k|
+        case k
+        when :alt
+          mods << 1
+        when :control
+          mods << 2
+        when :meta, :command
+          mods << 4
+        when :shift
+          mods << 8
+        else
+          keys << k
+        end
+      end
+      [mods.inject(&:|), keys]
+    end
+
+    def focus
+      val = browser.evaluate_script %( ChromeRemoteHelper.onSelfValue(#{id}, "focus") )
+    end
+
+    def value(*args)
+      debug args
+      val = browser.evaluate_script %( ChromeRemoteHelper.onSelfValue(#{id}, "value") )
+    end
+
+    def checked?
+      val = browser.evaluate_script %( ChromeRemoteHelper.onSelfValue(#{id}, "checked") )
+    end
+
+    def selected?
+      val = browser.evaluate_script %( ChromeRemoteHelper.onSelfValue(#{id}, "selected") )
+    end
+
+    def disabled?
+      val = browser.evaluate_script %( ChromeRemoteHelper.onSelfValue(#{id}, "disabled") )
+    end
+
+    def select_option(*args)
+      on_self_value %(
+        if (this.disabled)
+          return;
+
+        var selectNode = this.parentNode;
+        if (selectNode.tagName == "OPTGROUP")
+          selectNode = selectNode.parentNode;
+
+        ChromeRemoteHelper.dispatchEvent(selectNode, "mousedown");
+        selectNode.focus();
+        ChromeRemoteHelper.dispatchEvent(selectNode, "input");
+
+        if (!this.selected) {
+          this.selected = true;
+          ChromeRemoteHelper.dispatchEvent(selectNode, "change");
+        }
+
+        ChromeRemoteHelper.dispatchEvent(selectNode, "mouseup");
+        ChromeRemoteHelper.dispatchEvent(selectNode, "click");
+      )
+    end
+
+    def trigger(event_name)
+      on_self %( ChromeRemoteHelper.dispatchEvent(this, '#{event_name}') )
+    end
+
+    def method_missing(method, *args)
+      debug ["method missing", method, args]
+      raise "method missing #{method} #{args.inspect}"
+    end
+
+    def [](attr)
+      on_self_value %(return this.getAttribute("#{attr}") )
+    end
+
+    def node_description
+      # return @node_description if @node_description
+      @node_description = send_cmd("DOM.describeNode", nodeId: id)
+      debug ["node_desc", @node_description, id]
+      if @node_description.nil?
+        raise Capybara::ExpectationNotMet
+      end
+      @node_description
+    end
+
+    def tag_name
+      # node_description["node"]["localName"]
+      on_self_value("return this.tagName.toLowerCase()")
+    end
+    alias local_name tag_name
+
+    def send_cmd(cmd, args={})
+      browser.remote.send_cmd(cmd, args)
+    end
+    def send_cmd!(cmd, args={})
+      browser.remote.send_cmd!(cmd, args)
+    end
+
+    def on_self_value(function_body, options={})
+      function_body = function_body.gsub('"', '\"').gsub(/\s+/, " ")
+      browser.evaluate_script %(ChromeRemoteHelper.onSelf(#{id}, "#{function_body}"))
+    end
+
+    def on_self(function_body, options={})
+      function_body = function_body.gsub('"', '\"').gsub(/\s+/, " ")
+      browser.evaluate_script %( window.ChromeRemoteHelper && ChromeRemoteHelper.waitDOMContentLoaded(); )
+      browser.evaluate_script %(window.ChromeRemoteHelper && ChromeRemoteHelper.onSelf(#{id}, "#{function_body}"))
+    end
+
+    def on_self!(function_body, options={})
+      function_body = function_body.gsub('"', '\"').gsub(/\s+/, " ")
+
+      browser.evaluate_script %( ChromeRemoteHelper.waitDOMContentLoaded(); )
+
+      browser.execute_script! %(ChromeRemoteHelper.onSelf(#{id}, "#{function_body}"))
+    end
+
+    def remote_object_id
+      remote_object["object"]["objectId"]
+    end
+
+    def remote_object
+      return @remote_object if @remote_object
+      @remote_object = send_cmd("DOM.resolveNode", nodeId: id)
+      debug @remote_object, id
+      if @remote_object.nil?
+        raise Capybara::ExpectationNotMet
+      end
+      @remote_object
+    end
+
+    def request_node(remote_object_id)
+      @request_node ||= send_cmd("DOM.requestNode", objectId: remote_object_id)
+    end
+  end
+
+end