breakfast 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55fe92f6b48d4ee747f50fc3a831d0863723e6bd
-  data.tar.gz: 9a123637c58184758187ee44848f435a027d6910
+  metadata.gz: f9efb82f14ced85f239814ee2c1433b33f84cda1
+  data.tar.gz: ee25eca42d5a7358d824f7f5b533f6ca755e63b0
 SHA512:
-  metadata.gz: d361f652699abef3b4a145ff06370860c08552240830fb338e2fbfe399d769141de8a803c14859c91585cf15084ce92ca80c48ea2a70787a428bcf34e308ed68
-  data.tar.gz: 901bb0ece81ea661d5871ab62b8d2228fdfc68466faf99e66dbf1ab024f48196e7792a17d0fd1bf390573476b4755776f0be997347e47fd96e790c9f861c2b6d
+  metadata.gz: 62cdcdf0e004938f9d672cf8dc1d700f7b2aee6416617283611767e34ae9cbf99d8396e7de82fe75cb2b94c0891c0268c42f03cd58c6ff4c76901d00e9569077
+  data.tar.gz: e3ed59e5fc4c426d6c342427c3e6251ff1dba14e735def521dc19c6bb747fdb0bbae596c4670b443a3c041353abb29aa40a93608ecc7ad49f5e7b832b6b10328

data/CHANGELOG.md

@@ -1,9 +1,59 @@
 # CHANGE LOG
 
