mime-types 2.6.2 → 3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 706867f65357bce7a5ee276610100df3e2ea67bb
-  data.tar.gz: 736ee467668803dd28bf54d93972513cd4e98ec2
+  metadata.gz: 7023816dbfc18473c51bed6f14864322167273fe
+  data.tar.gz: d29e9c15601cca71c991bc5cc1b50b31c1864d74
 SHA512:
-  metadata.gz: a9a69e833a2ccc31a5963b3ed405cb6805298474f0814039fdc5f0ad879ba083f8ea7dc6214d9bd2e83ae095d96c5feff1cfd9dc11ded7b3c226196710d01f27
-  data.tar.gz: 37ffd21f38566ddd67b76c0441890a6f56332bdca5216df53398c6a3a56f102ef5e802d4ada028dcf26996a4302cc8197c0c6fb65b8ba996d3457d145c5ecabb
+  metadata.gz: 1e7ba49d9b78b1331085a956c9c4c6c24687e7f69443bc00370b4e233874d32d28067d9171d50d14b14ea2bd4885a9b452b6ccc0a1fd179283855aebf9a23a3d
+  data.tar.gz: 7aa2a2ff6b297ed18a4feb6029d30b051fcc87bcd6d7aa6be37be3b9caa15e4207756614c729322e62592ae71abc5beeafbae40959194719fb11ac8acbfde2d9

data/.gitignore

@@ -13,3 +13,5 @@ pkg
 publish
 test/cache.tst
 tmp/
+.rubocop.yml
+.byebug_history

data/.hoerc

@@ -2,7 +2,7 @@
 exclude: !ruby/regexp '/
   \.(tmp|swp)$
   |
-  CVS/
+  (CVS|tmp)\/
   |
   (?i:TAGS)
   |
@@ -10,11 +10,11 @@ exclude: !ruby/regexp '/
   |
   Gemfile(?:\.lock)?
   |
-  type-lists\/
-  |
-  \.(coveralls|pullreview|travis).yml$
+  \.(rubocop|coveralls|pullreview|travis).yml$
   |
   \.gemspec
   |
+  \.byebug_history
+  |
   Vagrantfile
   /x'

data/Code-of-Conduct.rdoc

@@ -0,0 +1,41 @@
+==  Contributor Code of Conduct
+
+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.
+
+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
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* 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. 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.
+
+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 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.2.0,
+available at
+{http://contributor-covenant.org/version/1/2/0/}[http://contributor-covenant.org/version/1/2/0/].

data/Contributing.rdoc

@@ -33,9 +33,6 @@ in +type-lists/application.yml+.
     extensions:
     - xml
     - xsl
-    references:
-    - IANA
-    - RFC3023
     xrefs: !ruby/hash:MIME::Types::Container
       rfc:
       - rfc3023

data/History.rdoc

@@ -1,3 +1,79 @@
+== 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
 
 * Bugs:

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–2015 Austin Ziegler.
-* 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

@@ -2,44 +2,31 @@
 .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.references.column
-data/mime.registered.column
-data/mime.signature.column
-data/mime.system.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,6 +14,16 @@ 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
@@ -25,51 +35,20 @@ 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.
 
-This is release 2.6 with two new experimental features. The first new feature
-is a new default registry storage format that greatly reduces the initial
-memory use of the mime-types library. This feature is enabled by requiring
-+mime/types/columnar+ instead of +mime/types+ with a small performance cost and
-no change in *total* memory use if certain methods are called (see {Columnar
-Store}[#label-Columnar+Store]). The second new feature is a logger interface
-that conforms to the expectations of an ActiveSupport::Logger so that warnings
-can be written to an application's log rather than the default location for
-+warn+. This interface may be used for other logging purposes in the future.
-
-mime-types 2.6 is the last planned version of mime-types 2.x, so deprecation
-warnings are no longer cached but provided every time the method is called.
-mime-types 2.6 supports Ruby 1.9.2 or later.
-
 === mime-types 1.x End of Life
 
-mime-types 2.0 was released in late 2013, and as of early 2015 there have been
-no reported security issues for mime-types 1.x. With the release of mime-types
-2.5, I set the formal End of Life for mime-types 1.x for 2015-10-27 (the second
-anniversary of the release of mime-types 2.0). After this date, absolutely no
-pull requests for mime-types 1.x will be accepted.
-
-=== mime-types Future
-
-There are a number of issues open that make clear to me that there are some
-fundamental changes that need to happen to both the data representation and the
-API provided by mime-types. This cannot happen under the current release, so
-all new development is focussing on an upcoming 3.0 release. The target for the
-release is on or before the beginning of RubyConf 2015 (2015-11-15).
+mime-types 1.x is no longer supported as of 2015-10-27.
 
-When 3.0 is released, mime-types 2.x will receive regular updates of the IANA
-registry for two years following the release. It will also receive security
-updates, if needed, for the same period. There will be no further feature
-development on mime-types 2.x following the 3.0 release.
+=== mime-types 2.x End of Life
 
-Coincident with the 3.0 release, I will release mime-types 2.99.0 that no
-longer imports the data to fields that have been deprecated, or exports it if
-it is present. If they work because they derive data from the data that is
-still present, the will continue to work. The quarterly updates will be against
-2.99.x.
+mime-types 2.x is supported as 2.99.x receiving quarterly updates of the IANA
+registry and security updates for two years. It will reach full end of life on
+2017-11-21.
 
-If the possible loss of this deprecated data matters, be sure to set your
-dependency appropriately:
+=== mime-types 3.x
 
-   gem 'mime-types', '~> 2.6, < 2.99'
+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
 
@@ -111,9 +90,9 @@ files). A MIME::Type stores the known information about one MIME type.
    puts text.like?(MIME::Type.new('x-text/x-plain')) # => true
 
    puts text.xrefs.inspect # => { "rfc" => [ "rfc2046", "rfc3676", "rfc5147" ] }
-   puts text.urls # => [ "http://www.iana.org/go/rfc2046",
-                  #      "http://www.iana.org/go/rfc3676",
-                  #      "http://www.iana.org/go/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'
@@ -136,50 +115,57 @@ files). A MIME::Type stores the known information about one MIME type.
 
 === Columnar Store
 
-mime-types 2.6 has 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,
-#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:
+
+   require 'mime/types/full'
+
+Libraries that use mime-types are discouraged from choosing the JSON store.
 
-Although this require will not be necessary after mime-types 3, it will work
-through at least {version
+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.
 
-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.
+   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
 
-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
 
@@ -211,6 +197,8 @@ indicate when new API features have been added, but all minor versions of
 mime-types 2.x will be backwards compatible; the interfaces marked deprecated
 will be removed in mime-types 3.x.
 
+:include: Code-of-Conduct.rdoc
+
 :include: Contributing.rdoc
 
 :include: Licence.rdoc