Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc fixes #153

Merged
merged 3 commits into from
Jan 17, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 49 additions & 15 deletions lib/mime/type.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,60 @@ module MIME
# == Usage
# require 'mime/types'
#
# plaintext = MIME::Types['text/plain'].first
# # returns [text/plain, text/plain]
# plaintext = MIME::Types['text/plain'] # => [ text/plain ]
# text = plaintext.first
# print text.media_type # => 'text'
# print text.sub_type # => 'plain'
# puts text.media_type # => 'text'
# puts text.sub_type # => 'plain'
#
# puts text.extensions.join(" ") # => 'asc txt c cc h hh cpp'
# puts text.extensions.join(' ') # => 'txt asc c cc h hh cpp hpp dat hlp'
# puts text.preferred_extension # => 'txt'
# puts text.friendly # => 'Text Document'
# puts text.i18n_key # => 'text.plain'
#
# puts text.encoding # => 8bit
# puts text.encoding # => quoted-printable
# puts text.default_encoding # => quoted-printable
# puts text.binary? # => false
# puts text.ascii? # => true
# puts text.obsolete? # => false
# puts text.registered? # => true
# puts text.complete? # => true
#
# puts text # => 'text/plain'
#
# puts text == 'text/plain' # => true
# puts MIME::Type.simplified('x-appl/x-zip') # => 'appl/zip'
# puts 'text/plain' == text # => true
# puts text == 'text/x-plain' # => false
# puts 'text/x-plain' == text # => false
#
# puts MIME::Type.simplified('x-appl/x-zip') # => 'x-appl/x-zip'
# puts MIME::Type.i18n_key('x-appl/x-zip') # => 'x-appl.x-zip'
#
# puts text.like?('text/x-plain') # => true
# puts text.like?(MIME::Type.new('x-text/x-plain')) # => true
#
# puts text.xrefs.inspect # => { "rfc" => [ "rfc2046", "rfc3676", "rfc5147" ] }
# puts text.xref_urls # => [ "http://www.iana.org/go/rfc2046",
# # "http://www.iana.org/go/rfc3676",
# # "http://www.iana.org/go/rfc5147" ]
#
# xtext = MIME::Type.new('x-text/x-plain')
# puts xtext.media_type # => 'text'
# puts xtext.raw_media_type # => 'x-text'
# puts xtext.sub_type # => 'plain'
# puts xtext.raw_sub_type # => 'x-plain'
# puts xtext.complete? # => false
#
# puts MIME::Types.any? { |type| type.content_type == 'text/plain' } # => true
# puts MIME::Types.all?(&:registered?) # => false
#
# # Various string representations of MIME types
# qcelp = MIME::Types['audio/QCELP'].first # => audio/QCELP
# puts qcelp.content_type # => 'audio/QCELP'
# puts qcelp.simplified # => 'audio/qcelp'
#
# puts MIME::Types.any? { |type|
# type.content_type == 'text/plain'
# } # => true
# puts MIME::Types.all?(&:registered?)
# # => false
# xwingz = MIME::Types['application/x-Wingz'].first # => application/x-Wingz
# puts xwingz.content_type # => 'application/x-Wingz'
# puts xwingz.simplified # => 'application/x-wingz'
class MIME::Type
# Reflects a MIME content-type specification that is not correctly
# formatted (it isn't +type+/+subtype+).
Expand Down Expand Up @@ -74,7 +109,7 @@ def to_s
:ASCII_ENCODINGS

# Builds a MIME::Type object from the +content_type+, a MIME Content Type
# value (e.g., 'text/plain' or 'applicaton/x-eruby'). The constructed object
# value (e.g., 'text/plain' or 'application/x-eruby'). The constructed object
# is yielded to an optional block for additional configuration, such as
# associating extensions and encoding information.
#
Expand Down Expand Up @@ -197,8 +232,7 @@ def eql?(other)
# audio/QCELP => audio/QCELP
attr_reader :content_type
# A simplified form of the MIME content-type string, suitable for
# case-insensitive comparison, with any extension markers (<tt>x-</tt)
# removed and converted to lowercase.
# case-insensitive comparison, with the content_type converted to lowercase.
#
# text/plain => text/plain
# x-chemical/x-pdb => x-chemical/x-pdb
Expand Down