Raise error on unknown view column 'cond:' params

Author: n-rodriguez

CHANGELOG.md

@@ -10,6 +10,7 @@
 * Improve specs
 * `AjaxDatatablesRails.config.db_adapter=` is removed and is configured per datatable class now. It defaults to Rails DB adapter. (fixes [#364](https://github.com/jbox-web/ajax-datatables-rails/issues/364))
 * Fix lib loading with JRuby (fixes [#371](https://github.com/jbox-web/ajax-datatables-rails/issues/371))
+* Raise an error when column's `cond:` setting is unknown
 
 ## 1.2.0 (2020-04-19)
 

lib/ajax-datatables-rails/datatable/column.rb

@@ -16,6 +16,7 @@ def initialize(datatable, index, options)
         @index       = index
         @options     = options
         @view_column = datatable.view_columns[options[:data].to_sym]
+        validate_settings!
       end
 
       def data
@@ -85,6 +86,27 @@ def casted_column
         @casted_column ||= ::Arel::Nodes::NamedFunction.new('CAST', [table[field].as(type_cast)])
       end
 
+      def validate_settings!
+        raise AjaxDatatablesRails::Error::InvalidSearchCondition, cond unless valid_search_condition?(cond)
+      end
+
+      VALID_SEARCH_CONDITIONS = [
+        # String condition
+        :start_with, :end_with, :like, :string_eq, :string_in, :null_value,
+        # Numeric condition
+        :eq, :not_eq, :lt, :gt, :lteq, :gteq, :in,
+        # Date condition
+        :date_range
+      ]
+
+      private_constant :VALID_SEARCH_CONDITIONS
+
+      def valid_search_condition?(cond)
+        return true if cond.is_a?(Proc)
+
+        VALID_SEARCH_CONDITIONS.include?(cond)
+      end
+
     end
   end
 end

lib/ajax-datatables-rails/datatable/column/search.rb

@@ -61,8 +61,6 @@ def non_regex_search
             filter
           when :eq, :not_eq, :lt, :gt, :lteq, :gteq, :in
             searchable_integer? ? raw_search(cond) : empty_search
-          when :null_value
-            null_value_search
           when :start_with
             casted_column.matches("#{formatted_value}%")
           when :end_with
@@ -73,6 +71,8 @@ def non_regex_search
             raw_search(:eq)
           when :string_in
             raw_search(:in)
+          when :null_value
+            null_value_search
           when :date_range
             date_range_search
           end

lib/ajax-datatables-rails/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module AjaxDatatablesRails
+  module Error
+    class BaseError < StandardError; end
+    class InvalidSearchCondition < BaseError; end
+  end
+end

spec/ajax-datatables-rails/orm/active_record_filter_records_spec.rb

@@ -107,6 +107,7 @@
         end
       end
 
+      # TODO: improve (or delete?) this test
       context 'when column.search_query returns nil' do
         let(:datatable) { DatatableCondUnknown.new(sample_params) }
 
@@ -115,6 +116,8 @@
         end
 
         it 'does not raise error' do
+          allow_any_instance_of(AjaxDatatablesRails::Datatable::Column).to receive(:valid_search_condition?).and_return(true)
+
           expect {
             datatable.data.size
           }.to_not raise_error
@@ -590,5 +593,19 @@
         end
       end
     end
+
+    context 'unknown condition' do
+      let(:datatable) { DatatableCondUnknown.new(sample_params) }
+
+      before(:each) do
+        datatable.params[:search] = { value: 'john doe', regex: 'false' }
+      end
+
+      it 'should raise error' do
+        expect {
+          datatable.data.size
+        }.to raise_error(AjaxDatatablesRails::Error::InvalidSearchCondition).with_message('foo')
+      end
+    end
   end
 end

spec/spec_helper.rb

@@ -78,5 +78,6 @@
 load File.dirname(__FILE__) + '/support/datatable_cond_numeric.rb'
 load File.dirname(__FILE__) + '/support/datatable_cond_proc.rb'
 load File.dirname(__FILE__) + '/support/datatable_cond_string.rb'
+load File.dirname(__FILE__) + '/support/datatable_cond_unknown.rb'
 load File.dirname(__FILE__) + '/support/datatable_order_nulls_last.rb'
 require File.dirname(__FILE__) + '/support/test_models.rb'

spec/support/datatable_cond_unknown.rb

@@ -0,0 +1,5 @@
+class DatatableCondUnknown < ComplexDatatable
+  def view_columns
+    super.deep_merge(username: { cond: :foo })
+  end
+end