mime-types 2.99.3 → 3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fc8f9668b867116a596617ef0c7a3deb6525d4f
-  data.tar.gz: da57ee98722d4b5cee6ae754df620202a3d4a7db
+  metadata.gz: 7023816dbfc18473c51bed6f14864322167273fe
+  data.tar.gz: d29e9c15601cca71c991bc5cc1b50b31c1864d74
 SHA512:
-  metadata.gz: a82b94ceb52e642b263c8223a55c213220125a576d5abeaa5a72c2ad7941d967921bfc13385a300d4c02f45228d9f9f4fccb9999da6dd16ea29cf5fe8388a3a0
-  data.tar.gz: c5411c2e67a87c342cde930311d3c3df806e2699f5e27bccd72df1c8ab4095bb81db256b787e354ab13e8ec953b8b8b3aa41b3891a6f749aa0a579419d1a133a
+  metadata.gz: 1e7ba49d9b78b1331085a956c9c4c6c24687e7f69443bc00370b4e233874d32d28067d9171d50d14b14ea2bd4885a9b452b6ccc0a1fd179283855aebf9a23a3d
+  data.tar.gz: 7aa2a2ff6b297ed18a4feb6029d30b051fcc87bcd6d7aa6be37be3b9caa15e4207756614c729322e62592ae71abc5beeafbae40959194719fb11ac8acbfde2d9

data/.autotest

@@ -0,0 +1,35 @@
+# -*- ruby -*-
+
+require 'autotest/bundler'
+require 'autotest/restart'
+require 'autotest/timestamp'
+
+def require_plugin(resource)
+  require resource
+rescue LoadError
+  false
+end
+
+require_plugin 'autotest/clear'
+
+Autotest.add_hook :initialize do |at|
+  # at.testlib = "minitest/unit"
+  #
+  # at.extra_files << "../some/external/dependency.rb"
+  #
+  # at.libs << ":../some/external"
+  #
+  # at.add_exception "vendor"
+  #
+  # at.add_mapping(/dependency.rb/) do |f, _|
+  #   at.files_matching(/test_.*rb$/)
+  # end
+  #
+  # %w(TestA TestB).each do |klass|
+  #   at.extra_class_map[klass] = "test/test_misc.rb"
+  # end
+end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/.gitignore

@@ -0,0 +1,17 @@
+*.md
+*.swp
+*~
+.rake_tasks~
+.source_index
+.vagrant
+Gemfile.lock
+Vagrantfile
+coverage
+doc
+html
+pkg
+publish
+test/cache.tst
+tmp/
+.rubocop.yml
+.byebug_history

data/.hoerc

@@ -0,0 +1,20 @@
+---
+exclude: !ruby/regexp '/
+  \.(tmp|swp)$
+  |
+  (CVS|tmp)\/
+  |
+  (?i:TAGS)
+  |
+  \.(svn|git|hg|DS_Store|idea|vagrant)\/
+  |
+  Gemfile(?:\.lock)?
+  |
+  \.(rubocop|coveralls|pullreview|travis).yml$
+  |
+  \.gemspec
+  |
+  \.byebug_history
+  |
+  Vagrantfile
+  /x'

data/Code-of-Conduct.rdoc

@@ -1,74 +1,41 @@
-== Contributor Covenant Code of Conduct
+==  Contributor Code of Conduct
 
-## Our Pledge
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age,
-body size, disability, ethnicity, gender identity and expression, level of
-experience, nationality, personal appearance, race, religion, or sexual
-identity and orientation.
-
-=== Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-=== Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+that are not aligned to this Code of Conduct. By adopting this Code of Conduct,
+project maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do
+not follow or enforce the Code of Conduct may be permanently removed from the
+project team.
 
-=== Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an
-appointed representative at an online or offline event. Representation of a
-project may be further defined and clarified by project maintainers.
-
-=== Enforcement
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an
-incident. Further details of specific enforcement policies may be posted
-separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-=== Attribution
+reported by opening an issue or contacting one or more of the project
+maintainers.
 
