cuprite 0.6.0 → 0.7.1

data/lib/capybara/cuprite/page.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module Capybara::Cuprite
+  module Page
+    MODAL_WAIT = ENV.fetch("CUPRITE_MODAL_WAIT", 0.05).to_f
+
+    def initialize(*args)
+      super
+      @accept_modal = []
+      @modal_messages = []
+    end
+
+    def set(node, value)
+      object_id = command("DOM.resolveNode", nodeId: node.node_id).dig("object", "objectId")
+      evaluate("_cuprite.set(arguments[0], arguments[1])", { "objectId" => object_id }, value)
+    end
+
+    def select(node, value)
+      evaluate_on(node: node, expression: "_cuprite.select(this, #{value})")
+    end
+
+    def trigger(node, event)
+      options = {}
+      options.merge!(wait: Ferrum::Mouse::CLICK_WAIT) if event.to_s == "click"
+      evaluate_on(node: node, expression: %(_cuprite.trigger(this, "#{event}")), **options)
+    end
+
+    def hover(node)
+      evaluate_on(node: node, expression: "_cuprite.scrollIntoViewport(this)")
+      x, y = find_position(node)
+      command("Input.dispatchMouseEvent", type: "mouseMoved", x: x, y: y)
+    end
+
+    def send_keys(node, keys)
+      if !evaluate_on(node: node, expression: %(_cuprite.containsSelection(this)))
+        before_click(node, "click")
+        node.click(mode: :left, keys: keys)
+      end
+
+      keyboard.type(keys)
+    end
+
+    def accept_confirm
+      @accept_modal << true
+    end
+
+    def dismiss_confirm
+      @accept_modal << false
+    end
+
+    def accept_prompt(modal_response)
+      @accept_modal << true
+      @modal_response = modal_response
+    end
+
+    def dismiss_prompt
+      @accept_modal << false
+    end
+
+    def find_modal(options)
+      start = Ferrum.monotonic_time
+      timeout = options.fetch(:wait) { session_wait_time }
+      expect_text = options[:text]
+      expect_regexp = expect_text.is_a?(Regexp) ? expect_text : Regexp.escape(expect_text.to_s)
+      not_found_msg = "Unable to find modal dialog"
+      not_found_msg += " with #{expect_text}" if expect_text
+
+      begin
+        modal_text = @modal_messages.shift
+        raise Capybara::ModalNotFound if modal_text.nil? || (expect_text && !modal_text.match(expect_regexp))
+      rescue Capybara::ModalNotFound => e
+        raise e, not_found_msg if Ferrum.timeout?(start, timeout)
+        sleep(MODAL_WAIT)
+        retry
+      end
+
+      modal_text
+    end
+
+    def reset_modals
+      @accept_modal = []
+      @modal_response = nil
+      @modal_messages = []
+    end
+
+    def before_click(node, name, keys = [], offset = {})
+      evaluate_on(node: node, expression: "_cuprite.scrollIntoViewport(this)")
+      x, y = find_position(node, offset[:x], offset[:y])
+      evaluate_on(node: node, expression: "_cuprite.mouseEventTest(this, '#{name}', #{x}, #{y})")
+      true
+    rescue Ferrum::JavaScriptError => e
+      raise MouseEventFailed.new(e.message) if e.class_name == "MouseEventFailed"
+    end
+
+    def switch_to_frame(handle)
+      case handle
+      when :parent
+        @frame_stack.pop
+      when :top
+        @frame_stack = []
+      else
+        @frame_stack << handle
+        inject_extensions
+      end
+    end
+
+    private
+
+    def prepare_page
+      super
+
+      network.intercept if !Array(@browser.url_whitelist).empty? ||
+                           !Array(@browser.url_blacklist).empty?
+
+      on(:request) do |request, index, total|
+        if @browser.url_blacklist && !@browser.url_blacklist.empty?
+          if @browser.url_blacklist.any? { |r| request.match?(r) }
+            request.abort and return
+          else
+            request.continue and return
+          end
+        elsif @browser.url_whitelist && !@browser.url_whitelist.empty?
+          if @browser.url_whitelist.any? { |r| request.match?(r) }
+            request.continue and return
+          else
+            request.abort and return
+          end
+        elsif index + 1 < total
+          # There are other callbacks that may handle this request
+          next
+        else
+          # If there are no callbacks then just continue
+          request.continue
+        end
+      end
+
+      on("Page.javascriptDialogOpening") do |params|
+        accept_modal = @accept_modal.last
+        if accept_modal == true || accept_modal == false
+          @accept_modal.pop
+          @modal_messages << params["message"]
+          options = { accept: accept_modal }
+          response = @modal_response || params["defaultPrompt"]
+          options.merge!(promptText: response) if response
+          command("Page.handleJavaScriptDialog", **options)
+        else
+          warn "Modal window has been opened, but you didn't wrap your code into (`accept_prompt` | `dismiss_prompt` | `accept_confirm` | `dismiss_confirm` | `accept_alert`), accepting by default"
+          options = { accept: true }
+          response = params["defaultPrompt"]
+          options.merge!(promptText: response) if response
+          command("Page.handleJavaScriptDialog", **options)
+        end
+      end
+    end
+
+    def find_position(node, *args)
+      x, y = node.find_position(*args)
+    rescue Ferrum::BrowserError => e
+      if e.message == "Could not compute content quads."
+        raise MouseEventFailed.new("MouseEventFailed: click, none, 0, 0")
+      else
+        raise
+      end
+    end
+  end
+end

