configure base package name (for additional files) and location-based package name (#115)

Author: hauner

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

@@ -7,6 +7,7 @@ package io.openapiprocessor.core.converter
 
 import io.openapiprocessor.core.converter.mapping.*
 import io.openapiprocessor.core.converter.options.BasePathOptions
+import io.openapiprocessor.core.converter.options.PackageOptions
 import io.openapiprocessor.core.converter.options.TargetDirOptions
 import io.openapiprocessor.core.support.Empty
 
@@ -34,8 +35,15 @@ class ApiOptions: MappingSettings {
      * - models => "${packageName}.model"
      */
     var packageName = "io.openapiprocessor.generated"
-    var packageNameFromPath = false
 
+    /**
+     * package-name related options
+     */
+    var packageOptions: PackageOptions = PackageOptions()
+
+    val packageNameFromLocation get() = packageOptions.fromLocation
+
+    // todo move to packageOptions
     var packageNameApi : String = "api"
     var packageNameModel: String = "model"
     var packageNameSupport: String = "support"

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

@@ -65,7 +65,19 @@ class OptionsConverter(private val checkObsoleteProcessorOptions: Boolean = fals
                     }
 
                     options.packageName = mapping.options.packageName
-                    options.packageNameFromPath = mapping.options.packageNameFromPath
+                    with(mapping.options.packageNames) {
+                        options.packageOptions.base = base
+                        options.packageOptions.location = location
+
+                        // sync base package name
+                        if (options.packageOptions.base != null) {
+                            options.packageName = options.packageOptions.base!!
+                        }
+                        else {
+                            options.packageOptions.base = mapping.options.packageName
+                        }
+                    }
+
                     options.modelType = mapping.options.modelType
                     options.modelAccessors = mapping.options.modelAccessors
                     options.enumType = mapping.options.enumType

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

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2024 https://github.com/openapi-processor/openapi-processor-base
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.converter.options
+
+class PackageOptions {
+    /**
+     * Java base package name of the generated source files. Sames 'package-name'.
+     */
+    var base: String? = null
+
+    /**
+     * Java base package name of location-based generated source files
+     */
+    var location: String? = null
+
+    val fromLocation: Boolean
+        get() = location != null
+}

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/Options.kt

@@ -22,10 +22,7 @@ data class Options(
      */
     val packageName: String = "io.openapiprocessor.generated",
 
-    /**
-     * enable/disable location based package names (optional)
-     */
-    val packageNameFromPath: Boolean = false,
+    val packageNames: PackageNames = PackageNames(),
 
     /**
      * enable/disable clearing of targetDir (optional).

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/PackageNames.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2025 https://github.com/openapi-processor/openapi-processor-base
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.processor.mapping.v2
+
+/**
+ * package-name options
+ */
+data class PackageNames(
+    /**
+     * Java base package name of the generated source files. Sames 'package-name'.
+     */
+    val base: String? = null,
+
+    /**
+     * Java base package name of location-based generated source files
+     */
+    val location: String? = null
+)
+
+

openapi-processor-core/src/main/resources/mapping/v13/mapping.example.yaml

@@ -10,8 +10,13 @@ options: # general processor options (required)
   # the target package (required): io.openapiprocessor.generated (default)
   package-name: io.openapiprocessor.generated
 
-  # derive the package name from the document location (optional): true or false (default)
-  package-name-from-path: true
+  # package-name related options
+  package-names:
+    # same as package-name
+    base: io.openapiprocessor.generated
+
+    # base package name of location-based generated files
+    location: io.openapiprocessor
 
   # enable validation annotations (optional): true or false (default), javax, jakarta
   bean-validation: jakarta

openapi-processor-core/src/main/resources/mapping/v13/mapping.yaml.json

@@ -32,14 +32,25 @@
       "type": "object",
       "properties": {
         "package-name": {
-          "description": "java root package name to use in the generated source files.",
+          "description": "java base package name of the generated source files.",
           "type": "string",
           "default": "io.openapiprocessor.generated"
         },
-        "package-name-from-path": {
-          "description": "derive the package name from the document location.",
-          "type": "boolean",
-          "default": false
+        "package-names": {
+          "description": "package name related options",
+          "type": "object",
+          "properties": {
+            "base": {
+              "description": "java base package name of the generated source files. Alternative to 'package-name'.",
+              "type": "string",
+              "default": "io.openapiprocessor.generated"
+            },
+            "location": {
+              "description": "java base package name of location based generated source files.",
+              "type": "string",
+              "default": null
+            }
+          }
         },
         "bean-validation": {
           "description": "enable bean validation annotations for OpenAPI constraints.",

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/converter/OptionsConverterSpec.kt

@@ -28,7 +28,8 @@ class OptionsConverterSpec: StringSpec({
         options.targetDirOptions.layout shouldBe TargetDirLayout.CLASSIC
 
         options.packageName shouldBe "io.openapiprocessor.generated"
-        options.packageNameFromPath shouldBe false
+        options.packageOptions.base shouldBe null
+        options.packageOptions.location shouldBe null
         options.beanValidation shouldBe false
         options.javadoc shouldBe false
         options.modelType shouldBe "default"
@@ -104,12 +105,15 @@ class OptionsConverterSpec: StringSpec({
 
         val options = converter.convertOptions(mapOf(
             "mapping" to """
-                openapi-processor-mapping: v9
+                openapi-processor-mapping: v13
                 options:
                   clear-target-dir: false
                   target-dir:
                     layout: standard
                   package-name: generated
+                  package-names:
+                    location: production
+                  package-name-base: production
                   package-name-from-path: true
                   model-name-suffix: Suffix
                   model-type: record
@@ -132,7 +136,8 @@ class OptionsConverterSpec: StringSpec({
         options.targetDirOptions.clear.shouldBeFalse()
         options.targetDirOptions.layout.isStandard().shouldBeTrue()
         options.packageName shouldBe "generated"
-        options.packageNameFromPath shouldBe true
+        options.packageOptions.base shouldBe "generated"
+        options.packageOptions.location shouldBe "production"
         options.modelNameSuffix shouldBe "Suffix"
         options.modelType shouldBe "record"
         options.modelAccessors shouldBe false

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

@@ -241,7 +241,7 @@ class DefaultWriterFactorySpec : StringSpec({
         val writerFactory = object : DefaultWriterFactory(options) {
             override fun initAdditionalPackages(options: ApiOptions): Map<String, Path> {
                 val pkgPaths = HashMap<String, Path>()
-                val (name, path) = initTargetPackage("foo/bar")
+                val (name, path) = initTargetPackage("io.openapiprocessor.foo.bar")
                 pkgPaths[name] = path
                 return pkgPaths
             }
@@ -257,7 +257,6 @@ class DefaultWriterFactorySpec : StringSpec({
     "lazy initialize additional package folders" {
         options.targetDir = listOf(target.toString()).joinToString(File.separator)
         options.targetDirOptions.layout = TargetDirLayout.CLASSIC
-        options.packageNameFromPath = true
 
         val writerFactory = DefaultWriterFactory(options)
         writerFactory.init()