provided allowBlocks parameter in interfaces and cli

Author: raydac

jcp/src/main/java/com/igormaznitsa/jcp/JcpPreprocessor.java

@@ -22,10 +22,12 @@
 package com.igormaznitsa.jcp;
 
 import static com.igormaznitsa.jcp.InfoHelper.makeTextForHelpInfo;
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiateAllServices;
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.readWholeTextFileIntoArray;
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.throwPreprocessorException;
 
 import com.igormaznitsa.jcp.cmdline.ActionPreprocessorExtensionHandler;
+import com.igormaznitsa.jcp.cmdline.AllowMergeBlockLineHandler;
 import com.igormaznitsa.jcp.cmdline.AllowWhitespaceDirectiveHandler;
 import com.igormaznitsa.jcp.cmdline.CareForLastEolHandler;
 import com.igormaznitsa.jcp.cmdline.ClearTargetHandler;
@@ -49,6 +51,7 @@
 import com.igormaznitsa.jcp.cmdline.UnknownAsFalseHandler;
 import com.igormaznitsa.jcp.cmdline.VerboseHandler;
 import com.igormaznitsa.jcp.containers.FileInfoContainer;
+import com.igormaznitsa.jcp.context.CommentTextProcessor;
 import com.igormaznitsa.jcp.context.PreprocessingState;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.directives.ExcludeIfDirectiveHandler;
@@ -70,6 +73,7 @@
 import java.util.Locale;
 import java.util.Objects;
 import java.util.Set;
+import java.util.stream.Collectors;
 import lombok.Data;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.FilenameUtils;
@@ -106,6 +110,7 @@ public final class JcpPreprocessor {
       new ExcludeFoldersHandler(),
       new KeepAttributesHandler(),
       new ActionPreprocessorExtensionHandler(),
+      new AllowMergeBlockLineHandler(),
       new UnknownAsFalseHandler()
   };
   private final PreprocessorContext context;
@@ -188,6 +193,15 @@ private static PreprocessorContext processCommandLine(final File baseDir,
       }
     }
 
+    final List<CommentTextProcessor> commentTextProcessors = findAndInstantiateAllServices(
+        CommentTextProcessor.class);
+    if (!commentTextProcessors.isEmpty()) {
+      System.out.printf("Detected comment text processors: %s%n",
+          commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
+              .collect(Collectors.joining(",")));
+      commentTextProcessors.forEach(result::addCommentTextProcessor);
+    }
+
     return result;
   }
 

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

@@ -21,8 +21,11 @@
 
 package com.igormaznitsa.jcp.ant;
 
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiateAllServices;
+
 import com.igormaznitsa.jcp.JcpPreprocessor;
 import com.igormaznitsa.jcp.context.CommentRemoverType;
+import com.igormaznitsa.jcp.context.CommentTextProcessor;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.context.SpecialVariableProcessor;
 import com.igormaznitsa.jcp.exceptions.PreprocessorException;
@@ -67,6 +70,7 @@ public class PreprocessTask extends Task implements PreprocessorLogger, SpecialV
   private Extensions extensions = null;
   private boolean unknownVarAsFalse = false;
   private boolean dryRun = false;
+  private boolean allowBlocks = false;
   private boolean verbose = false;
   private boolean clearTarget = false;
   private boolean careForLastEol = false;
@@ -148,6 +152,7 @@ PreprocessorContext makePreprocessorContext() {
     context.setDontOverwriteSameContent(this.isDontOverwriteSameContent());
     context.setClearTarget(this.isClearTarget());
     context.setDryRun(this.isDryRun());
+    context.setAllowsBlocks(this.isAllowBlocks());
     context.setKeepComments(PreprocessorUtils.findCommentRemoverForId(this.getKeepComments()));
     context.setVerbose(this.isVerbose());
     context.setKeepLines(this.isKeepLines());
@@ -177,6 +182,17 @@ PreprocessorContext makePreprocessorContext() {
               this.getActionPreprocessorExtension().trim()));
     }
 
