sprockets 2.3.2 → 3.0.0

data/lib/sprockets/cache/memory_store.rb

@@ -0,0 +1,66 @@
+module Sprockets
+  class Cache
+    # Public: Basic in memory LRU cache.
+    #
+    # Assign the instance to the Environment#cache.
+    #
+    #     environment.cache = Sprockets::Cache::MemoryStore.new(1000)
+    #
+    # See Also
+    #
+    #   ActiveSupport::Cache::MemoryStore
+    #
+    class MemoryStore
+      # Internal: Default key limit for store.
+      DEFAULT_MAX_SIZE = 1000
+
+      # Public: Initialize the cache store.
+      #
+      # max_size - A Integer of the maximum number of keys the store will hold.
+      #            (default: 1000).
+      def initialize(max_size = DEFAULT_MAX_SIZE)
+        @max_size = max_size
+        @cache = {}
+      end
+
+      # Public: Retrieve value from cache.
+      #
+      # This API should not be used directly, but via the Cache wrapper API.
+      #
+      # key - String cache key.
+      #
+      # Returns Object or nil or the value is not set.
+      def get(key)
+        exists = true
+        value = @cache.delete(key) { exists = false }
+        if exists
+          @cache[key] = value
+        else
+          nil
+        end
+      end
+
+      # Public: Set a key and value in the cache.
+      #
+      # This API should not be used directly, but via the Cache wrapper API.
+      #
+      # key   - String cache key.
+      # value - Object value.
+      #
+      # Returns Object value.
+      def set(key, value)
+        @cache.delete(key)
+        @cache[key] = value
+        @cache.shift if @cache.size > @max_size
+        value
+      end
+
+      # Public: Pretty inspect
+      #
+      # Returns String.
+      def inspect
+        "#<#{self.class} size=#{@cache.size}/#{@max_size}>"
+      end
+    end
+  end
+end

data/lib/sprockets/cache/null_store.rb

@@ -0,0 +1,46 @@
+module Sprockets
+  class Cache
+    # Public: A compatible cache store that doesn't store anything. Used by
+    # default when no Environment#cache is configured.
+    #
+    # Assign the instance to the Environment#cache.
+    #
+    #     environment.cache = Sprockets::Cache::NullStore.new
+    #
+    # See Also
+    #
+    #   ActiveSupport::Cache::NullStore
+    #
+    class NullStore
+      # Public: Simulate a cache miss.
+      #
+      # This API should not be used directly, but via the Cache wrapper API.
+      #
+      # key - String cache key.
+      #
+      # Returns nil.
+      def get(key)
+        nil
+      end
+
+      # Public: Simulate setting a value in the cache.
+      #
+      # This API should not be used directly, but via the Cache wrapper API.
+      #
+      # key   - String cache key.
+      # value - Object value.
+      #
+      # Returns Object value.
+      def set(key, value)
+        value
+      end
+
+      # Public: Pretty inspect
+      #
+      # Returns String.
+      def inspect
+        "#<#{self.class}>"
+      end
+    end
+  end
+end

data/lib/sprockets/cache.rb

