Sync Realm Database with CloudKit
Swift Ruby
Latest commit 2b03b41 Dec 12, 2017 @caiyue1993 caiyue1993 Merge pull request #14 from IngmarStein/change-token-expired
Handle CKError.changeTokenExpired and add more debug info
Permalink
Failed to load latest commit information.
Example use constant Dec 9, 2017
IceCream add comments Dec 12, 2017
docs remove folder Dec 5, 2017
.gitignore remove folder Dec 5, 2017
.swift-version add swift-version Nov 26, 2017
.travis.yml final try Dec 1, 2017
CHANGELOG.md add changelog Dec 1, 2017
IceCream.podspec update podspec Dec 9, 2017
LICENSE sign my name Nov 18, 2017
README.md update readme Dec 10, 2017

README.md

IceCream

CI Status Version License Platform contributions welcome

IceCream helps you sync Realm Database with CloudKit.

"It works like magic!"

Features

  • Realm Database

    • Off-line First
    • Thread Safety
    • Reactive Programming
    • Optimized for mobile apps
    • Easy when migrating
  • Apple CloudKit

    • Automatical Authentication
    • Silent Push
    • Free with limits(Private database consumes your user's iCloud quota)
  • Delta update

  • Reachability(Support Long-lived Operation)

  • Error Handling

  • Sync Automatically

  • Manually Synchronization is also supported

  • User Account Status Check

  • Complete Documentation

Prerequisite

  1. Be sure to have enrolled in Apple Developer Program

  2. Turn on your iCloud in Capabilities and choose CloudKit

  3. Turn on Background Modes and check Background fetch and Remote notification

Usage

Basics

  1. Prepare your Realm Object(e.g. Dog)
class Dog: Object {
    @objc dynamic var id = NSUUID().uuidString
    @objc dynamic var name = ""
    @objc dynamic var age = 0
    @objc dynamic var isDeleted = false

    override class func primaryKey() -> String? {
        return "id"
    }
}
  1. Do stuffs like that
extension Dog: CKRecordConvertible {
    // Yep, leave it blank!    
}

extension Dog: CKRecordRecoverable {
    typealias O = Dog
}

Is that easy? Protocol Extensions do this trick.

  1. Start the Engine!
var syncEngine: SyncEngine<Dog>?
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    ...
    syncEngine = SyncEngine<Dog>()
    application.registerForRemoteNotifications()
    ...
}

That's all you need to do! Everytime you write to Realm, the SyncEngine will get notified and handle sync stuffs!

For more details, clone the project to see the source code.

About Object Deletions

Yep, we highly recommend you use Soft Deletions. That's why we add a isDeleted property to CKRecordConvertible protocol.

When you want to delete a object, you just need to set its isDeleted property to true. And the rest of things are already taken care of.

You also don't need to worry about the clean-up things. It has also been considered.

Example project is provided to see the detailed usage.

Requirements

  • iOS 10.0+
  • Swift 4
  • Realm Swift ~> 3.0

Debug Suggestions

It's true that debugging CloudKit is hard and tedious. But I have some tips for you guys when facing puzzles.

  • You should know how Realm and CloudKit works.
  • Using GUI tools, like Realm Browser and CloudKit Dashboard.
  • When you are lost and don't remember where you are, I suggest starting all over again. In CloudKit Dashboard, "Reset..." button is provided. You can also clear local database by re-install apps.
  • Keep calm and carry on!

Warning: If you're going to launch your app onto App Store, don't forget to deploy your environment settings to production. You can do it easily in the CloudKit Dashboard. Write & Read permissions are also need to be considered.

One More Tip

How to debug CloudKit in production mode? See this post.

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Installation

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

pod 'IceCream', '~> 1.0.1'

Make it better

These are the to-do list in IceCream project. You can join us to become a contributor.

  • CKReference & Realm's LinkingObjects
  • CloudKit Shared Database
  • Other platforms supported, like macOS, tvOS and watchOS
  • Multiple objects supported

See the CONTRIBUTING file for contributing guidelines.

Live Demo

My app Sprint(A lightweight task management app) is using IceCream. You can download it and try it on your muiltiple devices to see this magic.

If your app has adopted IceCream, feel free to raise a PR to add to this page.

Reference

Backers

By now, IceCream is mainly maintained by myself. I'd be appreciated if you could be a backer to support the maintenance of IceCream. Thank you to all our backers! Become a backer

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your designated website. Become a sponsor

License

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