• Stars
    star
    377
  • Rank 113,535 (Top 3 %)
  • Language
    Swift
  • License
    Other
  • Created over 5 years ago
  • Updated 10 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

๐Ÿ—ณEasy data persistence in Swift

โค๏ธ Support my apps โค๏ธ

โค๏ธโค๏ธ๐Ÿ˜‡๐Ÿ˜๐Ÿค˜โค๏ธโค๏ธ

CI Status Version Carthage Compatible SPM compatible License Platform Swift

Description

EasyStash is an easy and lightweight persistence framework in Swift. With simple abstraction over NSCache and FileManager, it saves us from tedious work of saving and loading objects. There are no clever async, expiry handling or caching strategy for now, just save and load.

  • Swift 5
  • Support iOS, macOS, tvOS, watchOS
  • Synchronous APIs with explicit try catch
  • Persist UIImage/NSImage
  • Persist Codable objects, including primitive types
  • Persist Data
  • Test coverage

Usage

The main and only class is Storage which encapsulates memory and disk cache. All operations involving disk are error prone, we need to handle error explicitly.

With Options, we can customize folder name, searchPathDirectory, encoder and decoder for Codable. By default, folder and searchPathDirectory specify that files will be saved at /Library/Application Support/{BUNDLE_ID}/Default/

var storage: Storage? = nil

var options: Options = Options()
options.folder = "Users"

storage = try? Storage(options: options)

do {
    try storage?.save(image, forKey: "image")
    try storage?.save(users, forKey: "codable")
} catch {
    print(error)
}

Memory cache is checked first before doing disk operations, so we won't hit disk that often.

Saving and loading images

Works for both UIImage and NSImage. Because image and data loading uses the same signatures, we need to explicitly specify type

try storage.save(image, forKey: "image")
let loadedImage: UIImage = try storage.load(forKey: "image")

Saving and loading Codable objects

Uses JSONEncoder and JSONDecoder under the hood to serialize and deserialize to and from Data

let user = User(name: "A", age: 10)
let cities = [City(name: "Oslo"), City(name: "New York")]

try storage.save(users, forKey: "user")
try storage.save(cities, forKey: "cities")

let loadedUser = try storage.load(forKey: "user", as: User.self)
let loadedCities = try storage.load(forKey: "cities", as: [City].self)

Saving and loading Data

try storage.save(object: data, forKey: "data")
let loadedData: Data = try storage.load(forKey: "data")

Saving and loading primitives

Although primitives like Int, String, Bool conform to Codable, they can't be serialized into Data using JSONEncoder because json needs root object. This framework handles this case, so you can just save and load as normal

try storage.save(100, forKey: "an int")
try storage.save(isLoggedIn, forKey: "a boolean")

Folder informations

EasyStash includes some helpful functions to check file and folder within its Storage.

Check if file exists

try storage.exists(forKey: "has_updated_profile")

Remove file

try storage.remove(forKey: "a flag")

Remove all files

try storage.removeAll()

List all files. Each file has name, url, modificationDate and size information

let files = try storage.files()

Check folder size

let size = try storage.folderSize()

Check if folder has content

try storage.isEmpty()

Remove files based on predicate. This is useful when we want to clear expired objects, or objects based certain criteria.

try storage.removeAll(predicate: { $0.modificationDate < migrationDate })

Async

EasyStash is designed to be synchronous. If we want to do async, it's easy as using DispatchQueue

DispatchQueue.global().async {
    do {
        try storage.save(largeImage, forKey: "large_image")
    } catch {

    }
}

Installation

EasyStash is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'EasyStash'

EasyStash is also available through Carthage. To install just write into your Cartfile:

github "onmyway133/EasyStash"

EasyStash is also available through Swift Package Manager. Add EasyStash as a dependency to your Package.swift. For more information, please see the Swift Package Manager documentation.

.package(url: "https://github.com/onmyway133/EasyStash", from: "1.1.8")

EasyStash can also be installed manually. Just download and drop Sources folders in your project.

Author

Khoa Pham, [email protected]

Contributing

We would love you to contribute to EasyStash, check the CONTRIBUTING file for more info.

License

EasyStash is available under the MIT license. See the LICENSE file for more info.

More Repositories

1

awesome-ios-animation

โ˜” A collection of iOS animation repos
5,305
star
2

awesome-ios-architecture

๐Ÿฏ Better ways to structure iOS apps
5,056
star
3

PushNotifications

๐Ÿ‰ A macOS, Linux, Windows app to test push notifications on iOS and Android
JavaScript
2,230
star
4

DeepDiff

๐Ÿฆ€Amazingly incredible extraordinary lightning fast diffing in Swift
Swift
2,049
star
5

IconGenerator

๐Ÿฑ A macOS app to generate app icons
JavaScript
1,403
star
6

RoughSwift

