Extracted mustache-based templating out of CommentScript and into CommentScriptMustache.

Author: nedtwigg

src/main/java/com/diffplug/freshmark/CommentScript.java

@@ -15,8 +15,6 @@
  */
 package com.diffplug.freshmark;
 
-import java.util.function.Function;
-import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 import javax.script.ScriptEngine;
@@ -115,37 +113,14 @@ public String compile(String input) {
 		return parser.compile(input, compiler);
 	}
 
-	/** Performs templating on the script.  Delegates to mustache-style templating through keyToValue by default. */
-	protected String template(String section, String script) {
-		return mustacheTemplate(script, key -> keyToValue(section, key));
-	}
-
-	/** For the given section, return the templated value for the given key. */
-	protected abstract String keyToValue(String section, String key);
+	/** For the given section, perform templating on the given script. */
+	protected abstract String template(String section, String script);
 
 	/**
-	 * For the given section, setup a ScriptEngine appropriately.
+	 * For the given section, setup any built-in functions and variables.
 	 * <p>
 	 * The {@code input} value will be set for you, and the {@code output} value will
 	 * be extracted for you, but you must do everything else.
 	 */
 	protected abstract ScriptEngine setupScriptEngine(String section) throws ScriptException;
-
-	/** Replaces whatever is inside of {@code &#123;&#123;key&#125;&#125;} tags using the {@code keyToValue} function. */
-	static String mustacheTemplate(String input, Function<String, String> keyToValue) {
-		Matcher matcher = MUSTACHE_PATTERN.matcher(input);
-		StringBuilder result = new StringBuilder(input.length() * 3 / 2);
-
-		int lastElement = 0;
-		while (matcher.find()) {
-			result.append(matcher.group(1));
-			result.append(keyToValue.apply(matcher.group(2)));
-			lastElement = matcher.end();
-		}
-		result.append(input.substring(lastElement));
-		return result.toString();
-	}
-
-	/** Regex which matches for {@code {{key}}}. */
-	private static final Pattern MUSTACHE_PATTERN = Pattern.compile("(.*?)\\{\\{(.*?)\\}\\}", Pattern.DOTALL);
 }

src/main/java/com/diffplug/freshmark/CommentScriptMustache.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2015 DiffPlug
+ *
+ * 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.diffplug.freshmark;
+
+import java.util.function.Function;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * A CommentScript is a way of automatically generating
+ * or modifying parts of a document by embedding scripts
+ * in the comments of that document.
+ * <p>
+ * A CommentScript has the following form:
+ * <pre>
+ * {@code
+ * [INTRON] sectionName
+ * script
+ * script
+ * [EXON]
+ * lastProgramExecutionResult
+ * lastProgramExecutionResult
+ * lastProgramExecutionResult
+ * [INTRON] /sectionName [EXON]
+ * }
+ * </pre>
+ * This class is a minimal implementation of a CommentScript.  To create a CommentScript,
+ * you must provide:
+ * <ul>
+ * <li>The intron and exon strings in the constructor.</li>
+ * <li>{@link #keyToValue} - defines how template keys in the script string are transformed into values</li>
+ * <li>{@link #setupScriptEngine} - initializes any functions or variables which should be available to the script</li>
+ * </ul>
+ * See {@link FreshMark} for a sample implementation.
+ */
+public abstract class CommentScriptMustache extends CommentScript {
+	/** @see CommentScript#CommentScript(String, String) */
+	protected CommentScriptMustache(String intron, String exon) {
+		super(intron, exon);
+	}
+
+	/** @see CommentScript#CommentScript(String, String, String) */
+	protected CommentScriptMustache(String intron, String exon, String regex) {
+		super(intron, exon, regex);
+	}
+
+	protected String template(String section, String script) {
+		return mustacheTemplate(script, key -> keyToValue(section, script));
+	}
+
+	protected abstract String keyToValue(String section, String script);
+
+	/** Replaces whatever is inside of {@code &#123;&#123;key&#125;&#125;} tags using the {@code keyToValue} function. */
+	static String mustacheTemplate(String input, Function<String, String> keyToValue) {
+		Matcher matcher = MUSTACHE_PATTERN.matcher(input);
+		StringBuilder result = new StringBuilder(input.length() * 3 / 2);
+
+		int lastElement = 0;
+		while (matcher.find()) {
+			result.append(matcher.group(1));
+			result.append(keyToValue.apply(matcher.group(2)));
+			lastElement = matcher.end();
+		}
+		result.append(input.substring(lastElement));
+		return result.toString();
+	}
+
+	/** Regex which matches for {@code {{key}}}. */
+	private static final Pattern MUSTACHE_PATTERN = Pattern.compile("(.*?)\\{\\{(.*?)\\}\\}", Pattern.DOTALL);
+}

src/main/java/com/diffplug/freshmark/FreshMark.java

@@ -31,7 +31,7 @@
 import com.diffplug.jscriptbox.Language;
 
 /** The defaault implementation. */
-public class FreshMark extends CommentScript {
+public class FreshMark extends CommentScriptMustache {
 	private static final String INTRON = "<!---freshmark";
 	private static final String EXON = "-->";
 

src/test/java/com/diffplug/freshmark/CommentScriptMustacheTest.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2015 DiffPlug
+ *
+ * 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.diffplug.freshmark;
+
+import java.util.Locale;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+public class CommentScriptMustacheTest {
+	@Test
+	public void testTemplate() {
+		String before = TestResource.getTestResource("template_before.txt");
+		String after = TestResource.getTestResource("template_after.txt");
+		String afterActual = CommentScriptMustache.mustacheTemplate(before, key -> key.toUpperCase(Locale.US));
+		Assert.assertEquals(after, afterActual);
+	}
+}

src/test/java/com/diffplug/freshmark/FreshMarkDefaultTest.java

@@ -15,17 +15,38 @@
  */
 package com.diffplug.freshmark;
 
-import java.util.Locale;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 import org.junit.Assert;
 import org.junit.Test;
 
 public class FreshMarkTest {
 	@Test
-	public void testTemplate() {
-		String before = TestResource.getTestResource("template_before.txt");
-		String after = TestResource.getTestResource("template_after.txt");
-		String afterActual = CommentScript.mustacheTemplate(before, key -> key.toUpperCase(Locale.US));
+	public void testPrefixDelimReplacement() {
+		String before = TestResource.getTestResource("javadoc_before.txt");
+		String after = TestResource.getTestResource("javadoc_after.txt");
+		String afterActual = FreshMark.prefixDelimiterReplace(before, "https://diffplug.github.io/durian/javadoc/", "/", "4.0");
 		Assert.assertEquals(after, afterActual);
 	}
+
+	@Test
+	public void testFull() {
+		String before = TestResource.getTestResource("full_before.txt");
+		String after = TestResource.getTestResource("full_after.txt");
+
+		Map<String, String> props = new HashMap<>();
+		props.put("stable", "3.2.0");
+		props.put("version", "3.3.0-SNAPSHOT");
+		props.put("group", "com.diffplug.durian");
+		props.put("name", "durian");
+		props.put("org", "diffplug");
+		List<String> warnings = new ArrayList<>();
+		CommentScript freshmark = new FreshMark(props, warnings::add);
+		String afterActual = freshmark.compile(before);
+		Assert.assertEquals(after, afterActual);
+		Assert.assertTrue(warnings.isEmpty());
+	}
 }