summaryrefslogtreecommitdiff
path: root/History.md
blob: 6f5f364e853564edbeb9b854334ac8aa2e61a9a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
## 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][]) and Jun Aruga ([#125][]).

    *   Fixed test 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 reindex 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
[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