turbo-sprockets-rails3 0.1.0 → 0.1.1

data/README.md

@@ -6,31 +6,55 @@
 This is a backport of the work I've done for Rails 4.0.0, released as
 a gem for Rails 3.2.x. (See [sprockets-rails #21](https://github.com/rails/sprockets-rails/pull/21) and [sprockets #367](https://github.com/sstephenson/sprockets/pull/367) for the Rails 4 pull requests.)
 
+
 ### Disclaimer
 
 Please test this out thoroughly on your local machine before deploying to a production site, and open an issue on GitHub if you have any problems. By using this software you agree to the terms and conditions in the [MIT license](https://github.com/ndbroadbent/turbo-sprockets-rails3/blob/master/MIT-LICENSE).
 
-### Dependencies
+## Dependencies
 
 * sprockets `~> 2.1.3`
 * railties `~> 3.2.0`
 
-### Usage
+## Usage
 
-Just drop the gem in your `Gemfile`, in the `:assets` group:
+Just drop the gem in your `Gemfile`:
 
 ```ruby
-group :assets do
-  ...
-
-  gem 'turbo-sprockets-rails3'
-end
+gem 'turbo-sprockets-rails3'
 ```
 
 Run `bundle`, and you're done!
 
+
 Test it out by running `rake assets:precompile`. When it's finished, your `public/assets/manifest.yml` file should include a `:source_digests` hash for your assets.
 
 Go on, run `rake assets:precompile` again, and it should be a whole lot faster than before.
 
 Enjoy your lightning fast deploys!
+
+#### Automatic clean up of old assets
+
+By default, the `assets:precompile` task now deletes out-of-date assets after a new version is compiled. If you don't want to automatically delete old assets, you can turn off this behaviour by setting `config.assets.clean_after_precompile = false` in `config/environments/production.rb`.
+
+## Deployments
+
+### Heroku
+
+You won't be able to do an 'incremental update' on heroku, since your `public/assets`
+folder will be empty at the start of each push. However, this gem can still cut your
+precompile time in half, since it only compiles assets once to generate both digest and non-digest assets.
+
+### Capistrano
+
+If you are deploying with Capistrano, it's not a good idea to symlink `public/assets` to a shared assets folder, because the asset cleanup task would delete the current assets before the deploy has finished. Keeping a separate copy of `public/assets` for each release also means that you can safely roll back to a previous release.
+The best approach would be to add a deploy step that copies the `public/assets` folder from your previous release into the current release, before running `assets:precompile`.
+
+## Debugging
+
+If you would like to view debugging information in your terminal during the `assets:precompile` task, add the following lines to the bottom of `config/environments/production.rb`:
+
+```ruby
+config.log_level = :debug
+config.logger = Logger.new(STDOUT)
+```

data/lib/turbo-sprockets/sprockets_overrides/asset.rb

@@ -1,29 +1,31 @@
 require 'sprockets/asset'
 
-Sprockets::Asset.class_eval do
-  # Internal initializer to load `Asset` from serialized `Hash`.
-  def self.from_hash(environment, hash)
-    return unless hash.is_a?(Hash)
+module Sprockets
+  Asset.class_eval do
+    # Internal initializer to load `Asset` from serialized `Hash`.
+    def self.from_hash(environment, hash)
+      return unless hash.is_a?(Hash)
 
-    klass = case hash['class']
-      when 'BundledAsset'
-        BundledAsset
-      when 'ProcessedAsset'
-        ProcessedAsset
-      when 'UnprocessedAsset'
-        UnprocessedAsset
-      when 'StaticAsset'
-        StaticAsset
-      else
-        nil
-      end
+      klass = case hash['class']
+        when 'BundledAsset'
+          BundledAsset
+        when 'ProcessedAsset'
+          ProcessedAsset
+        when 'UnprocessedAsset'
+          UnprocessedAsset
+        when 'StaticAsset'
+          StaticAsset
+        else
+          nil
+        end
 
-    if klass
-      asset = klass.allocate
-      asset.init_with(environment, hash)
-      asset
+      if klass
+        asset = klass.allocate
+        asset.init_with(environment, hash)
+        asset
+      end
+    rescue UnserializeError
+      nil
     end
-  rescue UnserializeError
-    nil
   end
 end

data/lib/turbo-sprockets/sprockets_overrides/bundled_asset.rb

@@ -1,31 +1,33 @@
 require 'sprockets/bundled_asset'
 
-Sprockets::BundledAsset.class_eval do
+module Sprockets
+  BundledAsset.class_eval do
 
-  # Adds :process options
+    # Adds :process options
 
-  def initialize(environment, logical_path, pathname, options = {})
-    super(environment, logical_path, pathname)
-    @process = options.fetch(:process, true)
+    def initialize(environment, logical_path, pathname, options = {})
+      super(environment, logical_path, pathname)
+      @process = options.fetch(:process, true)
 
-    @processed_asset  = environment.find_asset(pathname, :bundle => false, :process => @process)
-    @required_assets  = @processed_asset.required_assets
-    @dependency_paths = @processed_asset.dependency_paths
+      @processed_asset  = environment.find_asset(pathname, :bundle => false, :process => @process)
+      @required_assets  = @processed_asset.required_assets
+      @dependency_paths = @processed_asset.dependency_paths
 
-    @source = ""
+      @source = ""
 
-    # Explode Asset into parts and gather the dependency bodies
-    to_a.each { |dependency| @source << dependency.to_s }
+      # Explode Asset into parts and gather the dependency bodies
+      to_a.each { |dependency| @source << dependency.to_s }
 
-    if @process
-      # Run bundle processors on concatenated source
-      context = environment.context_class.new(environment, logical_path, pathname)
-      @source = context.evaluate(pathname, :data => @source,
-                  :processors => environment.bundle_processors(content_type))
-    end
+      if @process
+        # Run bundle processors on concatenated source
+        context = environment.context_class.new(environment, logical_path, pathname)
+        @source = context.evaluate(pathname, :data => @source,
+                    :processors => environment.bundle_processors(content_type))
+      end
 
-    @mtime  = to_a.map(&:mtime).max
-    @length = Rack::Utils.bytesize(source)
-    @digest = environment.digest.update(source).hexdigest
+      @mtime  = to_a.map(&:mtime).max
+      @length = Rack::Utils.bytesize(source)
+      @digest = environment.digest.update(source).hexdigest
+    end
   end
 end

data/lib/turbo-sprockets/sprockets_overrides/environment.rb

@@ -1,19 +1,21 @@
 require 'sprockets/environment'
 
-Sprockets::Environment.class_eval do
+module Sprockets
+  Environment.class_eval do
 
-  # Adds :process options
+    # Adds :process options
 
-  def find_asset(path, options = {})
-    options[:bundle] = true unless options.key?(:bundle)
-    options[:process] = true unless options.key?(:process)
+    def find_asset(path, options = {})
+      options[:bundle] = true unless options.key?(:bundle)
+      options[:process] = true unless options.key?(:process)
 
-    # Ensure in-memory cached assets are still fresh on every lookup
-    if (asset = @assets[cache_key_for(path, options)]) && asset.fresh?(self)
-      asset
-    elsif asset = index.find_asset(path, options)
-      # Cache is pushed upstream by Index#find_asset
-      asset
+      # Ensure in-memory cached assets are still fresh on every lookup
+      if (asset = @assets[cache_key_for(path, options)]) && asset.fresh?(self)
+        asset
+      elsif asset = index.find_asset(path, options)
+        # Cache is pushed upstream by Index#find_asset
+        asset
+      end
     end
   end
 end

data/lib/turbo-sprockets/sprockets_overrides/index.rb

@@ -1,28 +1,30 @@
 require 'sprockets/index'
 
-Sprockets::Index.class_eval do
+module Sprockets
+  Index.class_eval do
 
-  # Adds :process options
+    # Adds :process options
 
-  def find_asset(path, options = {})
-    options[:bundle]  = true unless options.key?(:bundle)
-    options[:process] = true unless options.key?(:process)
+    def find_asset(path, options = {})
+      options[:bundle]  = true unless options.key?(:bundle)
+      options[:process] = true unless options.key?(:process)
 
-    if asset = @assets[cache_key_for(path, options)]
-      asset
-    elsif asset = super
-      logical_path_cache_key = cache_key_for(path, options)
-      full_path_cache_key    = cache_key_for(asset.pathname, options)
+      if asset = @assets[cache_key_for(path, options)]
+        asset
+      elsif asset = super
+        logical_path_cache_key = cache_key_for(path, options)
+        full_path_cache_key    = cache_key_for(asset.pathname, options)
 
-      # Cache on Index
-      @assets[logical_path_cache_key] = @assets[full_path_cache_key] = asset
-
-      # Push cache upstream to Environment
-      @environment.instance_eval do
+        # Cache on Index
         @assets[logical_path_cache_key] = @assets[full_path_cache_key] = asset
-      end
 
-      asset
+        # Push cache upstream to Environment
+        @environment.instance_eval do
+          @assets[logical_path_cache_key] = @assets[full_path_cache_key] = asset
+        end
+
+        asset
+      end
     end
   end
 end

data/lib/turbo-sprockets/sprockets_overrides/static_compiler.rb

@@ -1,68 +1,70 @@
 require 'sprockets/static_compiler'
 
-Sprockets::StaticCompiler.class_eval do
-  def initialize(env, target, paths, options = {})
-    @env = env
-    @target = target
-    @paths = paths
-    @digest = options.fetch(:digest, true)
-    @manifest = options.fetch(:manifest, true)
-    @manifest_path = options.delete(:manifest_path) || target
-    @zip_files = options.delete(:zip_files) || /\.(?:css|html|js|svg|txt|xml)$/
+module Sprockets
+  StaticCompiler.class_eval do
+    def initialize(env, target, paths, options = {})
+      @env = env
+      @target = target
+      @paths = paths
+      @digest = options.fetch(:digest, true)
+      @manifest = options.fetch(:manifest, true)
+      @manifest_path = options.delete(:manifest_path) || target
+      @zip_files = options.delete(:zip_files) || /\.(?:css|html|js|svg|txt|xml)$/
 
-    @current_source_digests = options.fetch(:source_digests, {})
-    @current_digest_files   = options.fetch(:digest_files,   {})
+      @current_source_digests = options.fetch(:source_digests, {})
+      @current_digest_files   = options.fetch(:digest_files,   {})
 
-    @digest_files   = {}
-    @source_digests = {}
-  end
+      @digest_files   = {}
+      @source_digests = {}
+    end
 
-  def compile
-    start_time = Time.now.to_f
+    def compile
+      start_time = Time.now.to_f
 
-    env.each_logical_path do |logical_path|
-      if File.basename(logical_path)[/[^\.]+/, 0] == 'index'
-        logical_path.sub!(/\/index\./, '.')
-      end
-      next unless compile_path?(logical_path)
+      env.each_logical_path do |logical_path|
+        if File.basename(logical_path)[/[^\.]+/, 0] == 'index'
+          logical_path.sub!(/\/index\./, '.')
+        end
+        next unless compile_path?(logical_path)
 
-      # Fetch asset without any processing or compression,
-      # to calculate a digest of the concatenated source files
-      asset = env.find_asset(logical_path, :process => false)
+        # Fetch asset without any processing or compression,
+        # to calculate a digest of the concatenated source files
+        asset = env.find_asset(logical_path, :process => false)
 
-      # Force digest to UTF-8, otherwise YAML dumps ASCII-8BIT as !binary
-      @source_digests[logical_path] = asset.digest.force_encoding("UTF-8")
+        # Force digest to UTF-8, otherwise YAML dumps ASCII-8BIT as !binary
+        @source_digests[logical_path] = asset.digest.force_encoding("UTF-8")
 
-      # Recompile if digest has changed or compiled digest file is missing
-      current_digest_file = @current_digest_files[logical_path]
+        # Recompile if digest has changed or compiled digest file is missing
+        current_digest_file = @current_digest_files[logical_path]
 
-      if @source_digests[logical_path] != @current_source_digests[logical_path] ||
-         !(current_digest_file && File.exists?("#{@target}/#{current_digest_file}"))
+        if @source_digests[logical_path] != @current_source_digests[logical_path] ||
+           !(current_digest_file && File.exists?("#{@target}/#{current_digest_file}"))
 
-        if asset = env.find_asset(logical_path)
-          @digest_files[logical_path] = write_asset(asset)
-        end
+          if asset = env.find_asset(logical_path)
+            @digest_files[logical_path] = write_asset(asset)
+          end
 
-      else
-        # Set asset file from manifest.yml
-        digest_file = @current_digest_files[logical_path]
-        @digest_files[logical_path] = digest_file
+        else
+          # Set asset file from manifest.yml
+          digest_file = @current_digest_files[logical_path]
+          @digest_files[logical_path] = digest_file
 
-        env.logger.debug "Not compiling #{logical_path}, sources digest has not changed " <<
-                         "(#{@source_digests[logical_path][0...7]})"
+          env.logger.debug "Not compiling #{logical_path}, sources digest has not changed " <<
+                           "(#{@source_digests[logical_path][0...7]})"
+        end
       end
-    end
 
-    if @manifest
-      write_manifest(source_digests: @source_digests, digest_files: @digest_files)
-    end
+      if @manifest
+        write_manifest(source_digests: @source_digests, digest_files: @digest_files)
+      end
 
-    # Store digests in Rails config. (Important if non-digest is run after primary)
-    config = ::Rails.application.config
-    config.assets.digest_files   = @digest_files
-    config.assets.source_digests = @source_digests
+      # Store digests in Rails config. (Important if non-digest is run after primary)
+      config = ::Rails.application.config
+      config.assets.digest_files   = @digest_files
+      config.assets.source_digests = @source_digests
 
-    elapsed_time = ((Time.now.to_f - start_time) * 1000).to_i
-    env.logger.debug "Processed #{'non-' unless @digest}digest assets in #{elapsed_time}ms"
+      elapsed_time = ((Time.now.to_f - start_time) * 1000).to_i
+      env.logger.debug "Processed #{'non-' unless @digest}digest assets in #{elapsed_time}ms"
+    end
   end
-end
+end

data/lib/turbo-sprockets/version.rb

@@ -1,3 +1,3 @@
 module TurboSprockets
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo-sprockets-rails3
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors: