feat!: Use Kotlin DSL for patch options (#234)

ReVanced · Sep 6, 2023 · c299817 · c299817
1 parent fcc1de4
commit c299817
Show file tree

Hide file tree

Showing 30 changed files with 1,038 additions and 707 deletions.
diff --git a/...cessor/src/main/kotlin/app/revanced/patcher/patch/annotations/processor/PatchProcessor.kt b/...cessor/src/main/kotlin/app/revanced/patcher/patch/annotations/processor/PatchProcessor.kt
@@ -3,7 +3,6 @@ package app.revanced.patcher.patch.annotations.processor
 import app.revanced.patcher.data.BytecodeContext
 import app.revanced.patcher.data.ResourceContext
 import app.revanced.patcher.patch.BytecodePatch
-import app.revanced.patcher.patch.PatchOptions
 import app.revanced.patcher.patch.ResourcePatch
 import app.revanced.patcher.patch.annotations.Patch
 import com.google.devtools.ksp.processing.*
@@ -114,7 +113,6 @@ class PatchProcessor(
             }
         }
 
-        // kotlin poet generate a class for each patch
         executablePatches.forEach { (patchDeclaration, patchAnnotation) ->
             val isBytecodePatch = patchDeclaration.isSubclassOf(BytecodePatch::class)
 
@@ -159,7 +157,7 @@ class PatchProcessor(
                                     "dependencies = setOf(%L)",
                                     buildList {
                                         addAll(dependencies)
-                                        // Also add the source class of the generated class so that it is also executed
+                                        // Also add the source class of the generated class so that it is also executed.
                                         add(patchDeclaration.toClassName())
                                     }.joinToString(", ") { dependency ->
                                         "${(dependencyResolutionMap[dependency] ?: dependency)}::class"
@@ -181,9 +179,18 @@ class PatchProcessor(
                                 .addParameter("context", contextClass)
                                 .build()
                         )
-                        .addProperty(
-                            PropertySpec.builder("options", PatchOptions::class, KModifier.OVERRIDE)
-                                .initializer("%T.options", patchDeclaration.toClassName())
+                        .addInitializerBlock(
+                            CodeBlock.builder()
+                                .add(
+                                    "%T.options.forEach { (key, option) ->",
+                                    patchDeclaration.toClassName()
+                                )
+                                .addStatement(
+                                    "options.register(option)"
+                                )
+                                .add(
+                                    "}"
+                                )
                                 .build()
                         )
                         .build()

diff --git a/...t/kotlin/app/revanced/patcher/patch/annotations/processor/TestPatchAnnotationProcessor.kt b/...t/kotlin/app/revanced/patcher/patch/annotations/processor/TestPatchAnnotationProcessor.kt
@@ -7,7 +7,6 @@ import com.tschuchort.compiletesting.kspWithCompilation
 import com.tschuchort.compiletesting.symbolProcessorProviders
 import kotlin.test.Test
 import kotlin.test.assertEquals
-import kotlin.test.assertNotNull
 import kotlin.test.assertNull
 
 class TestPatchAnnotationProcessor {
@@ -64,7 +63,7 @@ class TestPatchAnnotationProcessor {
             )
         ).loadPatch("$SAMPLE_PACKAGE.options.OptionsPatchGenerated")
 
-        assertNotNull(patch.options)
+        assert(patch.options.isNotEmpty())
         assertEquals(patch.options["print"].title, "Print message")
     }
 

diff --git a/...esources/app/revanced/patcher/patch/annotations/processor/samples/options/OptionsPatch.kt b/...esources/app/revanced/patcher/patch/annotations/processor/samples/options/OptionsPatch.kt
@@ -1,21 +1,19 @@
 package app.revanced.patcher.patch.annotations.processor.samples.options
 
 import app.revanced.patcher.data.ResourceContext
-import app.revanced.patcher.patch.PatchOption
 import app.revanced.patcher.patch.ResourcePatch
 import app.revanced.patcher.patch.annotations.Patch
+import app.revanced.patcher.patch.options.types.StringPatchOption.Companion.stringPatchOption
 
 @Patch(name = "Options patch")
 object OptionsPatch : ResourcePatch() {
     override fun execute(context: ResourceContext) {}
 
     @Suppress("unused")
-    private val printOption by option(
-        PatchOption.StringOption(
-            "print",
-            null,
-            "Print message",
-            "The message to print."
-        )
+    private val printOption by stringPatchOption(
+        "print",
+        null,
+        "Print message",
+        "The message to print."
     )
 }
diff --git a/revanced-patcher/api/revanced-patcher.api b/revanced-patcher/api/revanced-patcher.api
diff --git a/revanced-patcher/src/main/kotlin/app/revanced/patcher/patch/BytecodePatch.kt b/revanced-patcher/src/main/kotlin/app/revanced/patcher/patch/BytecodePatch.kt
@@ -0,0 +1,27 @@
+package app.revanced.patcher.patch
+
+import app.revanced.patcher.PatchClass
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+
+/**
+ * A ReVanced [Patch] that works on [BytecodeContext].
+ *
+ * @param fingerprints A list of [MethodFingerprint]s which will be resolved before the patch is executed.
+ * @param name The name of the patch.
+ * @param description The description of the patch.
+ * @param compatiblePackages The packages the patch is compatible with.
+ * @param dependencies The names of patches this patch depends on.
+ * @param use Weather or not the patch should be used.
+ * @param requiresIntegrations Weather or not the patch requires integrations.
+ */
+abstract class BytecodePatch(
+    internal val fingerprints: Set<MethodFingerprint> = emptySet(),
+    name: String? = null,
+    description: String? = null,
+    compatiblePackages: Set<CompatiblePackage>? = null,
+    dependencies: Set<PatchClass>? = null,
+    use: Boolean = true,
+    // TODO: Remove this property, once integrations are coupled with patches.
+    requiresIntegrations: Boolean = false,
+) : Patch<BytecodeContext>(name, description, compatiblePackages, dependencies, use, requiresIntegrations)
diff --git a/revanced-patcher/src/main/kotlin/app/revanced/patcher/patch/OptionsContainer.kt b/revanced-patcher/src/main/kotlin/app/revanced/patcher/patch/OptionsContainer.kt
diff --git a/revanced-patcher/src/main/kotlin/app/revanced/patcher/patch/Patch.kt b/revanced-patcher/src/main/kotlin/app/revanced/patcher/patch/Patch.kt
@@ -4,10 +4,8 @@ package app.revanced.patcher.patch
 
 import app.revanced.patcher.PatchClass
 import app.revanced.patcher.Patcher
-import app.revanced.patcher.data.BytecodeContext
 import app.revanced.patcher.data.Context
-import app.revanced.patcher.data.ResourceContext
-import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patcher.patch.options.PatchOptions
 import java.io.Closeable
 
 /**
@@ -32,7 +30,12 @@ sealed class Patch<out T : Context<*>>(
     val use: Boolean = true,
     // TODO: Remove this property, once integrations are coupled with patches.
     val requiresIntegrations: Boolean = false,
-) : OptionsContainer() {
+) {
+    /**
+     * The options of the patch associated by the options key.
+     */
+    val options = PatchOptions()
+
     /**
      * The execution function of the patch.
      *
@@ -66,44 +69,3 @@ sealed class Patch<out T : Context<*>>(
     )
 }
 
-/**
- * A ReVanced [Patch] that works on [ResourceContext].
- *
- * @param name The name of the patch.
- * @param description The description of the patch.
- * @param compatiblePackages The packages the patch is compatible with.
- * @param dependencies The names of patches this patch depends on.
- * @param use Weather or not the patch should be used.
- * @param requiresIntegrations Weather or not the patch requires integrations.
- */
-abstract class ResourcePatch(
-    name: String? = null,
-    description: String? = null,
-    compatiblePackages: Set<CompatiblePackage>? = null,
-    dependencies: Set<PatchClass>? = null,
-    use: Boolean = true,
-    // TODO: Remove this property, once integrations are coupled with patches.
-    requiresIntegrations: Boolean = false,
-) : Patch<ResourceContext>(name, description, compatiblePackages, dependencies, use, requiresIntegrations)
-
-/**
- * A ReVanced [Patch] that works on [BytecodeContext].
- *
- * @param fingerprints A list of [MethodFingerprint]s which will be resolved before the patch is executed.
- * @param name The name of the patch.
- * @param description The description of the patch.
- * @param compatiblePackages The packages the patch is compatible with.
- * @param dependencies The names of patches this patch depends on.
- * @param use Weather or not the patch should be used.
- * @param requiresIntegrations Weather or not the patch requires integrations.
- */
-abstract class BytecodePatch(
-    internal val fingerprints: Set<MethodFingerprint> = emptySet(),
-    name: String? = null,
-    description: String? = null,
-    compatiblePackages: Set<CompatiblePackage>? = null,
-    dependencies: Set<PatchClass>? = null,
-    use: Boolean = true,
-    // TODO: Remove this property, once integrations are coupled with patches.
-    requiresIntegrations: Boolean = false,
-) : Patch<BytecodeContext>(name, description, compatiblePackages, dependencies, use, requiresIntegrations)