refactor: Small internal changes

Author: blocknotes

config/locales/en.yml

@@ -1,5 +1,8 @@
 en:
   administrate_ransack:
+    ## Optional error key
+    # errors:
+    #   invalid_search: Invalid search term!
     filters:
       'clear_filters': Clear filters
       'no': 'No'

lib/administrate_ransack/searchable.rb

@@ -5,15 +5,10 @@
 module AdministrateRansack
   module Searchable
     def scoped_resource
-      options = respond_to?(:ransack_options) ? ransack_options : {}
-      begin
-        @ransack_results = super.ransack(params[:q], **options)
-      rescue ArgumentError => e
-        handle_ransack_argument_error(e)
-        set_flash_message_as_ransack_argument_error(e)
-        @ransack_results = reset_ransack_result_on_error(super).ransack({}, **options)
-      end
-      @ransack_results.result(distinct: true)
+      options = respond_to?(:ransack_options, true) ? ransack_options : {}
+      distinct = respond_to?(:ransack_result_distinct, true) ? ransack_result_distinct : true
+      @ransack_results = prepare_search(resource_collection: super, query_params: params[:q], options: options)
+      @ransack_results.result(distinct: distinct)
     end
 
     # ref => https://github.com/thoughtbot/administrate/blob/v0.18.0/app/helpers/administrate/application_helper.rb#L72-L78
@@ -33,29 +28,27 @@ def prepended(base)
 
     private
 
-    def set_flash_message_as_ransack_argument_error(error)
-      if error.message.eql?("Invalid sorting parameter provided")
-        flash.now[:alert] = I18n.t(
-          :invalid_sorting_parameter_provided,
-          scope: [:administrate_ransack, :errors],
-          default: error.message
-        )
-      elsif error.message.start_with?("Invalid search term ")
-        flash.now[:alert] = I18n.t(
-          :invalid_search_term,
-          search_term: error.message.split(' ')[3..].join(' '),
-          scope: [:administrate_ransack, :errors],
-          default: error.message
-        )
+    def prepare_search(resource_collection:, query_params:, options:)
+      resource_collection.ransack(query_params, **options)
+    rescue ArgumentError => e
+      if defined?(Ransack::InvalidSearchError) && e.is_a?(Ransack::InvalidSearchError) # rubocop:disable Style/GuardClause
+        ransack_invalid_search_error(e)
+        resource_collection.ransack({}, **options)
+      else
+        raise e
       end
     end
 
-    def handle_ransack_argument_error(error)
-      super if defined?(super)
+    def ransack_invalid_search_error(error)
+      if respond_to?(:invalid_search_callback, true)
+        invalid_search_callback(error)
+      else
+        invalid_search_flash_message(error, severity: :alert)
+      end
     end
 
-    def reset_ransack_result_on_error(super_scoped_resource)
-      super_scoped_resource.none
+    def invalid_search_flash_message(error, severity:)
+      flash.now[severity] = I18n.t('administrate_ransack.errors.invalid_search', default: error.message)
     end
   end
 end

spec/controllers/admin/posts_controller_spec.rb

@@ -8,44 +8,26 @@
       expect(assigns(:ransack_results)).to be_instance_of Ransack::Search
     end
 
-    context "when ransack_options is defined" do
-      context "when you want to handle the error manualy" do
-        controller do
-          def handle_ransack_argument_error(error)
-            raise error
-          end
-        end
+    context "when an invalid search term is provided" do
+      it "shows an alert message", :aggregate_failures do
+        get :index, params: { "q[title2_cont]" => "test", "q[category_eq]" => "news" }
 
-        it "raises an exception with an invalid parameter" do
-          expect {
-            get :index, params: { "q[title2_cont]" => "test" }
-          }.to raise_exception(ArgumentError, 'Invalid search term title2_cont')
-        end
+        expect(assigns(:ransack_results)).to be_instance_of Ransack::Search
+        expect(flash[:alert]).to eq 'Invalid search term title2_cont'
       end
+    end
 
-      context "when you want to reset the ransack result and display a flash message on error" do
-        it "resets the ransack result and displays a flash message" do
-          get :index, params: { "q[title2_cont]" => "test" }
-
-          expect(assigns(:ransack_results)).to be_instance_of Ransack::Search
-          expect(assigns(:ransack_results).result).to be_empty
-          expect(flash[:alert]).to eq 'Invalid search term title2_cont'
+    context "when an invalid_search_callback method is defined and an invalid search term is provided" do
+      controller do
+        def invalid_search_callback(error)
+          raise "Some error: #{error.message}"
         end
       end
 
-      context "when you want to not reset the ransack result on error" do
-        controller do
-          def reset_ransack_result_on_error(super_scoped_resource)
-            super_scoped_resource
-          end
-        end
-
-        it "does not reset the ransack result" do
+      it "executes the callback method" do
+        expect {
           get :index, params: { "q[title2_cont]" => "test" }
-
-          expect(assigns(:ransack_results)).to be_instance_of Ransack::Search
-          expect(assigns(:ransack_results).result).to_not be_empty
-        end
+        }.to raise_exception("Some error: Invalid search term title2_cont")
       end
     end
   end