fix: Use equality check to filter ENUMs

Co-authored-by: Grant Bakker <grant@bakker.pw>, fixes #19

Author: puntonim

migrations/20181211174223-create-user.js

@@ -1,3 +1,8 @@
+GENDER_CHOICES = {
+  MALE: "male",
+  FEMALE: "female",
+}
+
 module.exports = {
   up: (queryInterface, Sequelize) => {
     return queryInterface.createTable('Users', {
@@ -14,7 +19,9 @@ module.exports = {
         type: Sequelize.STRING,
       },
       gender: {
-        type: Sequelize.STRING,
+        type: Sequelize.ENUM({
+          values: Object.values(GENDER_CHOICES),
+        }),
       },
       email: {
         type: Sequelize.STRING,

spec/resource.spec.js

@@ -72,6 +72,47 @@ describe('Resource', function () {
     })
   })
 
+  describe('#find with filter', function () {
+    beforeEach(async function () {
+      this.params = {
+        gender: 'male',
+        email: 'john.doe@softwarebrothers.co',
+      }
+      this.record = await this.resource.create(this.params)
+    })
+
+    it('returns 1 BaseRecord when filtering on ENUMS', async function () {
+      const filter = new Filter({
+        gender: 'male',
+      }, this.resource)
+      const records = await this.resource.find(filter, { limit: 20, offset: 0, sort: { direction: 'asc', sortBy: 'id' } })
+
+      expect(records).to.have.lengthOf(1)
+      expect(records[0]).to.be.instanceOf(BaseRecord)
+      expect(records[0].params.gender).to.equal('male')
+    })
+
+    it('returns 0 BaseRecord when filtering on ENUMS', async function () {
+      const filter = new Filter({
+        gender: 'female',
+      }, this.resource)
+      const records = await this.resource.find(filter, { limit: 20, offset: 0, sort: { direction: 'asc', sortBy: 'id' } })
+
+      expect(records).to.have.lengthOf(0)
+    })
+
+    it('returns error when filtering on ENUMS with invalid value', async function () {
+      const filter = new Filter({
+        gender: 'XXX',
+      }, this.resource)
+      try {
+        await this.resource.find(filter, { limit: 20, offset: 0, sort: { direction: 'asc', sortBy: 'id' } })
+      } catch (error) {
+        expect(error).to.be.an.instanceOf(db.sequelize.DatabaseError)
+      }
+    })
+  })
+
   describe('#count', function () {
     it('returns 0 when there are none elements', async function () {
       const count = await this.resource.count(new Filter({}))

src/utils/convert-filter.js

@@ -9,6 +9,12 @@ const convertFilter = (filter) => {
     const { property, value } = filterProperty
     switch (property.type()) {
     case 'string':
+      if (property.sequelizePath.values) {
+        return {
+          [property.name()]: { [Op.eq]: `${escape(value)}` },
+          ...memo,
+        }
+      }
       return {
         [property.name()]: { [Op.like]: `%${escape(value)}%` },
         ...memo,