mime-types 2.3 → 2.4.1

data/lib/mime/types.rb

@@ -97,7 +97,11 @@ class MIME::Types
 
   # Iterates through the type variants.
   def each
-    @type_variants.values.each { |tv| tv.each { |t| yield t } }
+    if block_given?
+      @type_variants.each_value { |tv| tv.each { |t| yield t } }
+    else
+      enum_for(:each)
+    end
   end
 
   @__types__  = nil
@@ -165,7 +169,7 @@ class MIME::Types
   # current platform will be returned. This parameter has been deprecated.
   def type_for(filename, platform = false)
     types = Array(filename).flat_map { |fn|
-      @extension_index[File.basename(fn.chomp.downcase).gsub(/.*\./o, '')]
+      @extension_index[fn.chomp.downcase[/\.?([^.]*?)$/, 1]]
     }.compact.sort { |a, b| a.priority_compare(b) }.uniq
 
     if platform
@@ -206,8 +210,8 @@ class MIME::Types
   # a truthy value to suppress that warning.
   def add_type(mime_type, quiet = false)
     if !quiet and @type_variants[mime_type.simplified].include?(mime_type)
-      warn("Type %s is already registered as a variant of %s." % [
-        mime_type, mime_type.simplified ])
+      warn('Type %s is already registered as a variant of %s.' %
+           [ mime_type, mime_type.simplified ])
     end
 
     add_type_variant!(mime_type)
@@ -237,7 +241,11 @@ class MIME::Types
 
     # MIME::Types#each against the default MIME::Types registry.
     def each
-      __types__.each {|t| yield t }
+      if block_given?
+        __types__.each { |t| yield t }
+      else
+        enum_for(:each)
+      end
     end
 
     # MIME::Types#type_for against the default MIME::Types registry.

data/lib/mime/types/loader.rb

@@ -11,10 +11,8 @@ require 'mime/types/loader_path'
 # 3.  The value of MIME::Types::Loader::PATH.
 #
 # When #load is called, the +path+ will be searched recursively for all YAML
-# (.yml or .yaml) files. By convention, there is one file for each media type
-# (application.yml, audio.yml, etc.), but this is not required.
-#
-#
+# (.yml or .yaml) files. By convention, there is one file for each media
+# type (application.yml, audio.yml, etc.), but this is not required.
 class MIME::Types::Loader
   # The path that will be read for the MIME::Types files.
   attr_reader :path
@@ -81,6 +79,8 @@ class MIME::Types::Loader
     container
   end
 
+  BadV1Format = Class.new(Exception)
+
   class << self
     # Loads the default MIME::Type registry.
     def load
@@ -124,36 +124,27 @@ class MIME::Types::Loader
     # more information that's available, though, the richer the values that can
     # be provided.
     def load_from_v1(filename)
