sprockets 4.0.1

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

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+require 'fileutils'
+require 'sprockets/digest_utils'
+
+module Sprockets
+  class Asset
+    attr_reader :logical_path
+
+    # Private: Intialize Asset wrapper from attributes Hash.
+    #
+    # Asset wrappers should not be initialized directly, only
+    # Environment#find_asset should vend them.
+    #
+    # attributes - Hash of ivars
+    #
+    # Returns Asset.
+    def initialize(attributes = {})
+      @attributes   = attributes
+      @content_type = attributes[:content_type]
+      @filename     = attributes[:filename]
+      @id           = attributes[:id]
+      @load_path    = attributes[:load_path]
+      @logical_path = attributes[:logical_path]
+      @metadata     = attributes[:metadata]
+      @name         = attributes[:name]
+      @source       = attributes[:source]
+      @uri          = attributes[:uri]
+    end
+
+    # Internal: Return all internal instance variables as a hash.
+    #
+    # Returns a Hash.
+    def to_hash
+      @attributes
+    end
+
+    # Public: Metadata accumulated from pipeline process.
+    #
+    # 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.
+    #
+    # Returns Hash.
+    attr_reader :metadata
+
+    # Public: Returns String path of asset.
+    attr_reader :filename
+
+    # Internal: Unique asset object ID.
+    #
+    # Returns a String.
+    attr_reader :id
+
+    # Public: Internal URI to lookup asset by.
+    #
+    # NOT a publically accessible URL.
+    #
+    # Returns URI.
+    attr_reader :uri
+
+    # Public: Return logical path with digest spliced in.
+    #
+    #   "foo/bar-37b51d194a7513e45b56f6524f2d51f2.js"
+    #
+    # Returns String.
+    def digest_path
+      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
+
+    # Public: Get all externally linked asset filenames from asset.
+    #
+    # All linked assets should be compiled anytime this asset is.
+    #
+    # Returns Set of String asset URIs.
+    def links
+      metadata[:links] || Set.new
+    end
+
+    # Public: Return `String` of concatenated source.
+    #
+    # Returns String.
+    def source
+      if @source
+        @source
+      else
+        # File is read everytime to avoid memory bloat of large binary files
+        File.binread(filename)
+      end
+    end
+
+    # Public: Alias for #source.
+    #
+    # Returns String.
+    def to_s
+      source
+    end
+
+    # Public: Get charset of source.
+    #
+    # Returns a String charset name or nil if binary.
+    def charset
+      metadata[:charset]
+    end
+
+    # Public: Returns Integer length of source.
+    def length
+      metadata[:length]
+    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(digest)
+    end
+
+    # Pubic: ETag String of Asset.
+    def etag
+      DigestUtils.pack_hexdigest(environment_version + digest)
+    end
+
+    # Public: Returns String base64 digest of source.
+    def base64digest
+      DigestUtils.pack_base64digest(digest)
+    end
+
+    # Public: A "named information" URL for subresource integrity.
+    def integrity
+      DigestUtils.integrity_uri(digest)
+    end
+
+    # Public: Add enumerator to allow `Asset` instances to be used as Rack
+    # compatible body objects.
+    #
+    # block
+    #   part - String body chunk
+    #
+    # Returns nothing.
+    def each
+      yield to_s
+    end
+
+    # Deprecated: Save asset to disk.
+    #
+    # filename - String target
+    #
+    # Returns nothing.
+    def write_to(filename)
+      FileUtils.mkdir_p File.dirname(filename)
+
+      PathUtils.atomic_write(filename) do |f|
+        f.write source
+      end
+
+      nil
+    end
+
+    # Public: Pretty inspect
+    #
+    # Returns String.
+    def inspect
+      "#<#{self.class}:#{object_id.to_s(16)} #{uri.inspect}>"
+    end
+
+    # Public: Implements Object#hash so Assets can be used as a Hash key or
+    # in a Set.
+    #
+    # Returns Integer hash of the id.
+    def hash
+      id.hash
+    end
+
+    # Public: Compare assets.
+    #
+    # Assets are equal if they share the same path and digest.
+    #
+    # Returns true or false.
+    def eql?(other)
+      self.class == other.class && self.id == other.id
+    end
+    alias_method :==, :eql?
+  end
+end

data/lib/sprockets/autoload.rb

@@ -0,0 +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/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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'closure-compiler'
+
+module Sprockets
+  module Autoload
+    Closure = ::Closure
+  end
+end

data/lib/sprockets/autoload/coffee_script.rb

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

data/lib/sprockets/autoload/eco.rb

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

data/lib/sprockets/autoload/ejs.rb

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

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

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

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

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

data/lib/sprockets/autoload/yui.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'yui/compressor'
+
+module Sprockets
+  module Autoload
+    YUI = ::YUI
+  end
+end

data/lib/sprockets/autoload/zopfli.rb

@@ -0,0 +1,7 @@
+require 'zopfli'
+
+module Sprockets
+  module Autoload
+    Zopfli = ::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