Mime::Type

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
Methods
#
A
E
H
L
N
P
R
T
U
Constants
TRAILING_STAR_REGEXP = /^(text|application)\/\*/
 
PARAMETER_SEPARATOR_REGEXP = /;\s*\w+="?\w+"?/
 
Attributes
[R] hash
[R] string

TODO Change this to private once we've dropped Ruby 2.2 support. Workaround for Ruby 2.2 “private attribute?” warning.
[R] symbol
[R] synonyms

TODO Change this to private once we've dropped Ruby 2.2 support. Workaround for Ruby 2.2 “private attribute?” warning.
Class Public methods
lookup(string)

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 141
def lookup(string)
  LOOKUP[string] || Type.new(string)
end
lookup_by_extension(extension)

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 145
def lookup_by_extension(extension)
  EXTENSION_LOOKUP[extension.to_s]
end
new(string, symbol = nil, synonyms = [])

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 223
def initialize(string, symbol = nil, synonyms = [])
  @symbol, @synonyms = symbol, synonyms
  @string = string
  @hash = [@string, @synonyms, @symbol].hash
end
parse(accept_header)

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 169
def parse(accept_header)
  if !accept_header.include?(",")
    accept_header = accept_header.split(PARAMETER_SEPARATOR_REGEXP).first
    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)

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].

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 202
def parse_data_with_trailing_star(type)
  Mime::SET.select { |m| m =~ type }
end
parse_trailing_star(accept_header)

Source: show | on GitHub 

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

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 155
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 = [])

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.

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 151
def register_alias(string, symbol, extension_synonyms = [])
  register(string, symbol, [], extension_synonyms, true)
end
register_callback(&block)

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 137
def register_callback(&block)
  @register_callbacks << block
end
unregister(symbol)

This method is opposite of register method.

To unregister a MIME type:

Mime::Type.unregister(:mobile)

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 211
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 Public methods
==(mime_type)

Source: show | on GitHub 

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

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 245
def ===(list)
  if list.is_a?(Array)
    (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) }
  else
    super
  end
end
=~(mime_type)

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 267
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?()

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 277
def all?; false; end
eql?(other)

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 260
def eql?(other)
  super || (self.class == other.class &&
            @string    == other.string &&
            @synonyms  == other.synonyms &&
            @symbol    == other.symbol)
end
html?()

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 273
def html?
  symbol == :html || @string =~ /html/
end
ref()

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 241
def ref
  symbol || to_s
end
to_s()

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 229
def to_s
  @string
end
to_str()

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 233
def to_str
  to_s
end
to_sym()

Source: show | on GitHub 

# File actionpack/lib/action_dispatch/http/mime_type.rb, line 237
def to_sym
  @symbol
end