sprockets 4.0.0.beta6 → 4.0.0.beta7

data/lib/sprockets.rb

@@ -72,10 +72,14 @@ 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']
@@ -102,9 +106,9 @@ module Sprockets
     env.default_processors_for(type, file_type)
   end
 
-  require 'sprockets/source_map_comment_processor'
+  require 'sprockets/add_source_map_comment_to_asset_processor'
   register_pipeline :debug do
-    [SourceMapCommentProcessor]
+    [AddSourceMapCommentToAssetProcessor]
   end
 
   require 'sprockets/directive_processor'
@@ -184,6 +188,7 @@ module Sprockets
     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

data/lib/sprockets/{source_map_comment_processor.rb → add_source_map_comment_to_asset_processor.rb}

@@ -3,8 +3,31 @@ require 'sprockets/uri_utils'
 require 'sprockets/path_utils'
 
 module Sprockets
-  class SourceMapCommentProcessor
+  # 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"

data/lib/sprockets/base.rb

@@ -16,6 +16,18 @@ require 'sprockets/source_map_utils'
 require 'sprockets/uri_tar'
 
 module Sprockets
+
+  class DoubleLinkError < Sprockets::Error
+    def initialize(parent_filename:, logical_path:, last_filename:, filename:)
+      message = String.new
+      message << "Multiple files with the same output path cannot be linked (#{logical_path.inspect})\n"
+      message << "In #{parent_filename.inspect} these files were linked:\n"
+      message << "  - #{last_filename}\n"
+      message << "  - #{filename}\n"
+      super(message)
+    end
+  end
+
   # `Base` class for `Environment` and `CachedEnvironment`.
   class Base
     include PathUtils, PathDependencyUtils, PathDigestUtils, DigestUtils, SourceMapUtils
@@ -73,14 +85,26 @@ module Sprockets
     def find_all_linked_assets(*args)
       return to_enum(__method__, *args) unless block_given?
 
-      asset = find_asset(*args)
+      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
 

data/lib/sprockets/context.rb

@@ -186,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:
     #
@@ -198,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.
@@ -251,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/loader.rb

@@ -81,6 +81,8 @@ module Sprockets
           asset[:metadata][:links].map!             { |uri| expand_from_root(uri) } if asset[:metadata][:links]
           asset[:metadata][:stubbed].map!           { |uri| expand_from_root(uri) } if asset[:metadata][:stubbed]
           asset[:metadata][:required].map!          { |uri| expand_from_root(uri) } if asset[:metadata][:required]
+          asset[:metadata][:to_load].map!           { |uri| expand_from_root(uri) } if asset[:metadata][:to_load]
+          asset[:metadata][:to_link].map!           { |uri| expand_from_root(uri) } if asset[:metadata][:to_link]
           asset[:metadata][:dependencies].map!      { |uri| uri.start_with?("file-digest://") ? expand_from_root(uri) : uri } if asset[:metadata][:dependencies]
 
           asset[:metadata].each_key do |k|
@@ -140,7 +142,6 @@ module Sprockets
 
         # Read into memory and process if theres a processor pipeline
         if processors.any?
