sprockets 3.0.0 → 4.0.2

data/lib/sprockets/processor_utils.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+require 'set'
+
 module Sprockets
   # Functional utilities for dealing with Processor functions.
   #
-  # A Processor is a general function that my modify or transform an asset as
+  # A Processor is a general function that may modify or transform an asset as
   # part of the pipeline. CoffeeScript to JavaScript conversion, Minification
   # or Concatenation are all implemented as seperate Processor steps.
   #
@@ -14,26 +17,34 @@ module Sprockets
   module ProcessorUtils
     extend self
 
+    class CompositeProcessor < Struct.new(:processor_strategy, :param, :processors) # :nodoc:
+      SINGULAR = lambda { |param, input| ProcessorUtils.call_processor param, input }
+      PLURAL   = lambda { |param, input| ProcessorUtils.call_processors param, input }
+
+      def self.create(processors)
+        if processors.length == 1
+          new SINGULAR, processors.first, processors
+        else
+          new PLURAL, processors, processors
+        end
+      end
+
+      def call(input)
+        processor_strategy.call param, input
+      end
+
+      def cache_key
+        ProcessorUtils.processors_cache_keys(processors)
+      end
+    end
+
     # Public: Compose processors in right to left order.
     #
     # processors - Array of processors callables
     #
     # Returns a composed Proc.
     def compose_processors(*processors)
-      context = self
-
-      if processors.length == 1
-        obj = method(:call_processor).to_proc.curry[processors.first]
-      else
-        obj = method(:call_processors).to_proc.curry[processors]
-      end
-
-      metaclass = (class << obj; self; end)
-      metaclass.send(:define_method, :cache_key) do
-        context.processors_cache_keys(processors)
-      end
-
-      obj
+      CompositeProcessor.create processors
     end
 
     # Public: Invoke list of processors in right to left order.
@@ -99,5 +110,60 @@ module Sprockets
     def processors_cache_keys(processors)
       processors.map { |processor| processor_cache_key(processor) }
     end
+
+    # Internal: Set of all "simple" value types allowed to be returned in
+    # processor metadata.
+    VALID_METADATA_VALUE_TYPES = Set.new([
+      String,
+      Symbol,
+      TrueClass,
+      FalseClass,
+      NilClass
+    ] + (0.class == Integer ? [Integer] : [Bignum, Fixnum])).freeze
+
+    # Internal: Set of all nested compound metadata types that can nest values.
+    VALID_METADATA_COMPOUND_TYPES = Set.new([
+      Array,
+      Hash,
+      Set
+    ]).freeze
+
+    # Internal: Hash of all "simple" value types allowed to be returned in
+    # processor metadata.
+    VALID_METADATA_VALUE_TYPES_HASH = VALID_METADATA_VALUE_TYPES.each_with_object({}) do |type, hash|
+      hash[type] = true
+    end.freeze
+
+    # Internal: Hash of all nested compound metadata types that can nest values.
+    VALID_METADATA_COMPOUND_TYPES_HASH = VALID_METADATA_COMPOUND_TYPES.each_with_object({}) do |type, hash|
+      hash[type] = true
+    end.freeze
+
+    # Internal: Set of all allowed metadata types.
+    VALID_METADATA_TYPES = (VALID_METADATA_VALUE_TYPES + VALID_METADATA_COMPOUND_TYPES).freeze
+
+    # Internal: Validate returned result of calling a processor pipeline and
+    # raise a friendly user error message.
+    #
+    # result - Metadata Hash returned from call_processors
+    #
+    # Returns result or raises a TypeError.
+    def validate_processor_result!(result)
+      if !result.instance_of?(Hash)
+        raise TypeError, "processor metadata result was expected to be a Hash, but was #{result.class}"
+      end
+
+      if !result[:data].instance_of?(String)
+        raise TypeError, "processor :data was expected to be a String, but as #{result[:data].class}"
+      end
+
+      result.each do |key, value|
+        if !key.instance_of?(Symbol)
+          raise TypeError, "processor metadata[#{key.inspect}] expected to be a Symbol"
+        end
+      end
+
+      result
+    end
   end
 end

data/lib/sprockets/resolve.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 require 'sprockets/http_utils'
 require 'sprockets/path_dependency_utils'
@@ -20,27 +21,21 @@ module Sprockets
     #     # => "file:///path/to/app/javascripts/application.coffee?type=application/javascript"
     #
     # The String Asset URI is returned or nil if no results are found.
-    def resolve(path, options = {})
-      path = path.to_s
-      paths = options[:load_paths] || config[:paths]
-      accept = options[:accept]
+    def resolve(path, load_paths: config[:paths], accept: nil, pipeline: nil, base_path: nil)
+      paths = load_paths
 
       if valid_asset_uri?(path)
         uri, deps = resolve_asset_uri(path)
       elsif absolute_path?(path)
         filename, type, deps = resolve_absolute_path(paths, path, accept)
       elsif relative_path?(path)
-        filename, type, pipeline, deps = resolve_relative_path(paths, path, options[:base_path], accept)
+        filename, type, path_pipeline, deps, index_alias = resolve_relative_path(paths, path, base_path, accept)
       else
-        filename, type, pipeline, deps = resolve_logical_path(paths, path, accept)
+        filename, type, path_pipeline, deps, index_alias = resolve_logical_path(paths, path, accept)
       end
 
       if filename
-        params = {}
-        params[:type] = type if type
-        params[:pipeline] = pipeline if pipeline
-        params[:pipeline] = options[:pipeline] if options[:pipeline]
-        uri = build_asset_uri(filename, params)
+        uri = build_asset_uri(filename, type: type, pipeline: pipeline || path_pipeline, index_alias: index_alias)
       end
 
       return uri, deps
@@ -48,12 +43,22 @@ module Sprockets
 
     # Public: Same as resolve() but raises a FileNotFound exception instead of
     # nil if no assets are found.
-    def resolve!(path, options = {})
-      uri, deps = resolve(path, options.merge(compat: false))
+    def resolve!(path, **kargs)
+      uri, deps = resolve(path, **kargs)
 
       unless uri
-        message = "couldn't find file '#{path}'"
-        message << " with type '#{options[:accept]}'" if options[:accept]
+        message = +"couldn't find file '#{path}'"
+
+        if relative_path?(path) && kargs[:base_path]
+          load_path, _ = paths_split(config[:paths], kargs[:base_path])
+          message << " under '#{load_path}'"
+        end
+
+        message << " with type '#{kargs[:accept]}'" if kargs[:accept]
+
+        load_paths = kargs[:load_paths] || config[:paths]
+        message << "\nChecked in these paths: \n  #{ load_paths.join("\n  ") }"
+
         raise FileNotFound, message
       end
 
@@ -61,148 +66,230 @@ module Sprockets
     end
 
     protected
+
+      # Internal: Finds an asset given a URI
+      #
+      # uri - String. Contains file:// scheme, absolute path to
+      #       file.
+      #       e.g. "file:///Users/schneems/sprockets/test/fixtures/default/gallery.js?type=application/javascript"
+      #
+      # Returns Array. Contains a String uri and Set of dependencies
       def resolve_asset_uri(uri)
-        filename, _ = parse_asset_uri(uri)
-        return uri, Set.new([build_file_digest_uri(filename)])
+        filename, _ = URIUtils.parse_asset_uri(uri)
+        return uri, Set.new( [URIUtils.build_file_digest_uri(filename)] )
       end
 
+      # Internal: Finds a file in a set of given paths
+      #
+      # paths    - Array of Strings.
+      # filename - String containing absolute path to a file including extension.
+      #            e.g. "/Users/schneems/sprockets/test/fixtures/asset/application.js"
+      # accept   - String. A Quality value incoded set of
+      #            mime types that we are looking for. Can be nil.
+      #            e.g. "application/javascript" or "text/css, */*"
+      #
+      # Returns Array. Filename, type, path_pipeline, deps, index_alias
       def resolve_absolute_path(paths, filename, accept)
         deps = Set.new
         filename = File.expand_path(filename)
 
         # Ensure path is under load paths
-        return nil, nil, deps unless paths_split(paths, filename)
+        return nil, nil, deps unless PathUtils.paths_split(paths, filename)
 
