CodeNationDev/SwiftPowerStorage

Core of SimplyLogger product

Installation

Add the package to Xcode usign following url

https://github.com/CodeNationDev/SwiftPowerStorage.git

Definition & Interface

Main class

public class SPSManager: NSObject

Functions

Save

public func saveParameter<T: Codable>(forKey: String, object: T, completionHandler: ((Bool, T?)->(Void))? = nil)

Load

public func loadParameter<T:Codable>(forKey: String, type: T.Type) -> T?

Remove

public func removeParameter(forKey: String) -> String?

Usage example

Create manager

//
import UIKit
import SwiftPowerStorage

class ViewController: UIViewController {

    let cdManager = SPSManager()

    override func viewDidLoad() {
        super.viewDidLoad()
    }

Save an object

For save an object, your object must conforms Codable protocol. Remember that all primitive types conforms Codable protocol in Swift :D .

//
import UIKit
import os.log

public struct TestOne: Codable {
    var name: String?
    var age: Int?
    var last: String?
}

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        
        let member = TestOne(name: "David", age: 39, last: "Martin Saiz")
        cdManager.saveParameter(forKey: "Member1", object: member) { (result, last) -> (Void) in
            if result {
                // do something when save is successful
            }
            if let last = last {
                // If the entity already exists and had been overwritten, here returns the last value.
            }
        }

    }
}

Use completionHandler for ensure that all activities related with save task are executed when the value is trully saved. All works about CoreDate are launched in an async DispatchQueue.

Load object

Load an object is very easy, only call the function and provide the correct type for cast the object.

 if let value = cdManager.loadParameter(forKey: "Member1", type: TestOne.self) {
            print(value)
        } else {
            print("Object not found")
        }

Remove object

You can remove an existing object calling the following function:

 if let removed = cdManager.removeParameter(forKey: "Member1") {
            print(removed)
        } else {
            print("Object not found")
        }

This function returns the value of the deleted object if the deletion was successful.

Remove database

If you need reset database to init state, call following function

if cdManager.destroyPersistenStore() {
            // do something when deletion successful
        }

Function returns boolean as deletion result.

iCloud Sync

The persistent container used by this product extends of NSPersistentCloudKitContainer, then, you can create an iCloud container, add iCloud capability and the database will shared with all your Apple products that using this feature.

public lazy var persistentContainer: NSPersistentCloudKitContainer

Version History

1.0.1

Bugfixes in removeParameter returned value. Add unit tests.

1.0.0

* Refactor to SPSManager and bugfixes.

0.0.1

* First implementation with main features.

Package Metadata

Repository: CodeNationDev/SwiftPowerStorage

Stars: 1

Forks: 0

Open issues: 0

Default branch: main

Primary language: swift

License: MIT

README: README.md