mime-types 3.5.2 → 3.7.0

data/CONTRIBUTORS.md

@@ -0,0 +1,52 @@
+# Contributors
+
+- Austin Ziegler created mime-types.
+
+Thanks to everyone else who has contributed to mime-types over the years:
+
+- Aaron Patterson
+- Aggelos Avgerinos
+- Al Snow
+- Alex Vondrak
+- Andre Pankratz
+- Andy Brody
+- Arnaud Meuret
+- Brandon Galbraith
+- Burke Libbey
+- Chris Gat
+- Daniel Watkins
+- David Genord
+- Dillon Welch
+- Edward Betts
+- Eric Marden
+- Garret Alfert
+- Godfrey Chan
+- Greg Brockman
+- Hans de Graaff
+- Henrik Hodne
+- Igor Victor
+- Janko Marohnić
+- Jean Boussier
+- Jeremy Evans
+- Juanito Fatas
+- Jun Aruga
+- Keerthi Siva
+- Ken Ip
+- Kevin Menard
+- Koichi ITO
+- Łukasz Śliwa
+- Martin d'Allens
+- Masato Nakamura
+- Mauricio Linhares
+- Nana Kugayama
+- Nicholas La Roux
+- Nicolas Leger
+- nycvotes-dev
+- Olle Jonsson
+- Postmodern
+- Richard Hirner
+- Richard Hurt
+- Richard Schneeman
+- Robb Shecter
+- Tibor Szolár
+- Todd Carrico

data/{Licence.md → LICENCE.md}

@@ -1,6 +1,6 @@
 # Licence
 
-- Copyright 2003–2019 Austin Ziegler and contributors.
+- Copyright 2003-2025 Austin Ziegler and contributors.
 
 The software in this repository is made available under the MIT license.
 
@@ -9,17 +9,16 @@ The software in this repository is made available under the MIT license.
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
 the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -1,11 +1,12 @@
-.standard.yml
-Code-of-Conduct.md
-Contributing.md
-History.md
-Licence.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+CONTRIBUTORS.md
+LICENCE.md
 Manifest.txt
-README.rdoc
+README.md
 Rakefile
+SECURITY.md
 lib/mime-types.rb
 lib/mime/type.rb
 lib/mime/type/columnar.rb
@@ -19,6 +20,7 @@ lib/mime/types/full.rb
 lib/mime/types/loader.rb
 lib/mime/types/logger.rb
 lib/mime/types/registry.rb
+lib/mime/types/version.rb
 test/bad-fixtures/malformed
 test/fixture/json.json
 test/fixture/old-data

data/README.md