-        _, mime_type, _, _ = parse_path_extnames(filename)
+        _, mime_type = PathUtils.match_path_extname(filename, config[:mime_exts])
         type = resolve_transform_type(mime_type, accept)
         return nil, nil, deps if accept && !type
 
         return nil, nil, deps unless file?(filename)
 
-        deps << build_file_digest_uri(filename)
+        deps << URIUtils.build_file_digest_uri(filename)
         return filename, type, deps
       end
 
+      # Internal: Finds a relative file in a set of given paths
+      #
+      # paths   - Array of Strings.
+      # path    - String. A relative filename with or without extension
+      #           e.g. "./jquery" or "../foo.js"
+      # dirname - String. Base path where we start looking for the given file.
+      # accept  - String. A Quality value incoded set of
+      #           mime types that we are looking for. Can be nil.
+      #           e.g. "application/javascript" or "text/css, */*"
+      #
+      # Returns Array. Filename, type, path_pipeline, deps, index_alias
       def resolve_relative_path(paths, path, dirname, accept)
         filename = File.expand_path(path, dirname)
-        load_path, _ = paths_split(paths, dirname)
-        if load_path && logical_path = split_subpath(load_path, filename)
+        load_path, _ = PathUtils.paths_split(paths, dirname)
+        if load_path && logical_path = PathUtils.split_subpath(load_path, filename)
           resolve_logical_path([load_path], logical_path, accept)
         else
-          return nil, nil, Set.new
+          return nil, nil, nil, Set.new
         end
       end
 
+      # Internal: Finds a file in a set of given paths
+      #
+      # paths        - Array of Strings.
+      # logical_path - String. A filename with extension
+      #                e.g. "coffee/foo.js" or "foo.js"
+      # accept       - String. A Quality value incoded set of
+      #                mime types that we are looking for. Can be nil.
+      #                e.g. "application/javascript" or "text/css, */*"
+      #
+      # Finds a file on the given paths.
+      #
+      # Returns Array. Filename, type, path_pipeline, deps, index_alias
       def resolve_logical_path(paths, logical_path, accept)
-        logical_name, mime_type, _, pipeline = parse_path_extnames(logical_path)
+        extname, mime_type = PathUtils.match_path_extname(logical_path, config[:mime_exts])
+        logical_name = logical_path.chomp(extname)
+
+        extname, pipeline = PathUtils.match_path_extname(logical_name, config[:pipeline_exts])
+        logical_name = logical_name.chomp(extname)
+
         parsed_accept = parse_accept_options(mime_type, accept)
         transformed_accepts = expand_transform_accepts(parsed_accept)
-        filename, mime_type, deps = resolve_under_paths(paths, logical_name, transformed_accepts)
+
+        filename, mime_type, deps, index_alias = resolve_under_paths(paths, logical_name, transformed_accepts)
 
         if filename
           deps << build_file_digest_uri(filename)
           type = resolve_transform_type(mime_type, parsed_accept)
-          return filename, type, pipeline, deps
+          return filename, type, pipeline, deps, index_alias
         else
           return nil, nil, nil, deps
         end
       end
 
+      # Internal: Finds a file in a set of given paths
+      #
+      # paths        - Array of Strings.
+      # logical_name - String. A filename without extension
+      #                e.g. "application" or "coffee/foo"
+      # accepts      - Array of array containing mime/version pairs
+      #                e.g. [["application/javascript", 1.0]]
+      #
+      # Finds a file with the same name as `logical_name` or "index" inside
+      # of the `logical_name` directory that matches a valid mime-type/version from
+      # `accepts`.
+      #
+      # Returns Array. Filename, type, dependencies, and index_alias
       def resolve_under_paths(paths, logical_name, accepts)
-        all_deps = Set.new
-        return nil, nil, all_deps if accepts.empty?
+        deps = Set.new
+        return nil, nil, deps if accepts.empty?
+
+        # TODO: Allow new path resolves to be registered
+        @resolvers ||= [
+          method(:resolve_main_under_path),
+          method(:resolve_alts_under_path),
+          method(:resolve_index_under_path)
+        ]
+        mime_exts = config[:mime_exts]
 
