Merge pull request rails#51676 from joshuay03/pluck-symbol-string-value-hash

Allow `ActiveRecord::QueryMethods#pluck` to accept hash args with symbol & string values

Author: byroot

activerecord/CHANGELOG.md

@@ -1,3 +1,12 @@
+*   Allow `ActiveRecord::Base#pluck` to accept hash arguments with symbol and string values.
+
+    ```ruby
+    Post.joins(:comments).pluck(:id, comments: :id)
+    Post.joins(:comments).pluck("id", "comments" => "id")
+    ```
+
+    *Joshua Young*
+
 *   Make Float distinguish between `float4` and `float8` in PostgreSQL.
 
     Fixes #52742

activerecord/lib/active_record/relation/calculations.rb

@@ -275,10 +275,14 @@ def calculate(operation, column_name)
     #   # SELECT people.id FROM people WHERE people.age = 21 LIMIT 5
     #   # => [2, 3]
     #
-    #   Comment.joins(:person).pluck(:id, person: [:id])
+    #   Comment.joins(:person).pluck(:id, person: :id)
     #   # SELECT comments.id, people.id FROM comments INNER JOIN people on comments.person_id = people.id
     #   # => [[1, 2], [2, 2]]
     #
+    #   Comment.joins(:person).pluck(:id, person: [:id, :name])
+    #   # SELECT comments.id, people.id, people.name FROM comments INNER JOIN people on comments.person_id = people.id
+    #   # => [[1, 2, 'David'], [2, 2, 'David']]
+    #
     #   Person.pluck(Arel.sql('DATEDIFF(updated_at, created_at)'))
     #   # SELECT DATEDIFF(updated_at, created_at) FROM people
     #   # => ['0', '27761', '173']

activerecord/lib/active_record/relation/query_methods.rb

@@ -1956,6 +1956,25 @@ def arel_columns(columns)
         end
       end
 
+      def arel_columns_from_array(columns, table_name = model.table_name)
+        columns.map do |column|
+          arel_column("#{table_name}.#{column}")
+        end
+      end
+
+      def arel_columns_from_hash(fields)
+        fields.flat_map do |table_name, columns|
+          case columns
+          when Array
+            arel_columns_from_array(columns, table_name)
+          when Symbol, String
+            arel_column(columns)
+          else
+            raise TypeError, "Expected Symbol, String or Array, got: #{columns.class}"
+          end
+        end
+      end
+
       def arel_column(field)
         field = field.name if is_symbol = field.is_a?(Symbol)
 
@@ -2194,14 +2213,14 @@ def check_if_method_has_arguments!(method_name, args, message = nil)
       def process_select_args(fields)
         fields.flat_map do |field|
           if field.is_a?(Hash)
-            arel_columns_from_hash(field)
+            arel_column_aliases_from_hash(field)
           else
             field
           end
         end
       end
 
-      def arel_columns_from_hash(fields)
+      def arel_column_aliases_from_hash(fields)
         fields.flat_map do |key, columns_aliases|
           case columns_aliases
           when Hash

activerecord/test/cases/calculations_test.rb

@@ -976,7 +976,10 @@ def test_pluck_with_hash_argument
       [2, "The Second Topic of the day"],
       [3, "The Third Topic of the day"]
     ]
+    assert_equal expected, Topic.order(:id).limit(3).pluck(:id, topics: :title)
+    assert_equal expected, Topic.order(:id).limit(3).pluck("id", "topics" => "title")
     assert_equal expected, Topic.order(:id).limit(3).pluck(:id, topics: [:title])
+    assert_equal expected, Topic.order(:id).limit(3).pluck("id", "topics" => ["title"])
   end
 
   def test_pluck_with_hash_argument_with_multiple_tables
@@ -985,6 +988,8 @@ def test_pluck_with_hash_argument_with_multiple_tables
       [1, 2, "Thank you again for the welcome"],
       [2, 3, "Don't think too hard"]
     ]
+    assert_equal expected, Post.joins(:comments).order(posts: { id: :asc }, comments: { id: :asc }).limit(3).pluck(:id, comments: [:id, :body])
+    assert_equal expected, Post.joins(:comments).order(posts: { id: :asc }, comments: { id: :asc }).limit(3).pluck(posts: :id, comments: [:id, :body])
     assert_equal expected, Post.joins(:comments).order(posts: { id: :asc }, comments: { id: :asc }).limit(3).pluck(posts: [:id], comments: [:id, :body])
   end