-This Code of Conduct is adapted from the {Contributor
-Covenant}[http://contributor-covenant.org], version 1.4,
+This Code of Conduct is adapted from the
+{Contributor Covenant}[http://contributor-covenant.org], version 1.2.0,
 available at
-{http://contributor-covenant.org/version/1/4/}[http://contributor-covenant.org/version/1/4/].
+{http://contributor-covenant.org/version/1/2/0/}[http://contributor-covenant.org/version/1/2/0/].

data/Contributing.rdoc

@@ -165,6 +165,5 @@ Thanks to everyone else who has contributed to mime-types:
 * Richard Hirner
 * Richard Hurt
 * Richard Schneeman
-* Tao Guo
 * Tibor Szolár
 * Todd Carrico

data/History.rdoc

@@ -1,39 +1,78 @@
-== 2.99.3 / 2016-09-10
-
-* Data release. This release reflects updates to the embedded MIME type data on
-  the specified quarterly schedule.
-
-* Minor improvement to the support build script to only extract supported MIME
-  type name characters from obsoletion or deprecation notes.
-
-* Removed SimpleCov from the build process. The code here is no longer
-  changing, and its presence causes substantial breakage on Travis for Rubies
-  that are not 2.x-compatible.
-
-== 2.99.2 / 2016-05-21
-
-* Data release. This release reflects updates to the embedded MIME type data on
-  the specified quarterly schedule.
-
-* Minor improvement to the Rakefile, .hoerc, and Manifest to ensure that builds
-  work correctly on Travis.
-
-* Updated to {Contributor Covenant 1.4}[Code-of-Conduct_rdoc.html].
-
-== 2.99.1 / 2016-02-21
-
-* Data release. This release reflects only updates to the embedded MIME type
-  data on the specified quarterly schedule.
-
-== 2.99 / 2015-11-21
-
-* 1 governance change
-
-  * This project now has a {Code of Conduct}[Code-of-Conduct_rdoc.html]
-
-* 1 major change
-
-  * Replaced deprecated fields for MIME types with fixed empty responses.
+== 3.0 / 2015-11-21
+
+* 2 governance changes
+
+  * This project and the related mime-types-data project are now exclusively
+    MIT licensed. Resolves
+    {#95}[https://github.com/mime-types/ruby-mime-types/issues/95].
+
+  * All projects under the mime-types organization now have a standard code of
+    conduct adapted from the {Contributor
+    Covenant}[http://contributor-covenant.org]. This text can be found in the
+    {Code-of-Conduct.rdoc}[Code-of-Conduct_rdoc.html] 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}[https://github.com/mime-types/ruby-mime-types/issues/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}[https://github.com/mime-types/mime-types-data].
+
+* 17 minor changes:
+
+  * MIME::Type changes:
+
+    * Changed the way that simplified types representations are creatd 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 <tt>%w(text/yaml
+      yaml yml)</tt> works in the same way that <tt>['text/yaml', %w(yaml
+      yml)]</tt> 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}[https://github.com/mime-types/ruby-mime-types/issues/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}[https://github.com/mime-types/ruby-mime-types/issues/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}[https://github.com/mime-types/ruby-mime-types/85].
 
 == 2.6.2 / 2015-09-13
 

data/Licence.rdoc

@@ -1,16 +1,8 @@
 == Licence
 
-This software is available under three licences: the GNU GPL version 2 (or at
-your option, a later version), the Perl Artistic License, or the MIT License.
-The licence preferred by me is the MIT licence.
+*   Copyright 2003–2015 Austin Ziegler.
 
-The original Perl MIME::Types was dually originally licensed with the Perl
-Artistic Licence and the GNU GPL ("the same terms as Perl itself") and given
-that the Ruby implementation originally hewed pretty closely to the Perl
-version, I chose to maintain the additional licensing terms.
-
-* Copyright 2003–2016 Austin Ziegler and other contributors.
-* Adapted from MIME::Types (Perl) by Mark Overmeer.
+The software in this repository is made available under the MIT license.
 
 === MIT License
 
@@ -31,9 +23,3 @@ 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.
-
-=== Perl Artistic License (version 2)
-See the file docs/artistic.txt in the main distribution.
-
-=== GNU GPL version 2
-See the file docs/COPYING.txt in the main distribution.

data/Manifest.txt

@@ -1,40 +1,32 @@
+.autotest
+.gemtest
+.gitignore
+.hoerc
 Code-of-Conduct.rdoc
 Contributing.rdoc
-History-Types.rdoc
 History.rdoc
 Licence.rdoc
 Manifest.txt
 README.rdoc
 Rakefile
-data/mime-types.json
-data/mime.content_type.column
-data/mime.docs.column
-data/mime.encoding.column
-data/mime.friendly.column
-data/mime.obsolete.column
-data/mime.registered.column
-data/mime.signature.column
-data/mime.use_instead.column
-data/mime.xrefs.column
-docs/COPYING.txt
-docs/artistic.txt
 lib/mime-types.rb
 lib/mime/type.rb
 lib/mime/type/columnar.rb
 lib/mime/types.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/loader_path.rb
 lib/mime/types/logger.rb
-support/apache_mime_types.rb
+lib/mime/types/registry.rb
 support/benchmarks/load.rb
 support/benchmarks/load_allocations.rb
 support/benchmarks/object_counts.rb
-support/convert.rb
-support/convert/columnar.rb
-support/iana_registry.rb
+support/profile/columnar.rb
+support/profile/columnar_full.rb
+support/profile/full.rb
 test/bad-fixtures/malformed
 test/fixture/json.json
 test/fixture/old-data

data/README.rdoc

@@ -1,4 +1,4 @@
-= mime-types
+= mime-types for Ruby
 
 home :: https://github.com/mime-types/ruby-mime-types/
 code :: https://github.com/mime-types/ruby-mime-types/
@@ -14,19 +14,13 @@ 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.
 
-This is release 2.99.1, the first scheduled data update for mime-types 2.x. As
-of mime-types 2.99. deprecation warnings are noisy and data that has been
-deprecated is now no longer available. The data is both dropped from the data
-files and is stubbed out as empty or +nil+ values as appropriate.
-
-mime-types-2.6 was the last version of mime-types 2.x with newly available
-features, and mime-types 2.99 will only receive quarterly updates to the IANA
-registered MIME media types plus any security updates that may be required.
-
-If the loss of the deprecated data matters, be sure to set your dependency
-appropriately:
-
-   gem 'mime-types', '~> 2.6, < 2.99'
+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
 
@@ -43,8 +37,7 @@ user contributions. It conforms to RFCs 2045 and 2231.
 
 === mime-types 1.x End of Life
 
-mime-types 1.x has reached end of life and is no longer supported as of
-2015-10-27 and will receive no updates at all.
+mime-types 1.x is no longer supported as of 2015-10-27.
 
 === mime-types 2.x End of Life
 
@@ -122,50 +115,57 @@ files). A MIME::Type stores the known information about one MIME type.
 
 === Columnar Store
 
-mime-types 2.6 introduced an experimental columnar storage format that reduces
-the default memory footprint. It does this by selectively loading data. When a
-registry is first loaded from a columnar store, only the canonical MIME type
-and registered extensions will be loaded and the MIME type will be connected to
-its registry. When extended data is required (including +registered+,
-+obsolete+, and +use_instead+), that data is loaded from its own column file
-for all types in the registry. This load is done with a Mutex to ensure that
-the types are updated safely in a multithreaded environment.
+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.
 
-Columnar storage is slated to become the default storage format for mime-types
-3.0, but until that is released, the default is still to use the JSON storage
-format. As such, columnar storage can only currently be loaded at an
-application level with the following specification in the application Gemfile:
+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.
 
-   gem 'mime-types', require: 'mime/types/columnar'
+If you prefer to load all the data at once, this can be specified in your
+application Gemfile as:
 
-Projects that do not use Bundler, and libraries that wish to suggest this
-behaviour to applications are encouraged to require this directly, but only if
-you specify a dependency on mime-types 2.6.
+   gem 'mime-types', require: 'mime/types/full'
 
-   require 'mime/types/columnar'
+Projects that do not use Bundler should +require+ the same:
 
-Although this require will not be necessary after mime-types 3, it will work
-through at least {version
+   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.
+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 the new Columnar class (MIME::Type::Columnar) and module
-(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 only.
+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
 
-Since version 2.0, mime-types has supported a cache of MIME types based on
-<tt>Marshal.dump</tt>. The cache is invalidated for each released version of
-mime-types so that version 2.5 is not reused for version 2.6. If the
+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 current mime-types cache is not compatible with the columnar storage
-format. This will be resolved for mime-types 3.
+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