Merge branch 'master' of https://github.com/mudbugmedia/critical-path-css-rails into update-penthouse

Author: jackcompton

.rubocop.yml

@@ -6,7 +6,6 @@ AllCops:
     - 'spec/*_helper.rb'
     - 'Gemfile'
     - 'Rakefile'
-    - 'Vagrantfile'
 
 Documentation:
     Enabled: false

.rubocop_todo.yml

@@ -1,18 +1,34 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-10-29 13:19:55 -0500 using RuboCop version 0.34.1.
+# on 2017-12-29 15:04:25 +0000 using RuboCop version 0.52.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
-  Max: 91
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 19
 
 # Offense count: 1
-# Configuration parameters: Exclude.
-Style/FileName:
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 31
+
+# Offense count: 1
+Naming/AccessorMethodName:
+  Exclude:
+    - 'spec/support/static_file_server.rb'
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
   Exclude:
     - 'lib/critical-path-css-rails.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 96

BACKLOG.md

@@ -1,12 +1,8 @@
 # Backlog
 
-## Tests
-- Add a testing suite (preferably rspec)
-
 ## Features
 - Allow the user to give a single route for a Controller#Show route, instead of hard coding every unique Resource#Show URL
   * Implementation should account for any route that allows variables/parameters in the URL
 - Error reporting during CSS generation (404, 500 errors, etc.)
