Storage result to swift result (#41)

* fix broken provisioning profiles

* fix broken embedded framework

* remove LocksmithError

* move storage files

* rename CelySecureStatus to CelyStorageError

* port over to Swift Result

* rename CelyStorageStatus.success to CelyStorageStatus.noError

* skeleton for verbosity cely flag

* Refactored code to throw inside of internal classes but still return `Result` with public facing methods

Author: initFabian

.gitignore

@@ -63,4 +63,6 @@ fastlane/report.xml
 fastlane/Preview.html
 fastlane/screenshots
 fastlane/test_output
-docs/
+docs/
+
+Cely.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

Cely Demo/AppDelegate.swift

@@ -17,7 +17,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         Cely.setup(with: window!, forModel: User(), requiredProperties: [.token], withOptions: [
             .loginCompletionBlock: { (username: String, password: String) in
                 if username == "asdf", password == "asdf" {
-                    if User.save("FAKETOKEN:\(username)\(password)", as: .token) == .success {
+                    if case .success = User.save("FAKETOKEN:\(username)\(password)", as: .token) {
                         Cely.changeStatus(to: .loggedIn)
                     }
                 }

Cely Demo/Cely Demo.entitlements

@@ -4,7 +4,7 @@
 <dict>
 	<key>keychain-access-groups</key>
 	<array>
-		<string>$(AppIdentifierPrefix)com.cely.Cely-Demo</string>
+		<string>$(AppIdentifierPrefix)com.cely-tools.Cely-Demo</string>
 	</array>
 </dict>
 </plist>

Cely Demo/User.swift

@@ -33,7 +33,7 @@ struct User: CelyUser {
             }
         }
 
-        @discardableResult func save(_ value: Any) -> StorageResult {
+        @discardableResult func save(_ value: Any) -> Result<Void, Error> {
             return Cely.save(value, forKey: rawValue, securely: securely(), persisted: persisted())
         }
 
@@ -46,7 +46,7 @@ struct User: CelyUser {
 // MARK: - Save/Get User Properties
 
 extension User {
-    @discardableResult static func save(_ value: Any, as property: Property) -> StorageResult {
+    @discardableResult static func save(_ value: Any, as property: Property) -> Result<Void, Error> {
         return property.save(value)
     }
 

Cely.xcodeproj/project.pbxproj

@@ -21,6 +21,11 @@ public struct Cely {
     /// A Completion Block that is expecting a `username:String` and a `password:String`
     public static var loginCompletionBlock: CelyLoginCompletion?
 
+    // TODO: decide on having a verbosity CelyOption flag.
+    // There's some errors (`.itemNotFound`) that are expected to happen and
+    // I'm not sure if I want to silence them
+    internal static var verbosity = false
+
     /// Sets up Cely within your application
     ///
     /// - parameter window:             `UIWindow` of your application.
@@ -84,8 +89,14 @@ extension Cely {
     /// - parameter persist: `Boolean`: Keep data after logout
     ///
     /// - returns: `Boolean`: Whether or not your value was successfully set.
-    @discardableResult public static func save(_ value: Any?, forKey key: String, toStorage store: CelyStorageProtocol = store, securely secure: Bool = false, persisted persist: Bool = false) -> StorageResult {
-        return store.set(value, forKey: key, securely: secure, persisted: persist)
+    @discardableResult
+    public static func save(_ value: Any?, forKey key: String, toStorage store: CelyStorageProtocol = store, securely secure: Bool = false, persisted persist: Bool = false) -> Result<Void, Error> {
+        do {
+            try store.set(value, forKey: key, securely: secure, persisted: persist)
+            return .success(())
+        } catch {
+            return .failure(error)
+        }
     }
 
     /// Perform action like `LoggedIn` or `LoggedOut`
@@ -98,9 +109,15 @@ extension Cely {
     /// Log user out
     ///
     /// - parameter store: Storage `Cely` will be using. Defaulted to `CelyStorageProtocol`
-    public static func logout(useStorage store: CelyStorageProtocol = store) {
-        store.removeAllData()
-        changeStatus(to: .loggedOut)
+    @discardableResult
+    public static func logout(useStorage store: CelyStorageProtocol = store) -> Result<Void, Error> {
+        do {
+            try store.clearStorage()
+            changeStatus(to: .loggedOut)
+            return .success(())
+        } catch {
+            return .failure(error)
+        }
     }
 
     /// Returns whether or not the user is logged in
@@ -110,3 +127,11 @@ extension Cely {
         return currentLoginStatus() == .loggedIn
     }
 }
+
+internal extension Cely {
+    static func debugPrint(str: CustomStringConvertible) {
+        if verbosity {
+            print(str)
+        }
+    }
+}

Sources/Cely.swift

@@ -23,36 +23,13 @@ public enum CelyStatus: CelyCommands {
 /// Options that you can pass into Cely on `Cely.setup(_:)`
 public enum CelyOptions {
     case storage
-    @available(*, deprecated, renamed: "homeViewController", message: "We will no longer support UIStoryboard as a way to instantiate ViewControllers.")
-    case homeStoryboard
-    @available(*, deprecated, renamed: "loginViewController", message: "We will no longer support UIStoryboard as a way to instantiate ViewControllers.")
-    case loginStoryboard
     case homeViewController
     case loginViewController
     case loginCompletionBlock
     case loginStyle
     case celyAnimator
 }
 
-// enum result on whether or not Cely successfully saved your data
-public enum StorageResult: Equatable {
-    case success
-    case fail(LocksmithError)
-}
-
-public func == (lhs: StorageResult, rhs: StorageResult) -> Bool {
-    switch (lhs, rhs) {
-    case let (.fail(error1), .fail(error2)):
-        return error1 == error2
-
-    case (.success, .success):
-        return true
-
-    default:
-        return false
-    }
-}
-
 internal extension UITextField {
     @IBInspectable var leftSpacer: CGFloat {
         get {

Sources/CelyConstants.swift

@@ -16,9 +16,9 @@ public protocol CelyUser {
 
 /// Protocol a storage class must abide by in order for Cely to use it
 public protocol CelyStorageProtocol {
-    func set(_ value: Any?, forKey key: String, securely secure: Bool, persisted persist: Bool) -> StorageResult
+    func set(_ value: Any?, forKey key: String, securely secure: Bool, persisted persist: Bool) throws
     func get(_ key: String) -> Any?
-    func removeAllData()
+    func clearStorage() throws
 }
 
 /// Protocol that allows styles to be applied to Cely's default LoginViewController