data/lib/capybara/cuprite/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Cuprite
-    VERSION = "0.6.0"
+    VERSION = "0.7.1"
   end
 end

data/lib/capybara/cuprite.rb

@@ -1,31 +1,18 @@
 # frozen_string_literal: true
 
+require "ferrum"
 require "capybara"
 
-Thread.abort_on_exception = true
-Thread.report_on_exception = true if Thread.respond_to?(:report_on_exception=)
-
 module Capybara::Cuprite
-  require "capybara/cuprite/driver"
-  require "capybara/cuprite/browser"
-  require "capybara/cuprite/node"
-  require "capybara/cuprite/errors"
-  require "capybara/cuprite/cookie"
-
-  class << self
-    def windows?
-      RbConfig::CONFIG["host_os"] =~ /mingw|mswin|cygwin/
-    end
+end
 
-    def mac?
-      RbConfig::CONFIG["host_os"] =~ /darwin/
-    end
+require "capybara/cuprite/driver"
+require "capybara/cuprite/browser"
+require "capybara/cuprite/page"
+require "capybara/cuprite/node"
+require "capybara/cuprite/errors"
 
-    def mri?
-      defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby"
-    end
-  end
-end
+Ferrum::Page.prepend(Capybara::Cuprite::Page)
 
 Capybara.register_driver(:cuprite) do |app|
   Capybara::Cuprite::Driver.new(app)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuprite
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -31,39 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: websocket-driver
+  name: ferrum
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: cliver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: image_size
   requirement: !ruby/object:Gem::Requirement
@@ -202,25 +182,12 @@ files:
 - README.md
 - lib/capybara/cuprite.rb
 - lib/capybara/cuprite/browser.rb
-- lib/capybara/cuprite/browser/client.rb
-- lib/capybara/cuprite/browser/dom.rb
-- lib/capybara/cuprite/browser/frame.rb
-- lib/capybara/cuprite/browser/input.json
-- lib/capybara/cuprite/browser/input.rb
-- lib/capybara/cuprite/browser/javascripts/index.js
-- lib/capybara/cuprite/browser/net.rb
-- lib/capybara/cuprite/browser/page.rb
-- lib/capybara/cuprite/browser/process.rb
-- lib/capybara/cuprite/browser/runtime.rb
-- lib/capybara/cuprite/browser/targets.rb
-- lib/capybara/cuprite/browser/web_socket.rb
 - lib/capybara/cuprite/cookie.rb
 - lib/capybara/cuprite/driver.rb
 - lib/capybara/cuprite/errors.rb
