cuprite 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b3d43410a4b7875e111108b5ef1b53bf07589f833925ea3a9e336d725d99b95
-  data.tar.gz: 6cea0c2abdef1b5d8f8b6468f2924dac1cbbe5b51f1a4b6ce74bb980a86278ab
+  metadata.gz: 2931562eb83d217b25c93d8449b3a5e3c401e2ad64689a7b60c1de9b6abb8b5b
+  data.tar.gz: 5701e966d47d9dc45450b47dbb51ed56cd0ba94abe904573a2fc54bc04042210
 SHA512:
-  metadata.gz: cd77da4241673d610343e552245f5e0421ee6fe8613cc437bd53d0e8bd3d63be8b422a4abf36fcfedf35d79bbed0b7db5fe26250e5b86f737ac4479c6e02281e
-  data.tar.gz: cd86413a1b47478e4b0545c28c5ba0ea54a592d889ef0420547d2192bfdac7bece55e9557d88d48cca0720a8d86562dbe281b0988e1234fc55a25d7fc44484c1
+  metadata.gz: a348c4d493896c9ba2ba729a83741fd4ff8f52a6bead2486654a6c8ad90408780fec57ea2adcdeb7bc359516e4c768fb67b15fa0bdd862cbb314af4e6c462401
+  data.tar.gz: 6639dc96f4da906ce8f69657043e28de6d98f28e5cf0d7a71b8e0a3af7eca2ed94f3b931c539910b46ffabc147e54c8c0a847d8499df2efef30b4863e16ec93f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Machinio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,180 @@
+# Cuprite - Headless Chrome driver for Capybara #
+
+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/) browser while the latter is prefered
+for now because we work with tip-of-tree [protocol](https://chromedevtools.github.io/devtools-protocol/).
+
+The emphasis was made on raw CDP protocol because Headless Chrome allows you to
+do so many cool 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 but it's not a goal.
+
+## Speed comparison and missing features ##
+
+Almost all capybara tests are passing with quite good speed in comparison with
+Poltergest/PhantomJS:
+
+```
+cuprite:
+Finished in 4 minutes 15 seconds (files took 1.23 seconds to load)
+1533 examples, 0 failures, 148 pending
+
+poltergeist:
+Finished in 7 minutes 6 seconds (files took 0.59349 seconds to load)
+1560 examples, 0 failures, 6 pending
+
+selenium headless chrome:
+Finished in 9 minutes 3 seconds (files took 5.98 seconds to load)
+1445 examples, 0 failures, 3 pending
+```
+
+## Installation ##
+
+``` ruby
+gem "cuprite"
+```
+and run `bundle install`.
+
+In your test setup add:
+
+``` ruby
+require "capybara/cuprite"
+Capybara.javascript_driver = :cuprite
+```
+
+If you were previously using the `:rack_test` driver, be aware that
+your app will now run in a separate thread and this can have
+consequences for transactional tests. [See the Capybara README for more detail](https://github.com/jnicklas/capybara/blob/master/README.md#transactions-and-database-setup).
+
+## Installing Chromium ##
+
+As Chromium is stopped being built as a package for Linux don't even try to
+install it this way because it will either be outdated or unofficial package.
+Both are bad. Download it from official [source](https://www.chromium.org/getting-involved/download-chromium).
+
+## Supported features ##
+
+All the mandatory capybara features plus optional ones:
+
+* `page.evaluate_script` and `page.execute_script`
+* `page.within_frame`
+* `page.status_code`
+* `page.response_headers`
+* `page.save_screenshot`
+* `page.driver.render_base64(format, options)`
+* window API
+* cookie handling
+
+### Clicking coordinates ###
+
+Sometimes its desirable to click a very specific area of the screen. You can
+accomplish this with `page.driver.click(x, y)`, where x and y are the screen
+coordinates.
+
+### Manipulating request headers ###
+
+Manipulate HTTP request headers like a boss:
+
+``` ruby
+page.driver.headers # => {}
+page.driver.headers = { "User-Agent" => "Cuprite" }
+page.driver.add_headers("Referer" => "https://example.com")
+page.driver.headers # => { "User-Agent" => "Cuprite", "Referer" => "https://example.com" }
+```
+
+Notice that `headers=` will overwrite already set headers. You should use
+`add_headers` if you want to add a few more. These headers will apply to all
+subsequent HTTP requests (including requests for assets, AJAX, etc). They will
+be automatically cleared at the end of the test.
+
+### Inspecting network traffic ###
+
+You can inspect the network traffic (i.e. what resources have been loaded) on
+the current page by calling `page.driver.network_traffic`. This returns an array
+of request objects. A request object has a `response` method containing data
+about the response.
+
+Please note that network traffic is not cleared when you visit new page. You can
+manually clear the network traffic by calling `page.driver.clear_network_traffic`
+or `page.driver.reset`
+
+### Manipulating cookies ###
+
+The following methods are used to inspect and manipulate cookies:
+
+* `page.driver.cookies` - a hash of cookies accessible to the current
+  page. The keys are cookie names. The values are `Cookie` objects, with
+  the following methods: `name`, `value`, `domain`, `path`, `size`, `secure?`,
+  `httponly?`, `session?`, `expires`.
+* `page.driver.set_cookie(name, value, options = {})` - set a cookie.
+  The options hash can take the following keys: `:domain`, `:path`,
+  `:secure`, `:httponly`, `:expires`. `:expires` should be a
+  `Time` object.
+* `page.driver.remove_cookie(name)` - remove a cookie
+* `page.driver.clear_cookies` - clear all cookies
+
+## Customization ##
+
+You can customize the way that Capybara sets up Cuprite via the following code
+in your test setup:
+
+``` ruby
+Capybara.register_driver :cuprite do |app|
+  Capybara::Cuprite::Driver.new(app, options)
+end
+```
+
+`options` is a hash of options. The following options are supported:
+
+* `:browser` (Hash) - Hash of options to be passed to chrome process:
+  * `:path` (String) - Path to chrome binary, you can also set ENV variable as
+    `BROWSER_PATH=some/path/chrome bundle exec rspec`
+  * `: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]
+  * `:port` (Integer) - Remote debugging port for headless Chrome
+  * `:host` (String) - Remote debugging address for headless Chrome
+
+### URL Blacklisting & Whitelisting ###
+Cuprite supports URL blacklisting, which allows you to prevent scripts from
+running on designated domains:
+
+```ruby
+page.driver.browser.url_blacklist = ['http://www.example.com']
+```
+
+and also URL whitelisting, which allows scripts to only run
+on designated domains:
+
+```ruby
+page.driver.browser.url_whitelist = ['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,
+such as ad networks or analytics, to your testing environment.
+
+## License ##
+
+Copyright 2018-2019 Machinio
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/capybara/cuprite.rb

@@ -6,11 +6,11 @@ Thread.abort_on_exception = true
 Thread.report_on_exception = true
 
 module Capybara::Cuprite
-  require "cuprite/driver"
-  require "cuprite/browser"
-  require "cuprite/node"
-  require "cuprite/errors"
-  require "cuprite/cookie"
+  require "capybara/cuprite/driver"
+  require "capybara/cuprite/browser"
+  require "capybara/cuprite/node"
+  require "capybara/cuprite/errors"
+  require "capybara/cuprite/cookie"
 
   class << self
     def windows?

data/lib/capybara/cuprite/browser.rb

@@ -2,10 +2,10 @@
 
 require "base64"
 require "forwardable"
-require "cuprite/browser/targets"
-require "cuprite/browser/process"
-require "cuprite/browser/client"
-require "cuprite/browser/page"
+require "capybara/cuprite/browser/targets"
+require "capybara/cuprite/browser/process"
+require "capybara/cuprite/browser/client"
+require "capybara/cuprite/browser/page"
 
 module Capybara::Cuprite
   class Browser
@@ -91,7 +91,7 @@ module Capybara::Cuprite
     end
 
     def delete_text(node)
-      raise NotImplementedError
+      evaluate_on(node: node, expr: "_cuprite.deleteText(this)")
     end
 
     def select_file(node, value)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "timeout"
-require "cuprite/browser/web_socket"
+require "capybara/cuprite/browser/web_socket"
 
 module Capybara::Cuprite
   class Browser

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

@@ -59,20 +59,19 @@ module Capybara::Cuprite
       end
 
       def send_keys(node, keys)
-        # value.each_char do |char|
-        #   # Check puppeteer Input.js and USKeyboardLayout.js
-        #   # also send_keys and modifiers from capybara API and unify all that.
-        #   if /\n/.match?(char)
-        #     command("Input.insertText", text: char)
-        #     # command("Input.dispatchKeyEvent", type: "keyDown", code: "Enter", key: "Enter", text: "\r")
-        #     # command("Input.dispatchKeyEvent", type: "keyUp", code: "Enter", key: "Enter")
-        #   else
-        #     command("Input.dispatchKeyEvent", type: "keyDown", text: char)
-        #     command("Input.dispatchKeyEvent", type: "keyUp", text: char)
-        #   end
-        # end
-        # command "send_keys", node, normalize_keys(keys)
-        raise NotImplementedError
+        click(node) if !evaluate_on(node: node, expr: %(_cuprite.containsSelection(this)))
+
+        keys.first.each_char do |char|
+          # Check puppeteer Input.js and USKeyboardLayout.js also send_keys and modifiers from poltergeist.
+          if /\n/.match?(char)
+            command("Input.insertText", text: char)
+            # command("Input.dispatchKeyEvent", type: "keyDown", code: "Enter", key: "Enter", text: "\r")
+            # command("Input.dispatchKeyEvent", type: "keyUp", code: "Enter", key: "Enter")
+          else
+            command("Input.dispatchKeyEvent", type: "keyDown", text: char)
+            command("Input.dispatchKeyEvent", type: "keyUp", text: char)
+          end
+        end
       end
 
       private

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

@@ -122,8 +122,19 @@ class Cuprite {
     this.trigger(node, "focus");
     node.value = "";
 
-    if (node.type == "number") {
-      node.value = value
+    if (node.type == "number" || node.type == "date") {
+      node.value = value;
+    } else if (node.type == "time") {
+      node.value = new Date(value).toTimeString().split(" ")[0];
+    } else if (node.type == "datetime-local") {
+      value = new Date(value);
+      let year = value.getFullYear();
+      let month = ("0" + (value.getMonth() + 1)).slice(-2);
+      let date = ("0" + value.getDate()).slice(-2);
+      let hour = ("0" + value.getHours()).slice(-2);
+      let min = ("0" + value.getMinutes()).slice(-2);
+      let sec = ("0" + value.getSeconds()).slice(-2);
+      node.value = `${year}-${month}-${date}T${hour}:${min}:${sec}`;
     } else {
       for (let i = 0; i < value.length; i++) {
         let char = value[i];
@@ -402,6 +413,28 @@ class Cuprite {
       return node.value;
     }
   }
+
+  deleteText(node) {
+    let range = document.createRange();
+    range.selectNodeContents(node);
+    window.getSelection().removeAllRanges();
+    window.getSelection().addRange(range);
+    window.getSelection().deleteFromDocument();
+  }
+
+  containsSelection(node) {
+    let selectedNode = document.getSelection().focusNode;
+
+    if (!selectedNode) {
+      return false;
+    }
+
+    if (selectedNode.nodeType == 3) {
+      selectedNode = selectedNode.parentNode;
+    }
+
+    return node.contains(selectedNode);
+  }
 }
 
 window._cuprite = new Cuprite;

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "cuprite/browser/dom"
-require "cuprite/browser/input"
-require "cuprite/browser/runtime"
-require "cuprite/browser/frame"
-require "cuprite/browser/client"
-require "cuprite/network/error"
-require "cuprite/network/request"
-require "cuprite/network/response"
+require "capybara/cuprite/browser/dom"
+require "capybara/cuprite/browser/input"
+require "capybara/cuprite/browser/runtime"
+require "capybara/cuprite/browser/frame"
+require "capybara/cuprite/browser/client"
+require "capybara/cuprite/network/error"
+require "capybara/cuprite/network/request"
+require "capybara/cuprite/network/response"
 
 # RemoteObjectId is from a JavaScript world, and corresponds to any JavaScript
 # object, including JS wrappers for DOM nodes. There is a way to convert between

data/lib/capybara/cuprite/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Cuprite
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuprite
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -184,6 +184,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/capybara/cuprite.rb
 - lib/capybara/cuprite/browser.rb
 - lib/capybara/cuprite/browser/client.rb
@@ -211,12 +213,12 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- lib/capybara
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="