sprockets 3.0.0.beta.6 → 3.0.0.beta.7

data/lib/sprockets/cache.rb

@@ -1,5 +1,5 @@
-require 'sprockets/digest_utils'
 require 'logger'
+require 'sprockets/digest_utils'
 
 module Sprockets
   # Public: Wrapper interface to backend cache stores. Ensures a consistent API
@@ -76,7 +76,7 @@ module Sprockets
     #
     # Returns a JSON serializable object.
     def fetch(key)
-      start = Utils.benchmark_start
+      start = Time.now.to_f
       expanded_key = expand_key(key)
       value = @fetch_cache.get(expanded_key)
       if value.nil?
@@ -85,7 +85,7 @@ module Sprockets
           value = yield
           @cache_wrapper.set(expanded_key, value)
           @logger.debug do
-            ms = "(#{Utils.benchmark_end(start)}ms)"
+            ms = "(#{((Time.now.to_f - start) * 1000).to_i}ms)"
             "Sprockets Cache miss #{peek_key(key)}  #{ms}"
           end
         end
@@ -98,31 +98,36 @@ module Sprockets
     # store.
     #
     # This API may be used publicaly, but may have undefined behavior
-    # depending on the backend store being used. Therefore it must be used
-    # with caution, which is why its prefixed with an underscore. Prefer the
+    # 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 - Check local cache first (default: false)
     #
     # Returns a JSON serializable object or nil if there was a cache miss.
-    def _get(key)
-      @cache_wrapper.get(expand_key(key))
+    def get(key, local = false)
+      expanded_key = expand_key(key)
+      value = @fetch_cache.get(expanded_key) if local
+      value = @cache_wrapper.get(expanded_key) if value.nil?
+      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. Therefore it must be used
-    # with caution, which is why its prefixed with an underscore. Prefer the
+    # depending on the backend store being used. Prefer the
     # Cache#fetch API over using this.
     #
-    # key - JSON serializable key
+    # 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)
-      @cache_wrapper.set(expand_key(key), value)
+    def set(key, value, local = false)
+      expanded_key = expand_key(key)
+      @fetch_cache.set(expanded_key, value)
+      @cache_wrapper.set(expanded_key, value)
     end
 
     # Public: Pretty inspect

data/lib/sprockets/cache/file_store.rb

@@ -1,6 +1,7 @@
-require 'digest/md5'
 require 'fileutils'
 require 'logger'
+require 'sprockets/encoding_utils'
+require 'sprockets/path_utils'
 require 'zlib'
 
 module Sprockets

data/lib/sprockets/cached_environment.rb

@@ -1,4 +1,3 @@
-require 'sprockets/asset_uri'
 require 'sprockets/base'
 
 module Sprockets
@@ -18,8 +17,10 @@ module Sprockets
       @cache   = environment.cache
       @stats   = Hash.new { |h, k| h[k] = _stat(k) }
       @entries = Hash.new { |h, k| h[k] = _entries(k) }
