#46 refactoring for removers

Author: raydac

jcp-tests/jcp-test-gradle-7/build.gradle

@@ -49,7 +49,7 @@ preprocess {
     verbose = true
     clearTarget = true
     careForLastEol = true
-    keepComments = 'remove_all'
+    keepComments = 'remove_c_style'
     excludeFolders = ['**/some1', '**/some2']
     configFiles = ['./configFile.txt']
     keepLines = true

jcp-tests/jcp-test-gradle-8/build.gradle

@@ -49,7 +49,7 @@ preprocess {
     verbose = true
     clearTarget = true
     careForLastEol = true
-    keepComments = 'remove_jcp'
+    keepComments = 'remove_jcp_only'
     excludeFolders = ['**/some1', '**/some2']
     configFiles = ['./configFile.txt']
     keepLines = true

jcp/src/main/java/com/igormaznitsa/jcp/ant/PreprocessTask.java

@@ -22,13 +22,14 @@
 package com.igormaznitsa.jcp.ant;
 
 import com.igormaznitsa.jcp.JcpPreprocessor;
-import com.igormaznitsa.jcp.context.KeepComments;
+import com.igormaznitsa.jcp.context.CommentRemoverType;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.context.SpecialVariableProcessor;
 import com.igormaznitsa.jcp.exceptions.PreprocessorException;
 import com.igormaznitsa.jcp.expression.Value;
 import com.igormaznitsa.jcp.logger.PreprocessorLogger;
 import com.igormaznitsa.jcp.utils.GetUtils;
+import com.igormaznitsa.jcp.utils.PreprocessorUtils;
 import java.io.File;
 import java.nio.charset.Charset;
 import java.util.ArrayList;
@@ -69,7 +70,7 @@ public class PreprocessTask extends Task implements PreprocessorLogger, SpecialV
   private boolean verbose = false;
   private boolean clearTarget = false;
   private boolean careForLastEol = false;
-  private String keepComments = KeepComments.REMOVE_ALL.name();
+  private String keepComments = CommentRemoverType.REMOVE_C_STYLE.name();
   private Vars vars = null;
   private ExcludeFolders excludeFolders = null;
   private ConfigFiles configFiles = null;
@@ -146,7 +147,7 @@ PreprocessorContext makePreprocessorContext() {
     context.setDontOverwriteSameContent(this.isDontOverwriteSameContent());
     context.setClearTarget(this.isClearTarget());
     context.setDryRun(this.isDryRun());
-    context.setKeepComments(KeepComments.findForText(this.getKeepComments()));
+    context.setKeepComments(PreprocessorUtils.findCommentRemoverForId(this.getKeepComments()));
     context.setVerbose(this.isVerbose());
     context.setKeepLines(this.isKeepLines());
     context.setCareForLastEol(this.isCareForLastEol());

jcp/src/main/java/com/igormaznitsa/jcp/cmdline/KeepCommentsHandler.java

@@ -21,7 +21,9 @@
 
 package com.igormaznitsa.jcp.cmdline;
 
-import com.igormaznitsa.jcp.context.KeepComments;
+import static com.igormaznitsa.jcp.context.CommentRemoverType.makeListOfAllRemoverIds;
+
+import com.igormaznitsa.jcp.context.CommentRemoverType;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.utils.PreprocessorUtils;
 import java.util.Locale;
@@ -38,8 +40,8 @@ public class KeepCommentsHandler implements CommandLineHandler {
 
   @Override
   public String getDescription() {
-    return "select keep comments mode, for instance /M:remove_all, (allowed: " +
-        KeepComments.makeStringForExpectedValues() + ')';
+    return "select keep comments mode, for instance /M:remove_c_style, (allowed: true,false," +
+        makeListOfAllRemoverIds() + ')';
   }
 
   @Override
@@ -49,13 +51,13 @@ public boolean processCommandLineKey(final String key, final PreprocessorContext
     if (!key.isEmpty() && key.toUpperCase(Locale.ENGLISH).startsWith(ARG_NAME)) {
       final String tail = PreprocessorUtils.extractTrimmedTail(ARG_NAME, key);
 
-      final KeepComments mode;
+      final CommentRemoverType mode;
       try {
-        mode = KeepComments.findForText(tail);
+        mode = PreprocessorUtils.findCommentRemoverForId(tail);
       } catch (IllegalArgumentException ex) {
         throw context.makeException(
-            "Illegal keep comments mode '" + tail + "' in " + ARG_NAME + ", expected one of " +
-                KeepComments.makeStringForExpectedValues(), null);
+            "Illegal keep comments mode '" + tail + "' in " + ARG_NAME + ", expected one of: true,false," +
+                makeListOfAllRemoverIds(), null);
       }
 
       context.setKeepComments(mode);

jcp/src/main/java/com/igormaznitsa/jcp/cmdline/RemoveCommentsHandler.java

@@ -21,7 +21,7 @@
 
 package com.igormaznitsa.jcp.cmdline;
 
-import com.igormaznitsa.jcp.context.KeepComments;
+import com.igormaznitsa.jcp.context.CommentRemoverType;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 
 /**
@@ -45,7 +45,7 @@ public boolean processCommandLineKey(final String argument,
     boolean result = false;
 
     if (ARG_NAME.equalsIgnoreCase(argument)) {
-      configurator.setKeepComments(KeepComments.REMOVE_ALL);
+      configurator.setKeepComments(CommentRemoverType.REMOVE_C_STYLE);
       result = true;
     }
 

jcp/src/main/java/com/igormaznitsa/jcp/context/CommentRemoverType.java

@@ -0,0 +1,33 @@
+package com.igormaznitsa.jcp.context;
+
+import java.util.Arrays;
+import java.util.stream.Collectors;
+
+/**
+ * Type of comment remover.
+ * @since 7.1.0
+ */
+public enum CommentRemoverType {
+  /**
+   * To not remove comments.
+   */
+  KEEP_ALL,
+  /**
+   * Remove all single line and multiline comments defined in C style.
+   */
+  REMOVE_C_STYLE,
+  /**
+   * Remove only comments contain JCP directives.
+   */
+  REMOVE_JCP_ONLY;
+
+  /**
+   * Make comma separated list of enum item names.
+   * @return comma separated list of all enum items, without spaces.
+   */
+  public static String makeListOfAllRemoverIds() {
+    return Arrays.stream(CommentRemoverType.values())
+        .map(Enum::toString).collect(Collectors.joining(","));
+  }
+
+}

jcp/src/main/java/com/igormaznitsa/jcp/context/KeepComments.java

@@ -420,7 +420,7 @@ public void saveBuffersToStreams(final OutputStream prefix, final OutputStream n
         new BufferedWriter(new OutputStreamWriter(postfix, globalOutCharacterEncoding)));
   }
 
-  public boolean saveBuffersToFile(final File outFile, final KeepComments keepComments)
+  public boolean saveBuffersToFile(final File outFile, final CommentRemoverType keepComments)
       throws IOException {
     final File path = outFile.getParentFile();
 
@@ -439,7 +439,7 @@ public boolean saveBuffersToFile(final File outFile, final KeepComments keepComm
 
       if (this.overrideOnlyIfContentChanged) {
         String content = writePrinterBuffers(new StringWriter(totatBufferedChars)).toString();
-        if (keepComments != KeepComments.KEEP_ALL) {
+        if (keepComments != CommentRemoverType.KEEP_ALL) {
           content = makeCommentRemover(
               keepComments,
               new StringReader(content),
@@ -464,7 +464,7 @@ public boolean saveBuffersToFile(final File outFile, final KeepComments keepComm
           this.context.logDebug(
               "Ignore writing data for " + outFile + " because its content has not been changed");
         }
-      } else if (keepComments != KeepComments.KEEP_ALL) {
+      } else if (keepComments != CommentRemoverType.KEEP_ALL) {
         final String joinedBufferContent =
             writePrinterBuffers(new StringWriter(totatBufferedChars)).toString();
         writer = new OutputStreamWriter(

jcp/src/main/java/com/igormaznitsa/jcp/context/PreprocessingState.java

@@ -98,7 +98,7 @@ public class PreprocessorContext {
       .ensureNonNull(System.getProperty("jcp.line.separator", System.getProperty("line.separator")),
           "\n");
   private boolean verbose = false;
-  private KeepComments keepComments = KeepComments.KEEP_ALL;
+  private CommentRemoverType keepComments = CommentRemoverType.KEEP_ALL;
   private boolean clearTarget = false;
   private boolean dryRun = false;
   private boolean keepLines = false;

jcp/src/main/java/com/igormaznitsa/jcp/context/PreprocessorContext.java

@@ -25,7 +25,7 @@
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findFirstActiveFileContainer;
 
 import com.igormaznitsa.jcp.containers.FileInfoContainer;
-import com.igormaznitsa.jcp.context.KeepComments;
+import com.igormaznitsa.jcp.context.CommentRemoverType;
 import com.igormaznitsa.jcp.context.PreprocessingState;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.expression.Value;
@@ -79,7 +79,7 @@ private PreprocessorContext prepareContext(final PreprocessorContext base) {
     result.setDryRun(true);
     result.setKeepLines(false);
     result.setClearTarget(false);
-    result.setKeepComments(KeepComments.REMOVE_ALL);
+    result.setKeepComments(CommentRemoverType.REMOVE_C_STYLE);
     result.setCareForLastEol(true);
     return result;
   }