capybara-headless_chrome 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a764592d374ab41b59fd54042520ab3e7437eb4
-  data.tar.gz: a39469d6e392e66383c8f7c61fd39f9d24945b47
+  metadata.gz: 072a6982915af40cdbd5b6c8141dd6cbb78e81c2
+  data.tar.gz: c9f75a5a769c27861f5f93775c6a11f3be0d1894
 SHA512:
-  metadata.gz: 43b71aa6fd7a8caa1aaad2ae0048c959191477d3252912a0eef7c3172bf7b6d740940b42ffb52bcae19c1aaf33d054ffdf7d1d795fc55fc0dcf565d2bf8555cc
-  data.tar.gz: a957183b4d92c42a9f649a6df5e77ebef6dc9ecceea454cbac2b0a37d5d54ce64ce55125f289d6ae972804aec66c02c2f55d40b6af84035beba040d92e8b40ba
+  metadata.gz: b3e174527bdf32088f5980f02aa8354dc3890b310575385ceea692bae5db45ab663605c719a5fa8469846d4cbb6ed0b5e6e58a0143ad22c882cfe7fa4f7b8521
+  data.tar.gz: e6b9b81bbdadec609b7b4bdb79ffd9c1b98b1538794c4d11b11d4d22b57995b1781a89f8f02bb350f0457ad2f1917a01e3424c48d0c3dbe5b0a5f1c22f4b8666

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+.ruby-version
+.ruby-gemset
+Gemfile.lock

data/README.md

@@ -1,15 +1,37 @@
 # Capybara::HeadlessChrome
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/capybara/headless_chrome`. To experiment with that code, run `bin/console` for an interactive prompt.
+A nice and tidy Capybara driver for headless Chrome. Even supports file downloads!
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
+
+### Capybara Setup
+
+Just `require "capybara/headless_chrome"` somewhere in your test setup. This will register the `:chrome` driver, and make it  Capybara's default.
+
+### Working with Downloaded Files
+
+The Capybara session is extended with a single `#downloads` method that provides access to files downloaded during the session.
+
+```ruby
+page.click_link "Download Report"
+page.downloads.filenames # => ["report.csv"]
+page.downloads["report.csv"] # => #<File:report.csv>
+```
+
+Note that the `#[]` method is wrapped with Capybara's synchronize, so it will keep trying to find the file for up to `Capybara.default_max_wait_time` seconds.
+
+Be sure to run `page.downloads.reset` at the beginning of every test run to empty the downloaded files list.
+
+If you're using Cucumber, you can `require "capybara/headless_chrome/cucumber"` somewhere in your cucumber configuration to set this up for you.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this to your application's Gemfile:
 
 ```ruby
-gem 'capybara-headless_chrome'
+group :test do
+  gem 'capybara-headless_chrome'
+end
 ```
 
 And then execute:
@@ -20,10 +42,6 @@ Or install it yourself as:
 
     $ gem install capybara-headless_chrome
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/capybara-headless_chrome.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Micah Geisel"]
   spec.email         = ["micah@botandrose.com"]
 
-  spec.summary       = "Wiring between Capybara and Headless Chrome"
-  spec.description   = "Wiring between Capybara and Headless Chrome"
+  spec.summary       = "A nice and tidy Capybara driver for headless Chrome"
+  spec.description   = "A nice and tidy Capybara driver for headless Chrome. Even supports file downloads!"
   spec.homepage      = "https://github.com/botandrose/capybara-headless_chrome"
   spec.license       = "MIT"
 

data/lib/capybara/headless_chrome/cucumber.rb

@@ -1,4 +1,4 @@
 Before do
-  Capybara::HeadlessChrome::Downloads.setup
+  page.downloads.reset
 end
 

data/lib/capybara/headless_chrome/downloads.rb

@@ -0,0 +1,44 @@
+require "fileutils"
+require "capybara"
+
+module Capybara
+  module HeadlessChrome
+    class Downloads
+      class NotFound < Capybara::ExpectationNotMet; end
+
+      def dir
+        pathname.to_s
+      end
+
+      def reset
+        FileUtils.rm_rf(dir)
+        FileUtils.mkdir_p(dir)
+      end
+
+      def filenames
+        pathname.entries.reject(&:directory?).map(&:to_s)
+      end
+
+      def [] filename
+        Capybara.current_session.document.synchronize do
+          begin
+            File.open(pathname.join(filename))
+          rescue Errno::ENOENT
+            raise NotFound.new("Couldn't find #{filename} in #{filenames}")
+          end
+        end
+      end
+
+      private
+
+      def pathname
+        @pathname ||= Capybara.save_path.join(unique_id, "downloads")
+      end
+
+      def unique_id
+        Time.now.strftime('%s%L')
+      end
+    end
+  end
+end
+

data/lib/capybara/headless_chrome/driver.rb

