https://github.com/YR/Cachyr

A small key-value data cache for iOS, macOS and tvOS, written in Swift.
https://github.com/YR/Cachyr

Last synced: 3 months ago
JSON representation

A small key-value data cache for iOS, macOS and tvOS, written in Swift.

• Host: GitHub
• URL: https://github.com/YR/Cachyr
• Owner: nrkno
• License: mit
• Created: 2016-12-09T12:31:34.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-12-01T11:35:08.000Z (almost 4 years ago)
• Last Synced: 2024-08-03T08:02:32.937Z (3 months ago)
• Language: Swift
• Size: 86.9 KB
• Stars: 126
• Watchers: 14
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cachyr

A typesafe key-value data cache for iOS, macOS, tvOS and watchOS written in Swift.

There already exists plenty of cache solutions, so why create one more? We had a few requirements where existing solutions fulfilled some of them but not all:

- Written purely in Swift 3.

- Type safety while still allowing any kind of data to be stored.

- Disk and memory caching.

- Easy way to populate cache when a lookup results in a cache miss.

- Clean, single-purpose implementation. Do caching and nothing else.

## Installation

### CocoaPods

```

Add to Podfile:

pod 'Cachyr'

Then:

$ pod install

```

### Swift Package Manager

The [Swift Package Manager](https://swift.org/package-manager/) is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

To integrate `Cachyr` into your Xcode project using Xcode 11, specify it in `File > Swift Packages > Add`:

```

https://github.com/nrkno/yr-cachyr

```

### Manual

Clone the repo somewhere suitable, like inside your project repo so Cachyr can be added as a subrepo, then drag `Cachyr.xcodeproj` into your project.

Alternatively build the framework and add it to your project.

## Usage

```swift

let cache = DataCache()

let key = "foo"

let text = "bar"

cache.setValue(text, for: key)

// ... do important things ...

let cachedText: String? = cache.value(for: key)

// Or asynchronously

let cachedText = cache.value(for: key) { (value: String?) in

    // Do something with value

}

```

In this example the string `bar` is stored in the cache for the key `foo`. It is later retrieved as a string optional by explicitly declaring `String?` as the value type. Let's look at how generics enable easy data transformation.

```swift

let textAsData = cache.value(for: key) { (value: Data?) in

    print(value)

}

```

Now the exact same key is used to retrieve the data representation of the value. The cache stores everything as data, and by implementing the `DataConvertable` protocol for a type it is possible to convert the cached data to the return type you define when retrieving a value.

There are default `DataConvertable` implementations for `Data`, `String`, `Int` (all integer types), `Float` and `Double`.

For detailed usage examples take a look at [Usage.md](./Docs/Usage.md).

## ToDo

This framework is production ready but there are still many possible improvements. Some known tasks are:

- Better thread synchronization. The cache uses serial dispatch queues to handle concurrent access and memory/disk value synchronization. This makes the code easy to follow and reason about, but it is not as performant as a solution using the multiple reader single writer pattern. We tried using concurrent dispatch queues with dispatch barriers for cache updates, but it got messy and code readability suffered. In early development serial queues were the way to go, but there is room for improvement.

- Limit for disk usage. The disk cache has no limit on how much data it stores.

- Default `DataConvertable` support more common types.

Pull requests are very welcome.