improve identifiable documentation

netreconlab · Jul 13, 2024 · 3ac52ed · 3ac52ed
1 parent 71ff26d
commit 3ac52ed
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 32 deletions.
diff --git a/Sources/ParseSwift/Objects/ParseObject.swift b/Sources/ParseSwift/Objects/ParseObject.swift
@@ -172,16 +172,6 @@ public protocol ParseObject: ParseTypeable,
 // MARK: Default Implementations
 public extension ParseObject {
 
-    /**
-     A computed property that is a unique identifier and makes it easy to use `ParseObject`'s
-     as models in MVVM and SwiftUI.
-     - note: `id` allows `ParseObject`'s to be used even if they have not been saved and/or missing an `objectId`.
-     - important: `id` will have the same value as `objectId` when a `ParseObject` contains an `objectId`.
-    */
-    var id: String {
-        objectId ?? UUID().uuidString
-    }
-
     var mergeable: Self {
         guard isSaved,
             originalData == nil else {
@@ -245,6 +235,20 @@ extension ParseObject {
     }
 }
 
+// MARK: Identifiable
+public extension ParseObject {
+
+    /**
+     A computed property that ensures `ParseObject`'s can be uniquely identified across instances.
+     - note: `id` allows `ParseObject`'s to be uniquely identified even if they have not been saved and/or missing an `objectId`.
+     - important: `id` will have the same value as `objectId` when a `ParseObject` contains an `objectId`.
+     */
+    var id: String {
+        objectId ?? UUID().uuidString
+    }
+
+}
+
 // MARK: Helper Methods
 public extension ParseObject {
     /**

diff --git a/Sources/ParseSwift/Types/ParseFile.swift b/Sources/ParseSwift/Types/ParseFile.swift
@@ -22,28 +22,6 @@ public struct ParseFile: Fileable, Savable, Deletable, Hashable, Identifiable {
             && data == nil
     }
 
-    /**
-     A computed property that is a unique identifier and makes it easy to use `ParseFile`'s
-     as models in MVVM and SwiftUI.
-     - note: `id` allows `ParseFile`'s to be used even when they are  not saved.
-     - important: `id` will have the same value as `name` when a `ParseFile` is saved.
-    */
-    public var id: String {
-        guard isSaved else {
-            guard let cloudURL = cloudURL else {
-                guard let localURL = localURL else {
-                    guard let data = data else {
-                        return name
-                    }
-                    return "\(name)_\(data)"
-                }
-                return combineName(with: localURL)
-            }
-            return combineName(with: cloudURL)
-        }
-        return name
-    }
-
     /**
       The name of the file.
       Before the file is saved, this is the filename given by the user.
@@ -170,6 +148,30 @@ public struct ParseFile: Fileable, Savable, Deletable, Hashable, Identifiable {
     }
 }
 
+// MARK: Identifiable
+extension ParseFile {
+    /**
+     A computed property that ensures `ParseFile`'s can be uniquely identified across instances.
+     - note: `id` allows `ParseFile`'s to be uniquely identified even if they have not been saved.
+     - important: `id` will have the same value as `objectId` when a `ParseObject` contains an `objectId`.
+    */
+    public var id: String {
+        guard isSaved else {
+            guard let cloudURL = cloudURL else {
+                guard let localURL = localURL else {
+                    guard let data = data else {
+                        return name
+                    }
+                    return "\(name)_\(data)"
+                }
+                return combineName(with: localURL)
+            }
+            return combineName(with: cloudURL)
+        }
+        return name
+    }
+}
+
 // MARK: Helper Methods (internal)
 extension ParseFile {
     func combineName(with url: URL) -> String {