sprockets 3.7.2 → 4.0.2

data/bin/sprockets

@@ -12,7 +12,7 @@ unless ARGV.delete("--noenv")
   end
 end
 
-filenames = []
+paths = []
 environment = Sprockets::Environment.new(Dir.pwd)
 manifest = nil
 
@@ -52,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
@@ -64,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
@@ -75,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'
 
@@ -124,7 +125,7 @@ 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
@@ -133,7 +134,7 @@ module Rake
         end
       end
 
-      task :clean => ["clean_#{name}"]
+      task clean: ["clean_#{name}"]
     end
 
     private

data/lib/sprockets.rb

@@ -1,10 +1,11 @@
 # encoding: utf-8
+# frozen_string_literal: true
+
 require 'sprockets/version'
 require 'sprockets/cache'
 require 'sprockets/environment'
 require 'sprockets/errors'
 require 'sprockets/manifest'
-require 'sprockets/deprecation'
 
 module Sprockets
   require 'sprockets/processor_utils'
@@ -23,21 +24,21 @@ module Sprockets
     dependencies: Set.new.freeze,
     dependency_resolvers: {}.freeze,
     digest_class: Digest::SHA256,
-    engine_mime_types: {}.freeze,
-    engines: {}.freeze,
     mime_exts: {}.freeze,
     mime_types: {}.freeze,
     paths: [].freeze,
     pipelines: {}.freeze,
+    pipeline_exts: {}.freeze,
     postprocessors: Hash.new { |h, k| [].freeze }.freeze,
     preprocessors: Hash.new { |h, k| [].freeze }.freeze,
-    registered_transformers: Hash.new { |h, k| {}.freeze }.freeze,
-    root: File.expand_path('..', __FILE__).freeze,
+    registered_transformers: [].freeze,
+    root: __dir__.dup.freeze,
     transformers: Hash.new { |h, k| {}.freeze }.freeze,
+    exporters: Hash.new { |h, k| Set.new.freeze }.freeze,
     version: "",
-    gzip_enabled: true
+    gzip_enabled: true,
+    export_concurrent: true
   }.freeze
-  self.computed_config = {}
 
   @context_class = Context
 
@@ -48,6 +49,7 @@ module Sprockets
   # Common asset text types
   register_mime_type 'application/javascript', extensions: ['.js'], charset: :unicode
   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 'text/css', extensions: ['.css'], charset: :css
   register_mime_type 'text/html', extensions: ['.html', '.htm'], charset: :html
@@ -70,84 +72,133 @@ module Sprockets
   register_mime_type 'audio/aiff', extensions: ['.aiff']
   register_mime_type 'audio/mpeg', extensions: ['.mp3', '.mp2', '.m2a', '.m3a']
   register_mime_type 'application/ogg', extensions: ['.ogx']
+  register_mime_type 'audio/ogg', extensions: ['.ogg', '.oga']
   register_mime_type 'audio/midi', extensions: ['.midi', '.mid']
   register_mime_type 'video/avi', extensions: ['.avi']
   register_mime_type 'audio/wave', extensions: ['.wav', '.wave']
   register_mime_type 'video/mp4', extensions: ['.mp4', '.m4v']
+  register_mime_type 'audio/aac', extensions: ['.aac']
+  register_mime_type 'audio/mp4', extensions: ['.m4a']
+  register_mime_type 'audio/flac', extensions: ['.flac']
 
   # Common font types
   register_mime_type 'application/vnd.ms-fontobject', extensions: ['.eot']
   register_mime_type 'application/x-font-opentype', extensions: ['.otf']
   register_mime_type 'application/x-font-ttf', extensions: ['.ttf']
   register_mime_type 'application/font-woff', extensions: ['.woff']
+  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/css-sourcemap+json', extensions: ['.css.map']
+  register_transformer 'application/javascript', 'application/js-sourcemap+json', SourceMapProcessor
+  register_transformer 'text/css', 'application/css-sourcemap+json', SourceMapProcessor
 
   register_pipeline :source do |env|
     []
   end
 
-  register_pipeline :self do |env, type, file_type, engine_extnames|
-    env.self_processors_for(type, file_type, engine_extnames)
+  register_pipeline :self do |env, type, file_type|
+    env.self_processors_for(type, file_type)
+  end
+
+  register_pipeline :default do |env, type, file_type|
+    env.default_processors_for(type, file_type)
   end
 
