Separate support for java.time types into new module

See #113
robfletcher · Oct 11, 2018 · 5a38aa7 · 5a38aa7
1 parent 9c982ca
commit 5a38aa7
Show file tree

Hide file tree

Showing 11 changed files with 63 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Any suggestions, [issue reports](https://github.com/robfletcher/strikt/issues),
 
 Strikt is available from JCenter.
 
-```groovy
+```kotlin
 repositories { 
   jcenter() 
 }
@@ -22,6 +22,24 @@ dependencies {
 
 See the button below for the current version number.
 
+## Additional Libraries
+
+Strikt has the following additional libraries:
+
+* `strikt-javatime` -- supports the JSR-310 `java.time` package.
+* `strikt-protobuf` -- supports Protobuf / gRPC.
+
+Versions are synchronized with the core Strikt library.
+
+To install additional libraries include dependencies in your Gradle build.
+For example:
+
+```kotlin
+dependencies {
+  testImplementation("time")
+}
+```
+
 ## Using Strikt
 
 Please see the [project documentation](https://strikt.io/) and [API docs](https://strikt.io/api/strikt-core).

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,5 +1,5 @@
 rootProject.name = "strikt"
 
-include("strikt-core", "strikt-protobuf", "site")
+include("strikt-core", "strikt-protobuf", "strikt-java-time", "site")
 
 enableFeaturePreview("STABLE_PUBLISHING")
diff --git a/site/build.gradle.kts b/site/build.gradle.kts
@@ -2,6 +2,7 @@ import org.ajoberstar.gradle.git.ghpages.GithubPagesPluginExtension.DestinationC
 import org.apache.tools.ant.filters.ConcatFilter
 import org.apache.tools.ant.filters.ReplaceTokens
 import org.jbake.gradle.JBakeTask
+import org.jbake.gradle.JBakeServeTask
 
 plugins {
   id("org.ajoberstar.github-pages")
@@ -55,10 +56,14 @@ val copyApiDocs = task<Copy>("copyApiDocs") {
   }
 }
 
-tasks.withType<JBakeTask> {
+val bake by tasks.getting(JBakeTask::class) {
   dependsOn(copyApiDocs)
 }
 
+val bakePreview by tasks.getting(JBakeServeTask::class) {
+  dependsOn(bake)
+}
+
 tasks.getByName("clean").doFirst {
   delete("$projectDir/src/jbake/content/api/")
 }

diff --git a/site/src/jbake/assets/css/prism.css b/site/src/jbake/assets/css/prism.css
@@ -1,5 +1,5 @@
 /* PrismJS 1.15.0
-https://prismjs.com/download.html#themes=prism-tomorrow&languages=clike+groovy+kotlin */
+https://prismjs.com/download.html#themes=prism-tomorrow&languages=clike+kotlin */
 /**
  * prism.js tomorrow night eighties for JavaScript, CoffeeScript, CSS and HTML
  * Based on https://github.com/chriskempson/tomorrow-theme

diff --git a/site/src/jbake/assets/js/prism.js b/site/src/jbake/assets/js/prism.js
diff --git a/site/src/jbake/content/user-guide/additional-modules.md b/site/src/jbake/content/user-guide/additional-modules.md
@@ -9,13 +9,24 @@ previousPage=custom-assertions.html
 
 In addition to the core functionality provided by the `strikt-core` module, Strikt has the following optional modules:
 
+## Java Time
+
+Extensions for assertions and traversals on types from the `java.time` package.
+See the [API docs](/api/strikt-java-time/).
+
+Add the following to your dependencies:
+
+```kotlin
+testCompile("io.strikt:strikt-java-time:@version@")
+``` 
+
 ## Protobuf
 
 Extensions for testing code that uses Protobuf / gRPC.
 See the [API docs](/api/strikt-protobuf/).
 
 Add the following to your dependencies:
 
-```groovy
-testCompile "io.strikt:strikt-protobuf:@version@"
+```kotlin
+testCompile("io.strikt:strikt-protobuf:@version@")
 ``` 
diff --git a/site/src/jbake/content/user-guide/getting-started.md b/site/src/jbake/content/user-guide/getting-started.md
@@ -15,13 +15,13 @@ It can be used with JUnit, Spek or any other runner that supports tests written
 Strikt is available from JCenter.
 Add the following to your `build.gradle`.
 
-```groovy
+```kotlin
 repositories {
   jcenter()
 }
 
 dependencies {
-  testCompile "io.strikt:strikt-core:@version@"
+  testCompile("io.strikt:strikt-core:@version@")
 }
 ```
 

diff --git a/site/src/jbake/templates/navbar.ftl b/site/src/jbake/templates/navbar.ftl
@@ -48,6 +48,8 @@
             class="fas fa-book"></i></span><span>API</span></a>
           <div class="navbar-dropdown is-right">
             <a class="navbar-item" href="/api/strikt-core">strikt-core</a>
+            <a class="navbar-item"
+               href="/api/strikt-java-time">strikt-java-time</a>
             <a class="navbar-item" href="/api/strikt-protobuf">strikt-protobuf</a>
           </div>
         </div>

diff --git a/strikt-java-time/build.gradle.kts b/strikt-java-time/build.gradle.kts
@@ -0,0 +1,10 @@
+plugins {
+  id("java-library")
+  id("nebula.kotlin")
+  id("published")
+  id("info.solidsoft.pitest")
+}
+
+dependencies {
+  api(project(":strikt-core"))
+}
diff --git a/...lin/strikt/assertions/TemporalAccessor.kt → ...in/kotlin/strikt/time/TemporalAccessor.kt b/...lin/strikt/assertions/TemporalAccessor.kt → ...in/kotlin/strikt/time/TemporalAccessor.kt
@@ -1,4 +1,4 @@
-package strikt.assertions
+package strikt.time
 
 import strikt.api.Assertion
 import java.time.Instant
@@ -62,7 +62,7 @@ fun <T : TemporalAccessor> Assertion.Builder<T>.isAfter(expected: TemporalAccess
  * @see TemporalAccessor.get
  */
 fun <T : TemporalAccessor> Assertion.Builder<T>.get(field: TemporalField): Assertion.Builder<Int> =
-  get(field.toString()) { this.get(field) }
+  get(field.toString()) { get(field) }
 
 /**
  * Maps an assertion on the subject to an assertion on the value of the
@@ -74,4 +74,4 @@ fun <T : TemporalAccessor> Assertion.Builder<T>.get(field: TemporalField): Asser
  * @see TemporalAccessor.getLong
  */
 fun <T : TemporalAccessor> Assertion.Builder<T>.getLong(field: TemporalField): Assertion.Builder<Long> =
-  get(field.toString()) { this.getLong(field) }
+  get(field.toString()) { getLong(field) }
diff --git a/...n/strikt/assertions/TemporalAssertions.kt → .../kotlin/strikt/time/TemporalAssertions.kt b/...n/strikt/assertions/TemporalAssertions.kt → .../kotlin/strikt/time/TemporalAssertions.kt
@@ -1,13 +1,14 @@
-package strikt.assertions
+package strikt.time
 
 import org.junit.jupiter.api.DisplayName
 import org.junit.jupiter.api.DynamicTest
 import org.junit.jupiter.api.DynamicTest.dynamicTest
 import org.junit.jupiter.api.Nested
 import org.junit.jupiter.api.TestFactory
 import org.junit.jupiter.api.assertThrows
+import org.opentest4j.AssertionFailedError
 import strikt.api.expectThat
-import strikt.fails
+import strikt.assertions.isEqualTo
 import java.time.DateTimeException
 import java.time.Instant
 import java.time.LocalDate
@@ -95,7 +96,7 @@ internal class TemporalAssertions {
         Pair(YearMonth.from(today), today.minusMonths(1))
       ).map { (subject, expected) ->
         dynamicTest("fails asserting $subject (${subject.javaClass.simpleName}) is before $expected (${expected.javaClass.simpleName})") {
-          fails {
+          assertThrows<AssertionFailedError> {
             expectThat(subject).isBefore(expected)
           }
         }
@@ -173,7 +174,7 @@ internal class TemporalAssertions {
         Pair(YearMonth.from(today), today.plusMonths(1))
       ).map { (subject, expected) ->
         dynamicTest("fails asserting $subject (${subject.javaClass.simpleName}) is before $expected (${expected.javaClass.simpleName})") {
-          fails {
+          assertThrows<AssertionFailedError> {
             expectThat(subject).isAfter(expected)
           }
         }