antlr error listener added & jackson auto module discovery disabled

mnesimiyilmaz · mnesimiyilmaz · commit 355504f7ea88 · 2023-10-30T02:31:08.000+03:00
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ To use the package, you need to add following dependency:
 <dependency>
     <groupId>io.github.mnesimiyilmaz</groupId>
     <artifactId>sql4json</artifactId>
-    <version>0.0.1</version>
+    <version>0.0.2</version>
 </dependency>
 ```
 
@@ -186,6 +186,10 @@ SELECT name, age FROM $r WHERE id > 0
     >>>
 SELECT objectField FROM $r.data WHERE groupName = 'users'
 ```
+Or
+```sql
+SELECT name, age FROM (SELECT objectField FROM $r.data WHERE groupName = 'users') WHERE id > 0
+```
 
 ## Functions
 ### Lower & Upper
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>io.github.mnesimiyilmaz</groupId>
     <artifactId>sql4json</artifactId>
-    <version>0.0.1</version>
+    <version>0.0.2</version>
     <packaging>jar</packaging>
     <name>SQL4Json</name>
     <description>Filter, aggregate and select data from json using SQL like query.</description>
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/SQL4JsonListenerImpl.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/SQL4JsonListenerImpl.java
@@ -5,23 +5,24 @@
 import io.github.mnesimiyilmaz.sql4json.definitions.JsonColumnWithNonAggFunctionDefinion;
 import io.github.mnesimiyilmaz.sql4json.definitions.OrderByColumnDefinion;
 import io.github.mnesimiyilmaz.sql4json.definitions.SelectColumnDefinition;
+import io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonBaseListener;
 import io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser;
 import io.github.mnesimiyilmaz.sql4json.processor.SQLBuilder;
 import io.github.mnesimiyilmaz.sql4json.processor.SQLProcessor;
-import io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonBaseListener;
 import org.antlr.v4.runtime.tree.ParseTree;
 