-- lib/capybara/cuprite/network/error.rb
-- lib/capybara/cuprite/network/request.rb
-- lib/capybara/cuprite/network/response.rb
+- lib/capybara/cuprite/javascripts/index.js
 - lib/capybara/cuprite/node.rb
+- lib/capybara/cuprite/page.rb
 - lib/capybara/cuprite/version.rb
 homepage: https://github.com/machinio/cuprite
 licenses:
@@ -241,8 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Headless Chrome driver for Capybara

data/lib/capybara/cuprite/browser/client.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require "timeout"
-require "capybara/cuprite/browser/web_socket"
-
-module Capybara::Cuprite
-  class Browser
-    class Client
-      class IdError < RuntimeError; end
-
-      def initialize(browser, ws_url, allow_slowmo = true)
-        @command_id = 0
-        @subscribed = Hash.new { |h, k| h[k] = [] }
-        @browser, @allow_slowmo = browser, allow_slowmo
-        @commands = Queue.new
-        @ws = WebSocket.new(ws_url, @browser.logger)
-
-        @thread = Thread.new do
-          while message = @ws.messages.pop
-            method, params = message.values_at("method", "params")
-            if method
-              @subscribed[method].each { |b| b.call(params) }
-            else
-              @commands.push(message)
-            end
-          end
-
-          @commands.close
-        end
-      end
-
-      def command(method, params = {})
-        message = build_message(method, params)
-        sleep(@browser.slowmo) if !@browser.slowmo.nil? && @allow_slowmo
-        @ws.send_message(message)
-        message[:id]
-      end
-
-      def wait(id:)
-        message = Timeout.timeout(@browser.timeout, TimeoutError) { @commands.pop }
-        raise DeadBrowser unless message
-        raise IdError if message["id"] != id
-        error, response = message.values_at("error", "result")
-        raise BrowserError.new(error) if error
-        response
-      rescue IdError
-        retry
-      end
-
-      def subscribe(event, &block)
-        @subscribed[event] << block
-        true
-      end
-
-      def close
-        @ws.close
-        # Give a thread some time to handle a tail of messages
-        Timeout.timeout(1) { @thread.join }
-      rescue Timeout::Error
-        @thread.kill
-      end
-
-      private
-
-      def build_message(method, params)
-        { method: method, params: params }.merge(id: next_command_id)
-      end
-
-      def next_command_id
-        @command_id += 1
-      end
-    end
-  end
-end

data/lib/capybara/cuprite/browser/dom.rb

@@ -1,50 +0,0 @@
-module Capybara::Cuprite
-  class Browser
-    module DOM
-      def current_url
-        evaluate_in(execution_context_id, "window.top.location.href")
-      end
-
-      def title
-        evaluate_in(execution_context_id, "window.top.document.title")
-      end
-
-      def body
-        evaluate("document.documentElement.outerHTML")
-      end
-
-      def all_text(node)
-        evaluate_on(node: node, expr: "this.textContent")
-      end
-
-      def property(node, name)
-        evaluate_on(node: node, expr: %Q(this["#{name}"]))
-      end
-
-      def attributes(node)
-        value = evaluate_on(node: node, expr: "_cuprite.getAttributes(this)")
-        JSON.parse(value)
-      end
-
-      def attribute(node, name)
-        evaluate_on(node: node, expr: %Q(_cuprite.getAttribute(this, "#{name}")))
-      end
-
-      def value(node)
-        evaluate_on(node: node, expr: "_cuprite.value(this)")
-      end
-
-      def visible?(node)
-        evaluate_on(node: node, expr: "_cuprite.isVisible(this)")
-      end
-
-      def disabled?(node)
-        evaluate_on(node: node, expr: "_cuprite.isDisabled(this)")
-      end
-
-      def path(node)
-        evaluate_on(node: node, expr: "_cuprite.path(this)")
-      end
-    end
-  end
-end

