sprockets 3.0.0 → 3.7.2

data/lib/sprockets/cache.rb

@@ -60,7 +60,7 @@ module Sprockets
     # cache - A compatible backend cache store instance.
     def initialize(cache = nil, logger = self.class.default_logger)
       @cache_wrapper = get_cache_wrapper(cache)
-      @fetch_cache   = Cache::MemoryStore.new(4096)
+      @fetch_cache   = Cache::MemoryStore.new(1024)
       @logger        = logger
     end
 
@@ -97,7 +97,7 @@ module Sprockets
     # Public: Low level API to retrieve item directly from the backend cache
     # store.
     #
-    # This API may be used publicaly, but may have undefined behavior
+    # This API may be used publicly, but may have undefined behavior
     # depending on the backend store being used. Prefer the
     # Cache#fetch API over using this.
     #
@@ -120,7 +120,7 @@ module Sprockets
 
     # Public: Low level API to set item directly to the backend cache store.
     #
-    # This API may be used publicaly, but may have undefined behavior
+    # This API may be used publicly, but may have undefined behavior
     # depending on the backend store being used. Prefer the
     # Cache#fetch API over using this.
     #
@@ -153,7 +153,9 @@ module Sprockets
       #
       # Returns a String with a length less than 250 characters.
       def expand_key(key)
-        "sprockets/v#{VERSION}/#{DigestUtils.pack_urlsafe_base64digest(DigestUtils.digest(key))}"
+        digest_key = DigestUtils.pack_urlsafe_base64digest(DigestUtils.digest(key))
+        namespace = digest_key[0, 2]
+        "sprockets/v#{VERSION}/#{namespace}/#{digest_key}"
       end
 
       PEEK_SIZE = 100

data/lib/sprockets/closure_compressor.rb

@@ -1,4 +1,5 @@
 require 'sprockets/autoload'
+require 'sprockets/digest_utils'
 
 module Sprockets
   # Public: Closure Compiler minifier.
@@ -34,20 +35,13 @@ module Sprockets
     attr_reader :cache_key
 
     def initialize(options = {})
-      @compiler = Autoload::Closure::Compiler.new(options)
-      @cache_key = [
-        self.class.name,
-        Autoload::Closure::VERSION,
-        Autoload::Closure::COMPILER_VERSION,
-        VERSION,
-        options
-      ].freeze
+      @options = options
+      @cache_key = "#{self.class.name}:#{Autoload::Closure::VERSION}:#{Autoload::Closure::COMPILER_VERSION}:#{VERSION}:#{DigestUtils.digest(options)}".freeze
     end
 
     def call(input)
-      input[:cache].fetch(@cache_key + [input[:data]]) do
-        @compiler.compile(input[:data])
-      end
+      @compiler ||= Autoload::Closure::Compiler.new(@options)
+      @compiler.compile(input[:data])
     end
   end
 end

data/lib/sprockets/coffee_script_processor.rb

@@ -12,12 +12,12 @@ module Sprockets
     VERSION = '1'
 
     def self.cache_key
-      @cache_key ||= [name, Autoload::CoffeeScript::Source.version, VERSION].freeze
+      @cache_key ||= "#{name}:#{Autoload::CoffeeScript::Source.version}:#{VERSION}".freeze
     end
 
     def self.call(input)
       data = input[:data]
-      input[:cache].fetch(self.cache_key + [data]) do
+      input[:cache].fetch([self.cache_key, data]) do
         Autoload::CoffeeScript.compile(data)
       end
     end

data/lib/sprockets/coffee_script_template.rb

@@ -2,5 +2,16 @@ require 'sprockets/coffee_script_processor'
 
 module Sprockets
   # Deprecated
-  CoffeeScriptTemplate = CoffeeScriptProcessor
+  module CoffeeScriptTemplate
+    VERSION = CoffeeScriptProcessor::VERSION
+
+    def self.cache_key
+      CoffeeScriptProcessor.cache_key
+    end
+
+    def self.call(*args)
+      Deprecation.new.warn "CoffeeScriptTemplate is deprecated please use CoffeeScriptProcessor instead"
+      CoffeeScriptProcessor.call(*args)
+    end
+  end
 end

data/lib/sprockets/compressing.rb

@@ -70,5 +70,25 @@ module Sprockets
 
       register_bundle_processor 'application/javascript', klass
     end
