API: Deprecate CropImageContract. (#637)

CanHub · Aug 5, 2024 · 7eb3191 · 7eb3191
1 parent 1f892e4
commit 7eb3191
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/cropper/src/main/kotlin/com/canhub/cropper/CropImageContract.kt b/cropper/src/main/kotlin/com/canhub/cropper/CropImageContract.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.canhub.cropper
 
 import android.app.Activity
@@ -11,8 +13,13 @@ import androidx.activity.result.contract.ActivityResultContract
  * The UI can be customized using [CropImageOptions].
  * If you do not provide an [CropImageContractOptions.uri] in the input the user will be asked to pick an image before cropping.
  */
+@Deprecated(
+  """
+  This ActivityResultContract is deprecated.
+  Please either roll your own ActivityResultContract with the desired behavior or copy paste this.
+""",
+)
 class CropImageContract : ActivityResultContract<CropImageContractOptions, CropImageView.CropResult>() {
-  @Suppress("DEPRECATION")
   override fun createIntent(context: Context, input: CropImageContractOptions) = Intent(context, CropImageActivity::class.java).apply {
     putExtra(
       CropImage.CROP_IMAGE_EXTRA_BUNDLE,

diff --git a/cropper/src/main/kotlin/com/canhub/cropper/CropImageContractOptions.kt b/cropper/src/main/kotlin/com/canhub/cropper/CropImageContractOptions.kt
@@ -2,6 +2,12 @@ package com.canhub.cropper
 
 import android.net.Uri
 
+@Deprecated(
+  """
+  This ActivityResultContract is deprecated.
+  Please either roll your own ActivityResultContract with the desired behavior or copy paste this.
+""",
+)
 data class CropImageContractOptions(
   val uri: Uri?,
   val cropImageOptions: CropImageOptions,

diff --git a/cropper/src/test/kotlin/com/canhub/cropper/ContractTestFragment.kt b/cropper/src/test/kotlin/com/canhub/cropper/ContractTestFragment.kt
@@ -1,3 +1,5 @@
+@file:Suppress("DEPRECATION")
+
 package com.canhub.cropper
 
 import android.content.Intent

diff --git a/cropper/src/test/kotlin/com/canhub/cropper/CropImageContractTest.kt b/cropper/src/test/kotlin/com/canhub/cropper/CropImageContractTest.kt
@@ -17,6 +17,7 @@ import org.junit.Assert.assertEquals
 import org.junit.Test
 import org.junit.runner.RunWith
 
+@Suppress("DEPRECATION")
 @RunWith(AndroidJUnit4::class)
 class CropImageContractTest {