+### 0.4.0 - 2016-11-14
+#### Upgrading to `0.4.0` from `0.3.0`
+- Update gem with `bundle update breakfast`
+- Bump the `breakfast-rails` version in `package.json` to `0.4.0`
+- Run `npm install`
+
+*Note* Now by default asset fingerprinting will be on by default in production.
+A copy of each with the original filename will be present as well, so any
+hard-coded links to assets will still work correctly.
+
+#### Added
+- Asset Digests. Now when deploying assets will have fingerprints added to their
+  file names. This allows browsers to aggressively cache your assets.
+- New Option: `breakfast.manifest.digest`. Defaults to false in development /
+  test and true everywhere else. When true, enables Rails to serve fingerprinted
+  assets.
+- Rake Commands to trigger certain behavior:
+  - `breakfast:assets:build`
+    Manually run a compilation step.
+  - `breakfast:assets:build_production`
+    Manually trigger a production build. This will cause assets to get minified.
+  - `breakfast:assets:digest`
+    Run through your compiled assets and add a fingerprint to each one. Creates
+    a copy, leaving a file with the original filename and a duplicate with an
+    md5 fingerprint.
+  - `breakfast:assets:clean`
+    Removes any assets from the output folder that are not specified in the
+    manifest file (removes out of date files).
+  - `breakfast:assets:nuke`
+    Removes manifest and fingerprinted assets from the output folder.
+- New Capistrano Option: `:breakfast_npm_install_command`
+  Defaults to just `install`. Can be overridden to redirect output to dev/null.
+  Example:
+
+  ```
+  set :breakfast_npm_install_command, "install > /dev/null 2>&1"
+  ```
+
+#### Changes
+- Fixed small CSS issue if box-sizing is not set border-box globally.
+
+
+#### Contributors
+Many many thanks to the contributors for this release!
+- [@patkoperwas](https://github.com/patkoperwas)
+- [@mikeastock](https://github.com/mikeastock)
+- [@HParker](https://github.com/HParker)
+
+
 ## 0.3.1 - 2016-10-19
 - Better support for determining if Server is running. Using puma, passneger,
   etc. instead of the default rails server command now work.
 
+
 ## 0.3.0 - 2016-09-28
 
 ### Upgrading from `0.2.0`

data/README.md

@@ -15,46 +15,48 @@ See the official docs at
 
 View updates in the [CHANGELOG](https://github.com/devlocker/breakfast/blob/master/CHANGELOG.md)
 
-### Latest Patch `0.3.1`
-- Allows Breakfast to run when Rails is started outside of bin/rails server,
-  i.e. bundle exec puma, passenger, thin, etc.
-
-### Latest Release `0.3.0`
+### Latest Release `0.4.0`
 #### Added
-- New status bar that allows the user to switch reload strategies on the fly
-- Support for Haml & Slim files (without .html extension)
-- Reloading on ruby file changes.
-- Specify minimum Node & NPM versions when installing (avoid awkward and none
-  descriptive error messages)
-- NPM binary path for Capistrano
+- Asset Digests. Now when deploying assets will have fingerprints added to their
+  file names. This allows browsers to aggressively cache your assets.
+- New Option: `breakfast.manifest.digest`. Defaults to false in development /
+  test and true everywhere else. When true, enables Rails to serve fingerprinted
+  assets.
+- Rake Commands to trigger certain behavior:
+  - `breakfast:assets:build`
+    Manually run a compilation step.
+  - `breakfast:assets:build_production`
+    Manually trigger a production build. This will cause assets to get minified.
+  - `breakfast:assets:digest`
+    Run through your compiled assets and add a fingerprint to each one. Creates
+    a copy, leaving a file with the original filename and a duplicate with an
+    md5 fingerprint.
+  - `breakfast:assets:clean`
+    Removes any assets from the output folder that are not specified in the
+    manifest file (removes out of date files).
+  - `breakfast:assets:nuke`
+    Removes manifest and fingerprinted assets from the output folder.
+- New Capistrano Option: `:breakfast_npm_install_command`
+  Defaults to just `install`. Can be overridden to redirect output to dev/null.
+  Example:
 
-#### Changes
-- config.breakfast.view_folders change to config.breakfast.source_code_folders.
-  Change brought about by need to trigger reloads when Ruby source code changes.
+  ```
+  set :breakfast_npm_install_command, "install > /dev/null 2>&1"
+  ```
 
-#### Removed
-- config.breakfast.view_folders is no longer supported. Deprecated in favor of
-  source_code_folders option.
+#### Changes
+- Fixed small CSS issue if box-sizing is not set border-box globally.
 
 
 ### Upgrading
-#### Upgrading to `0.3.0` from `0.2.0`
+#### Upgrading to `0.4.0` from `0.3.0`
 - Update gem with `bundle update breakfast`
-- Bump the `breakfast-rails` version in `package.json` to `0.3.1`
+- Bump the `breakfast-rails` version in `package.json` to `0.4.0`
 - Run `npm install`
-- If you have modified the `config.breakfast.view_folders` option you will need
-  to replace it. The new option is `config.breakfast.source_code_folders` and it
-  defaults to `[Rails.root.join("app")]`. If you have view or Ruby files that
-  you would like to trigger reloads outside of the `app` folder then append
-  those paths by adding:
-
-  ```
-  config.breakfast.source_code_folders << Rails.root.join("lib")
-  ```
-
-  To which ever environment you want `Breakfast` to run in
-  (probably `config/environments/development.rb`).
 
+*Note* Now by default asset fingerprinting will be on by default in production.
+A copy of each with the original filename will be present as well, so any
+hard-coded links to assets will still work correctly.
 
 ### Contributing
 Bug reports and pull requests are welcome on GitHub at

data/lib/breakfast.rb

@@ -1,13 +1,17 @@
 require "breakfast/version"
+
+require "breakfast/brunch_watcher"
+require "breakfast/compilation_listener"
 require "breakfast/live_reload_channel"
+require "breakfast/manifest"
 require "breakfast/status_channel"
 require "breakfast/view_helper"
-require "breakfast/brunch_watcher"
-require "breakfast/compilation_listener"
 
 module Breakfast
   STATUS_CHANNEL = "breakfast_status".freeze
   RELOAD_CHANNEL = "breakfast_live_reload".freeze
+  BUILD_COMMAND = "./node_modules/brunch/bin/brunch build".freeze
+  PRODUCTION_BUILD_COMMAND = "./node_modules/brunch/bin/brunch build --production".freeze
 end
 
 require "breakfast/railtie" if defined?(Rails)

data/lib/breakfast/capistrano.rb

@@ -1,6 +1,6 @@
-require 'capistrano/version'
+require "capistrano/version"
 
-if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new('3.0.0')
+if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new("3.0.0")
   load File.expand_path("../capistrano/tasks/breakfast.rake", __FILE__)
 else
   raise "Requires Capistrano V3"

data/lib/breakfast/capistrano/tasks/breakfast.rake

@@ -3,13 +3,28 @@ namespace :breakfast do
   task :compile do
     on roles fetch(:breakfast_roles) do |host|
       within release_path do
-        execute fetch(:breakfast_npm_path).to_sym, "install"
-        execute "node_modules/brunch/bin/brunch", "build --production"
+        with rails_env: "#{fetch(:rails_env) || fetch(:stage)}" do
+          execute fetch(:breakfast_npm_path).to_sym, fetch(:breakfast_npm_install_command)
+          execute :rails, "breakfast:assets:build_production"
+          execute :rails, "breakfast:assets:digest"
+        end
+      end
+    end
+  end
+
+  desc "Clean out old assets"
+  task :clean do
+    on roles fetch(:breakfast_roles) do |host|
+      within release_path do
+        with rails_env: "#{fetch(:rails_env) || fetch(:stage)}" do
+          execute :rails, "breakfast:assets:clean"
+        end
       end
     end
   end
 
  after "deploy:updated", "breakfast:compile"
+ after "deploy:published", "breakfast:clean"
 end
 
 
@@ -17,5 +32,6 @@ namespace :load do
   task :defaults do
     set :breakfast_roles, -> { :web }
     set :breakfast_npm_path, "/usr/bin/npm"
+    set :breakfast_npm_install_command, "install"
   end
 end

data/lib/breakfast/compilation_listener.rb

@@ -3,9 +3,9 @@ module Breakfast
     ASSET_EXTENSIONS = ["css", "js"].freeze
     SOURCE_CODE_EXTENSIONS = ["rb", "html", "haml", "slim"].freeze
 
-    def self.start(asset_output_folders:, source_code_folders:)
-      asset_listener = 
-        ::Listen.to(*asset_output_folders) do |modified, added, removed|
+    def self.start(asset_output_folder:, source_code_folders:)
+      asset_listener =
+        ::Listen.to(asset_output_folder) do |modified, added, removed|
           files = modified + added + removed
 
           ASSET_EXTENSIONS.each do |extension|
@@ -15,7 +15,7 @@ module Breakfast
           end
         end
 
-      rails_listener = 
+      rails_listener =
         ::Listen.to(*source_code_folders) do |modified, added, removed|
           files = modified + added + removed
 

data/lib/breakfast/manifest.rb

@@ -0,0 +1,115 @@
+require "json"
+require "digest"
+require "fileutils"
+
+module Breakfast
+  class Manifest
+    MANIFEST_REGEX = /^\.breakfast-manifest-[0-9a-f]{32}.json$/
+    SPROCKETS_MANIFEST_REGEX = /^\.sprockets-manifest-[0-9a-f]{32}.json$/
+    FINGERPRINT_REGEX = /-[0-9a-f]{32}./
+
+    attr_reader :base_dir, :manifest_path, :cache
+    def initialize(base_dir:)
+      FileUtils.mkdir_p(base_dir)
+
+      @base_dir = Pathname.new(base_dir)
+      @manifest_path = find_manifest_or_create
+      @cache = update_cache!
+    end
+
+    def asset(path)
+      cache[path]
+    end
+
+    # The #digest! method will run through all of the compiled assets and
+    # create a copy of each asset with a digest fingerprint. This fingerprint
+    # will change whenever the file contents change. This allows us to use HTTP
+    # headers to cache these assets as we will be able to reliably know when
+    # they change.
+    #
+    # These fingerprinted files are copies of the original. The originals are
+    # not removed and still available should the need arise to serve a
+    # non-fingerprinted asset.
+    #
+    # Example manifest:
+    # {
+    #   app.js => app-76c6ee161ba431e823301567b175acda.js,
+    #   images/logo.png => images/logo-869269cdf1773ff0dec91bafb37310ea.png,
+    # }
+    #
+    # Resulting File Structure:
+    # - /
+    #   - app.js
+    #   - app-76c6ee161ba431e823301567b175acda.js
+    #   - images/
+    #     - logo.png
+    #     - logo-869269cdf1773ff0dec91bafb37310ea.png
+    def digest!
+      assets = asset_paths.map do |path|
+        digest = Digest::MD5.new
+        digest.update(File.read("#{base_dir}/#{path}"))
+
+        digest_path = "#{path.sub_ext('')}-#{digest.hexdigest}#{File.extname(path)}"
+
+        FileUtils.cp("#{base_dir}/#{path}", "#{base_dir}/#{digest_path}")
+
+        [path, digest_path]
+      end
+
+      File.open(manifest_path, "w") do |manifest|
+        manifest.write(assets.to_h.to_json)
+      end
+
+      update_cache!
+    end
+
+    # Remove any files not directly referenced by the manifest.
+    def clean!
+      files_to_keep = cache.keys.concat(cache.values)
+
+      if (sprockets_manifest = Dir.entries("#{base_dir}").detect { |entry| entry =~ SPROCKETS_MANIFEST_REGEX })
+        files_to_keep.concat(JSON.parse(File.read("#{base_dir}/#{sprockets_manifest}"))["files"].keys)
+      end
+
+      Dir["#{base_dir}/**/*"].each do |path|
+        next if File.directory?(path) || files_to_keep.include?(Pathname(path).relative_path_from(base_dir).to_s)
+
+        FileUtils.rm(path)
+      end
+    end
+
+    # Remove manifest, any fingerprinted files.
+    def nuke!
+      Dir["#{base_dir}/**/*"]
+        .select { |path| path =~ FINGERPRINT_REGEX }
+        .each { |file| FileUtils.rm(file) }
+
+      FileUtils.rm(manifest_path)
+    end
+
+    private
+
+    def update_cache!
+      @cache = JSON.parse(File.read(manifest_path))
+    end
+
+    # Creates a or finds a manifest file in a given directory. The manifest
+    # file is is prefixed with a dot ('.') and given a random string to ensure
+    # the file is not served or easily discoverable.
+    def find_manifest_or_create
+      if (manifest = Dir.entries("#{base_dir}").detect { |entry| entry =~ MANIFEST_REGEX })
+        "#{base_dir}/#{manifest}"
+      else
+        manifest = "#{base_dir}/.breakfast-manifest-#{SecureRandom.hex(16)}.json"
+        File.open(manifest, "w") { |manifest| manifest.write({}.to_json) }
+        manifest
+      end
+    end
+
+    def asset_paths
+      Dir["#{base_dir}/**/*"]
+        .reject { |path| File.directory?(path) || path =~ FINGERPRINT_REGEX }
+        .map { |file| Pathname(file).relative_path_from(base_dir) }
+    end
+  end
+end

data/lib/breakfast/railtie.rb

@@ -11,10 +11,11 @@ module Breakfast
       config.breakfast.css_reload_strategy = :hot
       config.breakfast.ruby_reload_strategy = :off
 
-      config.breakfast.asset_output_folders = [Rails.root.join("public")]
+      config.breakfast.asset_output_folder = Rails.root.join("public", "assets")
       config.breakfast.source_code_folders = [Rails.root.join("app")]
       config.breakfast.environments = %w(development)
       config.breakfast.status_bar_location = :bottom
+      config.breakfast.digest = !(Rails.env.development? || Rails.env.test?)
     end
 
     initializer "breakfast.setup_view_helpers" do |app|
@@ -23,14 +24,22 @@ module Breakfast
       end
     end
 
+    rake_tasks do
+      load "tasks/breakfast.rake"
+    end
+
     config.after_initialize do |app|
+      if config.breakfast.digest
+        config.breakfast.manifest = Breakfast::Manifest.new(base_dir: config.breakfast.asset_output_folder)
+      end
+
       if config.breakfast.environments.include?(Rails.env) && LocalEnvironment.new.running_server?
         Thread.new do
           Breakfast::BrunchWatcher.spawn(log: Rails.logger)
         end
 
         Breakfast::CompilationListener.start(
-          asset_output_folders: config.breakfast.asset_output_folders,
+          asset_output_folder: config.breakfast.asset_output_folder,
           source_code_folders: config.breakfast.source_code_folders
         )
       end

data/lib/breakfast/version.rb

@@ -1,3 +1,3 @@
 module Breakfast
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/breakfast/view_helper.rb

@@ -19,5 +19,16 @@ module Breakfast
         end
       end
     end
+
+    include ActionView::Helpers::AssetUrlHelper
+    include ActionView::Helpers::AssetTagHelper
+
+    def compute_asset_path(path, options = {})
+      if Rails.configuration.breakfast.digest && Rails.configuration.breakfast.manifest.asset(path)
+        path = Rails.configuration.breakfast.manifest.asset(path)
+      end
+
+      super(path, options)
+    end
   end
 end

data/lib/generators/breakfast/install_generator.rb

@@ -3,9 +3,9 @@ require "rails/generators"
 module Breakfast
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
-      NODE_VERSION = 'v4.1.1'
-      NPM_VERSION  = '3.10.6'
+      source_root File.expand_path("../templates", __FILE__)
+      NODE_VERSION = "v4.1.1"
+      NPM_VERSION  = "3.10.6"
 
       def install
         if node_prerequisites_installed?

data/lib/tasks/breakfast.rake

@@ -0,0 +1,61 @@
+require "rake"
+require "breakfast"
+
+namespace :breakfast do
+  namespace :assets do
+    desc "Build assets"
+    task :build => :environment do
+      exec(Breakfast::BUILD_COMMAND)
+    end
+
+    desc "Build assets for production"
+    task :build_production => :environment do
+      exec(Breakfast::PRODUCTION_BUILD_COMMAND)
+    end
+
+    desc "Add a digest to non-fingerprinted assets"
+    task :digest => :environment do
+      if Rails.configuration.breakfast.manifest
+        Rails.configuration.breakfast.manifest.digest!
+      else
+        raise Breakfast::ManifestDisabledError
+      end
+    end
+
+    desc "Remove out of date assets"
+    task :clean => :environment do
+      if Rails.configuration.breakfast.manifest
+        Rails.configuration.breakfast.manifest.clean!
+      else
+        raise Breakfast::ManifestDisabledError
+      end
+    end
+
+    desc "Remove manifest and fingerprinted assets"
+    task :nuke => :environment do
+      if Rails.configuration.breakfast.manifest
+        Rails.configuration.breakfast.manifest.nuke!
+      else
+        raise Breakfast::ManifestDisabledError
+      end
+    end
+  end
+end
+
+module Breakfast
+  class ManifestDisabledError < StandardError
+    def initialize
+      super(
+        <<~ERROR
+          Rails.configuration.breakfast.manifest is set to false. 
+          Enable it by adding the following in your environment file:
+
+            config.breakfast.manifest.digest = true
+
+          *Note* by default digest is set to false in development and test enviornments.
+
+        ERROR
+      )
+    end
+  end
+end

data/node_package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "breakfast-rails",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Assets for the Breakfast Gem",
   "main": "./lib/breakfast-rails.js",
   "scripts": {

data/node_package/src/status-bar.js

@@ -211,7 +211,7 @@ class StatusBar {
           display: flex;
           flex-grow: 1;
           height: 30px;
-          padding: 8px;
+          padding: 0 8px;
         }
 
         .breakfast-status-bar .breakfast-message-log-error {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breakfast
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Patrick Koperwas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ files:
 - lib/breakfast/capistrano/tasks/breakfast.rake
 - lib/breakfast/compilation_listener.rb
 - lib/breakfast/live_reload_channel.rb
+- lib/breakfast/manifest.rb
 - lib/breakfast/railtie.rb
 - lib/breakfast/status_channel.rb
 - lib/breakfast/version.rb
@@ -128,6 +129,7 @@ files:
 - lib/generators/breakfast/templates/app.scss
 - lib/generators/breakfast/templates/brunch-config.js
 - lib/generators/breakfast/templates/package.json
+- lib/tasks/breakfast.rake
 - node_package/.eslintrc.json
 - node_package/.npmignore
 - node_package/package.json