mime-types-data 3.2024.1203 → 3.2025.0204

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 194a6ab82a7dcc01105cc713335d21c302408686401d62e1f3f72639ec8eb3a8
-  data.tar.gz: f8a358b8ba3d7612698b4f7e06dd258fb0cd852e3d0a691f6194f26015b05c2b
+  metadata.gz: 840c446d1416a5c5cdce532c70a53873b135ea1006944a4f1fe31e0f27c122ac
+  data.tar.gz: 200600d2dc811ddf4bbb0dbff135779fdb51ffacb59b40aa47d07c7e4a432798
 SHA512:
-  metadata.gz: 5821e06aca5a7cf1a73874f786ff05c60d3e34a1db8231a9e4da0539b2865e2d3803ed5581034eb93436d67ee86db136f83f533144bcd5fbd953aa5974d0d080
-  data.tar.gz: 32dbb4179ef8c8958c27108b0b120a05cea87f7f59be2b1cf5c47cab32caeb803b574b0959779d0ddab73835ee398acb0853b08b8de4f2115472a70b5937304e
+  metadata.gz: 140991f337bbd821c48a2d0b34d4af0648139a672a751732a832b468ef2871aa902297e416b233ea8ac9654a6e45efd05ae0e0c7d93a59484df3e342b51aa8b1
+  data.tar.gz: 5dbbe997eeee3f8ddb232666a09037ad275f53b73d7ab6e68434838f258b28c433a408e22ab51659216debcbdfdf8415c8a94944f996c4dcfae1db1d990407db

data/{History.md → CHANGELOG.md}

@@ -2,6 +2,38 @@
 
 <!-- automatic-release -->
 
