sprockets 2.2.3 → 4.0.0

data/lib/sprockets/uglifier_compressor.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+require 'sprockets/autoload'
+require 'sprockets/digest_utils'
+require 'sprockets/source_map_utils'
+
+module Sprockets
+  # Public: Uglifier/Uglify compressor.
+  #
+  # To accept the default options
+  #
+  #     environment.register_bundle_processor 'application/javascript',
+  #       Sprockets::UglifierCompressor
+  #
+  # Or to pass options to the Uglifier class.
+  #
+  #     environment.register_bundle_processor 'application/javascript',
+  #       Sprockets::UglifierCompressor.new(comments: :copyright)
+  #
+  class UglifierCompressor
+    VERSION = '3'
+
+    # Public: Return singleton instance with default options.
+    #
+    # Returns UglifierCompressor object.
+    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[:comments] ||= :none
+
+      @options = options
+      @cache_key = "#{self.class.name}:#{Autoload::Uglifier::VERSION}:#{VERSION}:#{DigestUtils.digest(options)}".freeze
+    end
+
+    def call(input)
+      case Autoload::Uglifier::VERSION.to_i
+      when 1
+        raise "uglifier 1.x is no longer supported, please upgrade to 2.x or newer"
+      when 2
+        input_options = { source_filename: input[:filename] }
+      else
+        input_options = { source_map: { filename: input[:filename] } }
+      end
+
+      uglifier = Autoload::Uglifier.new(@options.merge(input_options))
+
+      js, map = uglifier.compile_with_map(input[:data])
+
+      map = SourceMapUtils.format_source_map(JSON.parse(map), input)
+      map = SourceMapUtils.combine_source_maps(input[:metadata][:map], map)
+
+      { data: js, map: map }
+    end
+  end
+end

data/lib/sprockets/unloaded_asset.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+require 'sprockets/uri_utils'
+require 'sprockets/uri_tar'
+
+module Sprockets
+  # Internal: Used to parse and store the URI to an unloaded asset
+  # Generates keys used to store and retrieve items from cache
+  class UnloadedAsset
+
+    # Internal: Initialize object for generating cache keys
+    #
+    # uri - A String containing complete URI to a file including scheme
+    #       and full path such as
+    #       "file:///Path/app/assets/js/app.js?type=application/javascript"
+    # env - The current "environment" that assets are being loaded into.
+    #       We need it so we know where the +root+ (directory where Sprockets
+    #       is being invoked). We also need it for the `file_digest` method,
+    #       since, for some strange reason, memoization is provided by
+    #       overriding methods such as `stat` in the `PathUtils` module.
+    #
+    # Returns UnloadedAsset.
+    def initialize(uri, env)
+      @uri               = uri.to_s
+      @env               = env
+      @compressed_path   = URITar.new(uri, env).compressed_path
+      @params            = nil # lazy loaded
+      @filename          = nil # lazy loaded
+    end
+    attr_reader :compressed_path, :uri
+
+    # Internal: Full file path without schema
+    #
+    # This returns a string containing the full path to the asset without the schema.
+    # Information is loaded lazily since we want `UnloadedAsset.new(dep, self).relative_path`
+    # to be fast. Calling this method the first time allocates an array and a hash.
+    #
+    # Example
+    #
+    # If the URI is `file:///Full/path/app/assets/javascripts/application.js"` then the
+    # filename would be `"/Full/path/app/assets/javascripts/application.js"`
+    #
+    # Returns a String.
+    def filename
+      unless @filename
+        load_file_params
+      end
+      @filename
+    end
+
+    # Internal: Hash of param values
+    #
+    # This information is generated and used internally by Sprockets.
+    # Known keys include `:type` which stores the asset's mime-type, `:id` which is a fully resolved
+    # digest for the asset (includes dependency digest as opposed to a digest of only file contents)
+    # and `:pipeline`. Hash may be empty.
+    #
+    # Example
+    #
+    # If the URI is `file:///Full/path/app/assets/javascripts/application.js"type=application/javascript`
+    # Then the params would be `{type: "application/javascript"}`
+    #
+    # Returns a Hash.
+    def params
+      unless @params
+        load_file_params
+      end
+      @params
+    end
+
+    # Internal: Key of asset
+    #
+    # Used to retrieve an asset from the cache based on "compressed" path to asset.
+    # A "compressed" path can either be relative to the root of the project or an
+    # absolute path.
+    #
+    # Returns a String.
+    def asset_key
+      "asset-uri:#{compressed_path}"
+    end
+
+    # Public: Dependency History key
+    #
+    # Used to retrieve an array of "histories" each of which contains a set of stored dependencies
+    # for a given asset path and filename digest.
+    #
+    # A dependency can refer to either an asset e.g. index.js
+    # may rely on jquery.js (so jquery.js is a dependency), or other factors that may affect
+    # compilation, such as the VERSION of Sprockets (i.e. the environment) and what "processors"
+    # are used.
+    #
+    # For example a history array with one Set of dependencies may look like:
+    #
+    # [["environment-version", "environment-paths", "processors:type=text/css&file_type=text/css",
+    #   "file-digest:///Full/path/app/assets/stylesheets/application.css",
+    #   "processors:type=text/css&file_type=text/css&pipeline=self",
+    #   "file-digest:///Full/path/app/assets/stylesheets"]]
+    #
+    # This method of asset lookup is used to ensure that none of the dependencies have been modified
+    # since last lookup. If one of them has, the key will be different and a new entry must be stored.
+    #
+    # URI dependencies are later converted to "compressed" paths
+    #
+    # Returns a String.
+    def dependency_history_key
+      "asset-uri-cache-dependencies:#{compressed_path}:#{ @env.file_digest(filename) }"
+    end
+
+    # Internal: Digest key
+    #
+    # Used to retrieve a string containing the "compressed" path to an asset based on
+    # a digest. The digest is generated from dependencies stored via information stored in
+    # the `dependency_history_key` after each of the "dependencies" is "resolved".
+    # For example "environment-version" may be resolved to "environment-1.0-3.2.0"
+    # for version "3.2.0" of Sprockets
+    #
+    # Returns a String.
+    def digest_key(digest)
+      "asset-uri-digest:#{compressed_path}:#{digest}"
+    end
+
+    # Internal: File digest key
+    #
+    # The digest for a given file won't change if the path and the stat time hasn't changed
+    # We can save time by not re-computing this information and storing it in the cache
+    #
+    # Returns a String.
+    def file_digest_key(stat)
+      "file_digest:#{compressed_path}:#{stat}"
+    end
+
+    private
+      # Internal: Parses uri into filename and params hash
+      #
+      # Returns Array with filename and params hash
+      def load_file_params
+        @filename, @params = URIUtils.parse_asset_uri(uri)
+      end
+  end
+end

