sprockets 2.2.3 → 2.12.3

data/lib/sprockets/mime.rb

@@ -15,6 +15,11 @@ module Sprockets
       end
     end
 
+    # Returns a `Hash` of explicitly registered mime types.
+    def registered_mime_types
+      @mime_types.dup
+    end
+
     if {}.respond_to?(:key)
       def extension_for_mime_type(type)
         mime_types.key(type)
@@ -41,8 +46,4 @@ module Sprockets
       end
     end
   end
-
-  # Extend Sprockets module to provide global registry
-  extend Mime
-  @mime_types = {}
 end

data/lib/sprockets/{trail.rb → paths.rb}

@@ -1,16 +1,11 @@
-require 'sprockets/errors'
-require 'pathname'
-
 module Sprockets
-  # `Trail` is an internal mixin whose public methods are exposed on
-  # the `Environment` and `Index` classes.
-  module Trail
+  module Paths
     # Returns `Environment` root.
     #
     # All relative paths are expanded with root as its base. To be
     # useful set this to your applications root directory. (`Rails.root`)
     def root
-      trail.root.dup
+      @trail.root.dup
     end
 
     # Returns an `Array` of path `String`s.
@@ -21,14 +16,13 @@ module Sprockets
     # have no affect on the environment. See `append_path`,
     # `prepend_path`, and `clear_paths`.
     def paths
-      trail.paths.dup
+      @trail.paths.dup
     end
 
     # Prepend a `path` to the `paths` list.
     #
     # Paths at the end of the `Array` have the least priority.
     def prepend_path(path)
-      expire_index!
       @trail.prepend_path(path)
     end
 
@@ -36,7 +30,6 @@ module Sprockets
     #
     # Paths at the beginning of the `Array` have a higher priority.
     def append_path(path)
-      expire_index!
       @trail.append_path(path)
     end
 
@@ -46,7 +39,6 @@ module Sprockets
     # completely wipe the paths list and reappend them in the order
     # you want.
     def clear_paths
-      expire_index!
       @trail.paths.dup.each { |path| @trail.remove_path(path) }
     end
 
@@ -57,34 +49,10 @@ module Sprockets
     #     # => [".js", ".css", ".coffee", ".sass", ...]
     #
     def extensions
-      trail.extensions.dup
-    end
-
-    # Finds the expanded real path for a given logical path by
-    # searching the environment's paths.
-    #
-    #     resolve("application.js")
-    #     # => "/path/to/app/javascripts/application.js.coffee"
-    #
-    # A `FileNotFound` exception is raised if the file does not exist.
-    def resolve(logical_path, options = {})
-      # If a block is given, preform an iterable search
-      if block_given?
-        args = attributes_for(logical_path).search_paths + [options]
-        trail.find(*args) do |path|
-          yield Pathname.new(path)
-        end
-      else
-        resolve(logical_path, options) do |pathname|
-          return pathname
-        end
-        raise FileNotFound, "couldn't find file '#{logical_path}'"
-      end
+      @trail.extensions.dup
     end
 
     protected
-      def trail
-        @trail
-      end
+      attr_reader :trail
   end
 end

data/lib/sprockets/processed_asset.rb

@@ -19,7 +19,7 @@ module Sprockets
       @dependency_digest = compute_dependency_digest(environment)
 
       elapsed_time = ((Time.now.to_f - start_time) * 1000).to_i
-      environment.logger.info "Compiled #{logical_path}  (#{elapsed_time}ms)  (pid #{Process.pid})"
+      environment.logger.debug "Compiled #{logical_path}  (#{elapsed_time}ms)  (pid #{Process.pid})"
     end
 
     # Interal: Used to check equality

data/lib/sprockets/processing.rb

@@ -7,16 +7,6 @@ module Sprockets
   # `Processing` is an internal mixin whose public methods are exposed on
   # the `Environment` and `Index` classes.
   module Processing
