README.md

iOS Components - Storage

In the pursuit of improving iOS codebase and migrate to new iOS architecture, we need to document each used component to be able to improve it and consolidate our foundations. This one defines our storage components.

---

Storage is a database wrapper that provides functional through ClientType. Ideally for each type of Entity will have its ClientType.

Each ClientType will define the specific fetch, persis or update depend on the business logic required

The template for this idea above may look like:

• Each EnityType will represent the data table

public protocol BrandEntityType {
    var brandId: String { get }
    var image: String { get set}
    var keywords: String { get set}
    var name: String { get set}
}

• So each EntityType will have ClientType represent functions to access that table like save, get data by ID, delete, etc.

public protocol BrandClientType {
    func save(_ entity: BrandEntityType, for nameSpace: String) throws
    func getBrandByLanguage(_ language: String) throws -> [BrandEntityType]?
    func clearBrandBy(_ language: String) throws
    func delete(_ id: String) throws -> Int
}

public protocol ClientType {
    var brand: BrandClientType { get }
}

The Context will make the appropriate query to the database base on these ClientType's function

extension StorageContext: BrandClientType {
    public func delete(_ id: String) throws -> Int {
        return try dbQueue.inDatabase({ db in
            try Brand.filter(Column("brandId") == id).deleteAll(db)
        })
    }
    
    public func save(_ entity: Brand, for nameSpace: String) throws {
        try dbQueue.inDatabase({ db in
            try entity.insert(db)
        })
    }

    public func getBrandByLanguage(_ language: String) throws -> [BrandClientType]? {
        return try dbQueue.inDatabase { db in
            try Brand.fetchAll(db)
        }
    }
    
    public func clearBrandBy(_ language: String) throws  {
        try dbQueue.inDatabase { db in
            _ = try Brand.filter(Column("language") == language).deleteAll(db)
        }
    }
}

To use it in the main app, just make the call through the client

let brand = Brand(...)
try Storage.shared.storageContext?.brand.save(brand)

Storage wrapper with GRDB

Storage