@@ -0,0 +1,66 @@
+require "selenium/webdriver"
+require "chromedriver/helper"
+require "capybara"
+require "capybara/headless_chrome/downloads"
+
+module Capybara
+  module HeadlessChrome
+    class Driver < Capybara::Selenium::Driver
+      def initialize app
+        super(app, browser: :chrome, desired_capabilities: chrome_capabilities)
+        configure_downloads
+      end
+
+      def downloads
+        @downloads ||= Downloads.new
+      end
+
+      private
+
+      def chrome_capabilities
+        ::Selenium::WebDriver::Remote::Capabilities.chrome(
+          chromeOptions: {
+            args: chrome_arguments,
+            prefs: chrome_preferences
+          }
+        )
+      end
+
+      def chrome_arguments
+        [
+          "no-sandbox",
+          "headless",
+          "disable-infobars",
+          "disable-popup-blocking",
+          "disable-gpu",
+          "window-size=1280,1024",
+        ]
+      end
+
+      def chrome_preferences
+        {
+          "download.default_directory" => downloads.dir,
+          "download.directory_upgrade": "true",
+          "download.prompt_for_download": "false",
+          "browser.set_download_behavior": "{ behavior: 'allow' }",
+        }
+      end
+
+      def configure_downloads
+        bridge = browser.send(:bridge)
+        path = '/session/:session_id/chromium/send_command'
+        path[':session_id'] = bridge.session_id
+
+        bridge.http.call(:post,
+          path,
+          cmd: 'Page.setDownloadBehavior',
+          params: {
+            behavior: 'allow',
+            downloadPath: downloads.dir,
+          }
+        )
+      end
+    end
+  end
+end
+

data/lib/capybara/headless_chrome/session_dsl.rb

@@ -0,0 +1,10 @@
+module Capybara
+  module HeadlessChrome
+    module SessionDSL
+      def downloads
+        driver.downloads
+      end
+    end
+  end
+end
+

data/lib/capybara/headless_chrome/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module HeadlessChrome
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/capybara/headless_chrome.rb

@@ -1,94 +1,12 @@
 require "capybara/headless_chrome/version"
-require "capybara"
-require "chromedriver/helper"
-require "selenium/webdriver"
-
-module Capybara
-  module HeadlessChrome
-    class DownloadNotFound < Capybara::ExpectationNotMet; end
-
-    class Downloads
-      class << self
-        def setup
-          FileUtils.rm_rf dir
-          FileUtils.mkdir_p dir
-        end
-
-        def configure_driver driver
-          bridge = driver.browser.send(:bridge)
-          path = '/session/:session_id/chromium/send_command'
-          path[':session_id'] = bridge.session_id
-
-          bridge.http.call(:post,
-            path,
-            cmd: 'Page.setDownloadBehavior',
-            params: {
-              behavior: 'allow',
-              downloadPath: dir,
-            }
-          )
-        end
-
-        def chrome_prefs
-          {
-            "download.default_directory" => dir,
-            "download.directory_upgrade": "true",
-            "download.prompt_for_download": "false",
-            "browser.set_download_behavior": "{ behavior: 'allow' }",
-          }
-        end
-
-        def dir
-          pathname.to_s
-        end
-
-        def pathname
-          Capybara.save_path.join("downloads")
-        end
-      end
-
-      def filenames
-        self.class.pathname.entries.reject(&:directory?).map(&:to_s)
-      end
-
-      def [] filename
-        path = self.class.pathname.join(filename)
-        Capybara.current_session.document.synchronize do
-          begin
-            File.open(path)
-          rescue Errno::ENOENT
-            raise DownloadNotFound.new("Couldn't find #{filename} in #{filenames}")
-          end
-        end
-      end
-    end
-  end
-end
+require "capybara/headless_chrome/driver"
+require "capybara/headless_chrome/session_dsl"
 
 Capybara.register_driver :chrome do |app|
-  capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
-    chromeOptions: {
-      args: [
-        "no-sandbox",
-        "headless",
-        "disable-infobars",
-        "disable-popup-blocking",
-        "disable-gpu",
-        "window-size=1280,1024",
-      ],
-      prefs: {}.merge(Capybara::HeadlessChrome::Downloads.chrome_prefs),
-    }
-  )
-  Capybara::Selenium::Driver.new(app, browser: :chrome, desired_capabilities: capabilities).tap do |driver|
-    Capybara::HeadlessChrome::Downloads.configure_driver driver
-  end
+  Capybara::HeadlessChrome::Driver.new(app)
 end
 
-Capybara.javascript_driver = :chrome
-Capybara.default_driver = :chrome
+Capybara.default_driver = Capybara.javascript_driver = :chrome
+
+Capybara::Session.include Capybara::HeadlessChrome::SessionDSL
 
-Capybara::Session.class_eval do
-  def downloads
-    Capybara::HeadlessChrome::Downloads.new
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-headless_chrome
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Micah Geisel
@@ -94,7 +94,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Wiring between Capybara and Headless Chrome
+description: A nice and tidy Capybara driver for headless Chrome. Even supports file
+  downloads!
 email:
 - micah@botandrose.com
 executables: []
@@ -113,6 +114,9 @@ files:
 - capybara-headless_chrome.gemspec
 - lib/capybara/headless_chrome.rb
 - lib/capybara/headless_chrome/cucumber.rb
+- lib/capybara/headless_chrome/downloads.rb
+- lib/capybara/headless_chrome/driver.rb
+- lib/capybara/headless_chrome/session_dsl.rb
 - lib/capybara/headless_chrome/version.rb
 homepage: https://github.com/botandrose/capybara-headless_chrome
 licenses:
@@ -137,5 +141,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Wiring between Capybara and Headless Chrome
+summary: A nice and tidy Capybara driver for headless Chrome
 test_files: []