sprockets 3.7.2 → 4.2.0

data/lib/sprockets/loader.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 require 'sprockets/asset'
 require 'sprockets/digest_utils'
-require 'sprockets/engines'
 require 'sprockets/errors'
 require 'sprockets/file_reader'
 require 'sprockets/mime'
@@ -18,7 +18,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 +27,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 +45,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,10 +60,47 @@ module Sprockets
           end
         end
       end
-      Asset.new(self, asset)
+      Asset.new(asset)
     end
 
     private
+      def compress_key_from_hash(hash, key)
+        return unless hash.key?(key)
+        value = hash[key].dup
+        return if !value
+
+        if block_given?
+          value.map! do |x|
+            if yield x
+             compress_from_root(x)
+            else
+             x
+            end
+          end
+        else
+          value.map! { |x| compress_from_root(x) }
+        end
+        hash[key] = value
+      end
+
+
+      def expand_key_from_hash(hash, key)
+        return unless hash.key?(key)
+        value = hash[key].dup
+        return if !value
+        if block_given?
+          value.map! do |x|
+            if yield x
+              expand_from_root(x)
+            else
+              x
+            end
+          end
+        else
+          value.map! { |x| expand_from_root(x) }
+        end
+        hash[key] = value
+      end
 
       # Internal: Load asset hash from cache
       #
@@ -78,15 +114,17 @@ module Sprockets
           asset[:uri]       = expand_from_root(asset[:uri])
           asset[:load_path] = expand_from_root(asset[:load_path])
           asset[:filename]  = expand_from_root(asset[:filename])
-          asset[:metadata][:included].map!          { |uri| expand_from_root(uri) } if asset[:metadata][:included]
-          asset[:metadata][:links].map!             { |uri| expand_from_root(uri) } if asset[:metadata][:links]
-          asset[:metadata][:stubbed].map!           { |uri| expand_from_root(uri) } if asset[:metadata][:stubbed]
-          asset[:metadata][:required].map!          { |uri| expand_from_root(uri) } if asset[:metadata][:required]
-          asset[:metadata][:dependencies].map!      { |uri| uri.start_with?("file-digest://") ? expand_from_root(uri) : uri } if asset[:metadata][:dependencies]
+          expand_key_from_hash(asset[:metadata], :included)
+          expand_key_from_hash(asset[:metadata], :links)
+          expand_key_from_hash(asset[:metadata], :stubbed)
+          expand_key_from_hash(asset[:metadata], :required)
+          expand_key_from_hash(asset[:metadata], :to_load)
+          expand_key_from_hash(asset[:metadata], :to_link)
+          expand_key_from_hash(asset[:metadata], :dependencies) { |uri| uri.start_with?("file-digest://") }
 
           asset[:metadata].each_key do |k|
-            next unless k =~ /_dependencies\z/
-            asset[:metadata][k].map! { |uri| expand_from_root(uri) }
+            next unless k.match?(/_dependencies\z/) # rubocop:disable Performance/EndWith
+            expand_key_from_hash(asset[:metadata], k)
           end
         end
         asset
@@ -103,13 +141,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,9 +172,9 @@ 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
@@ -139,7 +187,9 @@ module Sprockets
             load_path: load_path,
             name: name,
             content_type: type,
-            metadata: { dependencies: dependencies }
+            metadata: {
+              dependencies: dependencies
+            }
           })
           validate_processor_result!(result)
           source = result.delete(:data)
@@ -147,12 +197,14 @@ module Sprockets
           metadata[:charset] = source.encoding.name.downcase unless metadata.key?(:charset)
           metadata[:digest]  = digest(source)
           metadata[:length]  = source.bytesize
+          metadata[:environment_version] = version
         else
           dependencies << build_file_digest_uri(unloaded.filename)
           metadata = {
             digest: file_digest(unloaded.filename),
             length: self.stat(unloaded.filename).size,
-            dependencies: dependencies
+            dependencies: dependencies,
+            environment_version: version,
           }
         end
 
