Merge pull request #2772 from guilleiguaran/backports-assets-pipeline

Backports of the assets pipeline changes done in 3-1-stable

10 files changed, 160 insertions, 36 deletions

diff --git a/actionpack/lib/sprockets/assets.rake b/actionpack/lib/sprockets/assets.rake
index 5698f22080..6f38ece0c3 100644
--- a/actionpack/lib/sprockets/assets.rake
+++ b/actionpack/lib/sprockets/assets.rake
@@ -19,7 +19,9 @@ namespace :assets do
 
       config = Rails.application.config
       env    = Rails.application.assets
-      target = Rails.root.join("public#{config.assets.prefix}")
+      target = Pathname.new(File.join(Rails.public_path, config.assets.prefix))
+      manifest = {}
+      manifest_path = config.assets.manifest || target
 
       if env.respond_to?(:each_logical_path)
         config.assets.precompile.each do |path|
@@ -31,6 +33,7 @@ namespace :assets do
             end
 
             if asset = env.find_asset(logical_path)
+              manifest[logical_path] = asset.digest_path
               filename = target.join(asset.digest_path)
               mkdir_p filename.dirname
               asset.write_to(filename)
@@ -44,6 +47,10 @@ namespace :assets do
         assets << {:to => target}
         env.precompile(*assets)
       end
+
+      File.open("#{manifest_path}/manifest.yml", 'w') do |f|
+        YAML.dump(manifest, f)
+      end
     end
   end
 
diff --git a/actionpack/lib/sprockets/helpers/rails_helper.rb b/actionpack/lib/sprockets/helpers/rails_helper.rb
index 062aa4dae5..975dc9e80c 100644
--- a/actionpack/lib/sprockets/helpers/rails_helper.rb
+++ b/actionpack/lib/sprockets/helpers/rails_helper.rb
@@ -14,6 +14,7 @@ module Sprockets
           paths = RailsHelper::AssetPaths.new(config, controller)
           paths.asset_environment = asset_environment
           paths.asset_prefix      = asset_prefix
+          paths.asset_digests     = asset_digests
           paths
         end
       end
@@ -60,7 +61,7 @@ module Sprockets
       def debug_assets?
         begin
           config = Rails.application.config.assets
-          config.allow_debugging && (config.debug || params[:debug_assets])
+          config.compile && (config.debug || params[:debug_assets])
         rescue NoMethodError
           false
         end
@@ -76,6 +77,10 @@ module Sprockets
         Rails.application.config.assets.prefix
       end
 
+      def asset_digests
+        Rails.application.config.assets.digests
+      end
+
       # Override to specify an alternative asset environment for asset
       # path generation. The environment should already have been mounted
       # at the prefix returned by +asset_prefix+.
@@ -84,7 +89,9 @@ module Sprockets
       end
 
       class AssetPaths < ::ActionView::AssetPaths #:nodoc:
-        attr_accessor :asset_environment, :asset_prefix
+        attr_accessor :asset_environment, :asset_prefix, :asset_digests
+
+        class AssetNotPrecompiledError < StandardError; end
 
         def compute_public_path(source, dir, ext=nil, include_host=true, protocol=nil)
           super(source, asset_prefix, ext, include_host, protocol)
@@ -103,18 +110,25 @@ module Sprockets
         end
 
         def digest_for(logical_path)
-          if asset = asset_environment[logical_path]
-            return asset.digest_path
+          if asset_digests && (digest = asset_digests[logical_path])
+            return digest
           end
 
-          logical_path
+          if Rails.application.config.assets.compile
+            if asset = asset_environment[logical_path]
+              return asset.digest_path
+            end
+            return logical_path
+          else
+            raise AssetNotPrecompiledError.new("#{logical_path} isn't precompiled")
+          end
         end
 
         def rewrite_asset_path(source, dir)
           if source[0] == ?/
             source
           else
-            source = digest_for(source) if performing_caching?
+            source = digest_for(source) if Rails.application.config.assets.digest
             source = File.join(dir, source)
             source = "/#{source}" unless source =~ /^\//
             source
@@ -128,16 +142,6 @@ module Sprockets
             source
           end
         end
-
-        def performing_caching?
-          # When included in Sprockets::Context, we need to ask the
-          # top-level config as the controller is not available.
-          if config.action_controller.present?
-            config.action_controller.perform_caching
-          else
-            config.perform_caching
-          end
-        end
       end
     end
   end
