Module: Sprockets
Overview
Define some basic Sprockets
error classes
Constant Summary
-
SassCacheStore =
Deprecated: Use
SassProcessor::CacheStore
instead.SassProcessor::CacheStore
-
SassFunctions =
Deprecated: Use
SassProcessor::Functions
instead.SassProcessor::Functions
-
VERSION =
# File 'lib/sprockets/version.rb', line 3"4.2.1"
Class Attribute Summary
Configuration
- Extended
config, config=, | |
context_class | This class maybe mutated and mixed in with custom helpers. |
digest_class | Public: Returns a |
digest_class= | Deprecated: Assign a |
logger | Get and set |
version | The |
version= | Assign an environment version. |
Paths
- Included
root | Returns |
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 |
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 |
skip_gzip? | Public: Checks if Gzip is disabled. |
Class Method Summary
Configuration
- Extended
Paths
- Included
append_path | Append a |
clear_paths | Clear all paths and start fresh. |
each_file | Public: Iterate over every file under all load paths. |
paths | Returns an |
prepend_path | Prepend a |
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: |
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 |
|
pipelines, | |
postprocessors | Postprocessors are ran after |
preprocessors |
|
processors | Alias for Processing#preprocessors. |
register_bundle_metadata_reducer | Public: Register bundle metadata reducer function. |
register_bundle_processor | Registers a new |
register_pipeline | Registers a pipeline that will be called by |
register_postprocessor | Registers a new Postprocessor |
register_preprocessor | Registers a new Preprocessor |
register_processor | Alias for Processing#register_preprocessor. |
unregister_bundle_processor | Remove Bundle Processor |
unregister_postprocessor | Remove Postprocessor |
unregister_preprocessor | Remove Preprocessor |
unregister_processor | Alias for Processing#unregister_preprocessor. |
register_config_processor, unregister_config_processor |
Exporting
- Included
exporters |
|
register_exporter | Public: Registers a new Exporter |
unregister_exporter | Public: Remove Exporting processor |
Compressing
- Included
compressors, | |
register_compressor | Public: Register a new compressor |
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: |
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. |
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_uri | Public: Generate hash for use in the |
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 |
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 |
entries | Public: A version of |
file? | Public: Like |
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 |
set_pipeline | Public: Sets pipeline for path. |
split_subpath | Internal: Get relative path for root path and subpath. |
stat | Public: Like |
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. |
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 |
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. |
ProcessorUtils
- Extended
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. |