Add support for Thymeleaf 3 while keeping Thymeleaf 2 as the default

Closes gh-4393

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/main/java/sample/web/thymeleaf3/InMemoryMessageRepository.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2012-2016 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 sample.web.thymeleaf3;
+
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+import java.util.concurrent.atomic.AtomicLong;
+
+/**
+ * @author Dave Syer
+ */
+public class InMemoryMessageRepository implements MessageRepository {
+
+	private static AtomicLong counter = new AtomicLong();
+
+	private final ConcurrentMap<Long, Message> messages = new ConcurrentHashMap<Long, Message>();
+
+	@Override
+	public Iterable<Message> findAll() {
+		return this.messages.values();
+	}
+
+	@Override
+	public Message save(Message message) {
+		Long id = message.getId();
+		if (id == null) {
+			id = counter.incrementAndGet();
+			message.setId(id);
+		}
+		this.messages.put(id, message);
+		return message;
+	}
+
+	@Override
+	public Message findMessage(Long id) {
+		return this.messages.get(id);
+	}
+
+	@Override
+	public void deleteMessage(Long id) {
+		this.messages.remove(id);
+	}
+
+}

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/main/java/sample/web/thymeleaf3/Message.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2012-2016 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 sample.web.thymeleaf3;
+
+import java.util.Calendar;
+
+import org.hibernate.validator.constraints.NotEmpty;
+
+/**
+ * @author Rob Winch
+ */
+public class Message {
+
+	private Long id;
+
+	@NotEmpty(message = "Message is required.")
+	private String text;
+
+	@NotEmpty(message = "Summary is required.")
+	private String summary;
+
+	private Calendar created = Calendar.getInstance();
+
+	public Long getId() {
+		return this.id;
+	}
+
+	public void setId(Long id) {
+		this.id = id;
+	}
+
+	public Calendar getCreated() {
+		return this.created;
+	}
+
+	public void setCreated(Calendar created) {
+		this.created = created;
+	}
+
+	public String getText() {
+		return this.text;
+	}
+
+	public void setText(String text) {
+		this.text = text;
+	}
+
+	public String getSummary() {
+		return this.summary;
+	}
+
+	public void setSummary(String summary) {
+		this.summary = summary;
+	}
+}

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/main/java/sample/web/thymeleaf3/MessageRepository.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2012-2016 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 sample.web.thymeleaf3;
+
+/**
+ * @author Rob Winch
+ */
+public interface MessageRepository {
+
+	Iterable<Message> findAll();
+
+	Message save(Message message);
+
+	Message findMessage(Long id);
+
+	void deleteMessage(Long id);
+
+}

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/main/java/sample/web/thymeleaf3/SampleWebThymeleaf3Application.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2012-2016 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 sample.web.thymeleaf3;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.core.convert.converter.Converter;
+
+@SpringBootApplication
+public class SampleWebThymeleaf3Application {
+
+	@Bean
+	public MessageRepository messageRepository() {
+		return new InMemoryMessageRepository();
+	}
+
+	@Bean
+	public Converter<String, Message> messageConverter() {
+		return new Converter<String, Message>() {
+			@Override
+			public Message convert(String id) {
+				return messageRepository().findMessage(Long.valueOf(id));
+			}
+		};
+	}
+
+	public static void main(String[] args) throws Exception {
+		SpringApplication.run(SampleWebThymeleaf3Application.class, args);
+	}
+
+}

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/main/java/sample/web/thymeleaf3/mvc/MessageController.java