-- Allow the user to pass arguments to Penthouse.js, i.e. Viewport size, etc. For a list of the configurable options, please see [Penthouse](https://github.com/pocketjoso/penthouse)
 - Improve installation process, if possible
 - Improve implementation. Is their a better solution then using Rails.cache?

Gemfile

@@ -3,8 +3,12 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'actionpack'
   gem 'byebug', platform: [:ruby], require: false
   gem 'rubocop', require: false
+  gem 'rspec-rails', '~> 3.6'
+  gem 'capybara', '~> 2.16'
+  gem 'pry-rails'
 end
 
 # HACK: npm install on bundle

README.md

@@ -2,22 +2,32 @@
 
 Only load the CSS you need for the initial viewport in Rails!
 
-This gem give you the ability to load only the CSS you *need* on an initial page view. This gives you blazin' fast rending as there's no initial network call to grab your application's CSS.
+This gem gives you the ability to load only the CSS you *need* on an initial page view. This gives you blazin' fast rending as there's no initial network call to grab your application's CSS.
 
 This gem assumes that you'll load the rest of the CSS asyncronously. At the moment, the suggested way is to use the [loadcss-rails](https://github.com/michael-misshore/loadcss-rails) gem.
 
 This gem uses [Penthouse](https://github.com/pocketjoso/penthouse) to generate the critical CSS.
 
-## Update
+## Dependency Requirements for / Upgrading to the Latest Release
 
-Versions below 0.3.0 are not compatible with this version.  Please read the Upgrading from Previous Versions section below for more information.
+### For 1.0.0 or later
+To maintain the latest version of Penthouse, this gem depends on NodeJS and NVM to be installed on the system.
+
+### For 2.0.0 or later
+This gem may require additional packages to be installed to run Chrome headless. Per the Penthouse documentation, this may be all you need:
+
+```
+sudo apt-get install libnss3
+```
+
+However, more packages may need to be installed depending on your OS distribution which can be found via [this answer](https://github.com/GoogleChrome/puppeteer/issues/404#issuecomment-323555784)
 
 ## Installation
 
-Add `critical-path-css-rails` to your Gemfile:
+After reviewing the dependency requirements, add `critical-path-css-rails` to your Gemfile:
 
 ```
-gem 'critical-path-css-rails', '~> 1.0.0'
+gem 'critical-path-css-rails', '~> 2.3.0'
 ```
 
 Download and install by running:
@@ -110,7 +120,7 @@ Careful use of these methods allows the developer to generate critical path CSS
 
 A user can use these methods to [dynamically generate critical path CSS](https://gist.github.com/taranda/1597e97ccf24c978b59aef9249666c77) without using the `rake critical_path_css:generate` rake task and without hardcoding the application's routes into `config/critical_path_css.yml`.  See [this Gist](https://gist.github.com/taranda/1597e97ccf24c978b59aef9249666c77) for an example of such an implementation.
 
-## Upgrading from Previous Versions
+## Upgrading from a version earlier than 0.3.0
 
 The latest version of Critcal Path CSS Rails changes the functionality of the `generate` method.  In past versions,
 `generate` would produce CSS for all of the routes listed in `config/critical_path_css.yml`.  This functionality has been replaced by the `generate_all` method, and `generate` will only produce CSS for one route.
@@ -121,7 +131,21 @@ Developers upgrading from versions prior to 0.3.0 will need to replace `Critical
 rails generate critical_path_css:install
 ```
 
-Answer 'Y' when prompted to overwrite `critical_path_css.rake`.  However, overwriting `critical_path_css.yml` is not necessary and not recommended.
+Answer 'Y' when prompted to overwrite `critical_path_css.rake`.  However, overwriting `critical_path_css.yml` is not recommended nor necessary.
+
+
+## Testing / Development
+
+This gem is to be tested inside of docker/docker-compose. [Combustion](https://github.com/pat/combustion), alongside rspec-rails and capybara, are the primary components for testing. To run the test, you'll need to have [Docker](https://docs.docker.com/engine/installation) installed. Once installed, run the following commands in the gem's root to build, run, and shell into the docker container.
+
+```Bash
+  docker-compose build
+  docker-compose up -d
+  docker exec -it $(cat app_container_name) /bin/bash
+```
+
+Once shell'd in, run `bundle exec rspec spec` to run the test. The test rails app lives in `spec/internal`, and it can be viewed locally at `http://localhost:9292/`
+
 
 ## Versions
 
@@ -135,8 +159,6 @@ major version bump = major-level updates to critical-path-css-rails, Penthouse,
 
 ## Contributing
 
-Feel free to open an issue ticket if you find something that could be improved. A couple notes:
-
-* If the Penthouse.js script is outdated (i.e. maybe a new version of Penthouse.js was released yesterday), feel free to open an issue and prod us to get that thing updated. However, for security reasons, we won't be accepting pull requests with updated Penthouse.js script.
+Feel free to open an issue ticket if you find something that could be improved.
 
-Copyright Mudbug Media and Michael Misshore, released under the MIT License.
+Copyright Mudbug Media and Michael Misshore, released under the MIT License.

app_container_name

@@ -0,0 +1 @@
+criticalpathcss_ruby

config.ru

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+require 'combustion'
+
+Combustion.initialize! :action_controller, :action_view
+run Combustion::Application

critical-path-css-rails.gemspec

@@ -1,20 +1,20 @@
 require File.expand_path('../lib/critical_path_css/rails/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name        = 'critical-path-css-rails'
-  s.version     = CriticalPathCSS::Rails::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Michael Misshore']
-  s.email       = 'mmisshore@gmail.com'
-  s.summary     = 'Critical Path CSS for Rails!'
-  s.description = 'Only load the CSS you need for the initial viewport in Rails!'
-  s.license     = 'MIT'
+Gem::Specification.new do |gem|
+  gem.name        = 'critical-path-css-rails'
+  gem.version     = CriticalPathCSS::Rails::VERSION
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ['Michael Misshore']
+  gem.email       = 'mmisshore@gmail.com'
+  gem.summary     = 'Critical Path CSS for Rails!'
+  gem.description = 'Only load the CSS you need for the initial viewport in Rails!'
+  gem.license     = 'MIT'
 
-  s.files        = `git ls-files`.split("\n")
-  s.executables  = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_path = 'lib'
+  gem.files        = `git ls-files`.split("\n")
+  gem.executables  = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_path = 'lib'
 
-  s.add_development_dependency 'rspec', '~> 3.6'
+  gem.add_development_dependency 'combustion', '~> 0.7.0'
 
-  s.extensions = ['ext/npm/extconf.rb']
+  gem.extensions = ['ext/npm/extconf.rb']
 end

docker-compose.yml

@@ -0,0 +1,21 @@
+version: '2'
+services:
+    ruby:
+        build:
+            context: .
+            dockerfile: docker/ruby/Dockerfile
+        ports:
+            - 9292:9292
+        volumes:
+            - .:/app:rw
+        volumes_from:
+            - data
+        env_file: docker/ruby/.env
+        container_name: criticalpathcss_ruby
+    data:
+        build:
+            context: .
+            dockerfile: docker/ruby/Dockerfile
+        volumes:
+            - /gems
+        command: "true"

docker/ruby/.env

@@ -0,0 +1 @@
+RAILS_ENV=development