sprockets 3.0.0 → 4.0.0

data/lib/sprockets/cache/file_store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 require 'logger'
 require 'sprockets/encoding_utils'
@@ -19,7 +20,9 @@ module Sprockets
     class FileStore
       # Internal: Default key limit for store.
       DEFAULT_MAX_SIZE = 25 * 1024 * 1024
-
+      EXCLUDED_DIRS = ['.', '..'].freeze
+      GITKEEP_FILES = ['.gitkeep', '.keep'].freeze
+      
       # Internal: Default standard error fatal logger.
       #
       # Returns a Logger.
@@ -32,11 +35,12 @@ module Sprockets
       # Public: Initialize the cache store.
       #
       # root     - A String path to a directory to persist cached values to.
-      # max_size - A Integer of the maximum number of keys the store will hold.
-      #            (default: 1000).
+      # max_size - A Integer of the maximum size the store will hold (in bytes).
+      #            (default: 25MB).
+      # logger   - The logger to which some info will be printed.
+      #            (default logger level is FATAL and won't output anything).
       def initialize(root, max_size = DEFAULT_MAX_SIZE, logger = self.class.default_logger)
         @root     = root
-        @size     = find_caches.inject(0) { |n, (_, stat)| n + stat.size }
         @max_size = max_size
         @gc_size  = max_size * 0.75
         @logger   = logger
@@ -107,11 +111,11 @@ module Sprockets
         # Write data
         PathUtils.atomic_write(path) do |f|
           f.write(raw)
-          @size += f.size unless exists
+          @size = size + f.size unless exists
         end
 
         # GC if necessary
-        gc! if @size > @max_size
+        gc! if size > @max_size
 
         value
       end
@@ -120,7 +124,24 @@ module Sprockets
       #
       # Returns String.
       def inspect
-        "#<#{self.class} size=#{@size}/#{@max_size}>"
+        "#<#{self.class} size=#{size}/#{@max_size}>"
+      end
+
+      # Public: Clear the cache
+      #
+      # adapted from ActiveSupport::Cache::FileStore#clear
+      #
+      # Deletes all items from the cache. In this case it deletes all the entries in the specified
+      # file store directory except for .keep or .gitkeep. Be careful which directory is specified
+      # as @root because everything in that directory will be deleted.
+      #
+      # Returns true
+      def clear(options=nil)
+        if File.exist?(@root)
+          root_dirs = Dir.entries(@root).reject { |f| (EXCLUDED_DIRS + GITKEEP_FILES).include?(f) }
+          FileUtils.rm_r(root_dirs.collect{ |f| File.join(@root, f) })
+        end
+        true
       end
 
       private
@@ -138,6 +159,10 @@ module Sprockets
           }.sort_by { |_, stat| stat.mtime.to_i }
         end
 
+        def size
+          @size ||= compute_size(find_caches)
+        end
+
         def compute_size(caches)
           caches.inject(0) { |sum, (_, stat)| sum + stat.size }
         end

data/lib/sprockets/cache/memory_store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sprockets
   class Cache
     # Public: Basic in memory LRU cache.
@@ -61,6 +62,14 @@ module Sprockets
       def inspect
         "#<#{self.class} size=#{@cache.size}/#{@max_size}>"
       end
+
+      # Public: Clear the cache
+      #
+      # Returns true
+      def clear(options=nil)
+        @cache.clear
+        true
+      end
     end
   end
 end

data/lib/sprockets/cache/null_store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sprockets
   class Cache
     # Public: A compatible cache store that doesn't store anything. Used by
@@ -41,6 +42,13 @@ module Sprockets
       def inspect
         "#<#{self.class}>"
       end
+
+      # Public: Simulate clearing the cache
+      #
+      # Returns true
+      def clear(options=nil)
+        true
+      end
     end
   end
 end

data/lib/sprockets/cache.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'logger'
 require 'sprockets/digest_utils'
 
@@ -35,6 +36,12 @@ module Sprockets
   #
   #   Returns argument value.
   #
+  # clear(options)
+  #
+  #   Clear the entire cache. Be careful with this method since it could
+  #   affect other processes if shared cache is being used.
+  #
+  #   The options hash is passed to the underlying cache implementation.
   class Cache
     # Builtin cache stores.
     autoload :FileStore,   'sprockets/cache/file_store'