-    include Engines, Mime
-
-    # Register a new mime type.
-    def register_mime_type(mime_type, ext)
-      # Overrides the global behavior to expire the index
-      expire_index!
-      @trail.append_extension(ext)
-      super
-    end
-
     # Returns an `Array` of format extension `String`s.
     #
     #     format_extensions
@@ -26,14 +16,6 @@ module Sprockets
       @trail.extensions - @engines.keys
     end
 
-    # Registers a new Engine `klass` for `ext`.
-    def register_engine(ext, klass)
-      # Overrides the global behavior to expire the index
-      expire_index!
-      add_engine_to_trail(ext, klass)
-      super
-    end
-
     # Deprecated alias for `preprocessors`.
     def processors(*args)
       preprocessors(*args)
@@ -83,13 +65,11 @@ module Sprockets
     #
     # A block can be passed for to create a shorthand processor.
     #
-    #     register_preprocessor :my_processor do |context, data|
+    #     register_preprocessor 'text/css', :my_processor do |context, data|
     #       data.gsub(...)
     #     end
     #
     def register_preprocessor(mime_type, klass, &block)
-      expire_index!
-
       if block_given?
         name  = klass.to_s
         klass = Class.new(Processor) do
@@ -107,13 +87,11 @@ module Sprockets
     #
     # A block can be passed for to create a shorthand processor.
     #
-    #     register_postprocessor :my_processor do |context, data|
+    #     register_postprocessor 'text/css', :my_processor do |context, data|
     #       data.gsub(...)
     #     end
     #
     def register_postprocessor(mime_type, klass, &block)
-      expire_index!
-
       if block_given?
         name  = klass.to_s
         klass = Class.new(Processor) do
@@ -135,8 +113,6 @@ module Sprockets
     #     unregister_preprocessor 'text/css', Sprockets::DirectiveProcessor
     #
     def unregister_preprocessor(mime_type, klass)
