Class: Mime::Type

Inherits:
Object show all
Defined in:
lib/action_controller/mime_type.rb

Overview

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.to_xml }
    end
  end
end

Defined Under Namespace

Classes: AcceptItem

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(string, symbol = nil, synonyms = []) ⇒ Type

Returns a new instance of Type.



103
104
105
106
 
# File 'lib/action_controller/mime_type.rb', line 103

def initialize(string, symbol = nil, synonyms = [])
  @symbol, @synonyms = symbol, synonyms
  @string = string
end

Class Method Details

.lookup(string) ⇒ Object 



43
44
45
 
# File 'lib/action_controller/mime_type.rb', line 43

def lookup(string)
  LOOKUP[string]
end

.parse(accept_header) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/action_controller/mime_type.rb', line 53

def parse(accept_header)
  # keep track of creation order to keep the subsequent sort stable
  index = 0
  list = accept_header.split(/,/).map! do |i| 
    AcceptItem.new(index += 1, *i.split(/;\s*q=/))
  end.sort!

  # Take care of the broken text/xml entry by renaming or deleting it
  text_xml = list.index("text/xml")
  app_xml = list.index("application/xml")

  if text_xml && app_xml
    # set the q value to the max of the two
    list[app_xml].q = [list[text_xml].q, list[app_xml].q].max

    # make sure app_xml is ahead of text_xml in the list
    if app_xml > text_xml
      list[app_xml], list[text_xml] = list[text_xml], list[app_xml]
      app_xml, text_xml = text_xml, app_xml
    end

    # delete text_xml from the list
    list.delete_at(text_xml)
  
  elsif text_xml
    list[text_xml].name = "application/xml"
  end

  # Look for more specific xml-based types and sort them ahead of app/xml

  if app_xml
    idx = app_xml
    app_xml_type = list[app_xml]

    while(idx < list.length)
      type = list[idx]
      break if type.q < app_xml_type.q
      if type.name =~ /\+xml$/
        list[app_xml], list[idx] = list[idx], list[app_xml]
        app_xml = idx
      end
      idx += 1
    end
  end

  list.map! { |i| Mime::Type.lookup(i.name) }.uniq!
  list
end

.register(string, symbol, synonyms = []) ⇒ Object 



47
48
49
50
51
 
# File 'lib/action_controller/mime_type.rb', line 47

def register(string, symbol, synonyms = [])
  Mime.send :const_set, symbol.to_s.upcase, Type.new(string, symbol, synonyms)
  SET << Mime.send(:const_get, symbol.to_s.upcase)
  LOOKUP[string] = EXTENSION_LOOKUP[symbol.to_s] = SET.last        
end

Instance Method Details

#==(mime_type) ⇒ Object 



128
129
130
 
# File 'lib/action_controller/mime_type.rb', line 128

def ==(mime_type)
  (@synonyms + [ self ]).any? { |synonym| synonym.to_s == mime_type.to_s } if mime_type
end

#===(list) ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/action_controller/mime_type.rb', line 120

def ===(list)
  if list.is_a?(Array)
    (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) }
  else
    super
  end
end

#to_s ⇒ Object 



108
109
110
 
# File 'lib/action_controller/mime_type.rb', line 108

def to_s
  @string
end

#to_str ⇒ Object 



112
113
114
 
# File 'lib/action_controller/mime_type.rb', line 112

def to_str
  to_s
end

#to_sym ⇒ Object 



116
117
118
 
# File 'lib/action_controller/mime_type.rb', line 116

def to_sym
  @symbol || @string.to_sym
end