@@ -44,7 +51,7 @@ module Sprockets
     # Internal: Cache key version for this class. Rarely should have to change
     # unless the cache format radically changes. Will be bump on major version
     # releases though.
-    VERSION = '3.0'
+    VERSION = '4.0.0'
 
     def self.default_logger
       logger = Logger.new($stderr)
@@ -60,7 +67,7 @@ module Sprockets
     # cache - A compatible backend cache store instance.
     def initialize(cache = nil, logger = self.class.default_logger)
       @cache_wrapper = get_cache_wrapper(cache)
-      @fetch_cache   = Cache::MemoryStore.new(4096)
+      @fetch_cache   = Cache::MemoryStore.new(1024)
       @logger        = logger
     end
 
@@ -97,7 +104,7 @@ module Sprockets
     # Public: Low level API to retrieve item directly from the backend cache
     # store.
     #
-    # This API may be used publicaly, but may have undefined behavior
+    # This API may be used publicly, but may have undefined behavior
     # depending on the backend store being used. Prefer the
     # Cache#fetch API over using this.
     #
@@ -120,7 +127,7 @@ module Sprockets
 
     # Public: Low level API to set item directly to the backend cache store.
     #
-    # This API may be used publicaly, but may have undefined behavior
+    # This API may be used publicly, but may have undefined behavior
     # depending on the backend store being used. Prefer the
     # Cache#fetch API over using this.
     #
@@ -143,6 +150,14 @@ module Sprockets
       "#<#{self.class} local=#{@fetch_cache.inspect} store=#{@cache_wrapper.cache.inspect}>"
     end
 
+    # Public: Clear cache
+    #
+    # Returns truthy on success, potentially raises exception on failure
+    def clear(options=nil)
+      @cache_wrapper.clear
+      @fetch_cache.clear
+    end
+
     private
       # Internal: Expand object cache key into a short String key.
       #
@@ -153,7 +168,9 @@ module Sprockets
       #
       # Returns a String with a length less than 250 characters.
       def expand_key(key)
-        "sprockets/v#{VERSION}/#{DigestUtils.pack_urlsafe_base64digest(DigestUtils.digest(key))}"
+        digest_key = DigestUtils.pack_urlsafe_base64digest(DigestUtils.digest(key))
+        namespace = digest_key[0, 2]
+        "sprockets/v#{VERSION}/#{namespace}/#{digest_key}"
       end
 
       PEEK_SIZE = 100
@@ -209,6 +226,16 @@ module Sprockets
         def set(key, value)
           cache.set(key, value)
         end
+
+        def clear(options=nil)
+          # dalli has a #flush method so try it
+          if cache.respond_to?(:flush)
+            cache.flush(options)
+          else
+            cache.clear(options)
+          end
+          true
+        end
       end
 
       class HashWrapper < Wrapper
@@ -219,6 +246,11 @@ module Sprockets
         def set(key, value)
           cache[key] = value
         end
+
+        def clear(options=nil)
+          cache.clear
+          true
+        end
       end
 
       class ReadWriteWrapper < Wrapper
@@ -229,6 +261,11 @@ module Sprockets
         def set(key, value)
           cache.write(key, value)
         end
+
+        def clear(options=nil)
+          cache.clear(options)
+          true
+        end
       end
   end
 end

data/lib/sprockets/cached_environment.rb

@@ -1,26 +1,26 @@
+# frozen_string_literal: true
 require 'sprockets/base'
 
 module Sprockets
-  # `Cached` is a special cached version of `Environment`.
+  # `CachedEnvironment` is a special cached version of `Environment`.
   #
   # The expection is that all of its file system methods are cached
-  # for the instances lifetime. This makes `Cached` much faster. This
+  # for the instances lifetime. This makes `CachedEnvironment` much faster. This
   # behavior is ideal in production environments where the file system
   # is immutable.
   #
-  # `Cached` should not be initialized directly. Instead use
+  # `CachedEnvironment` should not be initialized directly. Instead use
   # `Environment#cached`.
   class CachedEnvironment < Base
     def initialize(environment)
       initialize_configuration(environment)
 
       @cache   = environment.cache
-      @stats   = Hash.new { |h, k| h[k] = _stat(k) }
-      @entries = Hash.new { |h, k| h[k] = _entries(k) }
-      @uris    = Hash.new { |h, k| h[k] = _load(k) }
-
-      @processor_cache_keys  = Hash.new { |h, k| h[k] = _processor_cache_key(k) }
-      @resolved_dependencies = Hash.new { |h, k| h[k] = _resolve_dependency(k) }
+      @stats   = {}
+      @entries = {}
+      @uris    = {}
+      @processor_cache_keys = {}
+      @resolved_dependencies = {}
     end
 
     # No-op return self as cached environment.
