Class: Mime::Type

Inherits:
Object
  • Object
show all
Defined in:
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 body: @post.to_ics, mime_type: Mime::Type.lookup("text/calendar")  }
      format.xml { render xml: @post }
    end
  end
end

Direct Known Subclasses

AllType

Defined Under Namespace

Classes: AcceptItem, AcceptList, InvalidMimeType

Constant Summary collapse

TRAILING_STAR_REGEXP = 
/^(text|application)\/\*/
PARAMETER_SEPARATOR_REGEXP = 
/;\s*\w+="?\w+"?/
MIME_NAME = 
"[a-zA-Z0-9][a-zA-Z0-9#{Regexp.escape('!#$&-^_.+')}]{0,126}"
MIME_PARAMETER_KEY = 
"[a-zA-Z0-9][a-zA-Z0-9#{Regexp.escape('!#$&-^_.+')}]{0,126}"
MIME_PARAMETER_VALUE = 
"#{Regexp.escape('"')}?[a-zA-Z0-9][a-zA-Z0-9#{Regexp.escape('!#$&-^_.+')}]{0,126}#{Regexp.escape('"')}?"
MIME_PARAMETER = 
"\s*\;\s*#{MIME_PARAMETER_KEY}(?:\=#{MIME_PARAMETER_VALUE})?"
MIME_REGEXP = 
/\A(?:\*\/\*|#{MIME_NAME}\/(?:\*|#{MIME_NAME})(?>\s*#{MIME_PARAMETER}\s*)*)\z/

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(string, symbol = nil, synonyms = []) ⇒ Type

Returns a new instance of Type.

[View source]

236
237
238
239
240
241
242
243
 
# File 'lib/action_dispatch/http/mime_type.rb', line 236

def initialize(string, symbol = nil, synonyms = [])
  unless MIME_REGEXP.match?(string)
    raise InvalidMimeType, "#{string.inspect} is not a valid MIME type"
  end
  @symbol, @synonyms = symbol, synonyms
  @string = string
  @hash = [@string, @synonyms, @symbol].hash
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object (private)

[View source]

308
309
310
311
312
313
314
 
# File 'lib/action_dispatch/http/mime_type.rb', line 308

def method_missing(method, *args)
  if method.end_with?("?")
    method[0..-2].downcase.to_sym == to_sym
  else
    super
  end
end

Instance Attribute Details

#hash ⇒ Object (readonly)

Returns the value of attribute hash.


226
227
228
 
# File 'lib/action_dispatch/http/mime_type.rb', line 226

def hash
  @hash
end

#symbol ⇒ Object (readonly)

Returns the value of attribute symbol.


66
67
68
 
# File 'lib/action_dispatch/http/mime_type.rb', line 66

def symbol
  @symbol
end

Class Method Details

.lookup(string) ⇒ Object

[View source]

145
146
147
 
# File 'lib/action_dispatch/http/mime_type.rb', line 145

def lookup(string)
  LOOKUP[string] || Type.new(string)
end

.lookup_by_extension(extension) ⇒ Object

[View source]

149
150
151
 
# File 'lib/action_dispatch/http/mime_type.rb', line 149

def lookup_by_extension(extension)
  EXTENSION_LOOKUP[extension.to_s]
end

.parse(accept_header) ⇒ Object

[View source]

173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/action_dispatch/http/mime_type.rb', line 173

def parse(accept_header)
  if !accept_header.include?(",")
    accept_header = accept_header.split(PARAMETER_SEPARATOR_REGEXP).first
    return [] unless accept_header
    parse_trailing_star(accept_header) || [Mime::Type.lookup(accept_header)].compact
  else
    list, index = [], 0
    accept_header.split(",").each do |header|
      params, q = header.split(PARAMETER_SEPARATOR_REGEXP)

      next unless params
      params.strip!
      next if params.empty?

      params = parse_trailing_star(params) || [params]

      params.each do |m|
        list << AcceptItem.new(index, m.to_s, q)
        index += 1
      end
    end
    AcceptList.sort! list
  end
end

.parse_data_with_trailing_star(type) ⇒ 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].

[View source]

207
208
209
 
# File 'lib/action_dispatch/http/mime_type.rb', line 207

def parse_data_with_trailing_star(type)
  Mime::SET.select { |m| m.match?(type) }
end

.parse_trailing_star(accept_header) ⇒ Object

[View source]

198
199
200
 
# File 'lib/action_dispatch/http/mime_type.rb', line 198

