sprockets 3.7.2 → 4.0.2

data/lib/sprockets/exporters/file_exporter.rb

@@ -0,0 +1,24 @@
+require 'sprockets/exporters/base'
+
+module Sprockets
+  module Exporters
+    # Writes a an asset file to disk
+    class FileExporter < Exporters::Base
+      def skip?(logger)
+        if ::File.exist?(target)
+          logger.debug "Skipping #{ target }, already exists"
+          true
+        else
+          logger.info "Writing #{ target }"
+          false
+        end
+      end
+
+      def call
+        write(target) do |file|
+          file.write(asset.source)
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/exporters/zlib_exporter.rb

@@ -0,0 +1,33 @@
+require 'sprockets/exporters/base'
+require 'sprockets/utils/gzip'
+
+module Sprockets
+  module Exporters
+    # Generates a `.gz` file using the zlib algorithm built into
+    # Ruby's standard library.
+    class ZlibExporter < Exporters::Base
+      def setup
+        @gzip_target = "#{ target }.gz"
+        @gzip = Sprockets::Utils::Gzip.new(asset, archiver: Utils::Gzip::ZlibArchiver)
+      end
+
+      def skip?(logger)
+        return true if environment.skip_gzip?
+        return true if @gzip.cannot_compress?
+        if ::File.exist?(@gzip_target)
+          logger.debug "Skipping #{ @gzip_target }, already exists"
+          true
+        else
+          logger.info "Writing #{ @gzip_target }"
+          false
+        end
+      end
+
+      def call
+        write(@gzip_target) do |file|
+          @gzip.compress(file, target)
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/exporters/zopfli_exporter.rb

@@ -0,0 +1,14 @@
+require 'sprockets/exporters/zlib_exporter'
+
+module Sprockets
+  module Exporters
+    # Generates a `.gz` file using the zopfli algorithm from the
+    # Zopfli gem.
+    class ZopfliExporter < ZlibExporter
+      def setup
+        @gzip_target = "#{ target }.gz"
+        @gzip = Sprockets::Utils::Gzip.new(asset, archiver: Utils::Gzip::ZopfliArchiver)
+      end
+    end
+  end
+end

data/lib/sprockets/exporting.rb

@@ -0,0 +1,73 @@
+module Sprockets
+  # `Exporting` is an internal mixin whose public methods are exposed on
+  # the `Environment` and `CachedEnvironment` classes.
+  module Exporting
+    # Exporters are ran on the assets:precompile task
+    def exporters
+      config[:exporters]
+    end
+
+    # Public: Registers a new Exporter `klass` for `mime_type`.
+    #
+    # If your exporter depends on one or more other exporters you can
+    # specify this via the `depend_on` keyword.
+    #
+    #     register_exporter '*/*', Sprockets::Exporters::ZlibExporter
+    #
+    # This ensures that `Sprockets::Exporters::File` will always execute before
+    # `Sprockets::Exporters::Zlib`
+    def register_exporter(mime_types, klass = nil)
+      mime_types = Array(mime_types)
+
+      mime_types.each do |mime_type|
+        self.config = hash_reassoc(config, :exporters, mime_type) do |_exporters|
+          _exporters << klass
+        end
+      end
+    end
+
+    # Public: Remove Exporting processor `klass` for `mime_type`.
+    #
+    #     environment.unregister_exporter '*/*', Sprockets::Exporters::Zlib
+    #
+    # Can be called without a mime type
+    #
+    #     environment.unregister_exporter Sprockets::Exporters::Zlib
+    #
+    # Does not remove any exporters that depend on `klass`.
+    def unregister_exporter(mime_types, exporter = nil)
+      unless mime_types.is_a? Array
+        if mime_types.is_a? String
+          mime_types = [mime_types]
+        else # called with no mime type
+          exporter = mime_types
+          mime_types = nil
+        end
+      end
+
+      self.config = hash_reassoc(config, :exporters) do |_exporters|
+        _exporters.each do |mime_type, exporters_array|
+          next if mime_types && !mime_types.include?(mime_type)
+          if exporters_array.include? exporter
+            _exporters[mime_type] = exporters_array.dup.delete exporter
+          end
+        end
+      end
+    end
+
+    # Public: Checks if concurrent exporting is allowed
+    def export_concurrent
+      config[:export_concurrent]
+    end
+
+    # Public: Enable or disable the concurrently exporting files
+    #
+    # Defaults to true.
+    #
+    #     environment.export_concurrent = false
+    #
+    def export_concurrent=(export_concurrent)
+      self.config = config.merge(export_concurrent: export_concurrent).freeze
+    end
+  end
+end

