Parent

Class/Module Index [+]

Quicksearch

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 text: post.to_ics, mime_type: Mime::Type["text/calendar"]  }
      format.xml { render xml: @people }
    end
  end
end

Attributes

symbol[R]

Public Class Methods

browser_generated_types() click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 282
def self.browser_generated_types
  ActiveSupport::Deprecation.warn "Mime::Type.browser_generated_types is deprecated and will be removed in Rails 4.1"
  @@browser_generated_types
end
lookup(string) click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 151
def lookup(string)
  LOOKUP[string]
end
lookup_by_extension(extension) click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 155
def lookup_by_extension(extension)
  EXTENSION_LOOKUP[extension.to_s]
end
new(string, symbol = nil, synonyms = []) click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 231
def initialize(string, symbol = nil, synonyms = [])
  @symbol, @synonyms = symbol, synonyms
  @string = string
end
parse(accept_header) click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 179
def parse(accept_header)
  if accept_header !~ /,/
    accept_header = accept_header.split(PARAMETER_SEPARATOR_REGEXP).first
    parse_trailing_star(accept_header) || [Mime::Type.lookup(accept_header)].compact
  else
    list, index = AcceptList.new, 0
    accept_header.split(',').each do |header|
      params, q = header.split(PARAMETER_SEPARATOR_REGEXP)
      if params.present?
        params.strip!

        params = parse_trailing_star(params) || [params]

        params.each do |m|
          list << AcceptItem.new(index, m.to_s, q)
          index += 1
        end
      end
    end
    list.assort!
  end
end
parse_data_with_trailing_star(input) click to toggle source

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

# File lib/action_dispatch/http/mime_type.rb, line 211
def parse_data_with_trailing_star(input)
  Mime::SET.select { |m| m =~ input }
end
parse_trailing_star(accept_header) click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 202
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) click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 165
def register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false)
  Mime.const_set(symbol.upcase, Type.new(string, symbol, mime_type_synonyms))

  new_mime = Mime.const_get(symbol.upcase)
  SET << new_mime

  ([string] + mime_type_synonyms).each { |str| LOOKUP[str] = SET.last } unless skip_lookup
  ([symbol] + extension_synonyms).each { |ext| EXTENSION_LOOKUP[ext.to_s] = SET.last }

  @register_callbacks.each do |callback|
    callback.call(new_mime)
  end
end
register_alias(string, symbol, extension_synonyms = []) click to toggle source

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.

# File lib/action_dispatch/http/mime_type.rb, line 161
def register_alias(string, symbol, extension_synonyms = [])
  register(string, symbol, [], extension_synonyms, true)
end
register_callback(&block) click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 147
def register_callback(&block)
  @register_callbacks << block
end
unregister(symbol) click to toggle source

This method is opposite of register method.

Usage:

Mime::Type.unregister(:mobile)
# File lib/action_dispatch/http/mime_type.rb, line 220
def unregister(symbol)
  symbol = symbol.upcase
  mime = Mime.const_get(symbol)
  Mime.instance_eval { remove_const(symbol) }

  SET.delete_if { |v| v.eql?(mime) }
  LOOKUP.delete_if { |_,v| v.eql?(mime) }
  EXTENSION_LOOKUP.delete_if { |_,v| v.eql?(mime) }
end

Public Instance Methods

==(mime_type) click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 260
def ==(mime_type)
  return false if mime_type.blank?
  (@synonyms + [ self ]).any? do |synonym|
    synonym.to_s == mime_type.to_s || synonym.to_sym == mime_type.to_sym
  end
end
===(list) click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 252
def ===(list)
  if list.is_a?(Array)
    (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) }
  else
    super
  end
end
=~(mime_type) click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 267
def =~(mime_type)
  return false if mime_type.blank?
  regexp = Regexp.new(Regexp.quote(mime_type.to_s))
  (@synonyms + [ self ]).any? do |synonym|
    synonym.to_s =~ regexp
  end
end
html?() click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 287
def html?
  @@html_types.include?(to_sym) || @string =~ /html/
end
ref() click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 248
def ref
  to_sym || to_s
end
to_s() click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 236
def to_s
  @string
end
to_str() click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 240
def to_str
  to_s
end
to_sym() click to toggle source
# File lib/action_dispatch/http/mime_type.rb, line 244
def to_sym
  @symbol
end
verify_request?() click to toggle source

Returns true if Action Pack should check requests using this Mime Type for possible request forgery. See ActionController::RequestForgeryProtection.

# File lib/action_dispatch/http/mime_type.rb, line 277
def verify_request?
  ActiveSupport::Deprecation.warn "Mime::Type#verify_request? is deprecated and will be removed in Rails 4.1"
  @@browser_generated_types.include?(to_sym)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.