-        logical_basename = File.basename(logical_name)
         paths.each do |load_path|
-          candidates, deps = path_matches(load_path, logical_name, logical_basename)
-          all_deps.merge(deps)
-          candidate = find_best_q_match(accepts, candidates) do |c, matcher|
-            match_mime_type?(c[1] || "application/octet-stream", matcher)
+          candidates = []
+          @resolvers.each do |fn|
+            result = fn.call(load_path, logical_name, mime_exts)
+            candidates.concat(result[0])
+            deps.merge(result[1])
           end
-          return candidate + [all_deps] if candidate
-        end
-
-        return nil, nil, all_deps
-      end
 
-      def parse_accept_options(mime_type, types)
-        accepts = []
-        accepts += parse_q_values(types) if types
-
-        if mime_type
-          if accepts.empty? || accepts.any? { |accept, _| match_mime_type?(mime_type, accept) }
-            accepts = [[mime_type, 1.0]]
-          else
-            return []
+          candidate = HTTPUtils.find_best_q_match(accepts, candidates) do |c, matcher|
+            match_mime_type?(c[:type] || "application/octet-stream", matcher)
           end
+          return candidate[:filename], candidate[:type], deps, candidate[:index_alias] if candidate
         end
 
-        if accepts.empty?
-          accepts << ['*/*', 1.0]
-        end
-
-        accepts
-      end
-
-      def normalize_logical_path(path)
-        dirname, basename = File.split(path)
-        path = dirname if basename == 'index'
-        path
+        return nil, nil, deps
       end
 
-      def path_matches(load_path, logical_name, logical_basename)
+      # Internal: Finds candidate files on a given path
+      #
+      # load_path    - String. An absolute path to a directory
+      # logical_name - String. A filename without extension
+      #                e.g. "application" or "coffee/foo"
+      # mime_exts    - Hash of file extensions and their mime types
+      #                e.g. {".xml.builder"=>"application/xml+builder"}
+      #
+      # Finds files that match a given `logical_name` with an acceptable
+      # mime type that is included in `mime_exts` on the `load_path`.
+      #
+      # Returns Array. First element is an Array of hashes or empty, second is a String
+      def resolve_main_under_path(load_path, logical_name, mime_exts)
         dirname    = File.dirname(File.join(load_path, logical_name))
-        candidates = dirname_matches(dirname, logical_basename)
-        deps       = file_digest_dependency_set(dirname)
-
-        result = resolve_alternates(load_path, logical_name)
-        result[0].each do |fn|
-          candidates << [fn, parse_path_extnames(fn)[1]]
+        candidates = self.find_matching_path_for_extensions(dirname, File.basename(logical_name), mime_exts)
+        candidates.map! do |c|
+          { filename: c[0], type: c[1] }
         end
-        deps.merge(result[1])
+        return candidates, [ URIUtils.build_file_digest_uri(dirname) ]
+      end
+
 
+      # Internal: Finds candidate index files in a given path
+      #
+      # load_path    - String. An absolute path to a directory
+      # logical_name - String. A filename without extension
+      #                e.g. "application" or "coffee/foo"
+      # mime_exts    - Hash of file extensions and their mime types
+      #                e.g. {".xml.builder"=>"application/xml+builder"}
+      #
+      # Looking in the given `load_path` this method will find all files under the `logical_name` directory
+      # that are named `index` and have a matching mime type in `mime_exts`.
+      #
+      # Returns Array. First element is an Array of hashes or empty, second is a String
+      def resolve_index_under_path(load_path, logical_name, mime_exts)
         dirname = File.join(load_path, logical_name)
-        if directory? dirname
-          result = dirname_matches(dirname, "index")
-          candidates.concat(result)
+
+        if self.directory?(dirname)
+          candidates = self.find_matching_path_for_extensions(dirname, "index".freeze, mime_exts)
+        else
+          candidates = []
         end
 
-        deps.merge(file_digest_dependency_set(dirname))
+        candidates.map! do |c|
+          { filename: c[0],
+            type: c[1],
+            index_alias: compress_from_root(c[0].sub(/\/index(\.[^\/]+)$/, '\1')) }
+        end
 
