summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAustin Ziegler <austin@zieglers.ca>2021-01-17 00:52:31 -0500
committerAustin Ziegler <austin@zieglers.ca>2021-01-17 00:52:31 -0500
commita2ac225986b45b6b216f9047ec0f128f9c0bdd51 (patch)
tree1cc7a4343b640ed19d79d923905c6cdd403bf322
parent4cc6ef8fac112080f89acca357d7b6e0272dd553 (diff)
downloadmime-types-a2ac225986b45b6b216f9047ec0f128f9c0bdd51.tar.gz
Administrivia:
- Added Ruby 3.0 to the CI test matrix. Added `windows/jruby` to the CI exclusion list; it refuses to run successfully. - Update History.md and Contributing.md documentation with the most recent updates in a `NEXT` release (there are no changes as of yet that require a new release).
-rw-r--r--.github/workflows/ci.yml5
-rw-r--r--Contributing.md13
-rw-r--r--History.md66
3 files changed, 56 insertions, 28 deletions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 7c83bf6..4be556e 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -26,6 +26,7 @@ jobs:
- 2.5
- 2.6
- 2.7
+ - 3.0
- head
- debug
- mingw
@@ -46,6 +47,10 @@ jobs:
- os: windows
ruby: debug
- os: windows
+ ruby: jruby
+ - os: windows
+ ruby: jruby-head
+ - os: windows
ruby: truffleruby
- os: windows
ruby: truffleruby-head
diff --git a/Contributing.md b/Contributing.md
index 405c09b..56d4df5 100644
--- a/Contributing.md
+++ b/Contributing.md
@@ -6,11 +6,11 @@ request, or code contributions.
There are a few guidelines for contributing to mime-types:
- Code changes _will_ _not_ be accepted without tests. The test suite is
- written with [minitest][].
+ written with [minitest].
- Match my coding style.
- Use a thoughtfully-named topic branch that contains your change. Rebase your
commits into logical chunks as necessary.
-- Use [quality commit messages][].
+- Use [quality commit messages].
- Do not change the version number; when your patch is accepted and a release
is made, the version will be updated at that point.
- Submit a GitHub pull request with your changes.
@@ -19,11 +19,11 @@ There are a few guidelines for contributing to mime-types:
## Adding or Modifying MIME Types
The mime-types registry is no longer contained in mime-types, but in
-[mime-types-data][]. Please see that project for contributions there.
+[mime-types-data]. Please see that project for contributions there.
### Test Dependencies
-mime-types uses Ryan Davis’s [Hoe][] to manage the release process, and it adds
+mime-types uses Ryan Davis’s [Hoe] to manage the release process, and it adds
a number of rake tasks. You will mostly be interested in `rake`, which runs
the tests the same way that `rake test` or `rake travis` will do.
@@ -52,7 +52,7 @@ built-in benchmark library:
There are two allocation tracing benchmarks (for normal and columnar loads).
These can only be run on Ruby 2.1 or better and requires the
-[allocation\_tracer][] gem (not installed by default).
+[allocation\_tracer] gem (not installed by default).
- `rake benchmark:allocations`
- `rake benchmark:allocations:columnar`
@@ -101,6 +101,7 @@ Thanks to everyone else who has contributed to mime-types over the years:
- Greg Brockman
- Hans de Graaff
- Henrik Hodne
+- Igor Victor
- Janko Marohnić
- Jean Boussier
- Jeremy Evans
@@ -109,6 +110,8 @@ Thanks to everyone else who has contributed to mime-types over the years:
- Łukasz Śliwa
- Keerthi Siva
- Ken Ip
+- Kevin Menard
+- Koichi ITO
- Martin d'Allens
- Mauricio Linhares
- Nicolas Leger
diff --git a/History.md b/History.md
index ca8ef20..cde0aa4 100644
--- a/History.md
+++ b/History.md
@@ -1,5 +1,21 @@
# Changelog
+## NEXT / 2021-MM-DD
+
+- 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].
+
## 3.3.1 / 2019-12-26
- 1 minor bugfix:
@@ -8,12 +24,12 @@
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][]
+ been resolved. [#146]
- Administrivia:
- Olle Jonsson removed an outdated Travis configuration option (`sudo:
- false`). [#142][]
+ false`). [#142]
## 3.3 / 2019-09-04
@@ -22,16 +38,16 @@
- 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][]
+ Ruby. [#141]
- Administrivia:
- - Nicholas La Roux updated Travis build configurations. [#139][]
+ - 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][]
+ producing v3.2.1. [#137]
## 3.2.1 / 2018-08-12
@@ -46,22 +62,22 @@
- 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][]
+ 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][]
+ string allocations. [#135]
- 2 bug fixes
- - Burke Libbey fixed a problem with cached data loading. [#126][]
+ - 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][].
+ 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
@@ -70,7 +86,7 @@
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][]
+ registry would grow uncontrollably. [#136]
- Deprecations:
@@ -83,12 +99,12 @@
- 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][]).
+ - 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
+ 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
@@ -99,18 +115,18 @@
- 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][].
+ 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.
+ 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
+ - 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
@@ -125,22 +141,22 @@
- 2 governance changes
- This project and the related mime-types-data project are now exclusively
- MIT licensed. Resolves [#95][].
+ 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.
+ 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][].
+ [#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][].
+ [mime-types-data].
- 17 minor changes:
@@ -164,7 +180,7 @@
- When extensions are set or modified with `add_extensions`, the primary
registry will be informed of a need to reindex extensions. Resolves
- [#84][].
+ [#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
@@ -187,7 +203,7 @@
- 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][].
+ to prevent data duplication. Resolves [#79].
- `MIME::Types::Cache` changes:
@@ -206,7 +222,7 @@
- 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][].
+ 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
@@ -231,6 +247,10 @@
[#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
[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