mime-types 2.5 → 2.6

data/test/test_mime_types.rb

@@ -11,7 +11,7 @@ class TestMIMETypes < Minitest::Test
                     MIME::Type.new('application/x-wordperfect6.1'),
                     MIME::Type.new('content-type' => 'application/x-www-form-urlencoded', 'registered' => true),
                     MIME::Type.new(['application/x-gzip', %w(gz)]),
-                    MIME::Type.new(['application/gzip', %W(gz)]))
+                    MIME::Type.new(['application/gzip', %w(gz)]))
   end
 
   def test_enumerable
@@ -52,15 +52,15 @@ class TestMIMETypes < Minitest::Test
   end
 
   def test_index_with_platform_flag
-    assert_deprecated("MIME::Types#[]", "using the :platform flag") do
+    assert_deprecated('MIME::Types#[]', 'using the :platform flag') do
       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"
-      t.encoding = "8bit"
+    eruby = MIME::Type.new('application/x-eruby') do |t|
+      t.extensions = 'rhtml'
+      t.encoding = '8bit'
     end
 
     @mime_types.add(eruby)
@@ -74,9 +74,11 @@ class TestMIMETypes < Minitest::Test
     assert_equal(%w(image/jpeg), MIME::Types.of('foo.jpeg'))
     assert_equal(%w(image/jpeg text/plain),
                  MIME::Types.type_for(%w(foo.txt foo.jpeg)))
-    assert_equal(@mime_types.of('gif', true), @mime_types['image/gif'])
+    assert_deprecated('MIME::Types#type_for', 'using the platform parameter') do
+      assert_equal(@mime_types.of('gif', true), @mime_types['image/gif'])
+    end
     assert_empty(MIME::Types.type_for('coverallsjson'))
-    assert_deprecated("MIME::Types#type_for", "using the platform parameter") do
+    assert_deprecated('MIME::Types#type_for', 'using the platform parameter') do
       assert_empty(MIME::Types.type_for('jpeg', true))
     end
     assert_empty(@mime_types.type_for('zzz'))
@@ -89,7 +91,7 @@ class TestMIMETypes < Minitest::Test
   # This tests the instance implementation through the class implementation.
   def test_add_type_variant
     xtxp = MIME::Type.new('x-text/x-plain')
-    assert_deprecated("MIME::Types#add_type_variant", "and will be private") do
+    assert_deprecated('MIME::Types#add_type_variant', 'and will be private') do
       @mime_types.add_type_variant(xtxp)
     end
     assert_includes(@mime_types['text/plain'], xtxp)
@@ -102,16 +104,18 @@ class TestMIMETypes < Minitest::Test
   # This tests the instance implementation through the class implementation.
   def test_index_extensions
     xtxp = MIME::Type.new(['x-text/x-plain', %w(tzt)])
-    assert_deprecated("MIME::Types#index_extensions", "and will be private") do
+    assert_deprecated('MIME::Types#index_extensions', 'and will be private') do
       @mime_types.index_extensions(xtxp)
     end
     assert_includes(@mime_types.of('tzt'), xtxp)
   end
 
   def test_defined_types
-    assert_deprecated("MIME::Types#defined_types") do
+    assert_deprecated('MIME::Types#defined_types') do
       assert_empty(MIME::Types.new.defined_types)
     end
-    refute_empty(@mime_types.defined_types)
+    assert_deprecated('MIME::Types#defined_types') do
+      refute_empty(@mime_types.defined_types)
+    end
   end
 end

data/test/test_mime_types_class.rb

@@ -16,7 +16,7 @@ class TestMIMETypesQueryClassMethods < Minitest::Test
 
   def test_load_from_file
     fn = File.expand_path('../fixture/old-data', __FILE__)
-    assert_deprecated("MIME::Types.load_from_file") do
+    assert_deprecated('MIME::Types.load_from_file') do
       MIME::Types.load_from_file(fn)
     end
   end
@@ -53,7 +53,7 @@ class TestMIMETypesQueryClassMethods < Minitest::Test
   end
 
   def test_index_with_platform_flag
