Refactoring: Remove unused function, duplicate documentation & leverage named arguments. (#514)

Author: vanniktech

cropper/src/main/kotlin/com/canhub/cropper/BitmapLoadingWorkerJob.kt

@@ -3,7 +3,6 @@ package com.canhub.cropper
 import android.content.Context
 import android.graphics.Bitmap
 import android.net.Uri
-import com.canhub.cropper.utils.getFilePathFromUri
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
@@ -96,7 +95,6 @@ internal class BitmapLoadingWorkerJob internal constructor(
   internal companion object class Result {
     /**
      * The Android URI of the image to load.
-     * NOT a file path, for it use [getUriFilePath]
      */
     val uriContent: Uri
 
@@ -118,16 +116,6 @@ internal class BitmapLoadingWorkerJob internal constructor(
     /** The error that occurred during async bitmap loading. */
     val error: Exception?
 
-    /**
-     * The file path of the image to load
-     *
-     * [context] used to access Android APIs, like content resolve, it is your activity/fragment/widget.
-     * [uniqueName] If true, make each image cropped have a different file name, this could
-     * cause memory issues, use wisely. [Default: false]
-     */
-    fun getUriFilePath(context: Context, uniqueName: Boolean = false): String =
-      getFilePathFromUri(context, uriContent, uniqueName)
-
     internal constructor(
       uri: Uri,
       bitmap: Bitmap?,

cropper/src/main/kotlin/com/canhub/cropper/CropImageActivity.kt

@@ -407,14 +407,14 @@ open class CropImageActivity : AppCompatActivity(), OnSetImageUriCompleteListene
    */
   open fun getResultIntent(uri: Uri?, error: Exception?, sampleSize: Int): Intent {
     val result = CropImage.ActivityResult(
-      cropImageView?.imageUri,
-      uri,
-      error,
-      cropImageView?.cropPoints,
-      cropImageView?.cropRect,
-      cropImageView?.rotatedDegrees ?: 0,
-      cropImageView?.wholeImageRect,
-      sampleSize,
+      originalUri = cropImageView?.imageUri,
+      uriContent = uri,
+      error = error,
+      cropPoints = cropImageView?.cropPoints,
+      cropRect = cropImageView?.cropRect,
+      rotation = cropImageView?.rotatedDegrees ?: 0,
+      wholeImageRect = cropImageView?.wholeImageRect,
+      sampleSize = sampleSize,
     )
     val intent = Intent()
     intent.extras?.let(intent::putExtras)

cropper/src/main/kotlin/com/canhub/cropper/CropImageView.kt

@@ -1755,7 +1755,7 @@ class CropImageView @JvmOverloads constructor(
      *
      * [context] used to access Android APIs, like content resolve, it is your activity/fragment/widget.
      * [uniqueName] If true, make each image cropped have a different file name, this could
-     * cause memory issues, use wisely. [Default: false]
+     * cause memory issues, use wisely.
      */
     fun getUriFilePath(context: Context, uniqueName: Boolean = false): String? =
       uriContent?.let { getFilePathFromUri(context, it, uniqueName) }

cropper/src/main/kotlin/com/canhub/cropper/utils/GetFilePathFromUri.kt

@@ -13,19 +13,6 @@ import java.text.SimpleDateFormat
 import java.util.Date
 import java.util.Locale.getDefault
 
-/**
- * This class will create a temporary file in the cache if you need.
- *
- * When the uri already have `file://` schema we don't need to create a new file.
- * The temporary file will always override a previous one, saving memory.
- * Using the cache memory(context.cacheDir) we guarantee to not leak memory
- *
- * [context] used to access Android APIs, like content resolve, it is your activity/fragment.
- * [uri] the URI to load the image from.
- * [uniqueName] If true, make each image cropped have a different file name, this could cause memory issues, use wisely.
- *
- * @return string value of the File path.
- */
 internal fun getFilePathFromUri(context: Context, uri: Uri, uniqueName: Boolean): String =
   if (uri.path?.contains("file://") == true) {
     uri.path!!