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
- MIME_NAME
- MIME_PARAMETER
- MIME_PARAMETER_VALUE
- MIME_REGEXP
- PARAMETER_SEPARATOR_REGEXP
- TRAILING_STAR_REGEXP
Attributes
Public Class Methods
Source
# File lib/action_dispatch/http/mime_type.rb, line 144 def lookup(string) LOOKUP[string] || Type.new(string) end
Source
# File lib/action_dispatch/http/mime_type.rb, line 148 def lookup_by_extension(extension) EXTENSION_LOOKUP[extension.to_s] end
Source
# File lib/action_dispatch/http/mime_type.rb, line 234 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
# File lib/action_dispatch/http/mime_type.rb, line 172 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
Source
# File lib/action_dispatch/http/mime_type.rb, line 206 def parse_data_with_trailing_star(type) Mime::SET.select { |m| m.match?(type) } 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
# File lib/action_dispatch/http/mime_type.rb, line 197 def parse_trailing_star(accept_header) parse_data_with_trailing_star($1) if accept_header =~ TRAILING_STAR_REGEXP end
Source
# File lib/action_dispatch/http/mime_type.rb, line 158 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
Source
# File lib/action_dispatch/http/mime_type.rb, line 154 def register_alias(string, symbol, extension_synonyms = []) register(string, symbol, [], extension_synonyms, true) 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
# File lib/action_dispatch/http/mime_type.rb, line 140 def register_callback(&block) @register_callbacks << block end
Source
# File lib/action_dispatch/http/mime_type.rb, line 215 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
This method is opposite of register method.
To unregister a MIME type:
Mime::Type.unregister(:mobile)
Public Instance Methods
Source
# File lib/action_dispatch/http/mime_type.rb, line 267 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
# File lib/action_dispatch/http/mime_type.rb, line 259 def ===(list) if list.is_a?(Array) (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) } else super end end
Calls superclass method
Source
# File lib/action_dispatch/http/mime_type.rb, line 281 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
# File lib/action_dispatch/http/mime_type.rb, line 274 def eql?(other) super || (self.class == other.class && @string == other.string && @synonyms == other.synonyms && @symbol == other.symbol) end
Calls superclass method
Source
# File lib/action_dispatch/http/mime_type.rb, line 293 def html? (symbol == :html) || /html/.match?(@string) end
Source
# File lib/action_dispatch/http/mime_type.rb, line 287 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
Private Instance Methods
Source
# File lib/action_dispatch/http/mime_type.rb, line 306 def method_missing(method, *args) if method.end_with?("?") method[0..-2].downcase.to_sym == to_sym else super end end
Calls superclass method
Source
# File lib/action_dispatch/http/mime_type.rb, line 314 def respond_to_missing?(method, include_private = false) method.end_with?("?") || super end
Calls superclass method