Merge pull request #13 from QuickWrite/develop

Version `0.2.3-alpha`

Author: QuickWrite

.github/workflows/codeql.yml

@@ -61,7 +61,7 @@ jobs:
         distribution: adopt
 
     - name: Build with Maven
-      run: mvn --batch-mode --update-snapshots verify
+      run: mvn -B package --file pom.xml
 
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v2

.github/workflows/maven-deploy.yml

@@ -16,8 +16,10 @@ jobs:
           server-id: cloudsmith
           server-username: MAVEN_USERNAME
           server-password: MAVEN_PASSWORD
+      - name: Build with Maven
+        run: mvn -B package --file pom.xml
       - name: Publish package
-        run: mvn --batch-mode deploy
+        run: mvn deploy
         env:
           MAVEN_USERNAME: ${{ secrets.CLOUDSMITH_USERNAME }}
           MAVEN_PASSWORD: ${{ secrets.CLOUDSMITH_TOKEN }}

.github/workflows/maven.yml

@@ -26,7 +26,7 @@ jobs:
           java-version: '16'
           distribution: adopt
       - name: Build with Maven
-        run: mvn --batch-mode --update-snapshots verify
+        run: mvn -B package --file pom.xml
       - name: Create necessary directories
         run: mkdir staging && cp target/*.jar staging
       - name: Upload artifact

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>net.quickwrite</groupId>
     <artifactId>fluent4j</artifactId>
-    <version>0.2.2-alpha</version>
+    <version>0.2.3-alpha</version>
     <build>
         <plugins>
             <plugin>

src/main/java/net/quickwrite/fluent4j/ast/FluentBase.java

@@ -89,15 +89,15 @@ public String getIdentifier() {
     }
 
     @Override
-    public CharSequence getResult(final AccessorBundle bundle) {
+    public CharSequence getResult(final AccessorBundle bundle, final int recursionDepth) {
         if (this.fluentElements.size() == 1) {
-            return this.fluentElements.get(0).getResult(bundle);
+            return this.fluentElements.get(0).getResult(bundle, recursionDepth - 1);
         }
 
         final StringBuilder builder = new StringBuilder();
 
         for (final FluentElement element : this.fluentElements) {
-            builder.append(element.getResult(bundle));
+            builder.append(element.getResult(bundle, recursionDepth - 1));
         }
 
         return builder;

src/main/java/net/quickwrite/fluent4j/ast/FluentElement.java

@@ -42,7 +42,8 @@ public interface FluentElement {
      * it has been called from.
      *
      * @param bundle The bundle that is getting passed down
+     * @param recursionDepth The amount of recursive calls that can still be made
      * @return The {@link CharSequence} value of the argument with the parameters
      */
-    CharSequence getResult(final AccessorBundle bundle);
+    CharSequence getResult(final AccessorBundle bundle, final int recursionDepth);
 }

src/main/java/net/quickwrite/fluent4j/ast/FluentTextElement.java

@@ -82,7 +82,7 @@ public String stringValue() {
     }
 
     @Override
