mime-types 3.3.1

data/Licence.md

@@ -0,0 +1,25 @@
+## Licence
+
+*   Copyright 2003–2019 Austin Ziegler and contributors.
+
+The software in this repository is made available under the MIT license.
+
+### 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:
+
+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.

data/Manifest.txt

@@ -0,0 +1,31 @@
+Code-of-Conduct.md
+Contributing.md
+History.md
+Licence.md
+Manifest.txt
+README.rdoc
+Rakefile
+lib/mime-types.rb
+lib/mime/type.rb
+lib/mime/type/columnar.rb
+lib/mime/types.rb
+lib/mime/types/_columnar.rb
+lib/mime/types/cache.rb
+lib/mime/types/columnar.rb
+lib/mime/types/container.rb
+lib/mime/types/deprecations.rb
+lib/mime/types/full.rb
+lib/mime/types/loader.rb
+lib/mime/types/logger.rb
+lib/mime/types/registry.rb
+test/bad-fixtures/malformed
+test/fixture/json.json
+test/fixture/old-data
+test/fixture/yaml.yaml
+test/minitest_helper.rb
+test/test_mime_type.rb
+test/test_mime_types.rb
+test/test_mime_types_cache.rb
+test/test_mime_types_class.rb
+test/test_mime_types_lazy.rb
+test/test_mime_types_loader.rb

data/README.rdoc

