Add scope sample

- Backport #137 fixes #143
- Tune docs for usage and sample.

spring-statemachine-samples/build.gradle

@@ -45,3 +45,12 @@ project('spring-statemachine-samples-web') {
 		compile("org.springframework.session:spring-session:$springSessionVersion")
 	}
 }
+
+project('spring-statemachine-samples-scope') {
+	description = 'Spring State Machine Web Scope Sample'
+	dependencies {
+		compile("org.springframework.boot:spring-boot-starter-thymeleaf:$springBootVersion")
+//		compile("org.springframework.boot:spring-boot-starter-web:$springBootVersion")
+//		compile("org.springframework:spring-webmvc:$springVersion")
+	}
+}

spring-statemachine-samples/scope/src/main/java/demo/scope/Application.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2015 the original author or authors.
+ *
+ * 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 demo.scope;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class Application {
+
+	public static void main(String[] args) {
+		SpringApplication.run(Application.class, args);
+	}
+}

spring-statemachine-samples/scope/src/main/java/demo/scope/StateMachineConfig.java

@@ -0,0 +1,94 @@
+/*
+ * Copyright 2015 the original author or authors.
+ *
+ * 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 demo.scope;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.EnumSet;
+import java.util.Scanner;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Scope;
+import org.springframework.context.annotation.ScopedProxyMode;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.statemachine.config.EnableStateMachine;
+import org.springframework.statemachine.config.EnumStateMachineConfigurerAdapter;
+import org.springframework.statemachine.config.builders.StateMachineConfigurationConfigurer;
+import org.springframework.statemachine.config.builders.StateMachineStateConfigurer;
+import org.springframework.statemachine.config.builders.StateMachineTransitionConfigurer;
+
+@Configuration
+public class StateMachineConfig {
+
+	@Configuration
+	@EnableStateMachine
+	@Scope(scopeName="session", proxyMode=ScopedProxyMode.TARGET_CLASS)
+	static class Config
+			extends EnumStateMachineConfigurerAdapter<States, Events> {
+
+		@Override
+		public void configure(StateMachineConfigurationConfigurer<States, Events> config)
+				throws Exception {
+			config
+				.withConfiguration()
+					.autoStartup(true);
+		}
+
+		@Override
+		public void configure(StateMachineStateConfigurer<States, Events> states)
+				throws Exception {
+			states
+				.withStates()
+					.initial(States.S0)
+					.states(EnumSet.allOf(States.class));
+		}
+
+		@Override
+		public void configure(StateMachineTransitionConfigurer<States, Events> transitions)
+				throws Exception {
+			transitions
+				.withExternal()
+					.source(States.S0).target(States.S1).event(Events.A)
+					.and()
+				.withExternal()
+					.source(States.S1).target(States.S2).event(Events.B)
+					.and()
+				.withExternal()
+					.source(States.S2).target(States.S0).event(Events.C);
+		}
+
+	}
+
+	@Bean
+	public String stateChartModel() throws IOException {
+		ClassPathResource model = new ClassPathResource("statechartmodel.txt");
+		InputStream inputStream = model.getInputStream();
+		Scanner scanner = new Scanner(inputStream);
+		String content = scanner.useDelimiter("\\Z").next();
+		scanner.close();
+		return content;
+	}
+
+	public enum States {
+		S0, S1, S2;
+	}
+
+	public enum Events {
+		A, B, C;
+	}
+
+}

spring-statemachine-samples/scope/src/main/java/demo/scope/StateMachineController.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2015 the original author or authors.
+ *
+ * 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 demo.scope;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.statemachine.StateMachine;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+
+import demo.scope.StateMachineConfig.Events;
+import demo.scope.StateMachineConfig.States;
+
+@Controller
+public class StateMachineController {
+
+	@Autowired
+	private StateMachine<States, Events> stateMachine;
+
+	@Autowired
+	@Qualifier("stateChartModel")
+	private String stateChartModel;
+
+	@RequestMapping("/")
+	public String greeting() {
+		return "redirect:/states";
+	}
+
+	@RequestMapping("/states")
+	public String getStates(@RequestParam(value = "event", required = false) Events event, Model model) {
+		if (event != null) {
+			stateMachine.sendEvent(event);
+		}
+		model.addAttribute("states", stateMachine.getState().getIds());
+		model.addAttribute("stateChartModel", stateChartModel);
+		return "states";
+	}
+
+}

spring-statemachine-samples/scope/src/main/resources/logback.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+
+    <include resource="org/springframework/boot/logging/logback/base.xml"/>
+
+    <logger name="org.springframework.statemachine" level="TRACE"/>
+
+</configuration>

spring-statemachine-samples/scope/src/main/resources/statechartmodel.txt

@@ -0,0 +1,12 @@
++---------------------------------------------------+
+|                        SM                         |
++---------------------------------------------------+
+|                                                   |
+|     +--------+   A   +--------+   B   +--------+  |
+| *-->|   S0   |------>|   S1   |------>|   S2   |  |
+|     +--------+       +--------+       +--------+  |
+|         ^                                  |      |
+|         |                 C                |      |
+|         +----------------------------------+      |
+|                                                   |
++---------------------------------------------------+

spring-statemachine-samples/scope/src/main/resources/templates/states.html

@@ -0,0 +1,16 @@
+<!DOCTYPE HTML>
+<html xmlns:th="http://www.thymeleaf.org">
+<head>
+	<title>Spring Statemachine Scope Demo</title>
+	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+</head>
+<body>
+	<p th:text="'States: ' + ${states}" />
+	<form action="#" data-th-action="@{/states}" data-th-object="${model}" method="post">
+		<button type="submit" name="event" value="A">Send A</button>
+		<button type="submit" name="event" value="B">Send B</button>
+		<button type="submit" name="event" value="C">Send C</button>
+	</form>
+	<pre th:text="${stateChartModel}"/>
+</body>
+</html>