-    assert_deprecated("MIME::Types#[]", "using the :platform flag") do
+    assert_deprecated('MIME::Types#[]', 'using the :platform flag') do
       assert_empty(MIME::Types['text/plain', platform: true])
     end
   end
@@ -63,7 +63,7 @@ class TestMIMETypesQueryClassMethods < Minitest::Test
     assert_equal(%w(image/gif), MIME::Types.of('foo.gif'))
     assert_equal(%w(application/xml image/gif text/xml),
                  MIME::Types.type_for(%w(xml gif)))
-    assert_deprecated("MIME::Types#type_for", "using the platform parameter") do
+    assert_deprecated('MIME::Types#type_for', 'using the platform parameter') do
       assert_empty(MIME::Types.type_for('gif', true))
     end
     assert_empty(MIME::Types.type_for('zzz'))
@@ -71,16 +71,18 @@ class TestMIMETypesQueryClassMethods < Minitest::Test
 
   def test_count
     assert(MIME::Types.count.nonzero?,
-           "A lot of types are expected to be known.")
+           'A lot of types are expected to be known.')
   end
 
   def test_cache_file
     ENV['RUBY_MIME_TYPES_CACHE'] = 'foo'
-    assert_deprecated("MIME::Types.cache_file") do
+    assert_deprecated('MIME::Types.cache_file') do
       assert_equal('foo', MIME::Types.cache_file)
     end
     ENV.delete('RUBY_MIME_TYPES_CACHE')
-    assert_nil(MIME::Types.cache_file)
+    assert_deprecated('MIME::Types.cache_file') do
+      assert_nil(MIME::Types.cache_file)
+    end
   end
 end
 
@@ -91,37 +93,37 @@ class TestMIMETypesClassMethods < Minitest::Test
   end
 
   def test_add_with_type
-    MIME::Types.add(MIME::Type.new("application/x-eruby"))
+    MIME::Types.add(MIME::Type.new('application/x-eruby'))
     refute_empty(MIME::Types['application/x-eruby'])
   end
 
   def test_add_with_types
     mt = MIME::Types.new
-    mt.add MIME::Type.new("application/x-eruby")
+    mt.add MIME::Type.new('application/x-eruby')
     MIME::Types.add(mt)
     refute_empty(MIME::Types['application/x-eruby'])
   end
 
   def test_add_with_array
-    MIME::Types.add([MIME::Type.new("application/x-eruby")])
+    MIME::Types.add([MIME::Type.new('application/x-eruby')])
     refute_empty(MIME::Types['application/x-eruby'])
   end
 
   def test_add_with_noise_suppression
     assert_silent do
-      MIME::Types.add(MIME::Type.new("application/x-eruby"))
+      MIME::Types.add(MIME::Type.new('application/x-eruby'))
     end
     assert_output(nil, %r{application/x-eruby is already registered}) do
-      MIME::Types.add(MIME::Type.new("application/x-eruby"))
+      MIME::Types.add(MIME::Type.new('application/x-eruby'))
     end
     assert_silent do
-      MIME::Types.add(MIME::Type.new("application/x-eruby"), :silent)
+      MIME::Types.add(MIME::Type.new('application/x-eruby'), :silent)
     end
   end
 
   def test_add_type_variant
     xtxp = MIME::Type.new('x-text/x-plain')
-    assert_deprecated("MIME::Types#add_type_variant", "and will be private") do
+    assert_deprecated('MIME::Types#add_type_variant', 'and will be private') do
       MIME::Types.add_type_variant(xtxp)
     end
     assert_includes(MIME::Types['text/plain'], xtxp)
@@ -129,7 +131,7 @@ class TestMIMETypesClassMethods < Minitest::Test
 
   def test_index_extensions
     xtxp = MIME::Type.new(['x-text/x-plain', %w(tzt)])
-    assert_deprecated("MIME::Types#index_extensions", "and will be private") do
+    assert_deprecated('MIME::Types#index_extensions', 'and will be private') do
       MIME::Types.index_extensions(xtxp)
     end
     assert_includes(MIME::Types.of('tzt'), xtxp)

