sprockets 3.0.3 → 4.2.0

data/bin/sprockets

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+$VERBOSE = nil
 
 require 'sprockets'
 require 'optparse'
@@ -11,7 +12,7 @@ unless ARGV.delete("--noenv")
   end
 end
 
-filenames = []
+paths = []
 environment = Sprockets::Environment.new(Dir.pwd)
 manifest = nil
 
@@ -51,6 +52,10 @@ OptionParser.new do |opts|
   opts.on("--noenv", "Disables .sprocketsrc file") do
   end
 
+  opts.on("--cache=DIRECTORY", "Enables the FileStore cache using the specified directory") do |directory|
+    environment.cache = Sprockets::Cache::FileStore.new(directory)
+  end
+
   opts.on_tail("-h", "--help", "Shows this help message") do
     opts.show_usage
   end
@@ -63,8 +68,8 @@ OptionParser.new do |opts|
   opts.show_usage if ARGV.empty?
 
   begin
-    opts.order(ARGV) do |filename|
-      filenames << File.expand_path(filename)
+    opts.order(ARGV) do |path|
+      paths << path
     end
   rescue OptionParser::ParseError => e
     opts.warn e.message
@@ -74,14 +79,14 @@ end
 
 if environment.paths.empty?
   warn "No load paths given"
-  warn "Usage: sprockets -Ijavascripts/ filename"
+  warn "Usage: sprockets -Ijavascripts/ path"
   exit 1
 end
 
 if manifest
-  manifest.compile(filenames)
-elsif filenames.length == 1
-  puts environment.find_asset(filenames.first).to_s
+  manifest.compile(paths)
+elsif paths.length == 1
+  puts environment.find_asset(paths.first).to_s
 else
   warn "Only one file can be compiled to stdout at a time"
   exit 1

data/lib/rake/sprocketstask.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rake'
 require 'rake/tasklib'
 
@@ -68,9 +69,12 @@ module Rake
     #
     attr_accessor :assets
 
-    # Number of old assets to keep.
+    # Minimum number of old assets to keep. See Sprockets::Manifest#clean for more information.
     attr_accessor :keep
 
+    # Assets created within this age will be kept. See Sprockets::Manifest#clean for more information.
+    attr_accessor :age
+
     # Logger to use during rake tasks. Defaults to using stderr.
     #
     #   t.logger = Logger.new($stdout)
@@ -102,6 +106,7 @@ module Rake
       @logger       = Logger.new($stderr)
       @logger.level = Logger::INFO
       @keep         = 2
+      @age          = 3600
 
       yield self if block_given?
 
@@ -124,16 +129,16 @@ module Rake
         end
       end
 
-      task :clobber => ["clobber_#{name}"]
+      task clobber: ["clobber_#{name}"]
 
       desc name == :assets ? "Clean old assets" : "Clean old #{name} assets"
       task "clean_#{name}" do
         with_logger do
-          manifest.clean(keep)
+          manifest.clean(keep, age)
         end
       end
 
-      task :clean => ["clean_#{name}"]
+      task clean: ["clean_#{name}"]
     end
 
     private

data/lib/sprockets/add_source_map_comment_to_asset_processor.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require 'sprockets/uri_utils'
+require 'sprockets/path_utils'
+
+module Sprockets
+  # This is a processor designed to add a source map "comment"
+  # to the bottom of a css or JS file that is serving a source
+  # map. An example of a comment might look like this
+  #
+  #    //# application.js-80af0efcc960fc2ac93eda2f7b12e3db40ab360bf6ea269ceed3bea3678326f9.map
+  #
+  # As an asset is built it gets source map information added
+  # to the `asset.to_hash[:metadata][:map]` key. This contains all the
+  # information that is needed to build a source map file.
+  #
+  # To add this comment we must have an asset we can link to.
+  # To do this we ensure that the original asset is loaded, then
+  # we use a use a special mime type. For example `application/js-sourcemap+json`
+  # for a JS source map.
+  #
+  # This will trigger a new asset to be loaded and generated by the
+  # `SourceMapProcessor` processor.
+  #
+  # Finally once we have that file, we can generate a link to it
+  # with it's full fingerprint. This is done and then
+  # added to the original asset as a comment at the bottom.
+  #
+  class AddSourceMapCommentToAssetProcessor
+    def self.call(input)
+
+      case input[:content_type]
+      when "application/javascript"
+        comment = "\n//# sourceMappingURL=%s"
+        map_type = "application/js-sourcemap+json"
+      when "text/css"
+        comment = "\n/*# sourceMappingURL=%s */"
+        map_type = "application/css-sourcemap+json"
+      else
+        fail input[:content_type]
+      end
+
+      env = input[:environment]
+
+      uri, _ = env.resolve!(input[:filename], accept: input[:content_type])
+      asset = env.load(uri)
+
+      uri, _ = env.resolve!(input[:filename], accept: map_type)
+      map = env.load(uri)
+
+      uri, params = URIUtils.parse_asset_uri(input[:uri])
+      uri = env.expand_from_root(params[:index_alias]) if params[:index_alias]
+      path = PathUtils.relative_path_from(PathUtils.split_subpath(input[:load_path], uri), map.digest_path)
+
+      asset.metadata.merge(
+        data: asset.source + (comment % path) + "\n",
+        links: asset.links + [asset.uri, map.uri]
+      )
+    end
+  end
+end

