sprockets 3.0.3 → 4.2.0

data/lib/sprockets/manifest.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
 require 'json'
 require 'time'
+
+require 'concurrent'
+
 require 'sprockets/manifest_utils'
 
 module Sprockets
@@ -11,7 +15,7 @@ module Sprockets
   # The JSON is part of the public API and should be considered stable. This
   # should make it easy to read from other programming languages and processes
   # that don't have sprockets loaded. See `#assets` and `#files` for more
-  # infomation about the structure.
+  # information about the structure.
   class Manifest
     include ManifestUtils
 
@@ -48,14 +52,8 @@ module Sprockets
       @directory ||= File.dirname(@filename) if @filename
 
       # If directory is given w/o filename, pick a random manifest location
-      @rename_filename = nil
       if @directory && @filename.nil?
-        @filename = find_directory_manifest(@directory)
-
-        # If legacy manifest name autodetected, mark to rename on save
-        if File.basename(@filename).start_with?("manifest")
-          @rename_filename = File.join(@directory, generate_manifest_path)
-        end
+        @filename = find_directory_manifest(@directory, logger)
       end
 
       unless @directory && @filename
@@ -114,38 +112,46 @@ module Sprockets
     # Public: Find all assets matching pattern set in environment.
     #
     # Returns Enumerator of Assets.
-    def find(*args)
+    def find(*args, &block)
       unless environment
         raise Error, "manifest requires environment for compilation"
       end
 
       return to_enum(__method__, *args) unless block_given?
 
-      paths, filters = args.flatten.partition { |arg| self.class.simple_logical_path?(arg) }
-      filters = filters.map { |arg| self.class.compile_match_filter(arg) }
-
       environment = self.environment.cached
-
-      paths.each do |path|
-        environment.find_all_linked_assets(path) do |asset|
-          yield asset
+      promises = args.flatten.map do |path|
+        Concurrent::Promise.execute(executor: executor) do
+          environment.find_all_linked_assets(path).to_a
         end
       end
 
-      if filters.any?
-        environment.logical_paths do |logical_path, filename|
-          if filters.any? { |f| f.call(logical_path, filename) }
-            environment.find_all_linked_assets(filename) do |asset|
-              yield asset
-            end
-          end
-        end
+      promises.each do |promise|
+        promise.value!.each(&block)
       end
 
       nil
     end
 
-    # Compile and write asset to directory. The asset is written to a
+    # Public: Find the source of assets by paths.
+    #
+    # Returns Enumerator of assets file content.
+    def find_sources(*args)
+      return to_enum(__method__, *args) unless block_given?
+
+      if environment
+        find(*args).each do |asset|
+          yield asset.source
+        end
+      else
+        args.each do |path|
+          asset = assets[path]
+          yield File.binread(File.join(dir, asset)) if asset
+        end
+      end
+    end
+
+    # Compile asset to directory. The asset is written to a
     # fingerprinted filename like
     # `application-2e8e9a7c6b0aafa0c9bdeec90ea30213.js`. An entry is
     # also inserted into the manifest file.
@@ -157,29 +163,46 @@ module Sprockets
         raise Error, "manifest requires environment for compilation"
       end
 
-      filenames = []
+      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,
-          'mtime'        => asset.mtime.iso8601,
+          'mtime'        => mtime,
           'size'         => asset.bytesize,
           'digest'       => asset.hexdigest,
-          'integrity'    => asset.integrity
+
+          # Deprecated: Remove beta integrity attribute in next release.
+          # Callers should DigestUtils.hexdigest_integrity_uri to compute the
+          # digest themselves.
+          'integrity'    => DigestUtils.hexdigest_integrity_uri(asset.hexdigest)
         }
         assets[asset.logical_path] = asset.digest_path
 
-        target = File.join(dir, asset.digest_path)
+        filenames << asset.filename
 
-        if File.exist?(target)
-          logger.debug "Skipping #{target}, already exists"
-        else
-          logger.info "Writing #{target}"
-          asset.write_to target
-        end
+        promise      = nil
+        exporters_for_asset(asset) do |exporter|
+          next if exporter.skip?(logger)
 
