Class: MIME::Type

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/mime/type.rb

Overview

The definition of one MIME content-type.

Usage

require 'mime/types'

plaintext = MIME::Types['text/plain'].first
# returns [text/plain, text/plain]
text      = plaintext.first
print text.media_type           # => 'text'
print text.sub_type             # => 'plain'

puts text.extensions.join(" ")  # => 'asc txt c cc h hh cpp'

puts text.encoding              # => 8bit
puts text.binary?               # => false
puts text.ascii?                # => true
puts text == 'text/plain'       # => true
puts MIME::Type.simplified('x-appl/x-zip') # => 'appl/zip'

puts MIME::Types.any? { |type|
  type.content_type == 'text/plain'
}                               # => true
puts MIME::Types.all?(&:registered?)
                                # => false

Defined Under Namespace

Classes: InvalidContentType, InvalidEncoding

Constant Summary collapse

VERSION =

The released version of the mime-types library.

'2.3'
MEDIA_TYPE_RE =

:stopdoc:

%r{([-\w.+]+)/([-\w.+]*)}o
UNREGISTERED_RE = 
%r{[Xx]-}o
PLATFORM_RE = 
%r{#{RUBY_PLATFORM}}o
DEFAULT_ENCODINGS = 
[ nil, :default ]
BINARY_ENCODINGS = 
%w(base64 8bit)
TEXT_ENCODINGS = 
%w(7bit quoted-printable)
VALID_ENCODINGS = 
DEFAULT_ENCODINGS + BINARY_ENCODINGS + TEXT_ENCODINGS
IANA_URL = 
"http://www.iana.org/assignments/media-types/%s/%s"
RFC_URL = 
"http://rfc-editor.org/rfc/rfc%s.txt"
DRAFT_URL = 
"http://datatracker.ietf.org/public/idindex.cgi?command=id_details&filename=%s"
CONTACT_URL = 
"http://www.iana.org/assignments/contact-people.htm#%s"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content_type) {|_self| ... } ⇒ Type

Builds a MIME::Type object from the provided MIME Content Type value (e.g., ‘text/plain’ or ‘applicaton/x-eruby’). The constructed object is yielded to an optional block for additional configuration, such as associating extensions and encoding information.

  • When provided a Hash or a MIME::Type, the MIME::Type will be constructed with #init_with.

  • When provided an Array, the MIME::Type will be constructed only using the first two elements of the array as the content type and extensions.

  • Otherwise, the content_type will be used as a string.

Yields:

  • (_self)

Yield Parameters:

  • _self (MIME::Type) —

    the object that the method was called on



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
 
# File 'lib/mime/type.rb', line 91

def initialize(content_type) # :yields self:
  self.system      = nil
  self.obsolete    = false
  self.registered  = nil
  self.use_instead = nil
  self.signature   = nil

  case content_type
  when Hash
    init_with(content_type)
  when Array
    self.content_type = content_type[0]
    self.extensions   = content_type[1] || []
  when MIME::Type
    init_with(content_type.to_h)
  else
    self.content_type = content_type
  end

  self.extensions   ||= []
  self.docs         ||= nil
  self.encoding     ||= :default
  # This value will be deprecated in the future, as it will be an
  # alternative view on #xrefs. Silence an unnecessary warning for now by
  # assigning directly to the instance variable.
  @references       ||= []
  self.xrefs        ||= {}

  yield self if block_given?
end

Instance Attribute Details

#content_type ⇒ Object

Returns the whole MIME content-type string.

text/plain        => text/plain
x-chemical/x-pdb  => x-chemical/x-pdb



192
193
194
 
# File 'lib/mime/type.rb', line 192

def content_type
  @content_type
end

#docs ⇒ Object

The documentation for this MIME::Type.



297
298
299
 
# File 'lib/mime/type.rb', line 297

def docs
  @docs
end

#encoding ⇒ Object

