sprockets 3.0.0 → 4.0.2

data/lib/sprockets/context.rb

@@ -1,10 +1,9 @@
-require 'pathname'
+# frozen_string_literal: true
 require 'rack/utils'
 require 'set'
 require 'sprockets/errors'
 
 module Sprockets
-  # Deprecated: `Context` provides helper methods to all processors.
   # They are typically accessed by ERB templates. You can mix in custom helpers
   # by injecting them into `Environment#context_class`. Do not mix them into
   # `Context` directly.
@@ -19,10 +18,25 @@ module Sprockets
   # The `Context` also collects dependencies declared by
   # assets. See `DirectiveProcessor` for an example of this.
   class Context
-    attr_reader :environment, :filename, :pathname
+    # Internal: Proxy for ENV that keeps track of the environment variables used
+    class ENVProxy < SimpleDelegator
+      def initialize(context)
+        @context = context
+        super(ENV)
+      end
+
+      def [](key)
+        @context.depend_on_env(key)
+        super
+      end
+
+      def fetch(key, *)
+        @context.depend_on_env(key)
+        super
+      end
+    end
 
-    # Deprecated
-    attr_accessor :__LINE__
+    attr_reader :environment, :filename
 
     def initialize(input)
       @environment  = input[:environment]
@@ -31,7 +45,6 @@ module Sprockets
       @logical_path = input[:name]
       @filename     = input[:filename]
       @dirname      = File.dirname(@filename)
-      @pathname     = Pathname.new(@filename)
       @content_type = input[:content_type]
 
       @required     = Set.new(@metadata[:required])
@@ -47,6 +60,10 @@ module Sprockets
         dependencies: @dependencies }
     end
 
+    def env_proxy
+      ENVProxy.new(self)
+    end
+
     # Returns the environment path that contains the file.
     #
     # If `app/javascripts` and `app/stylesheets` are in your path, and
@@ -79,13 +96,13 @@ module Sprockets
     #     resolve("./bar.js")
     #     # => "file:///path/to/app/javascripts/bar.js?type=application/javascript"
     #
-    # path - String logical or absolute path
-    # options
-    #   accept - String content accept type
+    # path   - String logical or absolute path
+    # accept - String content accept type
     #
     # Returns an Asset URI String.
-    def resolve(path, options = {})
-      uri, deps = environment.resolve!(path, options.merge(base_path: @dirname))
+    def resolve(path, **kargs)
+      kargs[:base_path] = @dirname
+      uri, deps = environment.resolve!(path, **kargs)
       @dependencies.merge(deps)
       uri
     end
@@ -105,13 +122,13 @@ module Sprockets
     # including it.
     #
     # This is used for caching purposes. Any changes made to
-    # the dependency file with invalidate the cache of the
+    # the dependency file will invalidate the cache of the
     # source file.
     def depend_on(path)
-      if environment.absolute_path?(path) && environment.directory?(path)
+      if environment.absolute_path?(path) && environment.stat(path)
         @dependencies << environment.build_file_digest_uri(path)
       else
-        resolve(path, compat: false)
+        resolve(path)
       end
       nil
     end
@@ -121,10 +138,19 @@ module Sprockets
     #
     # This is used for caching purposes. Any changes that would
     # invalidate the dependency asset will invalidate the source
-    # file. Unlike `depend_on`, this will include recursively include
+    # file. Unlike `depend_on`, this will recursively include
     # the target asset's dependencies.
     def depend_on_asset(path)
-      load(resolve(path, compat: false))
+      load(resolve(path))
+    end
+
+    # `depend_on_env` allows you to state a dependency on an environment
+    # variable.
+    #
+    # This is used for caching purposes. Any changes in the value of the
+    # environment variable will invalidate the cache of the source file.
+    def depend_on_env(key)
+      @dependencies << "env:#{key}"
     end
 
     # `require_asset` declares `path` as a dependency of the file. The
@@ -137,7 +163,7 @@ module Sprockets
     #     <%= require_asset "#{framework}.js" %>
     #
     def require_asset(path)
