Merge pull request #40 from blocknotes/handle_invalid_search_terms

Handle invalid search terms

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

@@ -7,7 +7,7 @@ module Searchable
     def scoped_resource
       options = respond_to?(:ransack_options, true) ? ransack_options : {}
       distinct = respond_to?(:ransack_result_distinct, true) ? ransack_result_distinct : true
-      @ransack_results = super.ransack(params[:q], **options)
+      @ransack_results = prepare_search(resource_collection: super, query_params: params[:q], options: options)
       @ransack_results.result(distinct: distinct)
     end
 
@@ -25,5 +25,26 @@ def prepended(base)
         base.helper_method :sanitized_order_params
       end
     end
+
+    private
+
+    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 ransack_invalid_search_error(error)
+      if respond_to?(:invalid_search_callback, true)
+        invalid_search_callback(error)
+      else
+        flash.now[:alert] = I18n.t('administrate_ransack.errors.invalid_search', default: error.message)
+      end
+    end
   end
 end

spec/controllers/admin/posts_controller_spec.rb

@@ -8,11 +8,26 @@
       expect(assigns(:ransack_results)).to be_instance_of Ransack::Search
     end
 
-    context "when ransack_options is defined" do
-      it "raises an exception with an invalid parameter" do
+    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" }
+
+        expect(assigns(:ransack_results)).to be_instance_of Ransack::Search
+        expect(flash[:alert]).to eq 'Invalid search term title2_cont'
+      end
+    end
+
+    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
+
+      it "executes the callback method" do
         expect {
           get :index, params: { "q[title2_cont]" => "test" }
-        }.to raise_exception(ArgumentError, 'Invalid search term title2_cont')
+        }.to raise_exception("Some error: Invalid search term title2_cont")
       end
     end
   end