-    public CharSequence getResult(AccessorBundle bundle) {
+    public CharSequence getResult(final AccessorBundle bundle, final int recursionDepth) {
         return this.text;
     }
 

src/main/java/net/quickwrite/fluent4j/ast/FluentVariant.java

@@ -53,8 +53,8 @@ public String stringValue() {
         return identifier.stringValue();
     }
 
-    public CharSequence getResult(AccessorBundle bundle) {
-        return this.content.getResult(bundle);
+    public CharSequence getResult(final AccessorBundle bundle, final int recursionDepth) {
+        return this.content.getResult(bundle, recursionDepth - 1);
     }
 
     @Override

src/main/java/net/quickwrite/fluent4j/ast/placeable/AttributeReference.java

@@ -6,6 +6,7 @@
 import net.quickwrite.fluent4j.ast.placeable.base.FluentArgumentResult;
 import net.quickwrite.fluent4j.ast.placeable.base.FluentPlaceable;
 import net.quickwrite.fluent4j.ast.placeable.base.FluentSelectable;
+import net.quickwrite.fluent4j.exception.RecursionDepthReachedException;
 import net.quickwrite.fluent4j.util.StringSlice;
 import net.quickwrite.fluent4j.util.args.FluentArgs;
 import net.quickwrite.fluent4j.util.bundle.DirectFluentBundle;
@@ -42,7 +43,7 @@ public String stringValue() {
     }
 
     @Override
-    public CharSequence getResult(final AccessorBundle bundle) {
+    public CharSequence getResult(final AccessorBundle bundle, int recursionDepth) {
         final FluentMessage fluentMessage = this.getMessage(bundle.getBundle(), reference.stringValue());
         if (fluentMessage == null) {
             return getErrorString();
@@ -54,11 +55,11 @@ public CharSequence getResult(final AccessorBundle bundle) {
             return getErrorString();
         }
 
-        return attribute.getResult(bundle);
+        return attribute.getResult(bundle, recursionDepth - 1);
     }
 
     @Override
-    public FluentElement getArgumentResult(final AccessorBundle bundle) {
+    public FluentElement getArgumentResult(final AccessorBundle bundle, int recursionDepth) {
         final FluentMessage fluentMessage = this.getMessage(bundle.getBundle(), reference.stringValue());
         if (fluentMessage == null) {
             return this;
@@ -70,12 +71,10 @@ public FluentElement getArgumentResult(final AccessorBundle bundle) {
             return this;
         }
 
-        if (bundle.getAccessedStorage().alreadyAccessed(attribute)) {
-            return this;
+        if (recursionDepth <= 0) {
+            throw new RecursionDepthReachedException();
         }
 
-        bundle.getAccessedStorage().addElement(attribute);
-
         final List<FluentElement> elementList = attribute.getElements();
 
         if (elementList.size() != 1) {

src/main/java/net/quickwrite/fluent4j/ast/placeable/FunctionReference.java

@@ -20,13 +20,17 @@ public FunctionReference(final String functionName, final FluentArgs arguments)
     }
 
     @Override
-    public FluentElement getArgumentResult(final AccessorBundle bundle) {
+    public FluentElement getArgumentResult(final AccessorBundle bundle, int recursionDepth) {
         try {
             return bundle
                     .getBundle()
                     .getFunction(this.functionName)
                     .orElseThrow()
-                    .getResult(bundle, (FunctionFluentArgs) this.getArguments(bundle));
+                    .getFunctionResult(
+                            bundle,
+                            (FunctionFluentArgs) this.getArguments(bundle, recursionDepth),
+                            recursionDepth - 1
+                    );
         } catch (final Exception exception) {
             return new StringLiteral("{" + functionName + "()}");
         }
@@ -70,11 +74,12 @@ protected boolean check(String string) {
      * this function will return <code>{NUMBER()}</code>.
      *
      *
-     * @param bundle@return The result of the function with the specific parameters
+     * @param bundle @return The result of the function with the specific parameters
+     * @param recursionDepth The amount of recursive calls that can be made
      */
     @Override
-    public CharSequence getResult(AccessorBundle bundle) {
-            return this.getArgumentResult(bundle).getResult(bundle);
+    public CharSequence getResult(AccessorBundle bundle, final int recursionDepth) {
+            return this.getArgumentResult(bundle, recursionDepth - 1).getResult(bundle, recursionDepth - 1);
     }
 
     @Override

src/main/java/net/quickwrite/fluent4j/ast/placeable/MessageReference.java

@@ -36,10 +36,10 @@ public String stringValue() {
     }
 
     @Override
-    public CharSequence getResult(final AccessorBundle bundle) {
+    public CharSequence getResult(final AccessorBundle bundle, final int recursionDepth) {
          return bundle
                 .getBundle()
-                .getMessage(this.stringValue(), bundle)
+                .getMessage(this.stringValue(), bundle, recursionDepth - 1)
                 .orElse("{" + this.stringValue() + "}");
     }
 

src/main/java/net/quickwrite/fluent4j/ast/placeable/NumberLiteral.java

@@ -51,7 +51,7 @@ public static NumberLiteral getNumberLiteral(final String value) {
     }
 
     @Override
-    public CharSequence getResult(final AccessorBundle bundle) {
+    public CharSequence getResult(final AccessorBundle bundle, final int recursionDepth) {
         return NumberFormat.getInstance(bundle.getBundle().getLocale()).format(number);
     }
 

src/main/java/net/quickwrite/fluent4j/ast/placeable/SelectExpression.java

@@ -50,17 +50,17 @@ public String stringValue() {
     }
 
     @Override
-    public CharSequence getResult(final AccessorBundle bundle) {
+    public CharSequence getResult(final AccessorBundle bundle, final int recursionDepth) {
         final FluentElement argument = (identifier instanceof FluentArgumentResult) ?
-                ((FluentArgumentResult) identifier).getArgumentResult(bundle) : identifier;
+                ((FluentArgumentResult) identifier).getArgumentResult(bundle, recursionDepth - 1) : identifier;
 
         for (final FluentVariant variant : variants) {
             if (argument.matches(bundle.getBundle(), variant.getIdentifier())) {
-                return variant.getResult(bundle);
+                return variant.getResult(bundle, recursionDepth - 1);
             }
         }
 
-        return defaultVariant.getResult(bundle);
+        return defaultVariant.getResult(bundle, recursionDepth - 1);
     }
 
     @Override

src/main/java/net/quickwrite/fluent4j/ast/placeable/StringLiteral.java

@@ -55,7 +55,7 @@ public StringLiteral(final String content) {
     }
 
     @Override
-    public CharSequence getResult(AccessorBundle bundle) {
+    public CharSequence getResult(AccessorBundle bundle, final int recursionDepth) {
         return this.literal;
     }
 

src/main/java/net/quickwrite/fluent4j/ast/placeable/TermReference.java

@@ -1,7 +1,6 @@
 package net.quickwrite.fluent4j.ast.placeable;
 
 import net.quickwrite.fluent4j.ast.FluentElement;
-import net.quickwrite.fluent4j.ast.FluentTerm;
 import net.quickwrite.fluent4j.ast.placeable.base.FluentFunction;
 import net.quickwrite.fluent4j.util.StringSlice;
 import net.quickwrite.fluent4j.util.args.FluentArgs;
@@ -40,19 +39,24 @@ protected boolean check(final String string) {
     }
 
     @Override
-    public CharSequence getResult(final AccessorBundle bundle) {
+    public CharSequence getResult(final AccessorBundle bundle, final int recursionDepth) {
         return bundle.getBundle()
-                .getTerm(this.functionName, new AccessorElementsBundle(bundle.getBundle(), this.getArguments(bundle), bundle.getAccessedStorage()))
+                .getTerm(this.functionName,
+                        new AccessorElementsBundle(bundle.getBundle(),
+                        this.getArguments(bundle, recursionDepth)),
+                        recursionDepth - 1
+                )
                 .orElse("{-" + this.functionName + "}");
     }
 
     /**
      * @param bundle    The bundle that this is being called from
+     * @param recursionDepth The amount of recursive calls that can still be made
      * @return The result of the term that is being called
      */
     @Override
-    public FluentElement getArgumentResult(final AccessorBundle bundle) {
-        return new StringLiteral(getResult(bundle).toString());
+    public FluentElement getArgumentResult(final AccessorBundle bundle, final int recursionDepth) {
+        return new StringLiteral(getResult(bundle, recursionDepth - 1).toString());
     }
 
     @Override

src/main/java/net/quickwrite/fluent4j/ast/placeable/VariableReference.java

@@ -52,7 +52,7 @@ public String stringValue() {
     }
 
     @Override
-    public FluentElement getArgumentResult(final AccessorBundle bundle) {
+    public FluentElement getArgumentResult(final AccessorBundle bundle, final int recursionDepth) {
         final FluentArgs arguments = bundle.getArguments();
         final FluentElement argument = arguments.getNamed(content);
 
@@ -64,14 +64,14 @@ public FluentElement getArgumentResult(final AccessorBundle bundle) {
     }
 
     @Override
-    public CharSequence getResult(final AccessorBundle bundle) {
+    public CharSequence getResult(final AccessorBundle bundle, final int recursionDepth) {
         final FluentElement argument = bundle.getArguments().getNamed(content);
 
         if (argument == null) {
             return "{$" + content + "}";
         }
 
-        return argument.getResult(bundle);
+        return argument.getResult(bundle, recursionDepth - 1);
     }
 
     @Override

src/main/java/net/quickwrite/fluent4j/ast/placeable/base/FluentArgumentResult.java

@@ -4,5 +4,5 @@
 import net.quickwrite.fluent4j.util.bundle.args.AccessorBundle;
 
 public interface FluentArgumentResult {
-    FluentElement getArgumentResult(AccessorBundle bundle);
+    FluentElement getArgumentResult(AccessorBundle bundle, int recursionDepth);
 }

src/main/java/net/quickwrite/fluent4j/ast/placeable/base/FluentFunction.java

@@ -35,22 +35,24 @@ public FluentFunction(final String functionName, final FluentArgs arguments) {
      * has itself in a sanitized form.
      *
      * @param bundle The arguments that are getting passed down
+     * @param recursionDepth
      * @return The sanitized arguments of the function
      */
-    protected FluentArgs getArguments(final AccessorBundle bundle) {
+    protected FluentArgs getArguments(final AccessorBundle bundle, final int recursionDepth) {
         if (this.arguments == null)
             return null;
 
-        return this.arguments.sanitize(bundle);
+        return this.arguments.sanitize(bundle, recursionDepth);
     }
 
     /**
      * Returns the {@link FluentElement} that the function is returning.
      *
      * @param bundle    The bundle that this is being called from
+     * @param recursionDepth
      * @return The resulting {@link FluentElement} that has been created
      */
-    public abstract FluentElement getArgumentResult(final AccessorBundle bundle);
+    public abstract FluentElement getArgumentResult(final AccessorBundle bundle, int recursionDepth);
 
     /**
      * Checks if this FluentFunction and the selector are the same.

src/main/java/net/quickwrite/fluent4j/exception/RecursionDepthReachedException.java

@@ -0,0 +1,4 @@
+package net.quickwrite.fluent4j.exception;
+
+public class RecursionDepthReachedException extends RuntimeException {
+}

src/main/java/net/quickwrite/fluent4j/functions/AbstractFunction.java

@@ -1,8 +1,7 @@
 package net.quickwrite.fluent4j.functions;
 
-import net.quickwrite.fluent4j.util.args.FluentArgs;
+import net.quickwrite.fluent4j.exception.RecursionDepthReachedException;
 import net.quickwrite.fluent4j.util.args.FunctionFluentArgs;
-import net.quickwrite.fluent4j.util.bundle.DirectFluentBundle;
 import net.quickwrite.fluent4j.ast.placeable.base.FluentPlaceable;
 import net.quickwrite.fluent4j.ast.placeable.NumberLiteral;
 import net.quickwrite.fluent4j.util.bundle.args.AccessorBundle;
@@ -50,6 +49,27 @@ public String getIdentifier() {
         return this.identifier;
     }
 
+    /**
+     * Returns the result of {@link AbstractFunction#getResult(AccessorBundle, FunctionFluentArgs, int)},
+     * but also checks the recursion depth.
+     *
+     * @param bundle The bundle that this is getting called from
+     * @param arguments The arguments the function gets
+     * @param recursionDepth The amount of recursive calls that can still be made
+     * @return The result
+     */
+    public FluentPlaceable getFunctionResult(
+            final AccessorBundle bundle,
+            final FunctionFluentArgs arguments,
+            final int recursionDepth
+    ) {
+        if (recursionDepth <= 0) {
+            throw new RecursionDepthReachedException();
+        }
+
+        return getResult(bundle, arguments, recursionDepth);
+    }
+
     /**
      * Returns the value that should result from the
      * specific argument or the bundle itself. <br>
@@ -69,7 +89,8 @@ public String getIdentifier() {
      *
      * @param bundle The bundle that this is getting called from
      * @param arguments The arguments the function gets
+     * @param recursionDepth The amount of recursive calls that can still be made
      * @return The result
      */
-    public abstract FluentPlaceable getResult(final AccessorBundle bundle, final FunctionFluentArgs arguments);
+    public abstract FluentPlaceable getResult(final AccessorBundle bundle, final FunctionFluentArgs arguments, final int recursionDepth);
 }

src/main/java/net/quickwrite/fluent4j/functions/NumberFunction.java

@@ -71,10 +71,11 @@ public NumberFunction() {
      *
      * @param bundle    The bundle that this is getting called from
      * @param arguments The arguments the function gets
+     * @param recursionDepth The amount of recursive calls that can still be made
      * @return The number as a {@link CustomNumberLiteral} with the parameters
      */
     @Override
-    public FluentPlaceable getResult(final AccessorBundle bundle, final FunctionFluentArgs arguments) {
+    public FluentPlaceable getResult(final AccessorBundle bundle, final FunctionFluentArgs arguments, int recursionDepth) {
         final FluentElement number = arguments.getPositional(0);
 
         CustomNumberLiteral numberLiteral;

src/main/java/net/quickwrite/fluent4j/util/args/CustomNumberLiteral.java

@@ -46,7 +46,7 @@ public void setUseGrouping(boolean useGrouping) {
     }
 
     @Override
-    public String getResult(final AccessorBundle bundle) {
+    public String getResult(final AccessorBundle bundle, int recursionDepth) {
         NumberFormat numberFormat = NumberFormat.getInstance(bundle.getBundle().getLocale());
         numberFormat.setGroupingUsed(useGrouping);
         numberFormat.setMaximumFractionDigits(maximumFractionDigits);