Skip to Content Skip to Search

class 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

Constants

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

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

/;\s*q="?/
/^(text|application)\/\*/

Attributes

[R] hash
[R] string
[R] symbol
[R] synonyms

Public class methods

Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 167
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
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 172
def lookup_by_extension(extension)
  EXTENSION_LOOKUP[extension.to_s]
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 261
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
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 197
def parse(accept_header)
  if !accept_header.include?(",")
    if (index = accept_header.index(PARAMETER_SEPARATOR_REGEXP))
      accept_header = accept_header[0, index].strip
    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

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 code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 233
def parse_data_with_trailing_star(type)
  Mime::SET.select { |m| m.match?(type) }
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 224
def parse_trailing_star(accept_header)
  parse_data_with_trailing_star($1) if accept_header =~ TRAILING_STAR_REGEXP
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 183
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

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 code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 179
def register_alias(string, symbol, extension_synonyms = [])
  register(string, symbol, [], extension_synonyms, true)
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 163
def register_callback(&block)
  @register_callbacks << block
end

This method is opposite of register method.

To unregister a MIME type:

Mime::Type.unregister(:mobile)
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 242
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

Public instance methods

Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 294
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
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 286
def ===(list)
  if list.is_a?(Array)
    (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) }
  else
    super
  end
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 308
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
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 324
def all?; false; end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 301
def eql?(other)
  super || (self.class == other.class &&
            @string    == other.string &&
            @synonyms  == other.synonyms &&
            @symbol    == other.symbol)
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 320
def html?
  (symbol == :html) || @string.include?("html")
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 314
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
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 282
def ref
  symbol || to_s
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 270
def to_s
  @string
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 274
def to_str
  to_s
end
Source code GitHub
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 278
def to_sym
  @symbol
end

Namespace

Definition files