-        filenames << asset.filename
+          if promise.nil?
+            promise = Concurrent::Promise.new(executor: executor) { exporter.call }
+            concurrent_exporters << promise.execute
+          else
+            concurrent_exporters << promise.then { exporter.call }
+          end
+        end
       end
+
+      # make sure all exporters have finished before returning the main thread
+      concurrent_exporters.each(&:wait!)
       save
 
       filenames
@@ -192,6 +215,7 @@ module Sprockets
     #
     def remove(filename)
       path = File.join(dir, filename)
+      gzip = "#{path}.gz"
       logical_path = files[filename]['logical_path']
 
       if assets[logical_path] == filename
@@ -200,6 +224,7 @@ module Sprockets
 
       files.delete(filename)
       FileUtils.rm(path) if File.exist?(path)
+      FileUtils.rm(gzip) if File.exist?(gzip)
 
       save
 
@@ -230,9 +255,9 @@ module Sprockets
           # Sort by timestamp
           Time.parse(attrs['mtime'])
         }.reverse.each_with_index.drop_while { |(_, attrs), index|
-          age = [0, Time.now - Time.parse(attrs['mtime'])].max
+          _age = [0, Time.now - Time.parse(attrs['mtime'])].max
           # Keep if under age or within the count limit
-          age < age || index < count
+          _age < age || index < count
         }.each { |(path, _), _|
            # Remove old assets
           remove(path)
@@ -244,18 +269,13 @@ module Sprockets
     def clobber
       FileUtils.rm_r(directory) if File.exist?(directory)
       logger.info "Removed #{directory}"
+      # if we have an environment clear the cache too
+      environment.cache.clear if environment
       nil
     end
 
-    # Persist manfiest back to FS
+    # Persist manifest back to FS
     def save
-      if @rename_filename
-        logger.info "Renaming #{@filename} to #{@rename_filename}"
-        FileUtils.mv(@filename, @rename_filename)
-        @filename = @rename_filename
-        @rename_filename = nil
-      end
-
       data = json_encode(@data)
       FileUtils.mkdir_p File.dirname(@filename)
       PathUtils.atomic_write(@filename) do |f|
@@ -264,6 +284,36 @@ module Sprockets
     end
 
     private
+
+      # Given an asset, finds all exporters that
+      # match its mime-type.
+      #
+      # Will yield each expoter to the passed in block.
+      #
+      #     array = []
+      #     puts asset.content_type # => "application/javascript"
+      #     exporters_for_asset(asset) do |exporter|
+      #       array << exporter
+      #     end
+      #     # puts array => [Exporters::FileExporter, Exporters::ZlibExporter]
+      def exporters_for_asset(asset)
+        exporters = [Exporters::FileExporter]
+
+        environment.exporters.each do |mime_type, exporter_list|
+          next unless asset.content_type
+          next unless environment.match_mime_type? asset.content_type, mime_type
+          exporter_list.each do |exporter|
+            exporters << exporter
+          end
+        end
+
+        exporters.uniq!
+
+        exporters.each do |exporter|
+          yield exporter.new(asset: asset, environment: environment, directory: dir)
+        end
+      end
+
       def json_decode(obj)
         JSON.parse(obj, create_additions: false)
       end
@@ -281,5 +331,9 @@ module Sprockets
           logger
         end
       end
+
+      def executor
+        @executor ||= environment.export_concurrent ? :fast : :immediate
+      end
   end
 end

data/lib/sprockets/manifest_utils.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'securerandom'
+require 'logger'
 
 module Sprockets
   # Public: Manifest utilities.
@@ -6,7 +8,6 @@ module Sprockets
     extend self
 
     MANIFEST_RE = /^\.sprockets-manifest-[0-9a-f]{32}.json$/
-    LEGACY_MANIFEST_RE = /^manifest(-[0-9a-f]{32})?.json$/
 
     # Public: Generate a new random manifest path.
     #
@@ -33,12 +34,14 @@ module Sprockets
     #     # => "/app/public/assets/.sprockets-manifest-abc123.json"
     #
     # Returns String filename.
-    def find_directory_manifest(dirname)
+    def find_directory_manifest(dirname, logger = Logger.new($stderr))
       entries = File.directory?(dirname) ? Dir.entries(dirname) : []
-      entry = entries.find { |e| e =~ MANIFEST_RE } ||
-        # Deprecated: Will be removed in 4.x
-        entries.find { |e| e =~ LEGACY_MANIFEST_RE } ||
-        generate_manifest_path
+      manifest_entries = entries.select { |e| e =~ MANIFEST_RE }
+      if manifest_entries.length > 1
+        manifest_entries.sort!
+        logger.warn("Found multiple manifests: #{manifest_entries}. Choosing the first alphabetically: #{manifest_entries.first}")
+      end
+      entry = manifest_entries.first || generate_manifest_path
       File.join(dirname, entry)
     end
   end

data/lib/sprockets/mime.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/encoding_utils'
 require 'sprockets/http_utils'
 require 'sprockets/utils'
@@ -36,29 +37,18 @@ module Sprockets
 
     # Public: Register a new mime type.
     #
-    # mime_type - String MIME Type
-    # options - Hash
-    #   extensions: Array of String extnames
-    #   charset: Proc/Method that detects the charset of a file.
-    #            See EncodingUtils.
+    # mime_type  - String MIME Type
+    # extensions - Array of String extnames
+    # charset    - Proc/Method that detects the charset of a file.
+    #              See EncodingUtils.
     #
     # Returns nothing.
-    def register_mime_type(mime_type, options = {})
-      # Legacy extension argument, will be removed from 4.x
-      if options.is_a?(String)
-        options = { extensions: [options] }
-      end
-
-      extnames = Array(options[:extensions]).map { |extname|
-        Sprockets::Utils.normalize_extension(extname)
-      }
+    def register_mime_type(mime_type, extensions: [], charset: nil)
+      extnames = Array(extensions)
 
-      charset = options[:charset]
       charset ||= :default if mime_type.start_with?('text/')
       charset = EncodingUtils::CHARSET_DETECT[charset] if charset.is_a?(Symbol)
 
-      self.computed_config = {}
-
       self.config = hash_reassoc(config, :mime_exts) do |mime_exts|
         extnames.each do |extname|
           mime_exts[extname] = mime_type
@@ -97,34 +87,10 @@ module Sprockets
       data = File.binread(filename)
 
       if detect = mime_type_charset_detecter(content_type)
-        detect.call(data).encode(Encoding::UTF_8, :universal_newline => true)
+        detect.call(data).encode(Encoding::UTF_8, universal_newline: true)
       else
         data
       end
     end
-
-    private
-      def extname_map
-        self.computed_config[:_extnames] ||= compute_extname_map
-      end
-
-      def compute_extname_map
-        graph = {}
-
-        ([nil] + pipelines.keys.map(&:to_s)).each do |pipeline|
-          pipeline_extname = ".#{pipeline}" if pipeline
-          ([[nil, nil]] + config[:mime_exts].to_a).each do |format_extname, format_type|
-            4.times do |n|
-              config[:engines].keys.permutation(n).each do |engine_extnames|
-                key = "#{pipeline_extname}#{format_extname}#{engine_extnames.join}"
-                type = format_type || config[:engine_mime_types][engine_extnames.first]
-                graph[key] = {type: type, engines: engine_extnames, pipeline: pipeline}
-              end
-            end
-          end
-        end
-
-        graph
-      end
   end
 end

data/lib/sprockets/npm.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require 'json'
+
+module Sprockets
+  module Npm
+    # Internal: Override resolve_alternates to install package.json behavior.
+    #
+    # load_path    - String environment path
+    # logical_path - String path relative to base
+    #
+    # Returns candidate filenames.
+    def resolve_alternates(load_path, logical_path)
+      candidates, deps = super
+
+      dirname = File.join(load_path, logical_path)
+
+      if directory?(dirname)
+        filename = File.join(dirname, 'package.json')
+
+        if self.file?(filename)
+          deps << build_file_digest_uri(filename)
+          read_package_directives(dirname, filename) do |path|
+            if file?(path)
+              candidates << path
+            end
+          end
+        end
+      end
+
+      return candidates, deps
+    end
+
+    # Internal: Read package.json's main and style directives.
+    #
+    # dirname  - String path to component directory.
+    # filename - String path to package.json.
+    #
+    # Returns nothing.
+    def read_package_directives(dirname, filename)
+      package = JSON.parse(File.read(filename), create_additions: false)
+
+      case package['main']
+      when String
+        yield File.expand_path(package['main'], dirname)
+      when nil
+        yield File.expand_path('index.js', dirname)
+      end
+
+      yield File.expand_path(package['style'], dirname) if package['style']
+    end
+  end
+end

data/lib/sprockets/path_dependency_utils.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 require 'sprockets/path_utils'
 require 'sprockets/uri_utils'
@@ -41,7 +42,7 @@ module Sprockets
     #
     # Returns an Array of entry names and a Set of dependency URIs.
     def entries_with_dependencies(path)
-      return entries(path), file_digest_dependency_set(path)
+      return entries(path), Set.new([build_file_digest_uri(path)])
     end
 
     # Internal: List directory filenames and associated Stats under a
@@ -53,16 +54,7 @@ module Sprockets
     #
     # Returns an Array of filenames and a Set of dependency URIs.
     def stat_directory_with_dependencies(dir)
-      return stat_directory(dir).to_a, file_digest_dependency_set(dir)
-    end
-
-    # Internal: Returns a set of dependencies for a particular path.
-    #
-    # path - String directory path
-    #
-    # Returns a Set of dependency URIs.
-    def file_digest_dependency_set(path)
-      Set.new([build_file_digest_uri(path)])
+      return stat_directory(dir).to_a, Set.new([build_file_digest_uri(dir)])
     end
 
     # Internal: List directory filenames and associated Stats under an entire

data/lib/sprockets/path_digest_utils.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/digest_utils'
 require 'sprockets/path_utils'
 
@@ -15,7 +16,7 @@ module Sprockets
     def stat_digest(path, stat)
       if stat.directory?
         # If its a directive, digest the list of filenames
-        digest_class.digest(self.entries(path).join(','))
+        digest_class.digest(self.entries(path).join(','.freeze))
       elsif stat.file?
         # If its a file, digest the contents
         digest_class.file(path.to_s).digest

data/lib/sprockets/path_utils.rb

@@ -1,5 +1,4 @@
-require 'fileutils'
-
+# frozen_string_literal: true
 module Sprockets
   # Internal: File and path related utilities. Mixed into Environment.
   #
@@ -7,6 +6,7 @@ module Sprockets
   # when code actually wants to reference ::FileUtils.
   module PathUtils
     extend self
+    require 'pathname'
 
     # Public: Like `File.stat`.
     #
@@ -55,9 +55,14 @@ module Sprockets
     # Returns an empty `Array` if the directory does not exist.
     def entries(path)
       if File.directory?(path)
-        Dir.entries(path, :encoding => Encoding.default_internal).reject! { |entry|
-          entry =~ /^\.|~$|^\#.*\#$/
-        }.sort!
+        entries = Dir.entries(path, encoding: Encoding.default_internal)
+        entries.reject! { |entry|
+          entry.start_with?(".".freeze) ||
+            (entry.start_with?("#".freeze) && entry.end_with?("#".freeze)) ||
+            entry.end_with?("~".freeze)
+        }
+        entries.sort!
+        entries
       else
         []
       end
@@ -69,8 +74,6 @@ module Sprockets
     #
     # Returns true if path is absolute, otherwise false.
     if File::ALT_SEPARATOR
-      require 'pathname'
-
       # On Windows, ALT_SEPARATOR is \
       # Delegate to Pathname since the logic gets complex.
       def absolute_path?(path)
@@ -78,7 +81,7 @@ module Sprockets
       end
     else
       def absolute_path?(path)
-        path[0] == File::SEPARATOR
+        path.start_with?(File::SEPARATOR)
       end
     end
 
@@ -95,7 +98,58 @@ module Sprockets
     #
     # Returns true if path is relative, otherwise false.
     def relative_path?(path)
-      path =~ /^\.\.?($|#{SEPARATOR_PATTERN})/ ? true : false
+      path.match?(/^\.\.?($|#{SEPARATOR_PATTERN})/) ? true : false
+    end
+
+    # Public: Get relative path from `start` to `dest`.
+    #
+    # start - String start path (file or dir)
+    # dest  - String destination path
+    #
+    # Returns relative String path from `start` to `dest`
+    def relative_path_from(start, dest)
+      start, dest = Pathname.new(start), Pathname.new(dest)
+      start = start.dirname unless start.directory?
+      dest.relative_path_from(start).to_s
+    end
+
+    # Public: Joins path to base path.
+    #
+    # base - Root path
+    # path - Extending path
+    #
+    # Example
+    #
+    #     join('base/path/', '../file.js')
+    #     # => 'base/file.js'
+    #
+    # Returns string path starting from base and ending at path
+    def join(base, path)
+      (Pathname.new(base) + path).to_s
+    end
+
+    # Public: Sets pipeline for path
+    #
+    # path       - String path
+    # extensions - List of file extensions
+    # pipeline   - Pipeline
+    #
+    # Examples
+    #
+    #     set_pipeline('path/file.js.erb', config[:mime_exts], config[:pipeline_exts], :source)
+    #     # => 'path/file.source.js.erb'
+    #
+    #     set_pipeline('path/some.file.source.js.erb', config[:mime_exts], config[:pipeline_exts], :debug)
+    #     # => 'path/some.file.debug.js.erb'
+    #
+    # Returns string path with pipeline parsed in
+    def set_pipeline(path, mime_exts, pipeline_exts, pipeline)
+      extension, _ = match_path_extname(path, mime_exts)
+      path.chomp!(extension)
+      pipeline_old, _ = match_path_extname(path, pipeline_exts)
+      path.chomp!(pipeline_old)
+
+      "#{path}.#{pipeline}#{extension}"
     end
 
     # Internal: Get relative path for root path and subpath.
@@ -107,8 +161,8 @@ module Sprockets
     # subpath is outside of path.
     def split_subpath(path, subpath)
       return "" if path == subpath
-      path = File.join(path, '')
-      if subpath.start_with?(path)
+      path = File.join(path, ''.freeze)
+      if subpath&.start_with?(path)
         subpath[path.length..-1]
       else
         nil
@@ -146,16 +200,47 @@ module Sprockets
     #
     # Returns [String extname, Object value] or nil nothing matched.
     def match_path_extname(path, extensions)
-      match, key = nil, ""
-      path_extnames(path).reverse_each do |extname|
-        key.prepend(extname)
-        if value = extensions[key]
-          match = [key.dup, value]
-        elsif match
-          break
+      basename = File.basename(path)
+
+      i = basename.index('.'.freeze)
+      while i && i < basename.length - 1
+        extname = basename[i..-1]
+        if value = extensions[extname]
+          return extname, value
+        end
+
+        i = basename.index('.'.freeze, i+1)
+      end
+
+      nil
+    end
+
+    # Internal: Match paths in a directory against available extensions.
+    #
+    # path       - String directory
+    # basename   - String basename of target file
+    # extensions - Hash of String extnames to values
+    #
+    # Examples
+    #
+    #     exts = { ".js" => "application/javascript" }
+    #     find_matching_path_for_extensions("app/assets", "application", exts)
+    #     # => ["app/assets/application.js", "application/javascript"]
+    #
+    # Returns an Array of [String path, Object value] matches.
+    def find_matching_path_for_extensions(path, basename, extensions)
+      matches = []
+      entries(path).each do |entry|
+        next unless File.basename(entry).start_with?(basename)
+        extname, value = match_path_extname(entry, extensions)
+        if basename == entry.chomp(extname)
+          filename = File.join(path, entry)
+          if file?(filename)
+            matches << [filename, value]
+          end
         end
       end
-      match
+      matches
     end
 
     # Internal: Returns all parents for path
@@ -267,16 +352,16 @@ module Sprockets
         Thread.current.object_id,
         Process.pid,
         rand(1000000)
-      ].join('.')
+      ].join('.'.freeze)
       tmpname = File.join(dirname, basename)
 
       File.open(tmpname, 'wb+') do |f|
         yield f
       end
 
-      FileUtils.mv(tmpname, filename)
+      File.rename(tmpname, filename)
     ensure
-      FileUtils.rm(tmpname) if File.exist?(tmpname)
+      File.delete(tmpname) if File.exist?(tmpname)
     end
   end
 end

data/lib/sprockets/paths.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/path_utils'
 require 'sprockets/utils'