Merge pull request #22 from BGMSound/develop

[Refactor] Refactor document result validation structure

Author: BGMSound

documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/AbstractDocumentResult.kt

@@ -2,43 +2,58 @@ package io.github.bgmsound.documentify.core.emitter
 
 import io.github.bgmsound.documentify.core.specification.element.field.Field
 import io.github.bgmsound.documentify.core.specification.schema.response.ResponseSpec
+import org.hamcrest.Matcher
+import org.hamcrest.Matchers
 
 abstract class AbstractDocumentResult : DocumentResult {
-    abstract fun validateJsonPath(jsonResultMatcher: JsonResultMatcher)
+    abstract fun expect(jsonPath: String, matcher: Matcher<*>)
+
+    abstract fun expectValue(jsonPath: String, value: Any)
 
     override fun validateWith(responseSpec: ResponseSpec) {
         val matchers = aggregateMatchers(responseSpec.fields)
         if (matchers.isEmpty()) {
             return
         }
         matchers.forEach { matcher ->
-            validateJsonPath(matcher)
+            val jsonPath = matcher.jsonPath
+            val value = matcher.expectedValue
+            if (jsonPath.endsWith("[*]")) {
+                if (value !is List<*>) {
+                    throw IllegalArgumentException("sample value type must be List")
+                }
+                expect(jsonPath.substringBeforeLast("[*]"), Matchers.containsInAnyOrder(*value.toTypedArray()))
+            } else if (jsonPath.contains("[*]") && !jsonPath.endsWith("[*]")) {
+                expect(jsonPath, Matchers.hasItem(value))
+            } else {
+                expectValue(jsonPath, value)
+            }
         }
     }
 
-    private fun aggregateMatchers(fields: List<Field>): List<JsonResultMatcher> {
+    private fun aggregateMatchers(fields: List<Field>): List<ExpectedJsonValue> {
         return fields.filter {
             it.hasSample() || it.canHaveChild() || !it.isIgnored()
         }.flatMap {
             it.aggregateMatchers()
         }
     }
 
-    private fun Field.aggregateMatchers(): List<JsonResultMatcher> {
+    private fun Field.aggregateMatchers(): List<ExpectedJsonValue> {
         if (isIgnored()) {
             return emptyList()
         }
         if (!hasSample() && !canHaveChild()) {
             return emptyList()
         }
-        val matchers = mutableListOf<JsonResultMatcher>()
+        val matchers = mutableListOf<ExpectedJsonValue>()
         if (hasSample()) {
             val jsonPath = StringBuilder("$.${path}").apply {
                 if (isArray()) {
                     append("[*]")
                 }
             }.toString().replace("[]", "[*]")
-            matchers.add(JsonResultMatcher.of(jsonPath, sample))
+            matchers.add(ExpectedJsonValue.of(jsonPath, sample))
         } else if (childFields().isNotEmpty())  {
             val childMatchers = aggregateMatchers(childFields())
             matchers.addAll(childMatchers)

…entify/core/emitter/JsonResultMatcher.kt …entify/core/emitter/ExpectedJsonValue.ktdocumentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/JsonResultMatcher.kt renamed to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/ExpectedJsonValue.kt documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/JsonResultMatcher.kt renamed to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/ExpectedJsonValue.kt

@@ -1,10 +1,10 @@
 package io.github.bgmsound.documentify.core.emitter
 
-data class JsonResultMatcher(
+data class ExpectedJsonValue(
     val jsonPath: String,
     val expectedValue: Any
 ) {
     companion object {
-        fun of(path: String, expectedValue: Any) = JsonResultMatcher(path, expectedValue)
+        fun of(path: String, expectedValue: Any) = ExpectedJsonValue(path, expectedValue)
     }
 }

…ntify/core/specification/ResourceSpec.kt …ore/specification/schema/ResourceSpec.ktdocumentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/ResourceSpec.kt renamed to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/ResourceSpec.kt documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/ResourceSpec.kt renamed to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/ResourceSpec.kt

@@ -1,8 +1,9 @@
-package io.github.bgmsound.documentify.core.specification
+package io.github.bgmsound.documentify.core.specification.schema
 
 import com.epages.restdocs.apispec.ResourceDocumentation
 import com.epages.restdocs.apispec.ResourceSnippetParameters
 import com.epages.restdocs.apispec.Schema
+import io.github.bgmsound.documentify.core.specification.DocumentableSpec
 import io.github.bgmsound.documentify.core.specification.element.Link
 import io.github.bgmsound.documentify.core.specification.element.field.Field
 import io.github.bgmsound.documentify.core.specification.schema.request.RequestSpec
@@ -28,17 +29,17 @@ class ResourceSpec(
     }
 
     fun link(rel: String): Link {
-        val link = Link.newLink(rel)
+        val link = Link.Companion.newLink(rel)
         this.links.add(link)
         return link
     }
 
     fun links(vararg links: String) {
-        this.links.addAll(links.map { Link.newLink(it) })
+        this.links.addAll(links.map { Link.Companion.newLink(it) })
     }
 
     fun links(links: Collection<String>) {
-        this.links.addAll(links.map { Link.newLink(it) })
+        this.links.addAll(links.map { Link.Companion.newLink(it) })
     }
 
     fun tag(tag: String) {
@@ -70,7 +71,7 @@ class ResourceSpec(
     }
 
     override fun build(): List<Snippet> {
-        val resourceBuilder = ResourceSnippetParameters.builder()
+        val resourceBuilder = ResourceSnippetParameters.Companion.builder()
         if (tags.isNotEmpty()) {
             resourceBuilder.tags(*tags.toTypedArray())
         }
@@ -93,13 +94,13 @@ class ResourceSpec(
         }
         if (request.fields.isNotEmpty()) {
             if (request.schema != null) {
-                resourceBuilder.requestSchema(Schema.schema(request.schema!!))
+                resourceBuilder.requestSchema(Schema.Companion.schema(request.schema!!))
             }
             resourceBuilder.requestFields(buildFields(request.fields))
         }
         if (response.fields.isNotEmpty()) {
             if (response.schema != null) {
-                resourceBuilder.responseSchema(Schema.schema(response.schema!!))
+                resourceBuilder.responseSchema(Schema.Companion.schema(response.schema!!))
             }
             resourceBuilder.responseFields(buildFields(response.fields))
         }

documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/specification/schema/document/DocumentSpec.kt

@@ -1,7 +1,7 @@
 package io.github.bgmsound.documentify.core.specification.schema.document
 
 import io.github.bgmsound.documentify.core.specification.DocumentableSpec
-import io.github.bgmsound.documentify.core.specification.ResourceSpec
+import io.github.bgmsound.documentify.core.specification.schema.ResourceSpec
 import io.github.bgmsound.documentify.core.specification.schema.Method
 import io.github.bgmsound.documentify.core.specification.schema.request.RequestBodySpec
 import io.github.bgmsound.documentify.core.specification.schema.request.RequestHeaderSpec

documentify-project/documentify-mvc/src/main/kotlin/io/github/bgmsound/documentify/mvc/emitter/MvcDocumentResult.kt

@@ -1,29 +1,20 @@
 package io.github.bgmsound.documentify.mvc.emitter
 
 import io.github.bgmsound.documentify.core.emitter.AbstractDocumentResult
-import io.github.bgmsound.documentify.core.emitter.JsonResultMatcher
 import io.github.bgmsound.documentify.core.specification.schema.response.ResponseSpec
 import io.github.bgmsound.documentify.mvc.ValidatableMockResponse
-import org.hamcrest.Matchers
+import org.hamcrest.Matcher
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath
 
 class MvcDocumentResult(
     private val actualResponse: ValidatableMockResponse
 ) : AbstractDocumentResult() {
-    override fun validateJsonPath(jsonResultMatcher: JsonResultMatcher) {
-        val jsonPath = jsonResultMatcher.jsonPath
-        val value = jsonResultMatcher.expectedValue
+    override fun expect(jsonPath: String, matcher: Matcher<*>) {
+        actualResponse.expect(jsonPath(jsonPath).value(matcher))
+    }
 
-        if (jsonPath.endsWith("[*]")) {
-            if (value !is List<*>) {
-                throw IllegalArgumentException("sample value type must be List")
-            }
-            actualResponse.expect(jsonPath(jsonPath.substringBeforeLast("[*]")).value(Matchers.containsInAnyOrder(*value.toTypedArray())))
-        } else if (jsonPath.contains("[*]") && !jsonPath.endsWith("[*]")) {
-            actualResponse.expect(jsonPath(jsonPath).value(Matchers.hasItem(value)))
-        } else {
-            actualResponse.expect(jsonPath(jsonPath).value(value))
-        }
+    override fun expectValue(jsonPath: String, value: Any) {
+        actualResponse.expect(jsonPath(jsonPath).value(value))
     }
 
     companion object {

documentify-project/documentify-reactive/src/main/kotlin/io/github/bgmsound/documentify/reactive/emitter/ReactiveDocumentResult.kt

@@ -1,28 +1,20 @@
 package io.github.bgmsound.documentify.reactive.emitter
 
 import io.github.bgmsound.documentify.core.emitter.AbstractDocumentResult
-import io.github.bgmsound.documentify.core.emitter.JsonResultMatcher
 import io.github.bgmsound.documentify.core.specification.schema.response.ResponseSpec
+import org.hamcrest.Matcher
 import org.hamcrest.Matchers
 import org.springframework.test.web.reactive.server.WebTestClient
 
 class ReactiveDocumentResult(
     private val actualResponse: WebTestClient.BodyContentSpec
 ) : AbstractDocumentResult() {
-    override fun validateJsonPath(jsonResultMatcher: JsonResultMatcher) {
-        val jsonPath = jsonResultMatcher.jsonPath
-        val value = jsonResultMatcher.expectedValue
+    override fun expect(jsonPath: String, matcher: Matcher<*>) {
+        actualResponse.jsonPath(jsonPath).value(matcher)
+    }
 
-        if (jsonPath.endsWith("[*]")) {
-            if (value !is List<*>) {
-                throw IllegalArgumentException("sample value type must be List")
-            }
-            actualResponse.jsonPath(jsonPath.substringBeforeLast("[*]")).value(Matchers.containsInAnyOrder(*value.toTypedArray()))
-        } else if (jsonPath.contains("[*]") && !jsonPath.endsWith("[*]")) {
-            actualResponse.jsonPath(jsonPath).value(Matchers.hasItem(value))
-        } else {
-            actualResponse.jsonPath(jsonPath).value(Matchers.equalToObject(value))
-        }
+    override fun expectValue(jsonPath: String, value: Any) {
+        actualResponse.jsonPath(jsonPath).value(Matchers.equalToObject(value))
     }
 
     companion object {

…fy/sample/mvc/ComplexSampleController.kt …vc/controller/ComplexSampleController.ktdocumentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/ComplexSampleController.kt renamed to documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/controller/ComplexSampleController.kt documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/ComplexSampleController.kt renamed to documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/controller/ComplexSampleController.kt

@@ -1,4 +1,4 @@
-package io.github.bgmsound.documentify.sample.mvc
+package io.github.bgmsound.documentify.sample.mvc.controller
 
 import io.github.bgmsound.documentify.sample.mvc.dto.response.ComplexSampleResponse
 import io.github.bgmsound.documentify.sample.mvc.dto.response.NestedSampleResponse

…ocumentify/sample/mvc/ErrorController.kt …sample/mvc/controller/ErrorController.ktdocumentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/ErrorController.kt renamed to documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/controller/ErrorController.kt documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/ErrorController.kt renamed to documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/controller/ErrorController.kt

@@ -1,4 +1,4 @@
-package io.github.bgmsound.documentify.sample.mvc
+package io.github.bgmsound.documentify.sample.mvc.controller
 
 import io.github.bgmsound.documentify.sample.mvc.dto.response.SampleResponse
 import org.springframework.http.ResponseEntity

…ify/sample/mvc/NestedSampleController.kt …mvc/controller/NestedSampleController.ktdocumentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/NestedSampleController.kt renamed to documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/controller/NestedSampleController.kt documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/NestedSampleController.kt renamed to documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/controller/NestedSampleController.kt

@@ -1,4 +1,4 @@
-package io.github.bgmsound.documentify.sample.mvc
+package io.github.bgmsound.documentify.sample.mvc.controller
 
 import io.github.bgmsound.documentify.sample.mvc.dto.request.NestedSampleRequest
 import io.github.bgmsound.documentify.sample.mvc.dto.response.NestedSampleResponse

…cumentify/sample/mvc/SampleController.kt …ample/mvc/controller/SampleController.ktdocumentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/SampleController.kt renamed to documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/controller/SampleController.kt documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/SampleController.kt renamed to documentify-sample/mvc-sample/src/main/kotlin/io/github/bgmsound/documentify/sample/mvc/controller/SampleController.kt

@@ -1,4 +1,4 @@
-package io.github.bgmsound.documentify.sample.mvc
+package io.github.bgmsound.documentify.sample.mvc.controller
 
 import io.github.bgmsound.documentify.sample.mvc.dto.request.SampleRequest
 import io.github.bgmsound.documentify.sample.mvc.dto.response.SampleResponse