-      @required << resolve(path, accept: @content_type, pipeline: :self, compat: false)
+      @required << resolve(path, accept: @content_type, pipeline: :self)
       nil
     end
 
@@ -145,7 +171,7 @@ module Sprockets
     # `path` must be an asset which may or may not already be included
     # in the bundle.
     def stub_asset(path)
-      @stubbed << resolve(path, accept: @content_type, pipeline: :self, compat: false)
+      @stubbed << resolve(path, accept: @content_type, pipeline: :self)
       nil
     end
 
@@ -160,9 +186,10 @@ module Sprockets
       asset
     end
 
-    # Returns a Base64-encoded `data:` URI with the contents of the
-    # asset at the specified path, and marks that path as a dependency
-    # of the current file.
+    # Returns a `data:` URI with the contents of the asset at the specified
+    # path, and marks that path as a dependency of the current file.
+    #
+    # Uses URI encoding for SVG files, base64 encoding for all the other files.
     #
     # Use `asset_data_uri` from ERB with CSS or JavaScript assets:
     #
@@ -172,8 +199,11 @@ module Sprockets
     #
     def asset_data_uri(path)
       asset = depend_on_asset(path)
-      data = EncodingUtils.base64(asset.source)
-      "data:#{asset.content_type};base64,#{Rack::Utils.escape(data)}"
+      if asset.content_type == 'image/svg+xml'
+        svg_asset_data_uri(asset)
+      else
+        base64_asset_data_uri(asset)
+      end
     end
 
     # Expands logical path to full url to asset.
@@ -225,5 +255,50 @@ Extend your environment context with a custom method.
     def stylesheet_path(path)
       asset_path(path, type: :stylesheet)
     end
+
+    protected
+
+    # Returns a URI-encoded data URI (always "-quoted).
+    def svg_asset_data_uri(asset)
+      svg = asset.source.dup
+      optimize_svg_for_uri_escaping!(svg)
+      data = Rack::Utils.escape(svg)
+      optimize_quoted_uri_escapes!(data)
+      "\"data:#{asset.content_type};charset=utf-8,#{data}\""
+    end
+
+    # Returns a Base64-encoded data URI.
+    def base64_asset_data_uri(asset)
+      data = Rack::Utils.escape(EncodingUtils.base64(asset.source))
+      "data:#{asset.content_type};base64,#{data}"
+    end
+
+    # Optimizes an SVG for being URI-escaped.
+    #
+    # This method only performs these basic but crucial optimizations:
+    # * Replaces " with ', because ' does not need escaping.
+    # * Removes comments, meta, doctype, and newlines.
+    # * Collapses whitespace.
+    def optimize_svg_for_uri_escaping!(svg)
+      # Remove comments, xml meta, and doctype
+      svg.gsub!(/<!--.*?-->|<\?.*?\?>|<!.*?>/m, '')
+      # Replace consecutive whitespace and newlines with a space
+      svg.gsub!(/\s+/, ' ')
+      # Collapse inter-tag whitespace
+      svg.gsub!('> <', '><')
+      # Replace " with '
+      svg.gsub!(/([\w:])="(.*?)"/, "\\1='\\2'")
+      svg.strip!
+    end
+
+    # Un-escapes characters in the given URI-escaped string that do not need
+    # escaping in "-quoted data URIs.
+    def optimize_quoted_uri_escapes!(escaped)
+      escaped.gsub!('%3D', '=')
+      escaped.gsub!('%3A', ':')
+      escaped.gsub!('%2F', '/')
+      escaped.gsub!('%27', "'")
+      escaped.tr!('+', ' ')
+    end
   end
 end

data/lib/sprockets/dependencies.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/digest_utils'
 require 'sprockets/path_digest_utils'
 require 'sprockets/uri_utils'
@@ -51,18 +52,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/digest_utils.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'digest/md5'
 require 'digest/sha1'
 require 'digest/sha2'
