Class: Mime::Type

Inherits:
Object
  • Object
show all
Defined in:
lib/classy_resources/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

Constant Summary collapse

@@html_types = 
Set.new [:html, :all]
@@browser_generated_types = 
Set.new [:html, :url_encoded_form, :multipart_form, :text]

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Type.



139
140
141
142
 
# File 'lib/classy_resources/mime_type.rb', line 139

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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object (private) 



186
187
188
189
190
191
192
 
# File 'lib/classy_resources/mime_type.rb', line 186

def method_missing(method, *args)
  if method.to_s =~ /(\w+)\?$/
    $1.downcase.to_sym == to_sym
  else
    super
  end
end

Class Method Details

.browser_generated_types ⇒ Object 



24
 
# File 'lib/classy_resources/mime_type.rb', line 24

def self.browser_generated_types; @@browser_generated_types; end

.html_types ⇒ Object 



23
 
# File 'lib/classy_resources/mime_type.rb', line 23

def self.html_types; @@html_types; end

.lookup(string) ⇒ Object 



57
58
59
 
# File 'lib/classy_resources/mime_type.rb', line 57

def lookup(string)
  LOOKUP[string]
end

.lookup_by_extension(extension) ⇒ Object 



61
62
63
 
# File 'lib/classy_resources/mime_type.rb', line 61

def lookup_by_extension(extension)
  EXTENSION_LOOKUP[extension]
end

.parse(accept_header) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/classy_resources/mime_type.rb', line 80

def parse(accept_header)
  if accept_header !~ /,/
    [Mime::Type.lookup(accept_header)]
  else
    # keep track of creation order to keep the subsequent sort stable
    list = []
    accept_header.split(/,/).each_with_index do |header, index| 
      params, q = header.split(/;\s*q=/)       
      if params
        params.strip!          
        list << AcceptItem.new(index, params, q) unless params.empty?
      end
    end
    list.sort!

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

    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 = Mime::XML.to_s
    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
end

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



71
72
73
74
75
76
77
78
 
# File 'lib/classy_resources/mime_type.rb', line 71

def register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false)
  Mime.instance_eval { const_set symbol.to_s.upcase, Type.new(string, symbol, mime_type_synonyms) }

  SET << Mime.const_get(symbol.to_s.upcase)

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

.register_alias(string, symbol, extension_synonyms = []) ⇒ Object

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.



67
68
69
 
# File 'lib/classy_resources/mime_type.rb', line 67

def register_alias(string, symbol, extension_synonyms = [])
  register(string, symbol, [], extension_synonyms, true)
end

Instance Method Details

#==(mime_type) ⇒ Object 



164
165
166
167
168
169
 
# File 'lib/classy_resources/mime_type.rb', line 164

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) ⇒ Object 



156
157
158
159
160
161
162
 
# File 'lib/classy_resources/mime_type.rb', line 156

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

#browser_generated? ⇒ Boolean

Returns:

  • (Boolean) 


181
182
183
 
# File 'lib/classy_resources/mime_type.rb', line 181

def browser_generated?
  @@browser_generated_types.include?(to_sym)
end

#html? ⇒ Boolean

Returns:

  • (Boolean) 


177
178
179
 
# File 'lib/classy_resources/mime_type.rb', line 177

def html?
  @@html_types.include?(to_sym) || @string =~ /html/
end

#to_s ⇒ Object 



144
145
146
 
# File 'lib/classy_resources/mime_type.rb', line 144

def to_s
  @string
end

#to_str ⇒ Object 



148
149
150
 
# File 'lib/classy_resources/mime_type.rb', line 148

def to_str
  to_s
end

#to_sym ⇒ Object 



152
153
154
 
# File 'lib/classy_resources/mime_type.rb', line 152

def to_sym
  @symbol || @string.to_sym
end

#verify_request? ⇒ Boolean

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

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/classy_resources/mime_type.rb', line 173

def verify_request?
  browser_generated?
end