Tutorial v2

- Follow JB Nizet JPA guidelines
- Use Mockk and SpringMockK
- Document Maven configuration in addition to Gradle one
- Leverage CrudRepository.findIdOrNull extension
- Upgrade to Spring Boot 2.1.3
- Various refactoring and improvements

Closes gh-22
Closes gh-23

Author: sdeleuze

Diff for: README.adoc

@@ -1,7 +1,7 @@
 buildscript {
 	ext {
-		kotlinVersion = '1.2.41'
-		springBootVersion = '2.1.2.RELEASE'
+		kotlinVersion = '1.2.71'
+		springBootVersion = '2.1.3.RELEASE'
 	}
 	repositories {
 		mavenCentral()
@@ -17,6 +17,7 @@ buildscript {
 apply plugin: 'kotlin'
 apply plugin: 'kotlin-spring'
 apply plugin: 'kotlin-jpa'
+apply plugin: 'kotlin-allopen'
 apply plugin: 'kotlin-kapt'
 apply plugin: 'org.springframework.boot'
 apply plugin: 'io.spring.dependency-management'
@@ -26,17 +27,21 @@ version = '0.0.1-SNAPSHOT'
 sourceCompatibility = 1.8
 compileKotlin {
 	kotlinOptions {
-		freeCompilerArgs = ["-Xjsr305=strict"]
-		jvmTarget = "1.8"
+		freeCompilerArgs = ['-Xjsr305=strict']
+		jvmTarget = '1.8'
 	}
 }
 compileTestKotlin {
 	kotlinOptions {
-		freeCompilerArgs = ["-Xjsr305=strict"]
-		jvmTarget = "1.8"
+		freeCompilerArgs = ['-Xjsr305=strict']
+		jvmTarget = '1.8'
 	}
 }
 
+allOpen {
+	annotation('javax.persistence.Entity')
+}
+
 repositories {
 	mavenCentral()
 }
@@ -45,22 +50,20 @@ test {
 	useJUnitPlatform()
 }
 
-
 dependencies {
 	compile('org.springframework.boot:spring-boot-starter-data-jpa')
 	compile('org.springframework.boot:spring-boot-starter-web')
 	compile('org.springframework.boot:spring-boot-starter-mustache')
 	compile('com.fasterxml.jackson.module:jackson-module-kotlin')
-	compile("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
-	compile("org.jetbrains.kotlin:kotlin-reflect")
-	compile("com.atlassian.commonmark:commonmark:0.11.0")
-	compile("com.atlassian.commonmark:commonmark-ext-autolink:0.11.0")
-	runtime("com.h2database:h2")
-	kapt("org.springframework.boot:spring-boot-configuration-processor")
+	compile('org.jetbrains.kotlin:kotlin-stdlib-jdk8')
+	compile('org.jetbrains.kotlin:kotlin-reflect')
+	runtime('com.h2database:h2')
+	kapt('org.springframework.boot:spring-boot-configuration-processor')
 	testCompile('org.springframework.boot:spring-boot-starter-test') {
 		exclude module: 'junit'
+		exclude module: 'mockito-core'
 	}
-	testCompile("com.nhaarman:mockito-kotlin:1.5.0")
 	testImplementation('org.junit.jupiter:junit-jupiter-api')
+	testImplementation('com.ninja-squad:springmockk:1.1.0')
 	testRuntimeOnly('org.junit.jupiter:junit-jupiter-engine')
 }

Diff for: build.gradle

@@ -14,15 +14,15 @@
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>2.1.2.RELEASE</version>
+		<version>2.1.3.RELEASE</version>
 		<relativePath/> <!-- lookup parent from repository -->
 	</parent>
 
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 		<java.version>1.8</java.version>
-		<kotlin.version>1.2.41</kotlin.version>
+		<kotlin.version>1.2.71</kotlin.version>
 	</properties>
 
 	<dependencies>
@@ -50,16 +50,6 @@
 			<groupId>org.jetbrains.kotlin</groupId>
 			<artifactId>kotlin-reflect</artifactId>
 		</dependency>
-		<dependency>
-			<groupId>com.atlassian.commonmark</groupId>
-			<artifactId>commonmark</artifactId>
-			<version>0.11.0</version>
-		</dependency>
-		<dependency>
-			<groupId>com.atlassian.commonmark</groupId>
-			<artifactId>commonmark-ext-autolink</artifactId>
-			<version>0.11.0</version>
-		</dependency>
 		<dependency>
 			<groupId>com.h2database</groupId>
 			<artifactId>h2</artifactId>
@@ -72,8 +62,12 @@
 			<scope>test</scope>
 			<exclusions>
 				<exclusion>
-					<artifactId>junit</artifactId>
 					<groupId>junit</groupId>
+					<artifactId>junit</artifactId>
+				</exclusion>
+				<exclusion>
+					<groupId>org.mockito</groupId>
+					<artifactId>mockito-core</artifactId>
 				</exclusion>
 			</exclusions>
 		</dependency>
@@ -83,9 +77,9 @@
 			<scope>test</scope>
 		</dependency>
 		<dependency>
-			<groupId>com.nhaarman</groupId>
-			<artifactId>mockito-kotlin</artifactId>
-			<version>1.5.0</version>
+			<groupId>com.ninja-squad</groupId>
+			<artifactId>springmockk</artifactId>
+			<version>1.1.0</version>
 			<scope>test</scope>
 		</dependency>
 	</dependencies>
@@ -108,7 +102,11 @@
 					<compilerPlugins>
 						<plugin>spring</plugin>
 						<plugin>jpa</plugin>
+						<plugin>all-open</plugin>
 					</compilerPlugins>
+					<pluginOptions>
+						<option>all-open:annotation=javax.persistence.Entity</option>
+					</pluginOptions>
 				</configuration>
 				<dependencies>
 					<dependency>

Diff for: pom.xml

@@ -1,43 +1,12 @@
 package blog
 
-import com.samskivert.mustache.Mustache
-import org.springframework.boot.CommandLineRunner
 import org.springframework.boot.autoconfigure.SpringBootApplication
 import org.springframework.boot.context.properties.EnableConfigurationProperties
 import org.springframework.boot.runApplication
-import org.springframework.context.annotation.Bean
 
 @SpringBootApplication
 @EnableConfigurationProperties(BlogProperties::class)
-class BlogApplication {
-
-	@Bean
-	fun mustacheCompiler(loader: Mustache.TemplateLoader?) =
-			Mustache.compiler().escapeHTML(false).withLoader(loader)
-
-	@Bean
-	fun databaseInitializer(userRepository: UserRepository,
-							articleRepository: ArticleRepository) = CommandLineRunner {
-		val smaldini = User("smaldini", "Stéphane", "Maldini")
-		userRepository.save(smaldini)
-
-		articleRepository.save(Article(
-				"Reactor Bismuth is out",
-				"Lorem ipsum",
-				"dolor **sit** amet https://projectreactor.io/",
-				smaldini,
-				1
-		))
-		articleRepository.save(Article(
-				"Reactor Aluminium has landed",
-				"Lorem ipsum",
-				"dolor **sit** amet https://projectreactor.io/",
-				smaldini,
-				2
-		))
-	}
-
-}
+class BlogApplication
 
 fun main(args: Array<String>) {
 	runApplication<BlogApplication>(*args)

Diff for: src/main/kotlin/blog/BlogApplication.kt

@@ -0,0 +1,28 @@
+package blog
+
+import org.springframework.boot.ApplicationRunner
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+
+@Configuration
+class BlogConfiguration {
+
+    @Bean
+    fun databaseInitializer(userRepository: UserRepository,
+                            articleRepository: ArticleRepository) = ApplicationRunner {
+
+        val smaldini = userRepository.save(User("smaldini", "Stéphane", "Maldini"))
+        articleRepository.save(Article(
+                "Reactor Bismuth is out",
+                "Lorem ipsum",
+                "dolor sit amet",
+                smaldini
+        ))
+        articleRepository.save(Article(
+                "Reactor Aluminium has landed",
+                "Lorem ipsum",
+                "dolor sit amet",
+                smaldini
+        ))
+    }
+}

Diff for: src/main/kotlin/blog/BlogConfiguration.kt

@@ -0,0 +1,22 @@
+package blog
+
+import java.time.LocalDateTime
+import javax.persistence.*
+
+@Entity
+class Article(
+		var title: String,
+		var headline: String,
+		var content: String,
+		@ManyToOne var author: User,
+		var slug: String = title.toSlug(),
+		var addedAt: LocalDateTime = LocalDateTime.now(),
+		@Id @GeneratedValue var id: Long? = null)
+
+@Entity
+class User(
+		var login: String,
+		var firstname: String,
+		var lastname: String,
+		var description: String? = null,
+		@Id @GeneratedValue var id: Long? = null)

Diff for: src/main/kotlin/blog/Entities.kt

@@ -10,7 +10,7 @@ fun LocalDateTime.format() = this.format(englishDateFormatter)
 private val daysLookup = (1..31).associate { it.toLong() to getOrdinal(it) }
 
 private val englishDateFormatter = DateTimeFormatterBuilder()
-		.appendPattern("MMMM")
+		.appendPattern("yyyy-MM-dd")
 		.appendLiteral(" ")
 		.appendText(ChronoField.DAY_OF_MONTH, daysLookup)
 		.appendLiteral(" ")
@@ -24,3 +24,10 @@ private fun getOrdinal(n: Int) = when {
 	n % 10 == 3 -> "${n}rd"
 	else -> "${n}th"
 }
+
+fun String.toSlug() = toLowerCase()
+		.replace("\n", " ")
+		.replace("[^a-z\\d\\s]".toRegex(), " ")
+		.split(" ")
+		.joinToString("-")
+		.replace("-+".toRegex(), "-")

Diff for: src/main/kotlin/blog/Extensions.kt

@@ -8,7 +8,6 @@ import org.springframework.web.bind.annotation.PathVariable
 
 @Controller
 class HtmlController(private val repository: ArticleRepository,
-					 private val markdownConverter: MarkdownConverter,
 					 private val properties: BlogProperties) {
 
 	@GetMapping("/")
@@ -19,32 +18,32 @@ class HtmlController(private val repository: ArticleRepository,
 		return "blog"
 	}
 
-	@GetMapping("/article/{id}")
-	fun article(@PathVariable id: Long, model: Model): String {
+	@GetMapping("/article/{slug}")
+	fun article(@PathVariable slug: String, model: Model): String {
 		val article = repository
-				.findById(id)
-				.orElseThrow { IllegalArgumentException("Wrong article id provided") }
-				.render()
+				.findBySlug(slug)
+				?.render()
+				?: throw IllegalArgumentException("Wrong article slug provided")
 		model["title"] = article.title
 		model["article"] = article
 		return "article"
 	}
 
 	fun Article.render() = RenderedArticle(
+			slug,
 			title,
-			markdownConverter(headline),
-			markdownConverter(content),
+			headline,
+			content,
 			author,
-			id,
 			addedAt.format()
 	)
 
 	data class RenderedArticle(
+			val slug: String,
 			val title: String,
 			val headline: String,
 			val content: String,
 			val author: User,
-			val id: Long?,
 			val addedAt: String)
 
 }

Diff for: src/main/kotlin/blog/HtmlController.kt

@@ -0,0 +1,27 @@
+package blog
+
+import org.springframework.web.bind.annotation.*
+
+@RestController
+@RequestMapping("/api/article")
+class ArticleController(private val repository: ArticleRepository) {
+
+	@GetMapping("/")
+	fun findAll() = repository.findAllByOrderByAddedAtDesc()
+
+	@GetMapping("/{slug}")
+	fun findOne(@PathVariable slug: String) =
+			repository.findBySlug(slug) ?: throw IllegalArgumentException("Wrong article slug provided")
+
+}
+
+@RestController
+@RequestMapping("/api/user")
+class UserController(private val repository: UserRepository) {
+
+	@GetMapping("/")
+	fun findAll() = repository.findAll()
+
+	@GetMapping("/{login}")
+	fun findOne(@PathVariable login: String) = repository.findByLogin(login)
+}