getSB usage was eliminated from the macros

verhas · Dec 10, 2024 · a8522d0 · a8522d0
1 parent 4a3efe8
commit a8522d0
Show file tree

Hide file tree

Showing 52 changed files with 397 additions and 129 deletions.
diff --git a/README.jrf b/README.jrf
@@ -1,5 +1,5 @@
 # This is a Jamal reference file containing serialized base64 encoded macros
-# Created: 2024-12-06 15:26:42 +0100
+# Created: 2024-12-10 17:58:05 +0100
 # id|openStr|closeStr|verbatim|tailParameter|pure|content|parameters
 # TOC
 VE9D|eyU=|JX0=|0|0|0|Ci4gPDxJbnN0YWxsYXRpb24+PgouIDw8R1M+PgouIDw8Q29uZmlndXJhdGlvbj4+Ci4gPDxGZWF0dXJlcz4+Ci4gPDxDb250cmlidXRpbmc+PgouIDw8RG9jdW1lbnRhdGlvbj4+Ci4gPDxMaWNlbnNlPj4KLiA8PENoYW5nZWxvZz4+Ci4gPDxSb2FkbWFwPj4KLiA8PFN1cHBvcnQ+PgouIDw8RkFRPj4KLiA8PE1haW50ZW5hbmNlPj4=|
diff --git a/RELEASES.adoc b/RELEASES.adoc
@@ -9,14 +9,35 @@
 NOTE: The known bugs sections in the releases are updated after the release.
 Plese consult the latest SNAPSHOT version available online at https://github.com/verhas/jamal/blob/master/RELEASES.adoc[GitHub Jamal RELEASES.adoc]
 
-== https://github.com/verhas/jamal/tree/2.8.1[2.8.1]
+== https://github.com/verhas/jamal/tree/2.8.2[2.8.2]
 
 === Known Bugs
 
 __currently there are no known bugs in this release__
 
 === New Features
 
+* The installation kit installed command line version includes the debugger.
+
+* When starting the command line version using `-debug` without value it will start the HTTP debugger on the port `8080`.
+If you need to start it on a different port use the ``-debug=http:port`` option.
+Here `http:` is a literal string, and `port` is the port number.
+
+* There is a macro module to read a local GIT repository, which is experimental in this release.
+
+== https://github.com/verhas/jamal/tree/2.8.1[2.8.1]
+
+=== Known Bugs
+
+The command line version of the application does not include the debugger.
+It is not a bug, per se.
+You can start the debugger from the command line, but you have to start the application editing some shell scripts adding the dependency.
+Because the jbang version does include the debugger, it was not considered a bug.
+Starting with the release 2.8.1 there is an installation kit.
+When using the Jamal command line installed with the installation kit, the debugger is not available.
+
+=== New Features
+
 * Functions depending on environment variables also read possible values from `.env` files.
   This functionality can be achieved in prior versions using tools like `direnv`.
   From this release Jamal itself reads the `.env` files.

diff --git a/RELEASES.adoc.jam b/RELEASES.adoc.jam
@@ -9,14 +9,35 @@
 NOTE: The known bugs sections in the releases are updated after the release.
 Plese consult the latest SNAPSHOT version available online at https://github.com/verhas/jamal/blob/master/RELEASES.adoc[GitHub Jamal RELEASES.adoc]
 
-{%RELEASE KOMLO%}
+{%RELEASE HARKIV%}
 
 === Known Bugs
 
 __currently there are no known bugs in this release__
 
 === New Features
 
+* The installation kit installed command line version includes the debugger.
+
+* When starting the command line version using `-debug` without value it will start the HTTP debugger on the port `8080`.
+If you need to start it on a different port use the ``-debug=http:port`` option.
+Here `http:` is a literal string, and `port` is the port number.
+
+* There is a macro module to read a local GIT repository, which is experimental in this release.
+
+{%RELEASE KOMLO%}
+
+=== Known Bugs
+
+The command line version of the application does not include the debugger.
+It is not a bug, per se.
+You can start the debugger from the command line, but you have to start the application editing some shell scripts adding the dependency.
+Because the jbang version does include the debugger, it was not considered a bug.
+Starting with the release {%RELEASE:KOMLO%} there is an installation kit.
+When using the Jamal command line installed with the installation kit, the debugger is not available.
+
+=== New Features
+
 * Functions depending on environment variables also read possible values from `.env` files.
   This functionality can be achieved in prior versions using tools like `direnv`.
   From this release Jamal itself reads the `.env` files.