@@ -0,0 +1,200 @@
+# mime-types for Ruby
+
+- home :: https://github.com/mime-types/ruby-mime-types/
+- issues :: https://github.com/mime-types/ruby-mime-types/issues
+- code :: https://github.com/mime-types/ruby-mime-types/
+- rdoc :: http://rdoc.info/gems/mime-types/
+- changelog ::
+  https://github.com/mime-types/ruby-mime-types/blob/main/CHANGELOG.md
+- continuous integration :: [![Build Status][ci-badge]][ci-workflow]
+- test coverage :: [![Coverage][coveralls-badge]][coveralls]
+
+## 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.
+
+Version 3.0 is a major release that requires Ruby 2.0 compatibility and removes
+deprecated functions. The columnar registry format introduced in 2.6 has been
+made the primary format; the registry data has been extracted from this library
+and put into [mime-types-data][data]. Additionally, mime-types is now licensed
+exclusively under the MIT licence and there is a code of conduct in effect.
+There are a number of other smaller changes described in the History file.
+
+### About MIME Media Types
+
+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. 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][registry], and user
+contributions. It conforms to RFCs 2045 and 2231.
+
+### mime-types 3.x
+
+Users are encouraged to upgrade to mime-types 3.x as soon as is practical.
+mime-types 3.x requires Ruby 2.0 compatibility and a simpler licensing scheme.
+
+## Synopsis
+
+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.
+
+```ruby
+require 'mime/types'
+
+plaintext = MIME::Types['text/plain'] # => [ text/plain ]
+text = plaintext.first
+puts text.media_type            # => 'text'
+puts text.sub_type              # => 'plain'
+
+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              # => 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.provisional?          # => false
+puts text.complete?             # => true
+
+puts text                       # => 'text/plain'
+
+puts text == 'text/plain'       # => true
+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'
+
+xwingz = MIME::Types['application/x-Wingz'].first # => application/x-Wingz
+puts xwingz.content_type        # => 'application/x-Wingz'
+puts xwingz.simplified          # => 'application/x-wingz'
+```
+
+### Columnar Store
+
+mime-types uses as its primary registry storage format a columnar storage format
+reducing the default memory footprint. This is done by selectively loading the
+data on a per-attribute basis. When the registry is first loaded from the
+columnar store, only the canonical MIME content type and known extensions and
+the MIME type will be connected to its loading registry. When other data about
+the type is required (including `preferred_extension`, `obsolete?`, and
+`registered?`) that data is loaded from its own column file for all types in the
+registry.
+
+The load of any column data is performed with a Mutex to ensure that types are
+updated safely in a multithreaded environment. Benchmarks show that while
+columnar data loading is slower than the JSON store, it cuts the memory use by a
+third over the JSON store.
+
+If you prefer to load all the data at once, this can be specified in your
+application Gemfile as:
+
+```ruby
+gem 'mime-types', require: 'mime/types/full'
+```
+
+Projects that do not use Bundler should `require` the same:
+
+```ruby
+require 'mime/types/full'
+```
+
+Libraries that use mime-types are discouraged from choosing the JSON store.
+
+For applications and clients that used mime-types 2.6 when the columnar store
+was introduced, the require used previously will still work through at least
+[version 4][pull-96-comment] and possibly beyond; it is effectively an empty
+operation. You are recommended to change your Gemfile as soon as is practical.
+
+```ruby
+require 'mime/types/columnar'
+```
+
+Note that MIME::Type::Columnar and MIME::Types::Columnar are considered private
+variant implementations of MIME::Type and MIME::Types and the specific
+implementation should not be relied upon by consumers of the mime-types library.
+Instead, depend on the public implementations (MIME::Type and MIME::Types) only.
+
+### Cached Storage
+
+mime-types supports a cache of MIME types using `Marshal.dump`. The cache is
+invalidated for each version of the mime-types-data gem so that data version
+3.2015.1201 will not be reused with data version 3.2016.0101. If the environment
+variable `RUBY_MIME_TYPES_CACHE` is set to a cache file, mime-types will attempt
+to load the MIME type registry from the cache file. If it cannot, it will load
+the types normally and then saves the registry to the cache file.
+
+The caching works with both full stores and columnar stores. Only the data that
+has been loaded prior to saving the cache will be stored.
+
+## mime-types Modified Semantic Versioning
+
+The mime-types library has one version number, but this single version number
+tracks both API changes and registry data changes; this is not wholly compatible
+with all aspects of [Semantic Versioning][semver]; removing a MIME type from the
+registry _could_ be considered a breaking change under some interpretations of
+semantic versioning (as lookups for that particular type would no longer work by
+default).
+
+mime-types itself uses a modified semantic versioning scheme. Given the version
+`MAJOR.MINOR`:
+
+1. If an incompatible API (code) change is made, the `MAJOR` version will be
+   incremented and both `MINOR` and `PATCH` will be set to zero. Major version
+   updates will also generally break Ruby version compatibility guarantees.
+
+2. If an API (code) feature is added that does not break compatibility, the
+   `MINOR` version will be incremented and `PATCH` will be set to zero.
+
+3. If there is a bug fix to a feature added in the most recent `MAJOR.MINOR`
+   release, the `PATCH` value will be incremented.
+
+In practical terms, there will be fewer releases of mime-types focussing on
+features because of the existence of the [mime-types-data][data] gem, and if
+features are marked deprecated in the course of mime-types 3.x, they will not be
+removed until mime-types 4.x or possibly later.
+
+[pull-96-comment]: https://github.com/mime-types/ruby-mime-types/pull/96#issuecomment-100725400
+[semver]: https://semver.org
+[data]: https://github.com/mime-types/mime-types-data
+[ci-badge]: https://github.com/mime-types/ruby-mime-types/actions/workflows/ci.yml/badge.svg
+[ci-workflow]: https://github.com/mime-types/ruby-mime-types/actions/workflows/ci.yml
+[coveralls-badge]: https://coveralls.io/repos/mime-types/ruby-mime-types/badge.svg?branch=main&service=github
+[coveralls]: https://coveralls.io/github/mime-types/ruby-mime-types?branch=main
+[registry]: https://www.iana.org/assignments/media-types/media-types.xhtml

data/Rakefile