+    final List<CommentTextProcessor> commentTextProcessors = findAndInstantiateAllServices(
+        CommentTextProcessor.class);
+    if (!commentTextProcessors.isEmpty()) {
+      info(String.format("Detected %d external comment text processing services",
+          commentTextProcessors.size()));
+      info(String.format("Detected comment text processors: %s",
+          commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
+              .collect(Collectors.joining(","))));
+      commentTextProcessors.forEach(context::addCommentTextProcessor);
+    }
+
     this.registerConfigFiles(context);
     this.fillGlobalVars(context);
 

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

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2002-2019 Igor Maznitsa (http://www.igormaznitsa.com)
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.cmdline;
+
+import com.igormaznitsa.jcp.context.PreprocessorContext;
+
+/**
+ * Enable merging of text lines found in //$""" and //$$""" into single text block
+ * for processing by external processors.
+ *
+ * @author Igor Maznitsa (igor.maznitsa@igormaznitsa.com)
+ * @since 7.2.0
+ */
+public class AllowMergeBlockLineHandler implements CommandLineHandler {
+
+  private static final String ARG_NAME = "/B";
+
+  @Override
+  public String getDescription() {
+    return "interpret lines marked by //$\"\"\" and //$$\"\"\" as single text block";
+  }
+
+  @Override
+  public boolean processCommandLineKey(final String key, final PreprocessorContext context) {
+    boolean result = false;
+
+    if (ARG_NAME.equalsIgnoreCase(key)) {
+      context.setAllowsBlocks(true);
+      result = true;
+    }
+
+    return result;
+  }
+
+  @Override
+  public String getKeyName() {
+    return ARG_NAME;
+  }
+
+}

jcp/src/main/java/com/igormaznitsa/jcp/gradle/JcpTask.java

@@ -1,10 +1,12 @@
 package com.igormaznitsa.jcp.gradle;
 
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiateAllServices;
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiatePreprocessorExtensionForClassName;
 import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findCommentRemoverForId;
 import static java.util.Collections.emptyMap;
 
 import com.igormaznitsa.jcp.JcpPreprocessor;
+import com.igormaznitsa.jcp.context.CommentTextProcessor;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.expression.Value;
 import com.igormaznitsa.jcp.logger.PreprocessorLogger;
@@ -98,6 +100,12 @@ public class JcpTask extends DefaultTask {
    * Dry run, making pre-processing but without output
    */
   private final Property<Boolean> dryRun;
+  /**
+   * Allow merge preprocessed lines marked as block text for external processing.
+   *
+   * @since 7.2.0
+   */
+  private final Property<Boolean> allowBlocks;
   /**
    * Verbose mode.
    */
@@ -172,6 +180,7 @@ public JcpTask(final ObjectFactory factory) {
     this.clearTarget = factory.property(Boolean.class).convention(false);
     this.dontOverwriteSameContent = factory.property(Boolean.class).convention(false);
     this.dryRun = factory.property(Boolean.class).convention(false);
+    this.allowBlocks = factory.property(Boolean.class).convention(false);
     this.ignoreMissingSources = factory.property(Boolean.class).convention(false);
     this.keepAttributes = factory.property(Boolean.class).convention(false);
     this.keepComments = factory.property(Object.class).convention(false);
@@ -273,6 +282,11 @@ public Property<Boolean> getDryRun() {
     return dryRun;
   }
 
+  @Input
+  public Property<Boolean> getAllowBlocks() {
+    return allowBlocks;
+  }
+
   @Input
   public Property<Boolean> getVerbose() {
     return verbose;
@@ -348,7 +362,7 @@ public void preprocessTask() throws IOException {
     } else {
       baseDirFile = this.getProject().getProjectDir();
     }
-    logger.info("Base folder: " + baseDirFile);
+    logger.info("Base folder: {}", baseDirFile);
     final PreprocessorContext preprocessorContext = new PreprocessorContext(baseDirFile);
 
     preprocessorContext.setPreprocessorLogger(new PreprocessorLogger() {
@@ -419,6 +433,7 @@ public void warning(final String message) {
     preprocessorContext.setKeepComments(
         findCommentRemoverForId(String.valueOf(this.keepComments.get())));
     preprocessorContext.setDryRun(this.dryRun.get());
+    preprocessorContext.setAllowsBlocks(this.allowBlocks.get());
     preprocessorContext.setKeepAttributes(this.keepAttributes.get());
     preprocessorContext.setKeepLines(this.keepLines.get());
     preprocessorContext.setAllowWhitespaces(this.allowWhitespaces.get());
@@ -438,6 +453,17 @@ public void warning(final String message) {
           findAndInstantiatePreprocessorExtensionForClassName(className));
     }
 
+    final List<CommentTextProcessor> commentTextProcessors = findAndInstantiateAllServices(
+        CommentTextProcessor.class);
+    if (!commentTextProcessors.isEmpty()) {
+      logger.info("Detected {} external comment text processing services",
+          commentTextProcessors.size());
+      logger.info("Detected comment text processors: {}",
+          commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
+              .collect(Collectors.joining(",")));
+      commentTextProcessors.forEach(preprocessorContext::addCommentTextProcessor);
+    }
+
     this.vars.getOrElse(emptyMap()).entrySet().stream()
         .filter(e -> {
           if (e.getValue() == null) {

jcp/src/main/java/com/igormaznitsa/jcp/maven/PreprocessMojo.java

@@ -22,9 +22,11 @@
 package com.igormaznitsa.jcp.maven;
 
 import static com.igormaznitsa.jcp.utils.GetUtils.ensureNonNull;
+import static com.igormaznitsa.jcp.utils.PreprocessorUtils.findAndInstantiateAllServices;
 
 import com.igormaznitsa.jcp.JcpPreprocessor;
 import com.igormaznitsa.jcp.context.CommentRemoverType;
+import com.igormaznitsa.jcp.context.CommentTextProcessor;
 import com.igormaznitsa.jcp.context.PreprocessorContext;
 import com.igormaznitsa.jcp.exceptions.PreprocessorException;
 import com.igormaznitsa.jcp.expression.Value;
@@ -115,8 +117,8 @@ public class PreprocessMojo extends AbstractMojo implements PreprocessorLogger {
    * Name of a class to be used as action preprocessor extension. The class must have default constructor.
    * Empty string will be recognized as missing class name.
    *
-   * @since 7.1.2
    * @see com.igormaznitsa.jcp.extension.PreprocessorExtension
+   * @since 7.1.2
    */
   @Parameter(alias = "actionPreprocessorExtension", property = "jcp.action.preprocessor.extension", defaultValue = "")
   private String actionPreprocessorExtension = "";
@@ -199,6 +201,14 @@ public class PreprocessMojo extends AbstractMojo implements PreprocessorLogger {
   @Parameter(alias = "dryRun", defaultValue = "false")
   private boolean dryRun = false;
 
+  /**
+   * Allows merge preprocessed text lines as single text block for external processing.
+   *
+   * @since 7.2.0.
+   */
+  @Parameter(alias = "allowBlocks", defaultValue = "false")
+  private boolean allowBlocks = false;
+
   /**
    * Verbose mode.
    */
@@ -418,6 +428,7 @@ PreprocessorContext makePreprocessorContext() throws AbstractMojoExecutionExcept
     context.setVerbose(getLog().isDebugEnabled() || this.isVerbose());
     context.setKeepLines(this.isKeepLines());
     context.setDryRun(this.isDryRun());
+    context.setAllowsBlocks(this.isAllowBlocks());
     context.setAllowWhitespaces(this.isAllowWhitespaces());
     context.setPreserveIndents(this.isPreserveIndents());
     context.setExcludeFolders(this.getExcludeFolders());
@@ -466,6 +477,22 @@ public void execute() throws MojoExecutionException, MojoFailureException {
       final PreprocessorContext context;
       try {
         context = makePreprocessorContext();
+        final List<CommentTextProcessor> commentTextProcessors = findAndInstantiateAllServices(
+            CommentTextProcessor.class);
+        if (!commentTextProcessors.isEmpty()) {
+          getLog().info("Detected " + commentTextProcessors.size() +
+              " external comment text processing services");
+          if (this.isVerbose()) {
+            getLog().info("Detected comment text processors: " +
+                commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
+                    .collect(Collectors.joining(",")));
+          } else {
+            getLog().debug("Detected comment text processors: " +
+                commentTextProcessors.stream().map(x -> x.getClass().getCanonicalName())
+                    .collect(Collectors.joining(",")));
+          }
+          commentTextProcessors.forEach(context::addCommentTextProcessor);
+        }
       } catch (Exception ex) {
         final PreprocessorException newException =
             PreprocessorException.extractPreprocessorException(ex);

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

@@ -47,9 +47,11 @@
 import java.util.Locale;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.ServiceLoader;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.FilenameUtils;
 
@@ -244,6 +246,10 @@ public static String replacePartByChar(final String text, final char chr, final
     return result.toString();
   }
 
+  public static <T> List<T> findAndInstantiateAllServices(final Class<T> serviceClass) {
+    final ServiceLoader<T> serviceLoader = ServiceLoader.load(serviceClass);
+    return serviceLoader.stream().map(ServiceLoader.Provider::get).collect(Collectors.toList());
+  }
 
   public static String generateStringForChar(final char chr, final int length) {
     final StringBuilder buffer = new StringBuilder(Math.max(length, 1));

jcp/src/test/java/com/igormaznitsa/jcp/cmdline/AllowMergeBlockLineHandlerTest.java

@@ -0,0 +1,41 @@
+package com.igormaznitsa.jcp.cmdline;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.verify;
+
+import com.igormaznitsa.jcp.context.PreprocessorContext;
+
+public class AllowMergeBlockLineHandlerTest extends AbstractCommandLineHandlerTest {
+
+  private static final AllowMergeBlockLineHandler HANDLER = new AllowMergeBlockLineHandler();
+
+  @Override
+  public void testThatTheHandlerInTheHandlerList() {
+    assertHandlerInTheHandlerList(HANDLER);
+  }
+
+  @Override
+  public void testExecution() throws Exception {
+    final PreprocessorContext mock = prepareMockContext();
+
+    assertFalse(HANDLER.processCommandLineKey("", mock));
+    assertFalse(HANDLER.processCommandLineKey("/b:", mock));
+    assertFalse(HANDLER.processCommandLineKey("/BB", mock));
+
+    assertTrue(HANDLER.processCommandLineKey("/B", mock));
+    verify(mock).setAllowsBlocks(true);
+  }
+
+  @Override
+  public void testName() {
+    assertEquals("/B", HANDLER.getKeyName());
+  }
+
+  @Override
+  public void testDescription() {
+    assertDescription(HANDLER);
+  }
+
+}