diff --git a/actionpack/lib/sprockets/railtie.rb b/actionpack/lib/sprockets/railtie.rb
index c21bf57935..7927b7bc2c 100644
--- a/actionpack/lib/sprockets/railtie.rb
+++ b/actionpack/lib/sprockets/railtie.rb
@@ -26,6 +26,16 @@ module Sprockets
         end
       end
 
+      if config.assets.manifest
+        path = File.join(config.assets.manifest, "manifest.yml")
+      else
+        path = File.join(Rails.public_path, config.assets.prefix, "manifest.yml")
+      end
+
+      if File.exist?(path)
+        config.assets.digests = YAML.load_file(path)
+      end
+
       ActiveSupport.on_load(:action_view) do
         include ::Sprockets::Helpers::RailsHelper
 
diff --git a/actionpack/test/template/sprockets_helper_test.rb b/actionpack/test/template/sprockets_helper_test.rb
index 6c1f97a44a..ae4cb1f0aa 100644
--- a/actionpack/test/template/sprockets_helper_test.rb
+++ b/actionpack/test/template/sprockets_helper_test.rb
@@ -30,6 +30,8 @@ class SprocketsHelperTest < ActionView::TestCase
     @config = config
     @config.action_controller ||= ActiveSupport::InheritableOptions.new
     @config.perform_caching = true
+    @config.assets.digest = true
+    @config.assets.compile = true
   end
 
   def url_for(*args)
@@ -157,7 +159,7 @@ class SprocketsHelperTest < ActionView::TestCase
     assert_match %r{<script src="/assets/xmlhr-[0-9a-f]+.js\?body=1" type="text/javascript"></script>\n<script src="/assets/application-[0-9a-f]+.js\?body=1" type="text/javascript"></script>},
       javascript_include_tag(:application, :debug => true)
 
-    @config.assets.allow_debugging = true
+    @config.assets.compile = true
     @config.assets.debug = true
     assert_match %r{<script src="/assets/xmlhr-[0-9a-f]+.js\?body=1" type="text/javascript"></script>\n<script src="/assets/application-[0-9a-f]+.js\?body=1" type="text/javascript"></script>},
       javascript_include_tag(:application)
@@ -198,7 +200,7 @@ class SprocketsHelperTest < ActionView::TestCase
     assert_match %r{<link href="/assets/style-[0-9a-f]+.css\?body=1" media="screen" rel="stylesheet" type="text/css" />\n<link href="/assets/application-[0-9a-f]+.css\?body=1" media="screen" rel="stylesheet" type="text/css" />},
       stylesheet_link_tag(:application, :debug => true)
 
-    @config.assets.allow_debugging = true
+    @config.assets.compile = true
     @config.assets.debug = true
     assert_match %r{<link href="/assets/style-[0-9a-f]+.css\?body=1" media="screen" rel="stylesheet" type="text/css" />\n<link href="/assets/application-[0-9a-f]+.css\?body=1" media="screen" rel="stylesheet" type="text/css" />},
       stylesheet_link_tag(:application)
diff --git a/railties/lib/rails/application/configuration.rb b/railties/lib/rails/application/configuration.rb
index 5d7bd3282d..fa7e3b820b 100644
--- a/railties/lib/rails/application/configuration.rb
+++ b/railties/lib/rails/application/configuration.rb
@@ -41,11 +41,12 @@ module Rails
         @assets.prefix          = "/assets"
         @assets.version         = ''
         @assets.debug           = false
-        @assets.allow_debugging = false
-
-        @assets.cache_store    = [ :file_store, "#{root}/tmp/cache/assets/" ]
-        @assets.js_compressor  = nil
-        @assets.css_compressor = nil
+        @assets.compile         = true
+        @assets.digest          = false
+        @assets.manifest        = "#{root}/public#{@assets.prefix}"
+        @assets.cache_store     = [ :file_store, "#{root}/tmp/cache/assets/" ]
+        @assets.js_compressor   = nil
+        @assets.css_compressor  = nil
       end
 
       def compiled_asset_path
diff --git a/railties/lib/rails/generators/rails/app/templates/config/application.rb b/railties/lib/rails/generators/rails/app/templates/config/application.rb
index 3891829150..13fbe9e526 100644
--- a/railties/lib/rails/generators/rails/app/templates/config/application.rb
+++ b/railties/lib/rails/generators/rails/app/templates/config/application.rb
@@ -52,6 +52,9 @@ module <%= app_const_base %>
 <% unless options.skip_sprockets? -%>
     # Enable the asset pipeline
     config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
 <% end -%>
   end
 end
