chore(release): 3.2.0 [skip ci]

# [3.2.0](https://github.com/revanced/revanced-patcher/compare/v3.1.0...v3.2.0) (2022-08-02)

### Features

* PatchOptions#nullify to nullify an option ([371f0c4](371f0c4d0b))

CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.2.0](https://github.com/revanced/revanced-patcher/compare/v3.1.0...v3.2.0) (2022-08-02)
+
+
+### Features
+
+* PatchOptions#nullify to nullify an option ([371f0c4](https://github.com/revanced/revanced-patcher/commit/371f0c4d0bf96e7f6db35085efccaed3000a096c))
+
 # [3.1.0](https://github.com/revanced/revanced-patcher/compare/v3.0.0...v3.1.0) (2022-08-02)
 
 

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 3.1.0
+version = 3.2.0

src/main/kotlin/app/revanced/patcher/patch/PatchOption.kt

@@ -1,13 +1,16 @@
+@file:Suppress("CanBeParameter", "MemberVisibilityCanBePrivate")
+
 package app.revanced.patcher.patch
 
-@Suppress("CanBeParameter", "MemberVisibilityCanBePrivate")
 class NoSuchOptionException(val option: String) : Exception("No such option: $option")
+class IllegalValueException(val value: Any?) : Exception("Illegal value: $value")
+class InvalidTypeException(val got: String, val expected: String) :
+    Exception("Invalid option value type: $got, expected $expected")
 
 /**
  * A registry for an array of [PatchOption]s.
  * @param options An array of [PatchOption]s.
  */
-@Suppress("MemberVisibilityCanBePrivate")
 class PatchOptions(vararg val options: PatchOption<*>) : Iterable<PatchOption<*>> {
     private val register = buildMap {
         for (option in options) {
@@ -31,13 +34,22 @@ class PatchOptions(vararg val options: PatchOption<*>) : Iterable<PatchOption<*>
      * Please note that using the wrong value type results in a runtime error.
      */
     inline operator fun <reified T> set(key: String, value: T) {
-        @Suppress("UNCHECKED_CAST") val opt = get(key) as? PatchOption<T>
-        if (opt == null || opt.value !is T) throw IllegalArgumentException(
-            "The type of the option value is not the same as the type value provided"
+        @Suppress("UNCHECKED_CAST") val opt = get(key) as PatchOption<T>
+        if (opt.value !is T) throw InvalidTypeException(
+            T::class.java.canonicalName,
+            opt.value?.let { it::class.java.canonicalName } ?: "null"
         )
         opt.value = value
     }
 
+    /**
+     * Sets the value of a [PatchOption] to `null`.
+     * @param key The key of the [PatchOption].
+     */
+    fun nullify(key: String) {
+        get(key).value = null
+    }
+
     override fun iterator() = options.iterator()
 }
 
@@ -61,7 +73,7 @@ sealed class PatchOption<T>(
     var value: T? = default
         set(value) {
             if (!validator(value)) {
-                throw IllegalArgumentException("Illegal value: $value")
+                throw IllegalValueException(value)
             }
             field = value
         }

src/test/kotlin/app/revanced/patcher/patch/PatchOptionsTest.kt

@@ -36,6 +36,15 @@ internal class PatchOptionsTest {
         println(options["key1"].value)
     }
 
+    @Test
+    fun `should be able to set value to null`() {
+        // Sadly, doing:
+        // > options["key1"] = null
+        // is not possible because Kotlin
+        // cannot reify the type "Nothing?".
+        options.nullify("key1")
+    }
+
     @Test
     fun `should fail because the option does not exist`() {
         assertThrows<NoSuchOptionException> {
@@ -45,14 +54,14 @@ internal class PatchOptionsTest {
 
     @Test
     fun `should fail because of invalid value type`() {
-        assertThrows<IllegalArgumentException> {
+        assertThrows<InvalidTypeException> {
             options["key1"] = 123
         }
     }
 
     @Test
     fun `should fail because of an illegal value`() {
-        assertThrows<IllegalArgumentException> {
+        assertThrows<IllegalValueException> {
             options["key3"] = "this value is not an allowed option"
         }
     }