cuprite 0.9 → 0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 979d242c40547bfd784a54a15fa1ba81afc251a805f71880a234b4fd055f3afb
-  data.tar.gz: 433ff62183910210a57f5b1022a7807d3e8dc5ac86dbaf62879660b957a67b94
+  metadata.gz: 7101647cda6595d4d7644edf51bf61fb4891d2afaaa8eb51e04a1a10f587433f
+  data.tar.gz: bcfefe534e782ab4083068d9b6b0643183a5be8ea5f7dcd273b3121b8e790ede
 SHA512:
-  metadata.gz: 5495435618d770085085f9b992646e03e1b1271b20cefc8c7e0f1d4313abd398a161f3b85038e0583bd6834d55adc8052393d2e5dc61c1d395edbe5e90fb29f5
-  data.tar.gz: 64b6b8a516e44642e6dfeb3981081b5e1d7cd0489c4741358f841013f74f8268b6bdaf63017262ed2f70f6d83a8cc4a3c548bf3da33b86409e64695620a8e108
+  metadata.gz: ae72432731e273f9c59df718a31d66fb82678bd07ab45cb717d931704b20847253c7221a6cbda8dcb7468be0042ca74d0d96a3e11c9b6d63fbf2dc1eec8cb8ec
+  data.tar.gz: 747ff03cc544263579338c4fc389c6b96d39a8634dcaeaf30051713d195119a06c87557fea98e436c9a5748fd980628e8399ff3fba1a82ebaf791a60c4c2a453

data/README.md

@@ -1,26 +1,27 @@
-# Cuprite - Headless Chrome driver for Capybara #
+# Cuprite - Headless Chrome driver for Capybara
 