data/lib/sprockets/asset.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 require 'sprockets/digest_utils'
 
@@ -5,7 +6,7 @@ module Sprockets
   class Asset
     attr_reader :logical_path
 
-    # Private: Intialize Asset wrapper from attributes Hash.
+    # Private: Initialize Asset wrapper from attributes Hash.
     #
     # Asset wrappers should not be initialized directly, only
     # Environment#find_asset should vend them.
@@ -13,17 +14,14 @@ module Sprockets
     # attributes - Hash of ivars
     #
     # Returns Asset.
-    def initialize(environment, attributes = {})
-      @environment  = environment
+    def initialize(attributes = {})
       @attributes   = attributes
       @content_type = attributes[:content_type]
       @filename     = attributes[:filename]
       @id           = attributes[:id]
-      @integrity    = attributes[:integrity]
       @load_path    = attributes[:load_path]
       @logical_path = attributes[:logical_path]
       @metadata     = attributes[:metadata]
-      @mtime        = attributes[:mtime]
       @name         = attributes[:name]
       @source       = attributes[:source]
       @uri          = attributes[:uri]
@@ -40,7 +38,7 @@ module Sprockets
     #
     # The API status of the keys is dependent on the pipeline processors
     # itself. So some values maybe considered public and others internal.
-    # See the pipeline proccessor documentation itself.
+    # See the pipeline processor documentation itself.
     #
     # Returns Hash.
     attr_reader :metadata
@@ -55,7 +53,7 @@ module Sprockets
 
     # Public: Internal URI to lookup asset by.
     #
-    # NOT a publically accessible URL.
+    # NOT a publicly accessible URL.
     #
     # Returns URI.
     attr_reader :uri
@@ -66,7 +64,18 @@ module Sprockets
     #
     # Returns String.
     def digest_path
-      logical_path.sub(/\.(\w+)$/) { |ext| "-#{etag}#{ext}" }
+      if DigestUtils.already_digested?(@name)
+        logical_path
+      else
+        logical_path.sub(/\.(\w+)$/) { |ext| "-#{etag}#{ext}" }
+      end
+    end
+
+    # Public: Return load path + logical path with digest spliced in.
+    #
+    # Returns String.
+    def full_digest_path
+      File.join(@load_path, digest_path)
     end
 
     # Public: Returns String MIME type of asset. Returns nil if type is unknown.
@@ -81,14 +90,6 @@ module Sprockets
       metadata[:links] || Set.new
     end
 
-    # Public: Get all internally required assets that were concated into this
-    # asset.
-    #
-    # Returns Array of String asset URIs.
-    def included
-      metadata[:included]
-    end
-
     # Public: Return `String` of concatenated source.
     #
     # Returns String.
@@ -121,26 +122,41 @@ module Sprockets
     end
     alias_method :bytesize, :length
 
+    # Public: Returns String byte digest of source.
+    def digest
+      metadata[:digest]
+    end
+
+    # Private: Return the version of the environment where the asset was generated.
+    def environment_version
+      metadata[:environment_version]
+    end
+
     # Public: Returns String hexdigest of source.
     def hexdigest
-      DigestUtils.pack_hexdigest(metadata[:digest])
+      DigestUtils.pack_hexdigest(digest)
     end
 
-    # Deprecated: Returns String hexdigest of source.
-    #
-    # In 4.x this will be changed to return a raw Digest byte String.
-    alias_method :digest, :hexdigest
-
     # Pubic: ETag String of Asset.
