This repository has been archived by the owner on Jun 10, 2018. It is now read-only.
forked from rails/sprockets
/
processing.rb
280 lines (242 loc) · 7.88 KB
/
processing.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
require 'sprockets/engines'
require 'sprockets/mime'
require 'sprockets/processor'
require 'sprockets/utils'
module Sprockets
# `Processing` is an internal mixin whose public methods are exposed on
# the `Environment` and `Index` classes.
module Processing
include Engines, Mime
# Register a new mime type.
def register_mime_type(mime_type, ext)
# Overrides the global behavior to expire the index
expire_index!
@trail.append_extension(ext)
super
end
# Returns an `Array` of format extension `String`s.
#
# format_extensions
# # => ['.js', '.css']
#
def format_extensions
@trail.extensions - @engines.keys
end
# Registers a new Engine `klass` for `ext`.
def register_engine(ext, klass)
# Overrides the global behavior to expire the index
expire_index!
add_engine_to_trail(ext, klass)
super
end
# Deprecated alias for `preprocessors`.
def processors(*args)
preprocessors(*args)
end
# Returns an `Array` of `Processor` classes. If a `mime_type`
# argument is supplied, the processors registered under that
# extension will be returned.
#
# Preprocessors are ran before Postprocessors and Engine
# processors.
#
# All `Processor`s must follow the `Tilt::Template` interface. It is
# recommended to subclass `Tilt::Template`.
def preprocessors(mime_type = nil)
if mime_type
@preprocessors[mime_type].dup
else
deep_copy_hash(@preprocessors)
end
end
# Returns an `Array` of `Processor` classes. If a `mime_type`
# argument is supplied, the processors registered under that
# extension will be returned.
#
# Postprocessors are ran after Preprocessors and Engine processors.
#
# All `Processor`s must follow the `Tilt::Template` interface. It is
# recommended to subclass `Tilt::Template`.
def postprocessors(mime_type = nil)
if mime_type
@postprocessors[mime_type].dup
else
deep_copy_hash(@postprocessors)
end
end
# Deprecated alias for `register_preprocessor`.
def register_processor(*args, &block)
register_preprocessor(*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 :my_processor do |context, data|
# data.gsub(...)
# end
#
def register_preprocessor(mime_type, klass, &block)
expire_index!
if block_given?
name = klass.to_s
klass = Class.new(Processor) do
@name = name
@processor = block
end
end
@preprocessors[mime_type].push(klass)
end
# Registers a new Postprocessor `klass` for `mime_type`.
#
# register_postprocessor 'text/css', Sprockets::CharsetNormalizer
#
# A block can be passed for to create a shorthand processor.
#
# register_postprocessor :my_processor do |context, data|
# data.gsub(...)
# end
#
def register_postprocessor(mime_type, klass, &block)
expire_index!
if block_given?
name = klass.to_s
klass = Class.new(Processor) do
@name = name
@processor = block
end
end
@postprocessors[mime_type].push(klass)
end
# Deprecated alias for `unregister_preprocessor`.
def unregister_processor(*args)
unregister_preprocessor(*args)
end
# Remove Preprocessor `klass` for `mime_type`.
#
# unregister_preprocessor 'text/css', Sprockets::DirectiveProcessor
#
def unregister_preprocessor(mime_type, klass)
expire_index!
if klass.is_a?(String) || klass.is_a?(Symbol)
klass = @preprocessors[mime_type].detect { |cls|
cls.respond_to?(:name) &&
cls.name == "Sprockets::Processor (#{klass})"
}
end
@preprocessors[mime_type].delete(klass)
end
# Remove Postprocessor `klass` for `mime_type`.
#
# unregister_postprocessor 'text/css', Sprockets::DirectiveProcessor
#
def unregister_postprocessor(mime_type, klass)
expire_index!
if klass.is_a?(String) || klass.is_a?(Symbol)
klass = @postprocessors[mime_type].detect { |cls|
cls.respond_to?(:name) &&
cls.name == "Sprockets::Processor (#{klass})"
}
end
@postprocessors[mime_type].delete(klass)
end
# Returns an `Array` of `Processor` classes. If a `mime_type`
# argument is supplied, the processors registered under that
# extension will be returned.
#
# Bundle Processors are ran on concatenated assets rather than
# individual files.
#
# All `Processor`s must follow the `Tilt::Template` interface. It is
# recommended to subclass `Tilt::Template`.
def bundle_processors(mime_type = nil)
if mime_type
@bundle_processors[mime_type].dup
else
deep_copy_hash(@bundle_processors)
end
end
# Registers a new Bundle Processor `klass` for `mime_type`.
#
# register_bundle_processor 'text/css', Sprockets::CharsetNormalizer
#
# A block can be passed for to create a shorthand processor.
#
# register_bundle_processor :my_processor do |context, data|
# data.gsub(...)
# end
#
def register_bundle_processor(mime_type, klass, &block)
expire_index!
if block_given?
name = klass.to_s
klass = Class.new(Processor) do
@name = name
@processor = block
end
end
@bundle_processors[mime_type].push(klass)
end
# Remove Bundle Processor `klass` for `mime_type`.
#
# unregister_bundle_processor 'text/css', Sprockets::CharsetNormalizer
#
def unregister_bundle_processor(mime_type, klass)
expire_index!
if klass.is_a?(String) || klass.is_a?(Symbol)
klass = @bundle_processors[mime_type].detect { |cls|
cls.respond_to?(:name) &&
cls.name == "Sprockets::Processor (#{klass})"
}
end
@bundle_processors[mime_type].delete(klass)
end
# Return CSS compressor or nil if none is set
def css_compressor
bundle_processors('text/css').detect { |klass|
klass.respond_to?(:name) &&
klass.name == 'Sprockets::Processor (css_compressor)'
}
end
# Assign a compressor to run on `text/css` assets.
#
# The compressor object must respond to `compress` or `compile`.
def css_compressor=(compressor)
expire_index!
unregister_bundle_processor 'text/css', :css_compressor
return unless compressor
register_bundle_processor 'text/css', :css_compressor do |context, data|
compressor.compress(data)
end
end
# Return JS compressor or nil if none is set
def js_compressor
bundle_processors('application/javascript').detect { |klass|
klass.respond_to?(:name) &&
klass.name == 'Sprockets::Processor (js_compressor)'
}
end
# Assign a compressor to run on `application/javascript` assets.
#
# The compressor object must respond to `compress` or `compile`.
def js_compressor=(compressor)
expire_index!
unregister_bundle_processor 'application/javascript', :js_compressor
return unless compressor
register_bundle_processor 'application/javascript', :js_compressor do |context, data|
compressor.compress(data)
end
end
private
def add_engine_to_trail(ext, klass)
@trail.append_extension(ext.to_s)
if klass.respond_to?(:default_mime_type) && klass.default_mime_type
if format_ext = extension_for_mime_type(klass.default_mime_type)
@trail.alias_extension(ext.to_s, format_ext)
end
end
end
end
end