module Sprockets::Processing
`Processing` is an internal mixin whose public methods are exposed on the `Environment` and `CachedEnvironment` classes.
Public Instance Methods
Bundle
Processors are ran on concatenated assets rather than individual files.
# File lib/sprockets/processing.rb, line 88 def bundle_processors config[:bundle_processors] end
# File lib/sprockets/processing.rb, line 16 def pipelines config[:pipelines] end
Postprocessors are ran after Preprocessors and Engine processors.
# File lib/sprockets/processing.rb, line 36 def postprocessors config[:postprocessors] end
Preprocessors are ran before Postprocessors and Engine processors.
# File lib/sprockets/processing.rb, line 30 def preprocessors config[:preprocessors] end
Public: Register bundle metadata reducer function.
Examples
Sprockets.register_bundle_metadata_reducer 'application/javascript', :jshint_errors, [], :+ Sprockets.register_bundle_metadata_reducer 'text/css', :selector_count, 0 { |total, count| total + count }
mime_type - String MIME Type. Use '/' applies to all types. key - Symbol metadata key initial - Initial memo to pass to the reduce funciton (default: nil) block - Proc accepting the memo accumulator and current value
Returns nothing.
# File lib/sprockets/processing.rb, line 130 def register_bundle_metadata_reducer(mime_type, key, *args, &block) case args.size when 0 reducer = block when 1 if block_given? initial = args[0] reducer = block else initial = nil reducer = args[0].to_proc end when 2 initial = args[0] reducer = args[1].to_proc else raise ArgumentError, "wrong number of arguments (#{args.size} for 0..2)" end self.config = hash_reassoc(config, :bundle_reducers, mime_type) do |reducers| reducers.merge(key => [initial, reducer]) end end
Registers a new Bundle
Processor `klass` for `mime_type`.
register_bundle_processor 'application/javascript', Sprockets::DirectiveProcessor
A block can be passed for to create a shorthand processor.
register_bundle_processor 'application/javascript', :my_processor do |context, data| data.gsub(...) end
# File lib/sprockets/processing.rb, line 102 def register_bundle_processor(*args, &block) register_config_processor(:bundle_processors, *args, &block) end
# File lib/sprockets/processing.rb, line 20 def register_pipeline(name, proc = nil, &block) proc ||= block self.config = hash_reassoc(config, :pipelines) do |pipelines| pipelines.merge(name.to_sym => proc) end end
Registers a new Postprocessor `klass` for `mime_type`.
register_postprocessor 'application/javascript', Sprockets::DirectiveProcessor
A block can be passed for to create a shorthand processor.
register_postprocessor 'application/javascript', :my_processor do |context, data| data.gsub(...) end
# File lib/sprockets/processing.rb, line 65 def register_postprocessor(*args, &block) register_config_processor(:postprocessors, *args, &block) end
Registers a new Preprocessor `klass` for `mime_type`.
register_preprocessor 'text/css', Sprockets::DirectiveProcessor
A block can be passed for to create a shorthand processor.
register_preprocessor 'text/css', :my_processor do |context, data| data.gsub(...) end
# File lib/sprockets/processing.rb, line 50 def register_preprocessor(*args, &block) register_config_processor(:preprocessors, *args, &block) end
Remove Bundle
Processor `klass` for `mime_type`.
unregister_bundle_processor 'application/javascript', Sprockets::DirectiveProcessor
# File lib/sprockets/processing.rb, line 110 def unregister_bundle_processor(*args) unregister_config_processor(:bundle_processors, *args) end
Remove Postprocessor `klass` for `mime_type`.
unregister_postprocessor 'text/css', Sprockets::DirectiveProcessor
# File lib/sprockets/processing.rb, line 82 def unregister_postprocessor(*args) unregister_config_processor(:postprocessors, *args) end
Remove Preprocessor `klass` for `mime_type`.
unregister_preprocessor 'text/css', Sprockets::DirectiveProcessor
# File lib/sprockets/processing.rb, line 73 def unregister_preprocessor(*args) unregister_config_processor(:preprocessors, *args) end
Protected Instance Methods
# File lib/sprockets/processing.rb, line 162 def build_processors_uri(type, file_type, engine_extnames, pipeline) engines = engine_extnames.join(',') if engine_extnames.any? query = encode_uri_query_params( type: type, file_type: file_type, engines: engines, pipeline: pipeline ) "processors:#{query}" end
# File lib/sprockets/processing.rb, line 178 def default_processors_for(type, file_type, engine_extnames) bundled_processors = config[:bundle_processors][type] if bundled_processors.any? bundled_processors else self_processors_for(type, file_type, engine_extnames) end end
# File lib/sprockets/processing.rb, line 173 def processors_for(type, file_type, engine_extnames, pipeline) pipeline ||= :default config[:pipelines][pipeline.to_sym].call(self, type, file_type, engine_extnames) end
# File lib/sprockets/processing.rb, line 155 def resolve_processors_cache_key_uri(uri) params = parse_uri_query_params(uri[11..-1]) params[:engine_extnames] = params[:engines] ? params[:engines].split(',') : [] processors = processors_for(params[:type], params[:file_type], params[:engine_extnames], params[:pipeline]) processors_cache_keys(processors) end
# File lib/sprockets/processing.rb, line 187 def self_processors_for(type, file_type, engine_extnames) processors = [] processors.concat config[:postprocessors][type] if type != file_type && processor = config[:transformers][file_type][type] processors << processor end processors.concat engine_extnames.map { |ext| engines[ext] } processors.concat config[:preprocessors][file_type] if processors.any? || mime_type_charset_detecter(type) processors << FileReader end processors end
Private Instance Methods
# File lib/sprockets/processing.rb, line 234 def deprecate_legacy_processor_interface(interface) msg = "You are using a deprecated processor interface #{ interface.inspect }.\n" + "Please update your processor interface:\n" + "https://github.com/rails/sprockets/blob/master/guides/extending_sprockets.md#supporting-all-versions-of-sprockets-in-processors\n" Deprecation.new([caller[3]]).warn msg end
# File lib/sprockets/processing.rb, line 207 def register_config_processor(type, mime_type, klass, proc = nil, &block) proc ||= block processor = wrap_processor(klass, proc) self.config = hash_reassoc(config, type, mime_type) do |processors| processors.unshift(processor) processors end compute_transformers! end
# File lib/sprockets/processing.rb, line 219 def unregister_config_processor(type, mime_type, klass) if klass.is_a?(String) || klass.is_a?(Symbol) klass = config[type][mime_type].detect do |cls| cls.respond_to?(:name) && cls.name == "Sprockets::LegacyProcProcessor (#{klass})" end end self.config = hash_reassoc(config, type, mime_type) do |processors| processors.delete(klass) processors end compute_transformers! end
# File lib/sprockets/processing.rb, line 242 def wrap_processor(klass, proc) if !proc if klass.respond_to?(:call) klass else deprecate_legacy_processor_interface(klass) LegacyTiltProcessor.new(klass) end elsif proc.respond_to?(:arity) && proc.arity == 2 deprecate_legacy_processor_interface(proc) LegacyProcProcessor.new(klass.to_s, proc) else proc end end