@@ -30,33 +30,28 @@ module Sprockets
     alias_method :index, :cached
 
     # Internal: Cache Environment#entries
-    alias_method :_entries, :entries
     def entries(path)
-      @entries[path]
+      @entries[path] ||= super(path)
     end
 
     # Internal: Cache Environment#stat
-    alias_method :_stat, :stat
     def stat(path)
-      @stats[path]
+      @stats[path] ||= super(path)
     end
 
     # Internal: Cache Environment#load
-    alias_method :_load, :load
     def load(uri)
-      @uris[uri]
+      @uris[uri] ||= super(uri)
     end
 
     # Internal: Cache Environment#processor_cache_key
-    alias_method :_processor_cache_key, :processor_cache_key
     def processor_cache_key(str)
-      @processor_cache_keys[str]
+      @processor_cache_keys[str] ||= super(str)
     end
 
     # Internal: Cache Environment#resolve_dependency
-    alias_method :_resolve_dependency, :resolve_dependency
     def resolve_dependency(str)
-      @resolved_dependencies[str]
+      @resolved_dependencies[str] ||= super(str)
     end
 
     private

data/lib/sprockets/closure_compressor.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'sprockets/autoload'
+require 'sprockets/digest_utils'
 
 module Sprockets
   # Public: Closure Compiler minifier.
@@ -34,20 +36,13 @@ module Sprockets
     attr_reader :cache_key
 
     def initialize(options = {})
-      @compiler = Autoload::Closure::Compiler.new(options)
-      @cache_key = [
-        self.class.name,
-        Autoload::Closure::VERSION,
-        Autoload::Closure::COMPILER_VERSION,
-        VERSION,
-        options
-      ].freeze
+      @options = options
+      @cache_key = "#{self.class.name}:#{Autoload::Closure::VERSION}:#{Autoload::Closure::COMPILER_VERSION}:#{VERSION}:#{DigestUtils.digest(options)}".freeze
     end
 
     def call(input)
-      input[:cache].fetch(@cache_key + [input[:data]]) do
-        @compiler.compile(input[:data])
-      end
+      @compiler ||= Autoload::Closure::Compiler.new(@options)
+      @compiler.compile(input[:data])
     end
   end
 end

data/lib/sprockets/coffee_script_processor.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'sprockets/autoload'
+require 'sprockets/source_map_utils'
 
 module Sprockets
   # Processor engine class for the CoffeeScript compiler.
@@ -6,20 +8,32 @@ module Sprockets
   #
   # For more infomation see:
   #
-  #   https://github.com/josh/ruby-coffee-script
+  #   https://github.com/rails/ruby-coffee-script
   #
   module CoffeeScriptProcessor
-    VERSION = '1'
+    VERSION = '2'
 
     def self.cache_key
-      @cache_key ||= [name, Autoload::CoffeeScript::Source.version, VERSION].freeze
+      @cache_key ||= "#{name}:#{Autoload::CoffeeScript::Source.version}:#{VERSION}".freeze
     end
 
     def self.call(input)
       data = input[:data]
-      input[:cache].fetch(self.cache_key + [data]) do
-        Autoload::CoffeeScript.compile(data)
+
+      js, map = input[:cache].fetch([self.cache_key, data]) do
+        result = Autoload::CoffeeScript.compile(
+          data,
+          sourceMap: "v3",
+          sourceFiles: [File.basename(input[:filename])],
+          generatedFile: input[:filename]
+        )
+        [result['js'], JSON.parse(result['v3SourceMap'])]
       end
+
+      map = SourceMapUtils.format_source_map(map, input)
+      map = SourceMapUtils.combine_source_maps(input[:metadata][:map], map)
+
+      { data: js, map: map }
     end
   end
 end

data/lib/sprockets/compressing.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/utils'
 
 module Sprockets
@@ -10,6 +11,24 @@ module Sprockets
       config[:compressors]
     end
 