@@ -0,0 +1,92 @@
+/*
+ * Copyright 2012-2016 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 sample.web.thymeleaf3.mvc;
+
+import javax.validation.Valid;
+
+import sample.web.thymeleaf3.Message;
+import sample.web.thymeleaf3.MessageRepository;
+
+import org.springframework.stereotype.Controller;
+import org.springframework.validation.BindingResult;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.ModelAttribute;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.servlet.ModelAndView;
+import org.springframework.web.servlet.mvc.support.RedirectAttributes;
+
+/**
+ * @author Rob Winch
+ * @author Doo-Hwan Kwak
+ */
+@Controller
+@RequestMapping("/")
+public class MessageController {
+
+	private final MessageRepository messageRepository;
+
+	public MessageController(MessageRepository messageRepository) {
+		this.messageRepository = messageRepository;
+	}
+
+	@GetMapping
+	public ModelAndView list() {
+		Iterable<Message> messages = this.messageRepository.findAll();
+		return new ModelAndView("messages/list", "messages", messages);
+	}
+
+	@GetMapping("{id}")
+	public ModelAndView view(@PathVariable("id") Message message) {
+		return new ModelAndView("messages/view", "message", message);
+	}
+
+	@GetMapping(params = "form")
+	public String createForm(@ModelAttribute Message message) {
+		return "messages/form";
+	}
+
+	@PostMapping
+	public ModelAndView create(@Valid Message message, BindingResult result,
+			RedirectAttributes redirect) {
+		if (result.hasErrors()) {
+			return new ModelAndView("messages/form", "formErrors", result.getAllErrors());
+		}
+		message = this.messageRepository.save(message);
+		redirect.addFlashAttribute("globalMessage", "Successfully created a new message");
+		return new ModelAndView("redirect:/{message.id}", "message.id", message.getId());
+	}
+
+	@RequestMapping("foo")
+	public String foo() {
+		throw new RuntimeException("Expected exception in controller");
+	}
+
+	@GetMapping(value = "delete/{id}")
+	public ModelAndView delete(@PathVariable("id") Long id) {
+		this.messageRepository.deleteMessage(id);
+		Iterable<Message> messages = this.messageRepository.findAll();
+		return new ModelAndView("messages/list", "messages", messages);
+	}
+
+	@GetMapping(value = "modify/{id}")
+	public ModelAndView modifyForm(@PathVariable("id") Message message) {
+		return new ModelAndView("messages/form", "message", message);
+	}
+
+}

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/main/resources/application.properties