@@ -1,41 +1,74 @@
 require "rubygems"
 require "hoe"
 require "rake/clean"
+require "minitest"
+require "minitest/test_task"
 
-Hoe.plugin :cov
-Hoe.plugin :doofus
-Hoe.plugin :gemspec2
-Hoe.plugin :git2
-Hoe.plugin :minitest
+Hoe.plugin :halostatue
 Hoe.plugin :rubygems
 
+Hoe.plugins.delete :debug
+Hoe.plugins.delete :newb
+Hoe.plugins.delete :publish
+Hoe.plugins.delete :signing
+Hoe.plugins.delete :test
+
 spec = Hoe.spec "mime-types" do
   developer("Austin Ziegler", "halostatue@gmail.com")
 
-  self.history_file = "History.md"
-  self.readme_file = "README.rdoc"
-
-  license "MIT"
+  self.trusted_release = ENV["rubygems_release_gem"] == "true"
 
   require_ruby_version ">= 2.0"
 
-  spec_extras[:metadata] = ->(val) { val["rubygems_mfa_required"] = "true" }
+  license "MIT"
+
+  spec_extras[:metadata] = ->(val) {
+    val.merge!({"rubygems_mfa_required" => "true"})
+  }
 
-  extra_deps << ["mime-types-data", "~> 3.2015"]
+  extra_deps << ["mime-types-data", "~> 3.2025", ">= 3.2025.0507"]
+  extra_deps << ["logger", ">= 0"]
 
-  extra_dev_deps << ["hoe", ">= 3.0", "< 5"]
-  extra_dev_deps << ["hoe-doofus", "~> 1.0"]
-  extra_dev_deps << ["hoe-gemspec2", "~> 1.1"]
-  extra_dev_deps << ["hoe-git2", "~> 1.7"]
+  extra_dev_deps << ["hoe", "~> 4.0"]
+  extra_dev_deps << ["hoe-halostatue", "~> 2.0"]
   extra_dev_deps << ["hoe-rubygems", "~> 1.0"]
   extra_dev_deps << ["minitest", "~> 5.0"]
   extra_dev_deps << ["minitest-autotest", "~> 1.0"]
   extra_dev_deps << ["minitest-focus", "~> 1.0"]
   extra_dev_deps << ["minitest-hooks", "~> 1.4"]
-  extra_dev_deps << ["rake", ">= 10.0", "< 14.0"]
+  extra_dev_deps << ["rake", ">= 10.0", "< 14"]
+  extra_dev_deps << ["rdoc", ">= 0.0"]
   extra_dev_deps << ["standard", "~> 1.0"]
 end
 
+Minitest::TestTask.create :test
+Minitest::TestTask.create :coverage do |t|
+  formatters = <<-RUBY.split($/).join(" ")
+    SimpleCov::Formatter::MultiFormatter.new([
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::LcovFormatter,
+      SimpleCov::Formatter::SimpleFormatter
+    ])
+  RUBY
+  t.test_prelude = <<-RUBY.split($/).join("; ")
+  require "simplecov"
+  require "simplecov-lcov"
+
+  SimpleCov::Formatter::LcovFormatter.config do |config|
+    config.report_with_single_file = true
+    config.lcov_file_name = "lcov.info"
+  end
+
+  SimpleCov.start "test_frameworks" do
+    enable_coverage :branch
+    primary_coverage :branch
+    formatter #{formatters}
+  end
+  RUBY
+end
+
+task default: :test
+
 namespace :benchmark do
   task :support do
     %w[lib support].each { |path|
@@ -52,39 +85,9 @@ namespace :benchmark do
     )
   end
 
-  desc "Allocation counts"
-  task :allocations, [:top_x, :mime_types_only] => "benchmark:support" do |_, args|
-    require "benchmarks/load_allocations"
-    Benchmarks::LoadAllocations.report(
-      top_x: args.top_x,
-      mime_types_only: args.mime_types_only
-    )
-  end
-
-  desc "Columnar allocation counts"
-  task "allocations:columnar", [:top_x, :mime_types_only] => "benchmark:support" do |_, args|
-    require "benchmarks/load_allocations"
-    Benchmarks::LoadAllocations.report(
-      columnar: true,
-      top_x: args.top_x,
-      mime_types_only: args.mime_types_only
-    )
-  end
-
-  desc "Columnar allocation counts (full load)"
-  task "allocations:columnar:full", [:top_x, :mime_types_only] => "benchmark:support" do |_, args|
-    require "benchmarks/load_allocations"
-    Benchmarks::LoadAllocations.report(
-      columnar: true,
-      top_x: args.top_x,
-      mime_types_only: args.mime_types_only,
-      full: true
-    )
-  end
-
   desc "Memory profiler"
   task :memory, [:top_x, :mime_types_only] => "benchmark:support" do |_, args|
