support enum (#1665)

Co-authored-by: Greg Molnar <gregmolnar@users.noreply.github.com>

Author: pekopekopekopayo

lib/ransack/nodes/attribute.rb

@@ -31,6 +31,8 @@ def associated_collection?
       def type
         if ransacker
           ransacker.type
+        elsif enum?
+          :enum
         else
           context.type_for(self)
         end
@@ -54,6 +56,14 @@ def inspect
         "Attribute <#{name}>"
       end
 
+      private
+
+      def enum?
+        bound? &&
+        klass.respond_to?(:defined_enums) &&
+        klass.defined_enums.key?(attr_name.to_s)
+      end
+
     end
   end
 end

lib/ransack/nodes/value.rb

@@ -24,6 +24,8 @@ def hash
 
       def cast(type)
         case type
+        when :enum
+          value
         when :date
           cast_to_date(value)
         when :datetime, :timestamp, :time, :timestamptz

spec/ransack/search_spec.rb

@@ -456,6 +456,49 @@ module Ransack
       let(:notable_type_field) {
         "#{quote_table_name("notes")}.#{quote_column_name("notable_type")}"
       }
+      let(:people_temperament_field) {
+        "#{quote_table_name("people")}.#{quote_column_name("temperament")}"
+      }
+
+      context 'when evaluating enums' do
+        before do
+          Person.first.update_attribute(:temperament, 'choleric')
+        end
+
+        it 'evaluates enum key correctly' do
+          s = Search.new(Person, temperament_eq: 'choleric')
+
+          expect(s.result.to_sql).not_to match(/#{people_temperament_field} = 0/)
+          expect(s.result.to_sql).to match(/#{people_temperament_field} = #{Person.temperaments[:choleric]}/)
+          expect(s.result).not_to be_empty
+        end
+
+        it 'evaluates enum value correctly' do
+          s = Search.new(Person, temperament_eq: Person.temperaments[:choleric])
+
+          expect(s.result.to_sql).not_to match(/#{people_temperament_field} = 0/)
+          expect(s.result.to_sql).to match(/#{people_temperament_field} = #{Person.temperaments[:choleric]}/)
+          expect(s.result).not_to be_empty
+        end
+      end
+
+      # Regression test for https://github.com/activerecord-hackery/ransack/issues/1644
+      context 'when enum fix does not break boolean predicate casting' do
+        it 'casts 0 to false for not_null predicate' do
+          s = Search.new(Person, name_not_null: 0)
+          expect(s.result.to_sql).to match(/#{people_name_field} IS NULL/)
+        end
+
+        it 'casts 1 to true for not_null predicate' do
+          s = Search.new(Person, name_not_null: 1)
+          expect(s.result.to_sql).to match(/#{people_name_field} IS NOT NULL/)
+        end
+
+        it 'casts "false" to false for not_null predicate' do
+          s = Search.new(Person, name_not_null: 'false')
+          expect(s.result.to_sql).to match(/#{people_name_field} IS NULL/)
+        end
+      end
 
       it 'evaluates conditions contextually' do
         s = Search.new(Person, children_name_eq: 'Ernie')

spec/support/schema.rb

@@ -64,6 +64,8 @@ class Person < ApplicationRecord
   has_many   :articles
   has_many   :story_articles
 
+  enum :temperament, { sanguine: 1, choleric: 2, melancholic: 3, phlegmatic: 4 }
+
   has_many :published_articles, ->{ where(published: true) },
       class_name: "Article"
   has_many   :comments
@@ -304,6 +306,7 @@ def self.create
         t.boolean  :awesome, default: false
         t.boolean  :terms_and_conditions, default: false
         t.boolean  :true_or_false, default: true
+        t.integer  :temperament
         t.timestamps null: false
       end