@@ -0,0 +1,2 @@
+# Allow Thymeleaf templates to be reloaded at dev time
+spring.thymeleaf.cache: false

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/main/resources/templates/layout.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html xmlns:th="http://www.thymeleaf.org"
+	xmlns:layout="http://www.ultraq.net.nz/web/thymeleaf/layout">
+<head>
+<title>Layout</title>
+<link rel="stylesheet" th:href="@{/css/bootstrap.min.css}"
+	href="../../css/bootstrap.min.css" />
+</head>
+<body>
+	<div class="container">
+		<div class="navbar">
+			<div class="navbar-inner">
+				<a class="brand"
+					href="https://github.com/ultraq/thymeleaf-layout-dialect">
+					Thymeleaf - Layout </a>
+				<ul class="nav">
+					<li><a th:href="@{/}" href="messages.html"> Messages </a></li>
+				</ul>
+			</div>
+		</div>
+		<h1 layout:fragment="header">Layout</h1>
+		<div layout:fragment="content">Fake content</div>
+	</div>
+</body>
+</html>

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/main/resources/templates/messages/form.html

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html xmlns:th="http://www.thymeleaf.org"
+	xmlns:layout="http://www.ultraq.net.nz/web/thymeleaf/layout"
+	layout:decorate="layout">
+<head>
+<title>Messages : Create</title>
+</head>
+<body>
+	<h1 layout:fragment="header">Messages : Create</h1>
+	<div layout:fragment="content" class="container">
+		<form id="messageForm" th:action="@{/(form)}" th:object="${message}"
+			action="#" method="post">
+			<div th:if="${#fields.hasErrors('*')}" class="alert alert-error">
+				<p th:each="error : ${#fields.errors('*')}" th:text="${error}">
+					Validation error</p>
+			</div>
+			<div class="pull-right">
+				<a th:href="@{/}" href="messages.html"> Messages </a>
+			</div>
+			<input type="hidden" th:field="*{id}"
+				th:class="${#fields.hasErrors('id')} ? 'field-error'" /> <label
+				for="summary">Summary</label> <input type="text"
+				th:field="*{summary}"
+				th:class="${#fields.hasErrors('summary')} ? 'field-error'" /> <label
+				for="text">Message</label>
+			<textarea th:field="*{text}"
+				th:class="${#fields.hasErrors('text')} ? 'field-error'"></textarea>
+			<div class="form-actions">
+				<input type="submit" value="Save" />
+			</div>
+		</form>
+	</div>
+</body>
+</html>

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/main/resources/templates/messages/list.html

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html xmlns:th="http://www.thymeleaf.org"
+	xmlns:layout="http://www.ultraq.net.nz/web/thymeleaf/layout"
+	layout:decorate="layout">
+<head>
+<title>Messages : View all</title>
+</head>
+<body>
+	<h1 layout:fragment="header">Messages : View all</h1>
+	<div layout:fragment="content" class="container">
+		<div class="pull-right">
+			<a href="form.html" th:href="@{/(form)}">Create Message</a>
+		</div>
+		<table class="table table-bordered table-striped">
+			<thead>
+				<tr>
+					<td>ID</td>
+					<td>Created</td>
+					<td>Summary</td>
+				</tr>
+			</thead>
+			<tbody>
+				<tr th:if="${messages.empty}">
+					<td colspan="3">No messages</td>
+				</tr>
+				<tr th:each="message : ${messages}">
+					<td th:text="${message.id}">1</td>
+					<td th:text="${#calendars.format(message.created)}">July 11,
+						2012 2:17:16 PM CDT</td>
+					<td><a href="view.html" th:href="@{'/' + ${message.id}}"
+						th:text="${message.summary}"> The summary </a></td>
+				</tr>
+			</tbody>
+		</table>
+	</div>
+</body>
+</html>

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/main/resources/templates/messages/view.html

@@ -0,0 +1,35 @@
+<html xmlns:th="http://www.thymeleaf.org"
+	xmlns:layout="http://www.ultraq.net.nz/web/thymeleaf/layout"
+	layout:decorate="layout">
+<head>
+<title>Messages : View</title>
+</head>
+<body>
+	<h1 layout:fragment="header">Messages : Create</h1>
+	<div layout:fragment="content" class="container">
+		<div class="alert alert-success" th:if="${globalMessage}"
+			th:text="${globalMessage}">Some Success message</div>
+		<div class="pull-right">
+			<a th:href="@{/}" href="list.html"> Messages </a>
+		</div>
+		<dl>
+			<dt>ID</dt>
+			<dd id="id" th:text="${message.id}">123</dd>
+			<dt>Date</dt>
+			<dd id="created" th:text="${#calendars.format(message.created)}">
+				July 11, 2012 2:17:16 PM CDT</dd>
+			<dt>Summary</dt>
+			<dd id="summary" th:text="${message.summary}">A short summary...
+			</dd>
+			<dt>Message</dt>
+			<dd id="text" th:text="${message.text}">A detailed message that
+				is longer than the summary.</dd>
+		</dl>
+		<div class="pull-left">
+			<a href="messages" th:href="@{'/delete/' + ${message.id}}">
+				delete </a> | <a href="form.html"
+				th:href="@{'/modify/' + ${message.id}}"> modify </a>
+		</div>
+	</div>
+</body>
+</html>

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/test/java/sample/web/thymeleaf3/MessageControllerWebTests.java

