cuprite 0.15 → 0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06038d0fa139b71bda9f95ce0d353bfbd0394ff6a09f95c8dc0acb4f0b7f86f9'
-  data.tar.gz: 91a79735083b3949663d38d8ed1703c7955ada3ec2299830e7105348a72dd337
+  metadata.gz: 70fb54b637d782b831b70e9894f65d95deb839abca0dff8355245c1dfaf7f81e
+  data.tar.gz: f909e93716a7bffb69e35cf4dbc783c13e4acc9d13a226f2ee5d85d2c49cc427
 SHA512:
-  metadata.gz: d1ab5955459610619f457b8ff7ac76fe761e003d20664da614f8b613da2849a65ba23c0c772753864321bf6b346a3e7d468da82dc55d816f33bbb7b13c6784ad
-  data.tar.gz: e618d937daea3246787cef4084f07fd7a5b2109fd7e34ff0bfa7f3d7e954c3b258539338a52378e8f9a80d96e4a8d29de3041d568b5dac8850aba61abba614c4
+  metadata.gz: 521a59b3852efa9a3e770090e56bdcbc508da3465414bc2a72300f10757380103d9b6cb668a426d0af3173a89ad02f5cbf78666d9d33b19235d68f2e955182d4
+  data.tar.gz: dd50d8cd20886faa16e5372659c25792847286c954ea1c5a951b5a504d87cb06897e2e0bacd7d86457a6f72529054d99bc3773e163a06d926ef0c21a98cc7375

data/README.md

