sprockets 3.7.3 → 4.0.0.beta1

data/lib/sprockets/base.rb

@@ -5,18 +5,18 @@ require 'sprockets/configuration'
 require 'sprockets/digest_utils'
 require 'sprockets/errors'
 require 'sprockets/loader'
-require 'sprockets/path_digest_utils'
 require 'sprockets/path_dependency_utils'
+require 'sprockets/path_digest_utils'
 require 'sprockets/path_utils'
 require 'sprockets/resolve'
 require 'sprockets/server'
-require 'sprockets/loader'
+require 'sprockets/source_map_utils'
 require 'sprockets/uri_tar'
 
 module Sprockets
   # `Base` class for `Environment` and `Cached`.
   class Base
-    include PathUtils, PathDependencyUtils, PathDigestUtils, DigestUtils
+    include PathUtils, PathDependencyUtils, PathDigestUtils, DigestUtils, SourceMapUtils
     include Configuration
     include Server
     include Resolve, Loader
@@ -60,17 +60,17 @@ module Sprockets
     end
 
     # Find asset by logical path or expanded path.
-    def find_asset(path, options = {})
-      uri, _ = resolve(path, options.merge(compat: false))
+    def find_asset(*args)
+      uri, _ = resolve(*args)
       if uri
         load(uri)
       end
     end
 
-    def find_all_linked_assets(path, options = {})
-      return to_enum(__method__, path, options) unless block_given?
+    def find_all_linked_assets(*args)
+      return to_enum(__method__, *args) unless block_given?
 
-      asset = find_asset(path, options)
+      asset = find_asset(*args)
       return unless asset
 
       yield asset

data/lib/sprockets/bower.rb

@@ -17,7 +17,7 @@ module Sprockets
       candidates, deps = super
 
       # bower.json can only be nested one level deep
-      if !logical_path.index('/')
+      if !logical_path.index('/'.freeze)
         dirname = File.join(load_path, logical_path)
 
         if directory?(dirname)
@@ -27,7 +27,9 @@ module Sprockets
           if filename
             deps << build_file_digest_uri(filename)
             read_bower_main(dirname, filename) do |path|
-              candidates << path
+              if file?(path)
+                candidates << path
+              end
             end
           end
         end

data/lib/sprockets/bundle.rb

@@ -17,7 +17,7 @@ module Sprockets
       type = input[:content_type]
       dependencies = Set.new(input[:metadata][:dependencies])
 
-      processed_uri, deps = env.resolve(input[:filename], accept: type, pipeline: :self, compat: false)
+      processed_uri, deps = env.resolve(input[:filename], accept: type, pipeline: :self)
       dependencies.merge(deps)
 
       find_required = proc { |uri| env.load(uri).metadata[:required] }

data/lib/sprockets/cache.rb

@@ -44,7 +44,7 @@ module Sprockets
     # Internal: Cache key version for this class. Rarely should have to change
     # unless the cache format radically changes. Will be bump on major version
     # releases though.
-    VERSION = '3.0'
+    VERSION = '4.0'
 
     def self.default_logger
       logger = Logger.new($stderr)
@@ -153,9 +153,7 @@ module Sprockets
       #
       # Returns a String with a length less than 250 characters.
       def expand_key(key)
-        digest_key = DigestUtils.pack_urlsafe_base64digest(DigestUtils.digest(key))
-        namespace = digest_key[0, 2]
-        "sprockets/v#{VERSION}/#{namespace}/#{digest_key}"
+        "sprockets/v#{VERSION}/#{DigestUtils.pack_urlsafe_base64digest(DigestUtils.digest(key))}"
       end
 
       PEEK_SIZE = 100

data/lib/sprockets/closure_compressor.rb

@@ -35,12 +35,11 @@ module Sprockets
     attr_reader :cache_key
 
     def initialize(options = {})
-      @options = options
+      @compiler = Autoload::Closure::Compiler.new(options)
       @cache_key = "#{self.class.name}:#{Autoload::Closure::VERSION}:#{Autoload::Closure::COMPILER_VERSION}:#{VERSION}:#{DigestUtils.digest(options)}".freeze
     end
 
     def call(input)
-      @compiler ||= Autoload::Closure::Compiler.new(@options)
       @compiler.compile(input[:data])
     end
   end

data/lib/sprockets/coffee_script_processor.rb

@@ -1,4 +1,5 @@
 require 'sprockets/autoload'
+require 'sprockets/source_map_utils'
 
 module Sprockets
   # Processor engine class for the CoffeeScript compiler.
@@ -9,7 +10,7 @@ module Sprockets
   #   https://github.com/josh/ruby-coffee-script
   #
   module CoffeeScriptProcessor
-    VERSION = '1'
+    VERSION = '2'
 
     def self.cache_key
       @cache_key ||= "#{name}:#{Autoload::CoffeeScript::Source.version}:#{VERSION}".freeze
@@ -17,9 +18,14 @@ module Sprockets
 
     def self.call(input)
       data = input[:data]
-      input[:cache].fetch([self.cache_key, data]) do
-        Autoload::CoffeeScript.compile(data)
+
+      js, map = input[:cache].fetch([self.cache_key, data]) do
+        result = Autoload::CoffeeScript.compile(data, sourceMap: true, sourceFiles: [input[:source_path]])
+        [result['js'], SourceMapUtils.decode_json_source_map(result['v3SourceMap'])['mappings']]
       end
