Merge pull request #497 from scireum/aha/code-cleanup

Aha/code cleanup

pom.xml

@@ -6,15 +6,15 @@
     <parent>
         <groupId>com.scireum</groupId>
         <artifactId>sirius-parent</artifactId>
-        <version>5.1</version>
+        <version>5.8</version>
     </parent>
     <artifactId>sirius-web</artifactId>
     <version>DEVELOPMENT-SNAPSHOT</version>
     <name>SIRIUS web</name>
     <description>Provides a modern and scalable web server as SIRIUS module</description>
 
     <properties>
-        <sirius.kernel>12.0-rc16</sirius.kernel>
+        <sirius.kernel>12.0-rc19</sirius.kernel>
     </properties>
 
     <dependencies>
@@ -42,7 +42,7 @@
         <dependency>
             <groupId>com.scireum</groupId>
             <artifactId>server-sass</artifactId>
-            <version>4.2.1</version>
+            <version>5.0</version>
         </dependency>
 
         <!-- Used as chosen JSON implementation -->

src/main/java/sirius/tagliatelle/Tagliatelle.java

@@ -349,7 +349,8 @@ private Template resolveFromCache(String path, Resource resource) {
     private Template compileTemplate(String path, Resource resource, @Nullable CompilationContext parentContext)
             throws CompileException {
         CompilationContext compilationContext = createCompilationContext(path, resource, parentContext);
-        new Compiler(compilationContext, resource.getContentAsString()).compile();
+        Compiler compiler = new Compiler(compilationContext, resource.getContentAsString());
+        compiler.compile();
         return handleAliasing(compilationContext.getTemplate(), compilationContext);
     }
 

src/main/java/sirius/tagliatelle/TagliatelleController.java

@@ -108,6 +108,11 @@ public void tagInfo(WebContext ctx, String tagLib, String tag) throws Exception
         }
     }
 