data/lib/sprockets/uri_tar.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+require 'sprockets/path_utils'
+
+module Sprockets
+ # Internal: used to "expand" and "compress" values for storage
+  class URITar
+    attr_reader :scheme, :root, :path
+
+    # Internal: Initialize object for compression or expansion
+    #
+    # uri - A String containing URI that may or may not contain the scheme
+    # env - The current "environment" that assets are being loaded into.
+    def initialize(uri, env)
+      @root = env.root
+      @env  = env
+      uri   = uri.to_s
+      if uri.include?("://".freeze)
+        @scheme, _, @path = uri.partition("://".freeze)
+        @scheme << "://".freeze
+      else
+        @scheme = "".freeze
+        @path   = uri
+      end
+    end
+
+    # Internal: Converts full uri to a "compressed" uri
+    #
+    # If a uri is inside of an environment's root it will
+    # be shortened to be a relative path.
+    #
+    # If a uri is outside of the environment's root the original
+    # uri will be returned.
+    #
+    # Returns String
+    def compress
+      scheme + compressed_path
+    end
+
+    # Internal: Tells us if we are using an absolute path
+    #
+    # Nix* systems start with a `/` like /Users/schneems.
+    # Windows systems start with a drive letter than colon and slash
+    # like C:/Schneems.
+    def absolute_path?
+      PathUtils.absolute_path?(path)
+    end
+
+    # Internal: Convert a "compressed" uri to an absolute path
+    #
+    # If a uri is inside of the environment's root it will not
+    # start with a slash for example:
+    #
+    #   file://this/is/a/relative/path
+    #
+    # If a uri is outside the root, it will start with a slash:
+    #
+    #   file:///This/is/an/absolute/path
+    #
+    # Returns String
+    def expand
+      if absolute_path?
+        # Stored path was absolute, don't add root
+        scheme + path
+      else
+        if scheme.empty?
+          File.join(root, path)
+        else
+          # We always want to return an absolute uri,
+          # make sure the path starts with a slash.
+          scheme + File.join("/".freeze, root, path)
+        end
+      end
+    end
+
+    # Internal: Returns "compressed" path
+    #
+    # If the input uri is relative to the environment root
+    # it will return a path relative to the environment root.
+    # Otherwise an absolute path will be returned.
+    #
+    # Only path information is returned, and not scheme.
+    #
+    # Returns String
+    def compressed_path
+      # windows
+      if !@root.start_with?("/".freeze) && path.start_with?("/".freeze)
+        consistent_root = "/".freeze + @root
+      else
+        consistent_root = @root
+      end
+
+      if compressed_path = PathUtils.split_subpath(consistent_root, path)
+        compressed_path
+      else
+        path
+      end
+    end
+  end
+end