diff --git a/RELEASES.jim b/RELEASES.jim
@@ -33,7 +33,7 @@ You can find some bare release numbers in the documentation even though the exis
 my parents were there once
 {@define ! RELEASE:ULANBATOR=1.12.3}
 
-The first "next" (non-retrospect) release is named after the city where I lived in most of the my life.
+The first "next" (non-retrospect) release is named after the city where I was born and where I lived in most of the my life.
 
 {@define ! RELEASE:BUDAPEST=2.0.0}
 
@@ -65,4 +65,5 @@ a town very north in Russia
 {@define ! RELEASE:PECSVARAD=2.7.0}
 {@define ! RELEASE:PECS=2.8.0}
 {@define ! RELEASE:KOMLO=2.8.1}
+{@define ! RELEASE:HARKIV=2.8.2} to remember the heroic effort of the Ukrainian people on the 1000-th day of the Russian war
 
diff --git a/documentation/macros/debug.adoc b/documentation/macros/debug.adoc
@@ -51,4 +51,7 @@ When this option is on, the fact that a global and external debugger is defined
 
 NOTE: The macro does not work inside the interactive embeddings like IntelliJ or AsciidocFx.
 Starting up the debugger may cause several different issues in an environment like that.
-Insread the macro in those environments returns a constant string that gets into the document, so you can see while editing.
+Insread the macro in those environments returns a constant string that gets into the document, so you can see while editing.
+
+
+
diff --git a/documentation/macros/include.adoc.jam b/documentation/macros/include.adoc.jam
@@ -1,6 +1,6 @@
 {%@import macrodoc.jim%}
 {%MACRO name="include" since={%RELEASE:ZURICH%}%}
-{%@snip:check file=../../jamal-core/src/main/java/javax0/jamal/builtins/Include.java hash=d09e14c9 %}
+{%@snip:check file=../../jamal-core/src/main/java/javax0/jamal/builtins/Include.java hash=826bb6cc %}
 {%@import ../../environmentvariables.jim%}
 == Syntax
 

