Class: Mime::Type
- Inherits:
-
Object
show all
- Defined in:
- actionpack/lib/action_dispatch/http/mime_type.rb
Overview
Encapsulates the notion of a mime type. Can be used at render time, for example, with:
class PostsController < ActionController::Base
def show
@post = Post.find(params[:id])
respond_to do |format|
format.html
format.ics { render text: post.to_ics, mime_type: Mime::Type["text/calendar"] }
format.xml { render xml: @people }
end
end
end
Defined Under Namespace
Classes: AcceptItem, AcceptList
Constant Summary
collapse
- TRAILING_STAR_REGEXP =
/(text|application)\/\*/
- PARAMETER_SEPARATOR_REGEXP =
/;\s*\w+="?\w+"?/
- @@html_types =
Set.new [:html, :all]
Instance Attribute Summary collapse
Class Method Summary
collapse
-
.lookup(string) ⇒ Object
-
.lookup_by_extension(extension) ⇒ Object
-
.parse(accept_header) ⇒ Object
-
.parse_data_with_trailing_star(input) ⇒ Object
For an input of 'text'
, returns [Mime::JSON, Mime::XML, Mime::ICS, Mime::HTML, Mime::CSS, Mime::CSV, Mime::JS, Mime::YAML, Mime::TEXT]
.
-
.parse_trailing_star(accept_header) ⇒ Object
-
.register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false) ⇒ Object
-
.register_alias(string, symbol, extension_synonyms = []) ⇒ Object
Registers an alias that’s not used on mime type lookup, but can be referenced directly.
-
.register_callback(&block) ⇒ Object
-
.unregister(symbol) ⇒ Object
This method is opposite of register method.
Instance Method Summary
collapse
Constructor Details
#initialize(string, symbol = nil, synonyms = []) ⇒ Type
Returns a new instance of Type.
228
229
230
231
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 228
def initialize(string, symbol = nil, synonyms = [])
@symbol, @synonyms = symbol, synonyms
@string = string
end
|
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method, *args) ⇒ Object
282
283
284
285
286
287
288
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 282
def method_missing(method, *args)
if method.to_s.ends_with? '?'
method[0..-2].downcase.to_sym == to_sym
else
super
end
end
|
Instance Attribute Details
Returns the value of attribute symbol
57
58
59
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 57
def symbol
@symbol
end
|
Class Method Details
.lookup(string) ⇒ Object
148
149
150
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 148
def lookup(string)
LOOKUP[string]
end
|
.lookup_by_extension(extension) ⇒ Object
152
153
154
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 152
def lookup_by_extension(extension)
EXTENSION_LOOKUP[extension.to_s]
end
|
.parse(accept_header) ⇒ Object
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 176
def parse()
if !.include?(',')
= .split(PARAMETER_SEPARATOR_REGEXP).first
parse_trailing_star() || [Mime::Type.lookup()].compact
else
list, index = AcceptList.new, 0
.split(',').each do ||
params, q = .split(PARAMETER_SEPARATOR_REGEXP)
if params.present?
params.strip!
params = parse_trailing_star(params) || [params]
params.each do |m|
list << AcceptItem.new(index, m.to_s, q)
index += 1
end
end
end
list.assort!
end
end
|
.parse_data_with_trailing_star(input) ⇒ Object
For an input of 'text'
, returns [Mime::JSON, Mime::XML, Mime::ICS, Mime::HTML, Mime::CSS, Mime::CSV, Mime::JS, Mime::YAML, Mime::TEXT]
.
For an input of 'application'
, returns [Mime::HTML, Mime::JS, Mime::XML, Mime::YAML, Mime::ATOM, Mime::JSON, Mime::RSS, Mime::URL_ENCODED_FORM]
.
208
209
210
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 208
def parse_data_with_trailing_star(input)
Mime::SET.select { |m| m =~ input }
end
|
.parse_trailing_star(accept_header) ⇒ Object
199
200
201
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 199
def parse_trailing_star()
parse_data_with_trailing_star($1) if =~ TRAILING_STAR_REGEXP
end
|
.register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false) ⇒ Object
162
163
164
165
166
167
168
169
170
171
172
173
174
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 162
def register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false)
Mime.const_set(symbol.upcase, Type.new(string, symbol, mime_type_synonyms))
new_mime = Mime.const_get(symbol.upcase)
SET << new_mime
([string] + mime_type_synonyms).each { |str| LOOKUP[str] = SET.last } unless skip_lookup
([symbol] + extension_synonyms).each { |ext| EXTENSION_LOOKUP[ext.to_s] = SET.last }
@register_callbacks.each do |callback|
callback.call(new_mime)
end
end
|
.register_alias(string, symbol, extension_synonyms = []) ⇒ Object
Registers an alias that’s not used on mime type lookup, but can be referenced directly. Especially useful for rendering different HTML versions depending on the user agent, like an iPhone.
158
159
160
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 158
def register_alias(string, symbol, extension_synonyms = [])
register(string, symbol, [], extension_synonyms, true)
end
|
.register_callback(&block) ⇒ Object
144
145
146
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 144
def register_callback(&block)
@register_callbacks << block
end
|
.unregister(symbol) ⇒ Object
This method is opposite of register method.
Usage:
Mime::Type.unregister(:mobile)
217
218
219
220
221
222
223
224
225
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 217
def unregister(symbol)
symbol = symbol.upcase
mime = Mime.const_get(symbol)
Mime.instance_eval { remove_const(symbol) }
SET.delete_if { |v| v.eql?(mime) }
LOOKUP.delete_if { |_,v| v.eql?(mime) }
EXTENSION_LOOKUP.delete_if { |_,v| v.eql?(mime) }
end
|
Instance Method Details
#==(mime_type) ⇒ Object
257
258
259
260
261
262
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 257
def ==(mime_type)
return false if mime_type.blank?
(@synonyms + [ self ]).any? do |synonym|
synonym.to_s == mime_type.to_s || synonym.to_sym == mime_type.to_sym
end
end
|
#===(list) ⇒ Object
249
250
251
252
253
254
255
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 249
def ===(list)
if list.is_a?(Array)
(@synonyms + [ self ]).any? { |synonym| list.include?(synonym) }
else
super
end
end
|
#=~(mime_type) ⇒ Object
264
265
266
267
268
269
270
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 264
def =~(mime_type)
return false if mime_type.blank?
regexp = Regexp.new(Regexp.quote(mime_type.to_s))
(@synonyms + [ self ]).any? do |synonym|
synonym.to_s =~ regexp
end
end
|
#html? ⇒ Boolean
272
273
274
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 272
def html?
@@html_types.include?(to_sym) || @string =~ /html/
end
|
245
246
247
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 245
def ref
to_sym || to_s
end
|
233
234
235
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 233
def to_s
@string
end
|
237
238
239
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 237
def to_str
to_s
end
|
241
242
243
|
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 241
def to_sym
@symbol
end
|