mime-types 3.7.0.pre1 → 3.7.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc8ea5f8e0271da1f1b5ad79011d66be1ab6eaf2e51ccefb7a6b1744ab7a60c
-  data.tar.gz: c8bef17d139d55505852440b1f8103d0ed218093e7e6f0b999c58cfaa6a7f302
+  metadata.gz: e25ed719cc7aaa5bebf7b6a4c701a9269aee07a7826d57f51b0e304c3cef489e
+  data.tar.gz: c7c7df7e30a4a6e03b60a4c3d19009a18a8cc4a263a9bc0e9d7317c1fa22868c
 SHA512:
-  metadata.gz: 8a30479ab4fd1589bcdf9dd21b145786038799fb4f3e0b8bc0ba4ad14fd23c38e88265323752faca4750de2d5e23f30ecbbb4e9bc33fca2dd93ddf45032a5f40
-  data.tar.gz: 3b5dd2e2a4628096ab7b44a3a5cb43d1c2c0c5404fa8e16909f8e20481ad0521bbe957fc5e0410b807c6e834d5e086dd5bbe40ffbb13a289c41efc9e3f5585be
+  metadata.gz: 5f45853a6237e1773122595b9055112b053743daf726d209bbeabadda70dfb3248120db2a45807246739e87961efaebc35bedfd1e0418820f7c511fddc906633
+  data.tar.gz: 0da2dad77c9d62eb54bbbd5a830593d6e1e392c1c1f4b141aa242b9cff512f3918504baf29b2cbb4f18f90a9103cf024b1a85b834557a0430fb84ddce46e88ba

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 3.7.0.pre1 / YYYY-MM-DD
+## 3.7.0.pre2 / YYYY-MM-DD
 
 - Deprecated `MIME::Type#priority_compare`. In a future release, this will be
   will be renamed to `MIME::Type#<=>`. This method is used in tight loops, so
@@ -19,6 +19,14 @@
   none, as explicit support for several special values (which should have caused
   errors in any case) have been removed.
 
+- When sorting the result of `MIME::Types#type_for`, provided a priority boost
+  if one of the target extensions is the type's preferred extension. This means
+  that for the case in [#148][issue-148], when getting the type for `foo.webm`,
+  the type `video/webm` will be returned before the type `audio/webm`, because
+  `.webm` is the preferred extension for `video/webm` but not `audio/webm`
+  (which has a preferred extension of `.weba`). Added tests to ensure MIME types
+  are retrieved in a stable order (which is alphabetical).
+
 ## 3.6.2 / 2025-03-25
 
 - Updated the reference to the changelog in the README, fixing RubyGems metadata
@@ -369,6 +377,7 @@ there are some validation changes and updated code with formatting.
 [issue-127]: https://github.com/mime-types/ruby-mime-types/issues/127
 [issue-134]: https://github.com/mime-types/ruby-mime-types/issues/134
 [issue-136]: https://github.com/mime-types/ruby-mime-types/issues/136
+[issue-148]: https://github.com/mime-types/ruby-mime-types/issues/148
 [issue-166]: https://github.com/mime-types/ruby-mime-types/issues/166
 [issue-177]: https://github.com/mime-types/ruby-mime-types/issues/177
 [mime-types-data]: https://github.com/mime-types/mime-types-data

data/Rakefile

@@ -26,7 +26,7 @@ spec = Hoe.spec "mime-types" do
     val.merge!({"rubygems_mfa_required" => "true"})
   }
 
-  extra_deps << ["mime-types-data", "~> 3.2025", ">= 3.2025.0506.pre1"]
+  extra_deps << ["mime-types-data", "~> 3.2025", ">= 3.2025.0506.pre2"]
   extra_deps << ["logger", ">= 0"]
 
   extra_dev_deps << ["hoe", "~> 4.0"]

data/lib/mime/type.rb

@@ -134,7 +134,6 @@ class MIME::Type
     @friendly = {}
     @obsolete = @registered = @provisional = false
     @preferred_extension = @docs = @use_instead = @__sort_priority = nil
-    __extension_priorities
 
     self.extensions = []
 
@@ -196,12 +195,11 @@ class MIME::Type
     simplified <=> other
   end
 
-  # Compares the +other+ MIME::Type using the simplified representation, then
-  # a pre-computed sort priority value. Used by MIME::Types#[] to sort types.
+  # Compares the +other+ MIME::Type using a pre-computed sort priority value,
+  # then the simplified representation for an alphabetical sort.
   #
-  # While this method is public, its direct use is strongly discouraged by
-  # consumers of mime-types. For the next major version of MIME::Types, this
-  # method will become #<=> and #priority_compare will be removed.
+  # For the next major version of MIME::Types, this method will become #<=> and
+  # #priority_compare will be removed.
   def priority_compare(other)
     if (cmp = __sort_priority <=> other.__sort_priority) == 0
       simplified <=> other.simplified
@@ -210,6 +208,33 @@ class MIME::Type
     end
   end
 