-      @digests = Hash.new { |h, k| h[k] = _file_digest(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.
@@ -40,83 +41,29 @@ module Sprockets
       @stats[path]
     end
 
-    # Internal: Cache Environment#file_digest
-    alias_method :_file_digest, :file_digest
-    def file_digest(path)
-      @digests[path]
-    end
-
     # Internal: Cache Environment#load
     alias_method :_load, :load
     def load(uri)
       @uris[uri]
     end
 
-    protected
-      def asset_dependency_graph_cache_key(uri)
-        filename, _ = AssetURI.parse(uri)
-        [
-          'asset-uri-dep-graph',
-          VERSION,
-          self.version,
-          self.paths,
-          uri,
-          file_digest(filename)
-        ]
-      end
-
-      def asset_uri_cache_key(uri)
-        [
-          'asset-uri',
-          VERSION,
-          self.version,
-          uri
-        ]
-      end
-
-      def load_asset_by_id_uri(uri)
-        cache.fetch(asset_uri_cache_key(uri)) do
-          super
-        end
-      end
-
-      def load_asset_by_uri(uri)
-        dep_graph_key = asset_dependency_graph_cache_key(uri)
-
-        if asset = get_asset_dependency_graph_cache(dep_graph_key)
-          asset
-        else
-          asset = super
-          set_asset_dependency_graph_cache(dep_graph_key, asset)
-          asset
-        end
-      end
-
-      def get_asset_dependency_graph_cache(key)
-        return unless cached = cache._get(key)
-        paths, digest, uri = cached
-
-        if files_digest(paths) == digest
-          cache._get(asset_uri_cache_key(uri))
-        end
-      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
 
-      def set_asset_dependency_graph_cache(key, asset)
-        uri = asset[:uri]
-        digest, paths = asset[:metadata].values_at(:dependency_sources_digest, :dependency_paths)
-        cache._set(key, [paths, digest, uri])
-        cache.fetch(asset_uri_cache_key(uri)) { asset }
-        asset
-      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 clear the cache
+      # Cache is immutable, any methods that try to change the runtime config
       # should bomb.
-      def mutate_config(*args)
+      def config=(config)
         raise RuntimeError, "can't modify immutable cached environment"
       end
   end
-
-  # Deprecated
-  Index = CachedEnvironment
 end

data/lib/sprockets/closure_compressor.rb

@@ -16,19 +16,32 @@ module Sprockets
   class ClosureCompressor
     VERSION = '1'
 
-    def self.call(*args)
-      new.call(*args)
+    # 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 = ::Closure::Compiler.new(options)
       @cache_key = [
-        'ClosureCompressor',
+        self.class.name,
         ::Closure::VERSION,
         ::Closure::COMPILER_VERSION,
         VERSION,
         options
-      ]
+      ].freeze
     end
 
     def call(input)

data/lib/sprockets/coffee_script_processor.rb

@@ -0,0 +1,26 @@
+require 'coffee_script'
+
+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'
+    SOURCE_VERSION = ::CoffeeScript::Source.version
+
+    def self.cache_key
+      @cache_key ||= [name, SOURCE_VERSION, VERSION].freeze
+    end
+
+    def self.call(input)
+      data = input[:data]
+      input[:cache].fetch(self.cache_key + [data]) do
+        ::CoffeeScript.compile(data)
+      end
+    end
+  end
+end

data/lib/sprockets/coffee_script_template.rb

@@ -1,23 +1,6 @@
-require 'coffee_script'
+require 'sprockets/coffee_script_processor'
 
 module Sprockets
-  # Template 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 CoffeeScriptTemplate
-    VERSION = '1'
-    SOURCE_VERSION = ::CoffeeScript::Source.version
-
-    def self.call(input)
-      data = input[:data]
-      key  = ['CoffeeScriptTemplate', SOURCE_VERSION, VERSION, data]
-      input[:cache].fetch(key) do
-        ::CoffeeScript.compile(data)
-      end
-    end
-  end
+  # Deprecated
+  CoffeeScriptTemplate = CoffeeScriptProcessor
 end

data/lib/sprockets/compressing.rb

@@ -1,11 +1,17 @@
+require 'sprockets/utils'
+
 module Sprockets
   # `Compressing` is an internal mixin whose public methods are exposed on
   # the `Environment` and `CachedEnvironment` classes.
   module Compressing
-    attr_reader :compressors
+    include Utils
+
+    def compressors
+      config[:compressors]
+    end
 
     def register_compressor(mime_type, sym, klass)
-      mutate_hash_config(:compressors, mime_type) do |compressors|
+      self.config = hash_reassoc(config, :compressors, mime_type) do |compressors|
         compressors[sym] = klass
         compressors
       end
@@ -14,7 +20,7 @@ module Sprockets
     # Return CSS compressor or nil if none is set
     def css_compressor
       if defined? @css_compressor
-        unwrap_processor(@css_compressor)
+        @css_compressor
       end
     end
 
@@ -41,7 +47,7 @@ module Sprockets
     # Return JS compressor or nil if none is set
     def js_compressor
       if defined? @js_compressor
-        unwrap_processor(@js_compressor)
+        @js_compressor
       end
     end
 

data/lib/sprockets/configuration.rb

@@ -1,33 +1,27 @@
 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
+    include Paths, Mime, Engines, Transformers, Processing, Compressing, Dependencies, Utils
 
     def initialize_configuration(parent)
-      @logger                = parent.logger
-      @version               = parent.version
-      @digest_class          = parent.digest_class
-      @context_class         = Class.new(parent.context_class)
-      @root                  = parent.root
-      @paths                 = parent.paths
-      @mime_types            = parent.mime_types
-      @mime_exts             = parent.mime_exts
-      @encodings             = parent.encodings
-      @engines               = parent.engines
-      @engine_mime_types     = parent.engine_mime_types
-      @transformers          = parent.transformers
-      @inverted_transformers = parent.inverted_transformers
-      @preprocessors         = parent.preprocessors
-      @postprocessors        = parent.postprocessors
-      @bundle_reducers       = parent.bundle_reducers
-      @bundle_processors     = parent.bundle_processors
-      @compressors           = parent.compressors
+      @config = parent.config
+      @logger = parent.logger
+      @context_class = Class.new(parent.context_class)
+    end
+
+    attr_reader :config
+
+    def config=(config)
+      raise TypeError, "can't assign mutable config" unless config.frozen?
+      @config = config
     end
 
     # Get and set `Logger` instance.
@@ -43,20 +37,24 @@ module Sprockets
     #
     # It would be wise to increment this value anytime you make a
     # configuration change to the `Environment` object.
-    attr_reader :version
+    def version
+      config[:version]
+    end
 
     # Assign an environment version.
     #
     #     environment.version = '2.0'
     #
     def version=(version)
-      mutate_config(:version) { version.dup }
+      self.config = hash_reassoc(config, :version) { version.dup }
     end
 
     # Public: Returns a `Digest` implementation class.
     #
     # Defaults to `Digest::SHA256`.
-    attr_reader :digest_class
+    def digest_class
+      config[:digest_class]
+    end
 
     # Deprecated: Assign a `Digest` implementation class. This maybe any Ruby
     # `Digest::` implementation such as `Digest::SHA256` or
@@ -65,7 +63,7 @@ module Sprockets
     #     environment.digest_class = Digest::MD5
     #
     def digest_class=(klass)
-      @digest_class = klass
+      self.config = config.merge(digest_class: klass).freeze
     end
 
     # Deprecated: Get `Context` class.
@@ -78,19 +76,5 @@ module Sprockets
     #     end
     #
     attr_reader :context_class
-
-    private
-      def mutate_config(sym)
-        obj = yield self.instance_variable_get("@#{sym}").dup
-        self.instance_variable_set("@#{sym}", obj.freeze)
-      end
-
-      def mutate_hash_config(sym, key)
-        mutate_config(sym) do |hash|
-          obj = yield hash[key].dup
-          hash[key] = obj.freeze
-          hash
-        end
-      end
   end
 end

data/lib/sprockets/context.rb

@@ -4,7 +4,7 @@ require 'set'
 require 'sprockets/errors'
 
 module Sprockets
-  # Deprecated: `Context` provides helper methods to all `Template` processors.
+  # Deprecated: `Context` provides helper methods to all processors.
   # They are typically accessed by ERB templates. You can mix in custom helpers
   # by injecting them into `Environment#context_class`. Do not mix them into
   # `Context` directly.
@@ -34,17 +34,17 @@ module Sprockets
       @pathname     = Pathname.new(@filename)
       @content_type = input[:content_type]
 
-      @required         = Set.new(@metadata[:required])
-      @stubbed          = Set.new(@metadata[:stubbed])
-      @links            = Set.new(@metadata[:links])
-      @dependency_paths = Set.new(@metadata[:dependency_paths])
+      @required     = Set.new(@metadata[:required])
+      @stubbed      = Set.new(@metadata[:stubbed])
+      @links        = Set.new(@metadata[:links])
+      @dependencies = Set.new(input[:metadata][:dependencies])
     end
 
     def metadata
       { required: @required,
         stubbed: @stubbed,
         links: @links,
-        dependency_paths: @dependency_paths }
+        dependencies: @dependencies }
     end
 
     # Returns the environment path that contains the file.