data/test/test_mime_types_lazy.rb

@@ -5,12 +5,14 @@ require 'minitest_helper'
 
 class TestMIMETypesLazy < Minitest::Test
   def setup
+    @cache_file = File.expand_path('../cache.tst', __FILE__)
     ENV['RUBY_MIME_TYPES_LAZY_LOAD'] = 'true'
-    ENV['RUBY_MIME_TYPES_CACHE'] = File.expand_path('../cache.tst', __FILE__)
+    ENV['RUBY_MIME_TYPES_CACHE'] = @cache_file
     MIME::Types::Cache.save
   end
 
   def teardown
+    clear_cache_file
     reset_mime_types
     if File.exist? ENV['RUBY_MIME_TYPES_CACHE']
       FileUtils.rm ENV['RUBY_MIME_TYPES_CACHE']
@@ -19,6 +21,10 @@ class TestMIMETypesLazy < Minitest::Test
     ENV.delete('RUBY_MIME_TYPES_LAZY_LOAD')
   end
 
+  def clear_cache_file
+    FileUtils.rm @cache_file if File.exist? @cache_file
+  end
+
   def reset_mime_types
     MIME::Types.instance_variable_set(:@__types__, nil)
     MIME::Types.send(:load_default_mime_types)

data/test/test_mime_types_loader.rb

@@ -12,21 +12,28 @@ class TestMIMETypesLoader < Minitest::Test
 
   def assert_correctly_loaded(types)
     assert_includes(types, 'application/1d-interleaved-parityfec')