@@ -0,0 +1,234 @@
+require 'logger'
+require 'sprockets/digest_utils'
+
+module Sprockets
+  # Public: Wrapper interface to backend cache stores. Ensures a consistent API
+  # even when the backend uses get/set or read/write.
+  #
+  # Public cache interface
+  #
+  # Always assign the backend store instance to Environment#cache=.
+  #
+  #     environment.cache = Sprockets::Cache::MemoryStore.new(1000)
+  #
+  # Environment#cache will always return a wrapped Cache interface. See the
+  # methods marked public on this class.
+  #
+  #
+  # Backend cache interface
+  #
+  # The Backend cache store must implement two methods.
+  #
+  # get(key)
+  #
+  #   key - An opaque String with a length less than 250 characters.
+  #
+  #   Returns an JSON serializable object.
+  #
+  # set(key, value)
+  #
+  #   Will only be called once per key. Setting a key "foo" with value "bar",
+  #   then later key "foo" with value "baz" is an undefined behavior.
+  #
+  #   key   - An opaque String with a length less than 250 characters.
+  #   value - A JSON serializable object.
+  #
+  #   Returns argument value.
+  #
+  class Cache
+    # Builtin cache stores.
+    autoload :FileStore,   'sprockets/cache/file_store'
+    autoload :MemoryStore, 'sprockets/cache/memory_store'
+    autoload :NullStore,   'sprockets/cache/null_store'
+
+    # 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'
+
+    def self.default_logger
+      logger = Logger.new($stderr)
+      logger.level = Logger::FATAL
+      logger
+    end
+
+    # Internal: Wrap a backend cache store.
+    #
+    # Always assign a backend cache store instance to Environment#cache= and
+    # use Environment#cache to retreive a wrapped interface.
+    #
+    # 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)
+      @logger        = logger
+    end
+
+    # Public: Prefer API to retrieve and set values in the cache store.
+    #
+    # key   - JSON serializable key
+    # block -
+    #   Must return a consistent JSON serializable object for the given key.
+    #
+    # Examples
+    #
+    #   cache.fetch("foo") { "bar" }
+    #
+    # Returns a JSON serializable object.
+    def fetch(key)
+      start = Time.now.to_f
+      expanded_key = expand_key(key)
+      value = @fetch_cache.get(expanded_key)
+      if value.nil?
+        value = @cache_wrapper.get(expanded_key)
+        if value.nil?
+          value = yield
+          @cache_wrapper.set(expanded_key, value)
+          @logger.debug do
+            ms = "(#{((Time.now.to_f - start) * 1000).to_i}ms)"
+            "Sprockets Cache miss #{peek_key(key)}  #{ms}"
+          end
+        end
+        @fetch_cache.set(expanded_key, value)
+      end
+      value
+    end
+
+    # Public: Low level API to retrieve item directly from the backend cache
+    # store.
+    #
+    # This API may be used publicaly, but may have undefined behavior
+    # depending on the backend store being used. Prefer the
+    # Cache#fetch API over using this.
+    #
+    # key   - JSON serializable key
+    # local - Check local cache first (default: false)
+    #
+    # Returns a JSON serializable object or nil if there was a cache miss.
+    def get(key, local = false)
+      expanded_key = expand_key(key)
+
+      if local && value = @fetch_cache.get(expanded_key)
+        return value
+      end
+
+      value = @cache_wrapper.get(expanded_key)
+      @fetch_cache.set(expanded_key, value) if local
+
+      value
+    end
+
+    # Public: Low level API to set item directly to the backend cache store.
+    #
+    # This API may be used publicaly, but may have undefined behavior
+    # depending on the backend store being used. Prefer the
+    # Cache#fetch API over using this.
+    #
+    # key   - JSON serializable key
+    # value - A consistent JSON serializable object for the given key. Setting
+    #         a different value for the given key has undefined behavior.
+    # local - Set on local cache (default: false)
+    #
+    # Returns the value argument.
+    def set(key, value, local = false)
+      expanded_key = expand_key(key)
+      @fetch_cache.set(expanded_key, value) if local
+      @cache_wrapper.set(expanded_key, value)
+    end
+
+    # Public: Pretty inspect
+    #
+    # Returns String.
+    def inspect
+      "#<#{self.class} local=#{@fetch_cache.inspect} store=#{@cache_wrapper.cache.inspect}>"
+    end
+
+    private
+      # Internal: Expand object cache key into a short String key.
+      #
+      # The String should be under 250 characters so its compatible with
+      # Memcache.
+      #
+      # key - JSON serializable key
+      #
+      # Returns a String with a length less than 250 characters.
+      def expand_key(key)
+        "sprockets/v#{VERSION}/#{DigestUtils.pack_urlsafe_base64digest(DigestUtils.digest(key))}"
+      end
+
+      PEEK_SIZE = 100
+
+      # Internal: Show first 100 characters of cache key for logging purposes.
+      #
+      # Returns a String with a length less than 100 characters.
+      def peek_key(key)
+        case key
+        when Integer
+          key.to_s
+        when String
+          key[0, PEEK_SIZE].inspect
+        when Array
+          str = []
+          key.each { |k| str << peek_key(k) }
+          str.join(':')[0, PEEK_SIZE]
+        else
+          peek_key(DigestUtils.pack_urlsafe_base64digest(DigestUtils.digest(key)))
+        end
+      end
+
+      def get_cache_wrapper(cache)
+        if cache.is_a?(Cache)
+          cache
+
+        # `Cache#get(key)` for Memcache
+        elsif cache.respond_to?(:get)
+          GetWrapper.new(cache)
+
+        # `Cache#[key]` so `Hash` can be used
+        elsif cache.respond_to?(:[])
+          HashWrapper.new(cache)
+
+        # `Cache#read(key)` for `ActiveSupport::Cache` support
+        elsif cache.respond_to?(:read)
+          ReadWriteWrapper.new(cache)
+
+        else
+          cache = Sprockets::Cache::NullStore.new
+          GetWrapper.new(cache)
+        end
+      end
+
+      class Wrapper < Struct.new(:cache)
+      end
+
+      class GetWrapper < Wrapper
+        def get(key)
+          cache.get(key)
+        end
+
+        def set(key, value)
+          cache.set(key, value)
+        end
+      end
+
+      class HashWrapper < Wrapper
+        def get(key)
+          cache[key]
+        end
+
+        def set(key, value)
+          cache[key] = value
+        end
+      end
+
+      class ReadWriteWrapper < Wrapper
+        def get(key)
+          cache.read(key)
+        end
+
+        def set(key, value)
+          cache.write(key, value)
+        end
+      end
+  end
+end

