add support for IN and NOT IN

README.md

@@ -134,10 +134,14 @@ Request : `/cars?search=color!Red`
 
 3. Using the greater than operator `>`  
 Request : `/cars?search=creationyear>2017`  
+> Note: You can use the `>:` operator as well.
+
 ![greater than operator example](./docs/images/greater-than-example.gif)
 
 4. Using the less than operator `<`  
-Request : `/cars?search=price<100000`  
+Request : `/cars?search=price<100000`
+> Note: You can use the `<:` operator as well.
+
 ![less than operator example](./docs/images/less-than-example.gif)
 
 5. Using the starts with operator `*`  
@@ -154,6 +158,12 @@ Request : `/cars?search=color:Red OR color:Blue`
 Request : `/cars?search=brand:Aston* AND price<300000`  
 ![and operator example](./docs/images/and-example.gif)
 
+7. Using the `IN` and `NOT IN` operators  
+Request : `/cars?search=color IN ['Red', 'Blue']  
+*Note: Spaces inside the brackets are not necessary*  
+*Note: You will need to encode the value (e.g. encodeURI) as brackets are not valid url parts*
+
+
 8. Using parenthesis  
 Request : `/cars?search=( brand:Nissan OR brand:Chevrolet ) AND color:Blue`  
 *Note: Spaces inside the parenthesis are not necessary*

src/main/antlr4/Query.g4

@@ -4,6 +4,7 @@ Copyright (c) 2019, Michael Mollard
 
 grammar Query;
 
+// syntactic rules
 input
    : query EOF
    ;
@@ -22,21 +23,31 @@ key
    : IDENTIFIER
    ;
 
+array
+   : LBRACKET (value (',' value)* )? RBRACKET
+   ;
+
 value
-   : IDENTIFIER
+   : array
+   | IDENTIFIER
    | STRING
    | ENCODED_STRING
    | NUMBER
    | BOOL
-   ;
+  ;
 
 op
    : EQ
    | GT
+   | GTE
    | LT
+   | LTE
    | NOT_EQ
+   | IN
+   | NOT_IN
    ;
 
+// lexical rules
 BOOL
     : 'true'
     | 'false'
@@ -132,21 +143,41 @@ RPAREN
    : ')'
    ;
 
+LBRACKET
+   : '['
+   ;
+
+RBRACKET
+    : ']'
+    ;
 
 GT
    : '>'
    ;
 
+GTE
+   : '>:'
+   ;
 
 LT
    : '<'
    ;
 
+LTE
+   : '<:'
+   ;
 
 EQ
    : ':'
    ;
 
+IN
+   : 'IN'
+   ;
+
+NOT_IN
+    : 'NOT IN'
+    ;
 
 NOT_EQ
    : '!'
@@ -161,14 +192,15 @@ IDENTIFIER
    : [A-Za-z0-9.]+
    ;
 
-ENCODED_STRING
-   : ~([ :<>!()])+
+ENCODED_STRING //anything but these characters :<>!()[], and whitespace
+   : ~([ ,:<>!()[\]])+
    ;
 
+
 LineTerminator
 : [\r\n\u2028\u2029] -> channel(HIDDEN)
 ;
 
 WS
    : [ \t\r\n]+ -> skip
-   ;
+   ;

src/main/kotlin/com/sipios/springsearch/QueryVisitorImpl.kt

@@ -34,15 +34,23 @@ class QueryVisitorImpl<T>(private val searchSpecAnnotation: SearchSpec) : QueryB
         val key = ctx.key()!!.text
         val op = ctx.op()!!.text
         var value = ctx.value()!!.text
-
         if (ctx.value().STRING() != null) {
-            value = value
-                .removeSurrounding("'")
-                .removeSurrounding("\"")
-                .replace("\\\"", "\"")
-                .replace("\\'", "'")
+            value = clearString(value)
+        } else if (ctx.value().array() != null) {
+            val arr = ctx.value().array()
+            val arrayValues = arr.value()
+            val valueAsList: List<String> =
+                arrayValues.map { if (it.STRING() != null) clearString(it.text) else it.text }
+            // there is no need for prefix and suffix (e.g. 'john*') in case of array value
+            val criteria = SearchCriteria(
+                key,
+                op,
+                null,
+                valueAsList,
+                null
+            )
+            return SpecificationImpl(criteria, searchSpecAnnotation)
         }
-
         val matchResult = this.valueRegExp.find(value!!)
         val criteria = SearchCriteria(
             key,
@@ -54,4 +62,10 @@ class QueryVisitorImpl<T>(private val searchSpecAnnotation: SearchSpec) : QueryB
 
         return SpecificationImpl(criteria, searchSpecAnnotation)
     }
+
+    private fun clearString(value: String) = value
+        .removeSurrounding("'")
+        .removeSurrounding("\"")
+        .replace("\\\"", "\"")
+        .replace("\\'", "'")
 }

src/main/kotlin/com/sipios/springsearch/SearchCriteria.kt

@@ -1,11 +1,11 @@
 package com.sipios.springsearch
 
 class SearchCriteria // Change EQUALS into ENDS_WITH, CONTAINS, STARTS_WITH based on the presence of * in the value
-    (var key: String, operation: String, prefix: String?, var value: String, suffix: String?) {
+    (var key: String, operation: String, prefix: String?, var value: Any?, suffix: String?) {
     var operation: SearchOperation?
 
     init {
-        var op = SearchOperation.getSimpleOperation(operation[0])
+        var op = SearchOperation.getSimpleOperation(operation)
         if (op != null) {
             // Change EQUALS into ENDS_WITH, CONTAINS, STARTS_WITH based on the presence of * in the value
             val startsWithAsterisk = prefix != null && prefix.contains(SearchOperation.ZERO_OR_MORE_REGEX)

src/main/kotlin/com/sipios/springsearch/SearchOperation.kt

@@ -1,10 +1,10 @@
 package com.sipios.springsearch
 
 enum class SearchOperation {
-    EQUALS, NOT_EQUALS, GREATER_THAN, LESS_THAN, STARTS_WITH, ENDS_WITH, CONTAINS, DOESNT_START_WITH, DOESNT_END_WITH, DOESNT_CONTAIN;
+    EQUALS, NOT_EQUALS, GREATER_THAN, LESS_THAN, STARTS_WITH, ENDS_WITH, CONTAINS, DOESNT_START_WITH, DOESNT_END_WITH, DOESNT_CONTAIN, GREATER_THAN_EQUALS, LESS_THAN_EQUALS, IN, NOT_IN;
 
     companion object {
-        val SIMPLE_OPERATION_SET = arrayOf(":", "!", ">", "<", "~")
+        val SIMPLE_OPERATION_SET = arrayOf(":", "!", ">", "<", "~", ">:", "<:")
         val ZERO_OR_MORE_REGEX = "*"
         val OR_OPERATOR = "OR"
         val AND_OPERATOR = "AND"
@@ -17,12 +17,16 @@ enum class SearchOperation {
          * @param input operation as string
          * @return The matching operation
          */
-        fun getSimpleOperation(input: Char): SearchOperation? {
+        fun getSimpleOperation(input: String): SearchOperation? {
             return when (input) {
-                ':' -> EQUALS
-                '!' -> NOT_EQUALS
-                '>' -> GREATER_THAN
-                '<' -> LESS_THAN
+                ":" -> EQUALS
+                "!" -> NOT_EQUALS
+                ">" -> GREATER_THAN
+                "<" -> LESS_THAN
+                ">:" -> GREATER_THAN_EQUALS
+                "<:" -> LESS_THAN_EQUALS
+                "IN" -> IN
+                "NOT IN" -> NOT_IN
                 else -> null
             }
         }

src/main/kotlin/com/sipios/springsearch/SpecificationImpl.kt

@@ -19,7 +19,8 @@ import org.springframework.web.server.ResponseStatusException
  *
  * @param <T>The class on which the specification will be applied</T>
  * */
-class SpecificationImpl<T>(private val criteria: SearchCriteria, private val searchSpecAnnotation: SearchSpec) : Specification<T> {
+class SpecificationImpl<T>(private val criteria: SearchCriteria, private val searchSpecAnnotation: SearchSpec) :
+    Specification<T> {
     @Throws(ResponseStatusException::class)
     override fun toPredicate(root: Root<T>, query: CriteriaQuery<*>, builder: CriteriaBuilder): Predicate? {
         val nestedKey = criteria.key.split(".")
@@ -29,7 +30,13 @@ class SpecificationImpl<T>(private val criteria: SearchCriteria, private val sea
         val strategy = ParsingStrategy.getStrategy(fieldClass, searchSpecAnnotation)
         val value: Any?
         try {
-            value = strategy.parse(criteria.value, fieldClass)
+            value = if (criteria.value is List<*>) {
+                ParsingStrategy.getStrategy(fieldClass, searchSpecAnnotation)
+                    .parse(criteria.value as List<*>, fieldClass)
+            } else {
+                ParsingStrategy.getStrategy(fieldClass, searchSpecAnnotation)
+                    .parse(criteria.value?.toString(), fieldClass)
+            }
         } catch (e: Exception) {
             throw ResponseStatusException(
                 HttpStatus.BAD_REQUEST,

src/main/kotlin/com/sipios/springsearch/strategies/DateStrategy.kt

@@ -22,6 +22,8 @@ class DateStrategy : ParsingStrategy {
         return when (ops) {
             SearchOperation.GREATER_THAN -> builder.greaterThan(path[fieldName], value as Date)
             SearchOperation.LESS_THAN -> builder.lessThan(path[fieldName], value as Date)
+            SearchOperation.GREATER_THAN_EQUALS -> builder.greaterThanOrEqualTo(path[fieldName], value as Date)
+            SearchOperation.LESS_THAN_EQUALS -> builder.lessThanOrEqualTo(path[fieldName], value as Date)
             else -> super.buildPredicate(builder, path, fieldName, ops, value)
         }
     }

src/main/kotlin/com/sipios/springsearch/strategies/DoubleStrategy.kt

@@ -17,6 +17,8 @@ class DoubleStrategy : ParsingStrategy {
         return when (ops) {
             SearchOperation.GREATER_THAN -> builder.greaterThan(path[fieldName], value as Double)
             SearchOperation.LESS_THAN -> builder.lessThan(path[fieldName], value as Double)
+            SearchOperation.GREATER_THAN_EQUALS -> builder.greaterThanOrEqualTo(path[fieldName], value as Double)
+            SearchOperation.LESS_THAN_EQUALS -> builder.lessThanOrEqualTo(path[fieldName], value as Double)
             else -> super.buildPredicate(builder, path, fieldName, ops, value)
         }
     }

src/main/kotlin/com/sipios/springsearch/strategies/DurationStrategy.kt

@@ -18,6 +18,8 @@ class DurationStrategy : ParsingStrategy {
         return when (ops) {
             SearchOperation.GREATER_THAN -> builder.greaterThan(path[fieldName], value as Duration)
             SearchOperation.LESS_THAN -> builder.lessThan(path[fieldName], value as Duration)
+            SearchOperation.GREATER_THAN_EQUALS -> builder.greaterThanOrEqualTo(path[fieldName], value as Duration)
+            SearchOperation.LESS_THAN_EQUALS -> builder.lessThanOrEqualTo(path[fieldName], value as Duration)
             else -> super.buildPredicate(builder, path, fieldName, ops, value)
         }
     }

src/main/kotlin/com/sipios/springsearch/strategies/FloatStrategy.kt

@@ -17,6 +17,8 @@ class FloatStrategy : ParsingStrategy {
         return when (ops) {
             SearchOperation.GREATER_THAN -> builder.greaterThan(path[fieldName], value as Float)
             SearchOperation.LESS_THAN -> builder.lessThan(path[fieldName], value as Float)
+            SearchOperation.GREATER_THAN_EQUALS -> builder.greaterThanOrEqualTo(path[fieldName], value as Float)
+            SearchOperation.LESS_THAN_EQUALS -> builder.lessThanOrEqualTo(path[fieldName], value as Float)
             else -> super.buildPredicate(builder, path, fieldName, ops, value)
         }
     }

src/main/kotlin/com/sipios/springsearch/strategies/InstantStrategy.kt

@@ -18,6 +18,8 @@ class InstantStrategy : ParsingStrategy {
         return when (ops) {
             SearchOperation.GREATER_THAN -> builder.greaterThan(path[fieldName], value as Instant)
             SearchOperation.LESS_THAN -> builder.lessThan(path[fieldName], value as Instant)
+            SearchOperation.GREATER_THAN_EQUALS -> builder.greaterThanOrEqualTo(path[fieldName], value as Instant)
+            SearchOperation.LESS_THAN_EQUALS -> builder.lessThanOrEqualTo(path[fieldName], value as Instant)
             else -> super.buildPredicate(builder, path, fieldName, ops, value)
         }
     }

src/main/kotlin/com/sipios/springsearch/strategies/IntStrategy.kt

@@ -17,6 +17,8 @@ class IntStrategy : ParsingStrategy {
         return when (ops) {
             SearchOperation.GREATER_THAN -> builder.greaterThan(path[fieldName], value as Int)
             SearchOperation.LESS_THAN -> builder.lessThan(path[fieldName], value as Int)
+            SearchOperation.GREATER_THAN_EQUALS -> builder.greaterThanOrEqualTo(path[fieldName], value as Int)
+            SearchOperation.LESS_THAN_EQUALS -> builder.lessThanOrEqualTo(path[fieldName], value as Int)
             else -> super.buildPredicate(builder, path, fieldName, ops, value)
         }
     }

src/main/kotlin/com/sipios/springsearch/strategies/LocalDateStrategy.kt

@@ -18,6 +18,8 @@ class LocalDateStrategy : ParsingStrategy {
         return when (ops) {
             SearchOperation.GREATER_THAN -> builder.greaterThan(path[fieldName], value as LocalDate)
             SearchOperation.LESS_THAN -> builder.lessThan(path[fieldName], value as LocalDate)
+            SearchOperation.GREATER_THAN_EQUALS -> builder.greaterThanOrEqualTo(path[fieldName], value as LocalDate)
+            SearchOperation.LESS_THAN_EQUALS -> builder.lessThanOrEqualTo(path[fieldName], value as LocalDate)
             else -> super.buildPredicate(builder, path, fieldName, ops, value)
         }
     }

src/main/kotlin/com/sipios/springsearch/strategies/LocalDateTimeStrategy.kt

@@ -18,6 +18,8 @@ class LocalDateTimeStrategy : ParsingStrategy {
         return when (ops) {
             SearchOperation.GREATER_THAN -> builder.greaterThan(path[fieldName], value as LocalDateTime)
             SearchOperation.LESS_THAN -> builder.lessThan(path[fieldName], value as LocalDateTime)
+            SearchOperation.GREATER_THAN_EQUALS -> builder.greaterThanOrEqualTo(path[fieldName], value as LocalDateTime)
+            SearchOperation.LESS_THAN_EQUALS -> builder.lessThanOrEqualTo(path[fieldName], value as LocalDateTime)
             else -> super.buildPredicate(builder, path, fieldName, ops, value)
         }
     }

src/main/kotlin/com/sipios/springsearch/strategies/LocalTimeStrategy.kt

@@ -18,6 +18,8 @@ class LocalTimeStrategy : ParsingStrategy {
         return when (ops) {
             SearchOperation.GREATER_THAN -> builder.greaterThan(path[fieldName], value as LocalTime)
             SearchOperation.LESS_THAN -> builder.lessThan(path[fieldName], value as LocalTime)
+            SearchOperation.GREATER_THAN_EQUALS -> builder.greaterThanOrEqualTo(path[fieldName], value as LocalTime)
+            SearchOperation.LESS_THAN_EQUALS -> builder.lessThanOrEqualTo(path[fieldName], value as LocalTime)
             else -> super.buildPredicate(builder, path, fieldName, ops, value)
         }
     }

src/main/kotlin/com/sipios/springsearch/strategies/ParsingStrategy.kt

@@ -27,6 +27,10 @@ interface ParsingStrategy {
         return value
     }
 
+    fun parse(value: List<*>?, fieldClass: KClass<out Any>): Any? {
+        return value?.map { parse(it.toString(), fieldClass) }
+    }
+
     /**
      * Method to build the predicate
      *
@@ -45,6 +49,16 @@ interface ParsingStrategy {
         value: Any?
     ): Predicate? {
         return when (ops) {
+            SearchOperation.IN -> {
+                val inClause: CriteriaBuilder.In<Any> = getInClause(builder, path, fieldName, value)
+                inClause
+            }
+
+            SearchOperation.NOT_IN -> {
+                val inClause: CriteriaBuilder.In<Any> = getInClause(builder, path, fieldName, value)
+                builder.not(inClause)
+            }
+
             SearchOperation.EQUALS -> builder.equal(path.get<Any>(fieldName), value)
             SearchOperation.NOT_EQUALS -> builder.notEqual(path.get<Any>(fieldName), value)
             SearchOperation.STARTS_WITH -> builder.like(path[fieldName], "$value%")
@@ -56,10 +70,23 @@ interface ParsingStrategy {
                 (path.get<String>(fieldName).`as`(String::class.java)),
                 "%$value%"
             )
+
             else -> null
         }
     }
 
+    fun getInClause(
+        builder: CriteriaBuilder,
+        path: Path<*>,
+        fieldName: String,
+        value: Any?
+    ): CriteriaBuilder.In<Any> {
+        val inClause: CriteriaBuilder.In<Any> = builder.`in`(path.get(fieldName))
+        val values = value as List<*>
+        values.forEach { inClause.value(it) }
+        return inClause
+    }
+
     companion object {
         fun getStrategy(fieldClass: KClass<out Any>, searchSpecAnnotation: SearchSpec): ParsingStrategy {
             return when {

src/main/kotlin/com/sipios/springsearch/strategies/StringStrategy.kt

@@ -15,6 +15,9 @@ data class StringStrategy(var searchSpecAnnotation: SearchSpec) : ParsingStrateg
         ops: SearchOperation?,
         value: Any?
     ): Predicate? {
+        if (ops == SearchOperation.NOT_IN || ops == SearchOperation.IN) {
+            return super.buildPredicate(builder, path, fieldName, ops, value)
+        }
         if (!searchSpecAnnotation.caseSensitiveFlag) {
             val lowerCasedValue = (value as String).lowercase(Locale.getDefault())
             val loweredFieldValue = builder.lower(path[fieldName])