fix: deprecated annotation won't work on helper options

shreyashsaitwal · Sep 28, 2023 · db1e1e7 · db1e1e7
1 parent b07aecf
commit db1e1e7
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 28 deletions.
diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/ExtensionProcessor.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/ExtensionProcessor.kt
@@ -13,7 +13,6 @@ import javax.annotation.processing.*
 import javax.lang.model.SourceVersion
 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.util.Elements
 import javax.tools.Diagnostic.Kind
@@ -51,7 +50,7 @@ class ExtensionProcessor : AbstractProcessor() {
         isFirstRound = false
 
         val elements = roundEnv.getElementsAnnotatedWith(Extension::class.java)
-        val extensions = elements.map { processExtensionElement(it, elementUtils) }
+        val extensions = elements.map { processExtensionElement(it) }
 
         val generator = InfoFilesGenerator(extensions)
         try {
@@ -64,7 +63,7 @@ class ExtensionProcessor : AbstractProcessor() {
         return false
     }
 
-    private fun processExtensionElement(element: Element, elementUtils: Elements): Ext {
+    private fun processExtensionElement(element: Element): Ext {
         val events = element.enclosedElements
             .filter { it.getAnnotation(SimpleEvent::class.java) != null }
             .map { Event(it as ExecutableElement, messager, elementUtils) }
@@ -79,7 +78,7 @@ class ExtensionProcessor : AbstractProcessor() {
 
         val designerProperties = element.enclosedElements
             .filter { it.getAnnotation(DesignerPropertyAnnotation::class.java) != null }
-            .map { DesignerProperty(it as ExecutableElement, messager, properties) }
+            .map { DesignerProperty(it as ExecutableElement, messager, elementUtils, properties) }
 
         val packageName = elementUtils.getPackageOf(element).qualifiedName.toString()
         val fqcn = "$packageName.${element.simpleName}"

diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Block.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Block.kt
@@ -2,13 +2,12 @@ package io.github.shreyashsaitwal.rush.block
 
 import io.github.shreyashsaitwal.rush.Utils
 import shaded.org.json.JSONObject
-import java.lang.Deprecated
 import javax.annotation.processing.Messager
 import javax.lang.model.element.ExecutableElement
 import javax.lang.model.element.Modifier
 import javax.lang.model.element.VariableElement
+import javax.lang.model.util.Elements
 import javax.tools.Diagnostic
-import kotlin.String
 
 /**
  * Represents AI2 block types:
@@ -17,7 +16,7 @@ import kotlin.String
  *  - `SimpleProperty`
  *  - `DesignerProperty`
  */
-abstract class Block(val element: ExecutableElement, val messager: Messager) {
+abstract class Block(val element: ExecutableElement, val messager: Messager, val elementUtils: Elements) {
 
     /**
      * Name of this block.
@@ -37,12 +36,12 @@ abstract class Block(val element: ExecutableElement, val messager: Messager) {
     /**
      * Helper (dropdown blocks) definition of this block.
      */
-    open val helper = Helper.tryFrom(element)
+    open val helper = Helper.tryFrom(element, elementUtils)
 
     /**
      * Whether this block is deprecated.
      */
-    val deprecated = element.getAnnotation(Deprecated::class.java) != null
+    val deprecated = elementUtils.isDeprecated(element)
 
     /**
      * Checks that are supposed to be performed on this block.
@@ -51,7 +50,11 @@ abstract class Block(val element: ExecutableElement, val messager: Messager) {
         val type = this::class.java.simpleName.toString()
 
         if (!Utils.isPascalCase(name)) {
-            messager.printMessage(Diagnostic.Kind.WARNING, "$type should follow `PascalCase` naming convention.", element)
+            messager.printMessage(
+                Diagnostic.Kind.WARNING,
+                "$type should follow `PascalCase` naming convention.",
+                element
+            )
         }
 
         if (!element.modifiers.contains(Modifier.PUBLIC)) {
@@ -70,7 +73,8 @@ abstract class Block(val element: ExecutableElement, val messager: Messager) {
  *  - `SimpleFunction`
  *  - `SimpleEvent`
  */
-abstract class ParameterizedBlock(element: ExecutableElement, messager: Messager) : Block(element, messager) {
+abstract class ParameterizedBlock(element: ExecutableElement, messager: Messager, elementUtil: Elements) :
+    Block(element, messager, elementUtil) {
 
     data class Parameter(
         val element: VariableElement,
@@ -103,7 +107,7 @@ abstract class ParameterizedBlock(element: ExecutableElement, messager: Messager
      * @return The parameters of this parameterized block.
      */
     val params: List<Parameter> = element.parameters.map {
-        val helper = Helper.tryFrom(it)
+        val helper = Helper.tryFrom(it, elementUtil)
         Parameter(
             it,
             it.simpleName.toString(),

diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/DesignerProperty.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/DesignerProperty.kt
@@ -4,13 +4,15 @@ import com.google.appinventor.components.annotations.DesignerProperty
 import shaded.org.json.JSONObject
 import javax.annotation.processing.Messager
 import javax.lang.model.element.ExecutableElement
+import javax.lang.model.util.Elements
 import javax.tools.Diagnostic.Kind
 
 class DesignerProperty(
     element: ExecutableElement,
     messager: Messager,
+    elementUtils: Elements,
     private val properties: List<Property>,
-) : Block(element, messager) {
+) : Block(element, messager, elementUtils) {
 
     init {
         runChecks()

diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Event.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Event.kt
@@ -12,8 +12,8 @@ import javax.tools.Diagnostic.Kind
 class Event(
     element: ExecutableElement,
     messager: Messager,
-    private val elementUtils: Elements,
-) : ParameterizedBlock(element, messager) {
+    elementUtils: Elements,
+) : ParameterizedBlock(element, messager, elementUtils) {
 
     init {
         runChecks()

diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Function.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Function.kt
@@ -14,8 +14,8 @@ import javax.tools.Diagnostic.Kind
 class Function(
     element: ExecutableElement,
     messager: Messager,
-    private val elementUtils: Elements,
-) : ParameterizedBlock(element, messager) {
+    elementUtils: Elements,
+) : ParameterizedBlock(element, messager, elementUtils) {
 
     init {
         runChecks()
@@ -34,7 +34,7 @@ class Function(
     override val returnType: String?
         get() {
             val continuationType = continuationUnderlyingType()
-            val helper = Helper.tryFrom(element)
+            val helper = Helper.tryFrom(element, elementUtils)
 
             return if (continuationType != null) {
                 if (element.returnType.kind != TypeKind.VOID) {

diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Helper.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Helper.kt
@@ -13,6 +13,7 @@ import javax.lang.model.element.ExecutableElement
 import javax.lang.model.element.TypeElement
 import javax.lang.model.type.DeclaredType
 import javax.lang.model.type.MirroredTypeException
+import javax.lang.model.util.Elements
 
 /**
  * Possible types of helper blocks.
@@ -74,7 +75,7 @@ data class Helper(
         /**
          * @return Generates [Helper] from [element] if it is of valid [HelperType], otherwise null.
          */
-        fun tryFrom(element: Element): Helper? {
+        fun tryFrom(element: Element, elementUtils: Elements): Helper? {
             val helperType = HelperType.tryFrom(element)
             return when (helperType) {
                 HelperType.ASSET -> {
@@ -111,7 +112,7 @@ data class Helper(
                     val data = if (isCached) {
                         HelperSingleton.optionListCache[optionListEnumName]!!
                     } else {
-                        OptionListData(helperElement).apply {
+                        OptionListData(helperElement, elementUtils).apply {
                             HelperSingleton.optionListCache.putIfAbsent(optionListEnumName, this)
                         }
                     }
@@ -168,7 +169,7 @@ private object HelperSingleton {
     }
 }
 
-private class OptionListData(private val element: Element) : HelperData() {
+private class OptionListData(element: Element, private val elementUtils: Elements) : HelperData() {
 
     data class Option(
         val deprecated: Boolean,
@@ -217,7 +218,8 @@ private class OptionListData(private val element: Element) : HelperData() {
         val enclosedElements = (elementType as DeclaredType).asElement().enclosedElements
         val enumElements = enclosedElements.filter { enumConsts.containsKey(it.simpleName.toString()) }
 
-        defaultOption = enumElements.singleOrNull { it.getAnnotation(Default::class.java) != null }
+        defaultOption = enumElements
+            .singleOrNull { it.getAnnotation(Default::class.java) != null }
             ?.simpleName?.toString() ?: enumConsts.keys.first()
 
         // The typeName property returns name like this: com.google.appinventor.components.common.OptionList<java.lang.String>
@@ -226,7 +228,9 @@ private class OptionListData(private val element: Element) : HelperData() {
 
         return enumConsts.map {
             Option(
-                deprecated = element.getAnnotation(Deprecated::class.java) != null,
+                deprecated = elementUtils.isDeprecated(enumElements.singleOrNull { el ->
+                    el.simpleName.toString() == it.key
+                }),
                 name = it.key,
                 value = it.value,
             ).asJsonObject()

diff --git a/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Property.kt b/processor/processor/src/main/kotlin/io/github/shreyashsaitwal/rush/block/Property.kt
@@ -23,8 +23,8 @@ private val processedProperties = mutableListOf<Property>()
 class Property(
     element: ExecutableElement,
     messager: Messager,
-    private val elementUtils: Elements,
-) : Block(element, messager) {
+    elementUtils: Elements,
+) : Block(element, messager, elementUtils) {
 
     private val accessType: PropertyAccessType
 
@@ -73,11 +73,11 @@ class Property(
 
     override val helper = when (element.returnType.kind) {
         // Setters
-        TypeKind.VOID -> Helper.tryFrom(element.parameters[0])
+        TypeKind.VOID -> Helper.tryFrom(element.parameters[0], elementUtils)
         // Getters with [DeclaredType] return type
-        TypeKind.DECLARED -> Helper.tryFrom((element.returnType as DeclaredType).asElement() as TypeElement)
+        TypeKind.DECLARED -> Helper.tryFrom((element.returnType as DeclaredType).asElement() as TypeElement, elementUtils)
         // Getters with primitive return type
-        else -> Helper.tryFrom(element)
+        else -> Helper.tryFrom(element, elementUtils)
     }
 
     /**