diff --git a/jamal-api/src/main/java/javax0/jamal/api/Input.java b/jamal-api/src/main/java/javax0/jamal/api/Input.java
@@ -1,12 +1,11 @@
 package javax0.jamal.api;
 
 /**
- *
  * The input Jamal is working with.
  * This is essentially a stream of characters along with the position reference.
- * When a macro is processed many times the output is also the input of the surrounding macro.
+ * When a macro is processed many times, the output is also the input of the surrounding macro.
  * Therefore, many times the class implementing this interface is also used as output.
- * The naming, therefore is a bit confusing.
+ * The naming, therefore, is a bit confusing.
  * <p>
  * An input has a string builder and also a file name from where the input is coming from.
  * The string builder is used to fetch the characters.
@@ -15,12 +14,20 @@
  */
 public interface Input extends CharSequence {
     /**
+     * Do not use this method in code using the implementations of this interface.
+     * The implementations should
+     * <ul>
+     * <li>either perform the operation as described here to support the default implementations, or
+     * <li>implement the methods in a way that they do not use this method.
+     * </ul>
+     *
      * Get the {@link StringBuilder} that contains the characters of the input. The processing many times works directly
      * on the {@link StringBuilder} deleting characters from the start of it as the processing progresses, thus
      * essentially modifying/mutating the {@code Input} object.
      *
      * @return the {@link StringBuilder} containing the characters of the input.
      */
+    @Deprecated()
     StringBuilder getSB();
 
     /**
@@ -118,6 +125,18 @@ default Input append(Object obj) {
         return this;
     }
 
+    /**
+     * replaces the current content of the input with the string representation of the {@code Object} argument.
+     *
+     * @param obj the object to be converted to string and replace the content of the input
+     * @return {@code this}
+     */
+    default Input replace(Object obj) {
+        this.reset();
+        this.append(obj);
+        return this;
+    }
+
     /**
      * Delete all character from the input. Invokes {@link StringBuilder#setLength(int) setLength(0)} on the underlying
      * StringBuilder.

diff --git a/jamal-asciidoc/pom.xml b/jamal-asciidoc/pom.xml
@@ -180,7 +180,7 @@
         <dependency>
             <groupId>org.jsoup</groupId>
             <artifactId>jsoup</artifactId>
-            <version>1.18.1</version>
+            <version>1.18.3</version>
         </dependency>
     </dependencies>
     <repositories>

diff --git a/jamal-core/src/main/java/javax0/jamal/builtins/Defer.java b/jamal-core/src/main/java/javax0/jamal/builtins/Defer.java
@@ -67,9 +67,7 @@ public void close() throws Exception {
             }
             final var reader = MacroReader.macro(processor);
             final String result = reader.readValue(outputName).orElse(out);
-            final StringBuilder sb = output.getSB();
-            sb.setLength(0);
-            sb.append(result);
+            output.replace(result);
         }
     }
 }

diff --git a/jamal-core/src/main/java/javax0/jamal/builtins/Escape.java b/jamal-core/src/main/java/javax0/jamal/builtins/Escape.java
@@ -205,8 +205,7 @@ public void close() throws Exception {
             if (!processor.errors().isEmpty()) {
                 processor.throwUp();
             }
-            output.getSB().setLength(0);
-            output.append(result);
+            output.replace(result);
         }
     }
 }

diff --git a/jamal-core/src/main/java/javax0/jamal/builtins/Include.java b/jamal-core/src/main/java/javax0/jamal/builtins/Include.java
@@ -57,7 +57,9 @@ public String evaluate(Input input, Processor processor) throws BadSyntax {
         final var weArePseudoDefault = processor.getRegister().open().equals("{") && processor.getRegister().close().equals("}");
         final var useDefaultSeparators = in.length() > 1 && in.charAt(0) == IMPORT_SHEBANG1 && in.charAt(1) == IMPORT_SHEBANG2 && !weArePseudoDefault;
         if (lines.isPresent()) {
-            Range.Lines.filter(in.getSB(), lines.get());
+            final var sb = new StringBuilder(in);
+            Range.Lines.filter(sb, lines.get());
+            in.replace(sb);
         }
         if (verbatim.is()) {
             result = in.toString();

diff --git a/jamal-engine/src/test/java/javax0/jamal/engine/TestProcessor.java b/jamal-engine/src/test/java/javax0/jamal/engine/TestProcessor.java
@@ -308,10 +308,7 @@ public static class Postprocessor implements Macro, AutoCloseable, ProcessorAwar
 
         @Override
         public void close() {
-            final var sb = output.getSB();
-            final var text = sb.toString().toUpperCase(Locale.ENGLISH);
-            sb.setLength(0);
-            sb.append(text);
+            output.replace(output.toString().toUpperCase(Locale.ENGLISH));
         }
 
         @Override

diff --git a/jamal-extensions/src/main/java/javax0/jamal/extensions/UseComments.java b/jamal-extensions/src/main/java/javax0/jamal/extensions/UseComments.java
@@ -40,9 +40,7 @@ public String fetch(Processor processor, Input input) throws BadSyntaxAt {
             }
             lines[j++] = lines[i];
         }
-        final var sb = input.getSB();
-        sb.delete(0, sb.length());
-        sb.append(Arrays.stream(lines).limit(j).collect(Collectors.joining("\n")));
+        input.replace(Arrays.stream(lines).limit(j).collect(Collectors.joining("\n")));
         return Macro.super.fetch(processor, input);
     }
 

diff --git a/jamal-groovy/pom.xml b/jamal-groovy/pom.xml
@@ -77,7 +77,7 @@
         <dependency>
             <groupId>org.codehaus.groovy</groupId>
             <artifactId>groovy-jsr223</artifactId>
-            <version>3.0.22</version>
+            <version>3.0.23</version>
         </dependency>
     </dependencies>
 </project>
diff --git a/jamal-groovy/src/main/java/javax0/jamal/groovy/GroovyCloser.java b/jamal-groovy/src/main/java/javax0/jamal/groovy/GroovyCloser.java
@@ -16,12 +16,14 @@ private Closer(Shell shell, String closerScript) {
 
         @Override
         public void close() throws Exception {
-            shell.property("result", result.getSB());
+            final var resultSB = new StringBuilder(result);
+            shell.property("result", resultSB);
             try {
                 final var sb = shell.evaluate(closerScript, null);
-                if (sb != null && sb != result.getSB()) {// NOT EQUALS, does it return the same object or not
-                    result.getSB().setLength(0);
-                    result.getSB().append(sb);
+                if (sb != null ) {
+                    result.replace(sb);
+                }else{
+                    result.replace(resultSB);
                 }
             } catch (Exception e) {
                 throw new BadSyntax("There was an exception '"

diff --git a/jamal-groovy/src/main/java/javax0/jamal/groovy/GroovyImport.java b/jamal-groovy/src/main/java/javax0/jamal/groovy/GroovyImport.java
@@ -11,13 +11,13 @@ public String evaluate(Input in, Processor processor) throws BadSyntax {
         final var shell = Shell.getShell(in, processor, this);
         final var scriptName = InputHandler.fetch2EOL(in).trim();
         final Input script;
-        if (scriptName.length() > 0) {
+        if (!scriptName.isEmpty()) {
             final var fileName = FileTools.absolute(in.getReference(), scriptName);
             script = FileTools.getInput(fileName, processor);
         } else {
             script = in;
         }
-        script.getSB().append(";''");
+        script.append(";''");
         try {
             shell.evaluate(script.toString(), scriptName);
         } catch (Exception e) {

diff --git a/jamal-groovy/src/main/java/javax0/jamal/groovy/Shell.java b/jamal-groovy/src/main/java/javax0/jamal/groovy/Shell.java
@@ -27,7 +27,7 @@ public Shell(String id) {
     }
 
     public Object evaluate(String script, String fileName) {
-        if (fileName != null && fileName.length() > 0) {
+        if (fileName != null && !fileName.isEmpty()) {
             return shell.evaluate(script, fileName);
         } else {
             return shell.evaluate(script, id + ".groovy");

diff --git a/jamal-java/src/main/java/javax0/jamal/java/Jdsl.java b/jamal-java/src/main/java/javax0/jamal/java/Jdsl.java
@@ -24,9 +24,7 @@ private static class State implements AutoCloseable, Closer.OutputAware {
 
         @Override
         public void close() throws Exception {
-            final var sb = output.getSB();
-            sb.delete(0, sb.length());
-            sb.append(result);
+            output.replace(result);
         }
 
         @Override
@@ -40,7 +38,7 @@ public String fetch(Processor processor, Input input) throws BadSyntaxAt {
         final var original = Macro.super.fetch(processor, input);
 
         processor.state(this, State::new).source = input.toString();
-        input.getSB().delete(0, input.length());
+        input.reset();
         return original;
     }
 

diff --git a/jamal-ruby/pom.xml b/jamal-ruby/pom.xml
@@ -82,7 +82,7 @@
         <dependency>
             <groupId>org.jruby</groupId>
             <artifactId>jruby-complete</artifactId>
-            <version>9.4.8.0</version>
+            <version>9.4.9.0</version>
         </dependency>
     </dependencies>
 </project>
diff --git a/jamal-ruby/src/main/java/javax0/jamal/ruby/RubyCloser.java b/jamal-ruby/src/main/java/javax0/jamal/ruby/RubyCloser.java
@@ -17,12 +17,11 @@ private Closer(Shell shell, String closerScript) {
 
         @Override
         public void close() throws Exception {
-            shell.property("$result", RubyString.newString(shell.shell.getProvider().getRuntime(), result.getSB()));
+            shell.property("$result", RubyString.newString(shell.shell.getProvider().getRuntime(), result));
             try {
                 final var sb = shell.evaluate(closerScript, null);
                 BadSyntax.when(sb == null, "Ruby closer script '%s' returned null", shell.getId());
-                result.getSB().setLength(0);
-                result.getSB().append(sb);
+                result.replace(sb);
             } catch (Exception e) {
                 throw new BadSyntax(String.format("There was an exception '%s' executing the ruby closer script in the shell '%s'.",
                         e.getMessage(), shell.getId()), e);

diff --git a/jamal-ruby/src/main/java/javax0/jamal/ruby/RubyImport.java b/jamal-ruby/src/main/java/javax0/jamal/ruby/RubyImport.java
@@ -17,7 +17,7 @@ public String evaluate(Input in, Processor processor) throws BadSyntax {
         } else {
             script = in;
         }
-        script.getSB().append("\n''");
+        script.append("\n''");
         try {
             shell.evaluate(script.toString(), scriptName);
         } catch (Exception e) {