+
+    # Public: Checks if Gzip is enabled.
+    def gzip?
+      config[:gzip_enabled]
+    end
+
+    # Public: Checks if Gzip is disabled.
+    def skip_gzip?
+      !gzip?
+    end
+
+    # Public: Enable or disable the creation of Gzip files.
+    #
+    # Defaults to true.
+    #
+    #     environment.gzip = false
+    #
+    def gzip=(gzip)
+      self.config = config.merge(gzip_enabled: gzip).freeze
+    end
   end
 end

data/lib/sprockets/context.rb

@@ -108,7 +108,9 @@ module Sprockets
     # the dependency file with invalidate the cache of the
     # source file.
     def depend_on(path)
-      if environment.absolute_path?(path) && environment.directory?(path)
+      path = path.to_s if path.is_a?(Pathname)
+
+      if environment.absolute_path?(path) && environment.stat(path)
         @dependencies << environment.build_file_digest_uri(path)
       else
         resolve(path, compat: false)

data/lib/sprockets/dependencies.rb

@@ -51,18 +51,18 @@ module Sprockets
     end
     alias_method :depend_on, :add_dependency
 
-    # Internal: Resolve set of dependency URIs.
-    #
-    # Returns Array of resolved Objects.
-    def resolve_dependencies(uris)
-      uris.map { |uri| resolve_dependency(uri) }
-    end
-
     # Internal: Resolve dependency URIs.
     #
     # Returns resolved Object.
     def resolve_dependency(str)
-      scheme = str[/([^:]+)/, 1]
+      # Optimize for the most common scheme to
+      # save 22k allocations on an average Spree app.
+      scheme = if str.start_with?('file-digest:'.freeze)
+        'file-digest'.freeze
+      else
+        str[/([^:]+)/, 1]
+      end
+
       if resolver = config[:dependency_resolvers][scheme]
         resolver.call(self, str)
       else

data/lib/sprockets/deprecation.rb