-    require "benchmarks/memory_profiler"
+    require "benchmarks/profile_memory"
     Benchmarks::ProfileMemory.report(
       mime_types_only: args.mime_types_only,
       top_x: args.top_x
@@ -93,7 +96,7 @@ namespace :benchmark do
 
   desc "Columnar memory profiler"
   task "memory:columnar", [:top_x, :mime_types_only] => "benchmark:support" do |_, args|
-    require "benchmarks/memory_profiler"
+    require "benchmarks/profile_memory"
     Benchmarks::ProfileMemory.report(
       columnar: true,
       mime_types_only: args.mime_types_only,
@@ -103,7 +106,7 @@ namespace :benchmark do
 
   desc "Columnar allocation counts (full load)"
   task "memory:columnar:full", [:top_x, :mime_types_only] => "benchmark:support" do |_, args|
-    require "benchmarks/memory_profiler"
+    require "benchmarks/profile_memory"
     Benchmarks::ProfileMemory.report(
       columnar: true,
       full: true,
@@ -132,53 +135,19 @@ namespace :benchmark do
 end
 
 namespace :profile do
-  directory "tmp/profile"
-
-  CLEAN.add "tmp"
-
-  def ruby_prof(script)
-    require "pathname"
-    output = Pathname("tmp/profile").join(script)
-    output.mkpath
-    script = Pathname("support/profile").join("#{script}.rb")
-
-    args = [
-      "-W0",
-      "-Ilib",
-      "-S", "ruby-prof",
-      "-R", "mime/types",
-      "-s", "self",
-      "-p", "multi",
-      "-f", output.to_s,
-      script.to_s
-    ]
-    ruby args.join(" ")
+  task full: "benchmark:support" do
+    require "profile"
+    profile_full
   end
 
-  task full: "tmp/profile" do
-    ruby_prof "full"
+  task columnar: "benchmark:support" do
+    require "profile"
+    profile_columnar
   end
 
-  task columnar: :support do
-    ruby_prof "columnar"
-  end
-
-  task "columnar:full" => :support do
-    ruby_prof "columnar_full"
-  end
-end
-
-if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.0")
-  namespace :test do
-    desc "Run test coverage"
-    task :coverage do
-      spec.test_prelude = [
-        'require "simplecov"',
-        'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
-        'gem "minitest"'
-      ].join("; ")
-      Rake::Task["test"].execute
-    end
+  task "columnar:full" => "benchmark:support" do
+    require "profile"
+    profile_columnar_full
   end
 end
 
@@ -209,6 +178,11 @@ namespace :convert do
   task docs: "convert:docs:run"
 end
 
+task :version do
+  require "mime/types/version"
+  puts MIME::Types::VERSION
+end
+
 namespace :deps do
   task :top, [:number] => "benchmark:support" do |_, args|
     require "deps"
@@ -225,5 +199,3 @@ task :console do
     abort
   end
 end
-
-# vim: syntax=ruby

data/SECURITY.md

@@ -0,0 +1,7 @@
+# mime-types Security
+
+## Security contact information
+
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security). Tidelift will
+coordinate the fix and disclosure.

data/lib/mime/type/columnar.rb

@@ -15,8 +15,10 @@ require "mime/type"
 class MIME::Type::Columnar < MIME::Type
   def initialize(container, content_type, extensions) # :nodoc:
     @container = container
+    @__priority_penalty = nil
     self.content_type = content_type
-    self.extensions = extensions
+    @extensions = Set[*Array(extensions).flatten.compact].freeze
+    clear_sort_priority
   end
 
   def self.column(*methods, file: nil) # :nodoc:
@@ -51,6 +53,17 @@ class MIME::Type::Columnar < MIME::Type
     super
   end
 
+  def update_sort_priority
+    if @container.__fully_loaded?
+      super
+    else
+      obsolete = (@__sort_priority & (1 << 7)) != 0
+      registered = (@__sort_priority & (1 << 5)) == 0
+
+      @__priority_penalty = (obsolete ? 3 : 0) + (registered ? 0 : 2)
+    end
+  end
+
   class << self
     undef column
   end