+      MIME.deprecated(self.class, __method__)
       data = read_file(filename).split($/)
       mime = MIME::Types.new
       data.each_with_index { |line, index|
         item = line.chomp.strip
         next if item.empty?
 
-        begin
-          m = MIME::Types::Loader::V1_FORMAT.match(item).captures
-        rescue Exception
+        m = MIME::Types::Loader::V1_FORMAT.match(item)
+
+        unless m
           warn <<-EOS
-#{filename}:#{index}: Parsing error in v1 MIME type definition.
+#{filename}:#{index + 1}: Parsing error in v1 MIME type definition.
 => #{line}
           EOS
-          raise
+          raise BadV1Format, line
         end
 
         unregistered, obsolete, platform, mediatype, subtype, extensions,
-          encoding, urls, docs, comment = *m
+          encoding, urls, docs, comment = *m.captures
 
-        if mediatype.nil?
-          if comment.nil?
-            warn <<-EOS
-#{filename}:#{index}: Parsing error in v1 MIME type definition (no media type).
-=> #{line}
-            EOS
-            raise
-          end
-
-          next
-        end
+        next if mediatype.nil?
 
         extensions &&= extensions.split(/,/)
         urls &&= urls.split(/,/)

data/support/benchmarks/load.rb

@@ -0,0 +1,55 @@
+# -*- ruby encoding: utf-8 -*-
+
+require 'benchmark'
+
+module Benchmarks
+  class Load
+    def self.report(load_path, repeats)
+      new(load_path, repeats.to_i).report
+    end
+
+    def initialize(load_path, repeats = nil)
+      @cache_file = File.expand_path('../cache.mtc', __FILE__)
+      @repeats    = repeats.to_i
+      @repeats    = 50 if repeats <= 0
+      @load_path  = load_path
+    end
+
+    def reload_mime_types(repeats = 1, force_load = false)
+      repeats.times {
+        Object.send(:remove_const, :MIME) if defined? ::MIME
+        $LOADED_FEATURES.delete_if { |n| n =~ /#{@load_path}/ }
+        require 'mime/types'
+        ::MIME::Types.send(:__types__) if force_load
+      }
+    end
+
+    def report
+      remove_cache
+
+      Benchmark.bm(17) do |mark|
+        mark.report("Normal:") { reload_mime_types(@repeats) }
+
+        ENV['RUBY_MIME_TYPES_LAZY_LOAD'] = 'yes'
+        mark.report("Lazy:") { reload_mime_types(@repeats) }
+        mark.report("Lazy+Load:") { reload_mime_types(@repeats, true) }
+
+        ENV.delete('RUBY_MIME_TYPES_LAZY_LOAD')
+
+        ENV['RUBY_MIME_TYPES_CACHE'] = @cache_file
+        reload_mime_types
+
+        mark.report("Cached:") { reload_mime_types(@repeats) }
+        ENV['RUBY_MIME_TYPES_LAZY_LOAD'] = 'yes'
+        mark.report("Lazy Cached:") { reload_mime_types(@repeats) }
+        mark.report("Lazy Cached Load:") { reload_mime_types(@repeats, true) }
+      end
+    ensure
+      remove_cache
+    end
+
+    def remove_cache
+      File.unlink(@cache_file) if File.exist?(@cache_file)
+    end
+  end
+end

data/support/convert.rb

@@ -6,28 +6,36 @@ require 'fileutils'
 
 class Convert
   class << self
+    # Create a Convert instance that converts from YAML.
     def from_yaml(path = nil)
       new(path: path, from: :yaml)
     end
 
+    # Create a Convert instance that converts from JSON.
     def from_json(path = nil)
       new(path: path, from: :json)
     end
 
+    # Create a Convert instance that converts from the mime-types 1.x file
+    # format.
     def from_v1(path = nil)
       new(path: path, from: :v1)
     end
 
+    # Converts from YAML to JSON. Defaults to converting to a single file.
     def from_yaml_to_json(args)
+      mf = args.multiple_files || "single"
       from_yaml(yaml_path(args.source)).
         to_json(destination:    json_path(args.destination),
-                multiple_files: multiple_files(args.multiple_files))
+                multiple_files: multiple_files(mf))
     end
 
+    # Converts from JSON to YAML. Defaults to converting to multiple files.
     def from_json_to_yaml(args)
+      mf = args.multiple_files || "multiple"
       from_json(json_path(args.source)).
         to_yaml(destination:    yaml_path(args.destination),
-                multiple_files: multiple_files(args.multiple_files))
+                multiple_files: multiple_files(mf))
     end
 
     private :new
@@ -50,8 +58,8 @@ class Convert
     end
 
     def multiple_files(flag)
-      case flag
-      when "true", "yes"
+      case flag.to_s.downcase
+      when "true", "yes", "multiple"
         true
       else
         false
@@ -73,11 +81,13 @@ class Convert
     load_from(options[:from])
   end
 
+  # Convert the data to JSON.
   def to_json(options = {})
     raise ArgumentError, 'destination is required' unless options[:destination]
     write_types(options.merge(format: :json))
   end
 
+  # Convert the data to YAML.
   def to_yaml(options = {})
     raise ArgumentError, 'destination is required' unless options[:destination]
     write_types(options.merge(format: :yaml))

data/test/bad-fixtures/malformed

@@ -0,0 +1,9 @@
+!application.smil @smi,smil :8bit 'IANA,RFC4536 =use-instead:application/smil+xml
+!audio/vnd.qcelp @qcp 'IANA,RFC3625 =use-instead:audio/QCELP
+*!image/bmp @bmp =use-instead:image/x-bmp
+*application/acad 'LTSW
+*audio/webm @webm '{WebM=http://www.webmproject.org/code/specs/container/}
+*image/pjpeg :base64 =Fixes a bug with IE6 and progressive JPEGs
+application/1d-interleaved-parityfec 'IANA,RFC6015
+audio/1d-interleaved-parityfec 'IANA,RFC6015
+mac:application/x-apple-diskimage @dmg

data/test/test_mime_type.rb

@@ -8,11 +8,28 @@ class TestMIMEType < Minitest::Test
     MIME::Type.new(content_type) { |mt| yield mt if block_given? }
   end
 
+  def make_javascript
+    make('application/javascript') do |js|
+      js.friendly('en' => 'JavaScript')
+      js.xrefs = {
+        'rfc' => %w(rfc4239 rfc4239),
+        'template' => %w(application/javascript)
+      }
+      js.encoding = '8bit'
+      js.extensions = %w(js sj)
+      js.references = %w(IANA RFC4329 {application/javascript=http://www.iana.org/assignments/media-types/application/javascript})
+      js.registered = true
+
+      yield js if block_given?
+    end
+  end
+
   def make_yaml_mime_type
     make('text/x-yaml') do |yaml|
       yaml.extensions = %w(yaml yml)
       yaml.encoding   = '8bit'
       yaml.system     = 'd9d172f608'
+      yaml.friendly('en' => 'YAML Structured Document')
     end
   end
 
@@ -74,6 +91,16 @@ class TestMIMEType < Minitest::Test
     assert_nil(MIME::Type.simplified('text'))
   end
 
+  def test_class_i18n_key
+    assert_equal('text.plain', MIME::Type.i18n_key('text/plain'))
+    assert_equal('image.jpeg', MIME::Type.i18n_key('image/jpeg'))
+    assert_equal('application.msword', MIME::Type.i18n_key('application/x-msword'))
+    assert_equal('text.vcard', MIME::Type.i18n_key('text/vCard'))
+    assert_equal('application.pkcs7-mime', MIME::Type.i18n_key('application/pkcs7-mime'))
+    assert_equal('xyz.abc', MIME::Type.i18n_key('x-xyz/abc'))
+    assert_nil(MIME::Type.i18n_key('text'))
+  end
+
   def test_CMP # '<=>'
     assert(MIME::Type.new('text/plain') == MIME::Type.new('text/plain'))
     assert(MIME::Type.new('text/plain') != MIME::Type.new('image/jpeg'))
@@ -204,7 +231,7 @@ class TestMIMEType < Minitest::Test
     assert_equal(%w(yaml), yaml.extensions)
 
     yaml.extensions = %w(yz yaml yz yml)
-    assert_equal(%w(yaml yml yz), yaml.extensions)
+    assert_equal(%w(yz yaml yml), yaml.extensions)
   end
 
   def test_like_eh
@@ -461,6 +488,40 @@ class TestMIMEType < Minitest::Test
     assert_equal(%W(IANA), yaml.references)
   end
 
+  def test_xrefs
+    assert_equal(
+      {
+        'rfc' => %w(rfc4239),
+        'template' => %w(application/javascript)
+      },
+      make_javascript.xrefs
+    )
+  end
+
+  def test_xref_urls
+    js = make_javascript do |j|
+      j.xrefs = j.xrefs.merge({
+        'draft'      => [ 'RFC-ietf-appsawg-json-merge-patch-07' ],
+        'person'     => [ 'David_Singer' ],
+        'rfc-errata' => [ '3245' ],
+        'uri'        => [ 'http://exmple.org' ],
+        'text'       => [ 'text' ]
+      })
+    end
+    assert_equal(
+      [
+        "http://www.iana.org/go/rfc4239",
+        "http://www.iana.org/assignments/media-types/application/javascript",
+        "http://www.iana.org/go/draft-ietf-appsawg-json-merge-patch-07",
+        "http://www.iana.org/assignments/media-types/media-types.xhtml#David_Singer",
+        "http://www.rfc-editor.org/errata_search.php?eid=3245",
+        "http://exmple.org",
+        "text"
+      ],
+      js.xref_urls
+    )
+  end
+
   def test_url
     assert_deprecated("MIME::Type#url", "and has been renamed to #references") do
       assert_empty(make_yaml_mime_type.url)
@@ -507,6 +568,29 @@ class TestMIMEType < Minitest::Test
     assert_equal('t/2', t.use_instead)
   end
 
+  def test_preferred_extension
+    assert_equal('zip', @applzip.preferred_extension)
+  end
+
+  def test_friendly_read
+    yaml = make_yaml_mime_type
+    assert_equal('YAML Structured Document', yaml.friendly)
+    assert_equal('YAML Structured Document', yaml.friendly('en'))
+    assert_equal(nil, yaml.friendly('fr'))
+  end
+
+  def test_friendly_set
+    assert_equal({ 'en' => 'Zip' }, @applzip.friendly([ 'en', 'Zip' ]))
+    assert_equal({ 'en' => 'Zip Archive' }, @applzip.friendly('en' => 'Zip Archive'))
+  end
+
+  def test_i18n_key
+    assert_equal('text.plain', make('text/plain').i18n_key)
+    assert_equal('application.vnd-3gpp-bsf-xml',
+                 make('application/vnd.3gpp.bsf+xml').i18n_key)
+    assert_equal('application.msword', make('application/x-msword').i18n_key)
+  end
+
   def test_deprecated_constant
     assert_output(nil, /MIME::InvalidContentType/) do
       assert_same(MIME::InvalidContentType, MIME::Type::InvalidContentType)
@@ -514,5 +598,6 @@ class TestMIMEType < Minitest::Test
     assert_silent do
       assert_same(MIME::InvalidContentType, MIME::Type::InvalidContentType)
     end
+    assert_raises(NameError) { MIME::Foo }
   end
 end

data/test/test_mime_types.rb

@@ -16,6 +16,8 @@ class TestMIMETypes < Minitest::Test
 
   def test_enumerable
     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
 
   def test_index_with_mime_type

data/test/test_mime_types_class.rb

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

data/test/test_mime_types_loader.rb

@@ -5,8 +5,9 @@ require 'minitest_helper'
 
 class TestMIMETypesLoader < Minitest::Test
   def setup
-    @path   = File.expand_path('../fixture', __FILE__)
-    @loader = MIME::Types::Loader.new(@path)
+    @path     = File.expand_path('../fixture', __FILE__)
+    @loader   = MIME::Types::Loader.new(@path)
+    @bad_path = File.expand_path('../bad-fixtures', __FILE__)
   end
 
   def assert_correctly_loaded(types)
@@ -39,4 +40,12 @@ class TestMIMETypesLoader < Minitest::Test
   def test_load_v1
     assert_correctly_loaded(@loader.load_v1)
   end
+
+  def test_malformed_v1
+    assert_output(nil, /1: Parsing error in v1 MIME type definition/) {
+      assert_raises(MIME::Types::Loader::BadV1Format) {
+        MIME::Types::Loader.load_from_v1(File.join(@bad_path, 'malformed'))
+      }
+    }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mime-types
 version: !ruby/object:Gem::Version
-  version: '2.3'
+  version: 2.4.1
 platform: ruby
 authors:
 - Austin Ziegler
@@ -36,7 +36,7 @@ cert_chain:
   SHkzay9FVEZoaSs3cElVV2xGbzBpbXJkeUxoZCtKdzNib1ZqM0NtdnloY3dt
   cG9NMEs5bApBT21yVWlFbFVxTE9aQT09Ci0tLS0tRU5EIENFUlRJRklDQVRF
   LS0tLS0K
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -192,64 +192,35 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
-description: ! 'The mime-types library provides a library and registry for information
-  about
-
-  MIME content type definitions. It can be used to determine defined filename
-
-  extensions for MIME types, or to use filename extensions to look up the likely
-
-  MIME type definitions.
-
-
-  MIME content types are used in MIME-compliant communications, as in e-mail or
-
-  HTTP traffic, to indicate the type of content which is transmitted. The
-
-  mime-types library provides the ability for detailed information about MIME
-
-  entities (provided as an enumerable collection 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 by definition incomplete; don''t hesitate to to
-
-  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.2, mostly changing how the MIME type registry is updated from
-
-  the IANA registry (the format of which was incompatibly changed shortly before
-
-  this release) and taking advantage of the extra data available from IANA
-
-  registry in the form of MIME::Type#xrefs. In addition, the {LTSW
-
-  list}[http://www.ltsw.se/knbase/internet/mime.htp] has been dropped as a
-
-  supported list.
-
-
-  As a reminder, mime-types 2.x is no longer compatible with Ruby 1.8 and
-
-  mime-types 1.x is only being maintained for security issues. No new MIME types
-
-  or features will be added.
-
-
-  mime-types (previously called MIME::Types for Ruby) was originally based on
-
-  MIME::Types for Perl by Mark Overmeer, copyright 2001 - 2009. It is built to
-
-  conform to the MIME types of RFCs 2045 and 2231. It tracks the {IANA Media
-
-  Types registry}[https://www.iana.org/assignments/media-types/media-types.xhtml]
-
-  with some types added by the users of mime-types.'
+description: ! "The mime-types library provides a library and registry for information
+  about\nMIME content type definitions. It can be used to determine defined filename\nextensions
+  for MIME types, or to use filename extensions to look up the likely\nMIME type definitions.\n\nMIME
+  content types are used in MIME-compliant communications, as in e-mail or\nHTTP traffic,
+  to indicate the type of content which is transmitted. The\nmime-types library provides
+  the ability for detailed information about MIME\nentities (provided as an enumerable
+  collection of MIME::Type objects) to be\ndetermined and used programmatically. There
+  are many types defined by RFCs and\nvendors, so the list is long but by definition
+  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
+  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
+  way to express this is the new method:\n\n    MIME::Type.of('image.jpg').first.preferred_extension\n\nŁukasz
+  Śliwa created the\n{friendly_mime}[https://github.com/lukaszsliwa/friendly_mime]
+  gem, which offers\nfriendly descriptive names for MIME types. This functionality
+  and\nEnglish-language data has been added to mime-types as MIME::Type#friendly.
+  To\nmake it easy for internationalization, MIME::Type#i18n_key has been added,\nwhich
+  will return a key suitable for use with the\n{I18n}[https://github.com/svenfuchs/i18n]
+  library.\n\nAs a reminder, mime-types 2.x is no longer compatible with Ruby 1.8
+  and\nmime-types 1.x is only being maintained for security issues. No new MIME types\nor
+  features will be added.\n\nmime-types (previously called MIME::Types for Ruby) was
+  originally based on\nMIME::Types for Perl by Mark Overmeer, copyright 2001 - 2009.
+  It is built to\nconform to the MIME types of RFCs 2045 and 2231. It tracks the {IANA
+  Media\nTypes registry}[https://www.iana.org/assignments/media-types/media-types.xhtml]\nwith
+  some types added by the users of mime-types."
 email:
 - halostatue@gmail.com
 executables: []
@@ -289,9 +260,10 @@ files:
 - lib/mime/types/loader.rb
 - lib/mime/types/loader_path.rb
 - support/apache_mime_types.rb
-- support/benchmarker.rb
+- support/benchmarks/load.rb
 - support/convert.rb
 - support/iana_registry.rb
+- test/bad-fixtures/malformed
 - test/fixture/json.json
 - test/fixture/old-data
 - test/fixture/yaml.yaml
@@ -326,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: The mime-types library provides a library and registry for information about