Latest 0.1.4
Homepage https://github.com/chriswunsch00/CWCoreData
License MIT
Platforms ios 9.0, watchos 3.0, requires ARC
Authors

[![CI Status](http://img.shields.io/travis/Chris Wunsch/CWCoreData.svg?style=flat)](https://travis-ci.org/Chris Wunsch/CWCoreData)
Version
License
Platform

Aims of this utility

  • Simplify the process of setting up Core Data
  • Simplify the process of inserting, deleting and changing objects

Requirements

This library requires to following:

  • Xcode 8.0+
  • iOS 7.0+
  • Arc must be enabled.

Installation

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

pod "CWCoreData"

Author

Minty Water Ltd

Chris Wunsch, [email protected]

License

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

Contribute

We accept pull requests!

Usage

The library is very easy to use, the only setup code you need is to tell it what the name of your xcdatamodeld is, if you are using cocoapods you must also import the module, see the sample code below:


/// If using CocoaPods
import CWCoreData

/// Tell the framework what your xcdatamodeld is called, if you forgot this the framework will raise an exception:
CoreDataStack.defaultStack.dataBaseName = "YOU_DATABASE_NAME"
CoreDataStack.defaultStack.sharedAppGroup = "YOU_SHARED_APP_CONTAINER_DOMAIN"

Creating the context

There are two contexts that you should use. The ‘mainQueueContext’ and the ‘privateQueueContext’. The ‘mainQueueContext’ should be used to populate the UI with data from the objects i.e. with a fetchedResultsController. Whereas the ‘privateQueueContext’ should be used to modifiy the data i.e. inserting/deleting etc… It is also thread safe and should be the only context used when accessing the data off the main thread. The ‘privateQueueContext’ also allows you to specify a merge policy. See exmapls below:


/// The main context, this is persisted across the app lifecycle:
let mainContext = CoreDataStack.defaultStack.mainQueueContext

/// Get a new private context:
let privateContext = CoreDataStack.privateQueueContext()

/// Get a new private context and specify a merge policy:
let privateContextWithPolicy = CoreDataStack.privateQueueContext(withMergePolicy: .errorMergePolicyType)

Saving the context

There are two ways to save a context, allowing you to specify behaviour or to simply save. When specifying the completionHandler this block is invoked AFTER the data has been merged back into the persisten store coordinator. It is therefor safe to assume that the data changes are now reflected in the ‘mainQueueContext’.

///Basic save:
CoreDataStack.defaultStack.save(context)

//Advanced save, allowing you to specifiy whether to performAndWait or simply perform:
CoreDataStack.defaultStack.save(context, performAndWait: false, completionHandler: { (result) in
print(result)
})

Insert new objects

To insert a new object into the database – this assumes the Entity name is ‘Event’ as per the example project. The following sample will show you how to do this in iOS 10 and below, if you are targeting iOS 10, then you can omit the else:


/// Create a new context to use for the insertion, we always use the 'privateQueueContext' to handle database changes. This will merge change back into the persistent store coordinator.
let context = CoreDataStack.privateQueueContext()

/// Create a new var to hold the event object:   
var newEvent : Event?

/// If we are running on iOS 10 then we can use the new API to insert:
if #available(iOS 10.0, *) {
    newEvent = Event(context: context)
} else {
    /// If we are using anything before iOS 10, then we use the helper method from the extension on NSManangedObject
    newEvent = Event.insertNewInstance(withContext: context) as? Event
}

/// If appropriate, configure the new managed object.
newEvent?.timestamp = NSDate()

/// We now save the changes, we can specify this with a completion block and whether we want to performBlockAndWait or just perform block:

/// Simply save:
CoreDataStack.defaultStack.save(context)

Retrieve existing object

The framework has an NSManangedObject extension that adds some helper methods for retreiving objects. The following code sample shows how an object can be retrieved with a simple predicate:


do {

    /// We use the main context for retrieval if we are going to use the obejct to populate the UI and we are NOT going to make direct changes to the object. Otherwise use the privateQeueContext.
    let context = CoreDataStack.defaultStack.mainQueueContext

    /// Create the predicate we will use:
    let predicate = NSPredicate(format: "timestamp < %@", NSDate())

    /// Get the event from the database if one exists with the provided predicate, there are other APIs that do similar operations with more options. See documentation.
    let savedEvent = try Event.fetchSingleObject(withPredicate: predicate, context: context, includesPendingChanges: true) as? Event

}

} catch {
    print("error")
}