+
+      map = SourceMapUtils.combine_source_maps(input[:metadata][:map], map)
+      { data: js, map: map }
     end
   end
 end

data/lib/sprockets/compressing.rb

@@ -35,7 +35,7 @@ module Sprockets
       if compressor.is_a?(Symbol)
         @css_compressor = klass = config[:compressors]['text/css'][compressor] || raise(Error, "unknown compressor: #{compressor}")
       elsif compressor.respond_to?(:compress)
-        klass = LegacyProcProcessor.new(:css_compressor, proc { |context, data| compressor.compress(data) })
+        klass = proc { |input| compressor.compress(input[:data]) }
         @css_compressor = :css_compressor
       else
         @css_compressor = klass = compressor
@@ -62,7 +62,7 @@ module Sprockets
       if compressor.is_a?(Symbol)
         @js_compressor = klass = config[:compressors]['application/javascript'][compressor] || raise(Error, "unknown compressor: #{compressor}")
       elsif compressor.respond_to?(:compress)
-        klass = LegacyProcProcessor.new(:js_compressor, proc { |context, data| compressor.compress(data) })
+        klass = proc { |input| compressor.compress(input[:data]) }
         @js_compressor = :js_compressor
       else
         @js_compressor = klass = compressor

data/lib/sprockets/configuration.rb

@@ -1,6 +1,5 @@
 require 'sprockets/compressing'
 require 'sprockets/dependencies'
-require 'sprockets/engines'
 require 'sprockets/mime'
 require 'sprockets/paths'
 require 'sprockets/processing'
@@ -9,19 +8,16 @@ require 'sprockets/utils'
 
 module Sprockets
   module Configuration
-    include Paths, Mime, Engines, Transformers, Processing, Compressing, Dependencies, Utils
+    include Paths, Mime, Transformers, Processing, Compressing, Dependencies, Utils
 
     def initialize_configuration(parent)
       @config = parent.config
-      @computed_config = parent.computed_config
       @logger = parent.logger
       @context_class = Class.new(parent.context_class)
     end
 
     attr_reader :config
 
-    attr_accessor :computed_config
-
     def config=(config)
       raise TypeError, "can't assign mutable config" unless config.frozen?
       @config = config
@@ -69,8 +65,6 @@ module Sprockets
       self.config = config.merge(digest_class: klass).freeze
     end
 
-    # Deprecated: Get `Context` class.
-    #
     # This class maybe mutated and mixed in with custom helpers.
     #
     #     environment.context_class.instance_eval do

data/lib/sprockets/context.rb

@@ -1,10 +1,8 @@
-require 'pathname'
 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 +17,7 @@ module Sprockets
   # The `Context` also collects dependencies declared by
   # assets. See `DirectiveProcessor` for an example of this.
   class Context
-    attr_reader :environment, :filename, :pathname
-
-    # Deprecated
-    attr_accessor :__LINE__
+    attr_reader :environment, :filename
 
     def initialize(input)
       @environment  = input[:environment]
@@ -31,7 +26,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])
@@ -79,13 +73,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
@@ -108,12 +102,10 @@ module Sprockets
     # the dependency file with invalidate the cache of the
     # source file.
     def depend_on(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)
+        resolve(path)
       end
       nil
     end
@@ -126,7 +118,7 @@ module Sprockets
     # file. Unlike `depend_on`, this will include recursively include
     # the target asset's dependencies.
     def depend_on_asset(path)
-      load(resolve(path, compat: false))
+      load(resolve(path))
     end
 
     # `require_asset` declares `path` as a dependency of the file. The
@@ -139,7 +131,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
 
@@ -147,7 +139,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
 

data/lib/sprockets/digest_utils.rb

@@ -34,56 +34,6 @@ 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
@@ -94,8 +44,46 @@ 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'.freeze
+        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
 
@@ -105,7 +93,7 @@ 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.

data/lib/sprockets/directive_processor.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: false
-
 require 'set'
 require 'shellwords'
 
@@ -36,8 +34,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.
     #
@@ -52,18 +48,16 @@ module Sprockets
     /x
 
     def self.instance
-      @instance ||= new(
-        # Deprecated: Default to C and Ruby comment styles
-        comments: ["//", ["/*", "*/"]] + ["#", ["###", "###"]]
-      )
+      # Default to C omment 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)
@@ -164,7 +158,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
@@ -360,11 +354,11 @@ module Sprockets
         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
@@ -392,13 +386,14 @@ module Sprockets
         asset
       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/erb_processor.rb

@@ -18,12 +18,7 @@ module Sprockets
     end
 
     def call(input)
-      if keyword_constructor? # Ruby 2.6+
-        engine = ::ERB.new(input[:data], trim_mode: '<>')
-      else
-        engine = ::ERB.new(input[:data], nil, '<>')
-      end
-
+      engine = ::ERB.new(input[:data], nil, '<>')
       context = input[:environment].context_class.new(input)
       klass = (class << context; self; end)
       klass.class_eval(&@block) if @block
@@ -31,12 +26,5 @@ module Sprockets
       data = context._evaluate_template
       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
 end

data/lib/sprockets/http_utils.rb

@@ -13,9 +13,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 +36,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)

data/lib/sprockets/jsminc_compressor.rb

@@ -0,0 +1,31 @@
+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,21 @@
 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 +33,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)