-import java.util.*;
+import java.util.ArrayList;
+import java.util.List;
 
 /**
  * @author mnesimiyilmaz
  */
 class SQL4JsonListenerImpl extends SQL4JsonBaseListener {
 
     private final List<SelectColumnDefinition> selectedColumns;
-    private final JsonNode dataNode;
-    private final SQLProcessor sqlProcessor;
-    private String rootPath;
+    private final JsonNode                     dataNode;
+    private final SQLProcessor                 sqlProcessor;
+    private       String                       rootPath;
 
     public SQL4JsonListenerImpl(JsonNode jsonNode) {
         this.dataNode = jsonNode;
@@ -30,59 +31,59 @@ public SQL4JsonListenerImpl(JsonNode jsonNode) {
     }
 
     @Override
-    public void enterRootNode(io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser.RootNodeContext ctx) {
+    public void enterRootNode(SQL4JsonParser.RootNodeContext ctx) {
         String path = ctx.getText();
-        if(path.startsWith("$r")){
+        if (path.startsWith("$r")) {
             this.rootPath = path.equalsIgnoreCase("$r") ? "" : path.substring(3);
         }
         getBuilder(ctx).setSelectedColumns(new ArrayList<>(selectedColumns));
         selectedColumns.clear();
     }
 
     @Override
-    public void enterSelectColumn(io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser.SelectColumnContext ctx) {
+    public void enterSelectColumn(SQL4JsonParser.SelectColumnContext ctx) {
         selectedColumns.add(new SelectColumnDefinition(ctx));
     }
 
     @Override
-    public void enterSelectedColumns(io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser.SelectedColumnsContext ctx) {
+    public void enterSelectedColumns(SQL4JsonParser.SelectedColumnsContext ctx) {
         if (ctx.ASTERISK() != null) {
             selectedColumns.add(SelectColumnDefinition.ofAsterisk());
         }
     }
 
     @Override
-    public void enterWhereConditions(io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser.WhereConditionsContext ctx) {
+    public void enterWhereConditions(SQL4JsonParser.WhereConditionsContext ctx) {
         getBuilder(ctx).setWhereClause(new ConditionProcessor(ctx.conditions()).process());
     }
 
     @Override
-    public void enterHavingConditions(io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser.HavingConditionsContext ctx) {
+    public void enterHavingConditions(SQL4JsonParser.HavingConditionsContext ctx) {
         getBuilder(ctx).setHavingClause(new ConditionProcessor(ctx.conditions()).process());
     }
 
     @Override
-    public void enterGroupByColumn(io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser.GroupByColumnContext ctx) {
+    public void enterGroupByColumn(SQL4JsonParser.GroupByColumnContext ctx) {
         getBuilder(ctx).addGroupByColumn(new JsonColumnWithNonAggFunctionDefinion(ctx.jsonColumnWithNonAggFunction()));
     }
 
     @Override
-    public void enterOrderByColumn(io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser.OrderByColumnContext ctx) {
+    public void enterOrderByColumn(SQL4JsonParser.OrderByColumnContext ctx) {
         getBuilder(ctx).addOrderByColumn(new OrderByColumnDefinion(ctx));
     }
 
-    public JsonNode getResult(){
+    public JsonNode getResult() {
         return sqlProcessor.process(dataNode, rootPath);
     }
 
-    private SQLBuilder getBuilder(ParseTree tree){
+    private SQLBuilder getBuilder(ParseTree tree) {
         return sqlProcessor.getBuilder(sql4JsonContextNameOf(tree));
     }
 
-    private static String sql4JsonContextNameOf(ParseTree tree){
+    private static String sql4JsonContextNameOf(ParseTree tree) {
         ParseTree parent = tree.getParent();
 
-        while (!(parent instanceof SQL4JsonParser.Sql4jsonContext)){
+        while (!(parent instanceof SQL4JsonParser.Sql4jsonContext)) {
             parent = parent.getParent();
         }
         return parent.toString();
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/SQL4JsonProcessor.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/SQL4JsonProcessor.java
@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonLexer;
 import io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser;
+import io.github.mnesimiyilmaz.sql4json.utils.AntlrSyntaxErrorListener;
 import org.antlr.v4.runtime.CharStreams;
 import org.antlr.v4.runtime.CommonTokenStream;
 import org.antlr.v4.runtime.tree.ParseTreeWalker;
@@ -16,7 +17,7 @@ public class SQL4JsonProcessor {
 
     private SQL4JsonInput sql4JsonInput;
     private int           currentQuery;
-    private JsonNode  result;
+    private JsonNode      result;
 
     public SQL4JsonProcessor(SQL4JsonInput sql4JsonInput) {
         this.queries = sql4JsonInput.getSql().split(">>>");
@@ -28,8 +29,11 @@ public JsonNode getResult() {
         if (result != null) return result;
 
         do {
+            AntlrSyntaxErrorListener errorListener = new AntlrSyntaxErrorListener();
             SQL4JsonLexer lexer = new SQL4JsonLexer(CharStreams.fromString(sql4JsonInput.getSql()));
+            lexer.addErrorListener(errorListener);
             SQL4JsonParser parser = new SQL4JsonParser(new CommonTokenStream(lexer));
+            parser.addErrorListener(errorListener);
             SQL4JsonListenerImpl listener = new SQL4JsonListenerImpl(sql4JsonInput.getRootNode());
             new ParseTreeWalker().walk(listener, parser.sql4json());
             result = listener.getResult();
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/condition/ConditionProcessor.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/condition/ConditionProcessor.java
@@ -1,7 +1,7 @@
 package io.github.mnesimiyilmaz.sql4json.condition;
 
-import io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser;
 import io.github.mnesimiyilmaz.sql4json.definitions.JsonColumnWithNonAggFunctionDefinion;
+import io.github.mnesimiyilmaz.sql4json.generated.SQL4JsonParser;
 import io.github.mnesimiyilmaz.sql4json.utils.ComparisonUtils;
 import io.github.mnesimiyilmaz.sql4json.utils.FieldKey;
 import io.github.mnesimiyilmaz.sql4json.utils.ValueUtils;
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/definitions/JsonColumnWithAggFunctionDefinion.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/definitions/JsonColumnWithAggFunctionDefinion.java
@@ -12,8 +12,8 @@ public class JsonColumnWithAggFunctionDefinion {
 
     private final SQL4JsonParser.JsonColumnWithAggFunctionContext ctx;
     private final JsonColumnWithNonAggFunctionDefinion            columnDefinition;
-    private final AggregateFunction                           aggregateFunction;
-    private final boolean                                     isAsterisk;
+    private final AggregateFunction                               aggregateFunction;
+    private final boolean                                         isAsterisk;
 
     public JsonColumnWithAggFunctionDefinion(SQL4JsonParser.JsonColumnWithAggFunctionContext ctx) {
         this.ctx = ctx;
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/definitions/JsonColumnWithNonAggFunctionDefinion.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/definitions/JsonColumnWithNonAggFunctionDefinion.java
@@ -18,7 +18,7 @@ public class JsonColumnWithNonAggFunctionDefinion {
 
     private final SQL4JsonParser.JsonColumnWithNonAggFunctionContext columnContext;
     private final String                                             columnName;
-    private final Function<Object, Object>                       valueDecorator;
+    private final Function<Object, Object>                           valueDecorator;
 
     public JsonColumnWithNonAggFunctionDefinion(SQL4JsonParser.JsonColumnWithNonAggFunctionContext columnContext) {
         this.columnContext = columnContext;
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/definitions/SelectColumnDefinition.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/definitions/SelectColumnDefinition.java
@@ -9,10 +9,10 @@
 @Getter
 public class SelectColumnDefinition {
 
-    private final SQL4JsonParser.SelectColumnContext    ctx;
-    private final JsonColumnWithAggFunctionDefinion columnDefinition;
-    private final String                            alias;
-    private final boolean                           isAsterisk;
+    private final SQL4JsonParser.SelectColumnContext ctx;
+    private final JsonColumnWithAggFunctionDefinion  columnDefinition;
+    private final String                             alias;
+    private final boolean                            isAsterisk;
 
     private SelectColumnDefinition() {
         this.ctx = null;
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/processor/SQLBuilder.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/processor/SQLBuilder.java
@@ -14,23 +14,23 @@
 public class SQLBuilder {
 
     @Setter
-    private List<SelectColumnDefinition> selectedColumns;
+    private List<SelectColumnDefinition>               selectedColumns;
     @Setter
-    private CriteriaNode whereClause;
+    private CriteriaNode                               whereClause;
     private List<JsonColumnWithNonAggFunctionDefinion> groupByColumns;
     @Setter
-    private CriteriaNode havingClause;
-    private List<OrderByColumnDefinion> orderByColumns;
+    private CriteriaNode                               havingClause;
+    private List<OrderByColumnDefinion>                orderByColumns;
 
-    public void addGroupByColumn(JsonColumnWithNonAggFunctionDefinion groupByColumn){
-        if(this.groupByColumns == null)
+    public void addGroupByColumn(JsonColumnWithNonAggFunctionDefinion groupByColumn) {
+        if (this.groupByColumns == null)
             this.groupByColumns = new ArrayList<>();
 
         this.groupByColumns.add(groupByColumn);
     }
 
-    public void addOrderByColumn(OrderByColumnDefinion orderByColumn){
-        if(this.orderByColumns == null)
+    public void addOrderByColumn(OrderByColumnDefinion orderByColumn) {
+        if (this.orderByColumns == null)
             this.orderByColumns = new ArrayList<>();
 
         this.orderByColumns.add(orderByColumn);
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/processor/SQLConstruct.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/processor/SQLConstruct.java
@@ -11,20 +11,23 @@
 import lombok.AccessLevel;
 import lombok.RequiredArgsConstructor;
 
-import java.util.*;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
 @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
 class SQLConstruct {
-    private List<SelectColumnDefinition> selectedColumns;
-    private CriteriaNode whereClause;
+    private List<SelectColumnDefinition>               selectedColumns;
+    private CriteriaNode                               whereClause;
     private List<JsonColumnWithNonAggFunctionDefinion> groupByColumns;
-    private CriteriaNode havingClause;
-    private List<OrderByColumnDefinion> orderByColumns;
+    private CriteriaNode                               havingClause;
+    private List<OrderByColumnDefinion>                orderByColumns;
 
-    public static SQLConstruct newInstance(SQLBuilder builder){
-        SQLConstruct sqlConstruct =  new SQLConstruct();
+    public static SQLConstruct newInstance(SQLBuilder builder) {
+        SQLConstruct sqlConstruct = new SQLConstruct();
         sqlConstruct.selectedColumns = builder.getSelectedColumns();
         sqlConstruct.whereClause = builder.getWhereClause();
         sqlConstruct.groupByColumns = builder.getGroupByColumns();
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/processor/SQLProcessor.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/processor/SQLProcessor.java
@@ -14,18 +14,18 @@ public SQLProcessor() {
         this.mapOfSQLBuilders = new LinkedHashMap<>();
     }
 
-    public SQLBuilder getBuilder(String name){
-       return mapOfSQLBuilders.computeIfAbsent(name, n -> new SQLBuilder());
+    public SQLBuilder getBuilder(String name) {
+        return mapOfSQLBuilders.computeIfAbsent(name, n -> new SQLBuilder());
     }
 
 
-    public JsonNode process(JsonNode dataNode, String rootPath){
+    public JsonNode process(JsonNode dataNode, String rootPath) {
         dataNode = JsonUtils.peelJsonNode(dataNode, rootPath);
         List<Map<FieldKey, Object>> flattenedData = JsonUtils.convertJsonToFlattenedListOfKeyValue(dataNode);
 
         Iterator<String> names = new LinkedList<>(mapOfSQLBuilders.keySet()).descendingIterator();
 
-        while (names.hasNext()){
+        while (names.hasNext()) {
             SQLConstruct sqlConstruct = SQLConstruct.newInstance(mapOfSQLBuilders.get(names.next()));
             flattenedData = sqlConstruct.apply(flattenedData);
         }
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/utils/AntlrSyntaxErrorListener.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/utils/AntlrSyntaxErrorListener.java
@@ -0,0 +1,18 @@
+package io.github.mnesimiyilmaz.sql4json.utils;
+
+import org.antlr.v4.runtime.BaseErrorListener;
+import org.antlr.v4.runtime.RecognitionException;
+import org.antlr.v4.runtime.Recognizer;
+
+public class AntlrSyntaxErrorListener extends BaseErrorListener {
+    @Override
+    public void syntaxError(Recognizer<?, ?> recognizer,
+                            Object offendingSymbol,
+                            int line,
+                            int charPositionInLine,
+                            String msg,
+                            RecognitionException e) {
+        throw new IllegalStateException(msg + " at line " + line + ":" + charPositionInLine);
+    }
+
+}
diff --git a/src/main/java/io/github/mnesimiyilmaz/sql4json/utils/JsonUtils.java b/src/main/java/io/github/mnesimiyilmaz/sql4json/utils/JsonUtils.java
@@ -5,9 +5,14 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.databind.json.JsonMapper;
+import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.JsonNodeType;
 import com.fasterxml.jackson.databind.type.CollectionType;
+import com.fasterxml.jackson.dataformat.xml.JacksonXmlModule;
+import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
 import lombok.Getter;
 
 import java.util.*;
@@ -181,7 +186,11 @@ public static JsonNode convertStructuredMapToJsonNode(List<Map<String, Object>>
     static {
         OBJECT_MAPPER = JsonMapper.builder()
                 .configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false)
-                .findAndAddModules()
+                .addModule(new JacksonXmlModule())
+                .addModule(new JavaTimeModule())
+                .addModule(new Jdk8Module())
+                .addModule(new ParameterNamesModule())
+                .addModule(new SimpleModule())
                 .defaultPrettyPrinter(new DefaultPrettyPrinter())
                 .build();
 
diff --git a/src/test/java/io/github/mnesimiyilmaz/sql4json/SQL4JsonQueryTests.java b/src/test/java/io/github/mnesimiyilmaz/sql4json/SQL4JsonQueryTests.java
@@ -4,6 +4,7 @@
 import io.github.mnesimiyilmaz.sql4json.dataclasses.Account;
 import io.github.mnesimiyilmaz.sql4json.dataclasses.Person;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.function.Executable;
 
 import java.time.LocalDate;
 import java.time.LocalDateTime;
@@ -449,9 +450,7 @@ void when_use_proper_nested_query_then_expect_no_error() {
         SQL4JsonProcessor processor = new SQL4JsonProcessor(input);
         JsonNode result = processor.getResult().get(0);
 
-        assertAll(
-                () -> assertEquals("Mücahit", result.get("username").asText())
-        );
+        assertEquals("Mücahit", result.get("username").asText());
     }
 
     @Test
@@ -479,9 +478,23 @@ void when_use_proper_nested_query_withBothInnerAndOuterWhereClause_then_expect_n
         SQL4JsonProcessor processor = new SQL4JsonProcessor(input);
         JsonNode result = processor.getResult();
 
-        assertAll(
-                () -> assertEquals("Mücahit", result.get(0).get("username").asText())
-        );
+        assertEquals("Mücahit", result.get(0).get("username").asText());
+    }
+
+    @Test
+    void when_try_to_execute_incorrect_query_then_expect_error() {
+        Executable executable = () -> {
+            Person personOne = new Person();
+            personOne.setName("Mücahit");
+            personOne.setSurname("YILMAZ");
+            personOne.setAge(26);
+
+            String jql = "select from $r";
+            SQL4JsonInput input = SQL4JsonInput.fromObject(jql, personOne);
+            SQL4JsonProcessor processor = new SQL4JsonProcessor(input);
+            processor.getResult();
+        };
+        assertThrows(IllegalStateException.class, executable);
     }
 
 }