-[![Build Status](https://travis-ci.org/machinio/cuprite.svg?branch=master)](https://travis-ci.org/machinio/cuprite)
+[![Build Status](https://travis-ci.org/rubycdp/cuprite.svg?branch=master)](https://travis-ci.org/rubycdp/cuprite)
 
-Cuprite is a pure Ruby driver (read as _no_ Java/Selenium/WebDriver/ChromeDriver
-requirement) for [Capybara](https://github.com/teamcapybara/capybara). It allows
-you to run your Capybara tests on a headless [Chrome](https://www.google.com/chrome/)
-or [Chromium](https://www.chromium.org/) by [CDP protocol](https://chromedevtools.github.io/devtools-protocol/).
-Under the hood it uses [Ferrum](https://github.com/route/ferrum) which is
-high-level API to the browser again by CDP protocol.
+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.
 
-The emphasis was made on raw CDP protocol because Headless Chrome allows you to
-do so many things that are barely supported by WebDriver because it should have
-consistent design with other browsers. The design of the driver will be as
-close to [Poltergeist](https://github.com/teampoltergeist/poltergeist) as
-possible though it's not a goal.
+[Cuprite](https://evrone.com/cuprite) designed & supported by [Evrone](https://evrone.com/)
+What else we build [with Ruby](https://evrone.com/ruby)
 
-## Install ##
 
-Add these lines to your `Gemfile` and run `bundle install`.
+## Install
+
+Add this to your `Gemfile` and run `bundle install`.
 
 ``` ruby
-gem "cuprite", group: :test
+group :test do
+  gem "cuprite"
+end
 ```
 
 In your test setup add:
@@ -33,21 +34,31 @@ Capybara.register_driver(:cuprite) do |app|
 end
 ```
 
-If you already had tests on Poltergeist then it should simply work, for Selenium
-you better check your code for `.manage` calls because things are much easier
-with Cuprite, see the documentation below.
+if you use `Docker` don't forget to pass `no-sandbox` option:
+
+```ruby
+Capybara::Cuprite::Driver.new(app, browser_options: { 'no-sandbox': nil })
+```
+
+Since Cuprite uses [Ferrum](https://github.com/rubycdp/ferrum#examples) there
+are many useful methods you can call even using this driver:
+
+```ruby
+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
+differently in Cuprite, see the documentation below.
 
-## Install Chrome ##
 
-There's no official Chrome or Chromium package for Linux don't install it this
-way because it either will be outdated or unofficial, both are bad. Download it
-from official [source](https://www.chromium.org/getting-involved/download-chromium).
-Chrome binary should be in the `PATH` or `BROWSER_PATH` or you can pass it as an
-option
+## Customization
 
-## Customization ##
+See the full list of options for
+[Ferrum](https://github.com/rubycdp/ferrum#customization).
 
-You can customize options with the following code in your test setup:
+You can pass options with the following code in your test setup:
 
 ``` ruby
 Capybara.register_driver(:cuprite) do |app|
@@ -55,47 +66,52 @@ Capybara.register_driver(:cuprite) do |app|
 end
 ```
 
-#### Running in Docker ####
+`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
 
-In docker as root you must pass the no-sandbox browser option:
+
+## Debugging
+
+If you pass `inspector` option, remote debugging will be enabled if you run
+tests with `INSPECTOR=true`. Then you can put `page.driver.debug` or
+`page.driver.debug(binding)` in your test to pause it. This will launch the
+browser where you can inspect the content.
 
 ```ruby
-Capybara::Cuprite::Driver.new(app, browser_options: { 'no-sandbox': nil })
+Capybara.register_driver :cuprite do |app|
+  Capybara::Cuprite::Driver.new(app, inspector: ENV['INSPECTOR'])
+end
 ```
 
-* options `Hash`
-  * `:browser_path` (String) - Path to chrome binary, you can also set ENV
-      variable as `BROWSER_PATH=some/path/chrome bundle exec rspec`.
-  * `:headless` (Boolean) - Set browser as headless or not, `true` by default.
-  * `:slowmo` (Integer | Float) - Set a delay to wait before sending command.
-      Usefull companion of headless option, so that you have time to see changes.
-  * `:logger` (Object responding to `puts`) - When present, debug output is
-      written to this object.
-  * `:timeout` (Numeric) - The number of seconds we'll wait for a response when
-      communicating with browser. Default is 5.
-  * `:js_errors` (Boolean) - When true, JavaScript errors get re-raised in Ruby.
-  * `:window_size` (Array) - The dimensions of the browser window in which to
-      test, expressed as a 2-element array, e.g. [1024, 768]. Default: [1024, 768]
-  * `:browser_options` (Hash) - Additional command line options,
-      [see them all](https://peter.sh/experiments/chromium-command-line-switches/)
-      e.g. `{ "ignore-certificate-errors" => nil }`
-  * `:extensions` (Array) - An array of JS files to be preloaded into the browser
-  * `:port` (Integer) - Remote debugging port for headless Chrome
-  * `:host` (String) - Remote debugging address for headless Chrome
-  * `:url` (String) - URL for a running instance of Chrome. If this is set, a
-      browser process will not be spawned.
-  * `:url_blacklist` (Array) - array of strings to match against requested URLs
-  * `:url_whitelist` (Array) - array of strings to match against requested URLs
-  * `:process_timeout` (Integer) - How long to wait for the Chrome process to
-      respond on startup
+then somewhere in the test:
+
+```ruby
+it "does something useful" do
+  visit root_path
+
+  fill_in "field", with: "value"
+  page.driver.debug(binding)
+
+  expect(page).to have_content("value")
+end
+```
+
+In the middle of the execution Chrome will open a new tab where you can inspect
+the content and also if you passed `binding` an `irb` or `pry` console will be
+opened where you can further experiment with the test.
+
 
-### Clicking/Scrolling ###
+## Clicking/Scrolling
 
 * `page.driver.click(x, y)` Click a very specific area of the screen.
-* `page.driver.scroll_to(left, top)` Scroll to given position.
-* `element.send_keys(*keys)` Send keys to given node.
+* `page.driver.scroll_to(left, top)` Scroll to a given position.
+* `element.send_keys(*keys)` Send keys to a given node.
 
-### Request headers ###
+
+## Request headers
 
 Manipulate HTTP request headers like a boss:
 
@@ -111,10 +127,11 @@ Notice that `headers=` will overwrite already set headers. You should use
 subsequent HTTP requests (including requests for assets, AJAX, etc). They will
 be automatically cleared at the end of the test.
 
-### Network traffic ###
 
-* `page.driver.network_traffic` Inspect network traffic (resources have been
-  loaded) on the current page. This returns an array of request objects.
+## Network traffic
+
+* `page.driver.network_traffic` Inspect network traffic (loaded resources) on
+the current page. This returns an array of request objects.
 
 ```ruby
 page.driver.network_traffic # => [Request, ...]
@@ -124,7 +141,8 @@ request.response
 
 * `page.driver.wait_for_network_idle` Natively waits for network idle and if
 there are no active connections returns or raises `TimeoutError` error. Accepts
-the same options as Ferrum's [`wait_for_idle`](https://github.com/route/ferrum#wait_for_idleoptions)
+the same options as
+[`wait_for_idle`](https://github.com/rubycdp/ferrum#wait_for_idleoptions)
 
 ```ruby
 page.driver.wait_for_network_idle
@@ -136,7 +154,7 @@ manually clear the network traffic by calling `page.driver.clear_network_traffic
 or `page.driver.reset`
 
 
-### Manipulating cookies ###
+## Manipulating cookies
 
 The following methods are used to inspect and manipulate cookies:
 
@@ -151,18 +169,22 @@ The following methods are used to inspect and manipulate cookies:
 * `page.driver.remove_cookie(name)` - remove a cookie
 * `page.driver.clear_cookies` - clear all cookies
 
-### Screenshot ###
+
+## Screenshot
 
 Besides capybara screenshot method you can get image as Base64:
 
 * `page.driver.render_base64(format, options)`
 
-### Authorization ###
+
+## Authorization
 
 * `page.driver.basic_authorize(user, password)`
 * `page.driver.set_proxy(ip, port, type, user, password)`
 
-### URL Blacklisting & Whitelisting ###
+
+## URL Blacklisting & Whitelisting
+
 Cuprite supports URL blacklisting, which allows you to prevent scripts from
 running on designated domains:
 
@@ -170,8 +192,8 @@ running on designated domains:
 page.driver.browser.url_blacklist = ["http://www.example.com"]
 ```
 
-and also URL whitelisting, which allows scripts to only run
-on designated domains:
+and also URL whitelisting, which allows scripts to only run on designated
+domains:
 
 ```ruby
 page.driver.browser.url_whitelist = ["http://www.example.com"]
@@ -181,22 +203,8 @@ 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,
 such as ad networks or analytics, to your testing environment.
 
-### Remote debugging ###
-
-If you use the `inspector: true` option, remote debugging will be enabled. When
-this option is enabled, you can insert `page.driver.debug` into your tests to
-pause the test and launch a browser which gives you the Chrome inspector to view
-all your open pages and inspect them.
-
-You could set the inspector option via an environment variable:
-
-```ruby
-Capybara.register_driver :cuprite do |app|
-  Capybara::Cuprite::Driver.new(app, inspector: ENV['INSPECTOR'])
-end
-```
 
-## License ##
+## License
 
 Copyright 2018-2020 Machinio
 

data/lib/capybara/cuprite/driver.rb

@@ -300,13 +300,26 @@ module Capybara::Cuprite
     end
     alias_method :authorize, :basic_authorize
 
-    def debug
+    def debug_url
+      "http://#{browser.process.host}:#{browser.process.port}"
+    end
+
+    def debug(binding = nil)
       if @options[:inspector]
-        Process.spawn(browser.process.path, "http://#{browser.process.host}:#{browser.process.port}")
-        pause
+        Process.spawn(browser.process.path, debug_url)
+
+        if binding&.respond_to?(:pry)
+          Pry.start(binding)
+        elsif binding&.respond_to?(:irb)
+          binding.irb
+        else
+          pause
+        end
       else
         raise Error, "To use the remote debugging, you have to launch " \
-                     "the driver with `inspector: true` configuration option"
+                     "the driver with `inspector: ENV['INSPECTOR']` " \
+                     "configuration option and run your test suite passing " \
+                     "env variable"
       end
     end
 
@@ -317,7 +330,7 @@ module Capybara::Cuprite
       # In jRuby - STDIN returns immediately from select
       # see https://github.com/jruby/jruby/issues/1783
       read, write = IO.pipe
-      Thread.new { IO.copy_stream(STDIN, write); write.close }
+      thread = Thread.new { IO.copy_stream(STDIN, write); write.close }
 
       STDERR.puts "Cuprite execution paused. Press enter (or run 'kill -CONT #{Process.pid}') to continue."
 
@@ -333,6 +346,8 @@ module Capybara::Cuprite
         end
       end
     ensure
+      thread.kill
+      read.close
       trap("SIGCONT", old_trap) # Restore the previous signal handler, if there was one.
       STDERR.puts "Continuing"
     end

data/lib/capybara/cuprite/node.rb

@@ -144,16 +144,16 @@ module Capybara::Cuprite
       command(:disabled?)
     end
 
-    def click(keys = [], offset = {})
-      prepare_and_click(:left, __method__, keys, offset)
+    def click(keys = [], **options)
+      prepare_and_click(:left, __method__, keys, options)
     end
 
-    def right_click(keys = [], offset = {})
-      prepare_and_click(:right, __method__, keys, offset)
+    def right_click(keys = [], **options)
+      prepare_and_click(:right, __method__, keys, options)
     end
 
-    def double_click(keys = [], offset = {})
-      prepare_and_click(:double, __method__, keys, offset)
+    def double_click(keys = [], **options)
+      prepare_and_click(:double, __method__, keys, options)
     end
 
     def hover
@@ -225,9 +225,12 @@ module Capybara::Cuprite
 
     private
 
-    def prepare_and_click(mode, name, keys, offset)
+    def prepare_and_click(mode, name, keys, options)
+      delay = options[:delay].to_i
+      x, y = options.values_at(:x, :y)
+      offset = { x: x, y: y, position: options[:offset] || :top }
       command(:before_click, name, keys, offset)
-      node.click(mode: mode, keys: keys, offset: offset)
+      node.click(mode: mode, keys: keys, offset: offset, delay: delay)
     end
 
     def filter_text(text)

data/lib/capybara/cuprite/page.rb

@@ -94,7 +94,12 @@ module Capybara::Cuprite
 
     def before_click(node, name, keys = [], offset = {})
       evaluate_on(node: node, expression: "_cuprite.scrollIntoViewport(this)")
-      x, y = find_position(node, offset[:x], offset[:y])
+
+      # If offset is given it may go outside of the element and likely error
+      # will be raised that we detected another element at this position.
+      return true if offset[:x] || offset[:y]
+
+      x, y = find_position(node, **offset)
       evaluate_on(node: node, expression: "_cuprite.mouseEventTest(this, '#{name}', #{x}, #{y})")
       true
     rescue Ferrum::JavaScriptError => e
@@ -174,8 +179,8 @@ module Capybara::Cuprite
       end
     end
 
-    def find_position(node, *args)
-      x, y = node.find_position(*args)
+    def find_position(node, **options)
+      x, y = node.find_position(**options)
     rescue Ferrum::BrowserError => e
       if e.message == "Could not compute content quads."
         raise MouseEventFailed.new("MouseEventFailed: click, none, 0, 0")

data/lib/capybara/cuprite/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Cuprite
-    VERSION = "0.9"
+    VERSION = "0.10"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuprite
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '0.10'
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: image_size
   requirement: !ruby/object:Gem::Requirement
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Headless Chrome driver for Capybara