Renamed ScriptBox to JScriptBox.

Author: nedtwigg

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

@@ -79,18 +79,18 @@ protected CommentScript(String intron, String exon, String regex) {
 	/** Parser which splits up the raw document into structured tags which get passed to the compiler. */
 	final Parser parser;
 
-	/** Compiles a single section/program/input combo into the appropriate output. */
+	/** Compiles a single section/script/input combo into the appropriate output. */
 	final Parser.Compiler compiler = new Parser.Compiler() {
 		@Override
-		public String compileSection(String section, String program, String input) {
+		public String compileSection(String section, String script, String input) {
 			return Errors.rethrow().get(() -> {
 				ScriptEngine engine = setupScriptEngine(section);
 
-				// apply the templating engine to the program
-				String templatedProgram = mustacheTemplate(program, key -> keyToValue(section, key));
+				// apply the templating engine to the script
+				String templatedProgram = template(section, script);
 				// populate the input data
 				engine.put("input", input);
-				// evaluate the program and get the result
+				// evaluate the script and get the result
 				engine.eval(templatedProgram);
 				String compiled = Check.cast(engine.get("output"), String.class);
 				// make sure that the compiled output starts and ends with a newline,
@@ -101,11 +101,11 @@ public String compileSection(String section, String program, String input) {
 				if (!compiled.endsWith("\n")) {
 					compiled = compiled + "\n";
 				}
-				return parser.prefix + " " + section + "\n" +
-						program +
-						parser.postfix +
+				return parser.intron + " " + section + "\n" +
+						script +
+						parser.exon +
 						compiled +
-						parser.prefix + " /" + section + " " + parser.postfix;
+						parser.intron + " /" + section + " " + parser.exon;
 			});
 		}
 	};

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

@@ -27,8 +27,8 @@
 import javax.script.ScriptException;
 
 import com.diffplug.common.base.Errors;
+import com.diffplug.jscriptbox.JScriptBox;
 import com.diffplug.jscriptbox.Language;
-import com.diffplug.jscriptbox.ScriptBox;
 
 /** The defaault implementation. */
 public class FreshMark extends CommentScript {
@@ -46,7 +46,7 @@ public FreshMark(Map<String, ?> properties, Consumer<String> warningStream) {
 
 	@Override
 	protected ScriptEngine setupScriptEngine(String section) throws ScriptException {
-		return ScriptBox.create()
+		return JScriptBox.create()
 				.setAll(properties)
 				.set("link").toFunc2(FreshMark::link)
 				.set("image").toFunc2(FreshMark::image)

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

@@ -21,21 +21,15 @@
 
 /** A format defined by "tag start" and "tag end" chunks of text. */
 class Parser {
-	final String prefix, postfix;
+	final String intron, exon;
 	final Pattern pattern;
 
-	Parser(String prefix, String postfix, String regex) {
-		this.prefix = prefix;
-		this.postfix = postfix;
+	Parser(String intron, String exon, String regex) {
+		this.intron = intron;
+		this.exon = exon;
 		pattern = Pattern.compile(regex, Pattern.DOTALL);
 	}
 
-	Parser(String prefix, String postfix) {
-		this.prefix = prefix;
-		this.postfix = postfix;
-		pattern = Pattern.compile(Pattern.quote(prefix) + "(.*?)" + Pattern.quote(postfix), Pattern.DOTALL);
-	}
-
 	/**
 	 * Given an input string, parses out the body sections from the tag sections.
 	 * 
@@ -87,7 +81,7 @@ Consumer<String> wrap(Consumer<String> action) {
 							numReadSoFar += input.length();
 						} else {
 							// tag
-							String tag = prefix + input + postfix;
+							String tag = intron + input + exon;
 							assert(toRead.startsWith(tag));
 							numReadSoFar += tag.length();
 						}

src/main/java/com/diffplug/jscriptbox/ArityN.java

@@ -16,7 +16,7 @@
 package com.diffplug.jscriptbox;
 
 /**
- * We'd like to pass lambdas to {@link ScriptBox} through a fluent API,
+ * We'd like to pass lambdas to {@link JScriptBox} through a fluent API,
  * which means that we need to describe the function signature
  * in the method name.
  * <p>

src/main/java/com/diffplug/jscriptbox/ScriptBox.java renamed to src/main/java/com/diffplug/jscriptbox/JScriptBox.java

@@ -30,18 +30,18 @@
  * ScriptBox makes it easy to expose both objects and
  * functions to client code in a language-agnostic way.
  */
-public class ScriptBox {
+public class JScriptBox {
 	private Map<String, Object> names = new HashMap<>();
 
-	protected ScriptBox() {}
+	protected JScriptBox() {}
 
 	/** Creates a new NashornHarness and returns it. */
-	public static ScriptBox create() {
-		return new ScriptBox();
+	public static JScriptBox create() {
+		return new JScriptBox();
 	}
 
 	/** Sets all of the properties contained in the given map. */
-	public ScriptBox setAll(Map<String, ?> map) {
+	public JScriptBox setAll(Map<String, ?> map) {
 		names.putAll(map);
 		return this;
 	}
@@ -68,32 +68,32 @@ public NameSetter(String name) {
 			this.name = checkValidIdentifier(name);
 		}
 
-		public ScriptBox toValue(Object value) {
+		public JScriptBox toValue(Object value) {
 			names.put(name, value);
-			return ScriptBox.this;
+			return JScriptBox.this;
 		}
 
 		// @formatter:off
-		public 				ScriptBox toVoid0(Void0 value) { return toValue(value); }
-		public <A>			ScriptBox toVoid1(Void1<A> value) { return toValue(value); }
-		public <A, B>		ScriptBox toVoid2(Void2<A, B> value) { return toValue(value); }
-		public <A, B, C>	ScriptBox toVoid3(Void3<A, B, C> value) { return toValue(value); }
-		public <A, B, C, D>	ScriptBox toVoid4(Void4<A, B, C, D> value) { return toValue(value); }
-
-		public <R>				ScriptBox toFunc0(Func0<R> value) { return toValue(value); }
-		public <A, R>			ScriptBox toFunc1(Func1<A, R> value) { return toValue(value); }
-		public <A, B, R>		ScriptBox toFunc2(Func2<A, B, R> value) { return toValue(value); }
-		public <A, B, C, R>		ScriptBox toFunc3(Func3<A, B, C, R> value) { return toValue(value); }
-		public <A, B, C, D, R>	ScriptBox toFunc4(Func4<A, B, C, D, R> value) { return toValue(value); }
+		public 				JScriptBox toVoid0(Void0 value) { return toValue(value); }
+		public <A>			JScriptBox toVoid1(Void1<A> value) { return toValue(value); }
+		public <A, B>		JScriptBox toVoid2(Void2<A, B> value) { return toValue(value); }
+		public <A, B, C>	JScriptBox toVoid3(Void3<A, B, C> value) { return toValue(value); }
+		public <A, B, C, D>	JScriptBox toVoid4(Void4<A, B, C, D> value) { return toValue(value); }
+
+		public <R>				JScriptBox toFunc0(Func0<R> value) { return toValue(value); }
+		public <A, R>			JScriptBox toFunc1(Func1<A, R> value) { return toValue(value); }
+		public <A, B, R>		JScriptBox toFunc2(Func2<A, B, R> value) { return toValue(value); }
+		public <A, B, C, R>		JScriptBox toFunc3(Func3<A, B, C, R> value) { return toValue(value); }
+		public <A, B, C, D, R>	JScriptBox toFunc4(Func4<A, B, C, D, R> value) { return toValue(value); }
 		// @formatter:on
 	}
 
-	/** Returns a ScriptEngine with the stuff above. */
+	/** Returns a {@link ScriptEngine} which has been populated with the values of this box. */
 	public ScriptEngine build(Language language) throws ScriptException {
 		return language.initializeEngine(names);
 	}
 
-	/** Returns a {@link TypedScriptEngine} with the stuff above. */
+	/** Returns a {@link TypedScriptEngine} which has been populated with the values of this box. */
 	public TypedScriptEngine buildTyped(Language language) throws ScriptException {
 		return new TypedScriptEngine(build(language));
 	}

src/main/java/com/diffplug/jscriptbox/Language.java

@@ -22,7 +22,7 @@
 import javax.script.ScriptEngineManager;
 import javax.script.ScriptException;
 
-/** Interface which converts the result of a {@link ScriptBox} into a {@link ScriptEngine}. */
+/** Interface which converts the result of a {@link JScriptBox} into a {@link ScriptEngine}. */
 public interface Language {
 	/**
 	 * @param names		a map from names which should be defined in the script to their objects, particularly elements of {@link ArityN}.
@@ -31,7 +31,7 @@ public interface Language {
 	 */
 	ScriptEngine initializeEngine(Map<String, Object> names) throws ScriptException;
 
-	/** Language implementation for nashorn. */
+	/** Language implementation for javascript using the nashorn engine. */
 	public static Language javascript() {
 		return map -> {
 			ScriptEngine jsEngine = new ScriptEngineManager().getEngineByName("nashorn");

src/main/java/com/diffplug/jscriptbox/TypedScriptEngine.java

@@ -69,6 +69,11 @@ public <T> Optional<T> getOpt(String name, Class<T> clazz) throws ScriptExceptio
 		return Check.castOpt(scriptEngine.get(name), clazz);
 	}
 
+	/** Puts the given value into the script engine. */
+	public void put(String name, Object value) {
+		scriptEngine.put(name, value);
+	}
+
 	/** The underlying ScriptEngine. */
 	public ScriptEngine getRaw() {
 		return scriptEngine;

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

@@ -23,7 +23,7 @@
 import com.diffplug.common.base.StringPrinter;
 
 public class ParserTest {
-	static final Parser freshmarkParser = new Parser("<!---freshmark", "-->");
+	static final Parser freshmarkParser = new FreshMark(null, null).parser;
 
 	@Test
 	public void testBodyAndTags() {

src/test/java/com/diffplug/scriptbox/ScriptBoxNashornTest.java renamed to src/test/java/com/diffplug/scriptbox/JScriptBoxNashornTest.java

@@ -24,21 +24,21 @@
 import org.junit.Assert;
 import org.junit.Test;
 
+import com.diffplug.jscriptbox.JScriptBox;
 import com.diffplug.jscriptbox.Language;
-import com.diffplug.jscriptbox.ScriptBox;
 
-public class ScriptBoxNashornTest {
+public class JScriptBoxNashornTest {
 	@Test
 	public void testBasicExpressions() throws ScriptException {
-		ScriptEngine engine = ScriptBox.create().build(Language.javascript());
+		ScriptEngine engine = JScriptBox.create().build(Language.javascript());
 		Assert.assertEquals("abc", engine.eval("'abc'"));
 		Assert.assertEquals(123, engine.eval("123"));
 		Assert.assertEquals(123.5, engine.eval("123.5"));
 	}
 
 	@Test
 	public void testBasicScript() throws ScriptException {
-		ScriptEngine engine = ScriptBox.create().build(Language.javascript());
+		ScriptEngine engine = JScriptBox.create().build(Language.javascript());
 		engine.eval("var txt = 'abc';" +
 				"var int = 123;" +
 				"var float = 123.5;");
@@ -53,7 +53,7 @@ public void testBasicScript() throws ScriptException {
 	@Test
 	public void testVoid0() throws ScriptException {
 		AtomicBoolean wasRun = new AtomicBoolean(false);
-		ScriptEngine engine = ScriptBox.create()
+		ScriptEngine engine = JScriptBox.create()
 				.set("void0").toVoid0(() -> wasRun.set(true))
 				.build(Language.javascript());
 		engine.eval("void0()");
@@ -63,7 +63,7 @@ public void testVoid0() throws ScriptException {
 	@Test
 	public void testVoid1() throws ScriptException {
 		AtomicReference<String> arg1 = new AtomicReference<>();
-		ScriptEngine engine = ScriptBox.create()
+		ScriptEngine engine = JScriptBox.create()
 				.set("void1").toVoid1(arg1::set)
 				.build(Language.javascript());
 		engine.eval("void1('it lives!')");
@@ -74,7 +74,7 @@ public void testVoid1() throws ScriptException {
 	public void testVoid2() throws ScriptException {
 		AtomicReference<Object> arg1 = new AtomicReference<>();
 		AtomicReference<Object> arg2 = new AtomicReference<>();
-		ScriptEngine engine = ScriptBox.create()
+		ScriptEngine engine = JScriptBox.create()
 				.set("void2").toVoid2((a, b) -> {
 					arg1.set(a);
 					arg2.set(b);
@@ -90,7 +90,7 @@ public void testVoid3() throws ScriptException {
 		AtomicReference<Object> arg1 = new AtomicReference<>();
 		AtomicReference<Object> arg2 = new AtomicReference<>();
 		AtomicReference<Object> arg3 = new AtomicReference<>();
-		ScriptEngine engine = ScriptBox.create()
+		ScriptEngine engine = JScriptBox.create()
 				.set("void3").toVoid3((a, b, c) -> {
 					arg1.set(a);
 					arg2.set(b);
@@ -109,7 +109,7 @@ public void testVoid4() throws ScriptException {
 		AtomicReference<Object> arg2 = new AtomicReference<>();
 		AtomicReference<Object> arg3 = new AtomicReference<>();
 		AtomicReference<Object> arg4 = new AtomicReference<>();
-		ScriptEngine engine = ScriptBox.create()
+		ScriptEngine engine = JScriptBox.create()
 				.set("void4").toVoid4((a, b, c, d) -> {
 					arg1.set(a);
 					arg2.set(b);
@@ -129,15 +129,15 @@ public void testVoid4() throws ScriptException {
 	//////////////////////////////
 	@Test
 	public void testFunc0() throws ScriptException {
-		ScriptEngine engine = ScriptBox.create()
+		ScriptEngine engine = JScriptBox.create()
 				.set("func0").toFunc0(() -> "wassup")
 				.build(Language.javascript());
 		Assert.assertEquals("wassup", engine.eval("func0()"));
 	}
 
 	@Test
 	public void testFunc1() throws ScriptException {
-		ScriptEngine engine = ScriptBox.create()
+		ScriptEngine engine = JScriptBox.create()
 				.set("func1").toFunc1(a -> a)
 				.build(Language.javascript());
 		Assert.assertEquals("identity", engine.eval("func1('identity')"));
@@ -147,23 +147,23 @@ public void testFunc1() throws ScriptException {
 
 	@Test
 	public void testFunc2() throws ScriptException {
-		ScriptEngine engine = ScriptBox.create()
+		ScriptEngine engine = JScriptBox.create()
 				.set("func2").toFunc2((String a, String b) -> a + b)
 				.build(Language.javascript());
 		Assert.assertEquals("ab", engine.eval("func2('a', 'b')"));
 	}
 
 	@Test
 	public void testFunc3() throws ScriptException {
-		ScriptEngine engine = ScriptBox.create()
+		ScriptEngine engine = JScriptBox.create()
 				.set("func3").toFunc3((String a, String b, String c) -> a + b + c)
 				.build(Language.javascript());
 		Assert.assertEquals("abc", engine.eval("func3('a', 'b', 'c')"));
 	}
 
 	@Test
 	public void testFunc4() throws ScriptException {
-		ScriptEngine engine = ScriptBox.create()
+		ScriptEngine engine = JScriptBox.create()
 				.set("func4").toFunc4((String a, String b, String c, String d) -> a + b + c + d)
 				.build(Language.javascript());
 		Assert.assertEquals("abcd", engine.eval("func4('a', 'b', 'c', 'd')"));