data/lib/capybara/cuprite/browser/frame.rb

@@ -1,115 +0,0 @@
-module Capybara::Cuprite
-  class Browser
-    module Frame
-      def execution_context_id
-        @mutex.synchronize do
-          if !@frame_stack.empty?
-            @frames[@frame_stack.last]["execution_context_id"]
-          else
-            @execution_context_id
-          end
-        end
-      end
-
-      def frame_name
-        evaluate("window.name")
-      end
-
-      def frame_url
-        evaluate("window.location.href")
-      end
-
-      def frame_title
-        evaluate("document.title")
-      end
-
-      def switch_to_frame(handle)
-        case handle
-        when Capybara::Node::Base
-          @frame_stack << handle.native.node["frameId"]
-          inject_extensions
-        when :parent
-          @frame_stack.pop
-        when :top
-          @frame_stack = []
-        end
-      end
-
-      private
-
-      def subscribe_events
-        super if defined?(super)
-
-        @client.subscribe("Page.frameAttached") do |params|
-          @frames[params["frameId"]] = { "parent_id" => params["parentFrameId"] }
-        end
-
-        @client.subscribe("Page.frameStartedLoading") do |params|
-          @waiting_frames << params["frameId"]
-          @mutex.try_lock
-        end
-
-        @client.subscribe("Page.frameNavigated") do |params|
-          id = params["frame"]["id"]
-          if frame = @frames[id]
-            frame.merge!(params["frame"].select { |k, v| k == "name" || k == "url" })
-          end
-        end
-
-        @client.subscribe("Page.frameScheduledNavigation") do |params|
-          # Trying to lock mutex if frame is the main frame
-          @waiting_frames << params["frameId"]
-          @mutex.try_lock
-        end
-
-        @client.subscribe("Page.frameStoppedLoading") do |params|
-          # `DOM.performSearch` doesn't work without getting #document node first.
-          # It returns node with nodeId 1 and nodeType 9 from which descend the
-          # tree and we save it in a variable because if we call that again root
-          # node will change the id and all subsequent nodes have to change id too.
-          # `command` is not allowed in the block as it will deadlock the process.
-          if params["frameId"] == @frame_id
-            signal if @waiting_frames.empty?
-            @client.command("DOM.getDocument", depth: 0)
-          end
-
-          if @waiting_frames.include?(params["frameId"])
-            @waiting_frames.delete(params["frameId"])
-            signal if @waiting_frames.empty?
-          end
-        end
-
-        @client.subscribe("Runtime.executionContextCreated") do |params|
-          frame_id = params.dig("context", "auxData", "frameId")
-          execution_context_id = params.dig("context", "id")
-
-          # Remember the very first frame since it's the main one
-          @frame_id ||= frame_id
-          @execution_context_id ||= execution_context_id
-
-          if @frames[frame_id]
-            @frames[frame_id].merge!("execution_context_id" => execution_context_id)
-          else
-            @frames[frame_id] = { "execution_context_id" => execution_context_id }
-          end
-        end
-
-        @client.subscribe("Runtime.executionContextDestroyed") do |params|
-          execution_context_id = params["executionContextId"]
-          id, frame = @frames.find { |_, p| p["execution_context_id"] == execution_context_id }
-          frame["execution_context_id"] = nil if frame
-
-          if @execution_context_id == execution_context_id
-            @execution_context_id = nil
-          end
-        end
-
-        @client.subscribe("Runtime.executionContextsCleared") do
-          # If we didn't have time to set context id at the beginning we have
-          # to set lock and release it when we set something.
-          @execution_context_id = nil
-        end
-      end
-    end
-  end
-end