minor refactoring and added STR TRIMLINES(STR) function

Author: raydac

README.md

@@ -10,6 +10,7 @@
 # Changelog
 
 - **6.1.2-SNAPSHOT (under development)**
+  - CORE: added STR TRIMLINES(STR) function to trim lines represented as string and removing empty lines
   - CORE: added `/A` command line option (`copyFileAttributes` in Maven and ANT) to copy file attributes
   - CORE: added `/ED:` command line option to exclude sub-folders from preprocessing (`excludedFolders` in Maven and ANT) with ANT pattern support.
   - CORE: added `/PI` command line option (`preserveIndent` in Maven and ANT), turn on mode to preserve indent when removing `//$` and `//$$`, thanks to [jamuir](https://github.com/jamuir)

changelog.txt

@@ -1,4 +1,5 @@
 6.1.2-SNAPSHOT (under development)
+ - CORE: added STR TRIMLINES(STR) function to trim lines represented as string and removing empty lines
  - CORE: added `/A` command line option (`copyFileAttributes` in Maven and ANT) to copy file attributes
  - CORE: added `/ED:` command line option to exclude sub-folders from preprocessing (`excludedFolders` in Maven and ANT) with ANT pattern support.
  - CORE: added `/PI` command line flag (`preserveIndent` in Maven and ANT), turn on mode to preserve indent when removing `//$` and `//$$`, thanks to @jamuir

src/main/java/com/igormaznitsa/jcp/expression/functions/AbstractFunction.java

@@ -65,6 +65,7 @@ public abstract class AbstractFunction implements ExpressionItem {
     new FunctionSTR2XML(),
     new FunctionSTR2JAVA(),
     new FunctionSTR2GO(),
+    new FunctionTRIMLINES(),
     new FunctionSTRLEN(),
     new FunctionISSUBSTR(),
     new FunctionIS(),

src/main/java/com/igormaznitsa/jcp/expression/functions/FunctionSTR2GO.java

@@ -43,7 +43,7 @@ public String getName() {
   public Value executeStrBool(@Nonnull final PreprocessorContext context, @Nonnull final Value source, @Nonnull final Value splitAndQuoteLines) {
     if (splitAndQuoteLines.asBoolean()){
       final boolean endsWithNextLine = source.asString().endsWith("\n");
-      final String [] splitted = source.asString().split("\\n");
+      final String [] splitted = PreprocessorUtils.splitForCharAndHoldEmptyLine(source.asString(),'\n');
       final StringBuilder result = new StringBuilder(source.asString().length()*2);
       final String nextLineChars = PreprocessorUtils.getNextLineCodes();
 

src/main/java/com/igormaznitsa/jcp/expression/functions/FunctionSTR2JAVA.java

@@ -45,7 +45,7 @@ public String getName() {
   public Value executeStrBool(@Nonnull final PreprocessorContext context, @Nonnull final Value source, @Nonnull final Value splitAndQuoteLines) {
     if (splitAndQuoteLines.asBoolean()){
       final boolean endsWithNextLine = source.asString().endsWith("\n");
-      final String [] splitted = source.asString().split("\\n");
+      final String [] splitted = PreprocessorUtils.splitForCharAndHoldEmptyLine(source.asString(),'\n');
       final StringBuilder result = new StringBuilder(source.asString().length()*2);
       final String nextLineChars = PreprocessorUtils.getNextLineCodes();
 

src/main/java/com/igormaznitsa/jcp/expression/functions/FunctionTRIMLINES.java

@@ -0,0 +1,67 @@
+/* 
+ * Copyright 2017 Igor Maznitsa (http://www.igormaznitsa.com).
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.igormaznitsa.jcp.expression.functions;
+
+import javax.annotation.Nonnull;
+
+import com.igormaznitsa.jcp.context.PreprocessorContext;
+import com.igormaznitsa.jcp.expression.Value;
+import com.igormaznitsa.jcp.expression.ValueType;
+
+import com.igormaznitsa.jcp.utils.PreprocessorUtils;
+
+/**
+ * The class implements the TRIMLINES function handler
+ *
+ * @author Igor Maznitsa ([email protected])
+ */
+public final class FunctionTRIMLINES extends AbstractStrConverter {
+
+  @Override
+  @Nonnull
+  public String getName() {
+    return "trimlines";
+  }
+
+  @Override
+  @Nonnull
+  public Value executeStr(@Nonnull final PreprocessorContext context, @Nonnull final Value value) {
+    final String text = value.asString();
+    final StringBuilder result = new StringBuilder(text.length());
+
+    for(final String s : PreprocessorUtils.splitForChar(text, '\n')){
+      final String trimmed = s.trim();
+      if (!trimmed.isEmpty()) {
+        if (result.length()>0) result.append(PreprocessorUtils.getNextLineCodes());
+        result.append(trimmed);
+      }
+    }
+    
+    return Value.valueOf(result.toString());
+  }
+
+  @Override
+  @Nonnull
+  public String getReference() {
+    return "split string to lines and trim ecah line, empty lines will be removed";
+  }
+
+  @Override
+  @Nonnull
+  public ValueType getResultType() {
+    return ValueType.STRING;
+  }
+}

src/main/java/com/igormaznitsa/jcp/utils/PreprocessorUtils.java

@@ -382,6 +382,13 @@ public static String[] splitForEqualChar(@Nonnull final String string) {
     return result;
   }
 
+  @Nonnull
+  @MustNotContainNull
+  public static String[] splitForCharAndHoldEmptyLine(@Nonnull final String string, final char delimiter) {
+    String [] result = splitForChar(string, delimiter);
+    return result.length == 0 ? new String[]{""} : result;
+  }
+  
   @Nonnull
   @MustNotContainNull
   public static String[] splitForChar(@Nonnull final String string, final char delimiter) {

src/test/java/com/igormaznitsa/jcp/expression/functions/FunctionSTR2JAVATest.java

@@ -48,7 +48,6 @@ public void testExecution_wrongCases() throws Exception {
     assertFunctionException("str2java(true,\"ss\")");
     assertFunctionException("str2java(\"ss\",3)");
     assertDestinationFolderEmpty();
-   
   }
 
   @Override

src/test/java/com/igormaznitsa/jcp/expression/functions/FunctionTRIMLINESTest.java

@@ -0,0 +1,71 @@
+/* 
+ * Copyright 2014 Igor Maznitsa (http://www.igormaznitsa.com).
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.igormaznitsa.jcp.expression.functions;
+
+import com.igormaznitsa.jcp.expression.Value;
+import com.igormaznitsa.jcp.expression.ValueType;
+import com.igormaznitsa.jcp.utils.PreprocessorUtils;
+import org.junit.Test;
+import static org.junit.Assert.*;
+
+public class FunctionTRIMLINESTest extends AbstractFunctionTest {
+
+  private static final FunctionTRIMLINES HANDLER = new FunctionTRIMLINES();
+
+  @Test
+  public void testExecution_WorkingCases() throws Exception {
+    assertFunction("trimlines(\"\")", Value.valueOf(""));
+    assertFunction("trimlines(\"hello world\")", Value.valueOf("hello world"));
+    assertFunction("trimlines(\"  hello   \n   \n   world\n\")", Value.valueOf("hello"+PreprocessorUtils.getNextLineCodes()+"world"));
+    assertDestinationFolderEmpty();
+  }
+
+  @Test
+  public void testExecution_wrongCases() throws Exception {
+    assertFunctionException("trimlines()");
+    assertFunctionException("trimlines(1)");
+    assertFunctionException("trimlines(true)");
+    assertFunctionException("trimlines(true,\"ss\")");
+    assertFunctionException("trimlines(\"ss\",3)");
+    assertDestinationFolderEmpty();
+   
+  }
+
+  @Override
+  public void testName() {
+    assertEquals("trimlines", HANDLER.getName());
+  }
+
+  @Override
+  public void testReference() {
+    assertReference(HANDLER);
+  }
+
+  @Override
+  public void testArity() {
+    assertEquals(1, HANDLER.getArity());
+  }
+
+  @Override
+  public void testAllowedArgumentTypes() {
+    assertAllowedArguments(HANDLER, new ValueType[][]{{ValueType.STRING}});
+  }
+
+  @Override
+  public void testResultType() {
+    assertEquals(ValueType.STRING, HANDLER.getResultType());
+  }
+}