Class: Sprockets::CachedEnvironment

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Base`
Instance Chain: self, `Base`, `Npm`, `Bower`, `Loader`, `Resolve`, `Server`, `Configuration`, `Paths`, `Mime`, `Transformers`, `HTTPUtils`, `Processing`, `ProcessorUtils`, `Exporting`, `Compressing`, `Dependencies`, `Utils`, `PathDependencyUtils`, `URIUtils`, `PathDigestUtils`, `PathUtils`, `DigestUtils`, `SourceMapUtils`
Inherits:	Sprockets::Base Object Sprockets::Base Sprockets::CachedEnvironment
Defined in:	lib/sprockets/cached_environment.rb

Overview

CachedEnvironment is a special cached version of Environment.

The exception is that all of its file system methods are cached for the instances lifetime. This makes CachedEnvironment much faster. This behavior is ideal in production environments where the file system is immutable.

CachedEnvironment should not be initialized directly. Instead use Environment#cached.

Constant Summary

Class Method Summary

.new(environment) ⇒ CachedEnvironment constructor

Instance Attribute Summary

#config=(config) writeonly private

Cache is immutable, any methods that try to change the runtime config should bomb.

`Base` - Inherited

#cache	Get persistent cache store.
#cache=	Set persistent cache store.

`Configuration` - Included

#config, #config=,
#context_class	This class maybe mutated and mixed in with custom helpers.
#digest_class	Public: Returns a `Digest` implementation class.
#digest_class=	Deprecated: Assign a `Digest` implementation class.
#logger	Get and set `Logger` instance.
#version	The `Environment#version` is a custom value used for manually expiring all asset caches.
#version=	Assign an environment version.

`Paths` - Included

#root	Returns `Environment` root.
#root=	Internal: Change Environment root.

`Exporting` - Included

#export_concurrent	Public: Checks if concurrent exporting is allowed.
#export_concurrent=	Public: Enable or disable the concurrently exporting files.

`Compressing` - Included

#css_compressor	Return CSS compressor or nil if none is set.
#css_compressor=	Assign a compressor to run on `text/css` assets.
#gzip=	Public: Enable or disable the creation of Gzip files.
#gzip?	Public: Checks if Gzip is enabled.
#js_compressor	Return JS compressor or nil if none is set.
#js_compressor=	Assign a compressor to run on `application/javascript` assets.
#skip_gzip?	Public: Checks if Gzip is disabled.

Instance Method Summary

#cached (also: #index)

No-op return self as cached environment.
#entries(path)

Internal: Cache Environment#entries
#index

Alias for #cached.
#load(uri)

Internal: Cache Environment#load
#processor_cache_key(str)

Internal: Cache Environment#processor_cache_key
#resolve_dependency(str)

Internal: Cache Environment#resolve_dependency
#stat(path)

Internal: Cache Environment#stat

`Base` - Inherited

#[]	Preferred `find_asset` shorthand.
#cached	Return an `CachedEnvironment`.
#compress_from_root, #expand_from_root,
#file_digest	Internal: Compute digest for path.
#find_all_linked_assets,
#find_asset	Find asset by logical path or expanded path.
#find_asset!	Find asset by logical path or expanded path.
#index	Alias for Base#cached.
#inspect	Pretty inspect.

`Npm` - Included

#read_package_directives	Internal: Read package.json’s main and style directives.
#resolve_alternates	Internal: Override resolve_alternates to install package.json behavior.

`Bower` - Included

#read_bower_main	Internal: Read bower.json’s main directive.
#resolve_alternates	Internal: Override resolve_alternates to install bower.json behavior.

`Loader` - Included

#load	Public: Load Asset by `Asset` URI.
#asset_from_cache	Internal: Load asset hash from cache.
#compress_key_from_hash, #expand_key_from_hash,
#fetch_asset_from_dependency_cache	Internal: Retrieves an asset based on its digest.
#load_from_unloaded	Internal: Loads an asset and saves it to cache.
#resolve_dependencies	Internal: `Resolve` set of dependency URIs.
#store_asset	Internal: Save a given asset to the cache.

`Resolve` - Included

#resolve	Public: Find Asset URI for given a logical path by searching the environment’s load paths.
#resolve!	Public: Same as resolve() but raises a `FileNotFound` exception instead of nil if no assets are found.

`Server` - Included

#call	`call` implements the Rack 1.x specification which accepts an `env` Hash and returns a three item tuple with the status code, headers, and body.
#bad_request_response	Returns a 400 Forbidden response tuple.
#cache_headers,
#css_exception_response	Returns a CSS response that hides all elements on the page and displays the exception.
#escape_css_content	Escape special characters for use inside a CSS content(“…”) string.
#forbidden_request?,
#forbidden_response	Returns a 403 Forbidden response tuple.
#head_request?, #headers,
#javascript_exception_response	Returns a JavaScript response that re-throws a Ruby exception in the browser.
#method_not_allowed_response,
#not_found_response	Returns a 404 Not Found response tuple.
#not_modified_response	Returns a 304 Not Modified response tuple.
#ok_response	Returns a 200 OK response tuple.
#path_fingerprint	Gets ETag fingerprint.
#precondition_failed_response

