sprockets 4.0.1

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.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+require 'set'
+
+module Sprockets
+  # Internal: Utils, we didn't know where else to put it! Functions may
+  # eventually be shuffled into more specific drawers.
+  module Utils
+    extend self
+
+    # Internal: Check if object can safely be .dup'd.
+    #
+    # Similar to ActiveSupport #duplicable? check.
+    #
+    # obj - Any Object
+    #
+    # Returns false if .dup would raise a TypeError, otherwise true.
+    def duplicable?(obj)
+      case obj
+      when NilClass, FalseClass, TrueClass, Symbol, Numeric
+        false
+      else
+        true
+      end
+    end
+
+    # Internal: Duplicate and store key/value on new frozen hash.
+    #
+    # Seperated for recursive calls, always use hash_reassoc(hash, *keys).
+    #
+    # hash - Hash
+    # key  - Object key
+    #
+    # Returns Hash.
+    def hash_reassoc1(hash, key)
+      hash = hash.dup if hash.frozen?
+      old_value = hash[key]
+      old_value = old_value.dup if duplicable?(old_value)
+      new_value = yield old_value
+      new_value.freeze if duplicable?(new_value)
+      hash.store(key, new_value)
+      hash.freeze
+    end
+
+    # Internal: Duplicate and store key/value on new frozen hash.
+    #
+    # Similar to Hash#store for nested frozen hashes.
+    #
+    # hash  - Hash
+    # key_a - Object key. Use multiple keys for nested hashes.
+    # key_b - Object key. Use multiple keys for nested hashes.
+    # block - Receives current value at key.
+    #
+    # Examples
+    #
+    #     config = {paths: ["/bin", "/sbin"]}.freeze
+    #     new_config = hash_reassoc(config, :paths) do |paths|
+    #       paths << "/usr/local/bin"
+    #     end
+    #
+    # Returns duplicated frozen Hash.
+    def hash_reassoc(hash, key_a, key_b = nil, &block)
+      if key_b
+        hash_reassoc1(hash, key_a) do |value|
+          hash_reassoc(value, key_b, &block)
+        end
+      else
+        hash_reassoc1(hash, key_a, &block)
+      end
+    end
+
+    WHITESPACE_ORDINALS = {0x0A => "\n", 0x20 => " ", 0x09 => "\t"}
+    private_constant :WHITESPACE_ORDINALS
+
+    # Internal: Check if string has a trailing semicolon.
+    #
+    # str - String
+    #
+    # Returns true or false.
+    def string_end_with_semicolon?(str)
+      i = str.size - 1
+      while i >= 0
+        c = str[i].ord
+        i -= 1
+
+        next if WHITESPACE_ORDINALS[c]
+
+        return c === 0x3B
+      end
+
+      true
+    end
+
+    # Internal: Accumulate asset source to buffer and append a trailing
+    # semicolon if necessary.
+    #
+    # buf    - String buffer to append to
+    # source - String source to append
+    #
+    # Returns buf String.
+    def concat_javascript_sources(buf, source)
+      return buf if source.bytesize <= 0
+
+      buf << source
+      # If the source contains non-ASCII characters, indexing on it becomes O(N).
+      # This will lead to O(N^2) performance in string_end_with_semicolon?, so we should use 32 bit encoding to make sure indexing stays O(1)
+      source = source.encode(Encoding::UTF_32LE) unless source.ascii_only?
+      return buf if string_end_with_semicolon?(source)
+
+      # If the last character in the string was whitespace,
+      # such as a newline, then we want to put the semicolon
+      # before the whitespace. Otherwise append a semicolon.
+      if whitespace = WHITESPACE_ORDINALS[source[-1].ord]
+        buf[-1] = ";#{whitespace}"
+      else
+        buf << ";"
+      end
+
+      buf
+    end
+
+    # Internal: Inject into target module for the duration of the block.
+    #
+    # mod - Module
+    #
+    # Returns result of block.
+    def module_include(base, mod)
+      old_methods = {}
+
+      mod.instance_methods.each do |sym|
+        old_methods[sym] = base.instance_method(sym) if base.method_defined?(sym)
+      end
+
+      mod.instance_methods.each do |sym|
+        method = mod.instance_method(sym)
+        base.send(:define_method, sym, method)
+      end
+
+      yield
+    ensure
+      mod.instance_methods.each do |sym|
+        base.send(:undef_method, sym) if base.method_defined?(sym)
+      end
+      old_methods.each do |sym, method|
+        base.send(:define_method, sym, method)
+      end
+    end
+
+    # Internal: Post-order Depth-First search algorithm.
+    #
+    # Used for resolving asset dependencies.
+    #
+    # initial - Initial Array of nodes to traverse.
+    # block   -
+    #   node  - Current node to get children of
+    #
+    # Returns a Set of nodes.
+    def dfs(initial)
+      nodes, seen = Set.new, Set.new
+      stack = Array(initial).reverse
+
+      while node = stack.pop
+        if seen.include?(node)
+          nodes.add(node)
+        else
+          seen.add(node)
+          stack.push(node)
+          stack.concat(Array(yield node).reverse)
+        end
+      end
+
+      nodes
+    end
+
+    # Internal: Post-order Depth-First search algorithm that gathers all paths
+    # along the way.
+    #
+    # TODO: Rename function.
+    #
+    # path   - Initial Array node path
+    # block  -
+    #   node - Current node to get children of
+    #
+    # Returns an Array of node Arrays.
+    def dfs_paths(path)
+      paths = []
+      stack = [path]
+      seen  = Set.new
+
+      while path = stack.pop
+        seen.add(path.last)
+        paths << path
+
+        children = yield path.last
+        children.reverse_each do |node|
+          stack.push(path + [node]) unless seen.include?(node)
+        end
+      end
+
+      paths
+    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