Merge pull request #259 from Andreis13/sprockets-4

Add support for Sprockets 4.x.

Author: rafaelfranca

.travis.yml

@@ -14,6 +14,7 @@ gemfile:
   - gemfiles/Gemfile.rails-4.1.x
   - gemfiles/Gemfile.rails-4.2.x
   - gemfiles/Gemfile.rails-5.0.x
+  - gemfiles/Gemfile.rails-5.0.x.sprockets-4.x
 
 matrix:
   exclude:
@@ -29,6 +30,12 @@ matrix:
       rvm: 2.0.0
     - gemfile: gemfiles/Gemfile.rails-5.0.x
       rvm: 2.1
+    - gemfile: gemfiles/Gemfile.rails-5.0.x.sprockets-4.x
+      rvm: 1.9.3
+    - gemfile: gemfiles/Gemfile.rails-5.0.x.sprockets-4.x
+      rvm: 2.0.0
+    - gemfile: gemfiles/Gemfile.rails-5.0.x.sprockets-4.x
+      rvm: 2.1
 
 notifications:
   email: false

gemfiles/Gemfile.rails-5.0.x.sprockets-4.x

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :path => ".."
+
+gem "actionpack", :github => "rails/rails", :branch => "master"
+gem "railties", :github => "rails/rails", :branch => "master"
+gem "sprockets", :github => "rails/sprockets", :branch => "4.x"

lib/sprockets/rails/context.rb

@@ -17,7 +17,7 @@ def compute_asset_path(path, options = {})
         @dependencies << 'actioncontroller-asset-url-config'
 
         begin
-          asset_uri = resolve(path, compat: false)
+          asset_uri = resolve(path)
         rescue FileNotFound
           # TODO: eh, we should be able to use a form of locate that returns
           # nil instead of raising an exception.
@@ -40,4 +40,9 @@ def compute_asset_path(path, options = {})
     [config.relative_url_root,
     (config.asset_host unless config.asset_host.respond_to?(:call))]
   end
+
+  # fallback to the default pipeline when using Sprockets 3.x
+  unless config[:pipelines].include? :debug
+    register_pipeline :debug, config[:pipelines][:default]
+  end
 end

lib/sprockets/rails/helper.rb

@@ -1,6 +1,7 @@
 require 'action_view'
 require 'sprockets'
 require 'active_support/core_ext/class/attribute'
+require 'sprockets/rails/utils'
 
 module Sprockets
   module Rails
@@ -17,6 +18,7 @@ def initialize(source)
 
       include ActionView::Helpers::AssetUrlHelper
       include ActionView::Helpers::AssetTagHelper