+    # Public: Register a new compressor `klass` at `sym` for `mime_type`.
+    #
+    # Registering a processor allows it to be looked up by `sym` later when
+    # assigning a JavaScript or CSS compressor.
+    #
+    # Compressors only operate on JavaScript and CSS. If you want to compress a
+    # different type of asset, use a processor instead.
+    #
+    # Examples
+    #
+    #     register_compressor 'text/css', :my_sass, MySassCompressor
+    #     css_compressor = :my_sass
+    #
+    # mime_type - String MIME Type (one of: 'test/css' or 'application/javascript').
+    # sym       - Symbol registration address.
+    # klass     - The compressor class.
+    #
+    # Returns nothing.
     def register_compressor(mime_type, sym, klass)
       self.config = hash_reassoc(config, :compressors, mime_type) do |compressors|
         compressors[sym] = klass
@@ -35,7 +54,7 @@ module Sprockets
       if compressor.is_a?(Symbol)
         @css_compressor = klass = config[:compressors]['text/css'][compressor] || raise(Error, "unknown compressor: #{compressor}")
       elsif compressor.respond_to?(:compress)
-        klass = LegacyProcProcessor.new(:css_compressor, proc { |context, data| compressor.compress(data) })
+        klass = proc { |input| compressor.compress(input[:data]) }
         @css_compressor = :css_compressor
       else
         @css_compressor = klass = compressor
@@ -62,7 +81,7 @@ module Sprockets
       if compressor.is_a?(Symbol)
         @js_compressor = klass = config[:compressors]['application/javascript'][compressor] || raise(Error, "unknown compressor: #{compressor}")
       elsif compressor.respond_to?(:compress)
-        klass = LegacyProcProcessor.new(:js_compressor, proc { |context, data| compressor.compress(data) })
+        klass = proc { |input| compressor.compress(input[:data]) }
         @js_compressor = :js_compressor
       else
         @js_compressor = klass = compressor
@@ -70,5 +89,46 @@ module Sprockets
 
       register_bundle_processor 'application/javascript', klass
     end
+
+    # Public: Checks if Gzip is enabled.
+    def gzip?
+      config[:gzip_enabled]
+    end
+
+    # Public: Checks if Gzip is disabled.
+    def skip_gzip?
+      !gzip?
+    end
+
+    # Public: Enable or disable the creation of Gzip files.
+    #
+    # To disable gzip generation set to a falsey value:
+    #
+    #     environment.gzip = false
+    #
+    # To enable set to a truthy value. By default zlib wil
+    # be used to gzip assets. If you have the Zopfli gem
+    # installed you can specify the zopfli algorithm to be used
+    # instead:
+    #
+    #     environment.gzip = :zopfli
+    #
+    def gzip=(gzip)
+      self.config = config.merge(gzip_enabled: gzip).freeze
+
+      case gzip
+      when false, nil
+        self.unregister_exporter Exporters::ZlibExporter
+        self.unregister_exporter Exporters::ZopfliExporter
+      when :zopfli
+        self.unregister_exporter Exporters::ZlibExporter
+        self.register_exporter '*/*', Exporters::ZopfliExporter
+      else
+        self.unregister_exporter Exporters::ZopfliExporter
+        self.register_exporter '*/*', Exporters::ZlibExporter
+      end
+
+      gzip
+    end
   end
 end

data/lib/sprockets/configuration.rb

@@ -1,27 +1,25 @@
+# frozen_string_literal: true
 require 'sprockets/compressing'
 require 'sprockets/dependencies'
-require 'sprockets/engines'
 require 'sprockets/mime'
 require 'sprockets/paths'
 require 'sprockets/processing'
+require 'sprockets/exporting'
 require 'sprockets/transformers'
 require 'sprockets/utils'
 
 module Sprockets
   module Configuration
-    include Paths, Mime, Engines, Transformers, Processing, Compressing, Dependencies, Utils
+    include Paths, Mime, Transformers, Processing, Exporting, Compressing, Dependencies, Utils
 
     def initialize_configuration(parent)
       @config = parent.config
-      @computed_config = parent.computed_config
       @logger = parent.logger
       @context_class = Class.new(parent.context_class)
     end
 
     attr_reader :config
 
-    attr_accessor :computed_config
-
     def config=(config)
       raise TypeError, "can't assign mutable config" unless config.frozen?
       @config = config
@@ -69,8 +67,6 @@ module Sprockets
       self.config = config.merge(digest_class: klass).freeze
     end
 
-    # Deprecated: Get `Context` class.
-    #
     # This class maybe mutated and mixed in with custom helpers.
     #
     #     environment.context_class.instance_eval do