Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fuzz-productions/CoreDataDandy
A feature-light wrapper around Core Data that simplifies common database operations.
https://github.com/fuzz-productions/CoreDataDandy
Last synced: 3 months ago
JSON representation
A feature-light wrapper around Core Data that simplifies common database operations.
- Host: GitHub
- URL: https://github.com/fuzz-productions/CoreDataDandy
- Owner: ml-archive
- License: other
- Archived: true
- Created: 2016-02-02T22:35:45.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-02-11T15:51:49.000Z (over 4 years ago)
- Last Synced: 2024-08-14T14:05:18.769Z (3 months ago)
- Language: Swift
- Size: 241 KB
- Stars: 34
- Watchers: 19
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios-star - CoreDataDandy - A feature-light wrapper around Core Data that simplifies common database operations. (Core Data / Linter)
- awesome-ios - CoreDataDandy - A feature-light wrapper around Core Data that simplifies common database operations. (Core Data / Linter)
- fucking-awesome-ios - CoreDataDandy - A feature-light wrapper around Core Data that simplifies common database operations. (Core Data / Linter)
- fucking-awesome-ios - CoreDataDandy - A feature-light wrapper around Core Data that simplifies common database operations. (Core Data / Linter)
README
[](https://travis-ci.org/fuzz-productions/CoreDataDandy)
[](https://github.com/fuzz-productions/CoreDataDandy)
[](https://cocoapods.org/pods/CoreDataDandy)
[](https://github.com/fuzz-productions/CoreDataDandy/blob/master/LICENSE)
## Introduction
Core Data Dandy is a feature-light wrapper around Core Data that simplifies common database operations.
## Feature summary
* Initializes and maintains a Core Data stack.
* Provides convenience methods for saves, inserts, fetches, and deletes.
* Maps json into NSManagedObjects via a lightweight API.
* Deserializes NSManagedObjects into json
## Installation
### Carthage
```
github "fuzz-productions/CoreDataDandy" ~> 0.6.1
```
### CocoaPods
```
pod 'CoreDataDandy', '0.6.1'
```
## Usage
All standard usage of Core Data Dandy should flow through CoreDataDandy's sharedDandy. More advanced users, however, may find its various components useful in isolation.
### Bootstrapping
```swift
CoreDataDandy.wake("ModelName")
```
### Saving and deleting
Save with or without a closure.
```swift
Dandy.save()
Dandy.save { error in
// Respond to save completion.
}
```
Delete with or without a closure.
```swift
Dandy.delete(object)
Dandy.delete(object) {
// Respond to deletion completion.
}
```
Destroy the contents of the database. Called, for example, to recover from a failure to perform a migration.
```swift
Dandy.tearDown()
```
### Fetching
Fetch all objects of a given type.
```swift
Dandy.fetch(Gossip.self)
```
Fetch an object corresponding to an entity and primaryKey value.
```swift
Dandy.fetchUnique(Hat.self, identifiedBy: "bowler")
```
Fetch an array of objects filtered by a predicate.
```swift
Dandy.fetch(Gossip.self, filterBy: NSPredicate(format: "topic == %@", "John Keats"))
```
### Insertions and updates
Insert object of a given type.
```swift
Dandy.insert(Gossip.self)
```
Insert or fetch a unique a object from a primary key.
```swift
Dandy.insertUnique(Slander.self, identifiedBy: "WILDE")
```
Upsert a unique object, or insert and update a non-unique object.
```swift
Dandy.upsert(Gossip.self, from: json)
```
Upsert an array of unique objects, or insert and update non-unique objects.
```swift
Dandy.batchUpsert(Gossip.self, from: json)
```
### Mapping finalization
Objects requiring custom mapping finalization should adopt the `MappingFinalizer` protocol. The protocol has a single function, `finalizeMapping(_:)`.
```swift
extension Conclusion: MappingFinalizer {
func finalizeMapping(of json: [String : AnyObject]) {
if var content = content {
content += "_FINALIZED"
self.content = content
}
}
}
```
### Serialization
Serialize a single object.
```swift
Serializer.serialize(gossip)
```
Serialize an array of objects.
```swift
Serializer.serialize([byron, wilde, andre3000])
```
Serialize an object and its relationships.
```swift
Serializer.serialize(gossip, including: ["purveyor"])
```
Serialize an object and its nested relationships.
```swift
Serializer.serialize(gossip, including: ["purveyor.hats.material, purveyor.predecessor"])
```
## xcdatamodel decorations
CoreDataDandy supports four xcdatamodel attributes. All decorations are declared and documented in DandyConstants.
**@primaryKey**
Add this decoration to the entity's userInfo to specify which property on the entity functions as its primaryKey.
**@mapping**
Add this decoration to a property to specify an alternate mapping for this property. For instance, if a property is named "abbreviatedState," but the json value for this property is found at the key "state," add @mapping : state to the abbreviatedState's userInfo.
**@false**
Use this decoration in conjunction with the @mapping keyword to disable mapping to the property. For instance, if your entity has an attribute named "secret" that you'd prefer to map yourself, add @mapping : @false to secret's userInfo.
**@singleton**
Add this decoration to an entity's userInfo if there should never be more than one instance of this entity in your database. This decoration may be useful for objects like Tokens and CurrentUsers, though it's primarily included to suggest the kind of decorations that may be added in the future.
## Warnings
To receive console warnings in Swift projects, add the entry -D DEBUG in your project's build settings under Swift Compiler - Custom Flags.