๐ŸŽƒ Create hand-drawn, sketchy, comic shape in Swift
Swift
1,104
star
7

FinderGo

๐Ÿข Open terminal quickly from Finder
Swift
1,084
star
8

Snowflake

โ„๏ธ SVG in Swift
Swift
956
star
9

GifCapture

๐Ÿ‡ Gif capture app for macOS
Swift
916
star
10

awesome-machine-learning

๐ŸŽฐ A curated list of machine learning resources, preferably CoreML
794
star
11

Swiftlane

๐Ÿš€ Build utilities in pure Swift
Swift
692
star
12

blog

๐Ÿ What you don't know is what you haven't learned
666
star
13

awesome-swiftui

๐ŸŒฎ Awesome resources, articles, libraries about SwiftUI
642
star
14

EasyConfetti

๐ŸŽŠ Fancy confetti effects in Swift
Swift
561
star
15

XcodeWay

โ›ต An Xcode Source Editor Extension that helps navigating to many places easier
Swift
550
star
16

Smile

๐Ÿ˜„ Emoji in Swift
Swift
512
star
17

EasyAnchor

โš“๏ธ Declarative, extensible, powerful Auto Layout
Swift
455
star
18

Scale

๐ŸŽ Unit converter in Swift
Swift
323
star
19

EasyDropdown

๐Ÿ’ง Fantastic dropdown in Swift
Swift
309
star
20

XcodeColorSense2

๐Ÿ‰ An Xcode source editor extension that shows hex color info
Swift
285
star
21

Arcane

๐Ÿ”ฑ CommonCrypto in Swift, and more
Swift
283
star
22

awesome-android-animation

๐Ÿ’ฆ A collection of Android animation repos
Java
253
star
23

EasyTheme

๐Ÿ‘•๐Ÿ‘š Theme management in Swift
Swift
241
star
24

awesome-voip

๐Ÿค™Learning VoIP, RTP, pjsip and SIP
237
star
25

SwiftHash

๐Ÿ• MD5 in pure Swift
Swift
215
star
26

EasyClosure

๐Ÿฉ Unified communication patterns with easy closure in Swift
Swift
201
star
27

Github.swift

:octocat: Unofficial GitHub API client in Swift
Swift
186
star
28

emoji

โค๏ธ List of emojis
Swift
163
star
29

SwiftSnippets

๐Ÿฎ A collection of Swift snippets to be used in Xcode
Shell
162
star
30

Wave

๐ŸŒŠ Declarative chainable animations in Swift
Swift
127
star
31

awesome-online-earning

๐Ÿ’ฐWays to earn extra
124
star
32

Spek

๐ŸŽ Function builder BDD testing framework in Swift
Swift
122
star
33

FontAwesomeSwiftUI

Easy to use FontAwesome 5 in SwiftUI
Swift
97
star
34

Recipes

๐ŸฃMaking Recipes iOS app
Swift
91
star
35

MathSolver

โŒจ๏ธCamera calculator with Vision
Swift
87
star
36

XcodeColorSense

๐ŸŽˆ An Xcode plugin that makes working with color easier
Swift
77
star
37

Micro

๐ŸŽFast diffing and type safe SwiftUI style data source for UICollectionView
Swift
76
star
38

Omnia

๐Ÿ—ฟ Everything your projects need to know
Swift
62
star
39

notes

๐Ÿ“” Issues and solutions I found during development, mostly iOS
62
star
40

Sketch-Action

๐Ÿ”Ž A Sketch plugin to simulate Spotlight
Objective-C
59
star
41

MainThreadGuard

๐Ÿ’‚โ€โ™‚๏ธ Tracking UIKit access on main thread
Swift
58
star
42

EasyFake

๐Ÿคนโ€โ™€๏ธ Fake data generation in Swift
JavaScript
57
star
43

Reindeers

โ„๏ธ XML and HTML parser in Swift
Swift
55
star
44

awesome-git-commands

๐Ÿด Indispensable git commands for everyday use
55
star
45

RxLifeCycle

๐Ÿน Easy life cycle observation
Swift
53
star
46

Upstream

โ›ฒ๏ธ Adapted Data Source in Swift and a little bit more
Swift
53
star
47

BigBigNumbers

๐Ÿ”ขSay the number out loud
Swift
49
star
48

GifMagic

๐Ÿ’ˆ Gif maker and extractor in Swift
Swift
48
star
49

awesome-android-architecture

๐Ÿฐ Better ways to structure Android apps
45
star
50

AppStoreConnect

๐ŸŽ Interact with AppStoreConnect
Swift
45
star
51

TestTarget

๐Ÿณ Notes on configuring test targets
Swift
44
star
52

PhotoFeed

๐Ÿ›ต Instagram in Swift 4
Swift
43
star
53

awesome-conference-videos