@@ -0,0 +1,90 @@
+module Sprockets
+  class Deprecation
+    THREAD_LOCAL__SILENCE_KEY = "_sprockets_deprecation_silence".freeze
+    DEFAULT_BEHAVIORS = {
+      raise: ->(message, callstack) {
+        e = DeprecationException.new(message)
+        e.set_backtrace(callstack.map(&:to_s))
+        raise e
+      },
+
+      stderr: ->(message, callstack) {
+        $stderr.puts(message)
+      },
+    }
+
+    attr_reader :callstack
+
+    def self.silence(&block)
+      Thread.current[THREAD_LOCAL__SILENCE_KEY] = true
+      block.call
+    ensure
+      Thread.current[THREAD_LOCAL__SILENCE_KEY] = false
+    end
+
+    def initialize(callstack = nil)
+      @callstack = callstack || caller(2)
+    end
+
+    def warn(message)
+      return if Thread.current[THREAD_LOCAL__SILENCE_KEY]
+      deprecation_message(message).tap do |m|
+        behavior.each { |b| b.call(m, callstack) }
+      end
+    end
+
+    private
+      def behavior
+        @behavior ||= [DEFAULT_BEHAVIORS[:stderr]]
+      end
+
+      def behavior=(behavior)
+        @behavior = Array(behavior).map { |b| DEFAULT_BEHAVIORS[b] || b }
+      end
+
+      def deprecation_message(message = nil)
+        message ||= "You are using deprecated behavior which will be removed from the next major or minor release."
+        "DEPRECATION WARNING: #{message} #{ deprecation_caller_message }"
+      end
+
+      def deprecation_caller_message
+        file, line, method = extract_callstack
+        if file
+          if line && method
+            "(called from #{method} at #{file}:#{line})"
+          else
+            "(called from #{file}:#{line})"
+          end
+        end
+      end
+
+      SPROCKETS_GEM_ROOT = File.expand_path("../../../../..", __FILE__) + "/"
+
+      def ignored_callstack(path)
+        path.start_with?(SPROCKETS_GEM_ROOT) || path.start_with?(RbConfig::CONFIG['rubylibdir'])
+      end
+
+      def extract_callstack
+        return _extract_callstack if callstack.first.is_a? String
+
+        offending_line = callstack.find { |frame|
+          frame.absolute_path && !ignored_callstack(frame.absolute_path)
+        } || callstack.first
+
+        [offending_line.path, offending_line.lineno, offending_line.label]
+      end
+
+      def _extract_callstack
+        offending_line = callstack.find { |line| !ignored_callstack(line) } || callstack.first
+
+        if offending_line
+          if md = offending_line.match(/^(.+?):(\d+)(?::in `(.*?)')?/)
+            md.captures
+          else
+            offending_line
+          end
+        end
+      end
+  end
+  private_constant :Deprecation
+end

data/lib/sprockets/digest_utils.rb

@@ -34,6 +34,56 @@ module Sprockets
       DIGEST_SIZES[bytes.bytesize]
     end
 
+    ADD_VALUE_TO_DIGEST = {
+      String     => ->(val, digest) { digest << val },
+      FalseClass => ->(val, digest) { digest << 'FalseClass'.freeze },
+      TrueClass  => ->(val, digest) { digest << 'TrueClass'.freeze  },
+      NilClass   => ->(val, digest) { digest << 'NilClass'.freeze   },
+
+      Symbol => ->(val, digest) {
+        digest << 'Symbol'.freeze
+        digest << val.to_s
+      },
+      Integer => ->(val, digest) {
+        digest << 'Integer'.freeze
+        digest << val.to_s
+      },
+      Array => ->(val, digest) {
+        digest << 'Array'.freeze
+        val.each do |element|
+          ADD_VALUE_TO_DIGEST[element.class].call(element, digest)
+        end
+      },
+      Hash => ->(val, digest) {
+        digest << 'Hash'.freeze
+        val.sort.each do |array|
+          ADD_VALUE_TO_DIGEST[Array].call(array, digest)
+        end
+      },
+      Set => ->(val, digest) {
+        digest << 'Set'.freeze
+        ADD_VALUE_TO_DIGEST[Array].call(val.to_a, digest)
+      },
+      Encoding => ->(val, digest) {
+        digest << 'Encoding'.freeze
+        digest << val.name
+      },
+    }
+    if 0.class != Integer # Ruby < 2.4
+      ADD_VALUE_TO_DIGEST[Fixnum] = ->(val, digest) {
+        digest << 'Integer'.freeze
+        digest << val.to_s
+      }
+      ADD_VALUE_TO_DIGEST[Bignum] = ->(val, digest) {
+        digest << 'Integer'.freeze
+        digest << val.to_s
+      }
+    end
+    ADD_VALUE_TO_DIGEST.default_proc = ->(_, val) {
+      raise TypeError, "couldn't digest #{ val }"
+    }
+    private_constant :ADD_VALUE_TO_DIGEST
+
     # Internal: Generate a hexdigest for a nested JSON serializable object.
     #
     # This is used for generating cache keys, so its pretty important its
@@ -44,46 +94,8 @@ module Sprockets
     # Returns a String digest of the object.
     def digest(obj)
       digest = digest_class.new
-      queue  = [obj]
-
-      while queue.length > 0
-        obj = queue.shift
-        klass = obj.class
-
-        if klass == String
-          digest << obj
-        elsif klass == Symbol
-          digest << 'Symbol'
-          digest << obj.to_s
-        elsif klass == Fixnum
-          digest << 'Fixnum'
-          digest << obj.to_s
-        elsif klass == Bignum
-          digest << 'Bignum'
-          digest << obj.to_s
-        elsif klass == TrueClass
-          digest << 'TrueClass'
-        elsif klass == FalseClass
-          digest << 'FalseClass'
-        elsif klass == NilClass
-          digest << 'NilClass'
-        elsif klass == Array
-          digest << 'Array'
-          queue.concat(obj)
-        elsif klass == Hash
-          digest << 'Hash'
-          queue.concat(obj.sort)
-        elsif klass == Set
-          digest << 'Set'
-          queue.concat(obj.to_a)
-        elsif klass == Encoding
-          digest << 'Encoding'
-          digest << obj.name
-        else
-          raise TypeError, "couldn't digest #{klass}"
-        end
-      end
 
+      ADD_VALUE_TO_DIGEST[obj.class].call(obj, digest)
       digest.digest
     end
 
@@ -96,6 +108,15 @@ module Sprockets
       bin.unpack('H*').first
     end
 
+    # Internal: Unpack a hex encoded digest string into binary bytes.
+    #
+    # hex - String hex
+    #
+    # Returns binary String.
+    def unpack_hexdigest(hex)
+      [hex].pack('H*')
+    end
+
     # Internal: Pack a binary digest to a base64 encoded string.
     #
     # bin - String bytes
@@ -117,25 +138,20 @@ module Sprockets
       str
     end
 
-    # Internal: Maps digest class to the named information hash algorithm name.
-    #
-    # http://www.iana.org/assignments/named-information/named-information.xhtml
-    NI_HASH_ALGORITHMS = {
-      Digest::SHA256 => 'sha-256'.freeze,
-      Digest::SHA384 => 'sha-384'.freeze,
-      Digest::SHA512 => 'sha-512'.freeze
+    # Internal: Maps digest class to the CSP hash algorithm name.
+    HASH_ALGORITHMS = {
+      Digest::SHA256 => 'sha256'.freeze,
+      Digest::SHA384 => 'sha384'.freeze,
+      Digest::SHA512 => 'sha512'.freeze
     }
 
-    # Internal: Generate a "named information" URI for use in the `integrity`
-    # attribute of an asset tag as per the subresource integrity specification.
+    # Public: Generate hash for use in the `integrity` attribute of an asset tag
+    # as per the subresource integrity specification.
     #
-    # digest       - The String byte digest of the asset content.
-    # content_type - The content-type the asset will be served with. This *must*
-    #                be accurate if provided. Otherwise, subresource integrity
-    #                will block the loading of the asset.
+    # digest - The String byte digest of the asset content.
     #
     # Returns a String or nil if hash algorithm is incompatible.
-    def integrity_uri(digest, content_type = nil)
+    def integrity_uri(digest)
       case digest
       when Digest::Base
         digest_class = digest.class
@@ -146,11 +162,19 @@ module Sprockets
         raise TypeError, "unknown digest: #{digest.inspect}"
       end
 
-      if hash_name = NI_HASH_ALGORITHMS[digest_class]
-        uri = "ni:///#{hash_name};#{pack_urlsafe_base64digest(digest)}"
-        uri << "?ct=#{content_type}" if content_type
-        uri
+      if hash_name = HASH_ALGORITHMS[digest_class]
+        "#{hash_name}-#{pack_base64digest(digest)}"
       end
     end
+
+    # Public: Generate hash for use in the `integrity` attribute of an asset tag
+    # as per the subresource integrity specification.
+    #
+    # digest - The String hexbyte digest of the asset content.
+    #
+    # Returns a String or nil if hash algorithm is incompatible.
+    def hexdigest_integrity_uri(hexdigest)
+      integrity_uri(unpack_hexdigest(hexdigest))
+    end
   end
 end

data/lib/sprockets/eco_processor.rb

@@ -12,7 +12,7 @@ module Sprockets
     VERSION = '1'
 
     def self.cache_key
-      @cache_key ||= [name, Autoload::Eco::Source::VERSION, VERSION].freeze
+      @cache_key ||= "#{name}:#{Autoload::Eco::Source::VERSION}:#{VERSION}".freeze
     end
 
     # Compile template data with Eco compiler.
@@ -24,7 +24,7 @@ module Sprockets
     #
     def self.call(input)
       data = input[:data]
-      input[:cache].fetch(cache_key + [data]) do
+      input[:cache].fetch([cache_key, data]) do
         Autoload::Eco.compile(data)
       end
     end

data/lib/sprockets/eco_template.rb

@@ -2,5 +2,16 @@ require 'sprockets/eco_processor'
 
 module Sprockets
   # Deprecated
-  EcoTemplate = EcoProcessor
+  module EcoTemplate
+    VERSION = EcoProcessor::VERSION
+
+    def self.cache_key
+      EcoProcessor.cache_key
+    end
+
+    def self.call(*args)
+      Deprecation.new.warn "EcoTemplate is deprecated please use EcoProcessor instead"
+      EcoProcessor.call(*args)
+    end
+  end
 end

data/lib/sprockets/ejs_processor.rb

@@ -11,7 +11,7 @@ module Sprockets
     VERSION = '1'
 
     def self.cache_key
-      @cache_key ||= [name, VERSION].freeze
+      @cache_key ||= "#{name}:#{VERSION}".freeze
     end
 
     # Compile template data with EJS compiler.
@@ -23,7 +23,7 @@ module Sprockets
     #
     def self.call(input)
       data = input[:data]
-      input[:cache].fetch(cache_key + [data]) do
+      input[:cache].fetch([cache_key, data]) do
         Autoload::EJS.compile(data)
       end
     end

data/lib/sprockets/ejs_template.rb

@@ -2,5 +2,16 @@ require 'sprockets/ejs_processor'
 
 module Sprockets
   # Deprecated
-  EjsTemplate = EjsProcessor
+  module EjsTemplate
+    VERSION = EjsProcessor::VERSION
+
+    def self.cache_key
+      EjsProcessor.cache_key
+    end
+
+    def self.call(*args)
+      Deprecation.new.warn "EjsTemplate is deprecated please use EjsProcessor instead"
+      EjsProcessor.call(*args)
+    end
+  end
 end

data/lib/sprockets/encoding_utils.rb

@@ -104,7 +104,7 @@ module Sprockets
         charlock_detect(str)
       end
 
-      # Fallback to UTF-8
+      # Fallback to environment's external encoding
       if str.encoding == Encoding::BINARY
         str.force_encoding(Encoding.default_external)
       end
@@ -233,7 +233,10 @@ module Sprockets
       nil
     end
 
-    # Public: Detect charset from HTML document. Defaults to ISO-8859-1.
+    # Public: Detect charset from HTML document.
+    #
+    # Attempts to parse any Unicode BOM otherwise attempt Charlock detection
+    # and finally falls back to the environment's external encoding.
     #
     # str - String.
     #
@@ -246,9 +249,9 @@ module Sprockets
         charlock_detect(str)
       end
 
-      # Fallback to ISO-8859-1
+      # Fallback to environment's external encoding
       if str.encoding == Encoding::BINARY
-        str.force_encoding(Encoding::ISO_8859_1)
+        str.force_encoding(Encoding.default_external)
       end
 
       str

data/lib/sprockets/engines.rb

@@ -51,6 +51,17 @@ module Sprockets
     #     environment.register_engine '.coffee', CoffeeScriptProcessor
     #
     def register_engine(ext, klass, options = {})
+      unless options[:silence_deprecation]
+        msg = <<-MSG
+Sprockets method `register_engine` is deprecated.
+Please register a mime type using `register_mime_type` then
+use `register_compressor` or `register_transformer`.
+https://github.com/rails/sprockets/blob/master/guides/extending_sprockets.md#supporting-all-versions-of-sprockets-in-processors
+        MSG
+
+        Deprecation.new([caller.first]).warn(msg)
+      end
+
       ext = Sprockets::Utils.normalize_extension(ext)
 
       self.computed_config = {}

data/lib/sprockets/erb_template.rb

@@ -2,5 +2,10 @@ require 'sprockets/erb_processor'
 
 module Sprockets
   # Deprecated
-  ERBTemplate = ERBProcessor
+  class ERBTemplate < ERBProcessor
+    def call(*args)
+      Deprecation.new.warn "ERBTemplate is deprecated please use ERBProcessor instead"
+      super
+    end
+  end
 end

data/lib/sprockets/errors.rb

@@ -8,5 +8,4 @@ module Sprockets
   class ConversionError         < NotFound; end
   class FileNotFound            < NotFound; end
   class FileOutsidePaths        < NotFound; end
-  class VersionNotFound         < NotFound; end
 end

data/lib/sprockets/http_utils.rb

@@ -76,7 +76,9 @@ module Sprockets
         end
       end
 
-      matches.sort_by { |match, quality| -quality }.map { |match, quality| match }
+      matches.sort_by! { |match, quality| -quality }
+      matches.map! { |match, quality| match }
+      matches
     end
 
     # Internal: Find the best qvalue match from an Array of available options.

data/lib/sprockets/legacy.rb

@@ -128,6 +128,12 @@ module Sprockets
       cache.set(key, value)
     end
 
+    def normalize_logical_path(path)
+      dirname, basename = File.split(path)
+      path = dirname if basename == 'index'
+      path
+    end
+
     private
       # Deprecated: Seriously.
       def matches_filter(filters, logical_path, filename)
@@ -297,6 +303,16 @@ module Sprockets
         str !~ /\*|\*\*|\?|\[|\]|\{|\}/
     end
 
+    def self.compute_alias_logical_path(path)
+      dirname, basename = File.split(path)
+      extname = File.extname(basename)
+      if File.basename(basename, extname) == 'index'
+        "#{dirname}#{extname}"
+      else
+        nil
+      end
+    end
+
     # Deprecated: Filter logical paths in environment. Useful for selecting what
     # files you want to compile.
     #

data/lib/sprockets/legacy_proc_processor.rb

@@ -29,7 +29,7 @@ module Sprockets
     def call(input)
       context = input[:environment].context_class.new(input)
       data = @proc.call(context, input[:data])
-      context.metadata.merge(data: data)
+      context.metadata.merge(data: data.to_str)
     end
   end
 end

data/lib/sprockets/legacy_tilt_processor.rb

@@ -22,8 +22,8 @@ module Sprockets
       data     = input[:data]
       context  = input[:environment].context_class.new(input)
 
-      data = @klass.new(filename) { data }.render(context)
-      context.metadata.merge(data: data)
+      data = @klass.new(filename) { data }.render(context, {})
+      context.metadata.merge(data: data.to_str)
     end
   end
 end