nofelmahmood / Seam

Seam allows you to sync your CoreData Stores with CloudKit.

Topics

• Features
• Requirements
• Communication
• Installation
• Usage
• Getting Started
• FAQ
• Apps
• Author
• License

Features

• Automatic mapping of CoreData Models to CloudKit Private Databases
• Supports Assets
• Background Sync
• Conflict Resolution

Requirements

• iOS 8.0+ / Mac OS X 10.10+
• Xcode 7.1+

Communication

• If you want to contribute submit a pull request.
• If your app uses Seam I'll be glad to add it to the list. Edit the List and submit a pull request.
• If you found a bug open an issue.
• If you have a feature request open an issue.
• If you have a question, ask it on Stack Overflow.

Please read the Contributing Guidelines before doing any of above.

Installation

Cocoapods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate Seam into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

pod 'Seam', '~> 0.6'

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Seam into your Xcode project using Carthage, specify it in your Cartfile:

github "Seam/Seam" ~> 0.6

Run carthage update to build the framework and drag the built Seam.framework into your Xcode project.

Usage

Add a Store type of SeamStoreType to a NSPersistentStoreCoordinator in your CoreData stack:

let persistentStoreCoordinator = NSPersistentStoreCoordinator(managedObjectModel: yourModel)
let seamStore = try persistentStoreCoordinator.addPersistentStoreWithType(SeamStoreType, 
                                                                          configuration: nil, 
                                                                          URL: url, options: nil) as? Store

Observe the following two Notifications to know when the Sync Operation starts and finishes:

NSNotificationCenter.defaultCenter().addObserver(self, selector: "didStartSyncing:",
                                                name: SMStoreDidStartSyncingNotification,
                                                object: seamStore)

NSNotificationCenter.defaultCenter().addObserver(self, selector: "didFinishSyncing:",
                                                name: SMStoreDidFinishSyncingNotification,
                                                object: seamStore)                                               

func didStartSyncing(notification: NSNotification) {
  // Prepare for new data before syncing completes
}
  
func didFinishSyncing(notification: NSNotification) {
  // Merge Changes into your context after syncing completes
  mainContext.mergeChangesFromStoreDidFinishSyncingNotification(notification)
}
  

Finally call sync whenever and wherever you want:

seamStore.sync(nil)

To trigger sync whenever a change happens on the CloudKit Servers. Subscribe the store to receive Push Notifications from the CloudKit Servers.

seamStore.subscribeToPushNotifications({ successful in
    guard successful else { return }
    // Ensured that subscription was created successfully
})

// In your AppDelegate

func application(application: UIApplication, didReceiveRemoteNotification userInfo: [NSObject : AnyObject]) {
    seamStore.sync(nil)
}

Attributes

All CloudKit Attributes are mapped automatically to your CoreData attributes with the exception of CKAsset and CLLocation.

CKAsset and CLLocation can be used by setting the corresponding attribute as Transformable in your CoreData Model.

Transformable Attributes

CKAsset and CLLocation can be used in your CoreData model as Transformable attributes.

1. To use CKAsset set Transformable as AttributeType and CKAssetTransformer as value transformer name for the attribute.

2. To use CLLocation set Transformable as AttributeType and CLLocationTransformer as value transformer name for the attribute.

Relationships

Note : You must create inverse relationships in your app's CoreData Model or Seam wouldn't be able to translate CoreData Models in to CloudKit Records. Unexpected errors and curroption of data can possibly occur.

Getting Started

Download the demo project. Run it and see the magic as it happens.

FAQ

tvOS Support ?

tvOS provides no persistent local storage. Seam uses SQLITE file to keep a local copy of your database which is not possible with tvOS.

Apps

A list of Apps which are using Seam.

Author

Seam is owned and maintained by Nofel Mahmood.

You can follow him on Twitter and Medium

License

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