Delete an object

Deleting an object is easy


/// Create a new context to use for the deletion, we always use the 'privateQueueContext' to handle database changes. This will merge change back into the persistent store coordinator.
let context = CoreDataStack.privateQueueContext()

let objectToDelete = /// Your Object...

/// Delete the object:
context.delete(objectToDelete)

/// Save the changes, we don't supply a completion handler here:
CoreDataStack.defaultStack.save(context)

Fetched Results Controller

Setting up a fetched results controller is simple when using the CWCoreData. This will automatically update when any changes are made to the DB using the ‘privateQueueContext’


/// Create a var for the fetched results controller:
var fetchedResultsController: NSFetchedResultsController<Event> {

    if _fetchedResultsController != nil {
        return _fetchedResultsController!
    }

    /// Create the fetch request:
    let fetchRequest: NSFetchRequest<Event> = Event.fetchRequest()

    /// Optional: Set the batch size to a suitable number. 
    fetchRequest.fetchBatchSize = 20

    // Edit the sort key as appropriate.
    let sortDescriptor = NSSortDescriptor(key: "timestamp", ascending: false)

    fetchRequest.sortDescriptors = [sortDescriptor]

    /// Edit the section name key path and cache name if appropriate.
    /// nil for section name key path means "no sections".
    /// We always use the mainQueueContext for FetchedResultsControllers and any other time where we need the UI to be populated from the database object:
    let aFetchedResultsController = NSFetchedResultsController(fetchRequest: fetchRequest, managedObjectContext: CoreDataStack.defaultStack.mainQueueContext, sectionNameKeyPath: nil, cacheName: nil)
    aFetchedResultsController.delegate = self
    _fetchedResultsController = aFetchedResultsController

    do {
        try _fetchedResultsController!.performFetch()
    } catch {
        print(error)
    }

    return _fetchedResultsController!
}

var _fetchedResultsController: NSFetchedResultsController<Event>? = nil

You can now implement the FetchedResultsController delegates as you wish.

Feedback

I welcome feedback and pull requests for changes. Please report issues if you find any!

Latest podspec

{
    "name": "CWCoreData",
    "version": "0.1.4",
    "summary": "This is a small utility written in Swift to help you to use CoreData effectively throughout your app.",
    "description": "Using CWCoreData will make using core data in your app so much easier. It will initalise the database using the latest iOS 10 APIs or earlier APIs automatically for you. It will handle errors and bubble those back to you. It also adds extensions to NSManagedObject to allow easy insertions prior to iOS 10. It has quick APIs for database fetching too. It will also handle the creation of child contexts quickly and allow you to save them with or without a completion block. This completion block is invoked once the data has been saved back into the Persisten Store Coordinator.",
    "homepage": "https://github.com/chriswunsch00/CWCoreData",
    "license": "MIT",
    "authors": {
        "Chris Wunsch": "[email protected]"
    },
    "platforms": {
        "ios": "9.0",
        "watchos": "3.0"
    },
    "source": {
        "git": "https://github.com/chriswunsch00/CWCoreData.git",
        "tag": "0.1.4"
    },
    "source_files": [
        "Classes",
        "CWCoreData/Classes/**/*"
    ],
    "requires_arc": true,
    "pushed_with_swift_version": ""3.0""
}

Pin It on Pinterest

Share This