sprockets 3.7.5 → 4.0.0.beta1

data/lib/sprockets/loader.rb

@@ -1,6 +1,5 @@
 require 'sprockets/asset'
 require 'sprockets/digest_utils'
-require 'sprockets/engines'
 require 'sprockets/errors'
 require 'sprockets/file_reader'
 require 'sprockets/mime'
@@ -18,7 +17,7 @@ module Sprockets
   # object.
   module Loader
     include DigestUtils, PathUtils, ProcessorUtils, URIUtils
-    include Engines, Mime, Processing, Resolve, Transformers
+    include Mime, Processing, Resolve, Transformers
 
 
     # Public: Load Asset by Asset URI.
@@ -27,7 +26,6 @@ module Sprockets
     #       and full path such as:
     #       "file:///Path/app/assets/js/app.js?type=application/javascript"
     #
-    #
     # Returns Asset.
     def load(uri)
       unloaded = UnloadedAsset.new(uri, self)
@@ -46,7 +44,7 @@ module Sprockets
           # The presence of `paths` indicates dependencies were stored.
           # We can check to see if the dependencies have not changed by "resolving" them and
           # generating a digest key from the resolved entries. If this digest key has not
-          # changed the asset will be pulled from cache.
+          # changed, the asset will be pulled from cache.
           #
           # If this `paths` is present but the cache returns nothing then `fetch_asset_from_dependency_cache`
           # will confusingly be called again with `paths` set to nil where the asset will be
@@ -61,7 +59,7 @@ module Sprockets
           end
         end
       end
-      Asset.new(self, asset)
+      Asset.new(asset)
     end
 
     private
@@ -103,13 +101,23 @@ module Sprockets
           raise FileNotFound, "could not find file: #{unloaded.filename}"
         end
 
-        load_path, logical_path = paths_split(config[:paths], unloaded.filename)
+        path_to_split =
+          if index_alias = unloaded.params[:index_alias]
+            expand_from_root index_alias
+          else
+            unloaded.filename
+          end
+
+        load_path, logical_path = paths_split(config[:paths], path_to_split)
 
         unless load_path
-          raise FileOutsidePaths, "#{unloaded.filename} is no longer under a load path: #{self.paths.join(', ')}"
+          target = path_to_split
+          target += " (index alias of #{unloaded.filename})" if unloaded.params[:index_alias]
+          raise FileOutsidePaths, "#{target} is no longer under a load path: #{self.paths.join(', ')}"
         end
 
-        logical_path, file_type, engine_extnames, _ = parse_path_extnames(logical_path)
+        extname, file_type = match_path_extname(logical_path, mime_exts)
+        logical_path = logical_path.chomp(extname)
         name = logical_path
 
         if pipeline = unloaded.params[:pipeline]
@@ -124,22 +132,31 @@ module Sprockets
           raise ConversionError, "could not convert #{file_type.inspect} to #{type.inspect}"
         end
 
-        processors = processors_for(type, file_type, engine_extnames, pipeline)
+        processors = processors_for(type, file_type, pipeline)
 
-        processors_dep_uri = build_processors_uri(type, file_type, engine_extnames, pipeline)
+        processors_dep_uri = build_processors_uri(type, file_type, pipeline)
         dependencies = config[:dependencies] + [processors_dep_uri]
 
         # Read into memory and process if theres a processor pipeline
         if processors.any?
+          source_uri, _ = resolve!(unloaded.filename, pipeline: :source)
+          source_asset = load(source_uri)
+
+          source_path = source_asset.digest_path
+
           result = call_processors(processors, {
             environment: self,
             cache: self.cache,
             uri: unloaded.uri,
             filename: unloaded.filename,
             load_path: load_path,
+            source_path: source_path,
             name: name,
             content_type: type,
-            metadata: { dependencies: dependencies }
+            metadata: {
+              dependencies: dependencies,
+              map: []
+            }
           })
           validate_processor_result!(result)
           source = result.delete(:data)
@@ -171,17 +188,6 @@ module Sprockets
         asset[:id]  = pack_hexdigest(digest(asset))
         asset[:uri] = build_asset_uri(unloaded.filename, unloaded.params.merge(id: asset[:id]))
 
-        # Deprecated: Avoid tracking Asset mtime
-        asset[:mtime] = metadata[:dependencies].map { |u|
-          if u.start_with?("file-digest:")
-            s = self.stat(parse_file_digest_uri(u))
-            s ? s.mtime.to_i : nil
-          else
-            nil
-          end
-        }.compact.max
-        asset[:mtime] ||= self.stat(unloaded.filename).mtime.to_i
-
         store_asset(asset, unloaded)
         asset
       end