`Configuration` - Included

#initialize_configuration

`Paths` - Included

#append_path	Append a `path` to the `paths` list.
#clear_paths	Clear all paths and start fresh.
#each_file	Public: Iterate over every file under all load paths.
#paths	Returns an `Array` of path `String`s.
#prepend_path	Prepend a `path` to the `paths` list.

`Mime` - Included

#mime_exts	Internal: Mapping of MIME extension Strings to MIME type Strings.
#mime_type_charset_detecter	Internal: Get detecter function for MIME type.
#mime_types	Public: Mapping of MIME type Strings to properties Hash.
#read_file	Public: Read file on disk with MIME type specific encoding.
#register_mime_type	Public: Register a new mime type.

`Transformers` - Included

#compose_transformers	Internal: Compose multiple transformer steps into a single processor function.
#expand_transform_accepts	Internal: Expand accept type list to include possible transformed types.
#register_transformer	Public: Register a transformer from and to a mime type.
#register_transformer_suffix	Internal: Register transformer for existing type adding a suffix.
#resolve_transform_type	Internal: `Resolve` target mime type that the source type should be transformed to.
#transformers	Public: Two level mapping of a source mime type to a target mime type.
#compose_transformer_list, #compute_transformers!

`HTTPUtils` - Included

#find_best_mime_type_match	Internal: Find the best qvalue match from an Array of available mime type options.
#find_best_q_match	Internal: Find the best qvalue match from an Array of available options.
#find_mime_type_matches	Internal: Find the all qvalue match from an Array of available mime type options.
#find_q_matches	Internal: Find all qvalue matches from an Array of available options.
#match_mime_type?	Public: Test mime type against mime range.
#match_mime_type_keys	Public: Return values from Hash where the key matches the mime type.
#parse_q_values	Internal: Parse Accept header quality values.

`Processing` - Included

#bundle_processors	`Bundle` Processors are ran on concatenated assets rather than individual files.
#pipelines,
#postprocessors	Postprocessors are ran after `Preprocessors` and Engine processors.
#preprocessors	`Preprocessors` are ran before Postprocessors and Engine processors.
#processors	Alias for Processing#preprocessors.
#register_bundle_metadata_reducer	Public: Register bundle metadata reducer function.
#register_bundle_processor	Registers a new `Bundle` Processor `klass` for `mime_type`.
#register_pipeline	Registers a pipeline that will be called by `call_processor` method.
#register_postprocessor	Registers a new Postprocessor `klass` for `mime_type`.
#register_preprocessor	Registers a new Preprocessor `klass` for `mime_type`.
#register_processor	Alias for Processing#register_preprocessor.
#unregister_bundle_processor	Remove Bundle Processor `klass` for `mime_type`.
#unregister_postprocessor	Remove Postprocessor `klass` for `mime_type`.
#unregister_preprocessor	Remove Preprocessor `klass` for `mime_type`.
#unregister_processor	Alias for Processing#unregister_preprocessor.
#register_config_processor, #unregister_config_processor

`ProcessorUtils` - Included

#call_processor	Public: Invoke processor.
#call_processors	Public: Invoke list of processors in right to left order.
#compose_processors	Public: Compose processors in right to left order.
#processor_cache_key	Internal: Get processor defined cached key.
#processors_cache_keys	Internal: Get combined cache keys for set of processors.
#validate_processor_result!	Internal: Validate returned result of calling a processor pipeline and raise a friendly user error message.

`Exporting` - Included

#exporters	`Exporters` are ran on the assets:precompile task.
#register_exporter	Public: Registers a new Exporter `klass` for `mime_type`.
#unregister_exporter	Public: Remove Exporting processor `klass` for `mime_type`.

`Compressing` - Included

#compressors,
#register_compressor	Public: Register a new compressor `klass` at `sym` for `mime_type`.

`Dependencies` - Included

#add_dependency	Public: Add environmental dependency inherited by all assets.
#depend_on	Alias for Dependencies#add_dependency.
#dependencies	Public: Default set of dependency URIs for assets.
#dependency_resolvers	Public: Mapping dependency schemes to resolver functions.
#register_dependency_resolver	Public: Register new dependency URI resolver.
#resolve_dependency	Internal: `Resolve` dependency URIs.

`Utils` - Included