@@ -34,6 +35,59 @@ 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, 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.compare_by_identity.rehash
+
+    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
@@ -43,48 +97,18 @@ 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
+      build_digest(obj).digest
+    end
 
-      digest.digest
+    # Internal: Generate a hexdigest for a nested JSON serializable object.
+    #
+    # The same as `pack_hexdigest(digest(obj))`.
+    #
+    # obj - A JSON serializable object.
+    #
+    # Returns a String digest of the object.
+    def hexdigest(obj)
+      build_digest(obj).hexdigest!
     end
 
     # Internal: Pack a binary digest to a hex encoded string.
@@ -93,7 +117,16 @@ module Sprockets
     #
     # Returns hex String.
     def pack_hexdigest(bin)
-      bin.unpack('H*').first
+      bin.unpack('H*'.freeze).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.
@@ -117,25 +150,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 +174,27 @@ 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
+
+    private
+      def build_digest(obj)
+        digest = digest_class.new
+
+        ADD_VALUE_TO_DIGEST[obj.class].call(obj, digest)
+        digest
+      end
   end
 end

data/lib/sprockets/directive_processor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 require 'shellwords'
 
@@ -34,8 +35,6 @@ module Sprockets
   #     env.register_processor('text/css', MyProcessor)
   #
   class DirectiveProcessor
-    VERSION = '1'
-
     # Directives are denoted by a `=` followed by the name, then
     # argument list.
     #
@@ -50,18 +49,16 @@ module Sprockets
     /x
 
     def self.instance
-      @instance ||= new(
-        # Deprecated: Default to C and Ruby comment styles
-        comments: ["//", ["/*", "*/"]] + ["#", ["###", "###"]]
-      )
+      # Default to C comment styles
+      @instance ||= new(comments: ["//", ["/*", "*/"]])
     end
 
     def self.call(input)
       instance.call(input)
     end
 
-    def initialize(options = {})
-      @header_pattern = compile_header_pattern(Array(options[:comments]))
+    def initialize(comments: [])
+      @header_pattern = compile_header_pattern(Array(comments))
     end
 
     def call(input)
@@ -73,20 +70,28 @@ module Sprockets
       @uri          = input[:uri]
       @filename     = input[:filename]
       @dirname      = File.dirname(@filename)
-      @content_type = input[:content_type]
+      # If loading a source map file like `application.js.map` resolve
+      # dependencies using `.js` instead of `.js.map`
+      @content_type = SourceMapProcessor.original_content_type(input[:content_type], error_when_not_found: false)
       @required     = Set.new(input[:metadata][:required])
       @stubbed      = Set.new(input[:metadata][:stubbed])
       @links        = Set.new(input[:metadata][:links])
       @dependencies = Set.new(input[:metadata][:dependencies])
+      @to_link      = Set.new
+      @to_load      = Set.new
 
       data, directives = process_source(input[:data])
       process_directives(directives)
 
-      { data: data,
-        required: @required,
-        stubbed: @stubbed,
-        links: @links,
-        dependencies: @dependencies }
+      {
+        data:         data,
+        required:     @required,
+        stubbed:      @stubbed,
+        links:        @links,
+        to_load:      @to_load,
+        to_link:      @to_link,
+        dependencies: @dependencies
+      }
     end
 
     protected
@@ -116,9 +121,9 @@ module Sprockets
 
         header, directives = extract_directives(header)
 
-        data = ""
+        data = +""
         data.force_encoding(body.encoding)
-        data << header << "\n" unless header.empty?
+        data << header unless header.empty?
         data << body
         # Ensure body ends in a new line
         data << "\n" if data.length > 0 && data[-1] != "\n"
@@ -134,7 +139,7 @@ module Sprockets
       #     [[1, "require", "foo"], [2, "require", "bar"]]
       #
       def extract_directives(header)
-        processed_header = ""
+        processed_header = +""
         directives = []
 
         header.lines.each_with_index do |line, index|
@@ -149,7 +154,11 @@ module Sprockets
           processed_header << line
         end
 