The encoding (7bit, 8bit, quoted-printable, or base64) required to transport the data of this content type safely across a network, which roughly corresponds to Content-Transfer-Encoding. A value of nil or :default will reset the #encoding to the #default_encoding for the MIME::Type. Raises ArgumentError if the encoding provided is invalid.

If the encoding is not provided on construction, this will be either ‘quoted-printable’ (for text/* media types) and ‘base64’ for eveything else.



246
247
248
 
# File 'lib/mime/type.rb', line 246

def encoding
  @encoding
end

#extensions ⇒ Object

The list of extensions which are known to be used for this MIME::Type. Non-array values will be coerced into an array with #to_a. Array values will be flattened, nil values removed, sorted, and made unique.



225
226
227
 
# File 'lib/mime/type.rb', line 225

def extensions
  @extensions
end

#media_type ⇒ Object (readonly)

Returns the media type of the simplified MIME::Type.

text/plain        => text
x-chemical/x-pdb  => chemical



197
198
199
 
# File 'lib/mime/type.rb', line 197

def media_type
  @media_type
end

#raw_media_type ⇒ Object (readonly)

Returns the media type of the unmodified MIME::Type.

text/plain        => text
x-chemical/x-pdb  => x-chemical



202
203
204
 
# File 'lib/mime/type.rb', line 202

def raw_media_type
  @raw_media_type
end

#raw_sub_type ⇒ Object (readonly)

Returns the media type of the unmodified MIME::Type.

text/plain        => plain
x-chemical/x-pdb  => x-pdb



212
213
214
 
# File 'lib/mime/type.rb', line 212

def raw_sub_type
  @raw_sub_type
end

#references ⇒ Object

The encoded references URL list for this MIME::Type. See #urls for more information.

This was previously called #url.



303
304
305
 
# File 'lib/mime/type.rb', line 303

def references
  @references
end

#simplified ⇒ Object (readonly)

The MIME types main- and sub-label can both start with x-, which indicates that it is a non-registered name. Of course, after registration this flag can disappear, adds to the confusing proliferation of MIME types. The simplified string has the x- removed and are translated to lowercase.

text/plain        => text/plain
x-chemical/x-pdb  => chemical/pdb



221
222
223
 
# File 'lib/mime/type.rb', line 221

def simplified
  @simplified
end

#sub_type ⇒ Object (readonly)

Returns the sub-type of the simplified MIME::Type.

text/plain        => plain
x-chemical/x-pdb  => pdb



207
208
209
 
# File 'lib/mime/type.rb', line 207

def sub_type
  @sub_type
end

#use_instead ⇒ Object

Returns the media type or types that should be used instead of this media type, if it is obsolete. If there is no replacement media type, or it is not obsolete, nil will be returned.



282
283
284
285
 
# File 'lib/mime/type.rb', line 282

def use_instead
  return nil unless obsolete?
  @use_instead
end

#xrefs ⇒ Object

The cross-references list for this MIME::Type.



319
320
321
 
# File 'lib/mime/type.rb', line 319

def xrefs
  @xrefs
end

Class Method Details

.from_array(*args) ⇒ Object

Creates a MIME::Type from an array in the form of:

[type-name, [extensions], encoding, system]

extensions, encoding, and system are optional.

MIME::Type.from_array("application/x-ruby", ['rb'], '8bit')
MIME::Type.from_array(["application/x-ruby", ['rb'], '8bit'])

These are equivalent to:

MIME::Type.new('application/x-ruby') do |t|
  t.extensions  = %w(rb)
  t.encoding    = '8bit'
end

This method is deprecated.



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/mime/type.rb', line 581

def from_array(*args) # :yields MIME::Type.new:
  MIME.deprecated(self, __method__)

  # Dereferences the array one level, if necessary.
  args = args.first if args.first.kind_of? Array

  unless args.size.between?(1, 8)
    raise ArgumentError, "Array provided must contain between one and eight elements."
  end

  MIME::Type.new(args.shift) do |t|
    t.extensions, t.encoding, t.system, t.obsolete, t.docs, t.references,
      t.registered = *args
    yield t if block_given?
  end
end

.from_hash(hash) ⇒ Object

Creates a MIME::Type from a hash. Keys are case-insensitive, dashes may be replaced with underscores, and the internal Symbol of the lowercase-underscore version can be used as well. That is, Content-Type can be provided as content-type, Content_Type, content_type, or :content_type.

Known keys are Content-Type, Content-Transfer-Encoding, Extensions, and System.

MIME::Type.from_hash('Content-Type' => 'text/x-yaml',
                     'Content-Transfer-Encoding' => '8bit',
                     'System' => 'linux',
                     'Extensions' => ['yaml', 'yml'])

This is equivalent to:

MIME::Type.new('text/x-yaml') do |t|
  t.encoding    = '8bit'
  t.system      = 'linux'
  t.extensions  = ['yaml', 'yml']
end

This method has been deprecated.



622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/mime/type.rb', line 622

def from_hash(hash) # :yields MIME::Type.new:
  MIME.deprecated(self, __method__)
  type = {}
  hash.each_pair do |k, v|
    type[k.to_s.tr('A-Z', 'a-z').gsub(/-/, '_').to_sym] = v
  end

  MIME::Type.new(type[:content_type]) do |t|
    t.extensions  = type[:extensions]
    t.encoding    = type[:content_transfer_encoding]
    t.system      = type[:system]
    t.obsolete    = type[:obsolete]
    t.docs        = type[:docs]
    t.url         = type[:url]
    t.registered  = type[:registered]

    yield t if block_given?
  end
end

.from_mime_type(mime_type) ⇒ Object

Essentially a copy constructor.

MIME::Type.from_mime_type(plaintext)

is equivalent to:

MIME::Type.new(plaintext.content_type.dup) do |t|
  t.extensions  = plaintext.extensions.dup
  t.system      = plaintext.system.dup
  t.encoding    = plaintext.encoding.dup
end

This method has been deprecated.



655
656
657
658
 
# File 'lib/mime/type.rb', line 655

def from_mime_type(mime_type) # :yields the new MIME::Type:
  MIME.deprecated(self, __method__)
  new(mime_type)
end

.simplified(content_type) ⇒ Object

The MIME types main- and sub-label can both start with x-, which indicates that it is a non-registered name. Of course, after registration this flag can disappear, adds to the confusing proliferation of MIME types. The simplified string has the x- removed and are translated to lowercase.



553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/mime/type.rb', line 553

def simplified(content_type)
  matchdata = MEDIA_TYPE_RE.match(content_type)

  if matchdata.nil?
    nil
  else
    matchdata.captures.map { |e|
      e.downcase.gsub(UNREGISTERED_RE, '')
    }.join('/')
  end
end

Instance Method Details

#<=>(other) ⇒ Object

Compares the MIME::Type against the exact content type or the simplified type (the simplified type will be used if comparing against something that can be treated as a String with #to_s). In comparisons, this is done against the lowercase version of the MIME::Type.



135
136
137
138
139
140
141
 
# File 'lib/mime/type.rb', line 135

def <=>(other)
  if other.respond_to?(:content_type)
    @content_type.downcase <=> other.content_type.downcase
  elsif other.respond_to?(:to_s)
    @simplified <=> MIME::Type.simplified(other.to_s)
  end
end

#add_extensions(*ext) ⇒ Object

Merge the extensions provided into this MIME::Type. The extensions added will be merged uniquely.



232
233
234
 
# File 'lib/mime/type.rb', line 232

def add_extensions(*ext)
  self.extensions = self.extensions + ext
end

#ascii? ⇒ Boolean

MIME types can be specified to be sent across a network in particular formats. This method returns false when the MIME::Type encoding is set to base64.

Returns:

  • (Boolean) 


424
425
426
 
# File 'lib/mime/type.rb', line 424

def ascii?
  not binary?
end

#binary? ⇒ Boolean

MIME types can be specified to be sent across a network in particular formats. This method returns true when the MIME::Type encoding is set to base64.

Returns:

  • (Boolean) 


417
418
419
 
# File 'lib/mime/type.rb', line 417

def binary?
  BINARY_ENCODINGS.include?(@encoding)
end

#complete? ⇒ Boolean

Returns true if the MIME::Type specifies an extension list, indicating that it is a complete MIME::Type.

Returns:

  • (Boolean) 


456
457
458
 
# File 'lib/mime/type.rb', line 456

def complete?
  not @extensions.empty?
end

#default_encoding ⇒ Object

Returns the default encoding for the MIME::Type based on the media type.



274
275
276
 
# File 'lib/mime/type.rb', line 274

def default_encoding
  (@media_type == 'text') ? 'quoted-printable' : 'base64'
end

#encode_with(coder) ⇒ Object

:stopdoc:



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/mime/type.rb', line 512

def encode_with(coder)
  coder['content-type']   = @content_type
  coder['docs']           = @docs unless @docs.nil? or @docs.empty?
  coder['encoding']       = @encoding
  coder['extensions']     = @extensions unless @extensions.empty?
  if obsolete?
    coder['obsolete']     = obsolete?
    coder['use-instead']  = use_instead if use_instead
  end
  coder['references']     = references unless references.empty?
  coder['xrefs']          = xrefs unless xrefs.empty?
  coder['registered']     = registered?
  coder['signature']      = signature? if signature?
  coder['system']         = @system if @system
  coder
end

#eql?(other) ⇒ Boolean

Returns true if the other object is a MIME::Type and the content types match.

Returns:

  • (Boolean) 


184
185
186
 
# File 'lib/mime/type.rb', line 184

def eql?(other)
  other.kind_of?(MIME::Type) and self == other
end

#init_with(coder) ⇒ Object 



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/mime/type.rb', line 529

def init_with(coder)
  self.content_type = coder['content-type']
  self.docs         = coder['docs'] || []
  self.encoding     = coder['encoding']
  self.extensions   = coder['extensions'] || []
  self.obsolete     = coder['obsolete']
  # This value will be deprecated in the future, as it will be an
  # alternative view on #xrefs. Silence an unnecessary warning for now by
  # assigning directly to the instance variable.
  @references       = Array(coder['references']).flatten.compact.uniq
  self.registered   = coder['registered']
  self.signature    = coder['signature']
  self.system       = coder['system']
  self.xrefs        = coder['xrefs'] || {}
  self.use_instead  = coder['use-instead']
end

#like?(other) ⇒ Boolean

Returns true if the simplified type matches the current

Returns:

  • (Boolean) 


123
124
125
126
127
128
129
 
# File 'lib/mime/type.rb', line 123

def like?(other)
  if other.respond_to?(:simplified)
    @simplified == other.simplified
  else
    @simplified == MIME::Type.simplified(other)
  end
end

#obsolete=(v) ⇒ Object

:nodoc:



292
293
294
 
# File 'lib/mime/type.rb', line 292

def obsolete=(v) # :nodoc:
  @obsolete = !!v
end

#obsolete? ⇒ Boolean

Returns true if the media type is obsolete.

Returns:

  • (Boolean) 


289
290
291
 
# File 'lib/mime/type.rb', line 289

def obsolete?
  !!@obsolete
end

#platform?(__internal__ = false) ⇒ Boolean

Returns true if the MIME::Type is specific to the current operating system as represented by RUBY_PLATFORM.

This method is deprecated.

Returns:

  • (Boolean) 


449
450
451
452
 
# File 'lib/mime/type.rb', line 449

def platform?(__internal__ = false)
  MIME.deprecated(self, __method__) unless __internal__
  system?(__internal__) and (RUBY_PLATFORM =~ @system)
end

#priority_compare(other) ⇒ Object

Compares the MIME::Type based on how reliable it is before doing a normal <=> comparison. Used by MIME::Types#[] to sort types. The comparisons involved are:

  1. self.simplified <=> other.simplified (ensures that we don’t try to compare different types)

  2. IANA-registered definitions < other definitions.

  3. Generic definitions < platform definitions.

  4. Complete definitions < incomplete definitions.

  5. Current definitions < obsolete definitions.

  6. Obselete with use-instead references < obsolete without.

  7. Obsolete use-instead definitions are compared.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/mime/type.rb', line 155

def priority_compare(other)
  pc = simplified <=> other.simplified
  if pc.zero?
    pc = if ((reg = registered?) != other.registered?)
           reg ? -1 : 1 # registered < unregistered
         elsif ((plat = platform?(true)) != other.platform?(true))
           plat ? 1 : -1 # generic < platform
         elsif ((comp = complete?) != other.complete?)
           comp ? -1 : 1 # complete < incomplete
         elsif ((obs = obsolete?) != other.obsolete?)
           obs ? 1 : -1 # current < obsolete
         elsif obs and ((ui = use_instead) != (oui = other.use_instead))
           if ui.nil?
             1
           elsif oui.nil?
             -1
           else
             ui <=> oui
           end
         else
           0
         end
  end

  pc
end

#registered=(v) ⇒ Object

:nodoc:



410
411
412
 
# File 'lib/mime/type.rb', line 410

def registered=(v) # :nodoc:
  @registered = v.nil? ? v : !!v
end

#registered? ⇒ Boolean

Prior to BCP 178 (RFC 6648), it could be assumed that MIME content types that start with x- were unregistered MIME. Per this BCP, this assumption is no longer being made by default in this library.

There are three possible registration states for a MIME::Type:

  • Explicitly registered, like application/x-www-url-encoded.

  • Explicitly not registered, like image/webp.

  • Unspecified, in which case the media-type and the content-type will be scanned to see if they start with x-, indicating that they are assumed unregistered.

Returns:

  • (Boolean) 


402
403
404
405
406
407
408
409
 
# File 'lib/mime/type.rb', line 402

def registered?
  if @registered.nil?
    (@raw_media_type !~ UNREGISTERED_RE) and
      (@raw_sub_type !~ UNREGISTERED_RE)
  else
    !!@registered
  end
end

#signature=(v) ⇒ Object

:nodoc:



433
434
435
 
# File 'lib/mime/type.rb', line 433

def signature=(v) # :nodoc:
  @signature = !!v
end

#signature? ⇒ Boolean

Returns true when the simplified MIME::Type is in the list of known digital signatures.

Returns:

  • (Boolean) 


430
431
432
 
# File 'lib/mime/type.rb', line 430

def signature?
  !!@signature
end

#system ⇒ Object

If the MIME::Type is a system-specific MIME::Type, returns the regular expression for the operating system indicated.

This information about MIME content types is deprecated.



261
262
263
264
 
# File 'lib/mime/type.rb', line 261

def system
  MIME.deprecated(self, __method__)
  @system
end

#system=(os) ⇒ Object

:nodoc:



265
266
267
268
269
270
271
 
# File 'lib/mime/type.rb', line 265

def system=(os) # :nodoc:
  if os.nil? or os.kind_of?(Regexp)
    @system = os
  else
    @system = %r|#{os}|
  end
end

#system?(__internal__ = false) ⇒ Boolean

Returns true if the MIME::Type is specific to an operating system.

This method is deprecated.

Returns:

  • (Boolean) 


440
441
442
443
 
# File 'lib/mime/type.rb', line 440

def system?(__internal__ = false)
  MIME.deprecated(self, __method__) unless __internal__
  not @system.nil?
end

#to_a ⇒ Object

Returns the MIME::Type as an array suitable for use with MIME::Type.from_array.

This method is deprecated.



477
478
479
480
481
 
# File 'lib/mime/type.rb', line 477

def to_a
  MIME.deprecated(self, __method__)
  [ @content_type, @extensions, @encoding, @system, obsolete?, @docs,
    @references, registered? ]
end

#to_h ⇒ Object

Converts the MIME::Type to a hash suitable for use in JSON. The output of this method can also be used to initialize a MIME::Type.



507
508
509
 
# File 'lib/mime/type.rb', line 507

def to_h
  encode_with({})
end

#to_hash ⇒ Object

Returns the MIME::Type as an array suitable for use with MIME::Type.from_hash.

This method is deprecated.



487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/mime/type.rb', line 487

def to_hash
  MIME.deprecated(self, __method__)
  { 'Content-Type'              => @content_type,
    'Content-Transfer-Encoding' => @encoding,
    'Extensions'                => @extensions,
    'System'                    => @system,
    'Obsolete'                  => obsolete?,
    'Docs'                      => @docs,
    'URL'                       => @references,
    'Registered'                => registered?,
  }
end

#to_json(*args) ⇒ Object

Converts the MIME::Type to a JSON string.



501
502
503
 
# File 'lib/mime/type.rb', line 501

def to_json(*args)
  to_h.to_json(*args)
end

#to_s ⇒ Object

Returns the MIME::Type as a string.



461
462
463
 
# File 'lib/mime/type.rb', line 461

def to_s
  @content_type
end

#to_str ⇒ Object

Returns the MIME::Type as a string for implicit conversions. This allows MIME::Type objects to appear on either side of a comparison.

'text/plain' == MIME::Type.new('text/plain')



469
470
471
 
# File 'lib/mime/type.rb', line 469

def to_str
  @content_type
end

#url ⇒ Object

:nodoc:



309
310
311
312
 
# File 'lib/mime/type.rb', line 309

def url # :nodoc:
  MIME.deprecated(self, __method__, "and has been renamed to #references")
  references
end

#url=(r) ⇒ Object

:nodoc:



313
314
315
316
 
# File 'lib/mime/type.rb', line 313

def url=(r) # :nodoc:
  MIME.deprecated(self, __method__)
  self.references = r
end

#urls ⇒ Object

The decoded URL list for this MIME::Type.

The special URL value IANA will be translated into:

http://www.iana.org/assignments/media-types/<mediatype>/<subtype>

The special URL value RFC### will be translated into:

http://www.rfc-editor.org/rfc/rfc###.txt

The special URL value DRAFT:name will be translated into:

https://datatracker.ietf.org/public/idindex.cgi?
    command=id_detail&filename=<name>

The special URL value [token] will be translated into:

http://www.iana.org/assignments/contact-people.htm#<token>

These values will be accessible through #urls, which always returns an array.



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/mime/type.rb', line 343

def urls
  references.map do |el|
    case el
    when %r{^IANA$}
      IANA_URL % [ @media_type, @sub_type ]
    when %r{^RFC(\d+)$}
      RFC_URL % $1
    when %r{^DRAFT:(.+)$}
      DRAFT_URL % $1
    when %r{^\{([^=]+)=([^\}]+)\}}
      [$1, $2]
    when %r{^\[([^=]+)=([^\]]+)\]}
      [$1, CONTACT_URL % $2]
    when %r{^\[([^\]]+)\]}
      CONTACT_URL % $1
    else
      el
    end
  end
end

#xref_urls ⇒ Object

The decoded cross-reference URL list for this MIME::Type.



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/mime/type.rb', line 365

def xref_urls
  xrefs.map { |(type, values)|
    case type
    when 'rfc'
      values.map { |data| "http://www.iana.org/go/#{data}" }
    when 'draft'
      values.map { |data|
        "http://www.iana.org/go/#{data.sub(/\ARFC/, 'draft')}"
      }
    when 'rfc-errata'
      values.map { |data|
        "http://www.rfc-editor.org/errata_search.php?eid=#{data}"
      }
    when 'person'
      values.map { |data|
        "http://www.iana.org/assignments/media-types/media-types.xhtml##{data}"
      }
    when 'template'
      values.map { |data|
        "http://www.iana.org/assignments/media-types/#{data}"
      }
    when 'uri', 'text'
      values
    end
  }.flatten
end