data/lib/sprockets/cached_environment.rb

@@ -0,0 +1,69 @@
+require 'sprockets/base'
+
+module Sprockets
+  # `Cached` 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
+  # behavior is ideal in production environments where the file system
+  # is immutable.
+  #
+  # `Cached` 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) }
+    end
+
+    # No-op return self as cached environment.
+    def cached
+      self
+    end
+    alias_method :index, :cached
+
+    # Internal: Cache Environment#entries
+    alias_method :_entries, :entries
+    def entries(path)
+      @entries[path]
+    end
+
+    # Internal: Cache Environment#stat
+    alias_method :_stat, :stat
+    def stat(path)
+      @stats[path]
+    end
+
+    # Internal: Cache Environment#load
+    alias_method :_load, :load
+    def load(uri)
+      @uris[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]
+    end
+
+    # Internal: Cache Environment#resolve_dependency
+    alias_method :_resolve_dependency, :resolve_dependency
+    def resolve_dependency(str)
+      @resolved_dependencies[str]
+    end
+
+    private
+      # Cache is immutable, any methods that try to change the runtime config
+      # should bomb.
+      def config=(config)
+        raise RuntimeError, "can't modify immutable cached environment"
+      end
+  end
+end

data/lib/sprockets/closure_compressor.rb

@@ -0,0 +1,53 @@
+require 'sprockets/autoload'
+
+module Sprockets
+  # Public: Closure Compiler minifier.
+  #
+  # To accept the default options
+  #
+  #     environment.register_bundle_processor 'application/javascript',
+  #       Sprockets::ClosureCompressor
+  #
+  # Or to pass options to the Closure::Compiler class.
+  #
+  #     environment.register_bundle_processor 'application/javascript',
+  #       Sprockets::ClosureCompressor.new({ ... })
+  #
+  class ClosureCompressor
+    VERSION = '1'
+
+    # Public: Return singleton instance with default options.
+    #
+    # Returns ClosureCompressor 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 = {})
+      @compiler = Autoload::Closure::Compiler.new(options)
+      @cache_key = [
+        self.class.name,
+        Autoload::Closure::VERSION,
+        Autoload::Closure::COMPILER_VERSION,
+        VERSION,
+        options
+      ].freeze
+    end
+
+    def call(input)
+      input[:cache].fetch(@cache_key + [input[:data]]) do
+        @compiler.compile(input[:data])
+      end
+    end
+  end
+end

data/lib/sprockets/coffee_script_processor.rb

@@ -0,0 +1,25 @@
+require 'sprockets/autoload'
+
+module Sprockets
+  # Processor engine class for the CoffeeScript compiler.
+  # Depends on the `coffee-script` and `coffee-script-source` gems.
+  #
+  # For more infomation see:
+  #
+  #   https://github.com/josh/ruby-coffee-script
+  #
+  module CoffeeScriptProcessor
+    VERSION = '1'
+
+    def self.cache_key
+      @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)
+      end
+    end
+  end
+end

