sprockets 4.0.0 → 4.2.0

data/lib/sprockets/digest_utils.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'digest/md5'
 require 'digest/sha1'
 require 'digest/sha2'
 require 'set'
@@ -19,7 +18,6 @@ module Sprockets
 
     # Internal: Maps digest bytesize to the digest class.
     DIGEST_SIZES = {
-      16 => Digest::MD5,
       20 => Digest::SHA1,
       32 => Digest::SHA256,
       48 => Digest::SHA384,
@@ -68,18 +66,8 @@ module Sprockets
       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.compare_by_identity.rehash
 
@@ -189,6 +177,15 @@ module Sprockets
       integrity_uri(unpack_hexdigest(hexdigest))
     end
 
+    # Internal: Checks an asset name for a valid digest
+    #
+    # name - The name of the asset
+    #
+    # Returns true if the name contains a digest like string and .digested before the extension
+    def already_digested?(name)
+      return name =~ /-([0-9a-zA-Z]{7,128})\.digested/
+    end
+
     private
       def build_digest(obj)
         digest = digest_class.new

data/lib/sprockets/directive_processor.rb

@@ -285,6 +285,24 @@ module Sprockets
         to_load(resolve(path))
       end
 
+      # Allows you to state a dependency on a relative directory
+      # without including it.
+      #
+      # This is used for caching purposes. Any changes made to
+      # the dependency directory will invalidate the cache of the
+      # source file.
+      #
+      # This is useful if you are using ERB and File.read to pull
+      # in contents from multiple files in a directory.
+      #
+      #     //= depend_on_directory ./data
+      #
+      def process_depend_on_directory_directive(path = ".", accept = nil)
+        path = expand_relative_dirname(:depend_on_directory, path)
+        accept = expand_accept_shorthand(accept)
+        resolve_paths(*@environment.stat_directory_with_dependencies(path), accept: accept)
+      end
+
       # Allows dependency to be excluded from the asset bundle.
       #
       # The `path` must be a valid asset and may or may not already
@@ -374,7 +392,7 @@ module Sprockets
           next if subpath == @filename || stat.directory?
           uri, deps = @environment.resolve(subpath, **kargs)
           @dependencies.merge(deps)
-          yield uri if uri
+          yield uri if uri && block_given?
         end
       end
 

data/lib/sprockets/eco_processor.rb

@@ -4,7 +4,7 @@ require 'sprockets/autoload'
 module Sprockets
   # Processor engine class for the Eco compiler. Depends on the `eco` gem.
   #
-  # For more infomation see:
+  # For more information see:
   #
   #   https://github.com/sstephenson/ruby-eco
   #   https://github.com/sstephenson/eco

data/lib/sprockets/ejs_processor.rb

@@ -4,7 +4,7 @@ require 'sprockets/autoload'
 module Sprockets
   # Processor engine class for the EJS compiler. Depends on the `ejs` gem.
   #
-  # For more infomation see:
+  # For more information see:
   #
   #   https://github.com/sstephenson/ruby-ejs
   #

data/lib/sprockets/erb_processor.rb

@@ -18,8 +18,7 @@ class Sprockets::ERBProcessor
   end
 
   def call(input)
-    match = ERB.version.match(/\Aerb\.rb \[(?<version>[^ ]+) /)
-    if match && match[:version] >= "2.2.0" # Ruby 2.6+
+    if keyword_constructor? # Ruby 2.6+
       engine = ::ERB.new(input[:data], trim_mode: '<>')
     else
       engine = ::ERB.new(input[:data], nil, '<>')
@@ -34,4 +33,11 @@ class Sprockets::ERBProcessor
     data = engine.result(context.instance_eval('binding'))
     context.metadata.merge(data: data)
   end
+
+  private
+
+  def keyword_constructor?
+    return @keyword_constructor if defined? @keyword_constructor
+    @keyword_constructor = ::ERB.instance_method(:initialize).parameters.include?([:key, :trim_mode])
+  end
 end

data/lib/sprockets/exporters/base.rb

@@ -1,6 +1,6 @@
 module Sprockets
   module Exporters
-    # Convienence class for all exporters to inherit from
+    # Convenience class for all exporters to inherit from
     #
     # An exporter is responsible for exporting a Sprockets::Asset
     # to a file system. For example the Exporters::File class
@@ -29,7 +29,7 @@ module Sprockets
         setup
       end
 
-      # Public: Callback that is executed after intialization
+      # Public: Callback that is executed after initialization
       #
       # Any setup that needs to be done can be performed in the +setup+
       # method. It will be called immediately after initialization.
@@ -69,4 +69,3 @@ module Sprockets
     end
   end
 end
-

data/lib/sprockets/exporting.rb

@@ -28,11 +28,11 @@ module Sprockets
 
     # Public: Remove Exporting processor `klass` for `mime_type`.
     #
-    #     environment.unregister_exporter '*/*', Sprockets::Exporters::Zlib
+    #     environment.unregister_exporter '*/*', Sprockets::Exporters::ZlibExporter
     #
     # Can be called without a mime type
     #
-    #     environment.unregister_exporter Sprockets::Exporters::Zlib
+    #     environment.unregister_exporter Sprockets::Exporters::ZlibExporter
     #
     # Does not remove any exporters that depend on `klass`.
     def unregister_exporter(mime_types, exporter = nil)

data/lib/sprockets/loader.rb

@@ -195,14 +195,16 @@ module Sprockets
           source = result.delete(:data)
           metadata = result
           metadata[:charset] = source.encoding.name.downcase unless metadata.key?(:charset)
-          metadata[:digest]  = digest(self.version + source)
+          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
 
@@ -289,7 +291,7 @@ 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

data/lib/sprockets/manifest.rb

@@ -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
 
@@ -112,7 +112,7 @@ 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
@@ -122,12 +122,13 @@ module Sprockets
       environment = self.environment.cached
       promises = args.flatten.map do |path|
         Concurrent::Promise.execute(executor: executor) do
-          environment.find_all_linked_assets(path) do |asset|
-            yield asset
-          end
+          environment.find_all_linked_assets(path).to_a
         end
       end
-      promises.each(&:wait!)
+
+      promises.each do |promise|
+        promise.value!.each(&block)
+      end
 
       nil
     end
@@ -273,7 +274,7 @@ module Sprockets
       nil
     end
 
-    # Persist manfiest back to FS
+    # Persist manifest back to FS
     def save
       data = json_encode(@data)
       FileUtils.mkdir_p File.dirname(@filename)

data/lib/sprockets/npm.rb

@@ -8,7 +8,7 @@ module Sprockets
     # load_path    - String environment path
     # logical_path - String path relative to base
     #
-    # Returns candiate filenames.
+    # Returns candidate filenames.
     def resolve_alternates(load_path, logical_path)
       candidates, deps = super
 

data/lib/sprockets/path_utils.rb

@@ -162,7 +162,7 @@ module Sprockets
     def split_subpath(path, subpath)
       return "" if path == subpath
       path = File.join(path, ''.freeze)
-      if subpath.start_with?(path)
+      if subpath&.start_with?(path)
         subpath[path.length..-1]
       else
         nil

data/lib/sprockets/processing.rb

@@ -130,7 +130,7 @@ module Sprockets
     #
     # mime_type - String MIME Type. Use '*/*' applies to all types.
     # key       - Symbol metadata key
-    # initial   - Initial memo to pass to the reduce funciton (default: nil)
+    # initial   - Initial memo to pass to the reduce function (default: nil)
     # block     - Proc accepting the memo accumulator and current value
     #
     # Returns nothing.

data/lib/sprockets/processor_utils.rb

@@ -6,7 +6,7 @@ module Sprockets
   #
   # 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.
+  # or Concatenation are all implemented as separate Processor steps.
   #
   # Processors maybe any object that responds to call. So procs or a class that
   # defines a self.call method.
@@ -118,8 +118,9 @@ module Sprockets
       Symbol,
       TrueClass,
       FalseClass,
-      NilClass
-    ] + (0.class == Integer ? [Integer] : [Bignum, Fixnum])).freeze
+      NilClass,
+      Integer
+    ]).freeze
 
     # Internal: Set of all nested compound metadata types that can nest values.
     VALID_METADATA_COMPOUND_TYPES = Set.new([

data/lib/sprockets/sass_processor.rb

@@ -7,7 +7,7 @@ require 'uri'
 module Sprockets
   # Processor engine class for the SASS/SCSS compiler. Depends on the `sass` gem.
   #
-  # For more infomation see:
+  # For more information see:
   #
   #   https://github.com/sass/sass
   #   https://github.com/rails/sass-rails

data/lib/sprockets/sassc_processor.rb

@@ -7,7 +7,7 @@ require 'uri'
 module Sprockets
   # Processor engine class for the SASS/SCSS compiler. Depends on the `sassc` gem.
   #
-  # For more infomation see:
+  # For more information see:
   #
   #   https://github.com/sass/sassc-ruby
   #   https://github.com/sass/sassc-rails

data/lib/sprockets/server.rb

@@ -35,7 +35,8 @@ module Sprockets
       msg = "Served asset #{env['PATH_INFO']} -"
 
       # Extract the path from everything after the leading slash
-      path = Rack::Utils.unescape(env['PATH_INFO'].to_s.sub(/^\//, ''))
+      full_path = Rack::Utils.unescape(env['PATH_INFO'].to_s.sub(/^\//, ''))
+      path = full_path
 
       unless path.valid_encoding?
         return bad_request_response(env)
@@ -64,6 +65,15 @@ module Sprockets
       # Look up the asset.
       asset = find_asset(path)
 
+      # Fallback to looking up the asset with the full path.
+      # This will make assets that are hashed with webpack or
+      # other js bundlers work consistently between production
+      # and development pipelines.
+      if asset.nil? && (asset = find_asset(full_path))
+        if_match = asset.etag if fingerprint
+        fingerprint = asset.etag
+      end
+
       if asset.nil?
         status = :not_found
       elsif fingerprint && asset.etag != fingerprint
@@ -138,39 +148,39 @@ module Sprockets
       # Returns a 400 Forbidden response tuple
       def bad_request_response(env)
         if head_request?(env)
-          [ 400, { "Content-Type" => "text/plain", "Content-Length" => "0" }, [] ]
+          [ 400, { "content-type" => "text/plain", "content-length" => "0" }, [] ]
         else
-          [ 400, { "Content-Type" => "text/plain", "Content-Length" => "11" }, [ "Bad Request" ] ]
+          [ 400, { "content-type" => "text/plain", "content-length" => "11" }, [ "Bad Request" ] ]
         end
       end
 
       # Returns a 403 Forbidden response tuple
       def forbidden_response(env)
         if head_request?(env)
-          [ 403, { "Content-Type" => "text/plain", "Content-Length" => "0" }, [] ]
+          [ 403, { "content-type" => "text/plain", "content-length" => "0" }, [] ]
         else
-          [ 403, { "Content-Type" => "text/plain", "Content-Length" => "9" }, [ "Forbidden" ] ]
+          [ 403, { "content-type" => "text/plain", "content-length" => "9" }, [ "Forbidden" ] ]
         end
       end
 
       # Returns a 404 Not Found response tuple
       def not_found_response(env)
         if head_request?(env)
-          [ 404, { "Content-Type" => "text/plain", "Content-Length" => "0", "X-Cascade" => "pass" }, [] ]
+          [ 404, { "content-type" => "text/plain", "content-length" => "0", "x-cascade" => "pass" }, [] ]
         else
-          [ 404, { "Content-Type" => "text/plain", "Content-Length" => "9", "X-Cascade" => "pass" }, [ "Not found" ] ]
+          [ 404, { "content-type" => "text/plain", "content-length" => "9", "x-cascade" => "pass" }, [ "Not found" ] ]
         end
       end
 
       def method_not_allowed_response
-        [ 405, { "Content-Type" => "text/plain", "Content-Length" => "18" }, [ "Method Not Allowed" ] ]
+        [ 405, { "content-type" => "text/plain", "content-length" => "18" }, [ "Method Not Allowed" ] ]
       end
 
       def precondition_failed_response(env)
         if head_request?(env)
-          [ 412, { "Content-Type" => "text/plain", "Content-Length" => "0", "X-Cascade" => "pass" }, [] ]
+          [ 412, { "content-type" => "text/plain", "content-length" => "0", "x-cascade" => "pass" }, [] ]
         else
-          [ 412, { "Content-Type" => "text/plain", "Content-Length" => "19", "X-Cascade" => "pass" }, [ "Precondition Failed" ] ]
+          [ 412, { "content-type" => "text/plain", "content-length" => "19", "x-cascade" => "pass" }, [ "Precondition Failed" ] ]
         end
       end
 
@@ -179,7 +189,7 @@ module Sprockets
       def javascript_exception_response(exception)
         err  = "#{exception.class.name}: #{exception.message}\n  (in #{exception.backtrace[0]})"
         body = "throw Error(#{err.inspect})"
-        [ 200, { "Content-Type" => "application/javascript", "Content-Length" => body.bytesize.to_s }, [ body ] ]
+        [ 200, { "content-type" => "application/javascript", "content-length" => body.bytesize.to_s }, [ body ] ]
       end
 
       # Returns a CSS response that hides all elements on the page and
@@ -232,7 +242,7 @@ module Sprockets
           }
         CSS
 
-        [ 200, { "Content-Type" => "text/css; charset=utf-8", "Content-Length" => body.bytesize.to_s }, [ body ] ]
+        [ 200, { "content-type" => "text/css; charset=utf-8", "content-length" => body.bytesize.to_s }, [ body ] ]
       end
 
       # Escape special characters for use inside a CSS content("...") string
@@ -248,18 +258,18 @@ module Sprockets
         headers = {}
 
         # Set caching headers
-        headers["Cache-Control"] = +"public"
-        headers["ETag"]          = %("#{etag}")
+        headers["cache-control"] = +"public"
+        headers["etag"]          = %("#{etag}")
 
         # If the request url contains a fingerprint, set a long
         # expires on the response
         if path_fingerprint(env["PATH_INFO"])
-          headers["Cache-Control"] << ", max-age=31536000, immutable"
+          headers["cache-control"] << ", max-age=31536000, immutable"
 
         # Otherwise set `must-revalidate` since the asset could be modified.
         else
-          headers["Cache-Control"] << ", must-revalidate"
-          headers["Vary"] = "Accept-Encoding"
+          headers["cache-control"] << ", must-revalidate"
+          headers["vary"] = "Accept-Encoding"
         end
 
         headers
@@ -269,7 +279,7 @@ module Sprockets
         headers = {}
 
         # Set content length header
-        headers["Content-Length"] = length.to_s
+        headers["content-length"] = length.to_s
 
         # Set content type header
         if type = asset.content_type
@@ -277,7 +287,7 @@ module Sprockets
           if type.start_with?("text/") && asset.charset
             type += "; charset=#{asset.charset}"
           end
-          headers["Content-Type"] = type
+          headers["content-type"] = type
         end
 
         headers.merge(cache_headers(env, asset.etag))
@@ -289,7 +299,7 @@ module Sprockets
       #     # => "0aa2105d29558f3eb790d411d7d8fb66"
       #
       def path_fingerprint(path)
-        path[/-([0-9a-f]{7,128})\.[^.]+\z/, 1]
+        path[/-([0-9a-zA-Z]{7,128})\.[^.]+\z/, 1]
       end
   end
 end

data/lib/sprockets/source_map_processor.rb

@@ -9,7 +9,7 @@ module Sprockets
   # When a file is passed in it will have a `application/js-sourcemap+json`
   # or `application/css-sourcemap+json` mime type. The filename will be
   # match the original asset. The original asset is loaded. As it
-  # gets processed by Sprockets it will aquire all information
+  # gets processed by Sprockets it will acquire all information
   # needed to build a source map file in the `asset.to_hash[:metadata][:map]`
   # key.
   #

data/lib/sprockets/source_map_utils.rb

@@ -78,7 +78,7 @@ module Sprockets
       offset = 0
       if a["sections"].count != 0 && !a["sections"].last["map"]["mappings"].empty?
         last_line_count = a["sections"].last["map"].delete("x_sprockets_linecount")
-        offset += last_line_count
+        offset += last_line_count || 1
 
         last_offset = a["sections"].last["offset"]["line"]
         offset += last_offset
@@ -140,7 +140,7 @@ module Sprockets
       }
     end
 
-    # Public: Combine two seperate source map transformations into a single
+    # Public: Combine two separate source map transformations into a single
     # mapping.
     #
     # Source transformations may happen in discrete steps producing separate
@@ -436,7 +436,7 @@ module Sprockets
         digit = BASE64_VALUES[str[i]]
         raise ArgumentError unless digit
         continuation = (digit & VLQ_CONTINUATION_BIT) != 0
-        digit &= VLQ_CONTINUATION_BIT - 1
+        digit &= VLQ_BASE_MASK
           value += digit << shift
         if continuation
           shift += VLQ_BASE_SHIFT
@@ -453,7 +453,7 @@ module Sprockets
     #
     # ary - Two dimensional Array of Integers.
     #
-    # Returns a VLQ encoded String seperated by , and ;.
+    # Returns a VLQ encoded String separated by , and ;.
     def vlq_encode_mappings(ary)
       ary.map { |group|
         group.map { |segment|

data/lib/sprockets/uri_utils.rb

@@ -53,7 +53,7 @@ module Sprockets
         path = path[1..-1]
       end
 
-      [scheme, host, path, query]
+      [scheme, host || '', path, query]
     end
 
     # Internal: Join file: URI component parts into String.

data/lib/sprockets/utils.rb

@@ -25,7 +25,7 @@ module Sprockets
 
     # Internal: Duplicate and store key/value on new frozen hash.
     #
-    # Seperated for recursive calls, always use hash_reassoc(hash, *keys).
+    # Separated for recursive calls, always use hash_reassoc(hash, *keys).
     #
     # hash - Hash
     # key  - Object key
@@ -118,30 +118,38 @@ module Sprockets
       buf
     end
 
+    MODULE_INCLUDE_MUTEX = Mutex.new
+    private_constant :MODULE_INCLUDE_MUTEX
+
     # Internal: Inject into target module for the duration of the block.
     #
     # mod - Module
     #
     # Returns result of block.
     def module_include(base, mod)
-      old_methods = {}
+      MODULE_INCLUDE_MUTEX.synchronize do
+        old_methods = {}
 
-      mod.instance_methods.each do |sym|
-        old_methods[sym] = base.instance_method(sym) if base.method_defined?(sym)
-      end
+        mod.instance_methods.each do |sym|
+          old_methods[sym] = base.instance_method(sym) if base.method_defined?(sym)
+        end
 
-      mod.instance_methods.each do |sym|
-        method = mod.instance_method(sym)
-        base.send(:define_method, sym, method)
-      end
+        mod.instance_methods.each do |sym|
+          method = mod.instance_method(sym)
+          if base.method_defined?(sym)
+            base.send(:alias_method, sym, sym)
+          end
+          base.send(:define_method, sym, method)
+        end
 
-      yield
-    ensure
-      mod.instance_methods.each do |sym|
-        base.send(:undef_method, sym) if base.method_defined?(sym)
-      end
-      old_methods.each do |sym, method|
-        base.send(:define_method, sym, method)
+        yield
+      ensure
+        mod.instance_methods.each do |sym|
+          base.send(:undef_method, sym) if base.method_defined?(sym)
+        end
+        old_methods.each do |sym, method|
+          base.send(:define_method, sym, method)
+        end
       end
     end
 

data/lib/sprockets/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sprockets
-  VERSION = "4.0.0"
+  VERSION = "4.2.0"
 end

data/lib/sprockets.rb

@@ -51,6 +51,7 @@ module Sprockets
   register_mime_type 'application/json', extensions: ['.json'], charset: :unicode
   register_mime_type 'application/ruby', extensions: ['.rb']
   register_mime_type 'application/xml', extensions: ['.xml']
+  register_mime_type 'application/manifest+json', extensions: ['.webmanifest']
   register_mime_type 'text/css', extensions: ['.css'], charset: :css
   register_mime_type 'text/html', extensions: ['.html', '.htm'], charset: :html
   register_mime_type 'text/plain', extensions: ['.txt', '.text']
@@ -89,7 +90,7 @@ module Sprockets
   register_mime_type 'application/font-woff2', extensions: ['.woff2']
 
   require 'sprockets/source_map_processor'
-  register_mime_type 'application/js-sourcemap+json', extensions: ['.js.map']
+  register_mime_type 'application/js-sourcemap+json', extensions: ['.js.map'], charset: :unicode
   register_mime_type 'application/css-sourcemap+json', extensions: ['.css.map']
   register_transformer 'application/javascript', 'application/js-sourcemap+json', SourceMapProcessor
   register_transformer 'text/css', 'application/css-sourcemap+json', SourceMapProcessor
@@ -180,6 +181,7 @@ module Sprockets
     application/ecmascript-6
     application/javascript
     application/json
+    application/manifest+json
     application/xml
     text/coffeescript
     text/css
@@ -189,6 +191,7 @@ module Sprockets
     text/scss
     text/yaml
     text/eco
+    text/ejs
   ), 'application/\2+ruby', '.erb', ERBProcessor)
 
   register_mime_type 'application/html+ruby', extensions: ['.html.erb', '.erb', '.rhtml'], charset: :html