@@ -69,61 +69,36 @@ module Sprockets
     #
     attr_reader :content_type
 
-    # Internal
-    # TODO: Cleanup relative resolver logic shared between directive processor.
-    def _resolve(method, path, options = {})
-      options[:content_type] = self.content_type if options[:content_type] == :self
-      options[:accept] = options.delete(:content_type)
-
-      if environment.absolute_path?(path)
-        filename = path
-      elsif environment.relative_path?(path)
-        path = File.expand_path(path, @dirname)
-        if logical_path = @environment.split_subpath(load_path, path)
-          if filename = environment.send(method, logical_path, options.merge(load_paths: [load_path]))
-            accept = options[:accept]
-            message = "couldn't find file '#{logical_path}' under '#{load_path}'"
-            message << " with type '#{accept}'" if accept
-            raise FileNotFound, message
-          end
-        else
-          raise FileOutsidePaths, "#{path} isn't under path: #{load_path}"
-        end
-      else
-        filename = environment.send(method, path, options)
-      end
-
-      if filename
-        filename
-      else
-        accept = options[:accept]
-        message = "couldn't find file '#{path}'"
-        message << " with type '#{accept}'" if accept
-        raise FileNotFound, message
-      end
-    end
-
-    # Given a logical path, `resolve` will find and return the fully
-    # expanded path. Relative paths will also be resolved. An optional
-    # `:content_type` restriction can be supplied to restrict the
-    # search.
+    # Public: Given a logical path, `resolve` will find and return an Asset URI.
+    # Relative paths will also be resolved. An accept type maybe given to
+    # restrict the search.
     #
     #     resolve("foo.js")