-      expire_index!
-
       if klass.is_a?(String) || klass.is_a?(Symbol)
         klass = @preprocessors[mime_type].detect { |cls|
           cls.respond_to?(:name) &&
@@ -152,8 +128,6 @@ module Sprockets
     #     unregister_postprocessor 'text/css', Sprockets::DirectiveProcessor
     #
     def unregister_postprocessor(mime_type, klass)
-      expire_index!
-
       if klass.is_a?(String) || klass.is_a?(Symbol)
         klass = @postprocessors[mime_type].detect { |cls|
           cls.respond_to?(:name) &&
@@ -187,13 +161,11 @@ module Sprockets
     #
     # A block can be passed for to create a shorthand processor.
     #
-    #     register_bundle_processor :my_processor do |context, data|
+    #     register_bundle_processor 'text/css', :my_processor do |context, data|
     #       data.gsub(...)
     #     end
     #
     def register_bundle_processor(mime_type, klass, &block)
-      expire_index!
-
       if block_given?
         name  = klass.to_s
         klass = Class.new(Processor) do
@@ -210,8 +182,6 @@ module Sprockets
     #     unregister_bundle_processor 'text/css', Sprockets::CharsetNormalizer
     #
     def unregister_bundle_processor(mime_type, klass)
-      expire_index!
-
       if klass.is_a?(String) || klass.is_a?(Symbol)
         klass = @bundle_processors[mime_type].detect { |cls|
           cls.respond_to?(:name) &&
@@ -222,50 +192,6 @@ module Sprockets
       @bundle_processors[mime_type].delete(klass)
     end
 
-    # Return CSS compressor or nil if none is set
-    def css_compressor
-      bundle_processors('text/css').detect { |klass|
-        klass.respond_to?(:name) &&
-          klass.name == 'Sprockets::Processor (css_compressor)'
-      }
-    end
-
-    # Assign a compressor to run on `text/css` assets.
-    #
-    # The compressor object must respond to `compress` or `compile`.
-    def css_compressor=(compressor)
-      expire_index!
-
-      unregister_bundle_processor 'text/css', :css_compressor
-      return unless compressor
-
-      register_bundle_processor 'text/css', :css_compressor do |context, data|
-        compressor.compress(data)
-      end
-    end
-
-    # Return JS compressor or nil if none is set
-    def js_compressor
-      bundle_processors('application/javascript').detect { |klass|
-        klass.respond_to?(:name) &&
-          klass.name == 'Sprockets::Processor (js_compressor)'
-      }
-    end
-
-    # Assign a compressor to run on `application/javascript` assets.
-    #
-    # The compressor object must respond to `compress` or `compile`.
-    def js_compressor=(compressor)
-      expire_index!
-
-      unregister_bundle_processor 'application/javascript', :js_compressor
-      return unless compressor
-
-      register_bundle_processor 'application/javascript', :js_compressor do |context, data|
-        compressor.compress(data)
-      end
-    end
-
     private
       def add_engine_to_trail(ext, klass)
         @trail.append_extension(ext.to_s)

data/lib/sprockets/processor.rb

@@ -3,7 +3,7 @@ require 'tilt'
 module Sprockets
   # `Processor` creates an anonymous processor class from a block.
   #
-  #     register_preprocessor :my_processor do |context, data|
+  #     register_preprocessor 'text/css', :my_processor do |context, data|
   #       # ...
   #     end
   #

data/lib/sprockets/sass_cache_store.rb

@@ -0,0 +1,29 @@
+require 'sass'
+
+module Sprockets
+  class SassCacheStore < ::Sass::CacheStores::Base
+    attr_reader :environment
+
+    def initialize(environment)
+      @environment = environment
+    end
+
+    def _store(key, version, sha, contents)
+      environment.cache_set("sass/#{key}", {:version => version, :sha => sha, :contents => contents})
+    end
+
+    def _retrieve(key, version, sha)
+      if obj = environment.cache_get("sass/#{key}")
+        return unless obj[:version] == version
+        return unless obj[:sha] == sha
+        obj[:contents]
+      else
+        nil
+      end
+    end
+
+    def path_to(key)
+      key
+    end
+  end
+end

data/lib/sprockets/sass_compressor.rb

@@ -0,0 +1,27 @@
+require 'tilt'
+
+module Sprockets
+  class SassCompressor < Tilt::Template
+    self.default_mime_type = 'text/css'
+
+    def self.engine_initialized?
+      defined?(::Sass::Engine)
+    end
+
+    def initialize_engine
+      require_template_library 'sass'
+    end
+
+    def prepare
+    end
+
+    def evaluate(context, locals, &block)
+      ::Sass::Engine.new(data, {
+        :syntax => :scss,
+        :cache => false,
+        :read_cache => false,
+        :style => :compressed
+      }).render
+    end
+  end
+end

data/lib/sprockets/sass_functions.rb

@@ -0,0 +1,70 @@
+require 'sass'
+
+module Sprockets
+  module SassFunctions
+    def asset_path(path)
+      ::Sass::Script::String.new(sprockets_context.asset_path(path.value), :string)
+    end
+
+    def asset_url(path)
+      ::Sass::Script::String.new("url(" + sprockets_context.asset_path(path.value) + ")")
+    end
+
+    def image_path(path)
+      ::Sass::Script::String.new(sprockets_context.image_path(path.value), :string)
+    end
+
+    def image_url(path)
+      ::Sass::Script::String.new("url(" + sprockets_context.image_path(path.value) + ")")
+    end
+
+    def video_path(path)
+      ::Sass::Script::String.new(sprockets_context.video_path(path.value), :string)
+    end
+
+    def video_url(path)
+      ::Sass::Script::String.new("url(" + sprockets_context.video_path(path.value) + ")")
+    end
+
+    def audio_path(path)
+      ::Sass::Script::String.new(sprockets_context.audio_path(path.value), :string)
+    end
+
+    def audio_url(path)
+      ::Sass::Script::String.new("url(" + sprockets_context.audio_path(path.value) + ")")
+    end
+
+    def font_path(path)
+      ::Sass::Script::String.new(sprockets_context.font_path(path.value), :string)
+    end
+
+    def font_url(path)
+      ::Sass::Script::String.new("url(" + sprockets_context.font_path(path.value) + ")")
+    end
+
+    def javascript_path(path)
+      ::Sass::Script::String.new(sprockets_context.javascript_path(path.value), :string)
+    end
+
+    def javascript_url(path)
+      ::Sass::Script::String.new("url(" + sprockets_context.javascript_path(path.value) + ")")
+    end
+
+    def stylesheet_path(path)
+      ::Sass::Script::String.new(sprockets_context.stylesheet_path(path.value), :string)
+    end
+
+    def stylesheet_url(path)
+      ::Sass::Script::String.new("url(" + sprockets_context.stylesheet_path(path.value) + ")")
+    end
+
+    protected
+      def sprockets_context
+        options[:sprockets][:context]
+      end
+
+      def sprockets_environment
+        options[:sprockets][:environment]
+      end
+  end
+end

data/lib/sprockets/sass_importer.rb

@@ -0,0 +1,30 @@
+require 'sass'
+
+module Sprockets
+  # This custom importer that tracks all imported filenames during
+  # compile.
+  class SassImporter < ::Sass::Importers::Filesystem
+    attr_reader :imported_filenames
+
+    def initialize(*args)
+      @imported_filenames = []
+      super
+    end
+
+    def find_relative(*args)
+      engine = super
+      if engine && (filename = engine.options[:filename])
+        @imported_filenames << filename
+      end
+      engine
+    end
+
+    def find(*args)
+      engine = super
+      if engine && (filename = engine.options[:filename])
+        @imported_filenames << filename
+      end
+      engine
+    end
+  end
+end

data/lib/sprockets/sass_template.rb

@@ -0,0 +1,66 @@
+require 'tilt'
+
+module Sprockets
+  # This custom Tilt handler replaces the one built into Tilt. The
+  # main difference is that it uses a custom importer that plays nice
+  # with sprocket's caching system.
+  #
+  # See `SassImporter` for more infomation.
+  class SassTemplate < Tilt::Template
+    self.default_mime_type = 'text/css'
+
+    def self.engine_initialized?
+      defined?(::Sass::Engine) && defined?(::Sass::Script::Functions) &&
+        ::Sass::Script::Functions < Sprockets::SassFunctions
+    end
+
+    def initialize_engine
+      # Double check constant to avoid tilt warning
+      unless defined? ::Sass
+        require_template_library 'sass'
+      end
+
+      # Install custom functions. It'd be great if this didn't need to
+      # be installed globally, but could be passed into Engine as an
+      # option.
+      ::Sass::Script::Functions.send :include, Sprockets::SassFunctions
+    end
+
+    def prepare
+    end
+
+    def syntax
+      :sass
+    end
+
+    def evaluate(context, locals, &block)
+      # Use custom importer that knows about Sprockets Caching
+      cache_store = SassCacheStore.new(context.environment)
+
+      options = {
+        :filename => eval_file,
+        :line => line,
+        :syntax => syntax,
+        :cache_store => cache_store,
+        :importer => SassImporter.new(context.pathname.to_s),
+        :load_paths => context.environment.paths.map { |path| SassImporter.new(path.to_s) },
+        :sprockets => {
+          :context => context,
+          :environment => context.environment
+        }
+      }
+
+      result = ::Sass::Engine.new(data, options).render
+
+      # Track all imported files
+      filenames = ([options[:importer].imported_filenames] + options[:load_paths].map(&:imported_filenames)).flatten.uniq
+      filenames.each { |filename| context.depend_on(filename) }
+
+      result
+    rescue ::Sass::SyntaxError => e
+      # Annotates exception message with parse line number
+      context.__LINE__ = e.sass_backtrace.first[:line]
+      raise e
+    end
+  end
+end