[ActiveSupport] Add option filter on in_order_of (rails#52072)

* [ActiveSupport] Add option 'filter' on 'in_order_of'

* Update activesupport/lib/active_support/core_ext/enumerable.rb

Co-authored-by: Willian Gustavo Veiga <[email protected]>

---------

Co-authored-by: Willian Gustavo Veiga <[email protected]>
Co-authored-by: Rafael Mendonça França <[email protected]>

Author: 3 people

activesupport/CHANGELOG.md

@@ -1,3 +1,8 @@
+*   Add a `filter` option to `in_order_of` to prioritize certain values in the sorting without filtering the results
+    by these values.
+
+    *Igor Depolli*
+
 *   Improve error message when using `assert_difference` or `assert_changes` with a
     proc by printing the proc's source code (MRI only).
 

activesupport/lib/active_support/core_ext/enumerable.rb

@@ -192,9 +192,14 @@ def compact_blank
   #   # => [ Person.find(1), Person.find(5), Person.find(3) ]
   #
   # If the +series+ include keys that have no corresponding element in the Enumerable, these are ignored.
-  # If the Enumerable has additional elements that aren't named in the +series+, these are not included in the result.
-  def in_order_of(key, series)
-    group_by(&key).values_at(*series).flatten(1).compact
+  # If the Enumerable has additional elements that aren't named in the +series+, these are not included in the result, unless
+  # the +filter+ option is set to +false+.
+  def in_order_of(key, series, filter: true)
+    if filter
+      group_by(&key).values_at(*series).flatten(1).compact
+    else
+      sort_by { |v| series.index(v.public_send(key)) || series.size }.compact
+    end
   end
 
   # Returns the sole item in the enumerable. If there are no items, or more

activesupport/test/core_ext/enumerable_test.rb

@@ -386,6 +386,11 @@ def test_in_order_of_preserves_nested_elements
     assert_equal [[:opened, { price: 2, currency: :usd }], [:paid, { price: 1, currency: :eur }]], values.in_order_of(:first, [:opened, :paid])
   end
 
+  def test_in_order_of_with_filter_false
+    values = [ Payment.new(5), Payment.new(3), Payment.new(1) ]
+    assert_equal [ Payment.new(1), Payment.new(5), Payment.new(3) ], values.in_order_of(:price, [ 1, 5 ], filter: false)
+  end
+
   def test_sole
     expected_raise = Enumerable::SoleItemExpectedError