-    #     # => "/path/to/app/javascripts/foo.js"
+    #     # => "file:///path/to/app/javascripts/foo.js?type=application/javascript"
     #
     #     resolve("./bar.js")
-    #     # => "/path/to/app/javascripts/bar.js"
+    #     # => "file:///path/to/app/javascripts/bar.js?type=application/javascript"
+    #
+    # path - String logical or absolute path
+    # options
+    #   accept - String content accept type
     #
+    # Returns an Asset URI String.
     def resolve(path, options = {})
-      _resolve(:resolve, path, options)
+      uri, deps = environment.resolve!(path, options.merge(base_path: @dirname))
+      @dependencies.merge(deps)
+      uri
     end
 
-    def locate(path, options = {})
-      if AssetURI.valid?(path)
-        path
-      else
-        _resolve(:locate, path, options)
-      end
+    # Public: Load Asset by AssetURI and track it as a dependency.
+    #
+    # uri - AssetURI
+    #
+    # Returns Asset.
+    def load(uri)
+      asset = environment.load(uri)
+      @dependencies.merge(asset.metadata[:dependencies])
+      asset
     end
 
     # `depend_on` allows you to state a dependency on a file without
@@ -133,7 +108,7 @@ module Sprockets
     # the dependency file with invalidate the cache of the
     # source file.
     def depend_on(path)
-      @dependency_paths << resolve(path).to_s
+      resolve(path, compat: false)
       nil
     end
 
@@ -145,10 +120,7 @@ module Sprockets
     # file. Unlike `depend_on`, this will include recursively include
     # the target asset's dependencies.
     def depend_on_asset(path)
-      if asset = @environment.load(locate(path))
-        @dependency_paths.merge(asset.metadata[:dependency_paths])
-      end
-      nil
+      load(resolve(path, compat: false))
     end
 
     # `require_asset` declares `path` as a dependency of the file. The
@@ -161,7 +133,7 @@ module Sprockets
     #     <%= require_asset "#{framework}.js" %>
     #
     def require_asset(path)
-      @required << locate(path, accept: @content_type, bundle: false)
+      @required << resolve(path, accept: @content_type, bundle: false, compat: false)
       nil
     end
 
@@ -169,7 +141,7 @@ module Sprockets
     # `path` must be an asset which may or may not already be included
     # in the bundle.
     def stub_asset(path)
-      @stubbed << locate(path, accept: @content_type, bundle: false)
+      @stubbed << resolve(path, accept: @content_type, bundle: false, compat: false)
       nil
     end
 
@@ -179,10 +151,8 @@ module Sprockets
     #
     # Returns an Asset or nil.
     def link_asset(path)
-      if asset = @environment.load(locate(path))
-        @dependency_paths.merge(asset.metadata[:dependency_paths])
-        @links << asset.uri
-      end
+      asset = depend_on_asset(path)
+      @links << asset.uri
       asset
     end
 
@@ -197,9 +167,9 @@ module Sprockets
     #     $('<img>').attr('src', '<%= asset_data_uri 'avatar.jpg' %>')
     #
     def asset_data_uri(path)
-      depend_on_asset(path)
-      asset = environment.find_asset(path, accept_encoding: 'base64')
-      "data:#{asset.content_type};base64,#{Rack::Utils.escape(asset.to_s)}"
+      asset = depend_on_asset(path)
+      data = EncodingUtils.base64(asset.source)
+      "data:#{asset.content_type};base64,#{Rack::Utils.escape(data)}"
     end
 
     # Expands logical path to full url to asset.