-    assert_includes(types['application/acad'].first.references, 'LTSW')
-    assert_equal([%w(WebM http://www.webmproject.org/code/specs/container/)],
-                 types['audio/webm'].first.urls)
+    assert_deprecated('MIME::Type#references') do
+      assert_includes(types['application/acad'].first.references, 'LTSW')
+    end
+    assert_deprecated('MIME::Type#urls') do
+      assert_equal([%w(WebM http://www.webmproject.org/code/specs/container/)],
+                   types['audio/webm'].first.urls)
+    end
     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',
                  types['image/pjpeg'].first.docs)
 
-    assert(types['application/x-apple-diskimage'].first.system?)
-    assert_equal(/mac/, types['application/x-apple-diskimage'].first.system)
+    assert_deprecated('MIME::Type#system?') do
+      assert(types['application/x-apple-diskimage'].first.system?)
+    end
+    assert_deprecated('MIME::Type#system') do
+      assert_equal(/mac/, types['application/x-apple-diskimage'].first.system)
+    end
 
     assert(types['audio/vnd.qcelp'].first.obsolete?)
-    assert_equal(%w(audio/QCELP),
-                 types['audio/vnd.qcelp'].first.use_instead)
+    assert_equal('audio/QCELP', types['audio/vnd.qcelp'].first.use_instead)
   end
 
   def test_load_yaml
@@ -38,7 +45,9 @@ class TestMIMETypesLoader < Minitest::Test
   end
 
   def test_load_v1
-    assert_correctly_loaded(@loader.load_v1)
+    assert_deprecated('MIME::Types::Loader.load_v1') do
+      assert_correctly_loaded(@loader.load_v1)
+    end
   end
 
   def test_malformed_v1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mime-types
 version: !ruby/object:Gem::Version
-  version: '2.5'
+  version: '2.6'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-25 00:00:00.000000000 Z
+date: 2015-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -188,16 +202,27 @@ description: |-
   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
-  add additional type definitions (see Contributing.rdoc). The primary sources
-  for MIME type definitions found in mime-types is the
-  {IANA Media Types registry}[https://www.iana.org/assignments/media-types/media-types.xhtml],
-  RFCs, and W3C recommendations. It conforms to RFCs 2045 and 2231.
+  determined and used. There are many types defined by RFCs and vendors, so the
+  list is long but by definition incomplete; don't hesitate to add additional
+  type definitions. MIME type definitions found in mime-types are from RFCs, W3C
+  recommendations, the {IANA Media Types
+  registry}[https://www.iana.org/assignments/media-types/media-types.xhtml], and
+  user contributions. It conforms to RFCs 2045 and 2231.
+
+  This is release 2.6 with two new experimental features. The first new feature
+  is a new default registry storage format that greatly reduces the initial
+  memory use of the mime-types library. This feature is enabled by requiring
+  +mime/types/columnar+ instead of +mime/types+ with a small performance cost and
+  no change in *total* memory use if certain methods are called (see {Columnar
+  Store}[#columnar-store] for more details). The second new feature is a logger
+  interface that conforms to the expectations of an ActiveSupport::Logger so that
+  warnings can be written to an application's log rather than the default
+  location for +warn+. This interface may be used for other logging purposes in
+  the future.
 
-  This is release 2.5 with a couple of bug fixes, updating to the latest IANA
-  type registry, and adding a user-contributed type. mime-types 2.x supports Ruby
-  1.9.2 or later.
+  mime-types 2.6 is the last planned version of mime-types 2.x, so deprecation
+  warnings are no longer cached but provided every time the method is called.
+  mime-types 2.6 supports Ruby 1.9.2 or later.
 email:
 - halostatue@gmail.com
 executables: []
@@ -224,18 +249,35 @@ files:
 - README.rdoc
 - Rakefile
 - data/mime-types.json
+- data/mime.content_type.column
+- data/mime.docs.column
+- data/mime.encoding.column
+- data/mime.friendly.column
+- data/mime.obsolete.column
+- data/mime.references.column
+- data/mime.registered.column
+- data/mime.signature.column
+- data/mime.system.column
+- data/mime.use_instead.column
+- data/mime.xrefs.column
 - docs/COPYING.txt
 - docs/artistic.txt
 - lib/mime-types.rb
-- lib/mime.rb
 - lib/mime/type.rb
+- lib/mime/type/columnar.rb
 - lib/mime/types.rb
 - lib/mime/types/cache.rb
+- lib/mime/types/columnar.rb
+- lib/mime/types/deprecations.rb
 - lib/mime/types/loader.rb
 - lib/mime/types/loader_path.rb
+- lib/mime/types/logger.rb
 - support/apache_mime_types.rb
 - support/benchmarks/load.rb
+- support/benchmarks/load_allocations.rb
+- support/benchmarks/object_counts.rb
 - support/convert.rb
+- support/convert/columnar.rb
 - support/iana_registry.rb
 - test/bad-fixtures/malformed
 - test/fixture/json.json

data/lib/mime.rb

@@ -1,51 +0,0 @@
-# -*- ruby encoding: utf-8 -*-
-
-# The namespace for MIME applications, tools, and libraries.
-module MIME # :nodoc:
-end
-
-class << MIME
-  # Used to mark a method as deprecated in the mime-types interface.
-  def deprecated(klass, sym, message = nil, &block) # :nodoc:
-    level = case klass
-            when Class, Module
-              '.'
-            else
-              klass = klass.class
-              '#'
-            end
-    unless defined?(@__deprecated) and @__deprecated["#{klass}#{level}#{sym}"]
-      message = case message
-                when :private, :protected
-                  "and will be #{message}"
-                when nil
-                  "and will be removed"
-                else
-                  message
-                end
-      warn "#{klass}#{level}#{sym} is deprecated #{message}."
-      (@__deprecated ||= {})["#{klass}#{level}#{sym}"] = true
-      block.call if block
-    end
-  end
-
-  # MIME::InvalidContentType was moved to MIME::Type::InvalidContentType.
-  # Provide a single warning about this fact in the interim.
-  def const_missing(name) # :nodoc:
-    case name.to_s
-    when "InvalidContentType"
-      warn_about_moved_constants(name)
-      MIME::Type.const_get(name.to_sym)
-    else
-      super
-    end
-  end
-
-  private
-  def warn_about_moved_constants(name) # :nodoc:
-    unless defined?(@__warned_constants) and @__warned_constants[name]
-      warn "MIME::#{name} is deprecated. Use MIME::Type::#{name} instead."
-      (@__warned_constants ||= {})[name] = true
-    end
-  end
-end