• Stars
    star
    259
  • Rank 152,159 (Top 4 %)
  • Language
    Objective-C
  • License
    MIT License
  • Created almost 12 years ago
  • Updated about 7 years ago

Reviews

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

Repository Details

An iOS library for fast, easy, and safe threaded disk I/O.

Storage

Persist all the things! Wheee!

In attempting to keep things DRY, EDStorage was created to address the fair amount of boilerplate that often gets created to deal with writing data to disk within iOS applications in a performant manner. Disk I/O within iOS is synchronous and so much of this boilerplate is often written to improve performance by moving I/O to a background thread. EDStorage accomplishes this by transforming each write instance into a NSOperation which is managed by a single NSOperationQueue. All of this is done in the background while providing high-level methods to the user via categories.

EDStorage strives to provide three things:

  • An abstract interface based on categories that makes persisting data to disk simple.
  • A highly generic management interface that makes extending EDStorage equally simple.
  • Speed and safety.

Basic Use

The easiest way to get going with EDStorage is to take a look at the included example application. The Xcode project file can be found in example > storage.xcodeproj.

In order to include EDStorage in your project, you'll want to add the entirety of the EDStorage directory to your project. EDStorage is built on top of foundation libraries and so no additional frameworks are needed. To bring in all of the included storage categories, simply:

#import "EDStorage.h"

Each category has a slightly different interface depending on the needs of a specific class, but to use a common example, let's look at how to persist a UIImage to the application cache directory:

- (void)doSomething
{
    UIImage *image = [UIImage imageNamed:@"keyboardCat.png"];
    
    [image persistToCache:^(NSURL *url, NSUInteger size) {
        NSLog(@"FTW!: %@ | %d bytes", url, size);
    } failure:^(NSError *error) {
        NSLog(@"UH OH: %@", error);
    }];
}

Persisting to the temporary and documents application directories is equaly simple:

[image persistToTemp:^(NSURL *url, NSUInteger size) {
    NSLog(@"FTW!: %@ | %d bytes", url, size);
} failure:^(NSError *error) {
    NSLog(@"UH OH: %@", error);
}];
[image persistToDocuments:^(NSURL *url, NSUInteger size) {
    NSLog(@"FTW!: %@ | %d bytes", url, size);
} failure:^(NSError *error) {
    NSLog(@"UH OH: %@", error);
}];

Implementing A Storage Category

EDStorageManager provides a single block method for interfacing with categories:

- (void)persistData:(id)data withExtension:(NSString *)ext toLocation:(Location)location success:(void (^)(NSURL *url, NSUInteger size))success failure:(void (^)(NSError *error))failure;

Categories simply abstract the process of calling this method on EDStorageManager by handling conversion of the class instance into a NSData object. See the NSData+Storage implementation For example, the storage category for UIImage simply passes self into NSData by calling UIImageJPEGRepresentation().

If you create a category that you find useful, please let me know! Pull requests are welcome.


Locations

EDStorageDirectoryCache
EDStorageDirectoryTemp
EDStorageDirectoryDocuments

NSData+Storage Methods

- (void)persistToCacheWithExtension:(NSString *)extension success:(void (^)(NSURL *url, NSUInteger size))success failure:(void (^)(NSError *error))failure;
- (void)persistToTempWithExtension:(NSString *)extension success:(void (^)(NSURL *url, NSUInteger size))success failure:(void (^)(NSError *error))failure;
- (void)persistToDocumentsWithExtension:(NSString *)extension success:(void (^)(NSURL *url, NSUInteger size))success failure:(void (^)(NSError *error))failure;

NSDictionary+Storage Methods

- (void)persistToCache:(void (^)(NSURL *url, NSUInteger size))success failure:(void (^)(NSError *error))failure;
- (void)persistToTemp:(void (^)(NSURL *url, NSUInteger size))success failure:(void (^)(NSError *error))failure;
- (void)persistToDocuments:(void (^)(NSURL *url, NSUInteger size))success failure:(void (^)(NSError *error))failure;

UIImage+Storage Methods

- (void)persistToCache:(void (^)(NSURL *url, NSUInteger size))success failure:(void (^)(NSError *error))failure;
- (void)persistToTemp:(void (^)(NSURL *url, NSUInteger size))success failure:(void (^)(NSError *error))failure;
- (void)persistToDocuments:(void (^)(NSURL *url, NSUInteger size))success failure:(void (^)(NSError *error))failure;

iOS Support

EDStorage is tested on iOS 5 and up. Older versions of iOS may work but are not currently supported.

ARC