-    alias_method :etag, :hexdigest
+    def etag
+      version = environment_version
+
+      if version && version != ""
+        DigestUtils.hexdigest(version + digest)
+      else
+        DigestUtils.pack_hexdigest(digest)
+      end
+    end
 
     # Public: Returns String base64 digest of source.
     def base64digest
-      DigestUtils.pack_base64digest(metadata[:digest])
+      DigestUtils.pack_base64digest(digest)
     end
 
     # Public: A "named information" URL for subresource integrity.
-    attr_reader :integrity
+    def integrity
+      DigestUtils.integrity_uri(digest)
+    end
 
     # Public: Add enumerator to allow `Asset` instances to be used as Rack
     # compatible body objects.
@@ -165,9 +181,6 @@ module Sprockets
         f.write source
       end
 
-      # Set mtime correctly
-      File.utime(mtime, mtime, filename)
-
       nil
     end
 

data/lib/sprockets/autoload/babel.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'babel/transpiler'
+
+module Sprockets
+  module Autoload
+    Babel = ::Babel
+  end
+end

data/lib/sprockets/autoload/closure.rb

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

data/lib/sprockets/autoload/coffee_script.rb

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

data/lib/sprockets/autoload/eco.rb

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

data/lib/sprockets/autoload/ejs.rb

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

data/lib/sprockets/autoload/jsminc.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'jsminc'
+
+module Sprockets
+  module Autoload
+    JSMinC = ::JSMinC
+  end
+end

data/lib/sprockets/autoload/sass.rb

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

data/lib/sprockets/autoload/sassc.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'sassc'
+
+module Sprockets
+  module Autoload
+    SassC = ::SassC
+  end
+end

data/lib/sprockets/autoload/uglifier.rb

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

data/lib/sprockets/autoload/yui.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'yui/compressor'
 
 module Sprockets

data/lib/sprockets/autoload/zopfli.rb

@@ -0,0 +1,7 @@
+require 'zopfli'
+
+module Sprockets
+  module Autoload
+    Zopfli = ::Zopfli
+  end
+end

data/lib/sprockets/autoload.rb

@@ -1,11 +1,16 @@
+# frozen_string_literal: true
 module Sprockets
   module Autoload
+    autoload :Babel, 'sprockets/autoload/babel'
     autoload :Closure, 'sprockets/autoload/closure'
     autoload :CoffeeScript, 'sprockets/autoload/coffee_script'
     autoload :Eco, 'sprockets/autoload/eco'
     autoload :EJS, 'sprockets/autoload/ejs'
+    autoload :JSMinC, 'sprockets/autoload/jsminc'
     autoload :Sass, 'sprockets/autoload/sass'
+    autoload :SassC, 'sprockets/autoload/sassc'
     autoload :Uglifier, 'sprockets/autoload/uglifier'
     autoload :YUI, 'sprockets/autoload/yui'
+    autoload :Zopfli, 'sprockets/autoload/zopfli'
   end
 end

data/lib/sprockets/babel_processor.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+require 'sprockets/autoload'
+require 'sprockets/path_utils'
+require 'sprockets/source_map_utils'
+require 'json'
+
+module Sprockets
+  class BabelProcessor
+    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 = {})
+      @options = options.merge({
+        'blacklist' => (options['blacklist'] || []) + ['useStrict'],
+        'sourceMap' => true
+      }).freeze
+
+      @cache_key = [
+        self.class.name,
+        Autoload::Babel::Transpiler::VERSION,
+        Autoload::Babel::Source::VERSION,
+        VERSION,
+        @options
+      ].freeze
+    end
+
+    def call(input)
+      data = input[:data]
+
+      result = input[:cache].fetch(@cache_key + [input[:filename]] + [data]) do
+        opts = {
+          'moduleRoot' => nil,
+          'filename' => input[:filename],
+          'filenameRelative' => PathUtils.split_subpath(input[:load_path], input[:filename]),
+          'sourceFileName' => File.basename(input[:filename]),
+          'sourceMapTarget' => input[:filename]
+        }.merge(@options)
+
+        if opts['moduleIds'] && opts['moduleRoot']
+          opts['moduleId'] ||= File.join(opts['moduleRoot'], input[:name])
+        elsif opts['moduleIds']
+          opts['moduleId'] ||= input[:name]
+        end
+        Autoload::Babel::Transpiler.transform(data, opts)
+      end
+
+      map = SourceMapUtils.format_source_map(result["map"], input)
+      map = SourceMapUtils.combine_source_maps(input[:metadata][:map], map)
+
+      { data: result['code'], map: map }
+    end
+  end
+end