+  # Uses a modified pre-computed sort priority value based on whether one of the provided
+  # extensions is the preferred extension for a type.
+  #
+  # This is an internal function. If an extension provided is a preferred extension either
+  # for this instance or the compared instance, the corresponding extension has its top
+  # _extension_ bit cleared from its sort priority. That means that a type with between
+  # 0 and 8 extensions will be treated as if it had 9 extensions.
+  def __extension_priority_compare(other, exts) # :nodoc:
+    tsp = __sort_priority
+
+    if exts.include?(preferred_extension) && tsp & 0b1000 != 0
+      tsp = tsp & 0b11110111 | 0b0111
+    end
+
+    osp = other.__sort_priority
+
+    if exts.include?(other.preferred_extension) && osp & 0b1000 != 0
+      osp = osp & 0b11110111 | 0b0111
+    end
+
+    if (cmp = tsp <=> osp) == 0
+      simplified <=> other.simplified
+    else
+      cmp
+    end
+  end
+
   # Returns +true+ if the +other+ object is a MIME::Type and the content types
   # match.
   def eql?(other)
@@ -330,38 +355,10 @@ class MIME::Type
 
   ##
   def preferred_extension=(value) # :nodoc:
-    if value
-      add_extensions(value)
-      set_preferred_extension_priority(value)
-    elsif instance_variable_defined?(:@preferred_extension)
-      clear_extension_priority(@preferred_extension)
-    end
+    add_extensions(value) if value
     @preferred_extension = value
   end
 
-  ##
-  # Optional extension priorities for this MIME type. This is a map of
-  # extensions to relative priority values (+-20..20+) similar to +nice(1)+.
-  # Unless otherwise specified in the data, an explicitly set
-  # +preferred_extension+ is automatically given a relative priority of +-10+.
-  #
-  # :attr_reader: extension_priorities
-  attr_accessor :extension_priorities
-
-  ##
-  # Returns the priority for the provided extension or extensions. If a priority
-  # is not set, the default priority is +0+. The range for priorities is
-  # +-20..20+, inclusive.
-  #
-  # Obsolete MIME types have a <code>+3</code> penalty applied to their
-  # extension priority and unregistered MIME types have a <code>+2</code>
-  # penalty to their extension priority, meaning that the highest priority an
-  # obsolete, unregistered MIME type can have is +-15+. The lowest priority is
-  # always <code>+20</code>.
-  def extension_priority(*exts)
-    exts.map { |ext| get_extension_priority(ext) }.min
-  end
-
   ##
   # The encoding (+7bit+, +8bit+, <tt>quoted-printable</tt>, or +base64+)
   # required to transport the data of this content type safely across a
@@ -583,7 +580,6 @@ class MIME::Type
     coder["provisional"] = provisional? if provisional?
     coder["signature"] = signature? if signature?
     coder["sort-priority"] = __sort_priority || 0b11111111
-    coder["extension-priorities"] = __extension_priorities unless __extension_priorities.empty?
     coder
   end
 
@@ -604,7 +600,6 @@ class MIME::Type
     self.signature = coder["signature"]
     self.xrefs = coder["xrefs"] || {}
     self.use_instead = coder["use-instead"]
-    self.extension_priorities = coder["extension-priorities"]
 
     friendly(coder["friendly"] || {})
 
@@ -662,24 +657,8 @@ class MIME::Type
     end
   end
 
-  def __extension_priorities # :nodoc:
-    @extension_priorities ||= {}
-  end
-
   private
 
-  def clear_extension_priority(ext)
-    __extension_priorities.delete(ext) if ext
-  end
-
-  def get_extension_priority(ext)
-    [[-20, (__extension_priorities[ext] || 0) + __priority_penalty].max, 20].min
-  end
-
-  def set_preferred_extension_priority(ext)
-    __extension_priorities[ext] = -10 unless __extension_priorities.has_key?(ext)
-  end
-
   def clear_sort_priority
     @__sort_priority = nil
   end
@@ -709,13 +688,6 @@ class MIME::Type
     extension_count = [0, 16 - extension_count].max
 
     @__sort_priority = obsolete | registered | provisional | complete | extension_count
-    @__priority_penalty = ((instance_variable_defined?(:@obsolete) && @obsolete) ? 3 : 0) +
-      ((instance_variable_defined?(:@registered) && @registered) ? 0 : 2)
-  end
-
-  def __priority_penalty
-    update_sort_priority if @__priority_penalty.nil?
-    @__priority_penalty
   end
 
   def content_type=(type_string)

data/lib/mime/types/version.rb

@@ -4,7 +4,7 @@
 module MIME
   class Types
     # The released version of the mime-types library.
-    VERSION = "3.7.0.pre1"
+    VERSION = "3.7.0.pre2"
   end
 
   class Type

data/lib/mime/types.rb

@@ -130,9 +130,8 @@ class MIME::Types
         @type_variants[MIME::Type.simplified(type_id)]
       end
 
-    prune_matches(matches, complete, registered).sort { |a, b|
-      a.priority_compare(b)
-    }
+    # prune_matches(matches, complete, registered).sort { |a, b| a.priority_compare(b) }
+    prune_matches(matches, complete, registered).sort
   end
 
   # Return the list of MIME::Types which belongs to the file based on its
