Added Spring Boot Starter

Author: Marcel Overdijk

Changes.md

@@ -6,7 +6,14 @@ This documents the history of significant changes to `rivescript-java`.
 
 This update focuses on new features and bug fixes.
 
+* **API Breaking Changes:**
+  * The `load` and `call` methods of the `ObjectHandler` interface now 
+    require the `RiveScript` instance as an additional (first) argument.
+
 * **Changes:**
+  * Add RiveScript Spring Boot Starter module (#34).
+    A dedicated RiveScript Spring Boot Starter sample is available under
+    `/samples/spring-bootstarter-rsbot` for reference.
   * Add JSR-223 Scripting `ObjectHandler` to support object macros written in 
     any JSR-223 compliant scripting language. The `rivescript-core` distro
     comes bundled with out-of-the-box support for JavaScript, Groovy and Ruby

README.md

@@ -70,6 +70,9 @@ dependencies {
 }
 ```
 
+If you want to use RiveScript in a Spring Boot application see the 
+Spring Boot Starter [section](#spring-boot-starter).
+
 ## Usage
 
 When used as a library for writing your own chatbot, the synopsis is as follows:
@@ -167,6 +170,76 @@ The `<star>` tags in RiveScript will capture the user's "raw" input, so you can
 write replies to get the user's e-mail address or store foreign characters in
 their name.
 
+## Spring Boot Starter
+
+Add the `rivescript-spring-boot-starter` dependency to your project:
+
+_Maven_:
+
+```xml
+<dependency>
+  <groupId>com.rivescript</groupId>
+  <artifactId>rivescript-spring-boot-starter</artifactId>
+  <version>0.8.1</version>
+</dependency>
+```
+
+_Gradle_:
+
+```groovy
+dependencies {
+    compile "com.rivescript:rivescript-spring-boot-starter:0.8.1"
+}
+```
+
+The starter will automatically add the `rivescript-core` dependency to your 
+project and trigger the auto configuration to create the `RiveScript` bot 
+instance.
+
+Although the auto configuration will use sensible defaults to create the bot 
+instance, the following properties can be specified inside your 
+`application.properties`/`application.yml` file (or as command line switches)
+to customize the auto configuration behaviour:
+
+```txt
+rivescript:
+  enabled: true # Enable RiveScript for the application.
+  source-path: classpath:/rivescript/ # The comma-separated list of RiveScript source files and/or directories.
+  file-extensions: .rive, .rs # The comma-separated list of RiveScript file extensions to load.
+  throw-exceptions: false # Enable throw exceptions.
+  strict: true # Enable strict syntax checking.
+  utf8: false # Enable UTF-8 mode.
+  unicode-punctuation: [.,!?;:] # The unicode punctuation pattern (only used when UTF-8 mode is enabled).
+  force-case: false # Enable forcing triggers to lowercase.
+  depth: 50 # The recursion depth limit.
+  error-messages: # The custom error message overrides. For instance `rivescript.error-messages.deepRecursion=Custom Deep Recursion Detected Message`
+  object-handlers: # The comma-separated list of object handler names to register (currently supported: `groovy`, `javascript`, `ruby`).
+```
+
+To automatically register custom Java subroutines and/or non-default supported
+object handlers in the created `RiveScript` bot instance, define appropriate 
+beans in your application context like:
+
+```java
+@Bean
+public Map<String, Subroutine> subroutines() {
+	// The key is the name of the Java object macro to register.
+    Map<String, Subroutine> subroutines = new HashMap<>();
+    subroutines.put("subroutine1", new Subroutine1());
+    subroutines.put("subroutine2", new Subroutine2());
+    return subroutines;
+}
+
+@Bean
+public Map<String, ObjectHandler> objectHandlers() {
+	// The key is the name of the programming language to register.
+    Map<String, ObjectHandler> objectHandlers = new HashMap<>();
+    objectHandlers.put("handler1", new ObjectHandler1());
+    objectHandlers.put("handler2", new ObjectHandler2());
+    return objectHandlers;
+}
+```
+
 ## Building
 
 To compile, test, build all jars and docs run:
@@ -177,22 +250,29 @@ To install all jars into your local Maven cache run:
 
     ./gradlew install
 
-## RSBot Demo Script
+## Samples
+
+The `/samples` folder contains various samples of Java RiveScript bot implementations.
+
+* `rsbot` - The `RSBot.java` is a simple implementation using the `com.rivescript.cmd.Shell`.
 
-The `RSBot.java` is a simple implementation of a Java RiveScript bot. You
-can use it to quickly chat with the Eliza-based bot in the `Aiden/` folder.
+  These commands may be used at your input prompt in RSBot:
 
-These commands may be used at your input prompt in RSBot:
+      /quit        - Quit the program
+      /dump topics - Dump the internal topic/trigger/reply struct (debugging)
+      /dump sorted - Dump the internal trigger sort buffers (debugging)
+      /last        - Print the last trigger you matched.
 
-    /quit        - Quit the program
-    /dump topics - Dump the internal topic/trigger/reply struct (debugging)
-    /dump sorted - Dump the internal trigger sort buffers (debugging)
-    /last        - Print the last trigger you matched.
+  To execute `RSBot` to begin chatting with the demo Eliza-based run:
 
-To execute `RSBot` to begin chatting with the demo Eliza-based bot that
-tends to ship with RiveScript libraries run:
+      ./gradlew :rivescript-samples-rsbot:runBot --console plain
 
-    ./gradlew :rivescript-samples-rsbot:runBot --console plain
+* `spring-boot-starter-rsbot` - This example uses the RiveScript Spring Boot Starter to 
+  auto-configure the `RiveScript` bot instance. 
+  
+  To begin chatting with the demo bot run:
+  
+      ./gradlew :rivescript-samples-spring-boot-starter-rsbot:bootRun --console plain
 
 ## Authors
 

build.gradle

@@ -7,13 +7,14 @@ buildscript {
 }
 
 ext {
-	groovyVersion    = "2.4.8"
-	hamcrestVersion  = "1.3"
-	junitVersion     = "4.12"
-	jrubyVersion     = "9.1.7.0"
-	jsonVersion      = "20160810"
-	mockitoVersion   = "1.10.19"
-	slf4jVersion     = "1.7.22"
+	groovyVersion     = "2.4.8"
+	hamcrestVersion   = "1.3"
+	junitVersion      = "4.12"
+	jrubyVersion      = "9.1.7.0"
+	jsonVersion       = "20160810"
+	mockitoVersion    = "1.10.19"
+	slf4jVersion      = "1.7.22"
+	springBootVersion = "1.5.1.RELEASE"
 	ext.javadocLinks = [
 			"http://docs.oracle.com/javase/7/docs/api/",
 			"http://docs.oracle.com/javaee/7/api/"
@@ -200,6 +201,18 @@ project("rivescript-core") {
 	}
 }
 
+project("rivescript-spring-boot-starter") {
+
+	description = "RiveScript Spring Boot Starter"
+
+	dependencies {
+		compile project(":rivescript-core")
+		compile "org.springframework.boot:spring-boot:${springBootVersion}"
+		compile "org.springframework.boot:spring-boot-autoconfigure:${springBootVersion}"
+		testCompile "org.springframework.boot:spring-boot-test:${springBootVersion}"
+	}
+}
+
 configure(rootProject) {
 
 	description = "RiveScript"

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Mon Feb 20 22:34:13 CET 2017
+#Wed Mar 01 22:24:10 CET 2017
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-3.4-all.zip

rivescript-core/src/integration-test/java/com/rivescript/BaseIT.java

@@ -37,11 +37,6 @@
  */
 public class BaseIT {
 
-	protected static final String ERR_DEEP_RECURSION_DETECTED = "ERR: Deep Recursion Detected";
-	protected static final String ERR_NO_REPLY_MATCHED = "ERR: No Reply Matched";
-	protected static final String ERR_OBJECT_NOT_FOUND = "[ERR: Object Not Found]";
-	protected static final String ERR_REPLIES_NOT_SORTED = "ERR: Replies Not Sorted";
-
 	protected RiveScript rs;
 	protected String username = "local-user";
 

rivescript-core/src/integration-test/java/com/rivescript/GroovyObjectIT.java

@@ -26,6 +26,8 @@
 import org.junit.Before;
 import org.junit.Test;
 
+import static com.rivescript.RiveScript.DEFAULT_OBJECT_NOT_FOUND_MESSAGE;
+
 /**
  * Integration tests for {@link GroovyHandler}.
  *
@@ -36,7 +38,7 @@ public class GroovyObjectIT extends BaseIT {
 	@Before
 	public void setUp() {
 		rs = new RiveScript();
-		rs.setHandler("groovy", new GroovyHandler(rs));
+		rs.setHandler("groovy", new GroovyHandler());
 		setUp(new String[] {
 				"> object reverse groovy",
 				"    def msg = args.join(' ')",
@@ -69,6 +71,6 @@ public void testSetName() {
 	@Test
 	public void testNoGroovyHandler() {
 		rs.removeHandler("groovy");
-		assertReply("reverse hello world", ERR_OBJECT_NOT_FOUND);
+		assertReply("reverse hello world", DEFAULT_OBJECT_NOT_FOUND_MESSAGE);
 	}
 }

rivescript-core/src/integration-test/java/com/rivescript/JavaObjectIT.java

@@ -27,6 +27,8 @@
 import org.junit.Before;
 import org.junit.Test;
 
+import static com.rivescript.RiveScript.DEFAULT_OBJECT_NOT_FOUND_MESSAGE;
+
 /**
  * Integration tests for Java {@link Subroutine}.
  *
@@ -78,6 +80,6 @@ public void testSetName() {
 	@Test
 	public void testRemoveSubroutine() {
 		rs.removeSubroutine("reverse");
-		assertReply("reverse hello world", ERR_OBJECT_NOT_FOUND);
+		assertReply("reverse hello world", DEFAULT_OBJECT_NOT_FOUND_MESSAGE);
 	}
 }

rivescript-core/src/integration-test/java/com/rivescript/JavaScriptObjectIT.java

@@ -26,6 +26,8 @@
 import org.junit.Before;
 import org.junit.Test;
 
+import static com.rivescript.RiveScript.DEFAULT_OBJECT_NOT_FOUND_MESSAGE;
+
 /**
  * Integration tests for {@link JavaScriptHandler}.
  *
@@ -36,7 +38,7 @@ public class JavaScriptObjectIT extends BaseIT {
 	@Before
 	public void setUp() {
 		rs = new RiveScript();
-		rs.setHandler("javascript", new JavaScriptHandler(rs));
+		rs.setHandler("javascript", new JavaScriptHandler());
 		setUp(new String[] {
 				"> object reverse javascript",
 				"    var msg = args.join(' ');",
@@ -69,6 +71,6 @@ public void testSetName() {
 	@Test
 	public void testNoJavaScriptHandler() {
 		rs.removeHandler("javascript");
-		assertReply("reverse hello world", ERR_OBJECT_NOT_FOUND);
+		assertReply("reverse hello world", DEFAULT_OBJECT_NOT_FOUND_MESSAGE);
 	}
 }

rivescript-core/src/integration-test/java/com/rivescript/ObjectIT.java

@@ -27,6 +27,8 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import static com.rivescript.RiveScript.DEFAULT_OBJECT_NOT_FOUND_MESSAGE;
+
 /**
  * @author Noah Petherbridge
  * @author Marcel Overdijk
@@ -53,20 +55,20 @@ public void testMacroParsing() {
 				"- <call>goodbye</call>"
 		});
 		assertReply("Hello", "Hello world!");
-		assertReply("goodbye", ERR_OBJECT_NOT_FOUND);
+		assertReply("goodbye", DEFAULT_OBJECT_NOT_FOUND_MESSAGE);
 	}
 
 	private static class MockHandler implements ObjectHandler {
 
 		private Map<String, String> codes = new HashMap<>();
 
 		@Override
-		public void load(String name, String[] code) {
+		public void load(RiveScript rs, String name, String[] code) {
 			codes.put(name, StringUtils.join(code, "\n"));
 		}
 
 		@Override
-		public String call(String name, String[] fields) {
+		public String call(RiveScript rs, String name, String[] fields) {
 			return codes.get(name);
 		}
 	}

rivescript-core/src/integration-test/java/com/rivescript/ReplyIT.java

@@ -25,6 +25,8 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import static com.rivescript.RiveScript.DEFAULT_DEEP_RECURSION_MESSAGE;
+
 /**
  * @author Noah Petherbridge
  * @author Marcel Overdijk
@@ -139,7 +141,7 @@ public void testRedirects() {
 		assertReply("hi there", "Hi there!");
 		assertReply("my name is Kirsle", "That's my botmaster's name too.");
 		assertReply("call me kirsle", "That's my botmaster's name too.");
-		assertReply("one", ERR_DEEP_RECURSION_DETECTED);
+		assertReply("one", DEFAULT_DEEP_RECURSION_MESSAGE);
 	}
 
 	@Test