@@ -168,20 +220,9 @@ module Sprockets
           dependencies_digest: DigestUtils.digest(resolve_dependencies(metadata[:dependencies]))
         }
 
-        asset[:id]  = pack_hexdigest(digest(asset))
+        asset[:id]  = hexdigest(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
@@ -203,38 +244,17 @@ module Sprockets
         if cached_asset[:metadata]
           # Deep dup to avoid modifying `asset`
           cached_asset[:metadata] = cached_asset[:metadata].dup
-          if cached_asset[:metadata][:included] && !cached_asset[:metadata][:included].empty?
-            cached_asset[:metadata][:included] = cached_asset[:metadata][:included].dup
-            cached_asset[:metadata][:included].map! { |uri| compress_from_root(uri) }
-          end
-
-          if cached_asset[:metadata][:links] && !cached_asset[:metadata][:links].empty?
-            cached_asset[:metadata][:links] = cached_asset[:metadata][:links].dup
-            cached_asset[:metadata][:links].map! { |uri| compress_from_root(uri) }
-          end
-
-          if cached_asset[:metadata][:stubbed] && !cached_asset[:metadata][:stubbed].empty?
-            cached_asset[:metadata][:stubbed] = cached_asset[:metadata][:stubbed].dup
-            cached_asset[:metadata][:stubbed].map! { |uri| compress_from_root(uri) }
-          end
-
-          if cached_asset[:metadata][:required] && !cached_asset[:metadata][:required].empty?
-            cached_asset[:metadata][:required] = cached_asset[:metadata][:required].dup
-            cached_asset[:metadata][:required].map! { |uri| compress_from_root(uri) }
-          end
-
-          if cached_asset[:metadata][:dependencies] && !cached_asset[:metadata][:dependencies].empty?
-            cached_asset[:metadata][:dependencies] = cached_asset[:metadata][:dependencies].dup
-            cached_asset[:metadata][:dependencies].map! do |uri|
-              uri.start_with?("file-digest://".freeze) ? compress_from_root(uri) : uri
-            end
-          end
+          compress_key_from_hash(cached_asset[:metadata], :included)
+          compress_key_from_hash(cached_asset[:metadata], :links)
+          compress_key_from_hash(cached_asset[:metadata], :stubbed)
+          compress_key_from_hash(cached_asset[:metadata], :required)
+          compress_key_from_hash(cached_asset[:metadata], :to_load)
+          compress_key_from_hash(cached_asset[:metadata], :to_link)
+          compress_key_from_hash(cached_asset[:metadata], :dependencies) { |uri| uri.start_with?("file-digest://") }
 
-          # compress all _dependencies in metadata like `sass_dependencies`
           cached_asset[:metadata].each do |key, value|
-            next unless key =~ /_dependencies\z/
-            cached_asset[:metadata][key] = value.dup
-            cached_asset[:metadata][key].map! {|uri| compress_from_root(uri) }
+            next unless key.match?(/_dependencies\z/) # rubocop:disable Performance/EndWith
+            compress_key_from_hash(cached_asset[:metadata], key)
           end
         end
 
@@ -255,11 +275,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
       #
@@ -271,14 +291,14 @@ module Sprockets
       # Internal: Retrieves an asset based on its digest
       #
       # unloaded - An UnloadedAsset
-      # limit    - A Fixnum which sets the maximum number of versions of "histories"
+      # limit    - An Integer which sets the maximum number of versions of "histories"
       #            stored in the cache
       #
       # 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 +309,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

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
 require 'json'
 require 'time'
 
 require 'concurrent'
 
 require 'sprockets/manifest_utils'
-require 'sprockets/utils/gzip'
 
 module Sprockets
   # The Manifest logs the contents of assets compiled to a single directory. It
@@ -15,7 +15,7 @@ module Sprockets
   # The JSON is part of the public API and should be considered stable. This
   # should make it easy to read from other programming languages and processes
   # that don't have sprockets loaded. See `#assets` and `#files` for more
-  # infomation about the structure.
+  # information about the structure.
   class Manifest
     include ManifestUtils
 
@@ -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
+        @filename = find_directory_manifest(@directory, logger)
       end
 
       unless @directory && @filename
@@ -118,32 +112,22 @@ module Sprockets
     # Public: Find all assets matching pattern set in environment.
     #
     # Returns Enumerator of Assets.
-    def find(*args)
+    def find(*args, &block)
       unless environment
         raise Error, "manifest requires environment for compilation"
       end
 
       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|
-        environment.find_all_linked_assets(path) do |asset|
-          yield asset
+      promises = args.flatten.map do |path|
+        Concurrent::Promise.execute(executor: executor) do
+          environment.find_all_linked_assets(path).to_a
         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
+      promises.each do |promise|
+        promise.value!.each(&block)
       end
 
       nil
@@ -167,7 +151,7 @@ module Sprockets
       end
     end
 
-    # Compile and write asset to directory. The asset is written to a
+    # Compile asset to directory. The asset is written to a
     # fingerprinted filename like
     # `application-2e8e9a7c6b0aafa0c9bdeec90ea30213.js`. An entry is
     # also inserted into the manifest file.
@@ -179,14 +163,19 @@ module Sprockets
         raise Error, "manifest requires environment for compilation"
       end
 
-      filenames              = []
-      concurrent_compressors = []
-      concurrent_writers     = []
+      filenames            = []
+      concurrent_exporters = []
 
+      assets_to_export = Concurrent::Array.new
       find(*args) do |asset|
+        assets_to_export << asset
+      end
+
+      assets_to_export.each do |asset|
+        mtime = Time.now.iso8601
         files[asset.digest_path] = {
           'logical_path' => asset.logical_path,
-          'mtime'        => asset.mtime.iso8601,
+          'mtime'        => mtime,
           'size'         => asset.bytesize,
           'digest'       => asset.hexdigest,
 
@@ -197,38 +186,23 @@ 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)
-          logger.debug "Skipping #{target}, already exists"
-        else
-          logger.info "Writing #{target}"
-          write_file = Concurrent::Future.execute { asset.write_to target }
-          concurrent_writers << write_file
-        end
         filenames << asset.filename
 
-        next if environment.skip_gzip?
-        gzip = Utils::Gzip.new(asset)
-        next if gzip.cannot_compress?(environment.mime_types)
+        promise      = nil
+        exporters_for_asset(asset) do |exporter|
+          next if exporter.skip?(logger)
 
-        if File.exist?("#{target}.gz")
-          logger.debug "Skipping #{target}.gz, already exists"
-        else
-          logger.info "Writing #{target}.gz"
-          concurrent_compressors << Concurrent::Future.execute do
-            write_file.wait! if write_file
-            gzip.compress(target)
+          if promise.nil?
+            promise = Concurrent::Promise.new(executor: executor) { exporter.call }
+            concurrent_exporters << promise.execute
+          else
+            concurrent_exporters << promise.then { exporter.call }
           end
         end
-
       end
-      concurrent_writers.each(&:wait!)
-      concurrent_compressors.each(&:wait!)
+
+      # make sure all exporters have finished before returning the main thread
+      concurrent_exporters.each(&:wait!)
       save
 
       filenames
@@ -295,18 +269,13 @@ module Sprockets
     def clobber
       FileUtils.rm_r(directory) if File.exist?(directory)
       logger.info "Removed #{directory}"
+      # if we have an environment clear the cache too
+      environment.cache.clear if environment
       nil
     end
 
-    # Persist manfiest back to FS
+    # Persist manifest 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|
@@ -315,6 +284,36 @@ module Sprockets
     end
 
     private
+
+      # Given an asset, finds all exporters that
+      # match its mime-type.
+      #
+      # Will yield each expoter to the passed in block.
+      #
+      #     array = []
+      #     puts asset.content_type # => "application/javascript"
+      #     exporters_for_asset(asset) do |exporter|
+      #       array << exporter
+      #     end
+      #     # puts array => [Exporters::FileExporter, Exporters::ZlibExporter]
+      def exporters_for_asset(asset)
+        exporters = [Exporters::FileExporter]
+
+        environment.exporters.each do |mime_type, exporter_list|
+          next unless asset.content_type
+          next unless environment.match_mime_type? asset.content_type, mime_type
+          exporter_list.each do |exporter|
+            exporters << exporter
+          end
+        end
+
+        exporters.uniq!
+
+        exporters.each do |exporter|
+          yield exporter.new(asset: asset, environment: environment, directory: dir)
+        end
+      end
+
       def json_decode(obj)
         JSON.parse(obj, create_additions: false)
       end
@@ -332,5 +331,9 @@ module Sprockets
           logger
         end
       end
+
+      def executor
+        @executor ||= environment.export_concurrent ? :fast : :immediate
+      end
   end
 end

data/lib/sprockets/manifest_utils.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'securerandom'
+require 'logger'
 
 module Sprockets
   # Public: Manifest utilities.
@@ -6,7 +8,6 @@ module Sprockets
     extend self
 
     MANIFEST_RE = /^\.sprockets-manifest-[0-9a-f]{32}.json$/
-    LEGACY_MANIFEST_RE = /^manifest(-[0-9a-f]{32})?.json$/
 
     # Public: Generate a new random manifest path.
     #
@@ -33,12 +34,14 @@ module Sprockets
     #     # => "/app/public/assets/.sprockets-manifest-abc123.json"
     #
     # Returns String filename.
-    def find_directory_manifest(dirname)
+    def find_directory_manifest(dirname, logger = Logger.new($stderr))
       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
+      manifest_entries = entries.select { |e| e =~ MANIFEST_RE }
+      if manifest_entries.length > 1
+        manifest_entries.sort!
+        logger.warn("Found multiple manifests: #{manifest_entries}. Choosing the first alphabetically: #{manifest_entries.first}")
+      end
+      entry = manifest_entries.first || generate_manifest_path
       File.join(dirname, entry)
     end
   end

data/lib/sprockets/mime.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/encoding_utils'
 require 'sprockets/http_utils'
 require 'sprockets/utils'
@@ -36,29 +37,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,34 +87,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 = {}
-
-        ([nil] + pipelines.keys.map(&:to_s)).each do |pipeline|
-          pipeline_extname = ".#{pipeline}" if pipeline
-          ([[nil, nil]] + config[:mime_exts].to_a).each do |format_extname, format_type|
-            4.times do |n|
-              config[:engines].keys.permutation(n).each do |engine_extnames|
-                key = "#{pipeline_extname}#{format_extname}#{engine_extnames.join}"
-                type = format_type || config[:engine_mime_types][engine_extnames.first]
-                graph[key] = {type: type, engines: engine_extnames, pipeline: pipeline}
-              end
-            end
-          end
-        end
-
-        graph
-      end
   end
 end

data/lib/sprockets/npm.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require 'json'
+
+module Sprockets
+  module Npm
+    # Internal: Override resolve_alternates to install package.json behavior.
+    #
+    # load_path    - String environment path
+    # logical_path - String path relative to base
+    #
+    # Returns candidate filenames.
+    def resolve_alternates(load_path, logical_path)
+      candidates, deps = super
+
+      dirname = File.join(load_path, logical_path)
+
+      if directory?(dirname)
+        filename = File.join(dirname, 'package.json')
+
+        if self.file?(filename)
+          deps << build_file_digest_uri(filename)
+          read_package_directives(dirname, filename) do |path|
+            if file?(path)
+              candidates << path
+            end
+          end
+        end
+      end
+
+      return candidates, deps
+    end
+
+    # Internal: Read package.json's main and style directives.
+    #
+    # dirname  - String path to component directory.
+    # filename - String path to package.json.
+    #
+    # Returns nothing.
+    def read_package_directives(dirname, filename)
+      package = JSON.parse(File.read(filename), create_additions: false)
+
+      case package['main']
+      when String
+        yield File.expand_path(package['main'], dirname)
+      when nil
+        yield File.expand_path('index.js', dirname)
+      end
+
+      yield File.expand_path(package['style'], dirname) if package['style']
+    end
+  end
+end