data/lib/sprockets/uri_utils.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+require 'uri'
+
+module Sprockets
+  # Internal: Asset URI related parsing utilities. Mixed into Environment.
+  #
+  # An Asset URI identifies the compiled Asset result. It shares the file:
+  # scheme and requires an absolute path.
+  #
+  # Other query parameters
+  #
+  # type - String output content type. Otherwise assumed from file extension.
+  #        This maybe different than the extension if the asset is transformed
+  #        from one content type to another. For an example .coffee -> .js.
+  #
+  # id - Unique fingerprint of the entire asset and all its metadata. Assets
+  #      will only have the same id if they serialize to an identical value.
+  #
+  # pipeline - String name of pipeline.
+  #
+  module URIUtils
+    extend self
+
+    # Internal: Parse URI into component parts.
+    #
+    # uri - String uri
+    #
+    # Returns Array of components.
+    def split_uri(uri)
+      URI.split(uri)
+    end
+
+    # Internal: Join URI component parts into String.
+    #
+    # Returns String.
+    def join_uri(scheme, userinfo, host, port, registry, path, opaque, query, fragment)
+      URI::Generic.new(scheme, userinfo, host, port, registry, path, opaque, query, fragment).to_s
+    end
+
+    # Internal: Parse file: URI into component parts.
+    #
+    # uri - String uri
+    #
+    # Returns [scheme, host, path, query].
+    def split_file_uri(uri)
+      scheme, _, host, _, _, path, _, query, _ = URI.split(uri)
+
+      path = URI::Generic::DEFAULT_PARSER.unescape(path)
+      path.force_encoding(Encoding::UTF_8)
+
+      # Hack for parsing Windows "/C:/Users/IEUser" paths
+      if File::ALT_SEPARATOR && path[2] == ':'
+        path = path[1..-1]
+      end
+
+      [scheme, host, path, query]
+    end
+
+    # Internal: Join file: URI component parts into String.
+    #
+    # Returns String.
+    def join_file_uri(scheme, host, path, query)
+      str = +"#{scheme}://"
+      str << host if host
+      path = "/#{path}" unless path.start_with?("/".freeze)
+      str << URI::Generic::DEFAULT_PARSER.escape(path)
+      str << "?#{query}" if query
+      str
+    end
+
+    # Internal: Check if String is a valid Asset URI.
+    #
+    # str - Possible String asset URI.
+    #
+    # Returns true or false.
+    def valid_asset_uri?(str)
+      # Quick prefix check before attempting a full parse
+      str.start_with?("file://".freeze) && parse_asset_uri(str) ? true : false
+    rescue URI::InvalidURIError
+      false
+    end
+
+    # Internal: Parse Asset URI.
+    #
+    # Examples
+    #
+    #   parse("file:///tmp/js/application.coffee?type=application/javascript")
+    #   # => "/tmp/js/application.coffee", {type: "application/javascript"}
+    #
+    # uri - String asset URI
+    #
+    # Returns String path and Hash of symbolized parameters.
+    def parse_asset_uri(uri)
+      scheme, _, path, query = split_file_uri(uri)
+
+      unless scheme == 'file'
+        raise URI::InvalidURIError, "expected file:// scheme: #{uri}"
+      end
+
+      return path, parse_uri_query_params(query)
+    end
+
+    # Internal: Build Asset URI.
+    #
+    # Examples
+    #
+    #   build("/tmp/js/application.coffee", type: "application/javascript")
+    #   # => "file:///tmp/js/application.coffee?type=application/javascript"
+    #
+    # path   - String file path
+    # params - Hash of optional parameters
+    #
+    # Returns String URI.
+    def build_asset_uri(path, params = {})
+      join_file_uri("file", nil, path, encode_uri_query_params(params))
+    end
+
+    # Internal: Parse file-digest dependency URI.
+    #
+    # Examples
+    #
+    #   parse("file-digest:/tmp/js/application.js")
+    #   # => "/tmp/js/application.js"
+    #
+    # uri - String file-digest URI
+    #
+    # Returns String path.
+    def parse_file_digest_uri(uri)
+      scheme, _, path, _ = split_file_uri(uri)
+
+      unless scheme == 'file-digest'.freeze
+        raise URI::InvalidURIError, "expected file-digest scheme: #{uri}"
+      end
+
+      path
+    end
+
+    # Internal: Build file-digest dependency URI.
+    #
+    # Examples
+    #
+    #   build("/tmp/js/application.js")
+    #   # => "file-digest:/tmp/js/application.js"
+    #
+    # path - String file path
+    #
+    # Returns String URI.
+    def build_file_digest_uri(path)
+      join_file_uri('file-digest'.freeze, nil, path, nil)
+    end
+
+    # Internal: Serialize hash of params into query string.
+    #
+    # params - Hash of params to serialize
+    #
+    # Returns String query or nil if empty.
+    def encode_uri_query_params(params)
+      query = []
+
+      params.each do |key, value|
+        case value
+        when Integer
+          query << "#{key}=#{value}"
+        when String, Symbol
+          query << "#{key}=#{URI::Generic::DEFAULT_PARSER.escape(value.to_s)}"
+        when TrueClass
+          query << "#{key}"
+        when FalseClass, NilClass
+        else
+          raise TypeError, "unexpected type: #{value.class}"
+        end
+      end
+
+      "#{query.join('&'.freeze)}" if query.any?
+    end
+
+    # Internal: Parse query string into hash of params
+    #
+    # query - String query string
+    #
+    # Return Hash of params.
+    def parse_uri_query_params(query)
+      query.to_s.split('&'.freeze).reduce({}) do |h, p|
+        k, v = p.split('='.freeze, 2)
+        v = URI::Generic::DEFAULT_PARSER.unescape(v) if v
+        h[k.to_sym] = v || true
+        h
+      end
+    end
+  end
+end

