Merge pull request #3318 from mitchkettzend/default_filter_operator

Enhancement: Default filter operator for fields

Author: mshibuya

app/helpers/rails_admin/main_helper.rb

@@ -76,7 +76,7 @@ def ordered_filter_options
         options[:type]  = field.type
         options[:value] = filter_hash['v']
         options[:label] = field.label
-        options[:operator] = filter_hash['o']
+        options[:operator] = filter_hash['o'] || field.default_filter_operator
         options[:required] = field.required
         options
       end if ordered_filters

app/views/rails_admin/main/index.html.haml

@@ -35,7 +35,7 @@
           - else
             - ''
           %li
-            %a{href: '#', :"data-field-label" => field.label, :"data-field-name" => field.name, :"data-field-options" => field_options.html_safe, :"data-field-required" => field.required.to_s, :"data-field-type" => field.type, :"data-field-value" => "", :"data-field-datetimepicker-format" => (field.try(:parser) && field.parser.to_momentjs)}= capitalize_first_letter(field.label)
+            %a{href: '#', :"data-field-label" => field.label, :"data-field-name" => field.name, :"data-field-operator" => field.default_filter_operator, :"data-field-options" => field_options.html_safe, :"data-field-required" => field.required.to_s, :"data-field-type" => field.type, :"data-field-value" => "", :"data-field-datetimepicker-format" => (field.try(:parser) && field.parser.to_momentjs)}= capitalize_first_letter(field.label)
 
 %style
   - properties.select{ |p| p.column_width.present? }.each do |property|

lib/rails_admin/config/fields/base.rb

@@ -227,6 +227,10 @@ def virtual?
           bindings[:view].render partial: "rails_admin/main/#{partial}", locals: {field: self, form: bindings[:form]}
         end
 
+        register_instance_option :default_filter_operator do
+          nil
+        end
+
         def editable?
           !(@properties && @properties.read_only?)
         end

spec/integration/actions/index_spec.rb

@@ -304,6 +304,12 @@
     it 'displays base filters when no filters are present in the params' do
       RailsAdmin.config Player do
         list { filters([:name, :team]) }
+        field :name do
+          default_filter_operator 'is'
+        end
+        field :team do
+          filterable true
+        end
       end
       visit index_path(model_name: 'player')
 
@@ -314,7 +320,7 @@
           name: 'name',
           type: 'string',
           value: '',
-          operator: nil,
+          operator: 'is',
           required: true,
         },
         {

spec/rails_admin/config/fields/base_spec.rb

@@ -556,4 +556,21 @@ class FieldVisibilityTest < Tableless
       expect(RailsAdmin.config(Team).field(:name).allowed_methods).to eq [:name]
     end
   end
+
+  describe '#default_filter_operator' do
+    it 'has a default and be user customizable' do
+      RailsAdmin.config Team do
+        list do
+          field :division
+          field :name do
+            default_filter_operator 'is'
+          end
+        end
+      end
+      name_field = RailsAdmin.config('Team').list.fields.detect { |f| f.name == :name }
+      expect(name_field.default_filter_operator).to eq('is') # custom via user specification
+      division_field = RailsAdmin.config('Team').list.fields.detect { |f| f.name == :division }
+      expect(division_field.default_filter_operator).to be nil # rails_admin generic fallback
+    end
+  end
 end