ActiveRecord for Swift. Easy Core Data
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Classes
Example-iOS/SwiftRecordExample
SwiftRecord.framework
SwiftRecord.xcworkspace
SwiftRecord
.gitignore
LICENSE
README.md
SwiftRecord.podspec

README.md

SwiftRecord CocoaPod Carthage compatible MIT license Issues

by ark. tweet @arkverse for any feature requests. Feedback is greatly appreciated!

About

ActiveRecord style Core Data object management. Tremendously convenient and easy to use. Necessary for any and every Core Data project.

Written purely in Swift and based heavily on ObjectiveRecord

Easy creates, saves, deletes and queries. Do it using:

  • [String:AnyObject] dictionaries for creates, queries or sorts
  • String for queries and sorts, ie name == 'someName' or date ASC
  • NSPredicate and NSSortDescriptor/[NSSortDescriptor] for queries and sorts if you'd like

Now supports setting an autoincrementing ID for your NSManagedObject subclasses

This library also reads in your json dictionaries for you. Includes automatic camelCase changing ie first_name from server to firstName locally. You can customize the dictionary mappings too. Read more in the mapping section.

Object relationships are also generated from dictionaries, but disabled by default. Set SwiftRecord.generateRelationships to true to enable this feature. See the relationships section

Visit ark for a more beginner friendly guide to SwiftRecord

if you love SwiftRecord, tweet it! tweet button

Table of Contents

  1. Installation
  2. Creates, Saves, Deletes
  3. querying
  4. [sorting, limits](#sorting, limits)
  5. aggregation
  6. [custom coredata](#custom core data)
  7. mapping
  8. relationships
  9. autoincrement

Installation

via CocoaPods

  1. Edit your Podfile to use frameworks and add SwiftRecord:

     platform :ios, '8.0'
     use_frameworks!
    
     pod 'SwiftRecord'
    
  2. run pod install

via Carthage

  1. Just add SwiftRecord to your Cartfile:

    github "arkverse/SwiftRecord" >= 0.0.6

  2. and run carthage update

Manual Installation

Drag and drop either Classes/SwiftRecord.swift or SwiftRecord.framework into your project

Usage

  1. At the top of every NSManagedObject swift class add:

    import SwiftRecord
    
    @objc(Event)
    class Event: NSManagedObject {
    	@NSManaged var eventID: NSNumber
    	@NSManaged var name: String
    	@NSManaged var type: String
    	@NSManaged var when: NSDate
    	@NSManaged var creator: User
    	@NSManaged var attendess: NSSet
    }
  2. Set up Core Data by naming your model file MyAppName.xcdatamodel. Optionally, you can set your own model name by calling SwiftRecored.sharedRecord.modelName = "mymodelname"

create, save & delete:

var event = Event.create() as! Event // Downcasts are necessary,
event.type = "Birthday"
event.when = NSDate()
event.save() // simple save
event.delete() // simple delete

var properties: [String:AnyObject] = ["name":"productQA","type":"meeting", "when":NSDate()]
var meeting = Event.create(properties) as! Event // Remember to downcast

Note: the downside to using swift is that NSManagedObject and [NSManagedObject](arrays) are returned*, so api calls have to down casted into your class type. Feel free to always force downcast. MyObject calls will always create MyObject unless your class could not be found

*instancetype, Self in Swift, has only just been added, and still pretty useless

querying

Easily query against your entities. Queries accept optional condition, sort and limit parameters.

// grab all Events
var events = Event.all() as! [Event]

// all past events before now
var pastEvents = Event.query("when < %@", NSDate()) as! [Event]

// specific event, yes we have support for format&arguments. Note, finding specific events return optional vars
var thisEvent = Event.find("name == %@ AND when == %@", "productQA", NSDate()) as? Event

// Use dictionaries to query too
var birthdayEvents = Event.query(["type":"birthday"]) as! [Event]

// or NSPredicates
var predicate = NSPredicate("type == %@", "meeting")
var meetingEvents = Event.query(predicate) as! [Event]

sorting, limits

// Events sorted by date, defaults to ascending
var events = Event.all(sort: "when") as! [Event]
// Descending
var descendingEvents = Event.all(sort:["when":"DESC"]) as! [Event]
// or
var descEvents = Event.all(sort:"when DESC, eventID ASC")

// All meeting events sorted by when desc and eventID ascending and limit 10
var theseEvents = Event.query(["type":"meeting"], sort:["when":"DESC","eventID":"ASC"], limit: 10) as! [Event]

// NSSortDescriptor as sort arg (or array of NSSortDescriptors
Event.all(sort: NSSortDescriptor(key:"when",ascending:true))

Aggregation

// count all Events
var count = Event.count()

// count meeting Events
var count = Event.count("type == 'meeting'")

Custom Core Data

Custom ManagedObjectContext

if you made your own, feel free to set it

var myContext: NSManagedObjectContext = ...

SwiftRecord.sharedRecord.managedObjectContext = myContext

Custom CoreData model or .sqlite database

Don't set these if you set your own context. If you have a modelName different from the name of your app, set it. If you want a different databse name, set it.

SwiftRecord.sharedRecord.modelName = "MyModelName"
SwiftRecord.sharedRecord.databaseName = "custom_database_name"

Mapping

The most of the time, your JSON web service returns keys like first_name, last_name, etc.
Your Swift implementation has camelCased properties - firstName, lastName.

We automatically check against camelCase variations.

If you have different variations, override static func mappings() -> [String:String] to specify your local to remote key mapping

The key string is your local name, the value string, your remote name.

// this method is called once, so you don't have to do any caching / singletons
class Event: NSManagedObject {

override class func mappings() -> [String:String] {
	return ["localName":"remoteName","eventID":"_id","attendees":"people"]
}
  // firstName => first_name is automatically handled
}

@end

Relationships

While it is advised against, you can have your NSManagedObject relationships in your dictionaries and they will be filled, but first you must enable it by setting:

SwiftRecord.generateRelationships = true

Once this is set, you rels will be filled, ie:

var personDict = ["email":"zaid@arkverse.com","firstName":"zaid"]
var eventDict = ["name":"product QA meeting","when":NSDate(),"creator":personDict]
var event = Event.create(eventDict) as! Event
var person: Person = event.creator
println(person.username)

Autoincrement

If you would like SwiftRecord to manage autoincrementing your ID property for you, enable it just by override autoIncrementingId() and return the key for your ID property:

public class Event: NSManagedObject {

   override public func autoIncrementingId() -> String? {
       return "eventId"
   }

Note, this will set your ID property whenever one isn't provided. You will have duplicate ID's if you set your own objects id. For example, autoincrement is at ID 150 and you create an object with ID 200, autoincrement will eventually create an object with ID 200 as well. Enforcing uniqueness in Core Data is too expensive.

Testing

ObjectiveRecord supports CoreData's in-memory store. In any place, before your tests start running, it's enough to call

SwiftRecord.sharedRecord.useInMemoryStore()

Roadmap

  • improve Swiftiness
  • JSON generation
  • Possible add NSOrderedSet support in Relationship init
  • Support Realm
  • Better typing

License

SwiftRecord is available under the MIT license. See the LICENSE file for more information.

Check out ark for more about us

ga tracker