๐ŸŽธ Conference videos. Visit http://learntalks.com/
40
star
54

CollectionUpdateExample

๐Ÿ›ถ Demo batch update in UITableView and UICollectionView
Swift
38
star
55

Construction

๐Ÿ‘ท The many ways to construct and configure your entity
Swift
34
star
56

PastePal

PastePal is the best universal clipboard manager for Mac, iPhone and iPad.
31
star
57

github-extended

:octocat: A Chrome extension to discover more repositories
JavaScript
30
star
58

EasyNetworking

๐Ÿ›ฐEasy networking with async/await
Swift
28
star
59

Runtime-Headers

๐Ÿ’ฟ iOS, macOS runtime headers
Objective-C
28
star
60

UsingPlayground

๐Ÿ‘ถ Demo how to use Playground
Swift
26
star
61

EasySwiftUI

๐Ÿฐ Extra sugar for SwiftUI
Swift
25
star
62

Farge

๐ŸŽˆTell the name of hex color
Swift
24
star
63

Avengers

๐Ÿ‘พDemo how to use CoreML with IBM Watson, Azure Custom Vision, Turi Create
Swift
21
star
64

ISO8601

๐ŸŽ— Super lightweight ISO8601 Date Formatter in Swift
Swift
21
star
65

SlidingMenu

๐ŸŽฟ Demo how to create sliding menu on Android
Java
20
star
66

Paramount

๐Ÿ—ผ Like Flipboard FLEX, but allows custom action
Swift
20
star
67

Codelime

Codelime is a powerful code snippet manager with many dev tools for iOS development.
19
star
68

DynamicTableViewCellHeight

๐ŸŸ Demo how to use Autolayout to make varying row height
Objective-C
18
star
69

github-chat

๐Ÿ’ฌ A Chrome extension to enable chat within GitHub
JavaScript
18
star
70

Resolver

๐ŸŽŠ A simple resolver in Swift
Swift
15
star
71

archives

๐Ÿšฃ Only deliberate practice will make you better
Objective-C
14
star
72

ParticlePlayground

๐ŸŽŠ A Swift playground to play with CAEmitterLayer
Swift
14
star
73

json_resolve

๐ŸฐEasy resolving deep json using keypath in Dart
Dart
12
star
74

Then

๐Ÿƒ Promise A+ in Swift
Swift
11
star
75

LighterAppDelegate

๐ŸŽฃ Lighter AppDelegate by dispatching events
Swift
10
star
76

Xkcd

๐Ÿฆ„ Simple Xkcd iOS app
Swift
8
star
77

Border

๐Ÿ“ Make border for all views
Swift
8
star
78

Xmas

๐ŸŽ… ๐ŸŽ„ โ›„ Xmas plugin for Xcode
Objective-C
7
star
79

github-changelogs-maker

๐Ÿป Generate changelogs between 2 latest releases
JavaScript
7
star
80

linphone-iphone

Forked from linphone.org
Objective-C
7
star
81

EasyTracker

๐Ÿ•ต๏ธ Trackers in Swift
Swift
6
star
82

FantasticDisplay

๐ŸŽข Fantastic HUD and toast in Swift
Swift
6
star
83

ComputerScienceSwift

๐Ÿ‘จโ€๐Ÿ’ป Practice computer science in Swift
Swift
6
star
84

PushHero

Push Hero is a native macOS application written in pure Swift that allows us to easily test push notifications
6
star
85

onmyway133

What you don't know is what you haven't learned
5
star
86

Minion

๐Ÿ Working with Xcode plugins
Swift
5
star
87

SketchHeaders

๐Ÿ’ฟ Headers from Sketch
Objective-C
4
star
88

homebrew-formulae

๐Ÿš— Homebrew formulae
Ruby
3
star
89

chat_webrtc

โŒจ๏ธ Simple chat application using Node.js and WebRTC Data Channel
JavaScript
3
star
90

DarkSide

๐ŸŒŒ My dark theme based on Atom One Dark
Shell
3
star
91

android-architecture-components-kotlin

๐Ÿฅ‹ Samples for Android Architecture Components in Kotlin
Kotlin
2
star
92

slackbot-yoda

๐Ÿ’ Slackbot Yoda
JavaScript
2
star
93

onmyway133.github.io

Showcase
HTML
2
star
94

traffic_simulator

๐Ÿš— Traffic simulator using enchant.js
JavaScript
2
star
95

rtpproxy

๐Ÿฅ‚ Forked from http://www.rtpproxy.org/ with IP handover support
C
2
star
96

Shipmunk

Search, bookmark and track keyword rating for your favorite apps
2
star
97

Dust

๐Ÿš€ Unofficial, simple push notification
Swift
1
star
98

MarqueeTextBlock

๐ŸŒด How to make marquee TextBlock on Windows Phone
C#
1
star