@@ -255,11 +261,11 @@ module Sprockets
       #           "processors:type=text/css&file_type=text/css&pipeline=self",
       #           "file-digest:///Full/path/app/assets/stylesheets"]
       #
-      # Returns back array of things that the given uri dpends on
+      # Returns back array of things that the given uri depends on
       # For example the environment version, if you're using a different version of sprockets
       # then the dependencies should be different, this is used only for generating cache key
       # for example the "environment-version" may be resolved to "environment-1.0-3.2.0" for
-      #  version "3.2.0" of sprockets.
+      # version "3.2.0" of sprockets.
       #
       # Any paths that are returned are converted to relative paths
       #
@@ -276,9 +282,9 @@ module Sprockets
       #
       # This method attempts to retrieve the last `limit` number of histories of an asset
       # from the cache a "history" which is an array of unresolved "dependencies" that the asset needs
-      # to compile. In this case A dependency can refer to either an asset i.e. index.js
-      # may rely on jquery.js (so jquery.js is a depndency), or other factors that may affect
-      # compilation, such as the VERSION of sprockets (i.e. the environment) and what "processors"
+      # to compile. In this case a dependency can refer to either an asset e.g. index.js
+      # may rely on jquery.js (so jquery.js is a dependency), or other factors that may affect
+      # compilation, such as the VERSION of Sprockets (i.e. the environment) and what "processors"
       # are used.
       #
       # For example a history array may look something like this
@@ -289,7 +295,7 @@ module Sprockets
       #     "file-digest:///Full/path/app/assets/stylesheets"]]
       #
       # Where the first entry is a Set of dependencies for last generated version of that asset.
-      # Multiple versions are stored since sprockets keeps the last `limit` number of assets
+      # Multiple versions are stored since Sprockets keeps the last `limit` number of assets
       # generated present in the system.
       #
       # If a "history" of dependencies is present in the cache, each version of "history" will be

data/lib/sprockets/manifest.rb

@@ -52,14 +52,8 @@ module Sprockets
       @directory ||= File.dirname(@filename) if @filename
 
       # If directory is given w/o filename, pick a random manifest location
-      @rename_filename = nil
       if @directory && @filename.nil?
         @filename = find_directory_manifest(@directory)
-
-        # If legacy manifest name autodetected, mark to rename on save
-        if File.basename(@filename).start_with?("manifest")
-          @rename_filename = File.join(@directory, generate_manifest_path)
-        end
       end
 
       unless @directory && @filename
@@ -125,27 +119,13 @@ module Sprockets
 
       return to_enum(__method__, *args) unless block_given?
 
-      paths, filters = args.flatten.partition { |arg| self.class.simple_logical_path?(arg) }
-      filters = filters.map { |arg| self.class.compile_match_filter(arg) }
-
       environment = self.environment.cached
-
-      paths.each do |path|
+      args.flatten.each do |path|
         environment.find_all_linked_assets(path) do |asset|
           yield asset
         end
       end
 
-      if filters.any?
-        environment.logical_paths do |logical_path, filename|
-          if filters.any? { |f| f.call(logical_path, filename) }
-            environment.find_all_linked_assets(filename) do |asset|
-              yield asset
-            end
-          end
-        end
-      end
-
       nil
     end
 
@@ -161,8 +141,7 @@ module Sprockets
         end
       else
         args.each do |path|
-          asset = assets[path]
-          yield File.binread(File.join(dir, asset)) if asset
+          yield File.binread(File.join(dir, assets[path]))
         end
       end
     end
@@ -186,7 +165,7 @@ module Sprockets
       find(*args) do |asset|
         files[asset.digest_path] = {
           'logical_path' => asset.logical_path,
-          'mtime'        => asset.mtime.iso8601,
+          'mtime'        => Time.now.iso8601,
           'size'         => asset.bytesize,
           'digest'       => asset.hexdigest,
 
@@ -197,10 +176,6 @@ module Sprockets
         }
         assets[asset.logical_path] = asset.digest_path
 
-        if alias_logical_path = self.class.compute_alias_logical_path(asset.logical_path)
-          assets[alias_logical_path] = asset.digest_path
-        end
-
         target = File.join(dir, asset.digest_path)
 
         if File.exist?(target)
@@ -300,13 +275,6 @@ module Sprockets
 
     # Persist manfiest back to FS
     def save
-      if @rename_filename
-        logger.info "Renaming #{@filename} to #{@rename_filename}"
-        FileUtils.mv(@filename, @rename_filename)
-        @filename = @rename_filename
-        @rename_filename = nil
-      end
-
       data = json_encode(@data)
       FileUtils.mkdir_p File.dirname(@filename)
       PathUtils.atomic_write(@filename) do |f|