def parse_trailing_star(accept_header)
  parse_data_with_trailing_star($1) if accept_header =~ TRAILING_STAR_REGEXP
end

.register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false) ⇒ Object

[View source]

159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/action_dispatch/http/mime_type.rb', line 159

def register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false)
  new_mime = Type.new(string, symbol, mime_type_synonyms)

  SET << new_mime

  ([string] + mime_type_synonyms).each { |str| LOOKUP[str] = new_mime } unless skip_lookup
  ([symbol] + extension_synonyms).each { |ext| EXTENSION_LOOKUP[ext.to_s] = new_mime }

  @register_callbacks.each do |callback|
    callback.call(new_mime)
  end
  new_mime
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.

[View source]

155
156
157
 
# File 'lib/action_dispatch/http/mime_type.rb', line 155

def register_alias(string, symbol, extension_synonyms = [])
  register(string, symbol, [], extension_synonyms, true)
end

.register_callback(&block) ⇒ Object

[View source]

141
142
143
 
# File 'lib/action_dispatch/http/mime_type.rb', line 141

def register_callback(&block)
  @register_callbacks << block
end

.unregister(symbol) ⇒ Object

This method is opposite of register method.

To unregister a MIME type:

Mime::Type.unregister(:mobile)
[View source]

216
217
218
219
220
221
222
223
 
# File 'lib/action_dispatch/http/mime_type.rb', line 216

def unregister(symbol)
  symbol = symbol.downcase
  if mime = Mime[symbol]
    SET.delete_if { |v| v.eql?(mime) }
    LOOKUP.delete_if { |_, v| v.eql?(mime) }
    EXTENSION_LOOKUP.delete_if { |_, v| v.eql?(mime) }
  end
end

Instance Method Details

#==(mime_type) ⇒ Object

[View source]

269
270
271
272
273
274
 
# File 'lib/action_dispatch/http/mime_type.rb', line 269

def ==(mime_type)
  return false unless mime_type
  (@synonyms + [ self ]).any? do |synonym|
    synonym.to_s == mime_type.to_s || synonym.to_sym == mime_type.to_sym
  end
end

#===(list) ⇒ Object

[View source]

261
262
263
264
265
266
267
 
# File 'lib/action_dispatch/http/mime_type.rb', line 261

def ===(list)
  if list.is_a?(Array)
    (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) }
  else
    super
  end
end

#=~(mime_type) ⇒ Object

[View source]

283
284
285
286
287
 
# File 'lib/action_dispatch/http/mime_type.rb', line 283

def =~(mime_type)
  return false unless mime_type
  regexp = Regexp.new(Regexp.quote(mime_type.to_s))
  @synonyms.any? { |synonym| synonym.to_s =~ regexp } || @string =~ regexp
end

#all? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

299
 
# File 'lib/action_dispatch/http/mime_type.rb', line 299

def all?; false; end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean)
[View source]

276
277
278
279
280
281
 
# File 'lib/action_dispatch/http/mime_type.rb', line 276

def eql?(other)
  super || (self.class == other.class &&
            @string    == other.string &&
            @synonyms  == other.synonyms &&
            @symbol    == other.symbol)
end

#html? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

295
296
297
 
# File 'lib/action_dispatch/http/mime_type.rb', line 295

def html?
  (symbol == :html) || /html/.match?(@string)
end

#match?(mime_type) ⇒ Boolean

Returns:

  • (Boolean)
[View source]

289
290
291
292
293
 
# File 'lib/action_dispatch/http/mime_type.rb', line 289

def match?(mime_type)
  return false unless mime_type
  regexp = Regexp.new(Regexp.quote(mime_type.to_s))
  @synonyms.any? { |synonym| synonym.to_s.match?(regexp) } || @string.match?(regexp)
end

#ref ⇒ Object

[View source]

257
258
259
 
# File 'lib/action_dispatch/http/mime_type.rb', line 257

def ref
  symbol || to_s
end

#to_s ⇒ Object

[View source]

245
246
247
 
# File 'lib/action_dispatch/http/mime_type.rb', line 245

def to_s
  @string
end

#to_str ⇒ Object

[View source]

249
250
251
 
# File 'lib/action_dispatch/http/mime_type.rb', line 249

def to_str
  to_s
end

#to_sym ⇒ Object

[View source]

253
254
255
 
# File 'lib/action_dispatch/http/mime_type.rb', line 253

def to_sym
  @symbol
end