-  register_pipeline :default do |env, type, file_type, engine_extnames|
-    env.default_processors_for(type, file_type, engine_extnames)
+  require 'sprockets/add_source_map_comment_to_asset_processor'
+  register_pipeline :debug do
+    [AddSourceMapCommentToAssetProcessor]
   end
 
   require 'sprockets/directive_processor'
-  register_preprocessor 'text/css', DirectiveProcessor.new(
-    comments: ["//", ["/*", "*/"]]
-  )
-  register_preprocessor 'application/javascript', DirectiveProcessor.new(
-    comments: ["//", ["/*", "*/"]] + ["#", ["###", "###"]]
-  )
+  register_preprocessor 'text/css', DirectiveProcessor.new(comments: ["//", ["/*", "*/"]])
+  register_preprocessor 'application/javascript', DirectiveProcessor.new(comments: ["//", ["/*", "*/"]])
 
   require 'sprockets/bundle'
   register_bundle_processor 'application/javascript', Bundle
   register_bundle_processor 'text/css', Bundle
 
-  register_bundle_metadata_reducer '*/*', :data, proc { "" }, :concat
-  register_bundle_metadata_reducer 'application/javascript', :data, proc { "" }, Utils.method(:concat_javascript_sources)
+  register_bundle_metadata_reducer '*/*', :data, proc { +"" }, :concat
+  register_bundle_metadata_reducer 'application/javascript', :data, proc { +"" }, Utils.method(:concat_javascript_sources)
   register_bundle_metadata_reducer '*/*', :links, :+
+  register_bundle_metadata_reducer '*/*', :sources, proc { [] }, :+
 
   require 'sprockets/closure_compressor'
   require 'sprockets/sass_compressor'
+  require 'sprockets/sassc_compressor'
+  require 'sprockets/jsminc_compressor'
   require 'sprockets/uglifier_compressor'
   require 'sprockets/yui_compressor'
   register_compressor 'text/css', :sass, SassCompressor
+  register_compressor 'text/css', :sassc, SasscCompressor
   register_compressor 'text/css', :scss, SassCompressor
+  register_compressor 'text/css', :scssc, SasscCompressor
   register_compressor 'text/css', :yui, YUICompressor
   register_compressor 'application/javascript', :closure, ClosureCompressor
+  register_compressor 'application/javascript', :jsmin, JSMincCompressor
+  register_compressor 'application/javascript', :jsminc, JSMincCompressor
   register_compressor 'application/javascript', :uglifier, UglifierCompressor
   register_compressor 'application/javascript', :uglify, UglifierCompressor
   register_compressor 'application/javascript', :yui, YUICompressor
 
+  # Babel, TheFuture™ is now
+  require 'sprockets/babel_processor'
+  register_mime_type 'application/ecmascript-6', extensions: ['.es6'], charset: :unicode
+  register_transformer 'application/ecmascript-6', 'application/javascript', BabelProcessor
+  register_preprocessor 'application/ecmascript-6', DirectiveProcessor.new(comments: ["//", ["/*", "*/"]])
+
   # Mmm, CoffeeScript
   require 'sprockets/coffee_script_processor'
-  Deprecation.silence do
-    register_engine '.coffee', CoffeeScriptProcessor, mime_type: 'application/javascript', silence_deprecation: true
-  end
+  register_mime_type 'text/coffeescript', extensions: ['.coffee', '.js.coffee']
+  register_transformer 'text/coffeescript', 'application/javascript', CoffeeScriptProcessor
+  register_preprocessor 'text/coffeescript', DirectiveProcessor.new(comments: ["#", ["###", "###"]])
 
-  # JST engines
+  # JST processors
   require 'sprockets/eco_processor'
   require 'sprockets/ejs_processor'
   require 'sprockets/jst_processor'