data/lib/sprockets/utils/gzip.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+module Sprockets
+  module Utils
+    class Gzip
+      # Private: Generates a gzipped file based off of reference asset.
+      #
+      #     ZlibArchiver.call(file, source, mtime)
+      #
+      # Compresses a given `source` using stdlib Zlib algorithm
+      # writes contents to the `file` passed in. Sets `mtime` of
+      # written file to passed in `mtime`
+      module ZlibArchiver
+        def self.call(file, source, mtime)
+          gz = Zlib::GzipWriter.new(file, Zlib::BEST_COMPRESSION)
+          gz.mtime = mtime
+          gz.write(source)
+          gz.close
+
+          File.utime(mtime, mtime, file.path)
+        end
+      end
+
+      # Private: Generates a gzipped file based off of reference asset.
+      #
+      #     ZopfliArchiver.call(file, source, mtime)
+      #
+      # Compresses a given `source` using the zopfli gem
+      # writes contents to the `file` passed in. Sets `mtime` of
+      # written file to passed in `mtime`
+      module ZopfliArchiver
+        def self.call(file, source, mtime)
+          compressed_source = Autoload::Zopfli.deflate(source, format: :gzip, mtime: mtime)
+          file.write(compressed_source)
+          file.close
+
+          nil
+        end
+      end
+
+      attr_reader :content_type, :source, :charset, :archiver
+
+      # Private: Generates a gzipped file based off of reference file.
+      def initialize(asset, archiver: ZlibArchiver)
+        @content_type  = asset.content_type
+        @source        = asset.source
+        @charset       = asset.charset
+        @archiver      = archiver
+      end
+
+      # What non-text mime types should we compress? This list comes from:
+      # https://www.fastly.com/blog/new-gzip-settings-and-deciding-what-compress
+      COMPRESSABLE_MIME_TYPES = {
+        "application/vnd.ms-fontobject" => true,
+        "application/x-font-opentype" => true,
+        "application/x-font-ttf" => true,
+        "image/x-icon" => true,
+        "image/svg+xml" => true
+      }
+
+      # Private: Returns whether or not an asset can be compressed.
+      #
+      # We want to compress any file that is text based.
+      # You do not want to compress binary
+      # files as they may already be compressed and running them
+      # through a compression algorithm would make them larger.
+      #
+      # Return Boolean.
+      def can_compress?
+        # The "charset" of a mime type is present if the value is
+        # encoded text. We can check this value to see if the asset
+        # can be compressed.
+        #
+        # We also check against our list of non-text compressible mime types
+        @charset || COMPRESSABLE_MIME_TYPES.include?(@content_type)
+      end
+
+      # Private: Opposite of `can_compress?`.
+      #
+      # Returns Boolean.
+      def cannot_compress?
+        !can_compress?
+      end
+
+      # Private: Generates a gzipped file based off of reference asset.
+      #
+      # Compresses the target asset's contents and puts it into a file with
+      # the same name plus a `.gz` extension in the same folder as the original.
+      # Does not modify the target asset.
+      #
+      # Returns nothing.
+      def compress(file, target)
+        mtime = Sprockets::PathUtils.stat(target).mtime
+        archiver.call(file, source, mtime)
+
+        nil
+      end
+    end
+  end
+end