data/lib/sprockets/coffee_script_template.rb

@@ -0,0 +1,6 @@
+require 'sprockets/coffee_script_processor'
+
+module Sprockets
+  # Deprecated
+  CoffeeScriptTemplate = CoffeeScriptProcessor
+end

data/lib/sprockets/compressing.rb

@@ -0,0 +1,74 @@
+require 'sprockets/utils'
+
+module Sprockets
+  # `Compressing` is an internal mixin whose public methods are exposed on
+  # the `Environment` and `CachedEnvironment` classes.
+  module Compressing
+    include Utils
+
+    def compressors
+      config[:compressors]
+    end
+
+    def register_compressor(mime_type, sym, klass)
+      self.config = hash_reassoc(config, :compressors, mime_type) do |compressors|
+        compressors[sym] = klass
+        compressors
+      end
+    end
+
+    # Return CSS compressor or nil if none is set
+    def css_compressor
+      if defined? @css_compressor
+        @css_compressor
+      end
+    end
+
+    # Assign a compressor to run on `text/css` assets.
+    #
+    # The compressor object must respond to `compress`.
+    def css_compressor=(compressor)
+      unregister_bundle_processor 'text/css', @css_compressor if defined? @css_compressor
+      @css_compressor = nil
+      return unless compressor
+
+      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) })
+        @css_compressor = :css_compressor
+      else
+        @css_compressor = klass = compressor
+      end
+
+      register_bundle_processor 'text/css', klass
+    end
+
+    # Return JS compressor or nil if none is set
+    def js_compressor
+      if defined? @js_compressor
+        @js_compressor
+      end
+    end
+
+    # Assign a compressor to run on `application/javascript` assets.
+    #
+    # The compressor object must respond to `compress`.
+    def js_compressor=(compressor)
+      unregister_bundle_processor 'application/javascript', @js_compressor if defined? @js_compressor
+      @js_compressor = nil
+      return unless compressor
+
+      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) })
+        @js_compressor = :js_compressor
+      else
+        @js_compressor = klass = compressor
+      end
+
+      register_bundle_processor 'application/javascript', klass
+    end
+  end
+end

data/lib/sprockets/configuration.rb

@@ -0,0 +1,83 @@
+require 'sprockets/compressing'
+require 'sprockets/dependencies'
+require 'sprockets/engines'
+require 'sprockets/mime'
+require 'sprockets/paths'
+require 'sprockets/processing'
+require 'sprockets/transformers'
+require 'sprockets/utils'
+
+module Sprockets
+  module Configuration
+    include Paths, Mime, Engines, Transformers, Processing, 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
+    end
+
+    # Get and set `Logger` instance.
+    attr_accessor :logger
+
+    # The `Environment#version` is a custom value used for manually
+    # expiring all asset caches.
+    #
+    # Sprockets is able to track most file and directory changes and
+    # will take care of expiring the cache for you. However, its
+    # impossible to know when any custom helpers change that you mix
+    # into the `Context`.
+    #
+    # It would be wise to increment this value anytime you make a
+    # configuration change to the `Environment` object.
+    def version
+      config[:version]
+    end
+
+    # Assign an environment version.
+    #
+    #     environment.version = '2.0'
+    #
+    def version=(version)
+      self.config = hash_reassoc(config, :version) { version.dup }
+    end
+
+    # Public: Returns a `Digest` implementation class.
+    #
+    # Defaults to `Digest::SHA256`.
+    def digest_class
+      config[:digest_class]
+    end
+
+    # Deprecated: Assign a `Digest` implementation class. This maybe any Ruby
+    # `Digest::` implementation such as `Digest::SHA256` or
+    # `Digest::MD5`.
+    #
+    #     environment.digest_class = Digest::MD5
+    #
+    def digest_class=(klass)
+      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
+    #       include MyHelpers
+    #       def asset_url; end
+    #     end
+    #
+    attr_reader :context_class
+  end
+end