mime-types 2.4.1 → 2.4.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmFiNDllMzJlODVmMWE0YzI4NzM2YWZkNmU0NWE2YzZkODA0ZTI3NA==
+    MWViMWFhNWYxYmU3ZjM1NmE4ODUwNzM4ZjFlNDU1NjY0MTJhODBjMA==
   data.tar.gz: !binary |-
-    NDY0NGU1OThlMmQwMjI2ODgzMTQzMTJiOTRmODgwYzcwMTE2NWY3Mg==
+    YmNmY2UyMDhkYjk0ZmE2NTE0MjI2ZWMxNjJmYzY4YjgwZTRkY2E5ZA==
 SHA512:
   metadata.gz: !binary |-
-    MTEyNzQ2MDExMmUzZDk1YWMyZDMyMTUzMWIxYjYyZTRkZDM0M2U4NGM1NmFi
-    M2EzNTlhNzY1MzY3NDVlYmI2YjY0YjhkYzU2N2I4YTU5NDBhZjlhMTY0YTkz
-    YzIzNTYxMWYyMmZhYjk0Y2RkZjBkOTVhMGI5MzVlNjMxMjdiYjQ=
+    NTExNDY1MzFlNmFhMDU5NWQxMTEzZTY2YzE2ZWNlMjkzY2VmNzZmZjI3NGQ4
+    YmRmNjQ3NzY0YzA0ODhmNzEzZTc2N2E4NDg5NWI2NjczNjQ0Nzg3NDY4Njkz
+    OTlhNGVkNzBlYzcyZGU0MWVjNTk0NjMzNjhiOGRhZGI3YWZiY2I=
   data.tar.gz: !binary |-
-    NGRjNGMwYmVjZDU2Zjg5ZjU5M2VjNGYxNTIyMDUzNWNjMWRjMGFlZmFkMjRl
-    ODM1NGUwMmQ1MDliYmQ2MjYyMDdmZTVhY2RhMjQyY2RlYWNhNDE2MmZkMzRk
-    NTZiYjM1NmVjZWQ5M2U5ZTk4ZjM0MjIyMWZkNjg5OWIxMDBiZjQ=
+    YTZiMDRlYzljMDk4MDRjZTA0MGJhMWFhMTU1YWIyNTQ1MDc4YTkzOTVkYjg4
+    MGVhYTZlODU2MDEzOTBiOTc0ZTIxYzhiMmQ1MDhjNGUwNWQ5ZTA0NDY1YThj
+    MWYzYTBiNTk4NDQzMzFjNjk3MzMwM2Q0MTUwNzVkM2YyNDY5Yjk=

data/Contributing.rdoc

@@ -109,3 +109,5 @@ Thanks to everyone else who has contributed to mime-types:
 * Greg Brockman
 * Łukasz Śliwa (for the friendly names)
 * Keerthi Siva
+* Aaron Patterson
+* Godfrey Chan

data/History-Types.rdoc

@@ -1,6 +1,11 @@
 = MIME Types Changes by Version
 