@@ -148,16 +147,14 @@ class MIME::Types
   #   puts MIME::Types.type_for(%w(citydesk.xml citydesk.gif))
   #     => [application/xml, image/gif, text/xml]
   def type_for(filename)
-    Array(filename).flat_map { |fn|
-      @extension_index[fn.chomp.downcase[/\.?([^.]*?)\z/m, 1]]
-    }.compact.inject(Set.new, :+).sort { |a, b|
-      by_ext = a.extension_priority(*a.extensions) <=> b.extension_priority(*b.extensions)
-
-      if by_ext.zero?
-        a.priority_compare(b)
-      else
-        by_ext
-      end
+    wanted = Array(filename).map { |fn| fn.chomp.downcase[/\.?([^.]*?)\z/m, 1] }
+
+    wanted
+      .flat_map { |ext| @extension_index[ext] }
+      .compact
+      .reduce(Set.new, :+)
+      .sort { |a, b|
+      a.__extension_priority_compare(b, wanted)
     }
   end
   alias_method :of, :type_for
@@ -230,6 +227,12 @@ class MIME::Types
       k =~ pattern
     }.values.inject(Set.new, :+)
   end
+
+  # def stable_sort(list)
+  #   list.lazy.each_with_index.sort { |(a, ai), (b, bi)|
+  #     a.priority_compare(b).nonzero? || ai <=> bi
+  #   }.map(&:first)
+  # end
 end
 
 require "mime/types/cache"

data/test/minitest_helper.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-$debug = false
-
 gem "minitest"
 require "minitest/focus"
 require "minitest/hooks"

data/test/test_mime_types.rb

@@ -12,7 +12,8 @@ describe MIME::Types do
         MIME::Type.new("content-type" => "application/x-wordperfect6.1"),
         MIME::Type.new("content-type" => "application/x-www-form-urlencoded", "registered" => true),
         MIME::Type.new("content-type" => "application/x-gzip", "extensions" => %w[gz]),
-        MIME::Type.new("content-type" => "application/gzip", "extensions" => "gz", "registered" => true)
+        MIME::Type.new("content-type" => "application/gzip", "extensions" => "gz", "registered" => true),
+        *MIME::Types.type_for("foo.webm")
       )
     }
   end
@@ -33,8 +34,8 @@ describe MIME::Types do
     end
 
     it "is countable with an enumerator" do
-      assert_equal 6, mime_types.each.count
-      assert_equal 6, mime_types.lazy.count
+      assert_equal 8, mime_types.each.count
+      assert_equal 8, mime_types.lazy.count
     end
   end
 
@@ -139,7 +140,7 @@ describe MIME::Types do
     end
 
     it "finds multiple extensions" do
-      assert_equal %w[image/jpeg text/plain],
+      assert_equal %w[text/plain image/jpeg],
         mime_types.type_for(%w[foo.txt foo.jpeg])
     end
 
@@ -158,11 +159,15 @@ describe MIME::Types do
     it "handles newline characters correctly" do
       assert_includes mime_types.type_for("test.pdf\n.txt"), "text/plain"
     end
+
+    it "returns a stable order for types with equal priority" do
+      assert_equal %w[text/x-vcalendar text/x-vcard], MIME::Types[/text\/x-vca/]
+    end
   end
 
   describe "#count" do
     it "can count the number of types inside" do
-      assert_equal 6, mime_types.count
+      assert_equal 8, mime_types.count
     end
   end
 end

data/test/test_mime_types_class.rb

@@ -87,7 +87,10 @@ describe MIME::Types, "registry" do
     end
 
     it "finds multiple extensions ordered by the filename list" do
-      assert_equal %w[text/plain image/jpeg], MIME::Types.type_for(%w[foo.txt foo.jpeg])
+      result = MIME::Types.type_for(%w[foo.txt foo.jpeg])
+
+      # assert_equal %w[text/plain image/jpeg], MIME::Types.type_for(%w[foo.txt foo.jpeg])
+      assert_equal %w[text/plain image/jpeg], result
     end
 
     it "does not find unknown extensions" do
@@ -104,6 +107,10 @@ describe MIME::Types, "registry" do
       assert_includes MIME::Types.type_for("test.pdf\n.txt"), "text/plain"
       assert_includes MIME::Types.type_for("test.txt\n.pdf"), "application/pdf"
     end
+
+    it "returns a stable order for types with equal priority" do
+      assert_equal %w[text/x-vcalendar text/x-vcard], MIME::Types[/text\/x-vca/]
+    end
   end
 
   describe ".count" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mime-types
 version: !ruby/object:Gem::Version
-  version: 3.7.0.pre1
+  version: 3.7.0.pre2
 platform: ruby
 authors:
 - Austin Ziegler
 bindir: bin
 cert_chain: []
-date: 2025-04-04 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types-data
@@ -18,7 +18,7 @@ dependencies:
         version: '3.2025'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2025.0506.pre1
+        version: 3.2025.0506.pre2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
         version: '3.2025'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2025.0506.pre1
+        version: 3.2025.0506.pre2
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement