enable/disable @generated (openapi-processor/openapi-processor-spring#269)

Author: hauner

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt

@@ -77,6 +77,11 @@ class ApiOptions {
      */
     var formatCode = false
 
+    /**
+     *  enable/disable the @Generated annotation (optional).
+     */
+    var generatedAnnotation = true
+
     /**
      *  enable/disable the @Generated date (optional).
      */

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/GeneratedWriterImpl.kt

@@ -13,15 +13,27 @@ class GeneratedWriterImpl(private val info: GeneratedInfo, private val options:
     : GeneratedWriter {
 
     override fun getImports(): Set<String> {
+        if (!options.generatedAnnotation) {
+            return emptySet()
+        }
+
         return setOf("${options.packageName}.support.Generated")
     }
 
     override fun writeUse(target: Writer) {
+        if (!options.generatedAnnotation) {
+            return
+        }
+
         target.write(create())
         target.write("\n")
     }
 
     override fun writeSource(target: Writer) {
+        if (!options.generatedAnnotation) {
+            return
+        }
+
         target.write("""
             package ${options.packageName}.support;
 

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/GeneratedWriterSpec.kt

@@ -6,11 +6,52 @@
 package io.openapiprocessor.core.writer.java
 
 import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.collections.shouldBeEmpty
+import io.kotest.matchers.collections.shouldNotBeEmpty
+import io.kotest.matchers.string.shouldBeEmpty
+import io.kotest.matchers.string.shouldContain
+import io.openapiprocessor.core.converter.ApiOptions
+import java.io.StringWriter
 
 class GeneratedWriterSpec: StringSpec({
 
-    "x" {
+    "writes @Generated if enabled" {
+        val info = GeneratedInfo("openapi-processor-core", "test")
+        val options = ApiOptions()
+        options.generatedAnnotation = true
 
+        val generated = GeneratedWriterImpl(info, options)
+
+        val imports = generated.getImports()
+
+        val usage = StringWriter()
+        generated.writeUse(usage)
+
+        val source = StringWriter()
+        generated.writeSource(source)
+
+        imports.shouldNotBeEmpty()
+        usage.toString() shouldContain "@Generated"
+        source.toString() shouldContain "public @interface Generated"
     }
 
+    "does not write @Generated if disabled" {
+        val info = GeneratedInfo("openapi-processor-core", "test")
+        val options = ApiOptions()
+        options.generatedAnnotation = false
+
+        val generated = GeneratedWriterImpl(info, options)
+
+        val imports = generated.getImports()
+
+        val usage = StringWriter()
+        generated.writeUse(usage)
+
+        val source = StringWriter()
+        generated.writeSource(source)
+
+        imports.shouldBeEmpty()
+        usage.toString().shouldBeEmpty()
+        source.toString().shouldBeEmpty()
+    }
 })