data/lib/sprockets/manifest_utils.rb

@@ -36,8 +36,6 @@ module Sprockets
     def find_directory_manifest(dirname)
       entries = File.directory?(dirname) ? Dir.entries(dirname) : []
       entry = entries.find { |e| e =~ MANIFEST_RE } ||
-        # Deprecated: Will be removed in 4.x
-        entries.find { |e| e =~ LEGACY_MANIFEST_RE } ||
         generate_manifest_path
       File.join(dirname, entry)
     end

data/lib/sprockets/mime.rb

@@ -36,29 +36,18 @@ module Sprockets
 
     # Public: Register a new mime type.
     #
-    # mime_type - String MIME Type
-    # options - Hash
-    #   extensions: Array of String extnames
-    #   charset: Proc/Method that detects the charset of a file.
-    #            See EncodingUtils.
+    # mime_type  - String MIME Type
+    # extensions - Array of String extnames
+    # charset    - Proc/Method that detects the charset of a file.
+    #              See EncodingUtils.
     #
     # Returns nothing.
-    def register_mime_type(mime_type, options = {})
-      # Legacy extension argument, will be removed from 4.x
-      if options.is_a?(String)
-        options = { extensions: [options] }
-      end
-
-      extnames = Array(options[:extensions]).map { |extname|
-        Sprockets::Utils.normalize_extension(extname)
-      }
+    def register_mime_type(mime_type, extensions: [], charset: nil)
+      extnames = Array(extensions)
 
-      charset = options[:charset]
       charset ||= :default if mime_type.start_with?('text/')
       charset = EncodingUtils::CHARSET_DETECT[charset] if charset.is_a?(Symbol)
 
-      self.computed_config = {}
-
       self.config = hash_reassoc(config, :mime_exts) do |mime_exts|
         extnames.each do |extname|
           mime_exts[extname] = mime_type
@@ -97,54 +86,10 @@ module Sprockets
       data = File.binread(filename)
 
       if detect = mime_type_charset_detecter(content_type)
-        detect.call(data).encode(Encoding::UTF_8, :universal_newline => true)
+        detect.call(data).encode(Encoding::UTF_8, universal_newline: true)
       else
         data
       end
     end
-
-    private
-      def extname_map
-        self.computed_config[:_extnames] ||= compute_extname_map
-      end
-
-      def compute_extname_map
-        graph = {}
-
-        engine_extname_permutation = []
-
-        4.times do |n|
-          config[:engines].keys.permutation(n).each do |engine_extnames|
-            engine_extname_permutation << engine_extnames
-          end
-        end
-
-        mime_exts_grouped_by_mime_type = {}
-        config[:mime_exts].each do |format_extname,format_type|
-          mime_exts_grouped_by_mime_type[format_type] ||= []
-          mime_exts_grouped_by_mime_type[format_type] << format_extname
-        end
-
-        ([nil] + pipelines.keys.map(&:to_s)).each do |pipeline|
-          pipeline_extname = pipeline ? ".#{pipeline}" : ''.freeze
-          engine_extname_permutation.each do |engine_extnames|
-            mime_exts_grouped_by_mime_type.each do |format_type, format_extnames|
-              type = format_type
-              value = [type, engine_extnames, pipeline]
-              format_extnames.each do |format_extname|
-                key = "#{pipeline_extname}#{format_extname}#{engine_extnames.join}"
-                graph[key] = value
-              end
-              if format_type == config[:engine_mime_types][engine_extnames.first]
-                key =  "#{pipeline_extname}#{engine_extnames.join}"
-                graph[key] = value
-              end
-            end
-          end
-          graph[pipeline_extname] = [nil, [], pipeline]
-        end
-
-        graph
-      end
   end
 end

data/lib/sprockets/path_dependency_utils.rb

@@ -41,7 +41,7 @@ module Sprockets
     #
     # Returns an Array of entry names and a Set of dependency URIs.
     def entries_with_dependencies(path)
-      return entries(path), file_digest_dependency_set(path)
+      return entries(path), Set.new([build_file_digest_uri(path)])
     end
 
     # Internal: List directory filenames and associated Stats under a
@@ -53,16 +53,7 @@ module Sprockets
     #
     # Returns an Array of filenames and a Set of dependency URIs.
     def stat_directory_with_dependencies(dir)
-      return stat_directory(dir).to_a, file_digest_dependency_set(dir)
-    end
-
-    # Internal: Returns a set of dependencies for a particular path.
-    #
-    # path - String directory path
-    #
-    # Returns a Set of dependency URIs.
-    def file_digest_dependency_set(path)
-      Set.new([build_file_digest_uri(path)])
+      return stat_directory(dir).to_a, Set.new([build_file_digest_uri(dir)])
     end
 
     # Internal: List directory filenames and associated Stats under an entire

