add @NonDataProp to skip getter-like concrete methods

Author: xinthink

example/src/test/java/com/fivemiles/auto/dataclass/SimpleDataTest.kt

@@ -39,10 +39,14 @@ import org.junit.Test
 /**
  * Or abstract classes is also supported.
  */
+@Suppress("unused")
 @DataClass abstract class SimpleAbsData : Parcelable {
     abstract val name: String
     abstract var age: Int
 
+    /** Getter-like concrete methods will be skipped */
+    fun description(): String = "$name is $age years old."
+
     companion object {
         fun create(name: String = "Jon", age: Int = 18): SimpleAbsData =
             DC_SimpleAbsData(name, age)
@@ -57,6 +61,10 @@ import org.junit.Test
  */
 @DataClass data class SimpleFinalData(val name: String, var age: Int) {
     override fun toString() = "$name, $age years old"
+
+    /** Skip getter-like methods by annotating [NonDataProp] */
+    @NonDataProp
+    fun description(): String = "$name is $age years old."
 }
 
 /**

lib/src/main/java/com/fivemiles/auto/dataclass/DataProp.kt

@@ -8,19 +8,19 @@ import kotlin.reflect.KClass
  * Define a Data property
  */
 @Retention(AnnotationRetention.SOURCE)
-@Target(AnnotationTarget.PROPERTY_GETTER)
+@Target(AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.FUNCTION)
 @MustBeDocumented
 annotation class DataProp(
     /** Name of the JSON field for the property */
     val jsonField: String = "",
     /** Alternative JSON field names */
-    val jsonFieldAlternate: Array<String> = emptyArray(),
+    val jsonFieldAlternate: Array<String> = [],
     /** The literal of the default value, used in generated source */
     val defaultValueLiteral: String = "",
     /** Customized Gson [TypeAdapter] for this property */
     val gsonTypeAdapter: KClass<out TypeAdapter<*>> = TypeAdapter::class,
     /** Customized [ParcelAdapter] for this property */
     val parcelAdapter: KClass<out ParcelAdapter<*>> = ParcelAdapter::class,
-    /** If the property is transient */
+    /** If the property is transient (will be skipped by the generators) */
     val isTransient: Boolean = false
 )

lib/src/main/java/com/fivemiles/auto/dataclass/NonDataProp.kt

@@ -0,0 +1,9 @@
+package com.fivemiles.auto.dataclass
+
+/**
+ * Tell the generators to ignore the annotated getters or methods.
+ */
+@Retention(AnnotationRetention.SOURCE)
+@Target(AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.FUNCTION)
+@MustBeDocumented
+annotation class NonDataProp

processor/src/main/java/com/fivemiles/auto/dataclass/models.kt

@@ -1,12 +1,20 @@
 package com.fivemiles.auto.dataclass
 
-/* ktlint-disable no-wildcard-imports */
-import com.google.auto.common.*
-import com.squareup.kotlinpoet.*
+import com.google.auto.common.AnnotationMirrors
+import com.google.auto.common.MoreElements
+import com.squareup.kotlinpoet.ClassName
+import com.squareup.kotlinpoet.TypeName
+import com.squareup.kotlinpoet.asClassName
 import java.beans.Introspector
 import javax.annotation.processing.ProcessingEnvironment
-import javax.lang.model.element.*
-import javax.lang.model.type.*
+import javax.lang.model.element.AnnotationMirror
+import javax.lang.model.element.Element
+import javax.lang.model.element.ExecutableElement
+import javax.lang.model.element.Modifier
+import javax.lang.model.element.TypeElement
+import javax.lang.model.type.TypeKind
+import javax.lang.model.type.TypeMirror
+import javax.lang.model.util.Elements
 import javax.lang.model.util.Types
 
 private const val CLASS_NAME_PREFIX = "DC"
@@ -41,7 +49,7 @@ internal data class DataClassDef(
 ) {
 
     val typeUtils: Types by lazy { processingEnv.typeUtils }
-    val elementUtils = processingEnv.elementUtils
+    private val elementUtils: Elements = processingEnv.elementUtils
 
     /**
      * [ClassName] of the data class to be generated
@@ -103,7 +111,8 @@ internal data class DataClassDef(
         element: TypeElement,
         methods: Set<ExecutableElement>?
     ): Set<ExecutableElement> = methods?.filter {
-        it.parameters.isEmpty() &&
+        !it.isAnnotationPresent(NonDataProp::class.java.name) && // ignore non-property
+            it.parameters.isEmpty() &&
             (element.isConcreteClass || Modifier.ABSTRACT in it.modifiers) && // allow concrete properties in Parcelized class
             it.returnType?.kind != TypeKind.VOID &&
             !hasDefaultImplement(element, it, typeUtils) &&

processor/src/test/java/com/fivemiles/auto/dataclass/DataClassStepTest.kt

@@ -4,8 +4,15 @@ package com.fivemiles.auto.dataclass
 import com.google.common.truth.Truth.assertAbout
 import com.google.testing.compile.JavaFileObjects
 import com.google.testing.compile.JavaSourcesSubjectFactory.javaSources
-import com.squareup.kotlinpoet.*
-import org.junit.*
+import com.squareup.kotlinpoet.FileSpec
+import com.squareup.kotlinpoet.FunSpec
+import com.squareup.kotlinpoet.KModifier
+import com.squareup.kotlinpoet.PropertySpec
+import com.squareup.kotlinpoet.TypeSpec
+import com.squareup.kotlinpoet.asClassName
+import org.junit.Before
+import org.junit.Ignore
+import org.junit.Test
 import java.nio.charset.Charset
 import javax.tools.JavaFileObject
 import javax.tools.StandardLocation.SOURCE_OUTPUT
@@ -15,6 +22,7 @@ import javax.tools.StandardLocation.SOURCE_OUTPUT
  *
  * Created by ywu on 2017/7/6.
  */
+@Suppress("UNUSED_VARIABLE")
 class DataClassStepTest {
 
     private lateinit var dataClassSource: JavaFileObject