Scope enum -> Scope object change

reactivestudio · reactivestudio · commit 048d6e3e98ef · 2025-05-21T03:38:45.000+07:00
diff --git a/README.md b/README.md
@@ -26,10 +26,14 @@ to generate converters for the targets you use — while remaining fully type-sa
 For Gradle with Kotlin DSL:
 
 ```kotlin
+plugins {
+	id("com.google.devtools.ksp") version "2.1.21-2.0.1"
+}
+
 dependencies { 
-	implementation("pro.vlprojects:convertible-core:0.0.1")
-	implementation("pro.vlprojects:convertible-jpa:0.0.1") // or other scopes
-	ksp("pro.vlprojects:convertible-core:0.0.1")
+	implementation("pro.vlprojects:convertible-core:0.0.2")
+	implementation("pro.vlprojects:convertible-jpa:0.0.2") // or other scopes
+	ksp("pro.vlprojects:convertible-core:0.0.2")
 }
 ```
 
@@ -51,7 +55,7 @@ class User(
 
 3. Auto-generated converter
 ```kotlin
-@Component
+@Component(value = "jpa.UserIdConverter")
 @Converter(autoApply = true)
 class UserIdConverter : AttributeConverter<UserId, String> {
 	override fun convertToDatabaseColumn(attribute: UserId): String = attribute.raw
diff --git a/convertible-core/build.gradle.kts b/convertible-core/build.gradle.kts
@@ -10,9 +10,9 @@ repositories {
 }
 
 dependencies {
-	implementation("com.squareup:kotlinpoet:2.1.0")
-	implementation("com.squareup:kotlinpoet-ksp:2.1.0")
-	implementation("com.google.devtools.ksp:symbol-processing-api:2.1.10-1.0.29")
+	implementation("com.squareup:kotlinpoet:2.2.0")
+	implementation("com.squareup:kotlinpoet-ksp:2.2.0")
+	implementation("com.google.devtools.ksp:symbol-processing-api:2.1.21-2.0.1")
 	testImplementation(kotlin("test"))
 }
 
diff --git a/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/annotation/Convertible.kt b/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/annotation/Convertible.kt
@@ -4,6 +4,6 @@ package pro.vlprojects.convertible.core.annotation
 @Retention(AnnotationRetention.BINARY)
 @Repeatable
 annotation class Convertible(
-	val scopes: Array<Scope> = [],
+	val scopes: Array<String> = [],
 	val nullable: Boolean = false,
 )
diff --git a/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/annotation/ConvertibleFactory.kt b/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/annotation/ConvertibleFactory.kt
@@ -3,5 +3,5 @@ package pro.vlprojects.convertible.core.annotation
 @Target(AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR)
 @Retention(AnnotationRetention.SOURCE)
 annotation class ConvertibleFactory(
-	val scopes: Array<Scope> = [],
+	val scopes: Array<String> = [],
 )
diff --git a/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/annotation/ConvertibleValue.kt b/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/annotation/ConvertibleValue.kt
@@ -3,5 +3,5 @@ package pro.vlprojects.convertible.core.annotation
 @Target(AnnotationTarget.FUNCTION, AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER)
 @Retention(AnnotationRetention.SOURCE)
 annotation class ConvertibleValue(
-	val scopes: Array<Scope> = [],
+	val scopes: Array<String> = [],
 )
diff --git a/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/annotation/Scope.kt b/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/annotation/Scope.kt
@@ -1,13 +1,8 @@
 package pro.vlprojects.convertible.core.annotation
 
-enum class Scope {
-	JPA,
-	MONGODB,
-	JACKSON,
-	MVC,
-	;
-
-	companion object Factory {
-		fun from(name: String) = entries.firstOrNull { it.name.equals(name, ignoreCase = true) }
-	}
+object Scope {
+	const val JPA = "jpa"
+	const val MONGODB = "mongodb"
+	const val JACKSON = "jackson"
+	const val MVC = "mvc"
 }
diff --git a/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/definition/ConvertibleDefinition.kt b/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/definition/ConvertibleDefinition.kt
@@ -6,11 +6,10 @@ import com.google.devtools.ksp.symbol.KSPropertyDeclaration
 import com.squareup.kotlinpoet.ClassName
 import com.squareup.kotlinpoet.TypeName
 import com.squareup.kotlinpoet.ksp.toTypeName
-import pro.vlprojects.convertible.core.annotation.Scope
 
 data class ConvertibleDefinition(
 	val objectClassName: ClassName,
-	val scope: Scope,
+	val scope: String,
 	val nullable: Boolean,
 	val valueAccessor: ValueAccessor,
 	val factoryAccessor: FactoryAccessor,
diff --git a/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/processor/ConvertibleProcessor.kt b/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/processor/ConvertibleProcessor.kt
@@ -12,7 +12,6 @@ import com.squareup.kotlinpoet.FileSpec
 import pro.vlprojects.convertible.core.annotation.Convertible
 import pro.vlprojects.convertible.core.definition.ConvertibleDefinition
 import pro.vlprojects.convertible.core.strategy.ConvertibleStrategy
-import pro.vlprojects.convertible.core.processor.ConvertibleVisitor
 import java.io.OutputStreamWriter
 import java.util.ServiceLoader
 
@@ -40,7 +39,7 @@ class ConvertibleProcessor(
 
 	override fun finish() = definitions
 		.forEach { definition ->
-			val targetPackage = "${definition.objectClassName.packageName}.${definition.scope.name.lowercase()}"
+			val targetPackage = "${definition.objectClassName.packageName}.${definition.scope.lowercase()}"
 			strategies
 				.filter { it.supports(definition) }
 				.forEach { strategy ->
diff --git a/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/processor/ConvertibleVisitor.kt b/convertible-core/src/main/kotlin/pro/vlprojects/convertible/core/processor/ConvertibleVisitor.kt
@@ -5,7 +5,6 @@ import com.google.devtools.ksp.symbol.KSAnnotated
 import com.google.devtools.ksp.symbol.KSAnnotation
 import com.google.devtools.ksp.symbol.KSClassDeclaration
 import com.google.devtools.ksp.symbol.KSDeclaration
-import com.google.devtools.ksp.symbol.KSType
 import com.google.devtools.ksp.symbol.KSVisitorVoid
 import com.google.devtools.ksp.symbol.Modifier
 import com.squareup.kotlinpoet.TypeName
@@ -14,8 +13,9 @@ import com.squareup.kotlinpoet.ksp.toTypeName
 import pro.vlprojects.convertible.core.annotation.Convertible
 import pro.vlprojects.convertible.core.annotation.ConvertibleFactory
 import pro.vlprojects.convertible.core.annotation.ConvertibleValue
-import pro.vlprojects.convertible.core.annotation.Scope
 import pro.vlprojects.convertible.core.definition.ConvertibleDefinition
+import pro.vlprojects.convertible.core.definition.ConvertibleDefinition.FactoryAccessor
+import pro.vlprojects.convertible.core.definition.ConvertibleDefinition.ValueAccessor
 import kotlin.reflect.KClass
 
 class ConvertibleVisitor(
@@ -55,7 +55,7 @@ class ConvertibleVisitor(
 		}
 	}
 
-	private fun resolveValueAccessor(declaration: KSClassDeclaration, scope: Scope) : ConvertibleDefinition.ValueAccessor {
+	private fun resolveValueAccessor(declaration: KSClassDeclaration, scope: String) : ValueAccessor {
 
 		val className = declaration.simpleName.asString()
 
@@ -81,7 +81,7 @@ class ConvertibleVisitor(
 			check(method.isPublic()) { "Method $className.$methodName must be public" }
 			check(method.parameters.all { it.hasDefault }) { "Method $className.$methodName must have default params only" }
 
-			return ConvertibleDefinition.ValueAccessor.Factory.from(method)
+			return ValueAccessor.Factory.from(method)
 		}
 
 		if (properties.isNotEmpty()) {
@@ -92,7 +92,7 @@ class ConvertibleVisitor(
 			check(property.isPublic()) { "Property $className.$propertyName must be public" }
 			check(!type.isMarkedNullable) { "Type of $className.$propertyName must NOT be nullable" }
 
-			return ConvertibleDefinition.ValueAccessor.Factory.from(property)
+			return ValueAccessor.Factory.from(property)
 		}
 
 		// Fallback: use first public property as ValueAccessor
@@ -101,14 +101,14 @@ class ConvertibleVisitor(
 		check(fallbackProperty != null) { "No public property found in $className to use as fallback ConvertibleValue for scope $scope" }
 		check(!fallbackProperty.type.resolve().isMarkedNullable) { "Fallback property $className.$fallbackProperty must NOT be nullable" }
 
-		return ConvertibleDefinition.ValueAccessor.Factory.from(fallbackProperty)
+		return ValueAccessor.Factory.from(fallbackProperty)
 	}
 
 	private fun resolveFactoryAccessor(
 		declaration: KSClassDeclaration,
 		argumentType: TypeName,
-		scope: Scope,
-	) : ConvertibleDefinition.FactoryAccessor {
+		scope: String,
+	) : FactoryAccessor {
 
 		val className = declaration.simpleName.asString()
 
@@ -133,7 +133,7 @@ class ConvertibleVisitor(
 			check(method.isPublic()) { "Method $className.$methodName is not public" }
 			check(arguments.size == 1) { "Exactly one argument of type $argumentType expected in method $className.$methodName" }
 
-			return ConvertibleDefinition.FactoryAccessor.Factory.from(method)
+			return FactoryAccessor.Factory.from(method)
 		}
 
 		// Fallback: use public constructor as FactoryAccessor
@@ -145,24 +145,17 @@ class ConvertibleVisitor(
 		check(constructor != null) { "No public constructor found in $className" }
 		check(constructorArguments?.size == 1) { "Exactly one argument of type $argumentType expected in constructor $className" }
 
-		return ConvertibleDefinition.FactoryAccessor.Factory.from(constructor)
+		return FactoryAccessor.Factory.from(constructor)
 	}
 
-	private fun KSAnnotated.hasAnnotationWithScope(annotation: KClass<*>, scope: Scope) = annotations
+	private fun KSAnnotated.hasAnnotationWithScope(annotation: KClass<*>, scope: String) = annotations
 		.filter { it.isOf(annotation) }
 		.flatMap { it.getScopes() }
 		.contains(scope)
 
-	private fun KSAnnotation.getScopes(): List<Scope> {
-		val values = getArgument<List<*>>("scopes") ?: return emptyList()
-
-		return values
-			.filterIsInstance<KSDeclaration>()
-			.mapNotNull { type ->
-				val typeName = type.simpleName.asString()
-				Scope.entries.firstOrNull { it.name == typeName }
-			}
-	}
+	private fun KSAnnotation.getScopes() = getArgument<List<*>>("scopes")
+		?.filterIsInstance<String>()
+		?: emptyList()
 
 	private fun KSAnnotation.isOf(annotation: KClass<*>) = shortName.asString() == annotation.simpleName
 
diff --git a/convertible-jpa/build.gradle.kts b/convertible-jpa/build.gradle.kts
@@ -15,12 +15,12 @@ dependencies {
 	implementation("jakarta.persistence:jakarta.persistence-api:3.1.0")
 	implementation("org.springframework:spring-context:6.2.6")
 
-	implementation("com.squareup:kotlinpoet:2.1.0")
+	implementation("com.squareup:kotlinpoet:2.2.0")
 
 	testImplementation(kotlin("test"))
 
-	testImplementation("dev.zacsweers.kctfork:core:0.7.0")
-	testImplementation("dev.zacsweers.kctfork:ksp:0.7.0")
+	testImplementation("dev.zacsweers.kctfork:core:0.7.1")
+	testImplementation("dev.zacsweers.kctfork:ksp:0.7.1")
 
 	testImplementation(platform("org.junit:junit-bom:5.10.2"))
 	testImplementation("org.junit.jupiter:junit-jupiter-api")
diff --git a/convertible-jpa/src/main/kotlin/pro/vlprojects/convertible/jpa/JpaAttributeConverter.kt b/convertible-jpa/src/main/kotlin/pro/vlprojects/convertible/jpa/JpaAttributeConverter.kt
@@ -21,7 +21,8 @@ class JpaAttributeConverter : ConvertibleStrategy {
 
 	override fun build(definition: ConvertibleDefinition): FileSpec {
 
-		val packageName = "${definition.objectClassName.packageName}.jpa"
+		val scope = Scope.JPA
+		val packageName = "${definition.objectClassName.packageName}.$scope"
 		val fileName = "${definition.objectClassName.simpleName}Converter"
 		val nullable = definition.nullable
 		val objectType = definition.objectClassName.copy(nullable = nullable)
@@ -33,7 +34,12 @@ class JpaAttributeConverter : ConvertibleStrategy {
 				TypeSpec
 					.classBuilder(fileName)
 					.addModifiers()
-					.addAnnotation(Component::class)
+					.addAnnotation(
+						AnnotationSpec
+							.builder(Component::class)
+							.addMember("value = \"%L\"", "$scope.$fileName")
+							.build()
+					)
 					.addAnnotation(
 						AnnotationSpec
 							.builder(Converter::class)
diff --git a/convertible-jpa/src/test/kotlin/pro/vlprojects/convertible/jpa/JpaAttributeConverterTests.kt b/convertible-jpa/src/test/kotlin/pro/vlprojects/convertible/jpa/JpaAttributeConverterTests.kt
@@ -25,7 +25,7 @@ class JpaAttributeConverterTests {
 	fun `Should succeed to generate JPA converter from resource`(case: TestCase) {
 
 		val originalContent = readResource("vo/${case.originalName}")
-		val expectedContent = readResource("convertor/${case.expectedName}")
+		val expectedContent = readResource("converter/${case.expectedName}")
 
 		val compilation = prepareCompilation(case.originalName, originalContent)
 		val result = compilation.compile()
diff --git a/convertible-jpa/src/test/resources/converter/DeclaredAllConverter.kt b/convertible-jpa/src/test/resources/converter/DeclaredAllConverter.kt
@@ -6,7 +6,7 @@ import jakarta.persistence.Converter
 import kotlin.String
 import org.springframework.stereotype.Component
 
-@Component
+@Component(value = "jpa.DeclaredAllConverter")
 @Converter(autoApply = true)
 public class DeclaredAllConverter : AttributeConverter<DeclaredAll, String> {
   override fun convertToDatabaseColumn(attribute: DeclaredAll): String = attribute.value
diff --git a/convertible-jpa/src/test/resources/converter/EnumExampleConverter.kt b/convertible-jpa/src/test/resources/converter/EnumExampleConverter.kt
@@ -6,7 +6,7 @@ import jakarta.persistence.Converter
 import kotlin.String
 import org.springframework.stereotype.Component
 
-@Component
+@Component(value = "jpa.EnumExampleConverter")
 @Converter(autoApply = true)
 public class EnumExampleConverter : AttributeConverter<EnumExample, String> {
   override fun convertToDatabaseColumn(attribute: EnumExample): String = attribute.getValue()
diff --git a/convertible-jpa/src/test/resources/converter/FallbackAllConverter.kt b/convertible-jpa/src/test/resources/converter/FallbackAllConverter.kt
@@ -6,7 +6,7 @@ import jakarta.persistence.Converter
 import java.util.UUID
 import org.springframework.stereotype.Component
 
-@Component
+@Component(value = "jpa.FallbackAllConverter")
 @Converter(autoApply = true)
 public class FallbackAllConverter : AttributeConverter<FallbackAll, UUID> {
   override fun convertToDatabaseColumn(attribute: FallbackAll): UUID = attribute.raw
diff --git a/convertible-jpa/src/test/resources/converter/FallbackFactoryConverter.kt b/convertible-jpa/src/test/resources/converter/FallbackFactoryConverter.kt
@@ -6,7 +6,7 @@ import jakarta.persistence.Converter
 import kotlin.String
 import org.springframework.stereotype.Component
 
-@Component
+@Component(value = "jpa.FallbackFactoryConverter")
 @Converter(autoApply = true)
 public class FallbackFactoryConverter : AttributeConverter<FallbackFactory, String> {
   override fun convertToDatabaseColumn(attribute: FallbackFactory): String = attribute.value
diff --git a/convertible-jpa/src/test/resources/converter/FallbackValueConverter.kt b/convertible-jpa/src/test/resources/converter/FallbackValueConverter.kt
@@ -6,7 +6,7 @@ import jakarta.persistence.Converter
 import java.util.UUID
 import org.springframework.stereotype.Component
 
-@Component
+@Component(value = "jpa.FallbackValueConverter")
 @Converter(autoApply = true)
 public class FallbackValueConverter : AttributeConverter<FallbackValue, UUID> {
   override fun convertToDatabaseColumn(attribute: FallbackValue): UUID = attribute.raw
diff --git a/convertible-jpa/src/test/resources/converter/NullableDeclaredAllConverter.kt b/convertible-jpa/src/test/resources/converter/NullableDeclaredAllConverter.kt
@@ -6,7 +6,7 @@ import jakarta.persistence.Converter
 import kotlin.String
 import org.springframework.stereotype.Component
 
-@Component
+@Component(value = "jpa.NullableDeclaredAllConverter")
 @Converter(autoApply = true)
 public class NullableDeclaredAllConverter : AttributeConverter<NullableDeclaredAll?, String?> {
   override fun convertToDatabaseColumn(attribute: NullableDeclaredAll?): String? = attribute?.value
diff --git a/convertible-jpa/src/test/resources/converter/NullableEnumExampleConverter.kt b/convertible-jpa/src/test/resources/converter/NullableEnumExampleConverter.kt
@@ -6,7 +6,7 @@ import jakarta.persistence.Converter
 import kotlin.String
 import org.springframework.stereotype.Component
 
-@Component
+@Component(value = "jpa.NullableEnumExampleConverter")
 @Converter(autoApply = true)
 public class NullableEnumExampleConverter : AttributeConverter<NullableEnumExample?, String?> {
   override fun convertToDatabaseColumn(attribute: NullableEnumExample?): String? = attribute?.getValue()
diff --git a/convertible-jpa/src/test/resources/converter/NullableFallbackAllConverter.kt b/convertible-jpa/src/test/resources/converter/NullableFallbackAllConverter.kt
@@ -6,7 +6,7 @@ import jakarta.persistence.Converter
 import java.util.UUID
 import org.springframework.stereotype.Component
 
-@Component
+@Component(value = "jpa.NullableFallbackAllConverter")
 @Converter(autoApply = true)
 public class NullableFallbackAllConverter : AttributeConverter<NullableFallbackAll?, UUID?> {
   override fun convertToDatabaseColumn(attribute: NullableFallbackAll?): UUID? = attribute?.raw
diff --git a/convertible-jpa/src/test/resources/converter/NullableFallbackFactoryConverter.kt b/convertible-jpa/src/test/resources/converter/NullableFallbackFactoryConverter.kt
@@ -6,7 +6,7 @@ import jakarta.persistence.Converter
 import kotlin.String
 import org.springframework.stereotype.Component
 
-@Component
+@Component(value = "jpa.NullableFallbackFactoryConverter")
 @Converter(autoApply = true)
 public class NullableFallbackFactoryConverter : AttributeConverter<NullableFallbackFactory?, String?> {
   override fun convertToDatabaseColumn(attribute: NullableFallbackFactory?): String? = attribute?.value
diff --git a/convertible-jpa/src/test/resources/converter/NullableFallbackValueConverter.kt b/convertible-jpa/src/test/resources/converter/NullableFallbackValueConverter.kt
@@ -6,7 +6,7 @@ import jakarta.persistence.Converter
 import java.util.UUID
 import org.springframework.stereotype.Component
 
-@Component
+@Component(value = "jpa.NullableFallbackValueConverter")
 @Converter(autoApply = true)
 public class NullableFallbackValueConverter : AttributeConverter<NullableFallbackValue?, UUID?> {
   override fun convertToDatabaseColumn(attribute: NullableFallbackValue?): UUID? = attribute?.raw
diff --git a/gradle.properties b/gradle.properties
@@ -1,4 +1,4 @@
 group=pro.vlprojects
-version=0.0.1
-kotlin.version=2.1.10
+version=0.0.2
+kotlin.version=2.1.21
 kotlin.code.style=official

Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,9 @@ repositories {`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`dependencies {`
`13`		`- implementation("com.squareup:kotlinpoet:2.1.0")`
`14`		`- implementation("com.squareup:kotlinpoet-ksp:2.1.0")`
`15`		`- implementation("com.google.devtools.ksp:symbol-processing-api:2.1.10-1.0.29")`
	`13`	`+ implementation("com.squareup:kotlinpoet:2.2.0")`
	`14`	`+ implementation("com.squareup:kotlinpoet-ksp:2.2.0")`
	`15`	`+ implementation("com.google.devtools.ksp:symbol-processing-api:2.1.21-2.0.1")`
`16`	`16`	`testImplementation(kotlin("test"))`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@ package pro.vlprojects.convertible.core.annotation`
`4`	`4`	`@Retention(AnnotationRetention.BINARY)`
`5`	`5`	`@Repeatable`
`6`	`6`	`annotation class Convertible(`
`7`		`- val scopes: Array<Scope> = [],`
	`7`	`+ val scopes: Array<String> = [],`
`8`	`8`	`val nullable: Boolean = false,`
`9`	`9`	`)`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@ package pro.vlprojects.convertible.core.annotation`
`3`	`3`	`@Target(AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR)`
`4`	`4`	`@Retention(AnnotationRetention.SOURCE)`
`5`	`5`	`annotation class ConvertibleFactory(`
`6`		`- val scopes: Array<Scope> = [],`
	`6`	`+ val scopes: Array<String> = [],`
`7`	`7`	`)`