#concat_javascript_sources	Internal: Accumulate asset source to buffer and append a trailing semicolon if necessary.
#dfs	Internal: Post-order Depth-First search algorithm.
#dfs_paths	Internal: Post-order Depth-First search algorithm that gathers all paths along the way.
#duplicable?	Internal: Check if object can safely be .dup’d.
#hash_reassoc	Internal: Duplicate and store key/value on new frozen hash.
#hash_reassoc1	Internal: Duplicate and store key/value on new frozen hash.
#module_include	Internal: Inject into target module for the duration of the block.
#string_end_with_semicolon?	Internal: Check if string has a trailing semicolon.

`PathDependencyUtils` - Included

#entries_with_dependencies	Internal: List directory entries and return a set of dependencies that would invalid the cached return result.
#stat_directory_with_dependencies	Internal: List directory filenames and associated Stats under a directory.
#stat_sorted_tree_with_dependencies	Internal: List directory filenames and associated Stats under an entire directory tree.

`URIUtils` - Included

#build_asset_uri	Internal: Build Asset URI.
#build_file_digest_uri	Internal: Build file-digest dependency URI.
#encode_uri_query_params	Internal: Serialize hash of params into query string.
#join_file_uri	Internal: Join file: URI component parts into String.
#join_uri	Internal: Join URI component parts into String.
#parse_asset_uri	Internal: Parse Asset URI.
#parse_file_digest_uri	Internal: Parse file-digest dependency URI.
#parse_uri_query_params	Internal: Parse query string into hash of params.
#split_file_uri	Internal: Parse file: URI into component parts.
#split_uri	Internal: Parse URI into component parts.
#valid_asset_uri?	Internal: Check if String is a valid `Asset` URI.

`PathDigestUtils` - Included

#file_digest	Internal: Compute digest for path.
#files_digest	Internal: Compute digest for a set of paths.
#stat_digest	Internal: Compute digest for file stat.

`PathUtils` - Included

#absolute_path?	On Windows, ALT_SEPARATOR is \ Delegate to Pathname since the logic gets complex.
#atomic_write	Public: Write to a file atomically.
#directory?	Public: Like `File.directory?`.
#entries	Public: A version of `Dir.entries` that filters out `.` files and `~` swap files.
#file?	Public: Like `File.file?`.
#find_matching_path_for_extensions	Internal: Match paths in a directory against available extensions.
#find_upwards	Internal: Find target basename checking upwards from path.
#join	Public: Joins path to base path.
#match_path_extname	Internal: Match path extnames against available extensions.
#path_extnames	Internal: Get path’s extensions.
#path_parents	Internal: Returns all parents for path.
#paths_split	Internal: Detect root path and base for file in a set of paths.
#relative_path?	Public: Check if path is explicitly relative.
#relative_path_from	Public: Get relative path from `start` to `dest`.
#set_pipeline	Public: Sets pipeline for path.
#split_subpath	Internal: Get relative path for root path and subpath.
#stat	Public: Like `File.stat`.
#stat_directory	Public: Stat all the files under a directory.
#stat_sorted_tree	Public: Recursive stat all the files under a directory in alphabetical order.
#stat_tree	Public: Recursive stat all the files under a directory.

`DigestUtils` - Included

#already_digested?	Internal: Checks an asset name for a valid digest.
#detect_digest_class	Internal: Detect digest class hash algorithm for digest bytes.
#digest	Internal: Generate a hexdigest for a nested JSON serializable object.
#digest_class	Internal: Default digest class.
#hexdigest	Internal: Generate a hexdigest for a nested JSON serializable object.
#hexdigest_integrity_uri	Public: Generate hash for use in the `integrity` attribute of an asset tag as per the subresource integrity specification.
#integrity_uri	Public: Generate hash for use in the `integrity` attribute of an asset tag as per the subresource integrity specification.
#pack_base64digest	Internal: Pack a binary digest to a base64 encoded string.
#pack_hexdigest	Internal: Pack a binary digest to a hex encoded string.
#pack_urlsafe_base64digest	Internal: Pack a binary digest to a urlsafe base64 encoded string.
#unpack_hexdigest	Internal: Unpack a hex encoded digest string into binary bytes.
#build_digest

`SourceMapUtils` - Included

#bsearch_mappings	Public: Search Array of mappings for closest offset.
#combine_source_maps	Public: Combine two separate source map transformations into a single mapping.
#compare_source_offsets	Public: Compare two source map offsets.
#concat_source_maps	Public: Concatenate two source maps.
#decode_source_map	Public: Decompress source map.
#decode_vlq_mappings	Public: Decode VLQ mappings and match up sources and symbol names.
#encode_source_map	Public: Compress source map.
#encode_vlq_mappings	Public: Encode mappings Hash into a VLQ encoded String.
#format_source_map	Public: Transpose source maps into a standard format.
#make_index_map	Public: Converts source map to index map.
#vlq_decode	Public: Decode a VLQ string.
#vlq_decode_mappings	Public: Decode a VLQ string into mapping numbers.
#vlq_encode	Public: Encode a list of numbers into a compact VLQ string.
#vlq_encode_mappings	Public: Encode a mapping array into a compact VLQ string.

