mime-types 3.5.2 → 3.7.0

data/History.md

@@ -1,335 +0,0 @@
-# Changelog
-
-## 3.5.2 / 2024-01-02
-
-There are no primary code changes, but we are releasing this as an update as
-there are some validation changes and updated code with formatting.
-
-- Dependency and CI updates:
-
-  - Masato Nakamura added Ruby 3.3 to the CI workflow in [#179][].
-
-  - Fixed regressions in standard formatting in [#180][].
-
-  - Removed `minitest-bonus-assertions` because of a bundler resolution issue.
-    Created a better replacement in-line.
-
-## 3.5.1 / 2023-08-21
-
-- 1 bug fix:
-
-  - Better handle possible line-termination strings (legal in Unix filenames)
-    such as `\n` in `MIME::Types.type_for`. Reported by ooooooo-q in [#177][],
-    resolved in [#178][].
-
-## 3.5.0 / 2023-08-07
-
-- 1 minor enhancement:
-
-  - Robb Shecter changed the default log level for duplicate type variant from
-    `warn` to `debug` in [#170][]. This works because `MIME::Types.logger` is
-    intended to fit the `::Logger` interface, and the default logger
-    (`WarnLogger`) is a subclass of `::Logger` that passes through to
-    `Kernel.warn`.
-
-    - Further consideration has changed cache load messages from `warn` to
-      `error` and deprecation messages from `warn` to `debug`.
-
-- 1 bug fix:
-
-  - Added a definition of `MIME::Type#hash`. Contributed by Alex Vondrak in
-    [#167][], fixing [#166][].
-
-- Dependency and CI updates:
-
-  - Update the .github/workflows/ci.yml workflow to test Ruby 3.2 and more
-    reliably test certain combinations rather than depending on exclusions.
-
-  - Change `.standard.yml` configuration to format for Ruby 2.3 as certain files
-    are not properly detected with Ruby 2.0.
-
-    - Change from `hoe-git` to `hoe-git2` to support Hoe version 4.
-
-    - Apply `standardrb --fix`.
-
-    - The above changes have resulted in the Soft deprecation of Ruby versions
-      below 2.6. Any errors reported for Ruby versions 2.0, 2.1, 2.2, 2.3, 2.4,
-      and 2.5 will be resolved, but maintaining CI for these versions is
-      unsustainable.
-
-## 3.4.1 / 2021-11-16
-
-- 1 bug fix:
-
-  - Fixed a Ruby < 2.3 incompatibility introduced by the use of standardrb,
-    where `<<-` heredocs were converted to `<<~` heredocs. These have been
-    reverted back to `<<-` with the indentation kept and a `.strip` call
-    to prevent excess whitespace.
-
-## 3.4.0 / 2021-11-15
-
-- 1 minor enhancement:
-
-  - Added a new field to `MIME::Type` for checking provisional registrations
-    from IANA. [#157]
-
-- Documentation:
-
-  - Kevin Menard synced the documentation so that all examples are correct.
-    [#153]
-
-- Administrivia:
-
-  - Added Ruby 3.0 to the CI test matrix. Added `windows/jruby` to the
-    CI exclusion list; it refuses to run successfully.
-  - Removed the Travis CI configuration and changed it to Github Workflows
-    [#150][]. Removed Coveralls configuration.
-  - Igor Victor added TruffleRuby to the Travis CI configuration. [#149]
-  - Koichi ITO loosened an excessively tight dependency. [#147]
-  - Started using `standardrb` for Ruby formatting and validation.
-  - Moved `deps:top` functionality to a support file.
-
-## 3.3.1 / 2019-12-26
-
-- 1 minor bug fix:
-
-  - Al Snow fixed a warning with MIME::Types::Logger producing a warning
-    because Ruby 2.7 introduces numbered block parameters. Because of the way
-    that the MIME::Types::Logger works for deprecation messages, the
-    initializer parameters had been named `_1`, `_2`, and `_3`. This has now
-    been resolved. [#146]
-
-- Administrivia:
-
-  - Olle Jonsson removed an outdated Travis configuration option. [#142][]
-
-## 3.3 / 2019-09-04
-
-- 1 minor enhancement
-
-  - Jean Boussier reduced memory usage for Ruby versions 2.3 or higher by
-    interning various string values in each type. This is done with a
-    backwards-compatible call that _freezes_ the strings on older versions of
-    Ruby. [#141]
-
-- Administrivia:
-
-  - Nicholas La Roux updated Travis build configurations. [#139]
-
-## 3.2.2 / 2018-08-12
-
-- Hiroto Fukui removed a stray `debugger` statement that I had used in
-  producing v3.2.1. [#137]
-
-## 3.2.1 / 2018-08-12
-
-- A few bugs related to MIME::Types::Container and its use in the
-  mime-types-data helper tools reared their head because I released 3.2
-  before verifying against mime-types-data.
-
-## 3.2 / 2018-08-12
-
-- 2 minor enhancements
-
-  - Janko Marohnić contributed a change to `MIME::Type#priority_order` that
-    should improve on strict sorting when dealing with MIME types that appear
-    to be in the same family even if strict sorting would cause an
-    unregistered type to be sorted first. [#132]
-
-  - Dillon Welch contributed a change that added `frozen_string_literal: true`
-    to files so that modern Rubies can automatically reduce duplicate string
-    allocations. [#135]
-
-- 2 bug fixes
-
-  - Burke Libbey fixed a problem with cached data loading. [#126]
-
-  - Resolved an issue where Enumerable#inject returns `nil` when provided an
-    empty enumerable and a default value has not been provided. This is
-    because when Enumerable#inject isn't provided a starting value, the first
-    value is used as the default value. In every case where this error was
-    happening, the result was supposed to be an array containing Set objects
-    so they can be reduced to a single Set. [#117][], [#127][], [#134][]
-
-  - Fixed an uncontrolled growth bug in MIME::Types::Container where a key
-    miss would create a new entry with an empty Set in the container. This
-    was working as designed (this particular feature was heavily used during
-    MIME::Type registry construction), but the design was flawed in that it
-    did not have any way of determining the difference between construction
-    and querying. This would mean that, if you have a function in your web
-    app that queries the MIME::Types registry by extension, the extension
-    registry would grow uncontrollably. [#136]
-
-- Deprecations:
-
-  - Lazy loading (`$RUBY_MIME_TYPES_LAZY_LOAD`) has been deprecated.
-
-- Documentation Changes:
-
-  - Supporting files are now Markdown instead of rdoc, except for the README.
-
-  - The history file has been modified to remove all history prior to 3.0.
-    This history can be found in previous commits.
-
-  - A spelling error was corrected by Edward Betts ([#129][]).
-
-- Administrivia:
-
-  - CI configuration for more modern versions of Ruby were added by Nicolas
-    Leger ([#130][]), Jun Aruga ([#125][]), and Austin Ziegler. Removed
-    ruby-head-clang and rbx (Rubinius) from CI.
-
-  - Fixed tests which were asserting equality against nil, which will become
-    an error in Minitest 6.
-
-## 3.1 / 2016-05-22
-
-- 1 documentation change:
-
-  - Tim Smith (@tas50) updated the build badges to be SVGs to improve
-    readability on high-density (retina) screens with pull request [#112][].
-
-- 3 bug fixes
-
-  - A test for `MIME::Types::Cache` fails under Ruby 2.3 because of frozen
-    strings, [#118][]. This has been fixed.
-
-  - The JSON data has been incorrectly encoded since the release of
-    mime-types 3 on the `xrefs` field, because of the switch to using a Set
-    to store cross-reference information. This has been fixed.
-
-  - A tentative fix for [#117][] has been applied, removing the only circular
-    require dependencies that exist (and for which there was code to prevent,
-    but the current fix is simpler). I have no way to verify this fix and
-    depending on how things are loaded by `delayed_job`, this fix may not be
-    sufficient.
-
-- 1 governance change
-
-  - Updated to Contributor Covenant 1.4.
-
-## 3.0 / 2015-11-21
-
-- 2 governance changes
-
-  - This project and the related mime-types-data project are now exclusively
-    MIT licensed. Resolves [#95][].
-
-  - All projects under the mime-types organization now have a standard code
-    of conduct adapted from the [Contributor Covenant][]. This text can be
-    found in the [Code-of-Conduct.md][] file.
-
-- 3 major changes
-
-  - All methods deprecated in mime-types 2.x have been removed.
-
-  - mime-types now requires Ruby 2.0 compatibility or later. Resolves
-    [#97][].
-
-  - The registry data has been removed from mime-types and put into
-    mime-types-data, maintained and released separately. It can be found at
-    [mime-types-data][].
-
-- 17 minor changes:
-
-  - `MIME::Type` changes:
-
-    - Changed the way that simplified types representations are created to
-      reflect the fact that `x-` prefixes are no longer considered special
-      according to IANA. A simplified MIME type is case-folded to lowercase.
-      A new keyword parameter, `remove_x_prefix`, can be provided to remove
-      `x-` prefixes.
-
-    - Improved initialization with an Array works so that extensions do not
-      need to be wrapped in another array. This means that
-      `%w(text/yaml yaml yml)` works in the same way that
-      `['text/yaml', %w(yaml yml)]` did (and still does).
-
-    - Changed `priority_compare` to conform with attributes that no longer
-      exist.
-
-    - Changed the internal implementation of extensions to use a frozen Set.
-
-    - When extensions are set or modified with `add_extensions`, the primary
-      registry will be informed of a need to re-index extensions. Resolves
-      [#84][].
-
-    - The preferred extension can be set explicitly. If not set, it will be
-      the first extension. If the preferred extension is not in the extension
-      list, it will be added.
-
-    - Improved how xref URLs are generated.
-
-    - Converted `obsolete`, `registered` and `signature` to `attr_accessors`.
-
-  - `MIME::Types` changes:
-
-    - Modified `MIME::Types.new` to track instances of `MIME::Types` so that
-      they can be told to reindex the extensions as necessary.
-
-    - Removed `data_version` attribute.
-
-    - Changed `#[]` so that the `complete` and `registered` flags are
-      keywords instead of a generic options parameter.
-
-    - Extracted the class methods to a separate file.
-
-    - Changed the container implementation to use a Set instead of an Array
-      to prevent data duplication. Resolves [#79][].
-
-  - `MIME::Types::Cache` changes:
-
-    - Caching is now based on the data gem version instead of the mime-types
-      version.
-
-    - Caching is compatible with columnar registry stores.
-
-  - `MIME::Types::Loader` changes:
-
-    - `MIME::Types::Loader::PATH` has been removed and replaced with
-      `MIME::Types::Data::PATH` from the mime-types-data gem. The environment
-      variable `RUBY_MIME_TYPES_DATA` is still used.
-
-    - Support for the long-deprecated mime-types v1 format has been removed.
-
-    - The registry is default loaded from the columnar store by default. The
-      internal format of the columnar store has changed; many of the boolean
-      flags are now loaded from a single file. Resolves [#85][].
-
-[#79]: https://github.com/mime-types/ruby-mime-types/pull/79
-[#84]: https://github.com/mime-types/ruby-mime-types/pull/84
-[#85]: https://github.com/mime-types/ruby-mime-types/pull/85
-[#95]: https://github.com/mime-types/ruby-mime-types/pull/95
-[#97]: https://github.com/mime-types/ruby-mime-types/pull/97
-[#112]: https://github.com/mime-types/ruby-mime-types/pull/112
-[#117]: https://github.com/mime-types/ruby-mime-types/issues/117
-[#118]: https://github.com/mime-types/ruby-mime-types/pull/118
-[#125]: https://github.com/mime-types/ruby-mime-types/pull/125
-[#126]: https://github.com/mime-types/ruby-mime-types/pull/126
-[#127]: https://github.com/mime-types/ruby-mime-types/issues/127
-[#129]: https://github.com/mime-types/ruby-mime-types/pull/129
-[#130]: https://github.com/mime-types/ruby-mime-types/pull/130
-[#127]: https://github.com/mime-types/ruby-mime-types/issues/127
-[#132]: https://github.com/mime-types/ruby-mime-types/pull/132
-[#134]: https://github.com/mime-types/ruby-mime-types/issues/134
-[#135]: https://github.com/mime-types/ruby-mime-types/pull/135
-[#136]: https://github.com/mime-types/ruby-mime-types/issues/136
-[#137]: https://github.com/mime-types/ruby-mime-types/pull/137
-[#139]: https://github.com/mime-types/ruby-mime-types/pull/139
-[#141]: https://github.com/mime-types/ruby-mime-types/pull/141
-[#142]: https://github.com/mime-types/ruby-mime-types/pull/142
-[#146]: https://github.com/mime-types/ruby-mime-types/pull/146
-[#147]: https://github.com/mime-types/ruby-mime-types/pull/147
-[#149]: https://github.com/mime-types/ruby-mime-types/pull/149
-[#150]: https://github.com/mime-types/ruby-mime-types/pull/150
-[#153]: https://github.com/mime-types/ruby-mime-types/pull/153
-[#166]: https://github.com/mime-types/ruby-mime-types/issues/166
-[#167]: https://github.com/mime-types/ruby-mime-types/pull/167
-[#170]: https://github.com/mime-types/ruby-mime-types/pull/170
-[#177]: https://github.com/mime-types/ruby-mime-types/issues/177
-[#178]: https://github.com/mime-types/ruby-mime-types/pull/178
-[#179]: https://github.com/mime-types/ruby-mime-types/pull/179
-[#180]: https://github.com/mime-types/ruby-mime-types/pull/180
-[code-of-conduct.md]: Code-of-Conduct_md.html
-[contributor covenant]: http://contributor-covenant.org
-[mime-types-data]: https://github.com/mime-types/mime-types-data

data/README.rdoc

@@ -1,194 +0,0 @@
-= 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://github.com/mime-types/ruby-mime-types/actions/workflows/ci.yml/badge.svg" alt="Build Status" />}[https://github.com/mime-types/ruby-mime-types/actions/workflows/ci.yml]
-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.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+,
-<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]