@@ -0,0 +1,111 @@
+/*
+ * Copyright 2012-2016 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 sample.web.thymeleaf3;
+
+import java.util.regex.Pattern;
+
+import org.hamcrest.Description;
+import org.hamcrest.TypeSafeMatcher;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import sample.web.thymeleaf3.SampleWebThymeleaf3Application;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.WebApplicationContext;
+
+import static org.hamcrest.Matchers.containsString;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+/**
+ * A Basic Spring MVC Test for the Sample Controller"
+ *
+ * @author Biju Kunjummen
+ * @author Doo-Hwan, Kwak
+ */
+@RunWith(SpringRunner.class)
+@WebAppConfiguration
+@ContextConfiguration(classes = SampleWebThymeleaf3Application.class)
+public class MessageControllerWebTests {
+
+	@Autowired
+	private WebApplicationContext wac;
+
+	private MockMvc mockMvc;
+
+	@Before
+	public void setup() {
+		this.mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build();
+	}
+
+	@Test
+	public void testHome() throws Exception {
+		this.mockMvc.perform(get("/")).andExpect(status().isOk())
+				.andExpect(content().string(containsString("<title>Messages")));
+	}
+
+	@Test
+	public void testCreate() throws Exception {
+		this.mockMvc.perform(post("/").param("text", "FOO text").param("summary", "FOO"))
+				.andExpect(status().isFound())
+				.andExpect(header().string("location", RegexMatcher.matches("/[0-9]+")));
+	}
+
+	@Test
+	public void testCreateValidation() throws Exception {
+		this.mockMvc.perform(post("/").param("text", "").param("summary", ""))
+				.andExpect(status().isOk())
+				.andExpect(content().string(containsString("is required")));
+	}
+
+	private static class RegexMatcher extends TypeSafeMatcher<String> {
+		private final String regex;
+
+		public RegexMatcher(String regex) {
+			this.regex = regex;
+		}
+
+		public static org.hamcrest.Matcher<java.lang.String> matches(String regex) {
+			return new RegexMatcher(regex);
+		}
+
+		@Override
+		public boolean matchesSafely(String item) {
+			return Pattern.compile(this.regex).matcher(item).find();
+		}
+
+		@Override
+		public void describeMismatchSafely(String item, Description mismatchDescription) {
+			mismatchDescription.appendText("was \"").appendText(item).appendText("\"");
+		}
+
+		@Override
+		public void describeTo(Description description) {
+			description.appendText("a string that matches regex: ")
+					.appendText(this.regex);
+		}
+	}
+}

spring-boot-samples/spring-boot-sample-web-thymeleaf3/src/test/java/sample/web/thymeleaf3/SampleWebThymeleaf3ApplicationTests.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2012-2016 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 sample.web.thymeleaf3;
+
+import java.net.URI;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import org.springframework.boot.context.embedded.LocalServerPort;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.util.LinkedMultiValueMap;
+import org.springframework.util.MultiValueMap;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Basic integration tests for {@link SampleWebThymeleaf3Application}.
+ *
+ * @author Dave Syer
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
+@DirtiesContext
+public class SampleWebThymeleaf3ApplicationTests {
+
+	@LocalServerPort
+	private int port;
+
+	@Test
+	public void testHome() throws Exception {
+		ResponseEntity<String> entity = new TestRestTemplate()
+				.getForEntity("http://localhost:" + this.port, String.class);
+		assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
+		assertThat(entity.getBody()).contains("<title>Messages");
+		assertThat(entity.getBody()).doesNotContain("layout:fragment");
+	}
+
+	@Test
+	public void testCreate() throws Exception {
+		MultiValueMap<String, String> map = new LinkedMultiValueMap<String, String>();
+		map.set("text", "FOO text");
+		map.set("summary", "FOO");
+		URI location = new TestRestTemplate()
+				.postForLocation("http://localhost:" + this.port, map);
+		assertThat(location.toString()).contains("localhost:" + this.port);
+	}
+
+	@Test
+	public void testCss() throws Exception {
+		ResponseEntity<String> entity = new TestRestTemplate().getForEntity(
+				"http://localhost:" + this.port + "/css/bootstrap.min.css", String.class);
+		assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
+		assertThat(entity.getBody()).contains("body");
+	}
+
+}