@@ -0,0 +1,193 @@
+= mime-types for Ruby
+
+home :: https://github.com/mime-types/ruby-mime-types/
+code :: https://github.com/mime-types/ruby-mime-types/
+bugs :: https://github.com/mime-types/ruby-mime-types/issues
+rdoc :: http://rdoc.info/gems/mime-types/
+clog :: https://github.com/mime-types/ruby-mime-types/blob/master/History.md
+continuous integration :: {<img src="https://travis-ci.org/mime-types/ruby-mime-types.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/mime-types/ruby-mime-types]
+test coverage :: {<img src="https://coveralls.io/repos/mime-types/ruby-mime-types/badge.svg?branch=master&service=github" alt="Coverage Status" />}[https://coveralls.io/github/mime-types/ruby-mime-types?branch=master]
+
+== 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}[https://github.com/mime-types/mime-types-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}[https://www.iana.org/assignments/media-types/media-types.xhtml], 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.
+
+   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.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+,
+<tt>obsolete?</tt>, and <tt>registered?</tt>) 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:
+
+   gem 'mime-types', require: 'mime/types/full'
+
+Projects that do not use Bundler should +require+ the same:
+
+   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}[https://github.com/mime-types/ruby-mime-types/pull/96#issuecomment-100725400]
+and possibly beyond; it is effectively an empty operation. You are recommended
+to change your Gemfile as soon as is practical.
+
+   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 <tt>Marshal.dump</tt>. 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}[http://semver.org/];
+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 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, MINOR will be set to zero, and PATCH will be reset to the
+   implied zero.
+
+2. If an API (code) feature is added that does not break compatibility, the
+   MINOR version will be incremented and PATCH will be reset to the implied zero.
+
+3. If there is a bugfix to a feature added in the most recent MAJOR.MINOR
+   release, the implied PATCH value will be incremented resulting in
+   MAJOR.MINOR.PATCH.
+
+In practical terms, there will be fewer releases of mime-types focussing on
+features because of the existence of the [mime-types-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.
+
+{Code of Conduct}[Code-of-Conduct_md.html]
+
+{Contributing}[Contributing_md.html]
+
+{Licence}[Licence_md.html]

data/Rakefile

@@ -0,0 +1,284 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'hoe'
+require 'rake/clean'
+
+Hoe.plugin :doofus
+Hoe.plugin :gemspec2
+Hoe.plugin :git
+Hoe.plugin :minitest
+Hoe.plugin :travis
+Hoe.plugin :email unless ENV['CI'] or ENV['TRAVIS']
+
+spec = Hoe.spec 'mime-types' do
+  developer('Austin Ziegler', 'halostatue@gmail.com')
+  self.need_tar = true
+
+  require_ruby_version '>= 2.0'
+
+  self.history_file = 'History.md'
+  self.readme_file = 'README.rdoc'
+
+  license 'MIT'
+
+  extra_deps << ['mime-types-data', '~> 3.2015']
+
+  extra_dev_deps << ['hoe-doofus', '~> 1.0']
+  extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
+  extra_dev_deps << ['hoe-git', '~> 1.6']
+  extra_dev_deps << ['hoe-rubygems', '~> 1.0']
+  extra_dev_deps << ['hoe-travis', '~> 1.2']
+  extra_dev_deps << ['minitest', '~> 5.4']
+  extra_dev_deps << ['minitest-autotest', '~> 1.0']
+  extra_dev_deps << ['minitest-focus', '~> 1.0']
+  extra_dev_deps << ['minitest-bonus-assertions', '~> 3.0']
+  extra_dev_deps << ['minitest-hooks', '~> 1.4']
+  extra_dev_deps << ['rake', '>= 10.0', '< 13.0']
+  extra_dev_deps << ['fivemat', '~> 1.3']
+  extra_dev_deps << ['minitest-rg', '~> 5.2']
+
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.0')
+    extra_dev_deps << ['simplecov', '~> 0.7']
+    # if ENV['CI'] or ENV['TRAVIS']
+    #   extra_dev_deps << ['coveralls', '~> 0.8']
+    # end
+  end
+end
+
+namespace :benchmark do
+  task :support do
+    %w(lib support).each { |path|
+      $LOAD_PATH.unshift(File.join(Rake.application.original_dir, path))
+    }
+  end
+
+  desc 'Benchmark Load Times'
+  task :load, [:repeats] => 'benchmark:support' do |_, args|
+    require 'benchmarks/load'
+    Benchmarks::Load.report(
+      File.join(Rake.application.original_dir, 'lib'),
+      args.repeats
+    )
+  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'
+    Benchmarks::ProfileMemory.report(
+      mime_types_only: args.mime_types_only,
+      top_x: args.top_x
+    )
+  end
+
+  desc 'Columnar memory profiler'
+  task 'memory:columnar', [:top_x, :mime_types_only] => 'benchmark:support' do |_, args|
+    require 'benchmarks/memory_profiler'
+    Benchmarks::ProfileMemory.report(
+      columnar: true,
+      mime_types_only: args.mime_types_only,
+      top_x: args.top_x
+    )
+  end
+
+  desc 'Columnar allocation counts (full load)'
+  task 'memory:columnar:full', [:top_x, :mime_types_only] => 'benchmark:support' do |_, args|
+    require 'benchmarks/memory_profiler'
+    Benchmarks::ProfileMemory.report(
+      columnar: true,
+      full: true,
+      top_x: args.top_x,
+      mime_types_only: args.mime_types_only
+    )
+  end
+
+  desc 'Object counts'
+  task objects: 'benchmark:support' do
+    require 'benchmarks/object_counts'
+    Benchmarks::ObjectCounts.report
+  end
+
+  desc 'Columnar object counts'
+  task 'objects:columnar' => 'benchmark:support' do
+    require 'benchmarks/object_counts'
+    Benchmarks::ObjectCounts.report(columnar: true)
+  end
+
+  desc 'Columnar object counts (full load)'
+  task 'objects:columnar:full' => 'benchmark:support' do
+    require 'benchmarks/object_counts'
+    Benchmarks::ObjectCounts.report(columnar: true, full: true)
+  end
+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(' ')
+  end
+
+  task full: 'tmp/profile' do
+    ruby_prof 'full'
+  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
+    # Coveralls needs to be disabled for now because it transitively depends on
+    # an earlier version of mime-types.
+    # if ENV['CI'] or ENV['TRAVIS']
+    #   task :coveralls do
+    #     spec.test_prelude = [
+    #       'require "psych"',
+    #       'require "simplecov"',
+    #       'require "coveralls"',
+    #       'SimpleCov.formatter = Coveralls::SimpleCov::Formatter',
+    #       'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
+    #       'gem "minitest"'
+    #     ].join('; ')
+    #     Rake::Task['test'].execute
+    #   end
+
+    #   Rake::Task['travis'].prerequisites.replace(%w(test:coveralls))
+    # end
+
+    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
+  end
+end
+
+namespace :convert do
+  namespace :docs do
+    task :setup do
+      gem 'rdoc'
+      require 'rdoc/rdoc'
+      @doc_converter ||= RDoc::Markup::ToMarkdown.new
+    end
+
+    FileList['*.rdoc'].each do |name|
+      rdoc = name
+      mark = "#{File.basename(name, '.rdoc')}.md"
+
+      file mark => [rdoc, :setup] do |t|
+        puts "#{rdoc} => #{mark}"
+        File.open(t.name, 'wb') { |target|
+          target.write @doc_converter.convert(IO.read(t.prerequisites.first))
+        }
+      end
+
+      CLEAN.add mark
+
+      task run: [mark]
+    end
+  end
+
+  desc 'Convert documentation from RDoc to Markdown'
+  task docs: 'convert:docs:run'
+end
+
+task 'deps:top', [:number] do |_, args|
+  require 'net/http'
+  require 'json'
+
+  def rubygems_get(gem_name: '', endpoint: '')
+    path = File.join('/api/v1/gems/', gem_name, endpoint).chomp('/') + '.json'
+    Net::HTTP.start('rubygems.org', use_ssl: true) do |http|
+      JSON.parse(http.get(path).body)
+    end
+  end
+
+  results = rubygems_get(
+    gem_name: 'mime-types',
+    endpoint: 'reverse_dependencies'
+  )
+
+  weighted_results = {}
+  results.each do |name|
+    begin
+      weighted_results[name] = rubygems_get(gem_name: name)['downloads']
+    rescue => e
+      puts "#{name} #{e.message}"
+    end
+  end
+
+  weighted_results.sort { |(_k1, v1), (_k2, v2)|
+    v2 <=> v1
+  }.first(args.number || 50).each_with_index do |(k, v), i|
+    puts "#{i}) #{k}: #{v}"
+  end
+end
+
+task :console do
+  arguments = %w(pry)
+  arguments.push(*spec.spec.require_paths.map { |dir| "-I#{dir}" })
+  arguments.push("-r#{spec.spec.name.gsub('-', File::SEPARATOR)}")
+  unless system(*arguments)
+    error "Command failed: #{show_command}"
+    abort
+  end
+end
+
+# vim: syntax=ruby