Class: Mime::Type

Inherits:
Object show all
Defined in:
actionpack/lib/action_dispatch/http/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 body: @post.to_ics, mime_type: Mime::Type.lookup("text/calendar")  }
      format.xml { render xml: @post }
    end
  end
end

Direct Known Subclasses

AllType

Defined Under Namespace

Classes: AcceptItem, AcceptList, InvalidMimeType

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Type.



233
234
235
236
237
238
239
240
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 233

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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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



305
306
307
308
309
310
311
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 305

def method_missing(method, *args)
  if method.to_s.ends_with? "?"
    method[0..-2].downcase.to_sym == to_sym
  else
    super
  end
end

Instance Attribute Details

#hash ⇒ Object (readonly)

Returns the value of attribute hash



223
224
225
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 223

def hash
  @hash
end

#symbol ⇒ Object (readonly)

Returns the value of attribute symbol



63
64
65
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 63

def symbol
  @symbol
end

Class Method Details

.lookup(string) ⇒ Object 



142
143
144
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 142

def lookup(string)
  LOOKUP[string] || Type.new(string)
end

.lookup_by_extension(extension) ⇒ Object 



146
147
148
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 146

def lookup_by_extension(extension)
  EXTENSION_LOOKUP[extension.to_s]
end

.parse(accept_header) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 170

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

.parse_data_with_trailing_star(type) ⇒ Object

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



204
205
206
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 204

def parse_data_with_trailing_star(type)
  Mime::SET.select { |m| m.match?(type) }
end

.parse_trailing_star(accept_header) ⇒ Object 



195
196
197
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 195

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



156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 156

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

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



152
153
154
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 152

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

.register_callback(&block) ⇒ Object 



138
139
140
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 138

def register_callback(&block)
  @register_callbacks << block
end

.unregister(symbol) ⇒ Object

This method is opposite of register method.

To unregister a MIME type:

Mime::Type.unregister(:mobile)



213
214
215
216
217
218
219
220
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 213

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

Instance Method Details

#==(mime_type) ⇒ Object 



266
267
268
269
270
271
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 266

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

#===(list) ⇒ Object 



258
259
260
261
262
263
264
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 258

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

#=~(mime_type) ⇒ Object 



280
281
282
283
284
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 280

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

#all? ⇒ Boolean

Returns:

  • (Boolean) 


296
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 296

def all?; false; end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


273
274
275
276
277
278
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 273

def eql?(other)
  super || (self.class == other.class &&
            @string    == other.string &&
            @synonyms  == other.synonyms &&
            @symbol    == other.symbol)
end

#html? ⇒ Boolean

Returns:

  • (Boolean) 


292
293
294
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 292

def html?
  (symbol == :html) || /html/.match?(@string)
end

#match?(mime_type) ⇒ Boolean

Returns:

  • (Boolean) 


286
287
288
289
290
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 286

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

#ref ⇒ Object 



254
255
256
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 254

def ref
  symbol || to_s
end

#to_s ⇒ Object 



242
243
244
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 242

def to_s
  @string
end

#to_str ⇒ Object 



246
247
248
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 246

def to_str
  to_s
end

#to_sym ⇒ Object 



250
251
252
 
# File 'actionpack/lib/action_dispatch/http/mime_type.rb', line 250

def to_sym
  @symbol
end