+    /**
+     * Provides some statistics and metrics for the internals of tagliatelle.
+     *
+     * @param ctx the request being handled
+     */
     @Routed("/system/tags/state")
     @Permission(PERMISSION_SYSTEM_TAGS_STATE)
     public void tagState(WebContext ctx) {

src/main/java/sirius/tagliatelle/compiler/AttributeExpressionHandler.java

@@ -8,7 +8,6 @@
 
 package sirius.tagliatelle.compiler;
 
-import org.jetbrains.annotations.NotNull;
 import parsii.tokenizer.Position;
 import sirius.kernel.di.std.Register;
 import sirius.tagliatelle.emitter.CompositeEmitter;
@@ -22,6 +21,8 @@
 import sirius.tagliatelle.expression.Expression;
 import sirius.tagliatelle.expression.ReadLocal;
 
+import javax.annotation.Nonnull;
+
 /**
  * Parses an attribute expression.
  * <p>
@@ -67,7 +68,7 @@ public Emitter process(Compiler compiler) {
         return translateLiteralExpression(compiler, start, attributeName, condition);
     }
 
-    @NotNull
+    @Nonnull
     private Emitter translateLiteralExpression(Compiler compiler,
                                                Position start,
                                                String attributeName,

src/main/java/sirius/tagliatelle/compiler/Compiler.java

@@ -420,7 +420,7 @@ private void handleTag(TagHandler handler, CompositeEmitter block) {
     private void parseAttributes(TagHandler handler) {
         while (true) {
             skipWhitespaces();
-            if (reader.current().isEndOfInput() || reader.current().is('>') || reader.current().is('/')) {
+            if (reader.current().isEndOfInput() || reader.current().is('>','/')) {
                 break;
             }
             String name = parseName();

src/main/java/sirius/tagliatelle/compiler/InputProcessor.java

@@ -64,6 +64,13 @@ public void consumeExpectedCharacter(char expectedCharacter) {
         }
     }
 
+    /**
+     * Determines if the parser is currently at the given text / keyword.
+     *
+     * @param offset the offset to add to the parsers position
+     * @param text   the text or keyword to check for
+     * @return <tt>true</tt> if the parser is currently at the given text, <tt>false</tt> otherwise
+     */
     public boolean isAtText(int offset, String text) {
         for (int i = 0; i < text.length(); i++) {
             if (!reader.next(offset + i).is(text.charAt(i))) {

src/main/java/sirius/tagliatelle/compiler/Parser.java

@@ -533,7 +533,7 @@ private Expression tryClassOrEnumLiteral(String id) {
         int offset = 0;
         while (true) {
             Char current = reader.next(offset);
-            if (!(current.isLetter() || current.is('_') || current.is('.') || current.is('$') || current.isDigit())) {
+            if (!isValidClassNameChar(current)) {
                 break;
             }
             sb.append(current.getValue());
@@ -556,6 +556,10 @@ private Expression tryClassOrEnumLiteral(String id) {
         return new ConstantClass(context.resolveClass(pos, literal));
     }
 
+    private boolean isValidClassNameChar(Char current) {
+        return current.isLetter() || current.isDigit() || current.is('_', '.', '$');
+    }
+
     private Expression tryEnumLiteral(String literal, int offset) {
         Tuple<String, String> typeNameName = Strings.splitAtLast(literal, ".");
         Class<?> enumType = context.tryResolveClass(typeNameName.getFirst()).orElse(null);

src/main/java/sirius/tagliatelle/emitter/InlineTemplateEmitter.java

@@ -80,5 +80,4 @@ public void visitExpressions(Function<Position, ExpressionVisitor> visitorSuppli
     public String toString() {
         return "INLINE: " + template.getName() + " { " + body + " }\n";
     }
-
 }

src/main/java/sirius/tagliatelle/expression/ConcatExpression.java

@@ -31,6 +31,11 @@ public ConcatExpression(Expression... expressions) {
         stringExpressions.addAll(Arrays.asList(expressions));
     }
 
+    /**
+     * Adds a new expression.
+     *
+     * @param expr the expression to add
+     */
     public void add(Expression expr) {
         stringExpressions.add(expr);
     }

src/main/java/sirius/tagliatelle/expression/MethodCall.java

@@ -241,7 +241,7 @@ private Method findMethod(Class<?> type, String name, Class<?>[] parameterTypes)
         }
 
         // Try to find an appropriate method using coercions known to the system...
-        for (Method m: type.getMethods()) {
+        for (Method m : type.getMethods()) {
             if (signatureMatch(m, name, parameterTypes)) {
                 if (checkSandbox(m)) {
                     return m;

src/main/java/sirius/tagliatelle/expression/Negation.java

@@ -11,12 +11,17 @@
 import sirius.tagliatelle.rendering.LocalRenderContext;
 
 /**
- * Represents a boolean <tt>and</tt>.
+ * Represents a boolean <tt>not</tt>.
  */
 public class Negation implements Expression {
 
     private Expression expression;
 
+    /**
+     * Creates a new negation.
+     *
+     * @param expresion the expression to negate
+     */
     public Negation(Expression expresion) {
         this.expression = expresion;
     }

src/main/java/sirius/tagliatelle/expression/ReadLocal.java

@@ -9,6 +9,7 @@
 package sirius.tagliatelle.expression;
 
 import sirius.tagliatelle.rendering.LocalRenderContext;
+
 /**
  * Performs a read on the local stack.
  *

src/main/java/sirius/tagliatelle/expression/RenderEmitterExpression.java

@@ -22,6 +22,11 @@ public class RenderEmitterExpression implements Expression {
 
     private InlineTemplateEmitter emitter;
 
+    /**
+     * Creates an expression which evaluates to the result of the given emitter.
+     *
+     * @param emitter the emitter to wrap
+     */
     public RenderEmitterExpression(InlineTemplateEmitter emitter) {
         this.emitter = emitter;
     }

src/main/java/sirius/tagliatelle/macros/FormatDateMacro.java

@@ -23,7 +23,7 @@
 
 /**
  * Represents <tt>formatDate(…)</tt>.
- *
+ * <p>
  * The macro supports the datatypes {@code long} for epoch milliseconds, {@link Date} for legacy applications, and
  * {@link TemporalAccessor}. The invocation is forwarded to {@link NLS#toUserString(Object)} via
  * {@link Value#asLocalDate(LocalDate)}.
@@ -41,9 +41,11 @@ public void verifyArguments(List<Expression> args) {
             throw new IllegalArgumentException("One parameter is expected");
         }
 
-        if (!Tagliatelle.isAssignableTo(args.get(0).getType(), Long.class) &&
-            !Tagliatelle.isAssignableTo(args.get(0).getType(), Date.class) &&
-            !Tagliatelle.isAssignableTo(args.get(0).getType(), TemporalAccessor.class)) {
+        if (!Tagliatelle.isAssignableTo(args.get(0).getType(), Long.class)
+            && !Tagliatelle.isAssignableTo(args.get(0)
+                                               .getType(),
+                                           Date.class)
+            && !Tagliatelle.isAssignableTo(args.get(0).getType(), TemporalAccessor.class)) {
             throw new IllegalArgumentException("Illegal parameter type");
         }
     }

src/main/java/sirius/tagliatelle/macros/FormatTimeMacro.java

@@ -23,7 +23,7 @@
 
 /**
  * Represents <tt>formatTime(…)</tt>.
- *
+ * <p>
  * The macro supports the datatypes {@code long} for epoch milliseconds, {@link Date} for legacy applications, and
  * {@link TemporalAccessor}. The invocation is forwarded to {@link NLS#toUserString(Object)} via
  * {@link Value#asLocalTime(LocalTime)}.
@@ -41,9 +41,11 @@ public void verifyArguments(List<Expression> args) {
             throw new IllegalArgumentException("One parameter is expected");
         }
 
-        if (!Tagliatelle.isAssignableTo(args.get(0).getType(), Long.class) &&
-            !Tagliatelle.isAssignableTo(args.get(0).getType(), Date.class) &&
-            !Tagliatelle.isAssignableTo(args.get(0).getType(), TemporalAccessor.class)) {
+        if (!Tagliatelle.isAssignableTo(args.get(0).getType(), Long.class)
+            && !Tagliatelle.isAssignableTo(args.get(0)
+                                               .getType(),
+                                           Date.class)
+            && !Tagliatelle.isAssignableTo(args.get(0).getType(), TemporalAccessor.class)) {
             throw new IllegalArgumentException("Illegal parameter type");
         }
     }

src/main/java/sirius/tagliatelle/macros/LeftPadMacro.java

@@ -32,9 +32,10 @@ public Class<?> getType() {
 
     @Override
     public void verifyArguments(List<Expression> args) {
-        if (args.size() != 3 || !Tagliatelle.isAssignableTo(args.get(0).getType(), String.class)
-                || !Tagliatelle.isAssignableTo(args.get(1).getType(), String.class)
-                || !Tagliatelle.isAssignableTo(args.get(2).getType(), int.class)) {
+        if (args.size() != 3
+            || !Tagliatelle.isAssignableTo(args.get(0).getType(), String.class)
+            || !Tagliatelle.isAssignableTo(args.get(1).getType(), String.class)
+            || !Tagliatelle.isAssignableTo(args.get(2).getType(), int.class)) {
             throw new IllegalArgumentException("Expected the first and second argument to be a string "
                                                + "and the third to be a integer.");
         }

src/main/java/sirius/tagliatelle/macros/ToListMacro.java

@@ -32,8 +32,7 @@ public Class<?> getType() {
     @Override
     public void verifyArguments(List<Expression> args) {
         if (args.isEmpty()) {
-            throw new IllegalArgumentException(
-                    "Expected at least one parameter");
+            throw new IllegalArgumentException("Expected at least one parameter");
         }
     }
 

src/main/java/sirius/tagliatelle/rendering/GlobalRenderContext.java

@@ -204,7 +204,7 @@ public String getExtraBlock(String name) {
     /**
      * Emits everything which is invoked from within the callback into an unescaped string.
      *
-     * @param callback     the callback which will invoke emitters.
+     * @param callback the callback which will invoke emitters.
      * @return the contents which were emitted within the <tt>callback</tt>
      */
     public String emitToString(RenderCall callback) {

src/main/java/sirius/web/controller/AutocompleteHelper.java

@@ -165,6 +165,12 @@ private void writeTo(StructuredOutput out) {
      * Called to generate completions for a given query.
      */
     public interface ItemSearch {
+        /**
+         * Invoked to generate completions.
+         *
+         * @param query  the input provided by the user
+         * @param result the consumer to be supplied with completions for the autocomplete
+         */
         void search(String query, Consumer<Completion> result);
     }
 

src/main/java/sirius/web/controller/FacetRange.java

@@ -21,6 +21,7 @@ public class FacetRange {
 
     /**
      * Creates a new range with the given min and max values.
+     *
      * @param min smallest available value
      * @param max the largest available value
      */

src/main/java/sirius/web/crunchlog/Crunchlog.java

@@ -144,9 +144,9 @@ public LogBuilder withURIAndUserAgent(WebContext ctx) {
          */
         @CheckReturnValue
         public LogBuilder set(String key, Object value) {
-           if (context == null) {
-               throw new IllegalArgumentException("LogBuilder of Crunchlog was already submitted.");
-           }
+            if (context == null) {
+                throw new IllegalArgumentException("LogBuilder of Crunchlog was already submitted.");
+            }
 
             context.set(key, value);
             return this;

src/main/java/sirius/web/crunchlog/CrunchlogKernel.java

@@ -109,25 +109,27 @@ protected double maxCallFrequency() {
     }
 
     @Override
-    protected void doWork() throws Exception {
+    protected String doWork() throws Exception {
         if (buffer.isEmpty()) {
-            return;
+            return null;
         }
 
         if (!ensureWriterIsReady()) {
             buffer.clear();
-            return;
+            return null;
         }
 
         try {
+            int numWritten = 0;
             while (TaskContext.get().isActive()) {
                 Context line = buffer.poll();
                 if (line == null) {
-                    return;
+                    return "Crunchlogs written: " + numWritten;
                 }
                 String lineAsString = JSON.toJSONString(line);
                 currentWriter.write(lineAsString);
                 currentWriter.write("\n");
+                numWritten++;
             }
 
             currentWriter.flush();
@@ -140,6 +142,7 @@ protected void doWork() throws Exception {
             Exceptions.handle(Crunchlog.LOG, e);
             buffer.clear();
         }
+        return null;
     }
 
     /**

src/main/java/sirius/web/health/Cluster.java

@@ -8,22 +8,15 @@
 
 package sirius.web.health;
 
-import com.alibaba.fastjson.JSONArray;
-import com.alibaba.fastjson.JSONObject;
 import sirius.kernel.async.Tasks;
 import sirius.kernel.di.std.Part;
 import sirius.kernel.di.std.Register;
-import sirius.kernel.health.Exceptions;
 import sirius.kernel.health.Log;
 import sirius.kernel.health.metrics.Metric;
 import sirius.kernel.health.metrics.MetricState;
 import sirius.kernel.health.metrics.Metrics;
 import sirius.kernel.timer.EveryMinute;
-import sirius.kernel.timer.EveryTenSeconds;
-import sirius.web.services.JSONCall;
 
-import java.io.IOException;
-import java.net.URL;
 import java.util.Collections;
 import java.util.List;
 
@@ -151,5 +144,4 @@ private MetricState computeNodeState() {
 
         return newNodeState;
     }
-
 }

src/main/java/sirius/web/health/SystemController.java

@@ -30,7 +30,6 @@
 import sirius.web.security.Permission;
 
 import java.util.Collection;
-import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
 import java.util.stream.Collectors;
@@ -65,6 +64,11 @@ public class SystemController extends BasicController {
      */
     public static final String PERMISSION_SYSTEM_STATE = "permission-system-state";
 
+    /**
+     * Renders the UI for the system console.
+     *
+     * @param ctx the request being handled
+     */
     @Routed("/system/console")
     @Permission(PERMISSION_SYSTEM_CONSOLE)
     public void console(WebContext ctx) {