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 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 =

all media-type parameters need to be before the q-parameter www.rfc-editor.org/rfc/rfc7231#section-5.3.2

/\s*;\s*q="?/
ACCEPT_HEADER_REGEXP = 
/[^,\s"](?:[^,"]|"[^"]*")*/
MIME_NAME = 
"[a-zA-Z0-9][a-zA-Z0-9#{Regexp.escape('!#$&-^_.+')}]{0,126}"
MIME_PARAMETER_VALUE = 
"(?:#{MIME_NAME}|\"[^\"\r\\\\]*\")"
MIME_PARAMETER = 
"\s*;\s*#{MIME_NAME}(?:=#{MIME_PARAMETER_VALUE})?"
MIME_REGEXP = 
/\A(?:\*\/\*|#{MIME_NAME}\/(?:\*|#{MIME_NAME})(?>#{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.



257
258
259
260
261
262
263
264
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 257

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) 



329
330
331
332
333
334
335
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 329

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.



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

def hash
  @hash
end

#symbol ⇒ Object (readonly)

Returns the value of attribute symbol.



82
83
84
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 82

def symbol
  @symbol
end

Class Method Details

.lookup(string) ⇒ Object 



164
165
166
167
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 164

def lookup(string)
  # fallback to the media-type without parameters if it was not found
  LOOKUP[string] || LOOKUP[string.split(";", 2)[0]&.rstrip] || Type.new(string)
end

.lookup_by_extension(extension) ⇒ Object 



169
170
171
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 169

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

.parse(accept_header) ⇒ Object 



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
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 193

def parse(accept_header)
  if !accept_header.include?(",")
    if (index = accept_header.index(PARAMETER_SEPARATOR_REGEXP))
      accept_header = accept_header[0, index]
    end
    return [] if accept_header.blank?
    parse_trailing_star(accept_header) || Array(Mime::Type.lookup(accept_header))
  else
    list, index = [], 0
    accept_header.scan(ACCEPT_HEADER_REGEXP).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]].



229
230
231
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 229

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

.parse_trailing_star(accept_header) ⇒ Object 



220
221
222
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 220

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 



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 179

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.



175
176
177
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 175

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

.register_callback(&block) ⇒ Object 



160
161
162
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 160

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)



238
239
240
241
242
243
244
245
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 238

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 



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

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 



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

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

#=~(mime_type) ⇒ Object 



304
305
306
307
308
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 304

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) 


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

def all?; false; end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


297
298
299
300
301
302
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 297

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

#html? ⇒ Boolean

Returns:

  • (Boolean) 


316
317
318
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 316

def html?
  (symbol == :html) || @string.include?("html")
end

#match?(mime_type) ⇒ Boolean

Returns:

  • (Boolean) 


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

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 



278
279
280
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 278

def ref
  symbol || to_s
end

#to_s ⇒ Object 



266
267
268
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 266

def to_s
  @string
end

#to_str ⇒ Object 



270
271
272
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 270

def to_str
  to_s
end

#to_sym ⇒ Object 



274
275
276
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 274

def to_sym
  @symbol
end