refactor(model-api-gen): extract FileGenerator

Author: mhuster23

model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/internal/ConceptFileGenerator.kt

@@ -36,34 +36,34 @@ import java.nio.file.Path
 
 internal class ConceptFileGenerator(
     private val concept: ProcessedConcept,
-    private val outputDir: Path,
+    override val outputDir: Path,
     override val nameConfig: NameConfig,
-    private val conceptPropertiesInferfaceName: String?,
+    private val conceptPropertiesInterfaceName: String?,
     private val alwaysUseNonNullableProperties: Boolean,
-) : NameConfigBasedGenerator(nameConfig) {
+) : NameConfigBasedGenerator(nameConfig), FileGenerator {
 
-    fun generateFile() {
+    override fun generateFileSpec(): FileSpec {
         val conceptObject = ConceptObjectGenerator(concept, nameConfig).generate()
         val conceptWrapperInterface = ConceptWrapperInterfaceGenerator(
             concept,
             nameConfig,
-            conceptPropertiesInferfaceName,
+            conceptPropertiesInterfaceName,
             alwaysUseNonNullableProperties,
         ).generate()
         val nodeWrapperInterface = NodeWrapperInterfaceGenerator(concept, nameConfig, alwaysUseNonNullableProperties).generate()
         val nodeWrapperImpl = NodeWrapperImplGenerator(concept, nameConfig, alwaysUseNonNullableProperties).generate()
 
         val typeAliasSpec = TypeAliasSpec.builder(concept.conceptTypeAliasName(), concept.conceptWrapperInterfaceType()).build()
 
-        FileSpec.builder(concept.language.name, concept.name).runBuild {
+        return FileSpec.builder(concept.language.name, concept.name).runBuild {
             addFileComment(MetaModelGenerator.HEADER_COMMENT)
             addType(conceptObject)
             addTypeAlias(typeAliasSpec)
             addType(conceptWrapperInterface)
             addType(nodeWrapperInterface)
             addType(nodeWrapperImpl)
             addConceptFeatureShortcuts()
-        }.writeTo(outputDir)
+        }
     }
 
     private fun FileSpec.Builder.addConceptFeatureShortcuts() {

model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/internal/EnumFileGenerator.kt

@@ -32,15 +32,14 @@ import org.modelix.metamodel.generator.addDeprecationIfNecessary
 import org.modelix.metamodel.generator.runBuild
 import java.nio.file.Path
 
-internal class EnumFileGenerator(private val enum: ProcessedEnum, private val outputDir: Path) {
+internal class EnumFileGenerator(
+    private val enum: ProcessedEnum,
+    override val outputDir: Path,
+) : FileGenerator {
 
     private val enumType = ClassName(enum.language.name, enum.name)
 
-    fun generateFile() {
-        buildEnumFileSpec().writeTo(outputDir)
-    }
-
-    private fun buildEnumFileSpec(): FileSpec {
+    override fun generateFileSpec(): FileSpec {
         val generatedEnum = TypeSpec.enumBuilder(enum.name).runBuild {
             addDeprecationIfNecessary(enum)
             addPrimaryConstructor()

model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/internal/FileGenerator.kt

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2024.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.modelix.metamodel.generator.internal
+
+import com.squareup.kotlinpoet.FileSpec
+import java.nio.file.Path
+
+internal interface FileGenerator {
+    val outputDir: Path
+
+    fun generateFile() {
+        generateFileSpec().writeTo(outputDir)
+    }
+
+    fun generateFileSpec(): FileSpec
+}

model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/internal/LanguageFileGenerator.kt

@@ -35,16 +35,18 @@ import java.nio.file.Path
 
 internal class LanguageFileGenerator(
     private val language: ProcessedLanguage,
-    private val outputDir: Path,
+    override val outputDir: Path,
     override val nameConfig: NameConfig,
-) : NameConfigBasedGenerator(nameConfig) {
+) : NameConfigBasedGenerator(nameConfig), FileGenerator {
 
-    fun generateFile() {
-        val fileSpec = FileSpec.builder(language.generatedClassName().packageName, language.generatedClassName().simpleName).runBuild {
+    override fun generateFileSpec(): FileSpec {
+        return FileSpec.builder(
+            packageName = language.generatedClassName().packageName,
+            fileName = language.generatedClassName().simpleName,
+        ).runBuild {
             addFileComment(MetaModelGenerator.HEADER_COMMENT)
             addType(generateLanguage())
         }
-        fileSpec.writeTo(outputDir)
     }
 
     private fun generateLanguage(): TypeSpec {

model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/internal/MetaPropertiesInterfaceGenerator.kt

@@ -29,15 +29,11 @@ import java.nio.file.Path
 
 internal class MetaPropertiesInterfaceGenerator(
     private val languages: ProcessedLanguageSet,
-    private val outputDir: Path,
+    override val outputDir: Path,
     private val fqInterfaceName: String,
-) {
+) : FileGenerator {
 
-    fun generateFile() {
-        generateConceptMetaPropertiesInterface().writeTo(outputDir)
-    }
-
-    private fun generateConceptMetaPropertiesInterface(): FileSpec {
+    override fun generateFileSpec(): FileSpec {
         require(fqInterfaceName.contains(".")) { "The name of the concept properties interface does not contain a dot. Use a fully qualified name." }
         val interfaceName = ClassName(fqInterfaceName.substringBeforeLast("."), fqInterfaceName.substringAfterLast("."))
 

model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/internal/ModelQLFileGenerator.kt

@@ -43,20 +43,16 @@ import java.nio.file.Path
 
 internal class ModelQLFileGenerator(
     private val concept: ProcessedConcept,
-    private val outputDir: Path,
+    override val outputDir: Path,
     override val nameConfig: NameConfig,
     private val alwaysUseNonNullableProperties: Boolean,
-) : NameConfigBasedGenerator(nameConfig) {
+) : NameConfigBasedGenerator(nameConfig), FileGenerator {
 
     companion object {
         private const val PACKAGE_PREFIX = "org.modelix.modelql.gen."
     }
 
-    fun generateFile() {
-        buildModelQLFileSpec().writeTo(outputDir)
-    }
-
-    private fun buildModelQLFileSpec(): FileSpec {
+    override fun generateFileSpec(): FileSpec {
         return FileSpec.builder(PACKAGE_PREFIX + concept.language.name, concept.name).runBuild {
             addFileComment(MetaModelGenerator.HEADER_COMMENT)
             for (feature in concept.getOwnRoles()) {

model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/internal/RegistrationHelperGenerator.kt

@@ -32,15 +32,11 @@ import java.nio.file.Path
 internal class RegistrationHelperGenerator(
     private val classFqName: String,
     private val languages: ProcessedLanguageSet,
-    private val outputDir: Path,
+    override val outputDir: Path,
     override val nameConfig: NameConfig,
-) : NameConfigBasedGenerator(nameConfig) {
+) : NameConfigBasedGenerator(nameConfig), FileGenerator {
 
-    fun generateFile() {
-        generateSpec().writeTo(outputDir)
-    }
-
-    private fun generateSpec(): FileSpec {
+    override fun generateFileSpec(): FileSpec {
         require(classFqName.contains(".")) { "The name of the registrationHelper does not contain a dot. Use a fully qualified name." }
         val typeName = ClassName(classFqName.substringBeforeLast("."), classFqName.substringAfterLast("."))