+      include Sprockets::Rails::Utils
 
       VIEW_ACCESSORS = [:assets_environment, :assets_manifest,
                         :assets_precompile,
@@ -57,7 +59,7 @@ def assets_environment
       def compute_asset_path(path, options = {})
         if digest_path = asset_digest_path(path, options)
           path = digest_path if digest_assets
-          path += "?body=1" if options[:debug]
+          path += "?body=1" if options[:debug] && !using_sprockets4?
           File.join(assets_prefix || "/", path)
         else
           super
@@ -80,7 +82,7 @@ def asset_digest_path(path, options = {})
         if environment = assets_environment
           if asset = environment[path]
             unless options[:debug]
-              if !precompiled_assets.include?(asset)
+              if !precompiled_assets.include?(asset.logical_path)
                 raise AssetNotPrecompiled.new(asset.logical_path)
               end
             end
@@ -135,9 +137,13 @@ def javascript_include_tag(*sources)
 
         if options["debug"] != false && request_debug_assets?
           sources.map { |source|
-            if asset = lookup_asset_for_path(source, :type => :javascript)
-              asset.to_a.map do |a|
-                super(path_to_javascript(a.logical_path, :debug => true), options)
+            if asset = lookup_debug_asset(source, :type => :javascript)
+              if asset.respond_to?(:to_a)
+                asset.to_a.map do |a|
+                  super(path_to_javascript(a.logical_path, :debug => true), options)
+                end
+              else
+                super(path_to_javascript(asset.logical_path, :debug => true), options)
               end
             else
               super(source, options)
@@ -169,9 +175,13 @@ def stylesheet_link_tag(*sources)
 
         if options["debug"] != false && request_debug_assets?
           sources.map { |source|
-            if asset = lookup_asset_for_path(source, :type => :stylesheet)
-              asset.to_a.map do |a|
-                super(path_to_stylesheet(a.logical_path, :debug => true), options)
+            if asset = lookup_debug_asset(source, :type => :stylesheet)
+              if asset.respond_to?(:to_a)
+                asset.to_a.map do |a|
+                  super(path_to_stylesheet(a.logical_path, :debug => true), options)
+                end
+              else
+                super(path_to_stylesheet(asset.logical_path, :debug => true), options)
               end
             else
               super(source, options)
@@ -201,50 +211,26 @@ def request_debug_assets?
 
         # Internal method to support multifile debugging. Will
         # eventually be removed w/ Sprockets 3.x.
-        def lookup_asset_for_path(path, options = {})
+        def lookup_debug_asset(path, options = {})
           return unless env = assets_environment
           path = path.to_s
           if extname = compute_asset_extname(path, options)
             path = "#{path}#{extname}"
           end
 
-          if asset = env[path]
-            if !precompiled_assets.include?(asset)
-              raise AssetNotPrecompiled.new(asset.logical_path)
+          if asset = env[path, pipeline: :debug]
+            original_path = asset.logical_path.gsub('.debug', '')
+            unless precompiled_assets.include?(original_path)
+              raise AssetNotPrecompiled.new(original_path)
             end
           end
 
           asset
         end
 
-        # Internal: Generate a Set of all precompiled assets.
+        # Internal: Generate a Set of all precompiled assets logical paths.
         def precompiled_assets
-          @precompiled_assets ||= begin
-            assets = Set.new
-
-            paths, filters = (assets_precompile || []).flatten.partition { |arg| Sprockets::Manifest.simple_logical_path?(arg) }
-            filters = filters.map { |arg| Sprockets::Manifest.compile_match_filter(arg) }
-
-            env = assets_environment.cached
-
-            paths.each do |path|
-              env.find_all_linked_assets(path) do |asset|
-                assets << asset
-              end
-            end
-
-            if filters.any?
-              env.logical_paths do |logical_path, filename|
-                if filters.any? { |f| f.call(logical_path, filename) }
-                  env.find_all_linked_assets(filename) do |asset|
-                    assets << asset
-                  end
-                end
-              end
-            end
-
-            assets
-          end
+          @precompiled_assets ||= assets_manifest.find(assets_precompile || []).map(&:logical_path)
         end
     end
   end

lib/sprockets/rails/utils.rb

@@ -0,0 +1,11 @@
+require 'sprockets'
+
+module Sprockets
+  module Rails
+    module Utils
+      def using_sprockets4?
+        Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new('4.0.0')
+      end
+    end
+  end
+end

lib/sprockets/rails/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Rails
-    VERSION = "3.0.0.beta1"
+    VERSION = "3.0.0"
   end
 end

lib/sprockets/railtie.rb

@@ -43,6 +43,8 @@ class Engine < Railtie
 
 module Sprockets
   class Railtie < ::Rails::Railtie
+    include Sprockets::Rails::Utils
+
     LOOSE_APP_ASSETS = lambda do |logical_path, filename|
         filename.start_with?(::Rails.root.join("app/assets").to_s) &&
         !%w(.js .css).include?(File.extname(logical_path))
@@ -59,7 +61,11 @@ def configure(&block)
     config.assets.paths       = []
     config.assets.prefix      = "/assets"
     config.assets.manifest    = nil
-    config.assets.precompile  = [LOOSE_APP_ASSETS, /(?:\/|\\|\A)application\.(css|js)$/]
+    if using_sprockets4?
+      config.assets.precompile  = %w( manifest.js )
+    else
+      config.assets.precompile  = [LOOSE_APP_ASSETS, /(?:\/|\\|\A)application\.(css|js)$/]
+    end
     config.assets.version     = ""
     config.assets.debug       = false
     config.assets.compile     = true

sprockets-rails.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   s.files = Dir["README.md", "lib/**/*.rb", "LICENSE"]
 
   s.required_ruby_version = '>= 1.9.3'
-  
-  s.add_dependency "sprockets", ">= 3.0.0", "< 4.0"
+
+  s.add_dependency "sprockets", ">= 3.0.0"
   s.add_dependency "actionpack", ">= 4.0"
   s.add_dependency "activesupport", ">= 4.0"
   s.add_development_dependency "railties", ">= 4.0"

test/fixtures/manifest.js

@@ -0,0 +1,9 @@
+// manifest.js
+//= link foo.css
+//= link foo.js
+//= link bar.css
+//= link bar.js
+//= link file1.css
+//= link file1.js
+//= link file2.css
+//= link file2.js

test/fixtures/not_precompiled.css

@@ -0,0 +1 @@
+.not-precompiled {}