Depot

KO | EN

gitlite — search

#javascript #php #python #java #ruby #hacktoberfest #linux #r #angularjs #deprecated #yeoman #monitoring

★ 30 Open GitHub ↗

Struct Persistence framework for Swift

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Depot
Struct persistance framework for Swift. Simple as that:

```swift
let myStruct = MyStruct(...)

Depot.persist(myStruct, "cached_data")

if let retrievedStruct: MyStruct = Depot.retrieved("cached_data") {
  print("MyStruct is retrieved",unpackedCustomStruct)
} else {
  print("no struct retrieved")
}
```
## Features:

Depot can store differnet types:

* [x] Structs
* [x] Arrays of structs
* [x] Nested structs
* [x] Enums with raw types

## Installation

Installation for [CocoaPods](https://cocoapods.org) by adding the following line to your Podfile:

```ruby
use_frameworks!

pod 'Depot'
```

## Usage

### Structs

To support persisting struct, a struct needs to implement `PropertyListReadable` protocol which includes the following functions:
```swift
init?(storehouse: Storehousable)
func propertyListRepresentation() -> [String: AnyObject]
```

`init` method that gets each property from the storehouse, and a `propertyListRepresentation` method that converts structs to Sictionary that can persisted:

```swift
struct Person: PropertyListReadable {
    let name: String
    let age: Float
    let id: Int
    
    init(name: String, age: Float, id: Int) {
        self.name = name
        self.age = age
        self.id = id
    }
    
    init?(storehouse: Storehousable) {
        self.name = storehouse.read(key: "name") ?? ""
        self.age = storehouse.read(key: "age") ?? 25.5
        self.id = storehouse.read(key: "id") ?? 22
    }
    
    func propertyListRepresentation() -> [String : AnyObject] {
        return [ "name": self.name, "age": self.age, "id": self.id ]
    }
}
```
## License

Depot made available under the MIT license.

## Credits

Depot is brought to you by [Sameh Mabrouk](http://isame7.github.io/)

[mabrouksameh@gmail.com][2]

[@same7mabrouk][3]

[2]: mailto:mabrouksameh@gmail.com
  [3]: http://twitter.com/same7mabrouk

Depot

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README