-
           result = call_processors(processors, {
             environment: self,
             cache: self.cache,
@@ -224,6 +225,16 @@ module Sprockets
             cached_asset[:metadata][:required].map! { |uri| compress_from_root(uri) }
           end
 
+          if cached_asset[:metadata][:to_load] && !cached_asset[:metadata][:to_load].empty?
+            cached_asset[:metadata][:to_load] = cached_asset[:metadata][:to_load].dup
+            cached_asset[:metadata][:to_load].map! { |uri| compress_from_root(uri) }
+          end
+
+          if cached_asset[:metadata][:to_link] && !cached_asset[:metadata][:to_link].empty?
+            cached_asset[:metadata][:to_link] = cached_asset[:metadata][:to_link].dup
+            cached_asset[:metadata][:to_link].map! { |uri| compress_from_root(uri) }
+          end
+
           if cached_asset[:metadata][:dependencies] && !cached_asset[:metadata][:dependencies].empty?
             cached_asset[:metadata][:dependencies] = cached_asset[:metadata][:dependencies].dup
             cached_asset[:metadata][:dependencies].map! do |uri|

data/lib/sprockets/manifest.rb

@@ -165,7 +165,12 @@ module Sprockets
       filenames            = []
       concurrent_exporters = []
 
+      assets_to_export = Concurrent::Array.new
       find(*args) do |asset|
+        assets_to_export << asset
+      end
+
+      assets_to_export.each do |asset|
         mtime = Time.now.iso8601
         files[asset.digest_path] = {
           'logical_path' => asset.logical_path,

data/lib/sprockets/server.rb

@@ -54,11 +54,11 @@ module Sprockets
       if fingerprint
         if_match = fingerprint
       elsif env['HTTP_IF_MATCH']
-        if_match = env['HTTP_IF_MATCH'][/^"(\w+)"$/, 1]
+        if_match = env['HTTP_IF_MATCH'][/"(\w+)"$/, 1]
       end
 
       if env['HTTP_IF_NONE_MATCH']
-        if_none_match = env['HTTP_IF_NONE_MATCH'][/^"(\w+)"$/, 1]
+        if_none_match = env['HTTP_IF_NONE_MATCH'][/"(\w+)"$/, 1]
       end
 
       # Look up the asset.

data/lib/sprockets/source_map_processor.rb

@@ -2,24 +2,32 @@
 require 'set'
 
 module Sprockets
-  class SourceMapProcessor
-    def self.original_content_type(source_map_content_type, error_when_not_found: true)
-      case source_map_content_type
-      when "application/js-sourcemap+json"
-        "application/javascript"
-      when "application/css-sourcemap+json"
-        "text/css"
-      else
-        fail(source_map_content_type) if error_when_not_found
-        source_map_content_type
-      end
-    end
 
+  # The purpose of this class is to generate a source map file
+  # that can be read and understood by browsers.
+  #
+  # 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
+  # needed to build a source map file in the `asset.to_hash[:metadata][:map]`
+  # key.
+  #
+  # The output is an asset with a properly formatted source map file:
+  #
+  #   {
+  #     "version": 3,
+  #     "sources": ["foo.js"],
+  #     "names":   [ ],
+  #     "mappings": "AAAA,GAAIA"
+  #   }
+  #
+  class SourceMapProcessor
     def self.call(input)
       links = Set.new(input[:metadata][:links])
       env = input[:environment]
 
-      uri, _ = env.resolve!(input[:filename], accept: original_content_type(input[:content_type]))
+      uri, _ = env.resolve!(input[:filename], accept: self.original_content_type(input[:content_type]))
       asset  = env.load(uri)
       map    = asset.metadata[:map]
 
@@ -42,5 +50,17 @@ module Sprockets
 
       { data: json, links: links, dependencies: dependencies }
     end
+
+    def self.original_content_type(source_map_content_type, error_when_not_found: true)
+      case source_map_content_type
+      when "application/js-sourcemap+json"
+        "application/javascript"
+      when "application/css-sourcemap+json"
+        "text/css"
+      else
+        fail(source_map_content_type) if error_when_not_found
+        source_map_content_type
+      end
+    end
   end
 end

data/lib/sprockets/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprockets
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta6
+  version: 4.0.0.beta7
 platform: ruby
 authors:
 - Sam Stephenson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2018-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -45,6 +45,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: babel-transpiler
   requirement: !ruby/object:Gem::Requirement
@@ -304,6 +318,7 @@ files:
 - bin/sprockets
 - lib/rake/sprocketstask.rb
 - lib/sprockets.rb
+- lib/sprockets/add_source_map_comment_to_asset_processor.rb
 - lib/sprockets/asset.rb
 - lib/sprockets/autoload.rb
 - lib/sprockets/autoload/babel.rb
@@ -370,7 +385,6 @@ files:
 - lib/sprockets/sassc_compressor.rb
 - lib/sprockets/sassc_processor.rb
 - lib/sprockets/server.rb
-- lib/sprockets/source_map_comment_processor.rb
 - lib/sprockets/source_map_processor.rb
 - lib/sprockets/source_map_utils.rb
 - lib/sprockets/transformers.rb
@@ -402,7 +416,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: sprockets
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rack-based asset packaging system