Merge pull request #3766 from mamhoff/resources-controller-distinct

Resources controller: Return distinct records

Author: tvdeyen

app/controllers/alchemy/admin/resources_controller.rb

@@ -18,12 +18,7 @@ class ResourcesController < Alchemy::Admin::BaseController
       before_action :authorize_resource
 
       def index
-        @query = resource_handler.model.ransack(search_filter_params[:q])
-        @query.sorts = default_sort_order if @query.sorts.empty?
-        items = @query.result
-
-        items = items.includes(*resource_relations_names) if contains_relations?
-        items = items.tagged_with(search_filter_params[:tagged_with]) if search_filter_params[:tagged_with].present?
+        items = collection
 
         respond_to do |format|
           format.html do
@@ -121,6 +116,16 @@ def authorize_resource
         authorize!(action_name.to_sym, resource_instance_variable || resource_handler.model)
       end
 
+      def collection
+        @query = resource_handler.model.ransack(search_filter_params[:q])
+        @query.sorts = default_sort_order if @query.sorts.empty?
+        items = @query.result(distinct: true)
+
+        items = items.includes(*resource_relations_names) if contains_relations?
+        items = items.tagged_with(search_filter_params[:tagged_with]) if search_filter_params[:tagged_with].present?
+        items
+      end
+
       # Permits all editable resource attributes as default.
       #
       # Define this method in your inheriting controller if you want to permit additional attributes.

spec/controllers/alchemy/admin/resources_controller_spec.rb

@@ -85,6 +85,20 @@ def resource_handler
         end
       end
     end
+
+    describe "searching for records with multiple associated records" do
+      controller(Admin::LocationsController) {}
+
+      let(:bauwagen) { create(:location, name: "Bauwagen") }
+      let!(:peter) { create(:event, name: "Peter", location: bauwagen) }
+      let!(:lustig) { create(:event, name: "Lustig", location: bauwagen) }
+
+      it "returns only one bauwagen" do
+        get :index, params: {q: {events_name_cont: "t"}}
+        expect(response).to be_successful
+        expect(assigns(:locations)).to eq([bauwagen])
+      end
+    end
   end
 
   describe "#update" do

spec/dummy/app/controllers/admin/locations_controller.rb

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 
 class Admin::LocationsController < Alchemy::Admin::ResourcesController
+  private
+
+  def permitted_ransack_search_fields
+    super + [
+      "events_name_cont"
+    ]
+  end
 end

spec/dummy/app/models/location.rb

@@ -3,5 +3,12 @@
 class Location < ActiveRecord::Base
   extend Alchemy::SearchableResource
   include Alchemy::Taggable
+
   has_many :events
+
+  def self.ransackable_associations(_auth_object = nil)
+    [
+      :events
+    ]
+  end
 end