diff --git a/railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt b/railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt
index 33f9939ffe..47078e3af9 100644
--- a/railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt
+++ b/railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt
@@ -30,9 +30,6 @@
   # Do not compress assets
   config.assets.compress = false
 
-  # Allow pass debug_assets=true as a query parameter to load pages with unpackaged assets
-  config.assets.allow_debugging = true
-
   # Expands the lines which load the assets
   config.assets.debug = true
 end
diff --git a/railties/lib/rails/generators/rails/app/templates/config/environments/production.rb.tt b/railties/lib/rails/generators/rails/app/templates/config/environments/production.rb.tt
index de56d47688..64e2c09467 100644
--- a/railties/lib/rails/generators/rails/app/templates/config/environments/production.rb.tt
+++ b/railties/lib/rails/generators/rails/app/templates/config/environments/production.rb.tt
@@ -14,6 +14,15 @@
   # Compress JavaScripts and CSS
   config.assets.compress = true
 
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to Rails.root.join("public/assets")
+  # config.assets.manifest = YOUR_PATH
+
   # Specifies the header that your server uses for sending files
   # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
diff --git a/railties/test/application/asset_debugging_test.rb b/railties/test/application/asset_debugging_test.rb
index 38e1e21d17..707abe7191 100644
--- a/railties/test/application/asset_debugging_test.rb
+++ b/railties/test/application/asset_debugging_test.rb
@@ -33,24 +33,33 @@ module ApplicationTests
       teardown_app
     end
 
-    test "assets are concatenated when debug is off and allow_debugging is off either if debug_assets param is provided" do
-      # config.assets.debug and config.assets.allow_debugging are false for production environment
+    test "assets are concatenated when debug is off and compile is off either if debug_assets param is provided" do
+      # config.assets.debug and config.assets.compile are false for production environment
+      ENV["RAILS_ENV"] = "production"
+      capture(:stdout) do
+        Dir.chdir(app_path){ `bundle exec rake assets:precompile` }
+      end
       require "#{app_path}/config/environment"
 
-      # the debug_assets params isn't used if allow_debugging is off
+      class ::PostsController < ActionController::Base ; end
+
+      # the debug_assets params isn't used if compile is off
       get '/posts?debug_assets=true'
-      assert_match %r{<script src="/assets/application-([0-z]+)\.js" type="text/javascript"></script>}, last_response.body
-      assert_no_match %r{<script src="/assets/xmlhr-([0-z]+)\.js" type="text/javascript"></script>}, last_response.body
+      assert_match /<script src="\/assets\/application-([0-z]+)\.js" type="text\/javascript"><\/script>/, last_response.body
+      assert_no_match /<script src="\/assets\/xmlhr-([0-z]+)\.js" type="text\/javascript"><\/script>/, last_response.body
     end
 
-    test "assets aren't concatened when allow_debugging is on and debug_assets params is true" do
-      app_file "config/initializers/allow_debugging.rb", "Rails.application.config.assets.allow_debugging = true"
+    test "assets aren't concatened when compile is true is on and debug_assets params is true" do
+      app_file "config/initializers/compile.rb", "Rails.application.config.assets.compile = true"
 
+      ENV["RAILS_ENV"] = "production"
       require "#{app_path}/config/environment"
 
+      class ::PostsController < ActionController::Base ; end
+
       get '/posts?debug_assets=true'
-      assert_match %r{<script src="/assets/application-([0-z]+)\.js\?body=1" type="text/javascript"></script>}, last_response.body
-      assert_match %r{<script src="/assets/xmlhr-([0-z]+)\.js\?body=1" type="text/javascript"></script>}, last_response.body
+      assert_match /<script src="\/assets\/application-([0-z]+)\.js\?body=1" type="text\/javascript"><\/script>/, last_response.body
+      assert_match /<script src="\/assets\/xmlhr-([0-z]+)\.js\?body=1" type="text\/javascript"><\/script>/, last_response.body
     end
   end
 end
diff --git a/railties/test/application/assets_test.rb b/railties/test/application/assets_test.rb
index a8d1382e94..ccadf0b2c0 100644
--- a/railties/test/application/assets_test.rb
+++ b/railties/test/application/assets_test.rb
@@ -37,6 +37,8 @@ module ApplicationTests
 
     test "assets do not require compressors until it is used" do
       app_file "app/assets/javascripts/demo.js.erb", "<%= :alert %>();"
+      app_file "config/initializers/compile.rb", "Rails.application.config.assets.compile = true"
+
       ENV["RAILS_ENV"] = "production"
       require "#{app_path}/config/environment"
 
@@ -62,8 +64,87 @@ module ApplicationTests
       end
     end
 
+    test "precompile creates a manifest file with all the assets listed" do
+      app_file "app/assets/stylesheets/application.css.erb", "<%= asset_path('rails.png') %>"
+      app_file "app/assets/javascripts/application.js", "alert();"
+
+      capture(:stdout) do
+        Dir.chdir(app_path){ `bundle exec rake assets:precompile` }
+      end
+
+      manifest = "#{app_path}/public/assets/manifest.yml"
+
+      assets = YAML.load_file(manifest)
+      assert_match /application-([0-z]+)\.js/, assets["application.js"]
+      assert_match /application-([0-z]+)\.css/, assets["application.css"]
+    end
+
+    test "precompile creates a manifest file in a custom path with all the assets listed" do
+      app_file "app/assets/stylesheets/application.css.erb", "<%= asset_path('rails.png') %>"
+      app_file "app/assets/javascripts/application.js", "alert();"
+      FileUtils.mkdir "#{app_path}/shared"
+      app_file "config/initializers/manifest.rb", "Rails.application.config.assets.manifest = '#{app_path}/shared'"
+
+      capture(:stdout) do
+        Dir.chdir(app_path){ `bundle exec rake assets:precompile` }
+      end
+
+      manifest = "#{app_path}/shared/manifest.yml"
+
+      assets = YAML.load_file(manifest)
+      assert_match /application-([0-z]+)\.js/, assets["application.js"]
+      assert_match /application-([0-z]+)\.css/, assets["application.css"]
+    end
+
+    test "assets do not require any assets group gem when manifest file is present" do
+      app_file "app/assets/javascripts/application.js", "alert();"
+
+      ENV["RAILS_ENV"] = "production"
+      capture(:stdout) do
+        Dir.chdir(app_path){ `bundle exec rake assets:precompile` }
+      end
+      manifest = "#{app_path}/public/assets/manifest.yml"
+      assets = YAML.load_file(manifest)
+      asset_path = assets["application.js"]
+
+      require "#{app_path}/config/environment"
+
+      # Checking if Uglifier is defined we can know if Sprockets was reached or not
+      assert !defined?(Uglifier)
+      get "/assets/#{asset_path}"
+      assert_match "alert()", last_response.body
+      assert !defined?(Uglifier)
+    end
+
+    test "assets raise AssetNotPrecompiledError when manifest file is present and requested file isn't precompiled" do
+      app_file "app/views/posts/index.html.erb", "<%= javascript_include_tag 'app' %>"
+
+      app_file "config/routes.rb", <<-RUBY
+        AppTemplate::Application.routes.draw do
+          match '/posts', :to => "posts#index"
+        end
+      RUBY
+
+      ENV["RAILS_ENV"] = "production"
+      capture(:stdout) do
+        Dir.chdir(app_path){ `bundle exec rake assets:precompile` }
+      end
+
+      # Create file after of precompile
+      app_file "app/assets/javascripts/app.js", "alert();"
+
+      require "#{app_path}/config/environment"
+      class ::PostsController < ActionController::Base ; end
+
+      get '/posts'
+      assert_match /AssetNotPrecompiledError/, last_response.body
+      assert_match /app.js isn't precompiled/, last_response.body
+    end
+
     test "precompile appends the md5 hash to files referenced with asset_path and run in the provided RAILS_ENV" do
       app_file "app/assets/stylesheets/application.css.erb", "<%= asset_path('rails.png') %>"
+      # digest is default in false, we must enable it for test environment
+      app_file "config/initializers/compile.rb", "Rails.application.config.assets.digest = true"
 
       # capture(:stdout) do
         Dir.chdir(app_path){ `bundle exec rake assets:precompile RAILS_ENV=test` }
@@ -74,6 +155,7 @@ module ApplicationTests
 
     test "precompile appends the md5 hash to files referenced with asset_path and run in production as default even using RAILS_GROUPS=assets" do
       app_file "app/assets/stylesheets/application.css.erb", "<%= asset_path('rails.png') %>"
+      app_file "config/initializers/compile.rb", "Rails.application.config.assets.compile = true"
 
       ENV["RAILS_ENV"] = nil
       capture(:stdout) do