data/lib/sprockets/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/asset'
 require 'sprockets/bower'
 require 'sprockets/cache'
@@ -5,20 +6,36 @@ require 'sprockets/configuration'
 require 'sprockets/digest_utils'
 require 'sprockets/errors'
 require 'sprockets/loader'
-require 'sprockets/path_digest_utils'
+require 'sprockets/npm'
 require 'sprockets/path_dependency_utils'
+require 'sprockets/path_digest_utils'
 require 'sprockets/path_utils'
 require 'sprockets/resolve'
 require 'sprockets/server'
+require 'sprockets/source_map_utils'
+require 'sprockets/uri_tar'
 
 module Sprockets
-  # `Base` class for `Environment` and `Cached`.
+
+  class DoubleLinkError < Sprockets::Error
+    def initialize(parent_filename:, logical_path:, last_filename:, filename:)
+      super <<~MSG
+        Multiple files with the same output path cannot be linked (#{logical_path.inspect})
+        In #{parent_filename.inspect} these files were linked:
+          - #{last_filename}
+          - #{filename}
+      MSG
+    end
+  end
+
+  # `Base` class for `Environment` and `CachedEnvironment`.
   class Base
-    include PathUtils, PathDependencyUtils, PathDigestUtils, DigestUtils
+    include PathUtils, PathDependencyUtils, PathDigestUtils, DigestUtils, SourceMapUtils
     include Configuration
     include Server
     include Resolve, Loader
     include Bower
+    include Npm
 
     # Get persistent cache store
     attr_reader :cache
@@ -32,7 +49,7 @@ module Sprockets
       @cache = Cache.new(cache, logger)
     end
 
-    # Return an `Cached`. Must be implemented by the subclass.
+    # Return an `CachedEnvironment`. Must be implemented by the subclass.
     def cached
       raise NotImplementedError
     end
@@ -48,33 +65,46 @@ module Sprockets
         # Caveat: Digests are cached by the path's current mtime. Its possible
         # for a files contents to have changed and its mtime to have been
         # negligently reset thus appearing as if the file hasn't changed on
-        # disk. Also, the mtime is only read to the nearest second. Its
+        # disk. Also, the mtime is only read to the nearest second. It's
         # also possible the file was updated more than once in a given second.
-        cache.fetch("file_digest:#{path}:#{stat.mtime.to_i}") do
+        key = UnloadedAsset.new(path, self).file_digest_key(stat.mtime.to_i)
+        cache.fetch(key) do
           self.stat_digest(path, stat)
         end
       end
     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, **options)
+      uri, _ = resolve(*args, **options)
       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)
+      parent_asset = asset = find_asset(*args)
       return unless asset
 
       yield asset
       stack = asset.links.to_a
+      linked_paths = {}
 
       while uri = stack.shift
         yield asset = load(uri)
+
+        last_filename = linked_paths[asset.logical_path]
+        if last_filename && last_filename != asset.filename
+          raise DoubleLinkError.new(
+            parent_filename: parent_asset.filename,
+            last_filename:   last_filename,
+            logical_path:    asset.logical_path,
+            filename:        asset.filename
+          )
+        end
+        linked_paths[asset.logical_path] = asset.filename
         stack = asset.links.to_a + stack
       end
 
@@ -85,8 +115,18 @@ module Sprockets
     #
     #     environment['application.js']
     #
-    def [](*args)
-      find_asset(*args)
+    def [](*args, **options)
+      find_asset(*args, **options)
+    end
+
+    # Find asset by logical path or expanded path.
+    #
+    # If the asset is not found an error will be raised.
+    def find_asset!(*args)
+      uri, _ = resolve!(*args)
+      if uri
+        load(uri)
+      end
     end
 
     # Pretty inspect
@@ -95,5 +135,13 @@ module Sprockets
         "root=#{root.to_s.inspect}, " +
         "paths=#{paths.inspect}>"
     end
+
+    def compress_from_root(uri)
+      URITar.new(uri, self).compress
+    end
+
+    def expand_from_root(uri)
+      URITar.new(uri, self).expand
+    end
   end
 end

data/lib/sprockets/bower.rb

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