Class: MIME::Types
- Inherits:
-
Object
- Object
- MIME::Types
- Defined in:
- lib/s33r/mimetypes.rb
Overview
MIME::Types
MIME types are used in MIME-compliant communications, as in e-mail or HTTP traffic, to indicate the type of content which is transmitted. MIME::Types provides the ability for detailed information about MIME entities (provided as a set of MIME::Type objects) to be determined and used programmatically. There are many types defined by RFCs and vendors, so the list is long but not complete; don’t hesitate to ask to add additional information. This library follows the IANA collection of MIME types (see below for reference).
Description
MIME types are used in MIME entities, as in email or HTTP traffic. It is useful at times to have information available about MIME types (or, inversely, about files). A MIME::Type stores the known information about one MIME type.
Usage
require 'mime/types'
plaintext = MIME::Types['text/plain']
print plaintext.media_type # => 'text'
print plaintext.sub_type # => 'plain'
puts plaintext.extensions.join(" ") # => 'asc txt c cc h hh cpp'
puts plaintext.encoding # => 8bit
puts plaintext.binary? # => false
puts plaintext.ascii? # => true
puts plaintext.obsolete? # => false
puts plaintext.registered? # => true
puts plaintext == 'text/plain' # => true
puts MIME::Type.simplified('x-appl/x-zip') # => 'appl/zip'
This module is built to conform to the MIME types of RFCs 2045 and 2231. It follows the official IANA registry at www.iana.org/assignments/media-types/ and ftp.iana.org/assignments/media-types with some unofficial types added from the the collection at www.ltsw.se/knbase/internet/mime.htp
This is originally based on Perl MIME::Types by Mark Overmeer.
Author
- Copyright
-
Copyright © 2002 - 2006 by Austin Ziegler <[email protected]>
- Version
-
1.15
- Based On
-
Perl MIME::Types, Copyright © 2001 - 2005 by Mark Overmeer <[email protected]>.
- Licence
-
Ruby’s, Perl Artistic, or GPL version 2 (or later)
- See Also
-
www.iana.org/assignments/media-types/ www.ltsw.se/knbase/internet/mime.htp
Constant Summary collapse
- VERSION =
The released version of Ruby MIME::Types
'1.15'
Instance Attribute Summary collapse
-
#data_version ⇒ Object
readonly
The data version.
Class Method Summary collapse
-
.[](type_id, flags = {}) ⇒ Object
Returns a list of MIME::Type objects, which may be empty.
-
.add(*types) ⇒ Object
Add one or more MIME::Type objects to the set of known types.
-
.add_type_variant(mime_type) ⇒ Object
:nodoc:.
-
.index_extensions(mime_type) ⇒ Object
:nodoc:.
-
.of(filename, platform = false) ⇒ Object
A synonym for MIME::Types.type_for.
-
.type_for(filename, platform = false) ⇒ Object
Return the list of MIME::Types which belongs to the file based on its filename extension.
Instance Method Summary collapse
-
#[](type_id, flags = {}) ⇒ Object
Returns a list of MIME::Type objects, which may be empty.
-
#add(*types) ⇒ Object
Add one or more MIME::Type objects to the set of known types.
-
#add_type_variant(mime_type) ⇒ Object
:nodoc:.
-
#index_extensions(mime_type) ⇒ Object
:nodoc:.
-
#initialize(data_version = nil) ⇒ Types
constructor
A new instance of Types.
-
#of(filename, platform = false) ⇒ Object
A synonym for MIME::Types.type_for.
-
#type_for(filename, platform = false) ⇒ Object
Return the list of MIME::Types which belongs to the file based on its filename extension.
Constructor Details
#initialize(data_version = nil) ⇒ Types
Returns a new instance of Types.
533 534 535 536 |
# File 'lib/s33r/mimetypes.rb', line 533 def initialize(data_version = nil) @type_variants = Hash.new { |h, k| h[k] = [] } @extension_index = Hash.new { |h, k| h[k] = [] } end |
Instance Attribute Details
#data_version ⇒ Object (readonly)
The data version.
531 532 533 |
# File 'lib/s33r/mimetypes.rb', line 531 def data_version @data_version end |
Class Method Details
.[](type_id, flags = {}) ⇒ Object
Returns a list of MIME::Type objects, which may be empty. The optional flag parameters are :complete (finds only complete MIME::Type objects) and :platform (finds only MIME::Types for the current platform). It is possible for multiple matches to be returned for either type (in the example below, ‘text/plain’ returns two values – one for the general case, and one for VMS systems.
puts "\nMIME::Types['text/plain']"
MIME::Types['text/plain'].each { |t| puts t.to_a.join(", ") }
puts "\nMIME::Types[/^image/, :complete => true]"
MIME::Types[/^image/, :complete => true].each do |t|
puts t.to_a.join(", ")
end
641 642 643 |
# File 'lib/s33r/mimetypes.rb', line 641 def [](type_id, flags = {}) @__types__[type_id, flags] end |
.add(*types) ⇒ Object
Add one or more MIME::Type objects to the set of known types. Each type should be experimental (e.g., ‘application/x-ruby’). If the type is already known, a warning will be displayed.
Please inform the maintainer of this module when registered types are missing.
668 669 670 |
# File 'lib/s33r/mimetypes.rb', line 668 def add(*types) @__types__.add(*types) end |
.add_type_variant(mime_type) ⇒ Object
:nodoc:
619 620 621 |
# File 'lib/s33r/mimetypes.rb', line 619 def add_type_variant(mime_type) #:nodoc: @__types__.add_type_variant(mime_type) end |
.index_extensions(mime_type) ⇒ Object
:nodoc:
623 624 625 |
# File 'lib/s33r/mimetypes.rb', line 623 def index_extensions(mime_type) #:nodoc: @__types__.index_extensions(mime_type) end |
.of(filename, platform = false) ⇒ Object
A synonym for MIME::Types.type_for
658 659 660 |
# File 'lib/s33r/mimetypes.rb', line 658 def of(filename, platform = false) @__types__.type_for(filename, platform) end |
.type_for(filename, platform = false) ⇒ Object
Return the list of MIME::Types which belongs to the file based on its filename extension. If platform
is true
, then only file types that are specific to the current platform will be returned.
puts "MIME::Types.type_for('citydesk.xml')
=> "#{MIME::Types.type_for('citydesk.xml')}"
puts "MIME::Types.type_for('citydesk.gif')
=> "#{MIME::Types.type_for('citydesk.gif')}"
653 654 655 |
# File 'lib/s33r/mimetypes.rb', line 653 def type_for(filename, platform = false) @__types__.type_for(filename, platform) end |
Instance Method Details
#[](type_id, flags = {}) ⇒ Object
Returns a list of MIME::Type objects, which may be empty. The optional flag parameters are :complete (finds only complete MIME::Type objects) and :platform (finds only MIME::Types for the current platform). It is possible for multiple matches to be returned for either type (in the example below, ‘text/plain’ returns two values – one for the general case, and one for VMS systems.
puts "\nMIME::Types['text/plain']"
MIME::Types['text/plain'].each { |t| puts t.to_a.join(", ") }
puts "\nMIME::Types[/^image/, :complete => true]"
MIME::Types[/^image/, :complete => true].each do |t|
puts t.to_a.join(", ")
end
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 |
# File 'lib/s33r/mimetypes.rb', line 562 def [](type_id, flags = {}) if type_id.kind_of?(Regexp) matches = [] @type_variants.each_key do |k| matches << @type_variants[k] if k =~ type_id end matches.flatten! elsif type_id.kind_of?(MIME::Type) matches = [type_id] else matches = @type_variants[MIME::Type.simplified(type_id)] end matches.delete_if { |e| not e.complete? } if flags[:complete] matches.delete_if { |e| not e.platform? } if flags[:platform] matches end |
#add(*types) ⇒ Object
Add one or more MIME::Type objects to the set of known types. Each type should be experimental (e.g., ‘application/x-ruby’). If the type is already known, a warning will be displayed.
Please inform the maintainer of this module when registered types are missing.
606 607 608 609 610 611 612 613 614 615 616 |
# File 'lib/s33r/mimetypes.rb', line 606 def add(*types) types.each do |mime_type| if @type_variants.include?(mime_type.simplified) if @type_variants[mime_type.simplified].include?(mime_type) warn "Type #{mime_type} already registered as a variant of #{mime_type.simplified}." end end add_type_variant(mime_type) index_extensions(mime_type) end end |
#add_type_variant(mime_type) ⇒ Object
:nodoc:
538 539 540 |
# File 'lib/s33r/mimetypes.rb', line 538 def add_type_variant(mime_type) #:nodoc: @type_variants[mime_type.simplified] << mime_type end |
#index_extensions(mime_type) ⇒ Object
:nodoc:
542 543 544 |
# File 'lib/s33r/mimetypes.rb', line 542 def index_extensions(mime_type) #:nodoc: mime_type.extensions.each { |ext| @extension_index[ext] << mime_type } end |
#of(filename, platform = false) ⇒ Object
A synonym for MIME::Types.type_for
596 597 598 |
# File 'lib/s33r/mimetypes.rb', line 596 def of(filename, platform = false) type_for(filename, platform) end |
#type_for(filename, platform = false) ⇒ Object
Return the list of MIME::Types which belongs to the file based on its filename extension. If platform
is true
, then only file types that are specific to the current platform will be returned.
puts "MIME::Types.type_for('citydesk.xml')
=> "#{MIME::Types.type_for('citydesk.xml')}"
puts "MIME::Types.type_for('citydesk.gif')
=> "#{MIME::Types.type_for('citydesk.gif')}"
588 589 590 591 592 593 |
# File 'lib/s33r/mimetypes.rb', line 588 def type_for(filename, platform = false) ext = filename.chomp.downcase.gsub(/.*\./o, '') list = @extension_index[ext] list.delete_if { |e| not e.platform? } if platform list end |