CHANGELOG.md

CHANGELOG

The changelog for JSQCoreDataKit. Also see the releases on GitHub.

---

NEXT

• TBA

10.0.0

This release closes the 10.0.0 milestone.

New

• Introduced a new component, FetchedResultsCoordinator, which handles all of the boilerplate for setting up an NSFetchedResultsController and updating the content of a UICollectionView. All you need to do is provide a FetchedResultsCellConfiguration and an NSFetchRequest. See the documentation and example project for details. (#201)

• Added FetchedResultsController, a generic subclass of NSFetchedResultsController that's nicer to use in Swift.

Changed

• Upgraded to Swift 5.4

Breaking

• Xcode 13.0 now required

• Dropped support for old OS versions:

  • iOS 14+ now required
  • tvOS 14+ now required
  • watchOS 6+ now required
  • macOS 10.14+ now required

9.0.3

This release closes the 9.0.3 milestone.

• Upgraded to Xcode 12 and Swift 5.3

9.0.2

This release closes the 9.0.2 milestone.

New

• Support for Swift Package Manager

Changed

• Upgraded to Swift 5.2
• Upgraded to Xcode 11.4
• Upgraded to SwiftLint 0.39.2

9.0.1

This release closes the 9.0.1 milestone.

Fixed

• Carthage support (#92, #138, @kevnm67)

9.0.0

This release closes the 9.0.0 milestone.

Breaking

• Removed NSManagedObjectContext extension func save(wait:, completion:). Replaced with two new extension methods, func saveAsync(completion:) and func saveSync(completion:).

• Removed SaveResult type in favor of Swift's new generic Result type.

• Removed StackResult type in favor of Swift's new generic Result type.

• Renamed CoreDataStackFactory to CoreDataStackProvider

New

• Added typealias SaveResult = Result<NSManagedObjectContext, Error> (Replaces the former SaveResult type.)

• Added typealias StackResult = Result<CoreDataStack, Error> (Replaces the former StackResult type.)

Changed

• Upgraded to Swift 5.1
• Update to Xcode 11
• Update SwiftLint to 0.35.0, add new rules

8.0.0

This release closes the 8.0.0 milestone.

• iOS 11.0 minimum now required
• tvOS 11.0 minimum now required
• macOS 10.12 minimum now required
• watchOS 4.0 minimum now required

New

• Upgraded to Swift 4.2 (#125)
• Update to Xcode 10.1
• Update SwiftLint to 0.27.0

Breaking

• PersistentStoreOptions typealias is now [AnyHashable: Any] (#119)

• Make APIs more "swifty" (#120)

  • Nest top-level function defaultDirectoryURL() under CoreDataModel
  • Nest ChildContext typealias under NSManagedObjectContext extension
  • Move saveContext() top-level function to extension method on NSManagedObjectContext

Changed

• Use Equatable auto-synthesis where possible

7.0.0

• Converted to Swift 4.0
• iOS 9.0 minimum now required
• tvOS 10.0 minimum now required
• watchOS 3.0 minimum now required
• macOS 10.11 minimum now required

6.0.3

• Fixed some warnings from Swift 3.1 / Xcode 8.3

6.0.2

This release closes the 6.0.2 milestone.

• Fixed an issue where model migrations would fail. (#106, #109. Thanks @yasserislam, @marius-serban!)

6.0.1

This release closes the 6.0.1 milestone.

• Fixed an issue with carthage failing. (#100, #101, #102) Thanks @darkhonor and @tonyarnold!

6.0.0

This release closes the 6.0.0 milestone.

Swift 3.0 now required.

Breaking

• Migrated to Swift 3.0
• Removed entity(name: String, context: NSManagedObjectContext) -> NSEntityDescription
• Removed FetchRequest<T: NSManagedObject> (new Swift overlays now provide generic NSFetchRequest)
• Remove the delete() and fetch() extensions on NSManagedObjectContext (new Swift overlays now provide these)

New

• There's a new protocol, CoreDataEntityProtocol, which provides a better API for creating entity descriptions and inserting managed objects (#87). It also provides some helpful extensions. Conform to the new CoreDataEntityProtocol to take advantage of this. This replaces the (removed) top-level function entity(name:, context:) -> NSEntityDescription

5.0.0

This release closes the 5.0.0 milestone.

Swift 2.3 now required.

4.0.2

This release closes the 4.0.2 milestone.

• Fixed an issue where sqlite temporary files would not be cleaned up when removing the store (#85). Thanks @deemadden!

4.0.1

This release closes the 4.0.1 milestone.

• Fixed a multithreading concurrency violation while merging (#83). Thanks @saurabytes!

4.0.0

This release closes the 4.0.0 milestone.

This release includes a significant change to CoreDataStack, which no longer uses child contexts. The mainContext and backgroundContext are now both connected to the persistent store coordinator. See #60 for the background and rationale behind this change. In short, child contexts are considered bad practice for this kind of stack setup and should really only be used for "throw away" work.

While this is technically a breaking change, it likely will not affect most clients. The behavior should remain largely unchanged — data is still kept in-sync between the 2 contexts. So unless you were specifically relying on this parent-child nesting behavior, you should be fine. 👍

Thanks

Huge thanks to @Liquidsoul for closing most of the issues for this release and to @wiedem for contributing significantly as well! 🎉

Breaking changes ⚠️

Stack

• The mainContext and backgroundContext are now both connected to the persistent store coordinator (#60)
• When creating a child context, the concurrencyType determines which context is the parent (#73)
• CoreDataStackFactory has been simplified. There is now a single createStack() method. (#77)

Free functions

In alignment with the latest Swift API guidelines, the library now prefers methods/extensions over free functions.

• The resetStack() top-level function is now a method on CoreDataStack (#75)
• The deleteObjects() top-level function is now an extension method on NSManagedObjectContext (#76)
• The fetch() top-level function is now an extension method on NSManagedObjectContext (#78)
• The migrate() top-level function is now an extension method CoreDataModel (#82)

Documentation

All docs have been updated. As usual, check these out for more details on the changes described above.

Refinements

There have been other general refinements and additional unit tests have been added. Test coverage is 94% 😎

3.0.0

This release closes the 3.0.0 milestone.

The goals of this release are primarily to adopt Swift 2.2 and refine the API to make it more Swifty, as the definition of Swifty has evolved.

Breaking changes ⚠️

There are many breaking changes in this release, however — with the exception of Swift 2.2 — they are all merely name changes that aim to reduce verbosity.

• Migrated to Swift 2.2. (#67) Swift 2.2 and above is now required.
• Renamed DefaultStoreOptions to defaultStoreOptions
• Renamed CoreDataSaveResult to SaveResult
• Renamed CoreDataStackResult to StackResult
• Renamed CoreDataModel.removeExistingModelStore() to CoreDataModel.removeExistingStore()
• Renamed all enum cases to be lowercase, in line with latest Swift API guidelines
• The StackResultClosure typealias has been removed

New features

• Support for Swift Package Manager (#55) 🎉
• Core Data model migration support! (#46, #66) Thanks @marius-serban ! 🎉 See the README and docs for details!

2.2.1

This release closes the 2.2.1 milestone.

Fixes

• Fixed multithreading violation while saving context (#63, #59, #65). Thanks @saurabytes and @markkrenek!
• On tvOS, the default SQLite directory now defaults to .CacheDirectory instead of .DocumentDirectory (#61, #62). Thanks @cgoldsby !

2.2.0

This release closes the 2.2.0 milestone.

New

Added a resetStack() top-level function. See the updated docs for details. Thanks @marius-serban! 🎉

Changes

⚠️ CoreDataStackFactory.CompletionHandler was moved from the factory's scope to the module's scope and renamed to StackResultClosure. This is technically a breaking change, but it is highly unlikely that anyone was referring to this closure directly. If so, simply rename to the correct type.

2.1.0

JSQCoreDataKit now "officially" supports all Apple platforms: iOS, OSX, tvOS, watchOS. 🎉

🏆 2.1.0 milestone

2.0.0

🎉 JSQCoreDataKit 2.0 is here! 🎉

Breaking changes

• Swift 2.0

• You must now initialize CoreDataStack via a CoreDataStackFactory. This will init the stack on a background queue and return to your completion handler on the main queue when finished. This is necessary since adding a persistent store can take an unknown amount of time.

• Rethinking and rewriting of CoreDataStack. It now has a mainContext and a backgroundContext. 😎

• Saving a context now returns a CoreDataSaveResult to the completion handler, instead of NSError?

New

• New CoreDataStackFactory for async stack initialization, as mentioned above. It also support synchronous init if you need it, but this is only recommended for testing. Returns a CoreDataStackResult.

• All types now conform to CustomStringConvertible and Equatable. 👊

Issues closed

Find the complete list of closed issues here. 🐛

Documentation

All documentation has been updated. 📜

Example app

The example app is actually an example app now, check it out! It's a pretty substantial demo.

1.1.0

This release closes the 1.1.0 milestone.

• New top-level functions
• Ability to specify store directory other than ~/Documents/
• No breaking changes

See the documentation for more information!

1.0.0

It's here!

Checkout the README and documentation.