123456789_123456789_123456789_123456789_123456789_

Class: Mime::Type

Relationships & Source Files
Namespace Children
Classes:
AcceptItem, AcceptList
Exceptions:
InvalidMimeType
Extension / Inclusion / Inheritance Descendants
Subclasses:
AllType
Inherits: Object
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

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(string, symbol = nil, synonyms = nil) ⇒ Type

[ GitHub ] 

  


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



def initialize(string, symbol = nil, synonyms = nil)
  unless MIME_REGEXP.match?(string)
    raise InvalidMimeType, "#{string.inspect} is not a valid MIME type"
  end
  @symbol = symbol
  @synonyms = if synonyms&.any?
    synonyms.map { |synonym| synonym.dup.freeze }.freeze
  else
    [].freeze
  end
  @string = string.dup.freeze
  @hash = [@string, @synonyms, @symbol].hash
  freeze
end


  







Dynamic Method Handling

  

    This class handles dynamic methods through the method_missing method




  

    #method_missing(method)   (private)
  

  [ GitHub ]


  

  


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



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


  







Class Method Details



  

    .lookup(string)  
  

  [ GitHub ]


  

  


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



def lookup(string)
  lookup = Mime.lookup_by_string
  return lookup[string] if lookup.key?(string)

  # fallback to the media-type without parameters if it was not found
  string = string.split(";", 2)[0]&.rstrip
  lookup[string] || Type.new(string)
end


  








  

    .lookup_by_extension(extension)  
  

  [ GitHub ]


  

  


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



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


  








  

    .on_change(&block)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



def on_change(&block) # :nodoc:
  @on_change_callbacks << block
end


  








  

    .parse(accept_header)  
  

  [ GitHub ]


  

  


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



def parse(accept_header)
  if !accept_header.include?(",")
    if (index = accept_header.index(PARAMETER_SEPARATOR_REGEXP))
      accept_header = accept_header[0, index].strip
    end
    return [] if accept_header.blank?
    parse_trailing_star(accept_header) || Array(Mime::Type.lookup(accept_header))
  else
    list, index = [], 0
    accept_header.scan(ACCEPT_HEADER_REGEXP).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)  
  



  

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

  



  [ GitHub ]


  

  


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



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


  








  

    .parse_trailing_star(accept_header)  
  

  [ GitHub ]


  

  


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



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)  
  

  [ GitHub ]


  

  


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



def register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false)
  new_mime = Type.new(string, symbol, mime_type_synonyms)

  Mime.update do |registry, string_lookup, extension_lookup|
    registry << new_mime
    ([string] + mime_type_synonyms).each { |str| string_lookup[-str] = new_mime } unless skip_lookup
    ([symbol] + extension_synonyms).each { |ext| extension_lookup[-ext.to_s] = new_mime }
  end

  @on_change_callbacks.each do |callback|
    callback.call(new_mime, true)
  end
  new_mime
end


  








  

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



  

    
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.

  



  [ GitHub ]


  

  


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



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


  








  

    .register_callback(&block)  
  

  [ GitHub ]


  

  


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



def register_callback(&block)
  on_change { |mime, registered| block.call(mime) if registered }
end


  








  

    .unregister(symbol)  
  



  

    
This method is opposite of register method.


To unregister a MIME type:


Mime::Type.unregister(:mobile)

  



  [ GitHub ]


  

  


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



def unregister(symbol)
  symbol = symbol.downcase
  if mime = Mime[symbol]
    Mime.update do |registry, string_lookup, extension_lookup|
      registry.delete_if { |v| v.eql?(mime) }
      string_lookup.delete_if { |_, v| v.eql?(mime) }
      extension_lookup.delete_if { |_, v| v.eql?(mime) }
    end

    @on_change_callbacks.each do |callback|
      callback.call(mime, false)
    end
  end
end


  







Instance Attribute Details



  

    #all?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


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



def all?; false; end


  








  

    #hash   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :hash


  








  

    #html?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


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



def html?
  (symbol == :html) || @string.include?("html")
end


  








  

    #string   (readonly, protected)
  

  [ GitHub ]


  

  


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



attr_reader :string, :synonyms


  








  

    #symbol   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :symbol


  








  

    #synonyms   (readonly, protected)
  

  [ GitHub ]


  

  


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



attr_reader :string, :synonyms


  







Instance Method Details



  

    #==(mime_type)  
  

  [ GitHub ]


  

  


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



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)  
  

  [ GitHub ]


  

  


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



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


  








  

    #=~(mime_type)  
  

  [ GitHub ]


  

  


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



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


  








  

    #eql?(other)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


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



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


  








  

    #match?(mime_type)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


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



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  
  

  [ GitHub ]


  

  


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



def ref
  symbol || to_s
end


  








  

    #respond_to_missing?(method, include_private = false)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


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



def respond_to_missing?(method, include_private = false)
  method.end_with?("?") || super
end


  








  

    #to_a   (private)
  

  [ GitHub ]


  

  


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



def to_a; end


  








  

    #to_ary   (private)
  

  [ GitHub ]


  

  


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



def to_ary; end


  








  

    #to_s  
  

  [ GitHub ]


  

  


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



def to_s
  @string
end


  








  

    #to_str  
  

  [ GitHub ]


  

  


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



def to_str
  to_s
end


  








  

    #to_sym  
  

  [ GitHub ]


  

  


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



def to_sym
  @symbol
end