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

Namespace

Class

Methods

Constants

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

Attributes

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

Class Public methods

lookup(string)

📝 Source code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 145
      def lookup(string)
        LOOKUP[string] || Type.new(string)
      end
🔎 See on GitHub

lookup_by_extension(extension)

📝 Source code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 149
      def lookup_by_extension(extension)
        EXTENSION_LOOKUP[extension.to_s]
      end
🔎 See on GitHub

new(string, symbol = nil, synonyms = [])

📝 Source code 
# File actionpack/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
🔎 See on GitHub

parse(accept_header)

📝 Source code 
# File actionpack/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
🔎 See on GitHub

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 code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 207
      def parse_data_with_trailing_star(type)
        Mime::SET.select { |m| m.match?(type) }
      end
🔎 See on GitHub

parse_trailing_star(accept_header)

📝 Source code 
# File actionpack/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
🔎 See on GitHub

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

📝 Source code 
# File actionpack/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
🔎 See on GitHub

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 code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 155
      def register_alias(string, symbol, extension_synonyms = [])
        register(string, symbol, [], extension_synonyms, true)
      end
🔎 See on GitHub

register_callback(&block)

📝 Source code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 141
      def register_callback(&block)
        @register_callbacks << block
      end
🔎 See on GitHub

unregister(symbol)

This method is opposite of register method.

To unregister a MIME type:

Mime::Type.unregister(:mobile)
📝 Source code 
# File actionpack/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
🔎 See on GitHub

Instance Public methods

==(mime_type)

📝 Source code 
# File actionpack/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
🔎 See on GitHub

===(list)

📝 Source code 
# File actionpack/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
🔎 See on GitHub

=~(mime_type)

📝 Source code 
# File actionpack/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
🔎 See on GitHub

all?()

📝 Source code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 299
    def all?; false; end
🔎 See on GitHub

eql?(other)

📝 Source code 
# File actionpack/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
🔎 See on GitHub

html?()

📝 Source code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 295
    def html?
      (symbol == :html) || /html/.match?(@string)
    end
🔎 See on GitHub

match?(mime_type)

📝 Source code 
# File actionpack/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
🔎 See on GitHub

ref()

📝 Source code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 257
    def ref
      symbol || to_s
    end
🔎 See on GitHub

to_s()

📝 Source code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 245
    def to_s
      @string
    end
🔎 See on GitHub

to_str()

📝 Source code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 249
    def to_str
      to_s
    end
🔎 See on GitHub

to_sym()

📝 Source code 
# File actionpack/lib/action_dispatch/http/mime_type.rb, line 253
    def to_sym
      @symbol
    end
🔎 See on GitHub