chore(release): 3.5.1 [skip ci]

## [3.5.1](https://github.com/revanced/revanced-patcher/compare/v3.5.0...v3.5.1) (2022-09-06)

### Bug Fixes

* add tests for PathOption ([d6308e1](d6308e126c))
* PathOption should be open, not sealed ([a562e47](a562e476c0))
* typo in ListOption ([3921648](392164862c))

### Performance Improvements

* make exception an object ([75d2be8](75d2be8803))

CHANGELOG.md

@@ -1,3 +1,24 @@
+## [3.5.1](https://github.com/revanced/revanced-patcher/compare/v3.5.0...v3.5.1) (2022-09-06)
+
+
+### Bug Fixes
+
+* add tests for PathOption ([d6308e1](https://github.com/revanced/revanced-patcher/commit/d6308e126c6217b098192c51b6e98bc85a8656bd))
+* PathOption should be open, not sealed ([a562e47](https://github.com/revanced/revanced-patcher/commit/a562e476c085841efbc7ee98b01d8e6bb18ed757))
+* typo in ListOption ([3921648](https://github.com/revanced/revanced-patcher/commit/392164862c83d6e76b2a2113d6f6d59fef0020d1))
+
+
+### Performance Improvements
+
+* make exception an object ([75d2be8](https://github.com/revanced/revanced-patcher/commit/75d2be88037c9cf5436ab69d92abea575409a865))
+
+# [3.5.0](https://github.com/revanced/revanced-patcher/compare/v3.4.1...v3.5.0) (2022-09-05)
+
+
+### Features
+
+* default value for `Package.versions` annotation parameter ([131dedd](https://github.com/revanced/revanced-patcher/commit/131dedd4b021fe1c3b0be49ccba4764b325770ea))
+
 ## [3.4.1](https://github.com/revanced/revanced-patcher/compare/v3.4.0...v3.4.1) (2022-09-03)
 
 

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 3.4.1
+version = 3.5.1

src/main/kotlin/app/revanced/patcher/annotation/CompatibilityAnnotation.kt

@@ -24,5 +24,5 @@ annotation class Compatibility(
 @MustBeDocumented
 annotation class Package(
     val name: String,
-    val versions: Array<String>,
+    val versions: Array<String> = [],
 )

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

@@ -2,6 +2,8 @@
 
 package app.revanced.patcher.patch
 
+import java.io.File
+import java.nio.file.Path
 import kotlin.reflect.KProperty
 
 class NoSuchOptionException(val option: String) : Exception("No such option: $option")
@@ -9,7 +11,7 @@ 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")
 
-class RequirementNotMetException : Exception("null was passed into an option that requires a value")
+object RequirementNotMetException : Exception("null was passed into an option that requires a value")
 
 /**
  * A registry for an array of [PatchOption]s.
@@ -77,7 +79,7 @@ sealed class PatchOption<T>(
     var value: T? = default
         set(value) {
             if (value == null && required) {
-                throw RequirementNotMetException()
+                throw RequirementNotMetException
             }
             if (!validator(value)) {
                 throw IllegalValueException(value)
@@ -153,7 +155,7 @@ sealed class PatchOption<T>(
     ) {
         init {
             if (default !in options) {
-                throw IllegalStateException("Default option must be an allowed options")
+                throw IllegalStateException("Default option must be an allowed option")
             }
         }
     }
@@ -189,4 +191,36 @@ sealed class PatchOption<T>(
     ) : ListOption<Int>(
         key, default, options, title, description, required, validator
     )
+
+    /**
+     * A [PatchOption] representing a [Path].
+     * @see PatchOption
+     */
+    open class PathOption(
+        key: String,
+        default: Path?,
+        title: String,
+        description: String,
+        required: Boolean = false,
+        validator: (Path?) -> Boolean = { true }
+    ) : PatchOption<Path>(
+        key, default, title, description, required, validator
+    )
+
+    /**
+     * A [PathOption] of type [File].
+     * @see PathOption
+     */
+    class FileOption(
+        key: String,
+        default: File?,
+        title: String,
+        description: String,
+        required: Boolean = false,
+        validator: (File?) -> Boolean = { true }
+    ) : PathOption(
+        key, default?.toPath(), title, description, required, {
+            validator(it?.toFile())
+        }
+    )
 }

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

@@ -3,6 +3,7 @@ package app.revanced.patcher.patch
 import app.revanced.patcher.usage.bytecode.ExampleBytecodePatch
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.assertThrows
+import java.io.File
 import kotlin.test.assertNotEquals
 
 internal class PatchOptionsTest {
@@ -30,6 +31,9 @@ internal class PatchOptionsTest {
                         println(choice)
                     }
                 }
+                is PatchOption.PathOption -> {
+                    option.value = File("test.txt").toPath()
+                }
             }
         }
         val option = options["key1"]

src/test/kotlin/app/revanced/patcher/usage/bytecode/ExampleBytecodePatch.kt

@@ -32,6 +32,7 @@ import org.jf.dexlib2.immutable.reference.ImmutableFieldReference
 import org.jf.dexlib2.immutable.reference.ImmutableStringReference
 import org.jf.dexlib2.immutable.value.ImmutableFieldEncodedValue
 import org.jf.dexlib2.util.Preconditions
+import java.io.File
 
 @Patch
 @Name("example-bytecode-patch")
@@ -177,5 +178,8 @@ class ExampleBytecodePatch : BytecodePatch(listOf(ExampleFingerprint)) {
         PatchOption.IntListOption(
             "key4", 1, listOf(1, 2, 3), "title", "description"
         ),
+        PatchOption.PathOption(
+            "key5", File("test.txt").toPath(), "title", "description"
+        ),
     )
 }