style: improve style setting (#29)

style: improve style setting

1. add style setting for scala
2. check style with github ci

Author: zsc347

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ name: CI
 on:
   # Triggers the workflow on push or pull request events but only for the main branch
   pull_request:
-    branches: [ main, dev ]
+    branches: [main, dev]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -36,17 +36,18 @@ jobs:
       - name: set up maven and java
         uses: actions/setup-java@v3
         with:
-          java-version: '8'
+          java-version: "8"
           cache: maven
-          distribution: 'adopt'
+          distribution: "adopt"
+      - name: check format convention
+        run: |
+          mvn spotless:check
       - name: init mysql schema
         run: mvn test exec:java -f test/embedded-mysql/pom.xml
-#      - name: init hbase data
-#        run:
+      #      - name: init hbase data
+      #        run:
 
       # Runs a set of commands using the runners shell
       - name: build and test with maven
         run: |
           mvn clean test
-
-

.mvn/.gitkeep

@@ -0,0 +1 @@
+# Keep it here for tell mvn which one is root folder so ${maven.multiModuleProjectDirectory} can be used in pom.

CONTRIBUTING.md

@@ -36,13 +36,30 @@ You can install [Checkstyle] plugin to check the START-DB code.
 ### Formatting
 
 START-DB code is automatically formatted with [spotless], backed by the Eclipse formatter. You can do the same in IntelliJ with the [Eclipse Code Formatter] so that you can apply the correct formatting directly in
-your IDE. Or import it as IntelliJ code style setting.
-
-1. Open **File > Settings/Preferences > Code Style > Java**
-2. Gear icon > Import Scheme > Eclipse XML Profile
-3. Navigate to the file `conventions/eclipse-formatter.xml`
+your IDE.
+
+**Java Code Style**
+
+1. Open **File > Settings/Preferences > Plugins**
+2. Install **Adapter for Eclipse Code Formatter** from marketplace
+3. Open **File > Settings/Preferences > Adapter for Eclipse Code Formatter**
+4. Click "Use the Eclipse Code Formatter"
+5. Use default "Boundled Eclipse"
+6. Under "Eclipse formatter config", select "Eclipse workspace/project
+   folder or config file"
+7. Click "Browse", and navigate to the file `conventions/eclipse-formatter.xml`
+8. **IMPORTANT** - make sure "Optimize Imports" is **NOT** selected.
+9. Click "OK"
+
+**Scala Code Style**
+
+1. Open **File > Settings/Preferences > Code Style > Scala**
+2. Change **Formatter** to `scalafmt`
+3. Set **Configguration** to file `conventions/scalafmt.conf`
 4. Click "OK"
 
+Formatting will be triggered when running command `mvn package`. Or you can do format only with command `mvn spotless:apply`.
+
 [checkstyle]: https://plugins.jetbrains.com/plugin/1065-checkstyle-idea
 [spotless]: https://github.com/diffplug/spotless
 [eclipse code formatter]: https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter

conventions/license-header

@@ -1,13 +1,11 @@
 /*
  * Copyright 2022 ST-Lab
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * version 2 as published by the Free Software Foundation.
-
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
  */
 

conventions/scalafmt.conf

@@ -0,0 +1,6 @@
+# ref https://scalameta.org/scalafmt/docs/configuration.html
+version=2.0.1
+maxColumn = 100
+optIn.configStyleArguments = false
+runner.dialect = scala212
+onTestFailure = "To fix this, run `mvn spotless:apply` from the project root directory"

core/src/main/java/org/urbcomp/start/db/constant/ConfigFileConstant.java

@@ -1,3 +1,14 @@
+/*
+ * Copyright 2022 ST-Lab
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ */
+
 package org.urbcomp.start.db.constant;
 
 /**

core/src/main/java/org/urbcomp/start/db/core/geomesa/model/GeomesaQuery.java

@@ -1,3 +1,14 @@
+/*
+ * Copyright 2022 ST-Lab
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ */
+
 package org.urbcomp.start.db.core.geomesa.model;
 
 import org.apache.calcite.linq4j.tree.ConstantExpression;
@@ -8,14 +19,15 @@
 import java.lang.reflect.Type;
 
 /**
- * This class is different from the native implementation of geotools, because the
- * native implementation of GeoTools does not java basic data types, so it cannot
- * be recognized in the expression parsing of linq4j.
+ * This class is different from the native implementation of geotools, because the native
+ * implementation of GeoTools does not java basic data types, so it cannot be recognized in the
+ * expression parsing of linq4j.
+ * 
  * @see ConstantExpression#ConstantExpression(Type, Object)
  * @see Primitive
  *
- * Therefore, we need to re encapsulate the query object of geotools. When we need
- * this information, we need to present it in the form of basic data types.
+ *      Therefore, we need to re encapsulate the query object of geotools. When we need this
+ *      information, we need to present it in the form of basic data types.
  *
  * @author zaiyuan
  * @date 2022-05-01 15:17:07
@@ -86,4 +98,4 @@ public String getTableName() {
     public void setTableName(String tableName) {
         this.tableName = tableName;
     }
-}
+}

core/src/main/java/org/urbcomp/start/db/core/geomesa/rules/GeomesaFilterRule.java

@@ -1,3 +1,14 @@
+/*
+ * Copyright 2022 ST-Lab
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ */
+
 package org.urbcomp.start.db.core.geomesa.rules;
 
 import org.apache.calcite.plan.Convention;
@@ -10,8 +21,8 @@
 import org.urbcomp.start.db.geomesa.rel.GeomesaTableScan;
 
 /**
- * This class is used to match the specified filter rules, convert the original
- * query criteria into the filter object of geotools, and push down.
+ * This class is used to match the specified filter rules, convert the original query criteria into
+ * the filter object of geotools, and push down.
  *
  * @author zaiyuan
  * @date 2022-05-01 15:17:07
@@ -30,11 +41,9 @@ protected GeomesaFilterRule(Config config) {
      */
     public interface Config extends RelRule.Config {
         Config DEFAULT = EMPTY
-                .withOperandSupplier(b0 ->
-                        b0.operand(LogicalFilter.class)
-                                .oneInput(b1 -> b1.operand(GeomesaTableScan.class)
-                                        .noInputs()))
-                .as(Config.class);
+                        .withOperandSupplier(b0 -> b0.operand(LogicalFilter.class).oneInput(
+                                        b1 -> b1.operand(GeomesaTableScan.class).noInputs()))
+                        .as(Config.class);
 
         /**
          * Creates a rule that uses this configuration.
@@ -48,8 +57,10 @@ default GeomesaFilterRule toRule() {
     }
 
     /**
-     * <p>Typically a rule would check that the nodes are registered and convert
-     * calcite RexNode to Filter, creates a new expression.</p>
+     * <p>
+     * Typically a rule would check that the nodes are registered and convert calcite RexNode to
+     * Filter, creates a new expression.
+     * </p>
      *
      * @param call Rule call
      * @see #matches(RelOptRuleCall)
@@ -59,10 +70,9 @@ public void onMatch(RelOptRuleCall call) {
         LogicalFilter filter = call.rel(0);
         if (filter.getTraitSet().contains(Convention.NONE)) {
             RelTraitSet traits = filter.getTraitSet().replace(GeomesaConstant.CONVENTION());
-            call.transformTo(new GeomesaFilter(filter.getCluster(),
-                    traits, convert(filter.getInput(), GeomesaConstant.CONVENTION()),
-                    filter.getRowType(),
-                    filter.getCondition()));
+            call.transformTo(new GeomesaFilter(filter.getCluster(), traits,
+                            convert(filter.getInput(), GeomesaConstant.CONVENTION()),
+                            filter.getRowType(), filter.getCondition()));
         }
     }
 }

core/src/main/java/org/urbcomp/start/db/core/geomesa/rules/GeomesaToEnumerableConverterRule.java

@@ -1,3 +1,14 @@
+/*
+ * Copyright 2022 ST-Lab
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ */
+
 package org.urbcomp.start.db.core.geomesa.rules;
 
 import org.apache.calcite.adapter.enumerable.EnumerableConvention;
@@ -23,28 +34,28 @@ public class GeomesaToEnumerableConverterRule extends ConverterRule {
      * ConverterRule Instance
      */
     public static final ConverterRule INSTANCE =
-            new GeomesaToEnumerableConverterRule(RelFactories.LOGICAL_BUILDER);
+                    new GeomesaToEnumerableConverterRule(RelFactories.LOGICAL_BUILDER);
 
     /**
      * Construct Function with only One Parameter
      *
      * @param relBuilderFactory RelNoade Factory
      */
     public GeomesaToEnumerableConverterRule(RelBuilderFactory relBuilderFactory) {
-        super(RelNode.class, (Predicate<? super RelNode>) relNode -> true, GeomesaConstant.CONVENTION(),
-                EnumerableConvention.INSTANCE, relBuilderFactory,
-                "GeomesaToEnumerableConverterRule");
+        super(RelNode.class, (Predicate<? super RelNode>) relNode -> true,
+                        GeomesaConstant.CONVENTION(), EnumerableConvention.INSTANCE,
+                        relBuilderFactory, "GeomesaToEnumerableConverterRule");
     }
 
     /**
      * Convert RelNode to GeomesaToEnumeratorConverter
      *
      * @param rel RelNode
-     * @return  GeomesaToEnumeratorConverter
+     * @return GeomesaToEnumeratorConverter
      */
     @Override
     public RelNode convert(RelNode rel) {
         RelTraitSet newTraitSet = rel.getTraitSet().replace(getOutConvention());
         return new GeomesaToEnumeratorConverter(rel.getCluster(), newTraitSet, rel);
     }
-}
+}

core/src/main/java/org/urbcomp/start/db/frame/InnerFunction.java

@@ -1,3 +1,14 @@
+/*
+ * Copyright 2022 ST-Lab
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ */
+
 package org.urbcomp.start.db.frame;
 
 import java.lang.annotation.*;

core/src/main/java/org/urbcomp/start/db/metadata/AccessorFactory.java

@@ -1,3 +1,14 @@
+/*
+ * Copyright 2022 ST-Lab
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ */
+
 package org.urbcomp.start.db.metadata;
 
 import org.urbcomp.start.db.metadata.accessor.UserAccessor;
@@ -12,7 +23,8 @@ public class AccessorFactory {
 
     /**
      * get UserAccessor
-     * @return  UserAccessor
+     * 
+     * @return UserAccessor
      */
     public static UserAccessor getUserAccessor() {
         return new UserAccessor();

core/src/main/java/org/urbcomp/start/db/metadata/SqlSessionUtil.java

@@ -1,3 +1,14 @@
+/*
+ * Copyright 2022 ST-Lab
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ */
+
 package org.urbcomp.start.db.metadata;
 
 import lombok.extern.slf4j.Slf4j;
@@ -15,8 +26,8 @@
  * In order to reduce the overhead of frequent opening and closing of this object, we use the
  * singleton mode to maintain only one corresponding instance in memory.
  * <p>
- * In order to avoid the destruction of singleton pattern by serialization and deserialization,
- * we use static inner classes to maintain singleton objects.
+ * In order to avoid the destruction of singleton pattern by serialization and deserialization, we
+ * use static inner classes to maintain singleton objects.
  *
  * @author zaiyuan
  * @date 2022-05-01 15:17:07
@@ -30,10 +41,9 @@ public class SqlSessionUtil {
     private final SqlSession sqlSession;
 
     /**
-     * Nonparametric construction method
-     * We use the method of reading the configuration file to construct the sqlsession singleton.
-     * TODO: Maybe we should support reading configuration in other ways, such as Mysql, full pathname,
-     * Zookeeper, Apollo configuration center, etc.
+     * Nonparametric construction method We use the method of reading the configuration file to
+     * construct the sqlsession singleton. TODO: Maybe we should support reading configuration in
+     * other ways, such as Mysql, full pathname, Zookeeper, Apollo configuration center, etc.
      */
     private SqlSessionUtil() {
         InputStream inputStream = ResourceUtil.readResource(ConfigFileConstant.MYBATIS_CONFIG_PATH);
@@ -42,7 +52,8 @@ private SqlSessionUtil() {
     }
 
     /**
-     * Private static internal classes to maintain singletons to avoid obtaining singletons through constructors.
+     * Private static internal classes to maintain singletons to avoid obtaining singletons through
+     * constructors.
      */
     private static class SqlSessionUtilHolder {
         private static final SqlSessionUtil INSTANCE = new SqlSessionUtil();