+## 3.2025.0204 / 2025-02-04
+
+- Updated the Apache and IANA media registry entries as of release date
+
+
+- Added the Changelog URL to the README so that RubyGems.org is updated with the
+  `changelog_uri` on release. Contributed by Mark Young in [#96][#96].
+
+- Fixed an issue with automated releases that added thousands of files because
+  `vendor/` was no longer ignored.
+
+- Fixed the automated release builder process to handle the case when the
+  `automatic-release` tag is followed by a `## NEXT / YYYY-MM-DD` header so that
+  changes merged normally are picked up on automatic releases. [#98][#98]
+
+## 3.2025.0107 / 2025-01-07
+
+- Updated the Apache and IANA media registry entries as of release date
+- Restructured documentation for how I prefer to manage Hoe projects now.
+- Reworked the Rakefile because all data updates are now managed by GitHub
+  Actions and should not be managed manually any longer.
+
+  - `rake release:prepare` now does the same work as `rake release:gha`, but
+    does not commit or create a pull request.
+
+  - `rake convert` no longer has any subtasks.
+
+  - `rake update` has been removed with no replacement.
+
+- Updated `.hoerc` to properly exclude `support/` and `types/` from the
+  manifest.
+
 ## 3.2024.1203 / 2024-12-03
 
 - Updated the Apache and IANA media registry entries as of release date
@@ -612,6 +644,8 @@
 [#55]: https://github.com/mime-types/mime-types-data/issues/55
 [#77]: https://github.com/mime-types/mime-types-data/pull/77
 [#81]: https://github.com/mime-types/mime-types-data/pull/81
+[#96]: https://github.com/mime-types/mime-types-data/pull/96
+[#98]: https://github.com/mime-types/mime-types-data/pull/98
 [rmt]: https://github.com/mime-types/ruby-mime-types
 [code of conduct]: Code-of-Conduct.md
 [mini_mime]: https://github.com/discourse/mini_mime/issues/41

data/CONTRIBUTING.md

@@ -0,0 +1,150 @@
+# Contributing
+
+Contribution to mime-types-data is encouraged in any form: a bug report, new
+MIME type definitions, or additional code to help manage the MIME types. There
+are a few DOs and DON'Ts for contributions.
+
+- DO:
+
+  - Keep the coding style that already exists for any updated Ruby code (support
+    or otherwise). I use [Standard Ruby][standardrb] for linting and formatting.
+
+  - Use thoughtfully-named topic branches for contributions. Rebase your commits
+    into logical chunks as necessary.
+
+  - Use [quality commit messages][qcm].
+
+  - Add your name or GitHub handle to `CONTRIBUTORS.md` and a record in the
+    `CHANGELOG.md` as a separate commit from your main change. (Follow the style
+    in the `CHANGELOG.md` and provide a link to your PR.)
+
+- DO NOT:
+
+  - Modify `VERSION` in `lib/mime/types/data.rb`. When your patch is accepted
+    and a release is made, the version will be updated at that point. Most
+    likely, once merged, your release will be rolled into the next automatic
+    release.
+
+  - Modify `mime-types-data.gemspec`; it is a generated file. (You _may_ use
+    `rake gemspec` to regenerate it if your change involves metadata related to
+    gem itself).
+
+  - Modify the `Gemfile`.
+
+  - Modify any files in `data/`. Any changes to be captured here will be
+    automatically updated on the next release.
+
+Although mime-types-data was extracted from the [Ruby mime-types][rmt] gem and
+the support files are written in Ruby, the _target_ of mime-types-data is any
+implementation that wishes to use the data as a MIME types registry, so I am
+particularly interested in tools that will create a mime-types-data package for
+other languages.
+
+## Adding or Modifying MIME Types
+
+The Ruby mime-types gem loads its data from files encoded in the `data`
+directory in this gem by loading `mime-types-data` and reading
+MIME::Types::Data::PATH. These files are compiled files from the collection of
+data in the `types` directory.
+
+> [!WARNING]
+>
+> Pull requests that include changes to files in `data/` will require amendment
+> to revert these files.
+
+New or modified MIME types should be edited in the appropriate YAML file under
+`types`. The format is as shown below for the `application/xml` MIME type in
+`types/application.yml`.
+
+```yaml
+- !ruby/object:MIME::Type
+  content-type: application/xml
+  encoding: 8bit
+  extensions:
+    - xml
+    - xsl
+  references:
+    - IANA
+    - RFC3023
+  xrefs:
+    rfc:
+      - rfc3023
+  registered: true
+```
+
+There are other fields that can be added, matching the fields discussed in the
+documentation for MIME::Type. Pull requests for MIME types should just contain
+the changes to the YAML files for the new or modified MIME types; I will convert
+the YAML files to JSON prior to a new release. I would rather not have to verify
+that the JSON matches the YAML changes, which is why it is not necessary to
+convert for the pull request.
+
+If you are making a change for a private fork, use `rake convert:yaml:json` to
+convert the YAML to JSON, or `rake convert:yaml:columnar` to convert it to the
+new columnar format.
+
+### Updating Types from the IANA or Apache Lists
+
+If you are maintaining a private fork and wish to update your copy of the MIME
+types registry used by this gem, you can do this with the rake tasks:
+
+```sh
+$ rake mime:iana
+$ rake mime:apache
+```
+
+#### A Note on Provisional Types
+
+Provisionally registered types from IANA are contained in the `types/*.yaml`
+files. Per IANA,
+
+> This registry, unlike some other provisional IANA registries, is only for
+> temporary use. Entries in this registry are either finalized and moved to the
+> main media types registry or are abandoned and deleted. Entries in this
+> registry are suitable for use for development and test purposes only.
+
+Provisional types are rewritten when updated, so pull requests to manually
+customize provisional types (such as with extensions) are considered lower
+priority. It is recommended that any updates required to the data be performed
+in your application if you require provisional types.
+
+## The Release Process
+
+The release process is almost completely automated, where upstream MIME types
+will be updated weekly (on Tuesdays) and be presented in a reviewable pull
+request. Once merged, I need to perform a release and the update is complete.
+
+If performing a manual release outside of the update cycle, the IANA updates
+should be performed manually.
+
+1. Review any outstanding issues or pull requests to see if anything needs to be
+   addressed. This is necessary because there is no automated source for
+   extensions for the thousands of MIME entries. (Suggestions and/or pull
+   requests for same would be deeply appreciated.)
+2. `bundle install`
+3. Review the changes to make sure that the changes are sane. The IANA data
+   source changes from time to time, resulting in big changes or even a broken
+   step 4. (The most recent change was the addition of the `font/*` top-level
+   category.)
+4. Write up the changes in `CHANGELOG.md`. If any PRs have been merged, these
+   should be noted specifically and contributions should be added in
+   `Contributing.md`.
+5. Commit the changes and push to GitHub.
+6. `bundle exec rake release VERSION=newversion`
+
+This is based on an issue [#18][#18].
+
+### Help Wanted
+
+I want to automate this even further. I am **not** switching from Hoe for
+release management, so the use of [rubygems/release-gem][release-gem] requires
+some care (perhaps by exporting `VERSION=$(rake version)` to the job), but
+assistance in getting this action going for an automated release would be
+greatly appreciated.
+
+[#18]: https://github.com/mime-types/mime-types-data/issues/18
+[hoe]: https://github.com/seattlerb/hoe
+[qcm]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[release-gem]: https://github.com/rubygems/release-gem
+[rmt]: https://github.com/mime-types/ruby-mime-types/
+[standardrb]: https://github.com/standardrb/standard

data/CONTRIBUTORS.md

@@ -0,0 +1,53 @@
+# Contributors
+
+- Austin Ziegler created mime-types.
+
+Thanks to everyone else who has contributed to mime-types:
+
+- Aaron Patterson
+- Aggelos Avgerinos
+- Alessio Parma
+- Alex Balhatchet
+- Andre Pankratz
+- Andrey Eremin
+- Andy Brody
+- Arnaud Meuret
+- Bradley Meck
+- Brandon Galbraith
+- Chris Gat
+- Chris Salzberg
+- David Genord
+- Eric Marden
+- Garret Alfert
+- Godfrey Chan
+- Greg Brockman
+- Hans de Graaff
+- Henrik Hodne
+- Jeremy Evans
+- John Gardner
+- Jon Sneyers
+- Jonas Petersen
+- Juanito Fatas
+- Keerthi Siva
+- Ken Ip
+- Łukasz Śliwa
+- Lucia
+- Mark Young
+- Martin d'Allens
+- Mauricio Linhares
+- Mohammed Gad
+- Myk Klemme
+- nycvotes-dev
+- Postmodern
+- Richard Hirner
+- Richard Hurt
+- Richard Schneeman
+- Robert Buchberger
+- Samuel Williams
+- Sergio Baptista
+- Shane Eskritt
+- Tao Guo
+- Thomas Leese
+- Tibor Szolár
+- Todd Carrico
+- Yoran Brondsema

data/{Licence.md → LICENCE.md}

@@ -1,6 +1,6 @@
 ## Licence
 
-- Copyright 2003–2024 Austin Ziegler and other contributors.
+- Copyright 2003–2025 Austin Ziegler and other contributors.
 
 The software in this repository is made available under the MIT license.
 

data/Manifest.txt

@@ -1,7 +1,8 @@
-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.md
 Rakefile
@@ -19,18 +20,3 @@ data/mime.use_instead.column
 data/mime.xrefs.column
 lib/mime-types-data.rb
 lib/mime/types/data.rb
-types/application.yaml
-types/audio.yaml
-types/chemical.yaml
-types/conference.yaml
-types/drawing.yaml
-types/example.yaml
-types/font.yaml
-types/haptics.yaml
-types/image.yaml
-types/message.yaml
-types/model.yaml
-types/multipart.yaml
-types/text.yaml
-types/video.yaml
-types/world.yaml

data/README.md

@@ -1,8 +1,9 @@
 # mime-types-data
 
 - home :: https://github.com/mime-types/mime-types-data/
-- code :: https://github.com/mime-types/mime-types-data/
 - issues :: https://github.com/mime-types/mime-types-data/issues
+- code :: https://github.com/mime-types/mime-types-data/
+- changelog :: https://github.com/mime-types/mime-types-data/blob/main/CHANGELOG.md
 
 ## Description
 
@@ -13,11 +14,11 @@ extensions to look up the likely MIME type definitions.
 
 ### About MIME Media Types
 
-MIME media types are used in MIME-compliant communications, as in e-mail or
-HTTP traffic, to indicate the type of content which is transmitted. The
-registry provided in mime-types-data contains detailed information about MIME
-entities. There are many types defined by RFCs and vendors, so the list is long
-but invariably; don't hesitate to offer additional type definitions for
+MIME media types are used in MIME-compliant communications, as in e-mail or HTTP
+traffic, to indicate the type of content which is transmitted. The registry
+provided in mime-types-data contains detailed information about MIME entities.
+There are many types defined by RFCs and vendors, so the list is long but
+invariably; don't hesitate to offer additional type definitions for
 consideration. 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.
@@ -26,20 +27,20 @@ contributions. It conforms to RFCs 2045 and 2231.
 
 This registry contains the MIME media types in four formats:
 
-- A YAML format matching the Ruby mime-types library objects (MIME::Type).
-  This is the primary user-editable format for developers. It is _not_
-  shipped with the gem due to size considerations.
+- A YAML format matching the Ruby mime-types library objects (MIME::Type). This
+  is the primary user-editable format for developers. It is _not_ shipped with
+  the gem due to size considerations.
 - A JSON format converted from the YAML format. Prior to Ruby mime-types 3.0,
   this was the main consumption format and is still recommended for any
-  implementation that does not wish to implement the columnar format, which
-  has a significant implementation effort cost.
-- An encoded text format splitting the data for each MIME type across
-  multiple files. This columnar data format reduces the minimal data load
-  substantially, resulting in a performance improvement at the cost of more
-  complex code for loading the data on-demand. This is the default format for
-  Ruby mime-types 3.0.
-- An encoded text format for use with [`mini_mime`][] (as of 3.2021.1108). This
-  can be enabled with:
+  implementation that does not wish to implement the columnar format, which has
+  a significant implementation effort cost.
+- An encoded text format splitting the data for each MIME type across multiple
+  files. This columnar data format reduces the minimal data load substantially,
+  resulting in a performance improvement at the cost of more complex code for
+  loading the data on-demand. This is the default format for Ruby mime-types
+  3.0.
+- An encoded text format for use with [`mini_mime`][minimime]. This can be
+  enabled with:
 
   ```ruby
   MiniMime::Configuration.ext_db_path =
@@ -50,24 +51,24 @@ This registry contains the MIME media types in four formats:
 
 ## mime-types-data Modified Semantic Versioning
 
-mime-types-data uses a heavily modified [Semantic Versioning][] scheme to
-indicate that the data formats compatibility based on a `SCHEMA` version and
-the date of the data update: `SCHEMA.YEAR.MONTHDAY`.
+mime-types-data uses a heavily modified [Semantic Versioning][semver] scheme to
+indicate that the data formats compatibility based on a `SCHEMA` version and the
+date of the data update: `SCHEMA.YEAR.MONTHDAY`.
 
 1. If an incompatible data format change is made to any of the supported
-   formts, `SCHEMA` will be incremented. The current `SCHEMA` is 3, supporting
+   formats, `SCHEMA` will be incremented. The current `SCHEMA` is 3, supporting
    the YAML, JSON, and columnar formats required for Ruby mime-types 3.0.
 
-2. When the data is updated, the `YEAR.MONTHDAY` combination will be updated.
-   An update on the last day of October 2015 would be written as `2015.1031`,
+2. When the data is updated, the `YEAR.MONTHDAY` combination will be updated. An
+   update on the last day of October 2015 would be written as `2015.1031`,
    resulting in the full version of `3.2015.1031`.
 
 3. If multiple versions of the data need to be released on the same day due to
-   error, there will be an additional `REVISION` field incremented on the end
-   of the version. Thus, if three revisions need to be published on October
-   31st, 2015, the last release would be `3.2015.1031.2` (remember that the
-   first release has an implied `0`.)
+   error, there will be an additional `REVISION` field incremented on the end of
+   the version. Thus, if three revisions need to be published on October 31st,
+   2015, the last release would be `3.2015.1031.2` (remember that the first
+   release has an implied `0`.)
 
 [registry]: https://www.iana.org/assignments/media-types/media-types.xhtml
-[semantic versioning]: http://semver.org/
-[`mini_mime`]: https://github.com/discourse/mini_mime
+[semver]: http://semver.org/
+[minimime]: https://github.com/discourse/mini_mime

data/Rakefile

@@ -4,51 +4,35 @@ require "rubygems"
 require "hoe"
 require "rake/clean"
 
-Hoe.plugin :doofus
-Hoe.plugin :gemspec2
-Hoe.plugin :git2
-Hoe.plugin :rubygems
+$LOAD_PATH.unshift("lib")
+$LOAD_PATH.unshift("support")
+
+Hoe.plugin :halostatue
+
+Hoe.plugins.delete :debug
+Hoe.plugins.delete :newb
+Hoe.plugins.delete :publish
+Hoe.plugins.delete :signing
 
 Hoe.spec "mime-types-data" do
   developer("Austin Ziegler", "halostatue@gmail.com")
 
-  self.history_file = "History.md"
-  self.readme_file = "README.md"
+  require_ruby_version ">= 2.0"
 
   license "MIT"
 
-  require_ruby_version ">= 2.0"
-
-  spec_extras[:metadata] = ->(val) { val["rubygems_mfa_required"] = "true" }
+  spec_extras[:metadata] = ->(val) {
+    val.merge!({"rubygems_mfa_required" => "true"})
+  }
 
   extra_dev_deps << ["hoe", "~> 4.0"]
-  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-rubygems", "~> 1.0"]
+  extra_dev_deps << ["hoe-halostatue", "~> 1.0"]
   extra_dev_deps << ["mime-types", ">= 3.4.0", "< 4"]
   extra_dev_deps << ["nokogiri", "~> 1.6"]
   extra_dev_deps << ["rake", ">= 10.0", "< 14"]
   extra_dev_deps << ["standard", "~> 1.0"]
 end
 
-$LOAD_PATH.unshift "lib"
-$LOAD_PATH.unshift "support"
-
-def new_version
-  version =
-    IO.read("lib/mime/types/data.rb").scan(/VERSION = ['"](\d\.\d{4}\.\d{4}(?:\.\d+)?)['"]/).flatten.first
-
-  major = Gem::Version.new(version).canonical_segments.first
-  minor = Date.today.strftime("%Y.%m%d")
-
-  "#{major}.#{minor}"
-end
-
-def release_header
-  "#{new_version} / #{Date.today.strftime("%Y-%m-%d")}"
-end
-
 namespace :mime do
   desc "Download the current MIME type registrations from IANA."
   task :iana, [:destination] do |_, args|
@@ -63,105 +47,45 @@ namespace :mime do
   end
 end
 
+task :version do
+  require "mime/types/data"
+  puts MIME::Types::Data::VERSION
+end
+
 namespace :release do
-  task __pull: %w[mime:apache mime:iana convert]
-  task __prepare: %w[update:version update:history git:manifest]
-  task :__commit do
-    history = IO.read("History.md")
-    message = history.scan(%r{## (#{release_header}.+?)## \d\.\d{4}\.\d{4} /}m).flatten.first
-
-    IO.popen("git commit -a -F -", "w") { |commit|
-      commit.puts message
-    }
+  desc "Prepare a new release"
+  task :prepare do
+    require "prepare_release"
+
+    PrepareRelease.new
+      .download_and_convert
+      .write_updated_version
+      .write_updated_history
+      .rake_git_manifest
+      .rake_gemspec
   end
 
   desc "Prepare a new release for use with GitHub Actions"
   task :gha do
     require "prepare_release"
 
-    pr = PrepareRelease.new
-    pr.download_and_convert
-    pr.write_updated_version
-    pr.write_updated_history
-    pr.rake_git_manifest
-    pr.rake_gemspec
-    pr.as_gha_vars
-  end
-
-  desc "Prepare a new automatic release"
-  task automatic: :__pull do
-    if system("git diff --quiet --exit-code") == false
-      Rake::Task["release:__prepare"].invoke
-      Rake::Task["gemspec"].invoke
-      Rake::Task["release:__commit"].invoke
-    else
-      warn "No changes detected."
-    end
+    PrepareRelease.new
+      .download_and_convert
+      .write_updated_version
+      .write_updated_history
+      .rake_git_manifest
+      .rake_gemspec
+      .as_gha_vars
   end
 end
 
-namespace :convert do
-  namespace :yaml do
-    desc "Convert from YAML to JSON"
-    task :json, [:source, :destination, :multiple_files] do |_, args|
-      require "convert"
-      Convert.from_yaml_to_json(from: args.source, to: args.destination, multiple_files: args.multiple_files)
-    end
-
-    desc "Convert from YAML to Columnar"
-    task :columnar, [:source, :destination] do |_, args|
-      require "convert/columnar"
-      Convert::Columnar.from_yaml_to_columnar(from: args.source, to: args.destination)
-    end
-
-    desc "Convert from YAML to mini_mime db format"
-    task :mini_mime, [:source, :destination] do |_, args|
-      require "convert/mini_mime_db"
-      Convert::MiniMimeDb.from_yaml_to_mini_mime(from: args.source, to: args.destination)
-    end
-  end
-
-  namespace :json do
-    desc "Convert from JSON to YAML"
-    task :yaml, [:source, :destination, :multiple_files] do |_, args|
-      require "convert"
-      Convert.from_json_to_yaml(from: args.source, to: args.destination, multiple_files: args.multiple_files)
-    end
-  end
-end
-
-namespace :update do
-  desc "Update the release version"
-  task :version do
-    file = IO.read("lib/mime/types/data.rb")
-    updated = file.sub(/VERSION = ['"][.0-9]+['"]/, %(VERSION = "#{new_version}"))
-
-    IO.write("lib/mime/types/data.rb", updated)
-  end
-
-  desc "Update the history file with automatic release notes"
-  task :history do
-    history = IO.read("History.md")
-
-    if !/^## #{release_header}$/.match?(history)
-      note = <<-NOTE
-<!-- automatic-release -->
-
-## #{release_header}
-
-- Updated the Apache and IANA media registry entries as of release date.
-      NOTE
-
-      updated = history.sub("<!-- automatic-release -->\n", note)
+desc "Default conversion from YAML to JSON and Columnar"
+task :convert do
+  require "prepare_release"
 
-      IO.write("History.md", updated)
-    end
-  end
+  PrepareRelease.new.convert_types
 end
 
-desc "Default conversion from YAML to JSON and Columnar"
-task convert: ["convert:yaml:json", "convert:yaml:columnar", "convert:yaml:mini_mime"]
-
 Rake::Task["gem"].prerequisites.unshift("convert")
 Rake::Task["gem"].prerequisites.unshift("git:manifest")
 Rake::Task["gem"].prerequisites.unshift("gemspec")

data/SECURITY.md

@@ -1,4 +1,4 @@
-# mime-types Security
+# mime-types-data Security
 
 ## Security contact information