-        return candidates.select { |fn, _| file?(fn) }, deps
+        return candidates, [ URIUtils.build_file_digest_uri(dirname) ]
       end
 
-      def dirname_matches(dirname, basename)
-        candidates = []
-        entries = self.entries(dirname)
-        entries.each do |entry|
-          name, type, _, _ = parse_path_extnames(entry)
-          if basename == name
-            candidates << [File.join(dirname, entry), type]
-          end
+      def resolve_alts_under_path(load_path, logical_name, mime_exts)
+        filenames, deps = self.resolve_alternates(load_path, logical_name)
+        filenames.map! do |fn|
+          _, mime_type = PathUtils.match_path_extname(fn, mime_exts)
+          { filename: fn, type: mime_type }
         end
-        candidates
+        return filenames, deps
       end
 
-      def resolve_alternates(load_path, logical_name)
-        return [], Set.new
-      end
-
-      # Internal: Returns the name, mime type and `Array` of engine extensions.
+      # Internal: Converts mimetype into accept Array
       #
-      #     "foo.js.coffee.erb"
-      #     # => ["foo", "application/javascript", [".coffee", ".erb"]]
+      # - mime_type     - String, optional. e.g. "text/html"
+      # - explicit_type - String, optional. e.g. "application/javascript"
       #
-      def parse_path_extnames(path)
-        engines = []
-        extname, value = match_path_extname(path, extname_map)
-
-        if extname
-          path = path.chomp(extname)
-          type, engines, pipeline = value.values_at(:type, :engines, :pipeline)
+      # When called with an explicit_type and a mime_type, only a mime_type
+      # that matches the given explicit_type will be accepted.
+      #
+      # Returns Array of Array
+      #
+      #     [["application/javascript", 1.0]]
+      #     [["*/*", 1.0]]
+      #     []
+      def parse_accept_options(mime_type, explicit_type)
+        if mime_type
+          return [[mime_type, 1.0]] if explicit_type.nil?
+          return [[mime_type, 1.0]] if HTTPUtils.parse_q_values(explicit_type).any? { |accept, _| HTTPUtils.match_mime_type?(mime_type, accept) }
+          return []
         end
 
-        return path, type, engines, pipeline
+        accepts = HTTPUtils.parse_q_values(explicit_type)
+        accepts << ['*/*'.freeze, 1.0] if accepts.empty?
+        return accepts
+      end
+
+      def resolve_alternates(load_path, logical_name)
+        return [], Set.new
       end
   end
 end

data/lib/sprockets/sass_cache_store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sass'
 
 module Sprockets

data/lib/sprockets/sass_compressor.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
 require 'sprockets/autoload'
+require 'sprockets/digest_utils'
+require 'sprockets/source_map_utils'
 
 module Sprockets
   # Public: Sass CSS minifier.
@@ -34,26 +37,27 @@ module Sprockets
     attr_reader :cache_key
 
     def initialize(options = {})
-      @options = options
-      @cache_key = [
-        self.class.name,
-        Autoload::Sass::VERSION,
-        VERSION,
-        options
-      ].freeze
+      @options = {
+        syntax: :scss,
+        cache: false,
+        read_cache: false,
+        style: :compressed
+      }.merge(options).freeze
+      @cache_key = "#{self.class.name}:#{Autoload::Sass::VERSION}:#{VERSION}:#{DigestUtils.digest(options)}".freeze
     end
 
     def call(input)
-      data = input[:data]
-      input[:cache].fetch(@cache_key + [data]) do
-        options = {
-          syntax: :scss,
-          cache: false,
-          read_cache: false,
-          style: :compressed
-        }.merge(@options)
-        Autoload::Sass::Engine.new(data, options).render
-      end
+      css, map = Autoload::Sass::Engine.new(
+        input[:data],
+        @options.merge(filename: input[:filename])
+      ).render_with_sourcemap('')
+
+      css = css.sub("/*# sourceMappingURL= */\n", '')
+
+      map = SourceMapUtils.format_source_map(JSON.parse(map.to_json(css_uri: '')), input)
+      map = SourceMapUtils.combine_source_maps(input[:metadata][:map], map)
+
+      { data: css, map: map }
     end
   end
 end