@@ -4,9 +4,7 @@ Cuprite is a pure Ruby driver (read as _no_ Selenium/WebDriver/ChromeDriver
 dependency) for [Capybara](https://github.com/teamcapybara/capybara). It allows
 you to run Capybara tests on a headless Chrome or Chromium. Under the hood it
 uses [Ferrum](https://github.com/rubycdp/ferrum#index) which is high-level API
-to the browser by CDP protocol. The design of the driver is as close to
-[Poltergeist](https://github.com/teampoltergeist/poltergeist) as possible though
-it's not a goal.
+to the browser by CDP protocol.
 
 
 ## Install
@@ -43,8 +41,7 @@ browser = page.driver.browser
 browser.mouse.move(x: 123, y: 456).down.up
 ```
 
-If you already have tests on Poltergeist then it should simply work, for
-Selenium you better check your code for `manage` calls because it works
+For Selenium you better check your code for `manage` calls because it works
 differently in Cuprite, see the documentation below.
 
 
@@ -64,8 +61,8 @@ end
 `Cuprite`-specific options are:
 
 * options `Hash`
-  * `:url_blacklist` (Array) - array of strings to match against requested URLs
-  * `:url_whitelist` (Array) - array of strings to match against requested URLs
+  * `:url_blacklist` (Array) - array of regexes to match against requested URLs
+  * `:url_whitelist` (Array) - array of regexes to match against requested URLs
 
 
 ## Debugging
@@ -125,13 +122,17 @@ be automatically cleared at the end of the test.
 
 ## Network traffic
 
-* `page.driver.network_traffic` Inspect network traffic (loaded resources) on
-the current page. This returns an array of request objects.
+* `page.driver.network_traffic` allows you to inspect network traffic (i.e., loaded resources) on the current page. It returns an array of `Ferrum::Network::Exchange` objects, each representing a network request/response exchange. You can query both the request and response details of each exchange.
 
 ```ruby
-page.driver.network_traffic # => [Request, ...]
-request = page.driver.network_traffic.first
-request.response
+# Retrieve all network exchanges
+network_traffic = page.driver.network_traffic
+
+# Access the first exchange
+first_exchange = network_traffic.first
+
+# Inspect the response of the first request
+response = first_exchange.response
 ```
 
 * `page.driver.wait_for_network_idle` Natively waits for network idle and if
@@ -186,27 +187,29 @@ Besides capybara screenshot method you can get image as Base64:
 
 ## Proxy
 
-* `page.driver.set_proxy(ip, port, type, user, password)`
+* `page.driver.set_proxy(ip, port, user, password)`
 
 
-## URL Blacklisting & Whitelisting
+## URL Blocklisting & Allowlisting
 
-Cuprite supports URL blacklisting, which allows you to prevent scripts from
+Cuprite supports URL blocklisting, which allows you to prevent scripts from
 running on designated domains:
 
 ```ruby
-page.driver.browser.url_blacklist = %r{http://www.example.com}
+page.driver.browser.url_blocklist = %r{http://www.example.com}
 ```
 
-and also URL whitelisting, which allows scripts to only run on designated
+and also URL allowlisting, which allows scripts to only run on designated
 domains:
 
 ```ruby
-page.driver.browser.url_whitelist = %r{http://www.example.com}
+page.driver.browser.url_allowlist = %r{http://www.example.com}
 ```
 
-If you are experiencing slower run times, consider creating a URL whitelist of
-domains that are essential or a blacklist of domains that are not essential,
+For legacy support, `url_blacklist=` and `url_whitelist=` continue to work respectively.
+
+If you are experiencing slower run times, consider creating a URL allowlist of
+domains that are essential or a blocklist of domains that are not essential,
 such as ad networks or analytics, to your testing environment.
 
 ## License

data/lib/capybara/cuprite/browser.rb

@@ -11,50 +11,63 @@ module Capybara
                   find_modal accept_confirm dismiss_confirm accept_prompt
                   dismiss_prompt reset_modals] => :page
 
-      attr_reader :url_blacklist, :url_whitelist
-      alias url_blocklist url_blacklist
-      alias url_allowlist url_whitelist
-
       def initialize(options = nil)
-        options ||= {}
-        @client = nil
-        self.url_blacklist = options[:url_blacklist]
-        self.url_whitelist = options[:url_whitelist]
-
         super
-        @page = false
+
+        @options.url_blacklist = prepare_wildcards(options&.dig(:url_blacklist))
+        @options.url_whitelist = prepare_wildcards(options&.dig(:url_whitelist))
+
+        @page = nil
       end
 
-      def timeout=(value)
+      def command(...)
         super
-        @page.timeout = value unless @page.nil?
+      rescue Ferrum::DeadBrowserError
+        restart
+        raise
       end
 
       def page
-        raise Ferrum::NoSuchPageError if @page.nil?
+        raise Ferrum::NoSuchPageError if @page&.closed?
 
         @page ||= attach_page
       end
 
       def reset
         super
-        @page = attach_page
+        @options.reset_window_size
+        @page = nil
       end
 
       def quit
         super
-        @page = false
+        @page = nil
       end
 
+      def resize(**options)
+        @options.window_size = [options[:width], options[:height]]
+        super
+      end
+
+      def url_whitelist
+        @options.url_whitelist
+      end
+      alias url_allowlist url_whitelist
+
       def url_whitelist=(patterns)
-        @url_whitelist = prepare_wildcards(patterns)
-        page.network.whitelist = @url_whitelist if @client && @url_whitelist.any?
+        @options.url_whitelist = prepare_wildcards(patterns)
+        page.network.whitelist = @options.url_whitelist if @client && @options.url_whitelist.any?
       end
       alias url_allowlist= url_whitelist=
 
+      def url_blacklist
+        @options.url_blacklist
+      end
+      alias url_blocklist url_blacklist
+
       def url_blacklist=(patterns)
-        @url_blacklist = prepare_wildcards(patterns)
-        page.network.blacklist = @url_blacklist if @client && @url_blacklist.any?
+        @options.url_blacklist = prepare_wildcards(patterns)
+        page.network.blacklist = @options.url_blacklist if @client && @options.url_blacklist.any?
       end
       alias url_blocklist= url_blacklist=
 
@@ -109,8 +122,13 @@ module Capybara
         target = targets[target_id]
         raise Ferrum::NoSuchPageError unless target
 
-        @page = nil if @page.target_id == target.id
+        @page = ClosedPage.new if @page.target_id == target.id
         target.page.close
+        targets.delete(target_id) # page.close is async, delete target asap
+      end
+
+      def active_element
+        evaluate("document.activeElement")
       end
 
       def browser_error
@@ -121,24 +139,33 @@ module Capybara
         raise NotImplementedError
       end
 
-      def drag(node, other, steps)
+      def drag(node, other, steps, delay = nil, scroll = true)
         x1, y1 = node.find_position
-        x2, y2 = other.find_position
 
         mouse.move(x: x1, y: y1)
         mouse.down
+        sleep delay if delay
+
+        other.scroll_into_view if scroll
+
+        x2, y2 = other.find_position
         mouse.move(x: x2, y: y2, steps: steps)
+
         mouse.up
       end
 
-      def drag_by(node, x, y, steps)
+      def drag_by(node, dx, dy, steps, delay = nil, scroll = true)
         x1, y1 = node.find_position
-        x2 = x1 + x
-        y2 = y1 + y
 
         mouse.move(x: x1, y: y1)
         mouse.down
-        mouse.move(x: x2, y: y2, steps: steps)
+
+        sleep delay if delay
+
+        evaluate("window.scrollBy(#{dx}, #{dy})") if scroll # should be extracted to Mouse#scroll_by in ferrum
+
+        x2, y2 = node.find_position
+        mouse.move(x: x2 + dx, y: y2 + dy, steps: steps)
         mouse.up
       end
 
@@ -183,6 +210,10 @@ module Capybara
         evaluate_on(node: node, expression: "_cuprite.path(this)")
       end
 
+      def obscured?(node)
+        evaluate_on(node: node, expression: "_cuprite.isObscured(this)")
+      end
+
       def all_text(node)
         node.text
       end
@@ -224,10 +255,10 @@ module Capybara
       def attach_page(target_id = nil)
         target = targets[target_id] if target_id
         target ||= default_context.default_target
-        return target.page if target.attached?
+        return target.page if target.connected?
 
         target.maybe_sleep_if_new_window
-        target.page = Page.new(target.id, self)
+        target.page = Page.new(target.client, context_id: target.context_id, target_id: target.id)
         target.page
       end
     end

data/lib/capybara/cuprite/cookie.rb

@@ -40,7 +40,7 @@ module Capybara
       end
 
       def expires
-        Time.at(@attributes["expires"]) if (@attributes["expires"]).positive?
+        Time.at(@attributes["expires"]) if @attributes["expires"].positive?
       end
     end
   end

data/lib/capybara/cuprite/driver.rb

@@ -15,6 +15,7 @@ module Capybara
       delegate %i[restart quit status_code timeout timeout= current_url title body
                   window_handles close_window switch_to_window within_window window_handle
                   back forward refresh wait_for_reload viewport_size device_pixel_ratio] => :browser
+      delegate %i[send_keys] => :active_element
       alias html body
       alias current_window_handle window_handle
       alias go_back back
@@ -34,7 +35,11 @@ module Capybara
         @screen_size ||= DEFAULT_MAXIMIZE_SCREEN_SIZE
         @options[:save_path] ||= File.expand_path(Capybara.save_path) if Capybara.save_path
 
-        ENV["FERRUM_DEBUG"] = "true" if ENV["CUPRITE_DEBUG"]
+        # It's set for debug() to make devtools tab open correctly.
+        @options[:browser_options] ||= {}
+        unless @options[:browser_options][:"remote-allow-origins"]
+          @options[:browser_options].merge!("remote-allow-origins": "*")
+        end
 
         super()
       end
@@ -64,6 +69,10 @@ module Capybara
         evaluate_script("document.title")
       end
 
+      def active_element
+        Node.new(self, browser.active_element)
+      end
+
       def find_xpath(selector)
         find(:xpath, selector)
       end
@@ -109,7 +118,7 @@ module Capybara
       def open_new_window
         target = browser.default_context.create_target
         target.maybe_sleep_if_new_window
-        target.page = Page.new(target.id, browser)
+        target.page = Page.new(target.client, context_id: target.context_id, target_id: target.id)
         target.page
       end
 
@@ -242,7 +251,8 @@ module Capybara
 
       def remove_cookie(name, **options)
         options[:domain] = default_domain if options.empty?
-        browser.cookies.remove(**options.merge(name: name))
+        options = options.merge(name: name)
+        browser.cookies.remove(**options)
       end
 
       def clear_cookies
@@ -265,7 +275,12 @@ module Capybara
       alias authorize basic_authorize
 
       def debug_url
-        "http://#{browser.process.host}:#{browser.process.port}"
+        response = JSON.parse(Net::HTTP.get(URI(build_remote_debug_url(path: "/json"))))
+
+        devtools_frontend_path = response[0]&.[]("devtoolsFrontendUrl")
+        raise "Could not generate debug url for remote debugging session" unless devtools_frontend_path
+
+        build_remote_debug_url(path: devtools_frontend_path)
       end
 
       def debug(binding = nil)
@@ -363,6 +378,10 @@ module Capybara
 
       private
 
+      def build_remote_debug_url(path:)
+        "http://#{browser.process.host}:#{browser.process.port}#{path}"
+      end
+
       def default_domain
         if @started
           URI.parse(browser.current_url).host

data/lib/capybara/cuprite/javascripts/index.js

@@ -84,7 +84,6 @@ class Cuprite {
     return true;
   }
 
-
   isDisabled(node) {
     let xpath = "parent::optgroup[@disabled] | \
                  ancestor::select[@disabled] | \
@@ -116,6 +115,35 @@ class Cuprite {
     return `//${selectors.join("/")}`;
   }
 
+  /**
+   * Returns true if the node is obscured in the viewport.
+   *
+   * @param {Element} node
+   * @return {boolean} true if the node is obscured, false otherwise
+   */
+  isObscured(node) {
+    let win = window;
+    let rect = node.getBoundingClientRect();
+    let px = rect.left + rect.width / 2;
+    let py = rect.top + rect.height / 2;
+
+    while (win) {
+      let topNode = win.document.elementFromPoint(px, py);
+
+      if (node !== topNode && !node.contains(topNode)) return true;
+
+      node = win.frameElement;
+      if (!node) return false;
+
+      rect = node.getBoundingClientRect();
+      px = rect.left + px;
+      py = rect.top + py;
+      win = win.parent;
+    }
+
+    return false;
+  }
+
   set(node, value) {
     if (node.readOnly) return;
 
@@ -344,10 +372,24 @@ class Cuprite {
 
   _isInViewport(node) {
     let rect = node.getBoundingClientRect();
-    return rect.top >= 0 &&
-           rect.left >= 0 &&
-           rect.bottom <= window.innerHeight &&
-           rect.right <= window.innerWidth;
+
+    let inViewport =  rect.top >= 0 &&
+                      rect.left >= 0 &&
+                      rect.bottom <= window.innerHeight &&
+                      rect.right <= window.innerWidth;
+
+    if (inViewport) {
+      // check if obscured by another element
+      let x = rect.width/2;
+      let y = rect.height/2 ;
+
+      let px = rect.left + x,
+          py = rect.top + y,
+          e = document.elementFromPoint(px, py);
+      return node == e;
+    }
+
+    return false;
   }
 
   select(node, value) {
@@ -356,12 +398,13 @@ class Cuprite {
     } else if (value == false && !node.parentNode.multiple) {
       return false;
     } else {
-      this.trigger(node.parentNode, "focus");
+      let parentNode = node.parentNode;
+      this.trigger(parentNode, "focus");
 
       node.selected = value;
       this.changed(node);
 
-      this.trigger(node.parentNode, "blur");
+      this.trigger(parentNode, "blur");
       return true;
     }
   }

data/lib/capybara/cuprite/node.rb

@@ -110,7 +110,7 @@ module Capybara
           command(:set, value.to_s)
         elsif self[:isContentEditable]
           command(:delete_text)
-          send_keys(value.to_s)
+          click.type(value.to_s)
         end
       end
 
@@ -161,14 +161,16 @@ module Capybara
 
       def drag_to(other, **options)
         options[:steps] ||= 1
+        options[:scroll] = true unless options.key?(:scroll)
 
-        command(:drag, other.node, options[:steps])
+        command(:drag, other.node, options[:steps], options[:delay], options[:scroll])
       end
 
       def drag_by(x, y, **options)
         options[:steps] ||= 1
+        options[:scroll] = true unless options.key?(:scroll)
 
-        command(:drag_by, x, y, options[:steps])
+        command(:drag_by, x, y, options[:steps], options[:delay], options[:scroll])
       end
 
       def trigger(event)
@@ -211,6 +213,10 @@ module Capybara
         command(:path)
       end
 
+      def obscured?
+        command(:obscured?)
+      end
+
       def inspect
         %(#<#{self.class} @node=#{@node.inspect}>)
       end

data/lib/capybara/cuprite/options.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Ferrum
+  class Browser
+    class Options
+      attr_writer :window_size
+      attr_accessor :url_blacklist, :url_whitelist
+
+      def reset_window_size
+        @window_size = @options[:window_size]
+      end
+    end
+  end
+end

data/lib/capybara/cuprite/page.rb

@@ -4,6 +4,12 @@ require "forwardable"
 
 module Capybara
   module Cuprite
+    class ClosedPage
+      def closed?
+        true
+      end
+    end
+
     class Page < Ferrum::Page
       MODAL_WAIT = ENV.fetch("CUPRITE_MODAL_WAIT", 0.05).to_f
       TRIGGER_CLICK_WAIT = ENV.fetch("CUPRITE_TRIGGER_CLICK_WAIT", 0.1).to_f
@@ -13,7 +19,7 @@ module Capybara
                   current_url current_title body execution_id execution_id!
                   evaluate evaluate_on evaluate_async execute] => :active_frame
 
-      def initialize(*args)
+      def initialize(...)
         @frame_stack = []
         @accept_modal = []
         @modal_messages = []
@@ -70,17 +76,17 @@ module Capybara
 
       def find_modal(options)
         start = Ferrum::Utils::ElapsedTime.monotonic_time
-        timeout = options.fetch(:wait, browser.timeout)
         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
+        wait = options.fetch(:wait, timeout)
 
         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::Utils::ElapsedTime.timeout?(start, timeout)
+          raise e, not_found_msg if Ferrum::Utils::ElapsedTime.timeout?(start, wait)
 
           sleep(MODAL_WAIT)
           retry
@@ -117,7 +123,6 @@ module Capybara
           @frame_stack = []
         else
           @frame_stack << handle
-          inject_extensions
         end
       end
 
@@ -129,15 +134,22 @@ module Capybara
         active_frame.current_title
       end
 
+      def closed?
+        false
+      end
+
       private
 
       def prepare_page
         super
 
-        if @browser.url_blacklist.any?
-          network.blacklist = @browser.url_blacklist
-        elsif @browser.url_whitelist.any?
-          network.whitelist = @browser.url_whitelist
+        width, height = @options.window_size
+        resize(width: width, height: height)
+
+        if @options.url_blacklist.any?
+          network.blacklist = @options.url_blacklist
+        elsif @options.url_whitelist.any?
+          network.whitelist = @options.url_whitelist
         end
 
         on("Page.javascriptDialogOpening") do |params|

data/lib/capybara/cuprite/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Cuprite
-    VERSION = "0.15"
+    VERSION = "0.16"
   end
 end

data/lib/capybara/cuprite.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+ENV["FERRUM_DEBUG"] = "true" if ENV["CUPRITE_DEBUG"]
+
 require "ferrum"
 require "capybara"
 require "capybara/cuprite/driver"
 require "capybara/cuprite/browser"
 require "capybara/cuprite/page"
+require "capybara/cuprite/options"
 require "capybara/cuprite/node"
 require "capybara/cuprite/errors"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuprite
 version: !ruby/object:Gem::Version
-  version: '0.15'
+  version: '0.16'
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-04 00:00:00.000000000 Z
+date: 2025-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.16.0
 description: Cuprite is a driver for Capybara that allows you to run your tests on
   a headless Chrome browser
 email:
@@ -55,6 +55,7 @@ files:
 - lib/capybara/cuprite/errors.rb
 - lib/capybara/cuprite/javascripts/index.js
 - lib/capybara/cuprite/node.rb
+- lib/capybara/cuprite/options.rb
 - lib/capybara/cuprite/page.rb
 - lib/capybara/cuprite/version.rb
 homepage: https://github.com/rubycdp/cuprite
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Headless Chrome driver for Capybara