data/lib/sprockets/file_reader.rb

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

data/lib/sprockets/http_utils.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sprockets
   # Internal: HTTP URI utilities. Many adapted from Rack::Utils. Mixed into
   # Environment.
@@ -13,9 +14,9 @@ module Sprockets
     # Returns true if the given value is a mime match for the given mime match
     # specification, false otherwise.
     def match_mime_type?(value, matcher)
-      v1, v2 = value.split('/', 2)
-      m1, m2 = matcher.split('/', 2)
-      (m1 == '*' || v1 == m1) && (m2.nil? || m2 == '*' || m2 == v2)
+      v1, v2 = value.split('/'.freeze, 2)
+      m1, m2 = matcher.split('/'.freeze, 2)
+      (m1 == '*'.freeze || v1 == m1) && (m2.nil? || m2 == '*'.freeze || m2 == v2)
     end
 
     # Public: Return values from Hash where the key matches the mime type.
@@ -36,7 +37,22 @@ module Sprockets
 
     # Internal: Parse Accept header quality values.
     #
-    # Adapted from Rack::Utils#q_values.
+    # values - String e.g. "application/javascript"
+    #
+    # Adapted from Rack::Utils#q_values. Quality values are
+    # described in http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
+    #
+    #    parse_q_values("application/javascript")
+    #      # => [["application/javascript", 1.0]]
+    #
+    #    parse_q_values("*/*")
+    #      # => [["*/*", 1.0]]
+    #
+    #    parse_q_values("text/plain; q=0.5, image/*")
+    #      # => [["text/plain", 0.5], ["image/*", 1.0]]
+    #
+    #    parse_q_values("application/javascript, text/css")
+    #      # => [["application/javascript", 1.0], ["text/css", 1.0]]
     #
     # Returns an Array of [String, Float].
     def parse_q_values(values)
@@ -70,14 +86,16 @@ module Sprockets
         raise TypeError, "unknown q_values type: #{q_values.class}"
       end
 
+      i = 0
       q_values.each do |accepted, quality|
         if match = available.find { |option| matcher.call(option, accepted) }
-          matches << [match, quality]
+          i += 1
+          matches << [-quality, i, match]
         end
       end
 
-      matches.sort_by! { |match, quality| -quality }
-      matches.map! { |match, quality| match }
+      matches.sort!
+      matches.map! { |_, _, match| match }
       matches
     end
 

data/lib/sprockets/jsminc_compressor.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'sprockets/autoload'
+require 'sprockets/digest_utils'
+
+module Sprockets
+  class JSMincCompressor
+    VERSION = '1'
+
+    def self.instance
+      @instance ||= new
+    end
+
+    def self.call(input)
+      instance.call(input)
+    end
+
+    def self.cache_key
+      instance.cache_key
+    end
+
+    attr_reader :cache_key
+
+    def initialize(options = {})
+      @compressor_class = Autoload::JSMinC
+      @cache_key = "#{self.class.name}:#{Autoload::JSMinC::VERSION}:#{VERSION}:#{DigestUtils.digest(options)}".freeze
+    end
+
+    def call(input)
+      @compressor_class.minify(input[:data])
+    end
+  end
+end

data/lib/sprockets/jst_processor.rb

@@ -1,21 +1,22 @@
+# frozen_string_literal: true
 module Sprockets
-  # Public: .jst engine.
+  # Public: JST transformer.
   #
   # Exports server side compiled templates to an object.
   #
-  # Name your template "users/show.jst.ejs", "users/new.jst.eco", etc.
+  # Name your template "users/show.ejs", "users/new.eco", etc.
   #
   # To accept the default options
   #
-  #     environment.register_engine '.jst',
-  #       JstProcessor,
-  #       mime_type: 'application/javascript'
+  #     environment.register_transformer
+  #       'application/javascript+function',
+  #       'application/javascript', JstProcessor
   #
   # Change the default namespace.
   #
-  #     environment.register_engine '.jst',
-  #       JstProcessor.new(namespace: 'App.templates'),
-  #       mime_type: 'application/javascript'
+  #     environment.register_transformer
+  #       'application/javascript+function',
+  #       'application/javascript', JstProcessor.new(namespace: 'App.templates')
   #
   class JstProcessor
     def self.default_namespace
@@ -33,8 +34,8 @@ module Sprockets
       instance.call(input)
     end
 
-    def initialize(options = {})
-      @namespace = options[:namespace] || self.class.default_namespace
+    def initialize(namespace: self.class.default_namespace)
+      @namespace = namespace
     end
 
     def call(input)

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
       #
@@ -276,9 +296,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 +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