-        return processed_header.chomp, directives
+        processed_header.chomp!
+        # Ensure header ends in a new line like before it was processed
+        processed_header << "\n" if processed_header.length > 0 && header[-1] == "\n"
+
+        return processed_header, directives
       end
 
       # Gathers comment directives in the source and processes them.
@@ -162,7 +171,7 @@ module Sprockets
       # `process_require_glob_directive`.
       #
       #     class DirectiveProcessor < Sprockets::DirectiveProcessor
-      #       def process_require_glob_directive
+      #       def process_require_glob_directive(glob)
       #         Dir["#{dirname}/#{glob}"].sort.each do |filename|
       #           require(filename)
       #         end
@@ -187,7 +196,7 @@ module Sprockets
 
       # The `require` directive functions similar to Ruby's own `require`.
       # It provides a way to declare a dependency on a file in your path
-      # and ensures its only loaded once before the source file.
+      # and ensures it's only loaded once before the source file.
       #
       # `require` works with files in the environment path:
       #
@@ -265,15 +274,15 @@ module Sprockets
       # it.
       #
       # This is used for caching purposes. Any changes that would
-      # invalid the asset dependency will invalidate the cache our the
-      # source file.
+      # invalidate the asset dependency will invalidate the cache of
+      # the source file.
       #
       # Unlike `depend_on`, the path must be a requirable asset.
       #
       #     //= depend_on_asset "bar.js"
       #
       def process_depend_on_asset_directive(path)
-        load(resolve(path))
+        to_load(resolve(path))
       end
 
       # Allows dependency to be excluded from the asset bundle.
@@ -297,7 +306,8 @@ module Sprockets
       #   /*= link "logo.png" */
       #
       def process_link_directive(path)
-        @links << load(resolve(path)).uri
+        uri = to_load(resolve(path))
+        @to_link << uri
       end
 
       # `link_directory` links all the files inside a single
@@ -307,7 +317,7 @@ module Sprockets
       #     //= link_directory "./fonts"
       #
       # Use caution when linking against JS or CSS assets. Include an explicit
-      # extension or content type in these cases
+      # extension or content type in these cases.
       #
       #     //= link_directory "./scripts" .js
       #
@@ -323,7 +333,7 @@ module Sprockets
       #     //= link_tree "./images"
       #
       # Use caution when linking against JS or CSS assets. Include an explicit
-      # extension or content type in these cases
+      # extension or content type in these cases.
       #
       #     //= link_tree "./styles" .css
       #
@@ -354,15 +364,15 @@ module Sprockets
 
       def link_paths(paths, deps, accept)
         resolve_paths(paths, deps, accept: accept) do |uri|
-          @links << load(uri).uri
+          @to_link << to_load(uri)
         end
       end
 
-      def resolve_paths(paths, deps, options = {})
+      def resolve_paths(paths, deps, **kargs)
         @dependencies.merge(deps)
         paths.each do |subpath, stat|
           next if subpath == @filename || stat.directory?
-          uri, deps = @environment.resolve(subpath, options.merge(compat: false))
+          uri, deps = @environment.resolve(subpath, **kargs)
           @dependencies.merge(deps)
           yield uri if uri
         end
@@ -384,19 +394,19 @@ module Sprockets
         end
       end
 
-      def load(uri)
-        asset = @environment.load(uri)
-        @dependencies.merge(asset.metadata[:dependencies])
-        asset
+      def to_load(uri)
+        @to_load << uri
+        uri
       end
 
-      def resolve(path, options = {})
+      def resolve(path, **kargs)
         # Prevent absolute paths in directives
         if @environment.absolute_path?(path)
           raise FileOutsidePaths, "can't require absolute file: #{path}"
         end
 
-        uri, deps = @environment.resolve!(path, options.merge(base_path: @dirname))
+        kargs[:base_path] = @dirname
+        uri, deps = @environment.resolve!(path, **kargs)
         @dependencies.merge(deps)
         uri
       end

data/lib/sprockets/eco_processor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/autoload'
 
 module Sprockets
@@ -12,7 +13,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 +25,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