data/lib/sprockets/path_digest_utils.rb

@@ -15,7 +15,7 @@ module Sprockets
     def stat_digest(path, stat)
       if stat.directory?
         # If its a directive, digest the list of filenames
-        digest_class.digest(self.entries(path).join(','))
+        digest_class.digest(self.entries(path).join(','.freeze))
       elsif stat.file?
         # If its a file, digest the contents
         digest_class.file(path.to_s).digest

data/lib/sprockets/path_utils.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module Sprockets
   # Internal: File and path related utilities. Mixed into Environment.
   #
@@ -53,13 +55,12 @@ module Sprockets
     # Returns an empty `Array` if the directory does not exist.
     def entries(path)
       if File.directory?(path)
-        entries = Dir.entries(path, :encoding => Encoding.default_internal)
+        entries = Dir.entries(path, encoding: Encoding.default_internal)
         entries.reject! { |entry|
-          entry.start_with?(".".freeze) ||
-            (entry.start_with?("#".freeze) && entry.end_with?("#".freeze)) ||
-            entry.end_with?("~".freeze)
+          entry =~ /^\.|~$|^\#.*\#$/
         }
         entries.sort!
+        entries
       else
         []
       end
@@ -109,7 +110,7 @@ module Sprockets
     # subpath is outside of path.
     def split_subpath(path, subpath)
       return "" if path == subpath
-      path = File.join(path, '')
+      path = File.join(path, ''.freeze)
       if subpath.start_with?(path)
         subpath[path.length..-1]
       else
@@ -148,19 +149,43 @@ module Sprockets
     #
     # Returns [String extname, Object value] or nil nothing matched.
     def match_path_extname(path, extensions)
-      basename = File.basename(path)
-
-      i = basename.index('.'.freeze)
-      while i && i < basename.length - 1
-        extname = basename[i..-1]
-        if value = extensions[extname]
-          return extname, value
+      match, key = nil, ""
+      path_extnames(path).reverse_each do |extname|
+        key.prepend(extname)
+        if value = extensions[key]
+          match = [key.dup, value]
+        elsif match
+          break
         end
-
-        i = basename.index('.'.freeze, i+1)
       end
+      match
+    end
 
-      nil
+    # Internal: Match paths in a directory against available extensions.
+    #
+    # path       - String directory
+    # basename   - String basename of target file
+    # extensions - Hash of String extnames to values
+    #
+    # Examples
+    #
+    #     exts = { ".js" => "application/javascript" }
+    #     find_matching_path_for_extensions("app/assets", "application", exts)
+    #     # => ["app/assets/application.js", "application/javascript"]
+    #
+    # Returns an Array of [String path, Object value] matches.
+    def find_matching_path_for_extensions(path, basename, extensions)
+      matches = []
+      entries(path).each do |entry|
+        extname, value = match_path_extname(entry, extensions)
+        if basename == entry.chomp(extname)
+          filename = File.join(path, entry)
+          if file?(filename)
+            matches << [filename, value]
+          end
+        end
+      end
+      matches
     end
 
     # Internal: Returns all parents for path
@@ -272,16 +297,16 @@ module Sprockets
         Thread.current.object_id,
         Process.pid,
         rand(1000000)
-      ].join('.')
+      ].join('.'.freeze)
       tmpname = File.join(dirname, basename)
 
       File.open(tmpname, 'wb+') do |f|
         yield f
       end
 
-      File.rename(tmpname, filename)
+      FileUtils.mv(tmpname, filename)
     ensure
-      File.delete(tmpname) if File.exist?(tmpname)
+      FileUtils.rm(tmpname) if File.exist?(tmpname)
     end
   end
 end

data/lib/sprockets/preprocessors/default_source_map.rb

@@ -0,0 +1,24 @@
+module Sprockets
+  module Preprocessors
+    # Private: Adds a default map to assets when one is not present
+    #
+    # If the input file already has a source map, it effectively returns the original
+    # result. Otherwise it maps 1 for 1 lines original to generated. This is needed
+    # Because other generators run after might depend on having a valid source map
+    # available.
+    class DefaultSourceMap
+      def call(input)
+        result = { data: input[:data] }
+        map    = input[:metadata][:map]
+        if map.nil? || map.empty?
+          result[:map] ||= []
+          input[:data].each_line.with_index do |_, index|
+            line = index + 1
+            result[:map] << { source: input[:source_path], generated: [line , 0], original: [line, 0] }
+          end
+        end
+        return result
+      end
+    end
+  end
+end