Merge pull request #26 from BGMSound/develop

[Refactor] Unify default emitter to WebTestClient and upgrade to Java 21

Author: BGMSound

.github/workflows/deploy-to-mavencentral.yaml

@@ -16,11 +16,11 @@ jobs:
     steps:
       - name: GitHub 리포지토리 체크아웃
         uses: actions/checkout@v6
-      - name: JDK 17 설치
+      - name: JDK 21 설치
         uses: actions/setup-java@v5
         with:
           distribution: 'adopt'
-          java-version: '17'
+          java-version: '21'
       - name: Gradle 애드온 준비하기
         uses: gradle/gradle-build-action@v3
       - name: 프로젝트 빌드

.github/workflows/pull-request-coverage-report.yaml

@@ -16,11 +16,11 @@ jobs:
     steps:
       - name: GitHub 리포지토리 체크아웃
         uses: actions/checkout@v6
-      - name: JDK 17 설치
+      - name: JDK 21 설치
         uses: actions/setup-java@v5
         with:
           distribution: 'adopt'
-          java-version: '17'
+          java-version: '21'
       - name: Gradle 애드온 준비하기
         uses: gradle/gradle-build-action@v3
       - name: 커버리지 측정 및 리포트 생성

README.md

@@ -8,6 +8,16 @@ It combines the advantages of both Swagger and RestDocs for efficient and intuit
 
 ## Installation and Getting Started
 ### Installation
+
+This library requires `spring-restdocs-webtestclient` to be declared explicitly
+in your project, as it is no longer transitively provided.
+
+```kotlin
+dependencies {
+    testImplementation("org.springframework.restdocs:spring-restdocs-webtestclient")
+}
+```
+
 Add the following dependency to your `build.gradle.kts` file:
 <br><br>
 `MVC`
@@ -92,7 +102,7 @@ fun documentationGetApi() {
         responseBody {
             field("testField", "test", "test")
         }
-    }.expect(jsonPath("$testField").value("test"))
+    }.jsonPath("$testField").value("test")
 }
 ```
 

build.gradle.kts

@@ -42,13 +42,13 @@ subprojects {
     }
     tasks {
         java {
-            sourceCompatibility = JavaVersion.VERSION_17
-            targetCompatibility = JavaVersion.VERSION_17
+            sourceCompatibility = JavaVersion.VERSION_21
+            targetCompatibility = JavaVersion.VERSION_21
         }
         withType<KotlinCompile> {
             compilerOptions {
                 freeCompilerArgs.add("-Xjsr305=strict")
-                jvmTarget.set(JvmTarget.JVM_17)
+                jvmTarget.set(JvmTarget.JVM_21)
             }
         }
         test {

documentify-project/documentify-core/build.gradle.kts

@@ -1,9 +1,8 @@
 dependencies {
-    implementation(libs.spring.boot.starter.test)
     implementation(libs.restdocs.api.spec)
     implementation(libs.jackson.databind)
     implementation(libs.jackson.datatype.jsr310)
-    compileOnly(libs.spring.restdocs.mockmvc)
+    compileOnly(libs.spring.boot.starter.test)
+    compileOnly(libs.spring.restdocs.webtestclient)
     compileOnly(libs.spring.boot.starter.web)
-    compileOnly(libs.spring.boot.starter.webflux)
 }

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

@@ -0,0 +1,58 @@
+package io.github.bgmsound.documentify.core
+
+import io.github.bgmsound.documentify.core.emitter.DocumentEmitter
+import io.github.bgmsound.documentify.core.emitter.EmitterFactory
+import io.github.bgmsound.documentify.core.environment.ApplicationContextEnvironment.Companion.applicationContextEnvironment
+import io.github.bgmsound.documentify.core.environment.DocumentContextEnvironment
+import io.github.bgmsound.documentify.core.environment.WebTestClientContextEnvironment.Companion.webTestClientEnvironment
+import io.github.bgmsound.documentify.core.specification.schema.document.DocumentSpec
+import org.springframework.context.ApplicationContext
+import org.springframework.restdocs.RestDocumentationContextProvider
+import org.springframework.test.web.reactive.server.WebTestClient
+import org.springframework.web.context.WebApplicationContext
+
+abstract class AbstractDocumentify {
+    protected lateinit var provider: RestDocumentationContextProvider
+    protected lateinit var environment: DocumentContextEnvironment
+    protected var customEmitter: DocumentEmitter? = null
+
+    fun documentation(
+        name: String,
+        specCustomizer: DocumentSpec.() -> Unit
+    ): WebTestClient.BodyContentSpec {
+        val documentSpec = DocumentSpec(name).also { specCustomizer(it) }
+        val emitter = customEmitter ?: EmitterFactory.of(provider, documentSpec, environment)
+
+        return emitter.emit()
+    }
+
+    fun emitter(
+        customEmitter: DocumentEmitter
+    ) {
+        this.customEmitter = customEmitter
+    }
+
+    fun webTestClient(
+        provider: RestDocumentationContextProvider,
+        webTestClient: WebTestClient
+    ) {
+        this.provider = provider
+        environment = webTestClientEnvironment(provider, webTestClient)
+    }
+
+    fun applicationContext(
+        provider: RestDocumentationContextProvider,
+        applicationContext: ApplicationContext
+    ) {
+        this.provider = provider
+        environment = applicationContextEnvironment(provider, applicationContext)
+    }
+
+    fun webApplicationContext(
+        provider: RestDocumentationContextProvider,
+        context: WebApplicationContext
+    ) {
+        environment = applicationContextEnvironment(provider, context)
+        this.provider = provider
+    }
+}

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

@@ -3,10 +3,12 @@ package io.github.bgmsound.documentify.core.emitter
 import com.epages.restdocs.apispec.ResourceDocumentation
 import com.epages.restdocs.apispec.ResourceSnippetParameters
 import com.epages.restdocs.apispec.Schema
+import io.github.bgmsound.documentify.core.emitter.WebTestClientDocumentResult.Companion.validateWith
 import io.github.bgmsound.documentify.core.specification.schema.document.DocumentSpec
 import io.github.bgmsound.documentify.core.specification.schema.response.ResponseSpec
 import org.springframework.restdocs.RestDocumentationContextProvider
 import org.springframework.restdocs.snippet.Snippet
+import org.springframework.test.web.reactive.server.WebTestClient.BodyContentSpec
 
 abstract class AbstractDocumentEmitter(
     protected val provider: RestDocumentationContextProvider,
@@ -27,4 +29,16 @@ abstract class AbstractDocumentEmitter(
         }
         return ResourceDocumentation.resource(resourceBuilder.build())
     }
+
+    override fun emit(): BodyContentSpec {
+        val validatableDocumentResponse = emitDocument()
+        emitAlternativeResponseDocument()
+        validatableDocumentResponse.validateWith(documentSpec.response)
+
+        return validatableDocumentResponse
+    }
+
+    abstract fun emitDocument(): BodyContentSpec
+
+    abstract fun emitAlternativeResponseDocument()
 }

…ernativeMvcResponseDocumentController.kt …AlternativeResponseDocumentController.ktdocumentify-project/documentify-mvc/src/main/kotlin/io/github/bgmsound/documentify/mvc/emitter/AlternativeMvcResponseDocumentController.kt renamed to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/AlternativeResponseDocumentController.kt documentify-project/documentify-mvc/src/main/kotlin/io/github/bgmsound/documentify/mvc/emitter/AlternativeMvcResponseDocumentController.kt renamed to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/AlternativeResponseDocumentController.kt

@@ -1,11 +1,17 @@
-package io.github.bgmsound.documentify.mvc.emitter
+package io.github.bgmsound.documentify.core.emitter
 
 import org.springframework.http.ResponseEntity
-import org.springframework.web.bind.annotation.*
+import org.springframework.web.bind.annotation.DeleteMapping
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PatchMapping
+import org.springframework.web.bind.annotation.PostMapping
+import org.springframework.web.bind.annotation.PutMapping
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
 
 @RestController
 @RequestMapping("/**")
-class AlternativeMvcResponseDocumentController private constructor(
+class AlternativeResponseDocumentController private constructor(
     status: Int,
     response: Any
 ) {
@@ -40,8 +46,8 @@ class AlternativeMvcResponseDocumentController private constructor(
         fun new(
             status: Int,
             response: Any
-        ): AlternativeMvcResponseDocumentController {
-            return AlternativeMvcResponseDocumentController(status, response)
+        ): AlternativeResponseDocumentController {
+            return AlternativeResponseDocumentController(status, response)
         }
     }
 }

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

@@ -1,3 +1,9 @@
 package io.github.bgmsound.documentify.core.emitter
 
-interface DocumentEmitter
+import org.springframework.test.web.reactive.server.WebTestClient.BodyContentSpec
+
+interface DocumentEmitter {
+
+    fun emit(): BodyContentSpec
+
+}

…ntify/reactive/emitter/EmitterFactory.kt …cumentify/core/emitter/EmitterFactory.ktdocumentify-project/documentify-reactive/src/main/kotlin/io/github/bgmsound/documentify/reactive/emitter/EmitterFactory.kt renamed to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/EmitterFactory.kt documentify-project/documentify-reactive/src/main/kotlin/io/github/bgmsound/documentify/reactive/emitter/EmitterFactory.kt renamed to documentify-project/documentify-core/src/main/kotlin/io/github/bgmsound/documentify/core/emitter/EmitterFactory.kt

@@ -1,15 +1,15 @@
-package io.github.bgmsound.documentify.reactive.emitter
+package io.github.bgmsound.documentify.core.emitter
 
+import io.github.bgmsound.documentify.core.environment.DocumentContextEnvironment
 import io.github.bgmsound.documentify.core.specification.schema.document.DocumentSpec
-import io.github.bgmsound.documentify.reactive.ReactiveDocumentContextEnvironment
 import org.springframework.restdocs.RestDocumentationContextProvider
 
 object EmitterFactory {
     fun of(
         provider: RestDocumentationContextProvider,
         documentSpec: DocumentSpec,
-        environment: ReactiveDocumentContextEnvironment
-    ): ReactiveDocumentEmitter {
-        return WebTestClientReactiveDocumentEmitter(provider, documentSpec, environment)
+        environment: DocumentContextEnvironment
+    ): DocumentEmitter {
+        return WebTestClientDocumentEmitter(provider, documentSpec, environment)
     }
 }