-== 2.4 / 2014-10-07
+== 2.4.2 / 2014-10-15
+* Added application/vnd.ms-outlook as an unregistered MIME type with the
+  extension +msg+. Provided by @keerthisiv in
+  {#72}[https://github.com/halostatue/mime-types/pull/72].
+
+== 2.4.1 / 2014-10-07
 
 * Changed the sort order of many of the extensions to restore behaviour
   from mime-types 1.25.1.

data/History.rdoc

@@ -1,4 +1,18 @@
-== 2.4 / 2014-10-07
+== 2.4.2 / 2014-10-15
+
+* Bugs:
+  * Aaron Patterson (@tenderlove) found a loading bug and provided a fix that
+    nearly doubled registry load performance
+    ({#74}[https://github.com/halostatue/mime-types/pull/74]).
+  * Godfrey Chan (@chancancode) provided a prophylactic security fix to use
+    <tt>JSON.parse</tt> instead of <tt>JSON.load</tt> in
+    {#75}[https://github.com/halostatue/mime-types/pull/75]. This provides a
+    20% improvement over the already improved result, resulting in a total 55%
+    performance boost.
+
+== 2.4.1 / 2014-10-07
+
+mime-types 2.4 was pulled.
 
 * Bugs:
   * Restored the extension sort order from mime-types 1.25.1 and modified

data/README.rdoc

@@ -24,8 +24,12 @@ add additional type definitions (see Contributing.rdoc). The primary sources
 for MIME type definitions found in mime-types is the IANA collection of
 registrations (see below for the link), RFCs, and W3C recommendations.
 
-This is release 2.4.1 (2.4 was pulled), fixing a bug in observed use of the
-mime-types library where extensions were not previously sorted, such that
+This is release 2.4.2, fixing bugs with unnecessary object duplication and
+using JSON.parse instead of JSON.load. These fixes improve the JSON registry
+loading time by about 55% over previous 2.x releases. Cached registry load
+times are not changed. This release builds on the 2.4.1 release, which fixed a
+bug in observed use of the mime-types library where extensions were not
+previously sorted, such that
 
     MIME::Types.of('image.jpg').first.extensions.first
 

data/Rakefile

@@ -109,6 +109,24 @@ namespace :mime do
 end
 
 namespace :convert do
+  namespace :docs do
+    task :setup do
+      gem 'rdoc'
+      require 'rdoc/rdoc'
+      @doc_converter ||= RDoc::Markup::ToMarkdown.new
+    end
+
+    %w(README History History-Types).each do |name|
+      file "#{name}.md" => [ "#{name}.rdoc", :setup ] do |t|
+        File.open(t.name, 'wb') { |target|
+          target.write @doc_converter.convert(IO.read(t.prerequisites.first))
+        }
+      end
+
+      task docs: [ name ]
+    end
+  end
+
   namespace :yaml do
     desc "Convert from YAML to JSON"
     task :json, [ :source, :destination, :multiple_files ] => :support do |t, args|

data/lib/mime/type.rb

@@ -50,18 +50,16 @@ class MIME::Type
     end
 
     def to_s
-      "Invalid Encoding #{@encoding.inspect} (valid values are " +
-        "#{MIME::Type::VALID_ENCODINGS.inspect})."
+      "Invalid Encoding #{@encoding.inspect} (valid values: #{VALID_ENCODINGS.inspect})."
     end
     # :startdoc:
   end
 
   # The released version of the mime-types library.
-  VERSION = '2.4.1'
+  VERSION = '2.4.2'
 
   include Comparable
 
-  # :stopdoc:
   MEDIA_TYPE_RE     = %r{([-\w.+]+)/([-\w.+]*)}o
   UNREGISTERED_RE   = %r{[Xx]-}o
   I18N_RE           = %r{[^[:alnum:]]}o
@@ -76,7 +74,9 @@ class MIME::Type
   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"
-  # :startdoc:
+  private_constant :MEDIA_TYPE_RE, :UNREGISTERED_RE, :I18N_RE, :PLATFORM_RE,
+    :DEFAULT_ENCODINGS, :BINARY_ENCODINGS, :TEXT_ENCODINGS, :VALID_ENCODINGS,
+    :IANA_URL, :RFC_URL, :DRAFT_URL, :CONTACT_URL
 
   # Builds a MIME::Type object from the provided MIME Content Type value
   # (e.g., 'text/plain' or 'applicaton/x-eruby'). The constructed object is
@@ -157,13 +157,13 @@ class MIME::Type
   def priority_compare(other)
     pc = simplified <=> other.simplified
     if pc.zero?
-      pc = if ((reg = registered?) != other.registered?)
+      pc = if (reg = registered?) != other.registered?
              reg ? -1 : 1 # registered < unregistered
-           elsif ((plat = platform?(true)) != other.platform?(true))
+           elsif (plat = platform?(true)) != other.platform?(true)
              plat ? 1 : -1 # generic < platform
-           elsif ((comp = complete?) != other.complete?)
+           elsif (comp = complete?) != other.complete?
              comp ? -1 : 1 # complete < incomplete
-           elsif ((obs = obsolete?) != other.obsolete?)
+           elsif (obs = obsolete?) != other.obsolete?
              obs ? 1 : -1 # current < obsolete
            elsif obs and ((ui = use_instead) != (oui = other.use_instead))
              if ui.nil?
@@ -275,6 +275,7 @@ class MIME::Type
     MIME.deprecated(self, __method__)
     @system
   end
+
   def system=(os) # :nodoc:
     if os.nil? or os.kind_of?(Regexp)
       @system = os
@@ -302,6 +303,7 @@ class MIME::Type
   def obsolete?
     !!@obsolete
   end
+
   def obsolete=(v) # :nodoc:
     @obsolete = !!v
   end
@@ -324,6 +326,8 @@ class MIME::Type
       @friendly.merge!(Hash[*lang])
     when Hash
       @friendly.merge!(lang)
+    else
+      raise ArgumentError
     end
   end
 
@@ -352,6 +356,7 @@ class MIME::Type
     MIME.deprecated(self, __method__, "and has been renamed to #references")
     references
   end
+
   def url=(r) # :nodoc:
     MIME.deprecated(self, __method__)
     self.references = r
@@ -425,7 +430,7 @@ class MIME::Type
         values.map { |data|
           "http://www.iana.org/assignments/media-types/#{data}"
         }
-      when 'uri', 'text'
+      else # 'uri', 'text', etc.
         values
       end
     }.flatten
@@ -449,6 +454,7 @@ class MIME::Type
       !!@registered
     end
   end
+
   def registered=(v) # :nodoc:
     @registered = v.nil? ? v : !!v
   end
@@ -472,6 +478,7 @@ class MIME::Type
   def signature?
     !!@signature
   end
+
   def signature=(v) # :nodoc:
     @signature = !!v
   end
@@ -550,7 +557,9 @@ class MIME::Type
     encode_with({})
   end
 
-  # :stopdoc:
+  # Populates the +coder+ with attributes about this record for
+  # serialization. The structure of +coder+ should match the structure used
+  # with #init_with.
   def encode_with(coder)
     coder['content-type']   = @content_type
     coder['docs']           = @docs unless @docs.nil? or @docs.empty?
@@ -569,6 +578,8 @@ class MIME::Type
     coder
   end
 
+  # Initialize an empty object from +coder+, which must contain the
+  # attributes necessary for initializing an empty object.
   def init_with(coder)
     self.content_type = coder['content-type']
     self.docs         = coder['docs'] || []

data/lib/mime/types/loader.rb

@@ -56,9 +56,7 @@ class MIME::Types::Loader
   # This method is aliased to #load.
   def load_json
     Dir[json_path].sort.each do |f|
-      types = self.class.load_from_json(f).map { |type|
-        MIME::Type.new(type)
-      }
+      types = self.class.load_from_json(f)
       container.add(*types, :silent)
     end
     container
@@ -79,6 +77,7 @@ class MIME::Types::Loader
     container
   end
 
+  # Raised when a V1 format file is discovered.
   BadV1Format = Class.new(Exception)
 
   class << self
@@ -131,7 +130,7 @@ class MIME::Types::Loader
         item = line.chomp.strip
         next if item.empty?
 
-        m = MIME::Types::Loader::V1_FORMAT.match(item)
+        m = V1_FORMAT.match(item)
 
         unless m
           warn <<-EOS
@@ -142,7 +141,7 @@ class MIME::Types::Loader
         end
 
         unregistered, obsolete, platform, mediatype, subtype, extensions,
-          encoding, urls, docs, comment = *m.captures
+          encoding, urls, docs, _ = *m.captures
 
         next if mediatype.nil?
 
@@ -198,7 +197,7 @@ class MIME::Types::Loader
     # shipped with the mime-types library.
     def load_from_json(filename)
       require 'json'
-      JSON.load(read_file(filename)).map { |type| MIME::Type.new(type) }
+      JSON.parse(read_file(filename)).map { |type| MIME::Type.new(type) }
     end
 
     private
@@ -222,18 +221,19 @@ class MIME::Types::Loader
 
   # The regular expression used to match a v1-format file-based MIME type
   # definition.
-  MIME::Types::Loader::V1_FORMAT = # :nodoc:
+  V1_FORMAT = # :nodoc:
     %r{\A\s*
-    ([*])?                                 # 0: Unregistered?
-    (!)?                                   # 1: Obsolete?
-    (?:(\w+):)?                            # 2: Platform marker
-    #{MIME::Type::MEDIA_TYPE_RE}?          # 3,4: Media type
-    (?:\s+@(\S+))?                         # 5: Extensions
-    (?:\s+:(base64|7bit|8bit|quoted\-printable))?  # 6: Encoding
-    (?:\s+'(\S+))?                         # 7: URL list
-    (?:\s+=(.+))?                          # 8: Documentation
-    (?:\s*([#].*)?)?
+    ([*])?                                        # 0:    Unregistered?
+    (!)?                                          # 1:    Obsolete?
+    (?:(\w+):)?                                   # 2:    Platform marker
+    ([-\w.+]+)/([-\w.+]*)                         # 3, 4: Media Type
+    (?:\s+@(\S+))?                                # 5:    Extensions
+    (?:\s+:(base64|7bit|8bit|quoted\-printable))? # 6:    Encoding
+    (?:\s+'(\S+))?                                # 7:    URL list
+    (?:\s+=(.+))?                                 # 8:    Documentation
+    (?:\s*([#].*)?)?                              #       Comments
     \s*
     \z
     }x
+  private_constant :V1_FORMAT
 end

data/support/convert.rb

@@ -75,8 +75,6 @@ class Convert
       raise ArgumentError, ':from is required'
     end
 
-    path = options[:path]
-
     @loader = MIME::Types::Loader.new(options[:path])
     load_from(options[:from])
   end

data/support/iana_registry.rb

@@ -52,62 +52,8 @@ class IANARegistry
 
   def parse
     @registry.css('record').each do |record|
-      subtype = record.at_css('name').text
-      refs    = record.css('xref').map do |xref|
-        case xref["type"]
-        when 'person'
-          "[#{xref["data"]}]"
-        when 'rfc'
-          xref["data"].upcase
-        when 'draft'
-          "DRAFT:#{xref["data"].sub(/^RFC-/, 'draft-')}"
-        when 'rfc-errata'
-          "{RFC Errata #{xref["data"]}=http://www.rfc-editor.org/errata_search.php?eid=#{xref["data"]}}"
-        when 'uri'
-          # Fix a couple of known-broken links:
-          case xref["data"]
-          when /contact-people.htmll#Dolan\z/
-            "[Dolan]"
-          when /contact-people.htmll#Rottmann?\z/
-            "[Frank_Rottman]"
-          else
-            "{#{xref["data"]}}"
-          end
-        when 'text'
-          xref["data"]
-        end
-      end
-
-      xrefs   = MIME::Types::Container.new
-      record.css('xref').map do |xref|
-        type, data = xref["type"], xref["data"]
-
-        case type
-        when 'uri'
-          case data
-          when /contact-people.htmll#Dolan\z/
-            type, data = "person", "Dolan"
-          when /contact-people.htmll#Rottmann?\z/
-            type, data = "person", "Frank_Rottman"
-          end
-        end
-
-        xrefs[type] << data
-      end
-
-      record.css('file').each do |file|
-        file_name = if file.text == subtype
-                      [ @type, subtype ].join('/')
-                    else
-                      file.text
-                    end
-
-        if file["type"] == "template"
-          refs << (ASSIGNMENT_FILE_REF % [ file_name, file_name ])
-        end
-
-        xrefs[file["type"]] << file_name
-      end
+      subtype       = record.at_css('name').text
+      refs, xrefs   = parse_refs_and_files(record.css('xref'), record.css('file'))
 
       content_type  = [ @type, subtype ].join('/')
       obsolete      = record.at_css('obsolete')
@@ -151,4 +97,62 @@ class IANARegistry
       MIME::Types.new
     end
   end
+
+  def parse_refs_and_files(refs, files)
+    xr = MIME::Types::Container.new
+    r  = []
+
+    refs.each do |xref|
+      type, data = xref["type"], xref["data"]
+
+      # Fix some known-broken links that are actually people.
+      if type == 'uri'
+        case data
+        when /contact-people.htmll#Dolan\z/
+          type, data = "person", "Dolan"
+        when /contact-people.htmll#Rottmann?\z/
+          type, data = "person", "Frank_Rottman"
+        else
+          nil # There’s no error with this URI.
+        end
+      end
+
+      r << xref_to_ref(type, data)
+
+      xrefs[type] << data
+    end
+
+    files.each do |file|
+      file_name = if file.text == subtype
+                    [ @type, subtype ].join('/')
+                  else
+                    file.text
+                  end
+
+      if file["type"] == "template"
+        refs << (ASSIGNMENT_FILE_REF % [ file_name, file_name ])
+      end
+
+      xrefs[file["type"]] << file_name
+    end
+
+    r, xr
+  end
+
+  def ref_from_type(type, data)
+    case type
+    when 'person'
+      "[#{data}]"
+    when 'rfc'
+      data.upcase
+    when 'draft'
+      "DRAFT:#{data.sub(/^RFC-/, 'draft-')}"
+    when 'rfc-errata'
+      "{RFC Errata #{data}=http://www.rfc-editor.org/errata_search.php?eid=#{data}}"
+    when 'uri'
+      "{#{data}}"
+    else # 'text' or something else
+      data
+    end
+  end
 end

data/test/test_mime_type.rb

@@ -101,7 +101,7 @@ class TestMIMEType < Minitest::Test
     assert_nil(MIME::Type.i18n_key('text'))
   end
 
-  def test_CMP # '<=>'
+  def test_spaceship_compare # '<=>'
     assert(MIME::Type.new('text/plain') == MIME::Type.new('text/plain'))
     assert(MIME::Type.new('text/plain') != MIME::Type.new('image/jpeg'))
     assert(MIME::Type.new('text/plain') == 'text/plain')
@@ -167,11 +167,9 @@ class TestMIMEType < Minitest::Test
     assert_equal('base64', yaml.encoding)
     yaml.encoding = :default
     assert_equal('quoted-printable', yaml.encoding)
-    begin
+    assert_raises(MIME::Type::InvalidEncoding) {
       yaml.encoding = 'binary'
-    rescue MIME::Type::InvalidEncoding => ex
-      assert_equal('Invalid Encoding "binary" (valid values are [nil, :default, "base64", "8bit", "7bit", "quoted-printable"]).', ex.message)
-    end
+    }
   end
 
   def test_default_encoding
@@ -417,15 +415,18 @@ class TestMIMEType < Minitest::Test
   def test_to_hash
     yaml = make_yaml_mime_type
     assert_deprecated("MIME::Type#to_hash") do
-      assert_equal({'Content-Type'              => 'text/x-yaml',
-                    'Content-Transfer-Encoding' => '8bit',
-                    'Extensions'                => %w(yaml yml),
-                    'System'                    => /d9d172f608/,
-                    'Registered'                => false,
-                    'URL'                       => [],
-                    'Obsolete'                  => false,
-                    'Docs'                      => nil },
-                    yaml.to_hash)
+      assert_equal(
+        {
+          'Content-Type'              => 'text/x-yaml',
+          'Content-Transfer-Encoding' => '8bit',
+          'Extensions'                => %w(yaml yml),
+          'System'                    => /d9d172f608/,
+          'Registered'                => false,
+          'URL'                       => [],
+          'Obsolete'                  => false,
+          'Docs'                      => nil
+        },
+        yaml.to_hash)
     end
   end
 

data/test/test_mime_types.rb

@@ -15,7 +15,7 @@ class TestMIMETypes < Minitest::Test
   end
 
   def test_enumerable
-    assert(@mime_types.any? {|type| type.content_type == 'text/plain'})
+    assert(@mime_types.any? { |type| type.content_type == 'text/plain' })
     assert_kind_of(Enumerator, @mime_types.each)
     assert_equal(6, @mime_types.each.count)
   end
@@ -56,6 +56,7 @@ class TestMIMETypes < Minitest::Test
       assert_empty(MIME::Types['text/plain', platform: true])
     end
   end
+
   def test_add
     eruby = MIME::Type.new("application/x-eruby") do |t|
       t.extensions = "rhtml"

data/test/test_mime_types_class.rb

@@ -9,7 +9,7 @@ class TestMIMETypesQueryClassMethods < Minitest::Test
   end
 
   def test_enumerable
-    assert(MIME::Types.any? {|type| type.content_type == 'text/plain'})
+    assert(MIME::Types.any? { |type| type.content_type == 'text/plain' })
     assert_kind_of(Enumerator, MIME::Types.each)
     assert(MIME::Types.each.count > 999)
   end

data/test/test_mime_types_loader.rb

@@ -18,7 +18,7 @@ class TestMIMETypesLoader < Minitest::Test
     assert_equal(%w(webm), types['audio/webm'].first.extensions)
     refute(types['audio/webm'].first.registered?)
 
-    assert_equal("Fixes a bug with IE6 and progressive JPEGs",
+    assert_equal('Fixes a bug with IE6 and progressive JPEGs',
                  types['image/pjpeg'].first.docs)
 
     assert(types['application/x-apple-diskimage'].first.system?)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mime-types
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.2
 platform: ruby
 authors:
 - Austin Ziegler
@@ -36,7 +36,7 @@ cert_chain:
   SHkzay9FVEZoaSs3cElVV2xGbzBpbXJkeUxoZCtKdzNib1ZqM0NtdnloY3dt
   cG9NMEs5bApBT21yVWlFbFVxTE9aQT09Ci0tLS0tRU5EIENFUlRJRklDQVRF
   LS0tLS0K
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -203,8 +203,11 @@ description: ! "The mime-types library provides a library and registry for infor
   incomplete; don't hesitate to to\nadd additional type definitions (see Contributing.rdoc).
   The primary sources\nfor MIME type definitions found in mime-types is the IANA collection
   of\nregistrations (see below for the link), RFCs, and W3C recommendations.\n\nThis
-  is release 2.4.1 (2.4 was pulled), fixing a bug in observed use of the\nmime-types
-  library where extensions were not previously sorted, such that\n\n    MIME::Types.of('image.jpg').first.extensions.first\n\nreturned
+  is release 2.4.2, fixing bugs with unnecessary object duplication and\nusing JSON.parse
+  instead of JSON.load. These fixes improve the JSON registry\nloading time by about
+  55% over previous 2.x releases. Cached registry load\ntimes are not changed. This
+  release builds on the 2.4.1 release, which fixed a\nbug in observed use of the mime-types
+  library where extensions were not\npreviously sorted, such that\n\n    MIME::Types.of('image.jpg').first.extensions.first\n\nreturned
   a value of +jpeg+ in mime-types 1, but +jpe+ in mime-types 2. This was\nintroduced
   because extensions were sorted during assignment\n(MIME::Type#extensions=). This
   behaviour has been reverted to protect clients\nthat work as noted above. The preferred