Merge pull request #73 from claucambra/bugfix/improve-delete-api

Improve readability of item deletion procedure

Author: claucambra

Sources/NextcloudFileProviderKit/Item/Item+Delete.swift

@@ -12,11 +12,9 @@ import NextcloudKit
 import OSLog
 
 public extension Item {
-    // NOTE: the trashing metadata modification procedure here is rough. You SHOULD run a rescan of
-    // the trash in order to ensure you are getting a correct picture of the item's current remote
-    // state! This is important particularly for receiving the correct trash bin filename in case of
-    // there being a previous item in the trash with the same name, prompting the server to rename
-    // the newly-trashed target item
+    // NOTE: The trashing parameter does not affect whether the server will trash this or not.
+    // That's out of our hands. Instead, this is used internally to properly handle the metadata
+    // update automatically when we conduct a move of an item to the trash.
     func delete(
         trashing: Bool = false,
         domain: NSFileProviderDomain? = nil,
@@ -83,45 +81,59 @@ public extension Item {
             """
         )
 
-        guard !trashing else {
-            if self.metadata.directory {
-                _ = dbManager.renameDirectoryAndPropagateToChildren(
-                    ocId: ocId,
-                    newServerUrl: account.trashUrl,
-                    newFileName: filename
-                )
-            } else {
-                dbManager.renameItemMetadata(
-                    ocId: ocId, newServerUrl: account.trashUrl, newFileName: filename
-                )
-            }
-
-            guard var metadata = dbManager.itemMetadata(ocId: ocId) else {
-                Self.logger.warning(
-                    """
-                    Could not find item metadata for \(self.filename, privacy: .public)
-                    \(self.itemIdentifier.rawValue, privacy: .public)!
-                    Cannot finish trashing procedure.
-                    """
-                )
-                return NSFileProviderError(.cannotSynchronize)
-            }
-            metadata.trashbinFileName = filename
-            metadata.trashbinDeletionTime = Date()
-            metadata.trashbinOriginalLocation =
-                String(self.metadata.serverUrl + "/" + filename).replacingOccurrences(
-                    of: account.davFilesUrl + "/", with: ""
-                )
-
-            dbManager.addItemMetadata(metadata)
-
+        guard trashing else {
+            handleMetadataDeletion()
             return nil
         }
+        return handleMetadataTrashModification()
+    }
+
+    private func handleMetadataDeletion() {
+        let ocId = metadata.ocId
         if self.metadata.directory {
             _ = dbManager.deleteDirectoryAndSubdirectoriesMetadata(ocId: ocId)
         } else {
             dbManager.deleteItemMetadata(ocId: ocId)
         }
+    }
+
+    // NOTE: the trashing metadata modification procedure here is rough. You SHOULD run a rescan of
+    // the trash in order to ensure you are getting a correct picture of the item's current remote
+    // state! This is important particularly for receiving the correct trash bin filename in case of
+    // there being a previous item in the trash with the same name, prompting the server to rename
+    // the newly-trashed target item
+    private func handleMetadataTrashModification() -> Error? {
+        let ocId = metadata.ocId
+        if metadata.directory {
+            _ = dbManager.renameDirectoryAndPropagateToChildren(
+                ocId: ocId,
+                newServerUrl: account.trashUrl,
+                newFileName: filename
+            )
+        } else {
+            dbManager.renameItemMetadata(
+                ocId: ocId, newServerUrl: account.trashUrl, newFileName: filename
+            )
+        }
+
+        guard var metadata = dbManager.itemMetadata(ocId: ocId) else {
+            Self.logger.warning(
+                """
+                Could not find item metadata for \(self.filename, privacy: .public)
+                    \(self.itemIdentifier.rawValue, privacy: .public)!
+                    Cannot finish trashing procedure.
+                """
+            )
+            return NSFileProviderError(.cannotSynchronize)
+        }
+        metadata.trashbinFileName = filename
+        metadata.trashbinDeletionTime = Date()
+        metadata.trashbinOriginalLocation =
+            String(self.metadata.serverUrl + "/" + filename).replacingOccurrences(
+                of: account.davFilesUrl + "/", with: ""
+            )
+
+        dbManager.addItemMetadata(metadata)
         return nil
     }
 }