data/lib/sprockets/sass_functions.rb

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 # Deprecated: Require sprockets/sass_processor instead
 require 'sprockets/sass_processor'

data/lib/sprockets/sass_importer.rb

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 # Deprecated: Require sprockets/sass_processor instead
 require 'sprockets/sass_processor'

data/lib/sprockets/sass_processor.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 require 'rack/utils'
 require 'sprockets/autoload'
+require 'sprockets/source_map_utils'
 require 'uri'
 
 module Sprockets
@@ -39,18 +41,14 @@ module Sprockets
     # Public: Initialize template with custom options.
     #
     # options - Hash
-    #   cache_version - String custom cache version. Used to force a cache
-    #                   change after code changes are made to Sass Functions.
+    # cache_version - String custom cache version. Used to force a cache
+    #                 change after code changes are made to Sass Functions.
     #
     def initialize(options = {}, &block)
       @cache_version = options[:cache_version]
-      @cache_key = [
-        self.class.name,
-        VERSION,
-        Autoload::Sass::VERSION,
-        @cache_version
-      ].freeze
-
+      @cache_key = "#{self.class.name}:#{VERSION}:#{Autoload::Sass::VERSION}:#{@cache_version}".freeze
+      @importer_class = options[:importer] || Sass::Importers::Filesystem
+      @sass_config = options[:sass_config] || {}
       @functions = Module.new do
         include Functions
         include options[:functions] if options[:functions]
@@ -61,24 +59,30 @@ module Sprockets
     def call(input)
       context = input[:environment].context_class.new(input)
 
-      options = {
+      engine_options = merge_options({
         filename: input[:filename],
         syntax: self.class.syntax,
-        cache_store: CacheStore.new(input[:cache], @cache_version),
-        load_paths: input[:environment].paths,
+        cache_store: build_cache_store(input, @cache_version),
+        load_paths: context.environment.paths.map { |p| @importer_class.new(p.to_s) },
+        importer: @importer_class.new(Pathname.new(context.filename).to_s),
         sprockets: {
           context: context,
           environment: input[:environment],
           dependencies: context.metadata[:dependencies]
         }
-      }
+      })
 
-      engine = Autoload::Sass::Engine.new(input[:data], options)
+      engine = Autoload::Sass::Engine.new(input[:data], engine_options)
 
-      css = Utils.module_include(Autoload::Sass::Script::Functions, @functions) do
-        engine.render
+      css, map = Utils.module_include(Autoload::Sass::Script::Functions, @functions) do
+        engine.render_with_sourcemap('')
       end
 
+      css = css.sub("\n/*# sourceMappingURL= */\n", '')
+
+      map = SourceMapUtils.format_source_map(JSON.parse(map.to_json(css_uri: '')), input)
+      map = SourceMapUtils.combine_source_maps(input[:metadata][:map], map)
+
       # Track all imported files
       sass_dependencies = Set.new([input[:filename]])
       engine.dependencies.map do |dependency|
@@ -86,7 +90,31 @@ module Sprockets
         context.metadata[:dependencies] << URIUtils.build_file_digest_uri(dependency.options[:filename])
       end
 
-      context.metadata.merge(data: css, sass_dependencies: sass_dependencies)
+      context.metadata.merge(data: css, sass_dependencies: sass_dependencies, map: map)
+    end
+
+    private
+
+    # Public: Build the cache store to be used by the Sass engine.
+    #
+    # input - the input hash.
+    # version - the cache version.
+    #
+    # Override this method if you need to use a different cache than the
+    # Sprockets cache.
+    def build_cache_store(input, version)
+      CacheStore.new(input[:cache], version)
+    end
+
+    def merge_options(options)
+      defaults = @sass_config.dup
+
+      if load_paths = defaults.delete(:load_paths)
+        options[:load_paths] += load_paths
+      end
+
+      options.merge!(defaults)
+      options
     end
 
     # Public: Functions injected into Sass context during Sprockets evaluation.