Constructor Details

.new(environment) ⇒ `CachedEnvironment`

[ GitHub ]

# File 'lib/sprockets/cached_environment.rb', line 15


def initialize(environment)
  initialize_configuration(environment)

  @cache   = environment.cache
  @stats   = Concurrent::Map.new
  @entries = Concurrent::Map.new
  @uris    = Concurrent::Map.new
  @processor_cache_keys = Concurrent::Map.new
  @resolved_dependencies = Concurrent::Map.new
end

Instance Attribute Details

#config=(config) (writeonly, private)

Cache is immutable, any methods that try to change the runtime config should bomb.

Raises:

(RuntimeError)

[ GitHub ]

# File 'lib/sprockets/cached_environment.rb', line 60


def config=(config)
  raise RuntimeError, "can't modify immutable cached environment"
end

Instance Method Details

#cached Also known as: #index

No-op return self as cached environment.

[ GitHub ]

# File 'lib/sprockets/cached_environment.rb', line 27


def cached
  self
end

#entries(path)

Internal: Cache Environment#entries

[ GitHub ]

# File 'lib/sprockets/cached_environment.rb', line 33


def entries(path)
  @entries.fetch_or_store(path) { super(path) }
end

#index

Alias for #cached.

[ GitHub ]

# File 'lib/sprockets/cached_environment.rb', line 30


alias_method :index, :cached

#load(uri)

Internal: Cache Environment#load

[ GitHub ]

# File 'lib/sprockets/cached_environment.rb', line 43


def load(uri)
  @uris.fetch_or_store(uri) { super(uri) }
end

#processor_cache_key(str)

Internal: Cache Environment#processor_cache_key

[ GitHub ]

# File 'lib/sprockets/cached_environment.rb', line 48


def processor_cache_key(str)
  @processor_cache_keys.fetch_or_store(str) { super(str) }
end

#resolve_dependency(str)

Internal: Cache Environment#resolve_dependency

[ GitHub ]

# File 'lib/sprockets/cached_environment.rb', line 53


def resolve_dependency(str)
  @resolved_dependencies.fetch_or_store(str) { super(str) }
end

#stat(path)

Internal: Cache Environment#stat

[ GitHub ]

# File 'lib/sprockets/cached_environment.rb', line 38


def stat(path)
  @stats.fetch_or_store(path) { super(path) }
end

Class: Sprockets::CachedEnvironment

Overview

Constant Summary

SourceMapUtils - Included

DigestUtils - Included

PathUtils - Included

Utils - Included

ProcessorUtils - Included

Server - Included

Bower - Included

Class Method Summary

Instance Attribute Summary

Base - Inherited

Configuration - Included

Paths - Included

Exporting - Included

Compressing - Included

Instance Method Summary

Base - Inherited

Npm - Included

Bower - Included

Loader - Included

Resolve - Included

Server - Included

Configuration - Included

Paths - Included

Mime - Included

Transformers - Included

HTTPUtils - Included

Processing - Included

ProcessorUtils - Included

Exporting - Included

Compressing - Included

Dependencies - Included

Utils - Included

PathDependencyUtils - Included

URIUtils - Included

PathDigestUtils - Included

PathUtils - Included

DigestUtils - Included

SourceMapUtils - Included

Constructor Details

.new(environment) ⇒ CachedEnvironment

Instance Attribute Details

#config=(config) (writeonly, private)

Instance Method Details

#cached Also known as: #index

#entries(path)

#index

#load(uri)

#processor_cache_key(str)

#resolve_dependency(str)

#stat(path)

`SourceMapUtils` - Included

`DigestUtils` - Included

`PathUtils` - Included

`Utils` - Included

`ProcessorUtils` - Included

`Server` - Included

`Bower` - Included

`Base` - Inherited

`Configuration` - Included

`Paths` - Included

`Exporting` - Included

`Compressing` - Included

`Base` - Inherited

`Npm` - Included

`Bower` - Included

`Loader` - Included

`Resolve` - Included

`Server` - Included

`Configuration` - Included

`Paths` - Included

`Mime` - Included

`Transformers` - Included

`HTTPUtils` - Included

`Processing` - Included

`ProcessorUtils` - Included

`Exporting` - Included

`Compressing` - Included

`Dependencies` - Included

`Utils` - Included

`PathDependencyUtils` - Included

`URIUtils` - Included

`PathDigestUtils` - Included

`PathUtils` - Included

`DigestUtils` - Included

`SourceMapUtils` - Included

.new(environment) ⇒ `CachedEnvironment`