Merge branch 'TimothyGillespie/enableMultipleOrderBy' into TimothyGillespie/addOrderByTests

Author: TimothyGillespie

.github/workflows/maven-test.yml

@@ -0,0 +1,34 @@
+name: Maven Test
+on:
+  push:
+    branches:
+      - '**'
+      - '!master'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mariadb:latest
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+          MYSQL_DATABASE: test
+          MYSQL_USER: test
+          MYSQL_PASSWORD: test
+          MYSQL_RANDOM_ROOT_PASSWORD: yes
+        ports:
+          - 3306
+        options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Test
+        run: mvn -B test
+        env:
+          MYSQL_PORT: ${{ job.services.mysql.ports[3306] }}
+          MYSQL_USERNAME: test
+          MYSQL_PASSWORD: test

src/main/java/org/javawebstack/orm/Model.java

@@ -41,6 +41,7 @@ public class Model {
     private transient boolean internalEntryExists = false;
     private transient final Map<Class<? extends Model>, Object> internalJoinedModels = new HashMap<>();
     private transient Map<String, Object> internalOriginalValues = new HashMap<>();
+    private transient Map<String, Object> internalExtraFields = new HashMap<>();
 
     void internalAddJoinedModel(Class<? extends Model> type, Object entity) {
         internalJoinedModels.put(type, entity);
@@ -62,6 +63,14 @@ public Map<String, Object> getFieldValues() {
         return values;
     }
 
+    public Map<String, Object> getExtraFields() {
+        return internalExtraFields;
+    }
+
+    public <T> T getExtraField(String key) {
+        return (T) internalExtraFields.get(key);
+    }
+
     public Map<String, Object> getOriginalValues() {
         return internalOriginalValues;
     }

src/main/java/org/javawebstack/orm/Repo.java

@@ -7,6 +7,7 @@
 import org.javawebstack.orm.migration.AutoMigrator;
 import org.javawebstack.orm.query.Query;
 import org.javawebstack.orm.wrapper.SQL;
+import org.javawebstack.orm.wrapper.builder.SQLQueryString;
 
 import java.lang.reflect.Field;
 import java.sql.SQLException;
@@ -124,28 +125,14 @@ private void executeCreate(T entry) {
                 if (field.get(entry) == null)
                     field.set(entry, UUID.randomUUID());
             }
-            List<Object> params = new ArrayList<>();
-            StringBuilder sb = new StringBuilder("INSERT INTO `");
-            sb.append(info.getTableName());
-            sb.append("` (");
-            List<String> cols = new ArrayList<>();
-            List<String> values = new ArrayList<>();
             Map<String, Object> map = SQLMapper.map(this, entry);
             if (info.isAutoIncrement()) {
                 String idCol = info.getColumnName(info.getIdField());
                 if (map.containsKey(idCol) && map.get(idCol) == null)
                     map.remove(idCol);
             }
-            for (String columnName : map.keySet()) {
-                cols.add("`" + columnName + "`");
-                values.add("?");
-                params.add(map.get(columnName));
-            }
-            sb.append(String.join(",", cols));
-            sb.append(") VALUES (");
-            sb.append(String.join(",", values));
-            sb.append(");");
-            int id = connection.write(sb.toString(), params.toArray());
+            SQLQueryString qs = getConnection().builder().buildInsert(info, map);
+            int id = connection.write(qs.getQuery(), qs.getParameters().toArray());
             if (info.isAutoIncrement())
                 info.getField(info.getIdField()).set(entry, id);
             entry.setEntryExists(true);

src/main/java/org/javawebstack/orm/query/Query.java

@@ -4,6 +4,7 @@
 import org.javawebstack.orm.Repo;
 import org.javawebstack.orm.SQLMapper;
 import org.javawebstack.orm.exception.ORMQueryException;
+import org.javawebstack.orm.wrapper.builder.SQLQueryString;
 
 import java.sql.ResultSet;
 import java.sql.SQLException;
@@ -23,10 +24,9 @@ public class Query<T extends Model> {
     private final QueryGroup<T> where;
     private Integer offset;
     private Integer limit;
-    private QueryColumn order;
-    private boolean desc = false;
+    private QueryOrderBy order;
     private boolean withDeleted = false;
-    private final Map<Class<? extends Model>, QueryCondition> leftJoins = new HashMap<>();
+    private final List<QueryWith> withs = new ArrayList<>();
 
     public Query(Class<T> model) {
         this(Repo.get(model), model);
@@ -36,14 +36,47 @@ public Query(Repo<T> repo, Class<T> model) {
         this.repo = repo;
         this.model = model;
         this.where = new QueryGroup<>();
+        this.order = new QueryOrderBy();
+    }
+
+    public boolean isWithDeleted() {
+        return withDeleted;
+    }
+
+    public QueryGroup<T> getWhereGroup() {
+        return where;
+    }
+
+    public List<QueryWith> getWiths() {
+        return withs;
+    }
+
+    public Integer getLimit() {
+        return limit;
+    }
+
+    public Integer getOffset() {
+        return offset;
+    }
+
+    public QueryOrderBy getOrder() {
+        return order;
+    }
+
+    public Repo<T> getRepo() {
+        return repo;
     }
 
     public Class<T> getModel() {
         return model;
     }
 
-    public Query<T> leftJoin(Class<? extends Model> model, String self, String other) {
-        leftJoins.put(model, new QueryCondition(new QueryColumn(repo.getInfo().getTableName() + "." + self), "=", new QueryColumn(Repo.get(model).getInfo().getTableName() + "." + other)));
+    public Query<T> with(String extra) {
+        return with(extra, null);
+    }
+
+    public Query<T> with(String extra, String as) {
+        withs.add(new QueryWith(extra, as));
         return this;
     }
 
@@ -263,18 +296,25 @@ public Query<T> search(String search) {
         return this;
     }
 
+    public Query<T> order(String orderBy) {
+        return order(orderBy, false);
+    }
+
     public Query<T> order(String orderBy, boolean desc) {
         return order(new QueryColumn(orderBy), desc);
     }
 
     public Query<T> order(QueryColumn orderBy, boolean desc) {
-        this.order = orderBy;
-        this.desc = desc;
-        return this;
-    }
+        boolean success = this.order.add(orderBy, desc);
+        if(!success) {
+            throw new ORMQueryException(String.format(
+                "The column %s could not be ordered %s. This is probably caused by calling .order() on this column twice.",
+                orderBy.toString(),
+                desc ? "descendingly" : "ascendingly"
+            ));
+        }
 
-    public Query<T> order(String orderBy) {
-        return order(orderBy, false);
+        return this;
     }
 
     public Query<T> limit(int offset, int limit) {
@@ -296,59 +336,10 @@ public Query<T> withDeleted() {
         return this;
     }
 
-    public QueryString getQueryString() {
-        return getQueryString(false);
-    }
-
-    public QueryString getQueryString(boolean count) {
-        List<Object> parameters = new ArrayList<>();
-        StringBuilder sb = new StringBuilder("SELECT ")
-                .append(count ? "COUNT(*)" : "*")
-                .append(" FROM `")
-                .append(repo.getInfo().getTableName())
-                .append('`');
-        for (Class<? extends Model> type : leftJoins.keySet()) {
-            sb.append(" LEFT JOIN `")
-                    .append(Repo.get(type).getInfo().getTableName())
-                    .append("` ON ")
-                    .append(leftJoins.get(type).getQueryString(repo.getInfo()).getQuery());
-        }
-        considerSoftDelete();
-        if (where.getQueryElements().size() > 0) {
-            QueryString qs = where.getQueryString(repo.getInfo());
-            sb.append(" WHERE ").append(qs.getQuery());
-            parameters.addAll(qs.getParameters());
-        }
-        if (order != null) {
-            sb.append(" ORDER BY ").append(order.toString(repo.getInfo()));
-            if (desc)
-                sb.append(" DESC");
-        }
-        if (offset != null && limit == null)
-            limit = Integer.MAX_VALUE;
-        if (limit != null) {
-            sb.append(" LIMIT ?");
-            if (offset != null) {
-                sb.append(",?");
-                parameters.add(offset);
-            }
-            parameters.add(limit);
-        }
-        return new QueryString(sb.toString(), SQLMapper.mapParams(repo, parameters));
-    }
-
     public void finalDelete() {
-        List<Object> parameters = new ArrayList<>();
-        StringBuilder sb = new StringBuilder("DELETE FROM `")
-                .append(repo.getInfo().getTableName())
-                .append('`');
-        if (where.getQueryElements().size() > 0) {
-            QueryString qs = where.getQueryString(repo.getInfo());
-            sb.append(" WHERE ").append(qs.getQuery());
-            parameters = qs.getParameters();
-        }
+        SQLQueryString qs = repo.getConnection().builder().buildDelete(this);
         try {
-            repo.getConnection().write(sb.toString(), SQLMapper.mapParams(repo, parameters).toArray());
+            repo.getConnection().write(qs.getQuery(), qs.getParameters().toArray());
         } catch (SQLException throwables) {
             throw new ORMQueryException(throwables);
         }
@@ -374,18 +365,10 @@ public void restore() {
         withDeleted().update(values);
     }
 
-    private void considerSoftDelete() {
-        if (repo.getInfo().isSoftDelete() && !withDeleted) {
-            if (where.getQueryElements().size() > 0)
-                where.getQueryElements().add(0, QueryConjunction.AND);
-            where.getQueryElements().add(0, new QueryCondition(new QueryColumn(repo.getInfo().getColumnName(repo.getInfo().getSoftDeleteField())), "IS NULL", null));
-        }
-    }
-
     public T refresh(T entity) {
-        QueryString qs = getQueryString(false);
+        SQLQueryString qs = repo.getConnection().builder().buildQuery(this, false);
         try {
-            ResultSet rs = repo.getConnection().read(qs.getQuery(), SQLMapper.mapParams(repo, SQLMapper.mapParams(repo, qs.getParameters())).toArray());
+            ResultSet rs = repo.getConnection().read(qs.getQuery(), qs.getParameters().toArray());
             SQLMapper.mapBack(repo, rs, entity);
             repo.getConnection().close(rs);
             return entity;
@@ -399,39 +382,19 @@ public void update(T entity) {
     }
 
     public void update(Map<String, Object> values) {
-        if (repo.getInfo().hasUpdated())
-            values.put(repo.getInfo().getColumnName(repo.getInfo().getUpdatedField()), Timestamp.from(Instant.now()));
-        List<Object> parameters = new ArrayList<>();
-        List<String> sets = new ArrayList<>();
-        values.forEach((key, value) -> {
-            sets.add("`" + key + "`=?");
-            parameters.add(value);
-        });
-        StringBuilder sb = new StringBuilder("UPDATE `")
-                .append(repo.getInfo().getTableName())
-                .append("` SET ")
-                .append(String.join(",", sets));
-        considerSoftDelete();
-        if (where.getQueryElements().size() > 0) {
-            QueryString qs = where.getQueryString(repo.getInfo());
-            sb.append(" WHERE ").append(qs.getQuery());
-            parameters.addAll(qs.getParameters());
-        }
-        sb.append(';');
+        SQLQueryString queryString = repo.getConnection().builder().buildUpdate(this, values);
         try {
-            repo.getConnection().write(sb.toString(), SQLMapper.mapParams(repo, parameters).toArray());
+            repo.getConnection().write(queryString.getQuery(), queryString.getParameters().toArray());
         } catch (SQLException throwables) {
             throw new ORMQueryException(throwables);
         }
     }
 
     public List<T> all() {
-        QueryString qs = getQueryString(false);
+        SQLQueryString qs = repo.getConnection().builder().buildQuery(this, false);
         try {
-            ResultSet rs = repo.getConnection().read(qs.getQuery(), SQLMapper.mapParams(repo, qs.getParameters()).toArray());
-            List<Class<? extends Model>> joinedModels = new ArrayList<>();
-            joinedModels.addAll(leftJoins.keySet());
-            List<T> list = SQLMapper.map(repo, rs, joinedModels);
+            ResultSet rs = repo.getConnection().read(qs.getQuery(), qs.getParameters().toArray());
+            List<T> list = SQLMapper.map(repo, rs, new ArrayList<>());
             repo.getConnection().close(rs);
             return list;
         } catch (SQLException throwables) {
@@ -455,9 +418,9 @@ public Stream<T> stream() {
     }
 
     public int count() {
-        QueryString qs = getQueryString(true);
+        SQLQueryString qs = repo.getConnection().builder().buildQuery(this, true);
         try {
-            ResultSet rs = repo.getConnection().read(qs.getQuery(), SQLMapper.mapParams(repo, qs.getParameters()).toArray());
+            ResultSet rs = repo.getConnection().read(qs.getQuery(), qs.getParameters().toArray());
             int c = 0;
             if (rs.next())
                 c = rs.getInt(1);

src/main/java/org/javawebstack/orm/query/QueryColumn.java

@@ -1,12 +1,17 @@
 package org.javawebstack.orm.query;
 
 import org.javawebstack.orm.TableInfo;
+import org.javawebstack.orm.exception.ORMQueryException;
 
 import java.util.Arrays;
+import java.util.Objects;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
 public class QueryColumn {
 
+    private static final Pattern NAME_PATTERN = Pattern.compile("[A-Za-z0-9_\\-.]+");
+
     private final String name;
     private final boolean raw;
 
@@ -15,6 +20,8 @@ public QueryColumn(String name) {
     }
 
     public QueryColumn(String name, boolean raw) {
+        if(!raw)
+            validateName(name);
         this.name = name;
         this.raw = raw;
     }
@@ -37,4 +44,21 @@ public String toString(TableInfo info) {
         return Arrays.stream((info != null ? info.getColumnName(name) : name).split("\\.")).map(s -> "`" + s + "`").collect(Collectors.joining("."));
     }
 
+    private static void validateName(String name) {
+        if(!NAME_PATTERN.matcher(name).matches())
+            throw new ORMQueryException("Invalid column name '" + name + "' (Use raw in case you know what you're doing)");
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        QueryColumn that = (QueryColumn) o;
+        return toString().equals(that.toString());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(toString());
+    }
 }