EDStorage as of v0.2.0 is built using ARC. If you are including EDStorage in a project that does not use Automatic Reference Counting (ARC), you will need to set the -fobjc-arc compiler flag on all of the EDStorage source files. To do this in Xcode, go to your active target and select the "Build Phases" tab. Now select all EDStorage source files, press Enter, insert -fobjc-arc and then "Done" to enable ARC for EDStorage.

More Repositories

1

sentiment

AFINN-based sentiment analysis for Node.js.
JavaScript
2,618
star
2

color

A collection of categories and utilities that extend UIColor
Objective-C
537
star
3

troll

Language sentiment analysis and neural networks... for trolls.
JavaScript
330
star
4

cam

A β€œkeep it simple” approach to handling photo and video capture with AVFoundation.
Objective-C
281
star
5

queue

A persistent background job queue for iOS.
Objective-C
268
star
6

semver

Semantic Versioning library for Objective-C
Objective-C
115
star
7

washyourmouthoutwithsoap

A list of bad words in many languages.
JavaScript
89
star
8

fastly

Fastly API client for Node.js
JavaScript
70
star
9

conduit

JS to Objective-C... and back again.
Objective-C
52
star
10

parallax

Objective-C library for implementation of CoreMotion-controlled parallax distortion.
Objective-C
44
star
11

generator

Language agnostic project bootstrapping with an emphasis on simplicity.
JavaScript
30
star
12

fork-pool

A generic child process pool for Node.js.
JavaScript
27
star
13

logo

A streaming parser for the LOGO programming language.
JavaScript
23
star
14

micron-throttle

Token bucket based HTTP request throttle for Node.js
JavaScript
17
star
15

trebuchet

A node.js module for throwing email around using the Postmark API.
JavaScript
15
star
16

rodeo

Realtime notifications with Redis and Node.js
JavaScript
14
star
17

turtle

A collaborative programming environment for the LOGO programming language.
JavaScript
14
star
18

orchestra

Keyboard-based instruments designed for MaKey MaKey
10
star
19

basic

HTTP Basic Authentication for Node.js
JavaScript
10
star
20

dpla

Node.js API client for the Digital Public Library of America
JavaScript
9
star
21

simple

A simple static HTTP server
JavaScript
8
star
22

tineye

Node.js client for the Tineye search API
JavaScript
8
star
23

graffle-json

A node.js utility for converting OmniGraffle .OO3 files into structured JSON
JavaScript
8
star
24

strainer

Simple filtering of arrays and object streams.
JavaScript
8
star
25

namebot

A node.js module for creating usernames based on a specified corpus
JavaScript
7
star
26

baseit

A node.js module for simple(r) handling of radix 2 through 36 base encodings.
JavaScript
5
star
27

phidget

Node.js bindings for the Phidget line of USB sensor and control interfaces.
JavaScript
5
star
28

friendly-phonemes

A kid friendly corpus in both JSON and phonetic "DICT" formats
5
star
29

assert

Assertion extensions and utilities for OCUnit
Objective-C
4
star
30

3d-mixer

OpenFrameworks based 8-channel 3D sound mixer prototype
C
3
star
31

vouch

JSON schema validation ... for humans.
JavaScript
3
star
32

cc-client

Node.js client for the Constant Contact API
JavaScript
3
star
33

php-console

PHP Console is a MacOS X (10.6+) Cocoa application that provides users with a simple environment in which to execute arbitrary PHP code.
Objective-C
3
star
34

up-client

Node.js client for the (unofficial) Jawbone UP API
JavaScript
3
star
35

rij

Safe and sensible work queue for Node.js
JavaScript
3
star
36

localq

A persistent job queue for the browser.
JavaScript
3
star
37

cork

An API utility belt for request.
JavaScript
2
star
38

dotfiles

My dotfiles. There are many like them, but these are mine.
Shell
2
star
39

micron

Minimalist extensions to the Node.js core HTTP server.
JavaScript
2
star
40

apostle

Node.js API client for Apostle.io
JavaScript
2
star
41

sublime

A collection of handy Sublime Text snippets & build scripts
Python
2
star
42

hipchat-cli

A Hipchat CLI using curl
Shell
2
star
43

badgecrawler

Search provider for Mozilla Open Badges
JavaScript
2
star
44

randy

Socket.io based realtime notifications with Rodeo.
JavaScript
2
star
45

teach-presentation

How to Teach (Almost) Anything - Presentation Slides
1
star
46

uiimage-io

A category for UIImage that provides naive methods for saving UIImage objects to disk. For demo purposes only.
Objective-C
1
star
47

dashboard

gMail to servo = wat
JavaScript
1
star
48

ios-blinkrc-control

Quick prototype iOS control application for the "Insurance Liability Bot" (BlinkRC servo controller). Requires Sparrow framework (http://www.sparrow-framework.org).
Objective-C
1
star
49

dscripts

A collection of dtrace scripts
D
1
star