-  Deprecation.silence do
-    register_engine '.jst', JstProcessor, mime_type: 'application/javascript', silence_deprecation: true
-    register_engine '.eco', EcoProcessor, mime_type: 'application/javascript', silence_deprecation: true
-    register_engine '.ejs', EjsProcessor, mime_type: 'application/javascript', silence_deprecation: true
-  end
-
-  # CSS engines
-  require 'sprockets/sass_processor'
-  Deprecation.silence do
-    register_engine '.sass', SassProcessor, mime_type: 'text/css', silence_deprecation: true
-    register_engine '.scss', ScssProcessor, mime_type: 'text/css', silence_deprecation: true
-  end
+  register_mime_type 'text/eco', extensions: ['.eco', '.jst.eco']
+  register_mime_type 'text/ejs', extensions: ['.ejs', '.jst.ejs']
+  register_transformer 'text/eco', 'application/javascript+function', EcoProcessor
+  register_transformer 'text/ejs', 'application/javascript+function', EjsProcessor
+  register_transformer 'application/javascript+function', 'application/javascript', JstProcessor
+
+  # CSS processors
+  require 'sprockets/sassc_processor'
+  register_mime_type 'text/sass', extensions: ['.sass', '.css.sass']
+  register_mime_type 'text/scss', extensions: ['.scss', '.css.scss']
+  register_transformer 'text/sass', 'text/css', SasscProcessor
+  register_transformer 'text/scss', 'text/css', ScsscProcessor
+  register_preprocessor 'text/sass', DirectiveProcessor.new(comments: ["//", ["/*", "*/"]])
+  register_preprocessor 'text/scss', DirectiveProcessor.new(comments: ["//", ["/*", "*/"]])
   register_bundle_metadata_reducer 'text/css', :sass_dependencies, Set.new, :+
 
-  # Other
+  # ERB
   require 'sprockets/erb_processor'
-  register_engine '.erb', ERBProcessor, mime_type: 'text/plain', silence_deprecation: true
+  register_transformer_suffix(%w(
+    application/ecmascript-6
+    application/javascript
+    application/json
+    application/xml
+    text/coffeescript
+    text/css
+    text/html
+    text/plain
+    text/sass
+    text/scss
+    text/yaml
+    text/eco
+  ), 'application/\2+ruby', '.erb', ERBProcessor)
+
+  register_mime_type 'application/html+ruby', extensions: ['.html.erb', '.erb', '.rhtml'], charset: :html
+  register_mime_type 'application/xml+ruby', extensions: ['.xml.erb', '.rxml']
+
+  require 'sprockets/exporters/file_exporter'
+  require 'sprockets/exporters/zlib_exporter'
+  require 'sprockets/exporters/zopfli_exporter'
+  register_exporter '*/*', Exporters::FileExporter
+  register_exporter '*/*', Exporters::ZlibExporter
 
   register_dependency_resolver 'environment-version' do |env|
     env.version
@@ -161,9 +212,18 @@ module Sprockets
   register_dependency_resolver 'processors' do |env, str|
     env.resolve_processors_cache_key_uri(str)
   end
+  register_dependency_resolver 'env' do |env, str|
+    _, var = str.split(':', 2)
+    ENV[var]
+  end
 
   depend_on 'environment-version'
   depend_on 'environment-paths'
-end
 
-require 'sprockets/legacy'
+  require 'sprockets/preprocessors/default_source_map'
+  register_preprocessor 'text/css',               Preprocessors::DefaultSourceMap.new
+  register_preprocessor 'application/javascript', Preprocessors::DefaultSourceMap.new
+
+  register_bundle_metadata_reducer 'text/css',               :map, proc { |input| { "version" => 3, "file" => PathUtils.split_subpath(input[:load_path], input[:filename]), "sections" => [] } }, SourceMapUtils.method(:concat_source_maps)
+  register_bundle_metadata_reducer 'application/javascript', :map, proc { |input| { "version" => 3, "file" => PathUtils.split_subpath(input[:load_path], input[:filename]), "sections" => [] } }, SourceMapUtils.method(:concat_source_maps)
+end

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 aset 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'
 
@@ -13,8 +14,7 @@ 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]
@@ -22,7 +22,6 @@ module Sprockets
       @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]
@@ -68,6 +67,13 @@ module Sprockets
       logical_path.sub(/\.(\w+)$/) { |ext| "-#{etag}#{ext}" }
     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.
     attr_reader :content_type
 
@@ -80,14 +86,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.
@@ -120,27 +118,40 @@ 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.
     def integrity
-      DigestUtils.integrity_uri(metadata[:digest])
+      DigestUtils.integrity_uri(digest)
     end
 
     # Public: Add enumerator to allow `Asset` instances to be used as Rack
@@ -166,9 +177,6 @@ module Sprockets
         f.write source
       end
 
-      # Set mtime correctly
-      File.utime(mtime, mtime, filename)
-
       nil
     end