Merge branch 'prototype/Swift_3_2' into prototype/Swift_4_0

This commit is contained in:
John Estropia
2017-06-23 12:43:20 +09:00
16 changed files with 561 additions and 355 deletions

View File

@@ -1,6 +1,6 @@
Pod::Spec.new do |s| Pod::Spec.new do |s|
s.name = "CoreStore" s.name = "CoreStore"
s.version = "4.0.4" s.version = "4.0.5"
s.license = "MIT" s.license = "MIT"
s.summary = "Unleashing the real power of Core Data with the elegance and safety of Swift" s.summary = "Unleashing the real power of Core Data with the elegance and safety of Swift"
s.homepage = "https://github.com/JohnEstropia/CoreStore" s.homepage = "https://github.com/JohnEstropia/CoreStore"

View File

@@ -242,6 +242,10 @@
B53B27601EE3B92E00E9B352 /* CoreStoreManagedObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53B275E1EE3B92E00E9B352 /* CoreStoreManagedObject.swift */; }; B53B27601EE3B92E00E9B352 /* CoreStoreManagedObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53B275E1EE3B92E00E9B352 /* CoreStoreManagedObject.swift */; };
B53B27611EE3B92E00E9B352 /* CoreStoreManagedObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53B275E1EE3B92E00E9B352 /* CoreStoreManagedObject.swift */; }; B53B27611EE3B92E00E9B352 /* CoreStoreManagedObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53B275E1EE3B92E00E9B352 /* CoreStoreManagedObject.swift */; };
B53B27621EE3B92E00E9B352 /* CoreStoreManagedObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53B275E1EE3B92E00E9B352 /* CoreStoreManagedObject.swift */; }; B53B27621EE3B92E00E9B352 /* CoreStoreManagedObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53B275E1EE3B92E00E9B352 /* CoreStoreManagedObject.swift */; };
B53CA9A21EF1EF1600E0F440 /* PartialObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53CA9A11EF1EF1600E0F440 /* PartialObject.swift */; };
B53CA9A31EF1EF1600E0F440 /* PartialObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53CA9A11EF1EF1600E0F440 /* PartialObject.swift */; };
B53CA9A41EF1EF1600E0F440 /* PartialObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53CA9A11EF1EF1600E0F440 /* PartialObject.swift */; };
B53CA9A51EF1EF1600E0F440 /* PartialObject.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53CA9A11EF1EF1600E0F440 /* PartialObject.swift */; };
B53FB9FE1CAB2D2F00F0D40A /* CSMigrationResult.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53FB9FD1CAB2D2F00F0D40A /* CSMigrationResult.swift */; }; B53FB9FE1CAB2D2F00F0D40A /* CSMigrationResult.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53FB9FD1CAB2D2F00F0D40A /* CSMigrationResult.swift */; };
B53FBA001CAB2D2F00F0D40A /* CSMigrationResult.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53FB9FD1CAB2D2F00F0D40A /* CSMigrationResult.swift */; }; B53FBA001CAB2D2F00F0D40A /* CSMigrationResult.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53FB9FD1CAB2D2F00F0D40A /* CSMigrationResult.swift */; };
B53FBA011CAB2D2F00F0D40A /* CSMigrationResult.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53FB9FD1CAB2D2F00F0D40A /* CSMigrationResult.swift */; }; B53FBA011CAB2D2F00F0D40A /* CSMigrationResult.swift in Sources */ = {isa = PBXBuildFile; fileRef = B53FB9FD1CAB2D2F00F0D40A /* CSMigrationResult.swift */; };
@@ -757,6 +761,7 @@
B533C4DA1D7D4BFA001383CB /* DispatchQueue+CoreStore.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "DispatchQueue+CoreStore.swift"; sourceTree = "<group>"; }; B533C4DA1D7D4BFA001383CB /* DispatchQueue+CoreStore.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "DispatchQueue+CoreStore.swift"; sourceTree = "<group>"; };
B538BA701D15B3E30003A766 /* CoreStoreBridge.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CoreStoreBridge.m; sourceTree = "<group>"; }; B538BA701D15B3E30003A766 /* CoreStoreBridge.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CoreStoreBridge.m; sourceTree = "<group>"; };
B53B275E1EE3B92E00E9B352 /* CoreStoreManagedObject.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CoreStoreManagedObject.swift; sourceTree = "<group>"; }; B53B275E1EE3B92E00E9B352 /* CoreStoreManagedObject.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CoreStoreManagedObject.swift; sourceTree = "<group>"; };
B53CA9A11EF1EF1600E0F440 /* PartialObject.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PartialObject.swift; sourceTree = "<group>"; };
B53FB9FD1CAB2D2F00F0D40A /* CSMigrationResult.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CSMigrationResult.swift; sourceTree = "<group>"; }; B53FB9FD1CAB2D2F00F0D40A /* CSMigrationResult.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CSMigrationResult.swift; sourceTree = "<group>"; };
B53FBA031CAB300C00F0D40A /* CSMigrationType.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CSMigrationType.swift; sourceTree = "<group>"; }; B53FBA031CAB300C00F0D40A /* CSMigrationType.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CSMigrationType.swift; sourceTree = "<group>"; };
B53FBA0A1CAB5E6500F0D40A /* CSCoreStore+Migrating.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "CSCoreStore+Migrating.swift"; sourceTree = "<group>"; }; B53FBA0A1CAB5E6500F0D40A /* CSCoreStore+Migrating.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "CSCoreStore+Migrating.swift"; sourceTree = "<group>"; };
@@ -1229,6 +1234,7 @@
isa = PBXGroup; isa = PBXGroup;
children = ( children = (
B5D339D71E9489AB00C880DE /* CoreStoreObject.swift */, B5D339D71E9489AB00C880DE /* CoreStoreObject.swift */,
B53CA9A11EF1EF1600E0F440 /* PartialObject.swift */,
B52F74391E9B8724005F3DAC /* Dynamic Schema */, B52F74391E9B8724005F3DAC /* Dynamic Schema */,
B5D339DC1E9489C700C880DE /* DynamicObject.swift */, B5D339DC1E9489C700C880DE /* DynamicObject.swift */,
B52F742E1E9B50D0005F3DAC /* SchemaHistory.swift */, B52F742E1E9B50D0005F3DAC /* SchemaHistory.swift */,
@@ -1826,6 +1832,7 @@
B5FAD6AE1B518DCB00714891 /* CoreStore+Migration.swift in Sources */, B5FAD6AE1B518DCB00714891 /* CoreStore+Migration.swift in Sources */,
B5E84EE71AFF84610064E85B /* CoreStore+Logging.swift in Sources */, B5E84EE71AFF84610064E85B /* CoreStore+Logging.swift in Sources */,
B546F9731C9C553300D5AC55 /* SetupResult.swift in Sources */, B546F9731C9C553300D5AC55 /* SetupResult.swift in Sources */,
B53CA9A21EF1EF1600E0F440 /* PartialObject.swift in Sources */,
B56007111B3F6BD500A9A8F9 /* Into.swift in Sources */, B56007111B3F6BD500A9A8F9 /* Into.swift in Sources */,
B5E84F111AFF847B0064E85B /* Select.swift in Sources */, B5E84F111AFF847B0064E85B /* Select.swift in Sources */,
B51260931E9B28F100402229 /* EntityIdentifier.swift in Sources */, B51260931E9B28F100402229 /* EntityIdentifier.swift in Sources */,
@@ -2011,6 +2018,7 @@
82BA18A31C4BBD2200A0916E /* DataStack.swift in Sources */, 82BA18A31C4BBD2200A0916E /* DataStack.swift in Sources */,
82BA18C81C4BBD5900A0916E /* MigrationChain.swift in Sources */, 82BA18C81C4BBD5900A0916E /* MigrationChain.swift in Sources */,
B546F9741C9C553300D5AC55 /* SetupResult.swift in Sources */, B546F9741C9C553300D5AC55 /* SetupResult.swift in Sources */,
B53CA9A31EF1EF1600E0F440 /* PartialObject.swift in Sources */,
82BA18B11C4BBD3100A0916E /* SaveResult.swift in Sources */, 82BA18B11C4BBD3100A0916E /* SaveResult.swift in Sources */,
82BA18DD1C4BBE1400A0916E /* NSFetchedResultsController+Convenience.swift in Sources */, 82BA18DD1C4BBE1400A0916E /* NSFetchedResultsController+Convenience.swift in Sources */,
B51260941E9B28F100402229 /* EntityIdentifier.swift in Sources */, B51260941E9B28F100402229 /* EntityIdentifier.swift in Sources */,
@@ -2196,6 +2204,7 @@
B52DD1961BE1F92500949AFE /* DataStack.swift in Sources */, B52DD1961BE1F92500949AFE /* DataStack.swift in Sources */,
B5ECDBFD1CA804FD00C7F112 /* NSManagedObjectContext+ObjectiveC.swift in Sources */, B5ECDBFD1CA804FD00C7F112 /* NSManagedObjectContext+ObjectiveC.swift in Sources */,
B52DD1BD1BE1F94300949AFE /* NSManagedObject+Convenience.swift in Sources */, B52DD1BD1BE1F94300949AFE /* NSManagedObject+Convenience.swift in Sources */,
B53CA9A51EF1EF1600E0F440 /* PartialObject.swift in Sources */,
B52DD1AD1BE1F93900949AFE /* Where.swift in Sources */, B52DD1AD1BE1F93900949AFE /* Where.swift in Sources */,
B53FBA1C1CAB63E200F0D40A /* NSManagedObject+ObjectiveC.swift in Sources */, B53FBA1C1CAB63E200F0D40A /* NSManagedObject+ObjectiveC.swift in Sources */,
B51260961E9B28F100402229 /* EntityIdentifier.swift in Sources */, B51260961E9B28F100402229 /* EntityIdentifier.swift in Sources */,
@@ -2381,6 +2390,7 @@
B56321A81BD65219006C9394 /* NSManagedObject+Convenience.swift in Sources */, B56321A81BD65219006C9394 /* NSManagedObject+Convenience.swift in Sources */,
B546F9751C9C553300D5AC55 /* SetupResult.swift in Sources */, B546F9751C9C553300D5AC55 /* SetupResult.swift in Sources */,
B56321981BD65216006C9394 /* Where.swift in Sources */, B56321981BD65216006C9394 /* Where.swift in Sources */,
B53CA9A41EF1EF1600E0F440 /* PartialObject.swift in Sources */,
B5202CFD1C046E8400DED140 /* NSFetchedResultsController+Convenience.swift in Sources */, B5202CFD1C046E8400DED140 /* NSFetchedResultsController+Convenience.swift in Sources */,
B5FE4DA91C84FB4400FA6A91 /* InMemoryStore.swift in Sources */, B5FE4DA91C84FB4400FA6A91 /* InMemoryStore.swift in Sources */,
B51260951E9B28F100402229 /* EntityIdentifier.swift in Sources */, B51260951E9B28F100402229 /* EntityIdentifier.swift in Sources */,

View File

@@ -1,36 +1,25 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<model userDefinedModelVersionIdentifier="" type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="10169.1" systemVersion="15D21" minimumToolsVersion="Automatic"> <model type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="12141" systemVersion="16F73" minimumToolsVersion="Xcode 7.3" sourceLanguage="Objective-C" userDefinedModelVersionIdentifier="">
<entity name="Palette" representedClassName="CoreStoreDemo.Palette">
<attribute name="brightness" optional="YES" attributeType="Float" defaultValueString="0.0" syncable="YES"/>
<attribute name="colorName" optional="YES" transient="YES" attributeType="String" syncable="YES"/>
<attribute name="hue" optional="YES" attributeType="Integer 32" defaultValueString="0.0" syncable="YES"/>
<attribute name="saturation" optional="YES" attributeType="Float" defaultValueString="0.0" syncable="YES"/>
<userInfo/>
</entity>
<entity name="Place" representedClassName="CoreStoreDemo.Place" syncable="YES"> <entity name="Place" representedClassName="CoreStoreDemo.Place" syncable="YES">
<attribute name="latitude" optional="YES" attributeType="Double" defaultValueString="0.0" syncable="YES"/> <attribute name="latitude" optional="YES" attributeType="Double" defaultValueString="0.0" usesScalarValueType="NO" syncable="YES"/>
<attribute name="longitude" optional="YES" attributeType="Double" defaultValueString="0.0" syncable="YES"/> <attribute name="longitude" optional="YES" attributeType="Double" defaultValueString="0.0" usesScalarValueType="NO" syncable="YES"/>
<attribute name="subtitle" optional="YES" attributeType="String" syncable="YES"/> <attribute name="subtitle" optional="YES" attributeType="String" syncable="YES"/>
<attribute name="title" optional="YES" attributeType="String" syncable="YES"/> <attribute name="title" optional="YES" attributeType="String" syncable="YES"/>
</entity> </entity>
<entity name="TimeZone" representedClassName="CoreStoreDemo.TimeZone" syncable="YES"> <entity name="TimeZone" representedClassName="CoreStoreDemo.TimeZone" syncable="YES">
<attribute name="abbreviation" optional="YES" attributeType="String" syncable="YES"/> <attribute name="abbreviation" optional="YES" attributeType="String" syncable="YES"/>
<attribute name="daylightSavingTimeOffset" optional="YES" attributeType="Double" defaultValueString="0.0" syncable="YES"/> <attribute name="daylightSavingTimeOffset" optional="YES" attributeType="Double" defaultValueString="0.0" usesScalarValueType="NO" syncable="YES"/>
<attribute name="hasDaylightSavingTime" optional="YES" attributeType="Boolean" syncable="YES"/> <attribute name="hasDaylightSavingTime" optional="YES" attributeType="Boolean" usesScalarValueType="NO" syncable="YES"/>
<attribute name="name" optional="YES" attributeType="String" syncable="YES"/> <attribute name="name" optional="YES" attributeType="String" syncable="YES"/>
<attribute name="secondsFromGMT" optional="YES" attributeType="Integer 32" defaultValueString="0.0" syncable="YES"/> <attribute name="secondsFromGMT" optional="YES" attributeType="Integer 32" defaultValueString="0.0" usesScalarValueType="NO" syncable="YES"/>
</entity> </entity>
<configuration name="FetchingAndQueryingDemo"> <configuration name="FetchingAndQueryingDemo">
<memberEntity name="TimeZone"/> <memberEntity name="TimeZone"/>
</configuration> </configuration>
<configuration name="ObservingDemo">
<memberEntity name="Palette"/>
</configuration>
<configuration name="TransactionsDemo"> <configuration name="TransactionsDemo">
<memberEntity name="Place"/> <memberEntity name="Place"/>
</configuration> </configuration>
<elements> <elements>
<element name="Palette" positionX="261" positionY="189" width="128" height="105"/>
<element name="Place" positionX="261" positionY="225" width="128" height="105"/> <element name="Place" positionX="261" positionY="225" width="128" height="105"/>
<element name="TimeZone" positionX="297" positionY="270" width="128" height="120"/> <element name="TimeZone" positionX="297" positionY="270" width="128" height="120"/>
</elements> </elements>

View File

@@ -10,7 +10,7 @@ import UIKit
import CoreStore import CoreStore
private struct Static { struct ColorsDemo {
enum Filter: String { enum Filter: String {
@@ -33,8 +33,8 @@ private struct Static {
switch self { switch self {
case .all: return Where(true) case .all: return Where(true)
case .light: return Where("%K >= %@", #keyPath(Palette.brightness), 0.9) case .light: return Palette.where({ $0.brightness >= 0.9 })
case .dark: return Where("%K <= %@", #keyPath(Palette.brightness), 0.4) case .dark: return Palette.where({ $0.brightness <= 0.4 })
} }
} }
} }
@@ -45,25 +45,38 @@ private struct Static {
self.palettes.refetch( self.palettes.refetch(
self.filter.whereClause(), self.filter.whereClause(),
OrderBy(.ascending(#keyPath(Palette.hue))) Palette.orderBy(ascending: { $0.hue })
) )
} }
} }
static let stack: DataStack = {
return DataStack(
CoreStoreSchema(
modelVersion: "ColorsDemo",
entities: [
Entity<Palette>("Palette"),
],
versionLock: [
"Palette": [0x8c25aa53c7c90a28, 0xa243a34d25f1a3a7, 0x56565b6935b6055a, 0x4f988bb257bf274f]
]
)
)
}()
static let palettes: ListMonitor<Palette> = { static let palettes: ListMonitor<Palette> = {
try! CoreStore.addStorageAndWait( try! ColorsDemo.stack.addStorageAndWait(
SQLiteStore( SQLiteStore(
fileName: "ColorsDemo.sqlite", fileName: "ColorsDemo.sqlite",
configuration: "ObservingDemo",
localStorageOptions: .recreateStoreOnModelMismatch localStorageOptions: .recreateStoreOnModelMismatch
) )
) )
return ColorsDemo.stack.monitorSectionedList(
return CoreStore.monitorSectionedList(
From<Palette>(), From<Palette>(),
SectionBy(#keyPath(Palette.colorName)), SectionBy(Palette.keyPath({ $0.colorName })),
OrderBy(.ascending(#keyPath(Palette.hue))) Palette.orderBy(ascending: { $0.hue })
) )
}() }()
} }
@@ -77,7 +90,7 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
deinit { deinit {
Static.palettes.removeObserver(self) ColorsDemo.palettes.removeObserver(self)
} }
@@ -98,7 +111,7 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
] ]
let filterBarButton = UIBarButtonItem( let filterBarButton = UIBarButtonItem(
title: Static.filter.rawValue, title: ColorsDemo.filter.rawValue,
style: .plain, style: .plain,
target: self, target: self,
action: #selector(self.filterBarButtonItemTouched(_:)) action: #selector(self.filterBarButtonItemTouched(_:))
@@ -113,9 +126,9 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
] ]
self.filterBarButton = filterBarButton self.filterBarButton = filterBarButton
Static.palettes.addObserver(self) ColorsDemo.palettes.addObserver(self)
self.setTable(enabled: !Static.palettes.isPendingRefetch) self.setTable(enabled: !ColorsDemo.palettes.isPendingRefetch)
} }
override func prepare(for segue: UIStoryboardSegue, sender: Any?) { override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
@@ -137,19 +150,19 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
override func numberOfSections(in tableView: UITableView) -> Int { override func numberOfSections(in tableView: UITableView) -> Int {
return Static.palettes.numberOfSections() return ColorsDemo.palettes.numberOfSections()
} }
override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int { override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
return Static.palettes.numberOfObjectsInSection(section) return ColorsDemo.palettes.numberOfObjectsInSection(section)
} }
override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell { override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
let cell = tableView.dequeueReusableCell(withIdentifier: "PaletteTableViewCell") as! PaletteTableViewCell let cell = tableView.dequeueReusableCell(withIdentifier: "PaletteTableViewCell") as! PaletteTableViewCell
let palette = Static.palettes[indexPath] let palette = ColorsDemo.palettes[indexPath]
cell.colorView?.backgroundColor = palette.color cell.colorView?.backgroundColor = palette.color
cell.label?.text = palette.colorText cell.label?.text = palette.colorText
@@ -165,7 +178,7 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
self.performSegue( self.performSegue(
withIdentifier: "ObjectObserverDemoViewController", withIdentifier: "ObjectObserverDemoViewController",
sender: Static.palettes[indexPath] sender: ColorsDemo.palettes[indexPath]
) )
} }
@@ -174,8 +187,8 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
switch editingStyle { switch editingStyle {
case .delete: case .delete:
let palette = Static.palettes[indexPath] let palette = ColorsDemo.palettes[indexPath]
CoreStore.perform( ColorsDemo.stack.perform(
asynchronous: { (transaction) in asynchronous: { (transaction) in
transaction.delete(palette) transaction.delete(palette)
@@ -190,7 +203,7 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
override func tableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String? { override func tableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String? {
return Static.palettes.sectionInfoAtIndex(section).name return ColorsDemo.palettes.sectionInfoAtIndex(section).name
} }
@@ -213,7 +226,7 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
func listMonitorDidRefetch(_ monitor: ListMonitor<Palette>) { func listMonitorDidRefetch(_ monitor: ListMonitor<Palette>) {
self.filterBarButton?.title = Static.filter.rawValue self.filterBarButton?.title = ColorsDemo.filter.rawValue
self.tableView.reloadData() self.tableView.reloadData()
self.setTable(enabled: true) self.setTable(enabled: true)
} }
@@ -235,7 +248,7 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
if let cell = self.tableView.cellForRow(at: indexPath) as? PaletteTableViewCell { if let cell = self.tableView.cellForRow(at: indexPath) as? PaletteTableViewCell {
let palette = Static.palettes[indexPath] let palette = ColorsDemo.palettes[indexPath]
cell.colorView?.backgroundColor = palette.color cell.colorView?.backgroundColor = palette.color
cell.label?.text = palette.colorText cell.label?.text = palette.colorText
} }
@@ -268,7 +281,7 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
@IBAction private dynamic func resetBarButtonItemTouched(_ sender: AnyObject?) { @IBAction private dynamic func resetBarButtonItemTouched(_ sender: AnyObject?) {
CoreStore.perform( ColorsDemo.stack.perform(
asynchronous: { (transaction) in asynchronous: { (transaction) in
transaction.deleteAll(From<Palette>()) transaction.deleteAll(From<Palette>())
@@ -279,16 +292,16 @@ class ListObserverDemoViewController: UITableViewController, ListSectionObserver
@IBAction private dynamic func filterBarButtonItemTouched(_ sender: AnyObject?) { @IBAction private dynamic func filterBarButtonItemTouched(_ sender: AnyObject?) {
Static.filter = Static.filter.next() ColorsDemo.filter = ColorsDemo.filter.next()
} }
@IBAction private dynamic func addBarButtonItemTouched(_ sender: AnyObject?) { @IBAction private dynamic func addBarButtonItemTouched(_ sender: AnyObject?) {
CoreStore.perform( ColorsDemo.stack.perform(
asynchronous: { (transaction) in asynchronous: { (transaction) in
let palette = transaction.create(Into<Palette>()) let palette = transaction.create(Into<Palette>())
palette.setInitialValues() palette.setInitialValues(in: transaction)
}, },
completion: { _ in } completion: { _ in }
) )

View File

@@ -29,7 +29,7 @@ class ObjectObserverDemoViewController: UIViewController, ObjectObserver {
if let palette = newValue { if let palette = newValue {
self.monitor = CoreStore.monitorObject(palette) self.monitor = ColorsDemo.stack.monitorObject(palette)
} }
else { else {
@@ -50,22 +50,22 @@ class ObjectObserverDemoViewController: UIViewController, ObjectObserver {
required init?(coder aDecoder: NSCoder) { required init?(coder aDecoder: NSCoder) {
if let palette = CoreStore.fetchOne(From<Palette>(), OrderBy(.ascending(#keyPath(Palette.hue)))) { if let palette = ColorsDemo.stack.fetchOne(From<Palette>(), Palette.orderBy(ascending: { $0.hue })) {
self.monitor = CoreStore.monitorObject(palette) self.monitor = ColorsDemo.stack.monitorObject(palette)
} }
else { else {
_ = try? CoreStore.perform( _ = try? ColorsDemo.stack.perform(
synchronous: { (transaction) in synchronous: { (transaction) in
let palette = transaction.create(Into(Palette.self)) let palette = transaction.create(Into<Palette>())
palette.setInitialValues() palette.setInitialValues(in: transaction)
} }
) )
let palette = CoreStore.fetchOne(From<Palette>(), OrderBy(.ascending(#keyPath(Palette.hue))))! let palette = ColorsDemo.stack.fetchOne(From<Palette>(), Palette.orderBy(ascending: { $0.hue }))!
self.monitor = CoreStore.monitorObject(palette) self.monitor = ColorsDemo.stack.monitorObject(palette)
} }
super.init(coder: aDecoder) super.init(coder: aDecoder)
@@ -121,12 +121,12 @@ class ObjectObserverDemoViewController: UIViewController, ObjectObserver {
@IBAction dynamic func hueSliderValueDidChange(_ sender: AnyObject?) { @IBAction dynamic func hueSliderValueDidChange(_ sender: AnyObject?) {
let hue = self.hueSlider?.value ?? 0 let hue = self.hueSlider?.value ?? 0
CoreStore.perform( ColorsDemo.stack.perform(
asynchronous: { [weak self] (transaction) in asynchronous: { [weak self] (transaction) in
if let palette = transaction.edit(self?.monitor?.object) { if let palette = transaction.edit(self?.monitor?.object) {
palette.hue = Int32(hue) palette.hue .= Int(hue)
} }
}, },
completion: { _ in } completion: { _ in }
@@ -136,12 +136,12 @@ class ObjectObserverDemoViewController: UIViewController, ObjectObserver {
@IBAction dynamic func saturationSliderValueDidChange(_ sender: AnyObject?) { @IBAction dynamic func saturationSliderValueDidChange(_ sender: AnyObject?) {
let saturation = self.saturationSlider?.value ?? 0 let saturation = self.saturationSlider?.value ?? 0
CoreStore.perform( ColorsDemo.stack.perform(
asynchronous: { [weak self] (transaction) in asynchronous: { [weak self] (transaction) in
if let palette = transaction.edit(self?.monitor?.object) { if let palette = transaction.edit(self?.monitor?.object) {
palette.saturation = saturation palette.saturation .= saturation
} }
}, },
completion: { _ in } completion: { _ in }
@@ -151,12 +151,12 @@ class ObjectObserverDemoViewController: UIViewController, ObjectObserver {
@IBAction dynamic func brightnessSliderValueDidChange(_ sender: AnyObject?) { @IBAction dynamic func brightnessSliderValueDidChange(_ sender: AnyObject?) {
let brightness = self.brightnessSlider?.value ?? 0 let brightness = self.brightnessSlider?.value ?? 0
CoreStore.perform( ColorsDemo.stack.perform(
asynchronous: { [weak self] (transaction) in asynchronous: { [weak self] (transaction) in
if let palette = transaction.edit(self?.monitor?.object) { if let palette = transaction.edit(self?.monitor?.object) {
palette.brightness = brightness palette.brightness .= brightness
} }
}, },
completion: { _ in } completion: { _ in }
@@ -165,7 +165,7 @@ class ObjectObserverDemoViewController: UIViewController, ObjectObserver {
@IBAction dynamic func deleteBarButtonTapped(_ sender: AnyObject?) { @IBAction dynamic func deleteBarButtonTapped(_ sender: AnyObject?) {
CoreStore.perform( ColorsDemo.stack.perform(
asynchronous: { [weak self] (transaction) in asynchronous: { [weak self] (transaction) in
transaction.delete(self?.monitor?.object) transaction.delete(self?.monitor?.object)
@@ -176,7 +176,7 @@ class ObjectObserverDemoViewController: UIViewController, ObjectObserver {
func reloadPaletteInfo(_ palette: Palette, changedKeys: Set<String>?) { func reloadPaletteInfo(_ palette: Palette, changedKeys: Set<String>?) {
self.colorNameLabel?.text = palette.colorName self.colorNameLabel?.text = palette.colorName.value
let color = palette.color let color = palette.color
self.colorNameLabel?.textColor = color self.colorNameLabel?.textColor = color
@@ -184,17 +184,17 @@ class ObjectObserverDemoViewController: UIViewController, ObjectObserver {
self.hsbLabel?.text = palette.colorText self.hsbLabel?.text = palette.colorText
if changedKeys == nil || changedKeys?.contains(#keyPath(Palette.hue)) == true { if changedKeys == nil || changedKeys?.contains(Palette.keyPath{ $0.hue }) == true {
self.hueSlider?.value = Float(palette.hue) self.hueSlider?.value = Float(palette.hue.value)
} }
if changedKeys == nil || changedKeys?.contains(#keyPath(Palette.saturation)) == true { if changedKeys == nil || changedKeys?.contains(Palette.keyPath{ $0.saturation }) == true {
self.saturationSlider?.value = palette.saturation self.saturationSlider?.value = palette.saturation.value
} }
if changedKeys == nil || changedKeys?.contains(#keyPath(Palette.brightness)) == true { if changedKeys == nil || changedKeys?.contains(Palette.keyPath{ $0.brightness }) == true {
self.brightnessSlider?.value = palette.brightness self.brightnessSlider?.value = palette.brightness.value
} }
} }
} }

View File

@@ -14,64 +14,65 @@ import CoreStore
// MARK: - Palette // MARK: - Palette
class Palette: NSManagedObject { final class Palette: CoreStoreObject {
@NSManaged var hue: Int32 let hue = Value.Required<Int>("hue")
@NSManaged var saturation: Float let saturation = Value.Required<Float>("saturation")
@NSManaged var brightness: Float let brightness = Value.Required<Float>("brightness")
@objc dynamic var colorName: String { let colorName = Value.Optional<String>(
"colorName",
isTransient: true,
customGetter: Palette.getColorName
)
get { private static func getColorName(_ partialObject: PartialObject<Palette>) -> String? {
let KVCKey = #keyPath(Palette.colorName) if let colorName = partialObject.primitiveValue(for: { $0.colorName }) {
if let colorName = self.getValue(forKvcKey: KVCKey) as? String {
return colorName
}
let colorName: String
switch self.hue % 360 {
case 0 ..< 20: colorName = "Lower Reds"
case 20 ..< 57: colorName = "Oranges and Browns"
case 57 ..< 90: colorName = "Yellow-Greens"
case 90 ..< 159: colorName = "Greens"
case 159 ..< 197: colorName = "Blue-Greens"
case 197 ..< 241: colorName = "Blues"
case 241 ..< 297: colorName = "Violets"
case 297 ..< 331: colorName = "Magentas"
default: colorName = "Upper Reds"
}
self.setPrimitiveValue(colorName, forKey: KVCKey)
return colorName return colorName
} }
set {
self.setValue(newValue.cs_toQueryableNativeType(), forKvcKey: #keyPath(Palette.colorName)) let colorName: String
switch partialObject.value(for: { $0.hue }) % 360 {
case 0 ..< 20: colorName = "Lower Reds"
case 20 ..< 57: colorName = "Oranges and Browns"
case 57 ..< 90: colorName = "Yellow-Greens"
case 90 ..< 159: colorName = "Greens"
case 159 ..< 197: colorName = "Blue-Greens"
case 197 ..< 241: colorName = "Blues"
case 241 ..< 297: colorName = "Violets"
case 297 ..< 331: colorName = "Magentas"
default: colorName = "Upper Reds"
} }
partialObject.setPrimitiveValue(colorName, for: { $0.colorName })
return colorName
} }
}
extension Palette {
var color: UIColor { var color: UIColor {
return UIColor( return UIColor(
hue: CGFloat(self.hue) / 360.0, hue: CGFloat(self.hue.value) / 360.0,
saturation: CGFloat(self.saturation), saturation: CGFloat(self.saturation.value),
brightness: CGFloat(self.brightness), brightness: CGFloat(self.brightness.value),
alpha: 1.0 alpha: 1.0
) )
} }
var colorText: String { var colorText: String {
return "H: \(self.hue)˚, S: \(round(self.saturation * 100.0))%, B: \(round(self.brightness * 100.0))%" return "H: \(self.hue.value)˚, S: \(round(self.saturation.value * 100.0))%, B: \(round(self.brightness.value * 100.0))%"
} }
func setInitialValues() { func setInitialValues(in transaction: BaseDataTransaction) {
self.hue = Int32(arc4random_uniform(360)) self.hue .= Int(arc4random_uniform(360))
self.saturation = 1.0 self.saturation .= Float(1.0)
self.brightness = Float(arc4random_uniform(70) + 30) / 100.0 self.brightness .= Float(arc4random_uniform(70) + 30) / 100.0
} }
} }

View File

@@ -113,7 +113,7 @@ class CustomLoggerViewController: UIViewController, CoreStoreLogger {
case 2?: case 2?:
DispatchQueue.global(qos: .background).async { DispatchQueue.global(qos: .background).async {
_ = self.dataStack.fetchOne(From<Palette>()) _ = self.dataStack.fetchOne(From<Place>())
} }
default: default:

View File

@@ -51,40 +51,50 @@ class Dog: Animal {
} }
class Person: CoreStoreObject { class Person: CoreStoreObject {
let title = Value.Required<String>( let title = Value.Required<String>(
"title", "title",
default: "Mr.", default: "Mr.",
customSetter: { (`self`, setValue, originalNewValue) in customSetter: Person.setTitle
setValue(originalNewValue)
self.displayName .= nil
}
) )
let name = Value.Required<String>( let name = Value.Required<String>(
"name", "name",
customSetter: { (`self`, setValue, originalNewValue) in customSetter: Person.setName
setValue(originalNewValue)
self.displayName .= nil
}
) )
let displayName = Value.Optional<String>( let displayName = Value.Optional<String>(
"displayName", "displayName",
isTransient: true, isTransient: true,
customGetter: Person.cachedDisplayName(_:_:), customGetter: Person.getDisplayName(_:),
affectedByKeyPaths: Person.keyPathsAffectingDisplayName() affectedByKeyPaths: Person.keyPathsAffectingDisplayName()
) )
let pets = Relationship.ToManyUnordered<Animal>("pets", inverse: { $0.master }) let pets = Relationship.ToManyUnordered<Animal>("pets", inverse: { $0.master })
static func cachedDisplayName(_ instance: Person, _ getValue: () -> String?) -> String? { private static func setTitle(_ partialObject: PartialObject<Person>, _ newValue: String) {
if let cached = getValue() { partialObject.setPrimitiveValue(newValue, for: { $0.title })
partialObject.setPrimitiveValue(nil, for: { $0.displayName })
}
return cached private static func setName(_ partialObject: PartialObject<Person>, _ newValue: String) {
partialObject.setPrimitiveValue(newValue, for: { $0.name })
partialObject.setPrimitiveValue(nil, for: { $0.displayName })
}
static func getDisplayName(_ partialObject: PartialObject<Person>) -> String? {
if let displayName = partialObject.primitiveValue(for: { $0.displayName }) {
return displayName
} }
let primitiveValue = "\(instance.title.value) \(instance.name.value)" let title = partialObject.value(for: { $0.title })
instance.displayName .= primitiveValue let name = partialObject.value(for: { $0.name })
return primitiveValue let displayName = "\(title) \(name)"
partialObject.setPrimitiveValue(displayName, for: { $0.displayName })
return displayName
} }
static func keyPathsAffectingDisplayName() -> Set<String> { static func keyPathsAffectingDisplayName() -> Set<String> {

View File

@@ -210,6 +210,7 @@ public final class AsynchronousDataTransaction: BaseDataTransaction {
group.leave() group.leave()
} }
group.wait() group.wait()
self.context.reset()
} }

View File

@@ -135,3 +135,23 @@ open /*abstract*/ class CoreStoreObject: DynamicObject, Hashable {
} }
} }
} }
// MARK: - DynamicObject where Self: CoreStoreObject
public extension DynamicObject where Self: CoreStoreObject {
public func partialObject() -> PartialObject<Self> {
CoreStore.assert(
!self.isMeta,
"Attempted to create a \(cs_typeName(PartialObject<Self>.self)) from a meta object. Meta objects are only used for querying keyPaths and infering types."
)
return PartialObject<Self>(self.rawObject!)
}
internal static var meta: Self {
return self.init(asMeta: ())
}
}

View File

@@ -155,14 +155,3 @@ extension CoreStoreObject {
return self.rawObject! return self.rawObject!
} }
} }
// MARK: - Internal
internal extension DynamicObject where Self: CoreStoreObject {
internal static var meta: Self {
return self.init(asMeta: ())
}
}

View File

@@ -15,7 +15,7 @@
<key>CFBundlePackageType</key> <key>CFBundlePackageType</key>
<string>FMWK</string> <string>FMWK</string>
<key>CFBundleShortVersionString</key> <key>CFBundleShortVersionString</key>
<string>4.0.4</string> <string>4.0.5</string>
<key>CFBundleSignature</key> <key>CFBundleSignature</key>
<string>????</string> <string>????</string>
<key>CFBundleVersion</key> <key>CFBundleVersion</key>

View File

@@ -704,13 +704,13 @@ public final class ListMonitor<D: DynamicObject>: Hashable {
guard let `self` = self, guard let `self` = self,
let userInfo = note.userInfo, let userInfo = note.userInfo,
let object = userInfo[String(describing: NSManagedObject.self)] as? ObjectType else { let rawObject = userInfo[String(describing: NSManagedObject.self)] as? NSManagedObject else {
return return
} }
callback( callback(
self, self,
object, ObjectType.cs_fromRaw(object: rawObject),
userInfo[String(describing: IndexPath.self)] as? IndexPath, userInfo[String(describing: IndexPath.self)] as? IndexPath,
userInfo["\(String(describing: IndexPath.self)).New"] as? IndexPath userInfo["\(String(describing: IndexPath.self)).New"] as? IndexPath
) )

173
Sources/PartialObject.swift Normal file
View File

@@ -0,0 +1,173 @@
//
// PartialObject.swift
// CoreStore
//
// Copyright © 2017 John Rommel Estropia
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
import CoreData
import Foundation
// MARK: - PartialObject
/**
A `PartialObject` is only used when overriding getters and setters for `CoreStoreObject` properties. Custom getters and setters are implemented as a closure that "overrides" the default property getter/setter. The closure receives a `PartialObject<O>`, which acts as a fast, type-safe KVC interface for `CoreStoreObject`. The reason a `CoreStoreObject` instance is not passed directly is because the Core Data runtime is not aware of `CoreStoreObject` properties' static typing, and so loading those info everytime KVO invokes this accessor method incurs a heavy performance hit (especially in KVO-heavy operations such as `ListMonitor` observing.) When accessing the property value from `PartialObject<O>`, make sure to use `PartialObject<O>.persistentValue(for:)` instead of `PartialObject<O>.value(for:)`, which would unintentionally execute the same closure again recursively.
*/
public struct PartialObject<O: CoreStoreObject> {
public func completeObject() -> O {
return O.cs_fromRaw(object: self.rawObject)
}
// MARK: Value.Required accessors/mutators
public func value<V>(for property: (O) -> ValueContainer<O>.Required<V>) -> V {
return V.cs_fromQueryableNativeType(
self.rawObject.value(forKey: property(O.meta).keyPath)! as! V.QueryableNativeType
)!
}
public func setValue<V>(_ value: V, for property: (O) -> ValueContainer<O>.Required<V>) {
self.rawObject.setValue(
value.cs_toQueryableNativeType(),
forKey: property(O.meta).keyPath
)
}
public func primitiveValue<V>(for property: (O) -> ValueContainer<O>.Required<V>) -> V {
return V.cs_fromQueryableNativeType(
self.rawObject.primitiveValue(forKey: property(O.meta).keyPath)! as! V.QueryableNativeType
)!
}
public func setPrimitiveValue<V>(_ value: V, for property: (O) -> ValueContainer<O>.Required<V>) {
self.rawObject.setPrimitiveValue(
value.cs_toQueryableNativeType(),
forKey: property(O.meta).keyPath
)
}
// MARK: Value.Optional utilities
public func value<V>(for property: (O) -> ValueContainer<O>.Optional<V>) -> V? {
return (self.rawObject.value(forKey: property(O.meta).keyPath) as! V.QueryableNativeType?)
.flatMap(V.cs_fromQueryableNativeType)
}
public func setValue<V>(_ value: V?, for property: (O) -> ValueContainer<O>.Optional<V>) {
self.rawObject.setValue(
value?.cs_toQueryableNativeType(),
forKey: property(O.meta).keyPath
)
}
public func primitiveValue<V>(for property: (O) -> ValueContainer<O>.Optional<V>) -> V? {
return (self.rawObject.primitiveValue(forKey: property(O.meta).keyPath) as! V.QueryableNativeType?)
.flatMap(V.cs_fromQueryableNativeType)
}
public func setPrimitiveValue<V>(_ value: V?, for property: (O) -> ValueContainer<O>.Optional<V>) {
self.rawObject.setPrimitiveValue(
value?.cs_toQueryableNativeType(),
forKey: property(O.meta).keyPath
)
}
// MARK: Transformable.Required utilities
public func value<V>(for property: (O) -> TransformableContainer<O>.Required<V>) -> V {
return self.rawObject.value(forKey: property(O.meta).keyPath)! as! V
}
public func setValue<V>(_ value: V, for property: (O) -> TransformableContainer<O>.Required<V>) {
self.rawObject.setValue(
value,
forKey: property(O.meta).keyPath
)
}
public func primitiveValue<V>(for property: (O) -> TransformableContainer<O>.Required<V>) -> V {
return self.rawObject.primitiveValue(forKey: property(O.meta).keyPath)! as! V
}
public func setPrimitiveValue<V>(_ value: V, for property: (O) -> TransformableContainer<O>.Required<V>) {
self.rawObject.setPrimitiveValue(
value,
forKey: property(O.meta).keyPath
)
}
// MARK: Transformable.Optional utilities
public func value<V>(for property: (O) -> TransformableContainer<O>.Optional<V>) -> V? {
return self.rawObject.value(forKey: property(O.meta).keyPath) as! V?
}
public func setValue<V>(_ value: V?, for property: (O) -> TransformableContainer<O>.Optional<V>) {
self.rawObject.setValue(
value,
forKey: property(O.meta).keyPath
)
}
public func primitiveValue<V>(for property: (O) -> TransformableContainer<O>.Optional<V>) -> V? {
return self.rawObject.primitiveValue(forKey: property(O.meta).keyPath) as! V?
}
public func setPrimitiveValue<V>(_ value: V?, for property: (O) -> TransformableContainer<O>.Optional<V>) {
self.rawObject.setPrimitiveValue(
value,
forKey: property(O.meta).keyPath
)
}
// MARK: Internal
internal let rawObject: NSManagedObject
internal init(_ rawObject: NSManagedObject) {
self.rawObject = rawObject
}
}

View File

@@ -158,6 +158,10 @@ public final class SynchronousDataTransaction: BaseDataTransaction {
self.isCommitted = true self.isCommitted = true
let result = self.context.saveSynchronously(waitForMerge: waitForMerge) let result = self.context.saveSynchronously(waitForMerge: waitForMerge)
self.result = result self.result = result
defer {
self.context.reset()
}
return result return result
} }

View File

@@ -93,12 +93,24 @@ public enum ValueContainer<O: CoreStoreObject> {
``` ```
class Person: CoreStoreObject { class Person: CoreStoreObject {
let title = Value.Required<String>("title", default: "Mr.") let title = Value.Required<String>("title", default: "Mr.")
let name = Value.Required<String>( let name = Value.Required<String>("name")
"name", let displayName = Value.Required<String>(
customGetter: { (`self`, getValue) in "displayName",
return "\(self.title.value) \(getValue())" isTransient: true,
} customGetter: Person.getName(_:)
) )
private static func getName(_ partialObject: PartialObject<Person>) -> String {
let cachedDisplayName = partialObject.primitiveValue(for: { $0.displayName })
if !cachedDisplayName.isEmpty {
return cachedDisplayName
}
let title = partialObject.value(for: { $0.title })
let name = partialObject.value(for: { $0.name })
let displayName = "\(title) \(name)"
partialObject.setPrimitiveValue(displayName, for: { $0.displayName })
return displayName
}
} }
``` ```
- parameter keyPath: the permanent attribute name for this property. - parameter keyPath: the permanent attribute name for this property.
@@ -107,13 +119,8 @@ public enum ValueContainer<O: CoreStoreObject> {
- parameter isTransient: `true` if the property is transient, otherwise `false`. Defaults to `false` if not specified. The transient flag specifies whether or not a property's value is ignored when an object is saved to a persistent store. Transient properties are not saved to the persistent store, but are still managed for undo, redo, validation, and so on. - parameter isTransient: `true` if the property is transient, otherwise `false`. Defaults to `false` if not specified. The transient flag specifies whether or not a property's value is ignored when an object is saved to a persistent store. Transient properties are not saved to the persistent store, but are still managed for undo, redo, validation, and so on.
- parameter versionHashModifier: used to mark or denote a property as being a different "version" than another even if all of the values which affect persistence are equal. (Such a difference is important in cases where the properties are unchanged but the format or content of its data are changed.) - parameter versionHashModifier: used to mark or denote a property as being a different "version" than another even if all of the values which affect persistence are equal. (Such a difference is important in cases where the properties are unchanged but the format or content of its data are changed.)
- parameter renamingIdentifier: used to resolve naming conflicts between models. When creating an entity mapping between entities in two managed object models, a source entity property and a destination entity property that share the same identifier indicate that a property mapping should be configured to migrate from the source to the destination. If unset, the identifier will be the property's name. - parameter renamingIdentifier: used to resolve naming conflicts between models. When creating an entity mapping between entities in two managed object models, a source entity property and a destination entity property that share the same identifier indicate that a property mapping should be configured to migrate from the source to the destination. If unset, the identifier will be the property's name.
- parameter customGetter: use this closure to make final transformations to the property's value before returning from the getter. - parameter customGetter: use this closure as an "override" for the default property getter. The closure receives a `PartialObject<O>`, which acts as a fast, type-safe KVC interface for `CoreStoreObject`. The reason a `CoreStoreObject` instance is not passed directly is because the Core Data runtime is not aware of `CoreStoreObject` properties' static typing, and so loading those info everytime KVO invokes this accessor method incurs a cumulative performance hit (especially in KVO-heavy operations such as `ListMonitor` observing.) When accessing the property value from `PartialObject<O>`, make sure to use `PartialObject<O>.primitiveValue(for:)` instead of `PartialObject<O>.value(for:)`, which would unintentionally execute the same closure again recursively.
- parameter self: the `CoreStoreObject` - parameter customSetter: use this closure as an "override" for the default property setter. The closure receives a `PartialObject<O>`, which acts as a fast, type-safe KVC interface for `CoreStoreObject`. The reason a `CoreStoreObject` instance is not passed directly is because the Core Data runtime is not aware of `CoreStoreObject` properties' static typing, and so loading those info everytime KVO invokes this accessor method incurs a cumulative performance hit (especially in KVO-heavy operations such as `ListMonitor` observing.) When accessing the property value from `PartialObject<O>`, make sure to use `PartialObject<O>.setPrimitiveValue(_:for:)` instead of `PartialObject<O>.setValue(_:for:)`, which would unintentionally execute the same closure again recursively.
- parameter getValue: the original getter for the property
- parameter customSetter: use this closure to make final transformations to the new value before assigning to the property.
- parameter setValue: the original setter for the property
- parameter finalNewValue: the transformed new value
- parameter originalNewValue: the original new value
- parameter affectedByKeyPaths: a set of key paths for properties whose values affect the value of the receiver. This is similar to `NSManagedObject.keyPathsForValuesAffectingValue(forKey:)`. - parameter affectedByKeyPaths: a set of key paths for properties whose values affect the value of the receiver. This is similar to `NSManagedObject.keyPathsForValuesAffectingValue(forKey:)`.
*/ */
public init( public init(
@@ -123,8 +130,8 @@ public enum ValueContainer<O: CoreStoreObject> {
isTransient: Bool = false, isTransient: Bool = false,
versionHashModifier: String? = nil, versionHashModifier: String? = nil,
renamingIdentifier: String? = nil, renamingIdentifier: String? = nil,
customGetter: ((_ `self`: O, _ getValue: () -> V) -> V)? = nil, customGetter: ((_ partialObject: PartialObject<O>) -> V)? = nil,
customSetter: ((_ `self`: O, _ setValue: (_ finalNewValue: V) -> Void, _ originalNewValue: V) -> Void)? = nil, customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V) -> Void)? = nil,
affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) { affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) {
self.keyPath = keyPath self.keyPath = keyPath
@@ -155,17 +162,13 @@ public enum ValueContainer<O: CoreStoreObject> {
object.rawObject!.isRunningInAllowedQueue() == true, object.rawObject!.isRunningInAllowedQueue() == true,
"Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue." "Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue."
) )
let customGetter = (self.customGetter ?? { $1() }) if let customGetter = self.customGetter {
return customGetter(
object,
{ () -> V in
return object.rawObject!.getValue( return customGetter(PartialObject<O>(object.rawObject!))
forKvcKey: self.keyPath, }
didGetValue: { V.cs_fromQueryableNativeType($0 as! V.QueryableNativeType)! } return V.cs_fromQueryableNativeType(
) object.rawObject!.value(forKey: self.keyPath)! as! V.QueryableNativeType
} )!
)
} }
} }
set { set {
@@ -181,21 +184,16 @@ public enum ValueContainer<O: CoreStoreObject> {
"Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue." "Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue."
) )
CoreStore.assert( CoreStore.assert(
self.isTransient || object.rawObject!.isEditableInContext() == true, object.rawObject!.isEditableInContext() == true,
"Attempted to update a \(cs_typeName(O.self))'s value from outside a transaction." "Attempted to update a \(cs_typeName(O.self))'s value from outside a transaction."
) )
let customSetter = (self.customSetter ?? { $1($2) }) if let customSetter = self.customSetter {
customSetter(
object,
{ (newValue: V) -> Void in
object.rawObject!.setValue( return customSetter(PartialObject<O>(object.rawObject!), newValue)
newValue, }
forKvcKey: self.keyPath, return object.rawObject!.setValue(
willSetValue: { $0.cs_toQueryableNativeType() } newValue.cs_toQueryableNativeType(),
) forKey: self.keyPath
},
newValue
) )
} }
} }
@@ -230,15 +228,12 @@ public enum ValueContainer<O: CoreStoreObject> {
return { (_ id: Any) -> Any? in return { (_ id: Any) -> Any? in
let rawObject = id as! CoreStoreManagedObject let rawObject = id as! CoreStoreManagedObject
let value = customGetter( rawObject.willAccessValue(forKey: keyPath)
O.cs_fromRaw(object: rawObject), defer {
{
rawObject.getValue( rawObject.didAccessValue(forKey: keyPath)
forKvcKey: keyPath, }
didGetValue: { V.cs_fromQueryableNativeType($0 as! V.QueryableNativeType!)! } let value = customGetter(PartialObject<O>(rawObject))
)
}
)
return value.cs_toQueryableNativeType() return value.cs_toQueryableNativeType()
} }
} }
@@ -253,16 +248,13 @@ public enum ValueContainer<O: CoreStoreObject> {
return { (_ id: Any, _ newValue: Any?) -> Void in return { (_ id: Any, _ newValue: Any?) -> Void in
let rawObject = id as! CoreStoreManagedObject let rawObject = id as! CoreStoreManagedObject
customSetter( rawObject.willChangeValue(forKey: keyPath)
O.cs_fromRaw(object: rawObject), defer {
{ (userValue: V) -> Void in
rawObject.setValue( rawObject.didChangeValue(forKey: keyPath)
userValue, }
forKvcKey: keyPath, customSetter(
willSetValue: { $0.cs_toQueryableNativeType() } PartialObject<O>(rawObject),
)
},
V.cs_fromQueryableNativeType(newValue as! V.QueryableNativeType)! V.cs_fromQueryableNativeType(newValue as! V.QueryableNativeType)!
) )
} }
@@ -271,8 +263,8 @@ public enum ValueContainer<O: CoreStoreObject> {
// MARK: Private // MARK: Private
private let customGetter: ((_ `self`: O, _ getValue: () -> V) -> V)? private let customGetter: ((_ partialObject: PartialObject<O>) -> V)?
private let customSetter: ((_ `self`: O, _ setValue: (V) -> Void, _ newValue: V) -> Void)? private let customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V) -> Void)?
} }
@@ -295,13 +287,24 @@ public enum ValueContainer<O: CoreStoreObject> {
Initializes the metadata for the property. Initializes the metadata for the property.
``` ```
class Person: CoreStoreObject { class Person: CoreStoreObject {
let title = Value.Required<String>("title", default: "Mr.") let title = Value.Optional<String>("title", default: "Mr.")
let name = Value.Required<String>( let name = Value.Optional<String>("name")
"name", let displayName = Value.Optional<String>(
customGetter: { (`self`, getValue) in "displayName",
return "\(self.title.value) \(getValue())" isTransient: true,
} customGetter: Person.getName(_:)
) )
private static func getName(_ partialObject: PartialObject<Person>) -> String? {
if let cachedDisplayName = partialObject.primitiveValue(for: { $0.displayName }) {
return cachedDisplayName
}
let title = partialObject.value(for: { $0.title })
let name = partialObject.value(for: { $0.name })
let displayName = "\(title) \(name)"
partialObject.setPrimitiveValue(displayName, for: { $0.displayName })
return displayName
}
} }
``` ```
- parameter keyPath: the permanent attribute name for this property. - parameter keyPath: the permanent attribute name for this property.
@@ -326,8 +329,8 @@ public enum ValueContainer<O: CoreStoreObject> {
isTransient: Bool = false, isTransient: Bool = false,
versionHashModifier: String? = nil, versionHashModifier: String? = nil,
renamingIdentifier: String? = nil, renamingIdentifier: String? = nil,
customGetter: ((_ `self`: O, _ getValue: () -> V?) -> V?)? = nil, customGetter: ((_ partialObject: PartialObject<O>) -> V?)? = nil,
customSetter: ((_ `self`: O, _ setValue: (_ finalNewValue: V?) -> Void, _ originalNewValue: V?) -> Void)? = nil, customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V?) -> Void)? = nil,
affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) { affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) {
self.keyPath = keyPath self.keyPath = keyPath
@@ -358,17 +361,12 @@ public enum ValueContainer<O: CoreStoreObject> {
object.rawObject!.isRunningInAllowedQueue() == true, object.rawObject!.isRunningInAllowedQueue() == true,
"Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue." "Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue."
) )
let customGetter = (self.customGetter ?? { $1() }) if let customGetter = self.customGetter {
return customGetter(
object,
{ () -> V? in
return object.rawObject!.getValue( return customGetter(PartialObject<O>(object.rawObject!))
forKvcKey: self.keyPath, }
didGetValue: { ($0 as! V.QueryableNativeType?).flatMap(V.cs_fromQueryableNativeType) } return (object.rawObject!.value(forKey: self.keyPath) as! V.QueryableNativeType?)
) .flatMap(V.cs_fromQueryableNativeType)
}
)
} }
} }
set { set {
@@ -384,21 +382,16 @@ public enum ValueContainer<O: CoreStoreObject> {
"Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue." "Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue."
) )
CoreStore.assert( CoreStore.assert(
self.isTransient || object.rawObject!.isEditableInContext() == true, object.rawObject!.isEditableInContext() == true,
"Attempted to update a \(cs_typeName(O.self))'s value from outside a transaction." "Attempted to update a \(cs_typeName(O.self))'s value from outside a transaction."
) )
let customSetter = (self.customSetter ?? { $1($2) }) if let customSetter = self.customSetter {
customSetter(
object,
{ (newValue: V?) -> Void in
object.rawObject!.setValue( return customSetter(PartialObject<O>(object.rawObject!), newValue)
newValue, }
forKvcKey: self.keyPath, object.rawObject!.setValue(
willSetValue: { $0?.cs_toQueryableNativeType() } newValue?.cs_toQueryableNativeType(),
) forKey: self.keyPath
},
newValue
) )
} }
} }
@@ -432,15 +425,12 @@ public enum ValueContainer<O: CoreStoreObject> {
return { (_ id: Any) -> Any? in return { (_ id: Any) -> Any? in
let rawObject = id as! CoreStoreManagedObject let rawObject = id as! CoreStoreManagedObject
let value = customGetter( rawObject.willAccessValue(forKey: keyPath)
O.cs_fromRaw(object: rawObject), defer {
{
rawObject.getValue( rawObject.didAccessValue(forKey: keyPath)
forKvcKey: keyPath, }
didGetValue: { ($0 as! V.QueryableNativeType?).flatMap(V.cs_fromQueryableNativeType) } let value = customGetter(PartialObject<O>(rawObject))
)
}
)
return value?.cs_toQueryableNativeType() return value?.cs_toQueryableNativeType()
} }
} }
@@ -455,16 +445,13 @@ public enum ValueContainer<O: CoreStoreObject> {
return { (_ id: Any, _ newValue: Any?) -> Void in return { (_ id: Any, _ newValue: Any?) -> Void in
let rawObject = id as! CoreStoreManagedObject let rawObject = id as! CoreStoreManagedObject
customSetter( rawObject.willChangeValue(forKey: keyPath)
O.cs_fromRaw(object: rawObject), defer {
{ (userValue: V?) -> Void in
rawObject.setValue( rawObject.didChangeValue(forKey: keyPath)
userValue, }
forKvcKey: keyPath, customSetter(
willSetValue: { $0?.cs_toQueryableNativeType() } PartialObject<O>(rawObject),
)
},
(newValue as! V.QueryableNativeType?).flatMap(V.cs_fromQueryableNativeType) (newValue as! V.QueryableNativeType?).flatMap(V.cs_fromQueryableNativeType)
) )
} }
@@ -473,8 +460,8 @@ public enum ValueContainer<O: CoreStoreObject> {
// MARK: Private // MARK: Private
private let customGetter: ((_ `self`: O, _ getValue: () -> V?) -> V?)? private let customGetter: ((_ partialObject: PartialObject<O>) -> V?)?
private let customSetter: ((_ `self`: O, _ setValue: (V?) -> Void, _ newValue: V?) -> Void)? private let customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V?) -> Void)?
} }
} }
@@ -484,7 +471,8 @@ public extension ValueContainer.Required where V: EmptyableAttributeType {
Initializes the metadata for the property. This convenience initializer uses the `EmptyableAttributeType`'s "empty" value as the initial value for the property when the object is first created (e.g. `false` for `Bool`, `0` for `Int`, `""` for `String`, etc.) Initializes the metadata for the property. This convenience initializer uses the `EmptyableAttributeType`'s "empty" value as the initial value for the property when the object is first created (e.g. `false` for `Bool`, `0` for `Int`, `""` for `String`, etc.)
``` ```
class Person: CoreStoreObject { class Person: CoreStoreObject {
let title = Value.Required<String>("title") // initial value defaults to empty string let title = Value.Required<String>("title", default: "Mr.") // explicit default value
let name = Value.Required<String>("name") // initial value defaults to empty string
} }
``` ```
- parameter keyPath: the permanent attribute name for this property. - parameter keyPath: the permanent attribute name for this property.
@@ -492,13 +480,8 @@ public extension ValueContainer.Required where V: EmptyableAttributeType {
- parameter isTransient: `true` if the property is transient, otherwise `false`. Defaults to `false` if not specified. The transient flag specifies whether or not a property's value is ignored when an object is saved to a persistent store. Transient properties are not saved to the persistent store, but are still managed for undo, redo, validation, and so on. - parameter isTransient: `true` if the property is transient, otherwise `false`. Defaults to `false` if not specified. The transient flag specifies whether or not a property's value is ignored when an object is saved to a persistent store. Transient properties are not saved to the persistent store, but are still managed for undo, redo, validation, and so on.
- parameter versionHashModifier: used to mark or denote a property as being a different "version" than another even if all of the values which affect persistence are equal. (Such a difference is important in cases where the properties are unchanged but the format or content of its data are changed.) - parameter versionHashModifier: used to mark or denote a property as being a different "version" than another even if all of the values which affect persistence are equal. (Such a difference is important in cases where the properties are unchanged but the format or content of its data are changed.)
- parameter renamingIdentifier: used to resolve naming conflicts between models. When creating an entity mapping between entities in two managed object models, a source entity property and a destination entity property that share the same identifier indicate that a property mapping should be configured to migrate from the source to the destination. If unset, the identifier will be the property's name. - parameter renamingIdentifier: used to resolve naming conflicts between models. When creating an entity mapping between entities in two managed object models, a source entity property and a destination entity property that share the same identifier indicate that a property mapping should be configured to migrate from the source to the destination. If unset, the identifier will be the property's name.
- parameter customGetter: use this closure to make final transformations to the property's value before returning from the getter. - parameter customGetter: use this closure as an "override" for the default property getter. The closure receives a `PartialObject<O>`, which acts as a fast, type-safe KVC interface for `CoreStoreObject`. The reason a `CoreStoreObject` instance is not passed directly is because the Core Data runtime is not aware of `CoreStoreObject` properties' static typing, and so loading those info everytime KVO invokes this accessor method incurs a cumulative performance hit (especially in KVO-heavy operations such as `ListMonitor` observing.) When accessing the property value from `PartialObject<O>`, make sure to use `PartialObject<O>.primitiveValue(for:)` instead of `PartialObject<O>.value(for:)`, which would unintentionally execute the same closure again recursively.
- parameter self: the `CoreStoreObject` - parameter customSetter: use this closure as an "override" for the default property setter. The closure receives a `PartialObject<O>`, which acts as a fast, type-safe KVC interface for `CoreStoreObject`. The reason a `CoreStoreObject` instance is not passed directly is because the Core Data runtime is not aware of `CoreStoreObject` properties' static typing, and so loading those info everytime KVO invokes this accessor method incurs a cumulative performance hit (especially in KVO-heavy operations such as `ListMonitor` observing.) When accessing the property value from `PartialObject<O>`, make sure to use `PartialObject<O>.setPrimitiveValue(_:for:)` instead of `PartialObject<O>.setValue(_:for:)`, which would unintentionally execute the same closure again recursively.
- parameter getValue: the original getter for the property
- parameter customSetter: use this closure to make final transformations to the new value before assigning to the property.
- parameter setValue: the original setter for the property
- parameter finalNewValue: the transformed new value
- parameter originalNewValue: the original new value
- parameter affectedByKeyPaths: a set of key paths for properties whose values affect the value of the receiver. This is similar to `NSManagedObject.keyPathsForValuesAffectingValue(forKey:)`. - parameter affectedByKeyPaths: a set of key paths for properties whose values affect the value of the receiver. This is similar to `NSManagedObject.keyPathsForValuesAffectingValue(forKey:)`.
*/ */
public convenience init( public convenience init(
@@ -507,8 +490,8 @@ public extension ValueContainer.Required where V: EmptyableAttributeType {
isTransient: Bool = false, isTransient: Bool = false,
versionHashModifier: String? = nil, versionHashModifier: String? = nil,
renamingIdentifier: String? = nil, renamingIdentifier: String? = nil,
customGetter: ((_ `self`: O, _ getValue: () -> V) -> V)? = nil, customGetter: ((_ partialObject: PartialObject<O>) -> V)? = nil,
customSetter: ((_ `self`: O, _ setValue: (_ finalNewValue: V) -> Void, _ originalNewValue: V) -> Void)? = nil, customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V) -> Void)? = nil,
affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) { affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) {
self.init( self.init(
@@ -559,7 +542,30 @@ public enum TransformableContainer<O: CoreStoreObject> {
Initializes the metadata for the property. Initializes the metadata for the property.
``` ```
class Animal: CoreStoreObject { class Animal: CoreStoreObject {
let color = Transformable.Optional<UIColor>("color") let species = Value.Required<String>("species")
let color = Transformable.Required<UIColor>(
"color",
default: UIColor.clear,
isTransient: true,
customGetter: Animal.getColor(_:)
)
}
private static func getColor(_ partialObject: PartialObject<Animal>) -> UIColor {
let cachedColor = partialObject.primitiveValue(for: { $0.color })
if cachedColor != UIColor.clear {
return cachedColor
}
let color: UIColor
switch partialObject.value(for: { $0.species }) {
case "Swift": color = UIColor.orange
case "Bulbasaur": color = UIColor.green
default: color = UIColor.black
}
partialObject.setPrimitiveValue(color, for: { $0.color })
return color
} }
``` ```
- parameter keyPath: the permanent attribute name for this property. - parameter keyPath: the permanent attribute name for this property.
@@ -568,13 +574,8 @@ public enum TransformableContainer<O: CoreStoreObject> {
- parameter isTransient: `true` if the property is transient, otherwise `false`. Defaults to `false` if not specified. The transient flag specifies whether or not a property's value is ignored when an object is saved to a persistent store. Transient properties are not saved to the persistent store, but are still managed for undo, redo, validation, and so on. - parameter isTransient: `true` if the property is transient, otherwise `false`. Defaults to `false` if not specified. The transient flag specifies whether or not a property's value is ignored when an object is saved to a persistent store. Transient properties are not saved to the persistent store, but are still managed for undo, redo, validation, and so on.
- parameter versionHashModifier: used to mark or denote a property as being a different "version" than another even if all of the values which affect persistence are equal. (Such a difference is important in cases where the properties are unchanged but the format or content of its data are changed.) - parameter versionHashModifier: used to mark or denote a property as being a different "version" than another even if all of the values which affect persistence are equal. (Such a difference is important in cases where the properties are unchanged but the format or content of its data are changed.)
- parameter renamingIdentifier: used to resolve naming conflicts between models. When creating an entity mapping between entities in two managed object models, a source entity property and a destination entity property that share the same identifier indicate that a property mapping should be configured to migrate from the source to the destination. If unset, the identifier will be the property's name. - parameter renamingIdentifier: used to resolve naming conflicts between models. When creating an entity mapping between entities in two managed object models, a source entity property and a destination entity property that share the same identifier indicate that a property mapping should be configured to migrate from the source to the destination. If unset, the identifier will be the property's name.
- parameter customGetter: use this closure to make final transformations to the property's value before returning from the getter. - parameter customGetter: use this closure as an "override" for the default property getter. The closure receives a `PartialObject<O>`, which acts as a fast, type-safe KVC interface for `CoreStoreObject`. The reason a `CoreStoreObject` instance is not passed directly is because the Core Data runtime is not aware of `CoreStoreObject` properties' static typing, and so loading those info everytime KVO invokes this accessor method incurs a cumulative performance hit (especially in KVO-heavy operations such as `ListMonitor` observing.) When accessing the property value from `PartialObject<O>`, make sure to use `PartialObject<O>.primitiveValue(for:)` instead of `PartialObject<O>.value(for:)`, which would unintentionally execute the same closure again recursively.
- parameter self: the `CoreStoreObject` - parameter customSetter: use this closure as an "override" for the default property setter. The closure receives a `PartialObject<O>`, which acts as a fast, type-safe KVC interface for `CoreStoreObject`. The reason a `CoreStoreObject` instance is not passed directly is because the Core Data runtime is not aware of `CoreStoreObject` properties' static typing, and so loading those info everytime KVO invokes this accessor method incurs a cumulative performance hit (especially in KVO-heavy operations such as `ListMonitor` observing.) When accessing the property value from `PartialObject<O>`, make sure to use `PartialObject<O>.setPrimitiveValue(_:for:)` instead of `PartialObject<O>.setValue(_:for:)`, which would unintentionally execute the same closure again recursively.
- parameter getValue: the original getter for the property
- parameter customSetter: use this closure to make final transformations to the new value before assigning to the property.
- parameter setValue: the original setter for the property
- parameter finalNewValue: the transformed new value
- parameter originalNewValue: the original new value
- parameter affectedByKeyPaths: a set of key paths for properties whose values affect the value of the receiver. This is similar to `NSManagedObject.keyPathsForValuesAffectingValue(forKey:)`. - parameter affectedByKeyPaths: a set of key paths for properties whose values affect the value of the receiver. This is similar to `NSManagedObject.keyPathsForValuesAffectingValue(forKey:)`.
*/ */
public init( public init(
@@ -584,8 +585,8 @@ public enum TransformableContainer<O: CoreStoreObject> {
isTransient: Bool = false, isTransient: Bool = false,
versionHashModifier: String? = nil, versionHashModifier: String? = nil,
renamingIdentifier: String? = nil, renamingIdentifier: String? = nil,
customGetter: ((_ `self`: O, _ getValue: () -> V) -> V)? = nil, customGetter: ((_ partialObject: PartialObject<O>) -> V)? = nil,
customSetter: ((_ `self`: O, _ setValue: (_ finalNewValue: V) -> Void, _ originalNewValue: V) -> Void)? = nil, customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V) -> Void)? = nil,
affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) { affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) {
self.keyPath = keyPath self.keyPath = keyPath
@@ -616,17 +617,11 @@ public enum TransformableContainer<O: CoreStoreObject> {
object.rawObject!.isRunningInAllowedQueue() == true, object.rawObject!.isRunningInAllowedQueue() == true,
"Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue." "Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue."
) )
let customGetter = (self.customGetter ?? { $1() }) if let customGetter = self.customGetter {
return customGetter(
object,
{ () -> V in
return object.rawObject!.getValue( return customGetter(PartialObject<O>(object.rawObject!))
forKvcKey: self.keyPath, }
didGetValue: { $0 as! V } return object.rawObject!.value(forKey: self.keyPath)! as! V
)
}
)
} }
} }
set { set {
@@ -642,20 +637,16 @@ public enum TransformableContainer<O: CoreStoreObject> {
"Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue." "Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue."
) )
CoreStore.assert( CoreStore.assert(
self.isTransient || object.rawObject!.isEditableInContext() == true, object.rawObject!.isEditableInContext() == true,
"Attempted to update a \(cs_typeName(O.self))'s value from outside a transaction." "Attempted to update a \(cs_typeName(O.self))'s value from outside a transaction."
) )
let customSetter = (self.customSetter ?? { $1($2) }) if let customSetter = self.customSetter {
customSetter(
object,
{ (newValue: V) -> Void in
object.rawObject!.setValue( return customSetter(PartialObject<O>(object.rawObject!), newValue)
newValue, }
forKvcKey: self.keyPath object.rawObject!.setValue(
) newValue,
}, forKey: self.keyPath
newValue
) )
} }
} }
@@ -690,10 +681,13 @@ public enum TransformableContainer<O: CoreStoreObject> {
return { (_ id: Any) -> Any? in return { (_ id: Any) -> Any? in
let rawObject = id as! CoreStoreManagedObject let rawObject = id as! CoreStoreManagedObject
return customGetter( rawObject.willAccessValue(forKey: keyPath)
O.cs_fromRaw(object: rawObject), defer {
{ rawObject.getValue(forKvcKey: keyPath) as! V }
) rawObject.didAccessValue(forKey: keyPath)
}
let value = customGetter(PartialObject<O>(rawObject))
return value
} }
} }
@@ -707,12 +701,13 @@ public enum TransformableContainer<O: CoreStoreObject> {
return { (_ id: Any, _ newValue: Any?) -> Void in return { (_ id: Any, _ newValue: Any?) -> Void in
let rawObject = id as! CoreStoreManagedObject let rawObject = id as! CoreStoreManagedObject
customSetter( rawObject.willChangeValue(forKey: keyPath)
O.cs_fromRaw(object: rawObject), defer {
{ (userValue: V) -> Void in
rawObject.setValue(userValue, forKvcKey: keyPath) rawObject.didChangeValue(forKey: keyPath)
}, }
customSetter(
PartialObject<O>(rawObject),
newValue as! V newValue as! V
) )
} }
@@ -721,8 +716,8 @@ public enum TransformableContainer<O: CoreStoreObject> {
// MARK: Private // MARK: Private
private let customGetter: ((_ `self`: O, _ getValue: () -> V) -> V)? private let customGetter: ((_ partialObject: PartialObject<O>) -> V)?
private let customSetter: ((_ `self`: O, _ setValue: (V) -> Void, _ newValue: V) -> Void)? private let customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V) -> Void)?
} }
@@ -745,7 +740,27 @@ public enum TransformableContainer<O: CoreStoreObject> {
Initializes the metadata for the property. Initializes the metadata for the property.
``` ```
class Animal: CoreStoreObject { class Animal: CoreStoreObject {
let color = Transformable.Optional<UIColor>("color") let species = Value.Required<String>("species")
let color = Transformable.Optional<UIColor>(
"color",
isTransient: true,
customGetter: Animal.getColor(_:)
)
}
private static func getColor(_ partialObject: PartialObject<Animal>) -> UIColor? {
if let cachedColor = partialObject.primitiveValue(for: { $0.color }) {
return cachedColor
}
let color: UIColor?
switch partialObject.value(for: { $0.species }) {
case "Swift": color = UIColor.orange
case "Bulbasaur": color = UIColor.green
default: return nil
}
partialObject.setPrimitiveValue(color, for: { $0.color })
return color
} }
``` ```
- parameter keyPath: the permanent attribute name for this property. - parameter keyPath: the permanent attribute name for this property.
@@ -754,13 +769,8 @@ public enum TransformableContainer<O: CoreStoreObject> {
- parameter isTransient: `true` if the property is transient, otherwise `false`. Defaults to `false` if not specified. The transient flag specifies whether or not a property's value is ignored when an object is saved to a persistent store. Transient properties are not saved to the persistent store, but are still managed for undo, redo, validation, and so on. - parameter isTransient: `true` if the property is transient, otherwise `false`. Defaults to `false` if not specified. The transient flag specifies whether or not a property's value is ignored when an object is saved to a persistent store. Transient properties are not saved to the persistent store, but are still managed for undo, redo, validation, and so on.
- parameter versionHashModifier: used to mark or denote a property as being a different "version" than another even if all of the values which affect persistence are equal. (Such a difference is important in cases where the properties are unchanged but the format or content of its data are changed.) - parameter versionHashModifier: used to mark or denote a property as being a different "version" than another even if all of the values which affect persistence are equal. (Such a difference is important in cases where the properties are unchanged but the format or content of its data are changed.)
- parameter renamingIdentifier: used to resolve naming conflicts between models. When creating an entity mapping between entities in two managed object models, a source entity property and a destination entity property that share the same identifier indicate that a property mapping should be configured to migrate from the source to the destination. If unset, the identifier will be the property's name. - parameter renamingIdentifier: used to resolve naming conflicts between models. When creating an entity mapping between entities in two managed object models, a source entity property and a destination entity property that share the same identifier indicate that a property mapping should be configured to migrate from the source to the destination. If unset, the identifier will be the property's name.
- parameter customGetter: use this closure to make final transformations to the property's value before returning from the getter. - parameter customGetter: use this closure as an "override" for the default property getter. The closure receives a `PartialObject<O>`, which acts as a fast, type-safe KVC interface for `CoreStoreObject`. The reason a `CoreStoreObject` instance is not passed directly is because the Core Data runtime is not aware of `CoreStoreObject` properties' static typing, and so loading those info everytime KVO invokes this accessor method incurs a cumulative performance hit (especially in KVO-heavy operations such as `ListMonitor` observing.) When accessing the property value from `PartialObject<O>`, make sure to use `PartialObject<O>.primitiveValue(for:)` instead of `PartialObject<O>.value(for:)`, which would unintentionally execute the same closure again recursively.
- parameter self: the `CoreStoreObject` - parameter customSetter: use this closure as an "override" for the default property setter. The closure receives a `PartialObject<O>`, which acts as a fast, type-safe KVC interface for `CoreStoreObject`. The reason a `CoreStoreObject` instance is not passed directly is because the Core Data runtime is not aware of `CoreStoreObject` properties' static typing, and so loading those info everytime KVO invokes this accessor method incurs a cumulative performance hit (especially in KVO-heavy operations such as `ListMonitor` observing.) When accessing the property value from `PartialObject<O>`, make sure to use `PartialObject<O>.setPrimitiveValue(_:for:)` instead of `PartialObject<O>.setValue(_:for:)`, which would unintentionally execute the same closure again recursively.
- parameter getValue: the original getter for the property
- parameter customSetter: use this closure to make final transformations to the new value before assigning to the property.
- parameter setValue: the original setter for the property
- parameter finalNewValue: the transformed new value
- parameter originalNewValue: the original new value
- parameter affectedByKeyPaths: a set of key paths for properties whose values affect the value of the receiver. This is similar to `NSManagedObject.keyPathsForValuesAffectingValue(forKey:)`. - parameter affectedByKeyPaths: a set of key paths for properties whose values affect the value of the receiver. This is similar to `NSManagedObject.keyPathsForValuesAffectingValue(forKey:)`.
*/ */
public init( public init(
@@ -770,8 +780,8 @@ public enum TransformableContainer<O: CoreStoreObject> {
isTransient: Bool = false, isTransient: Bool = false,
versionHashModifier: String? = nil, versionHashModifier: String? = nil,
renamingIdentifier: String? = nil, renamingIdentifier: String? = nil,
customGetter: ((_ `self`: O, _ getValue: () -> V?) -> V?)? = nil, customGetter: ((_ partialObject: PartialObject<O>) -> V?)? = nil,
customSetter: ((_ `self`: O, _ setValue: (_ finalNewValue: V?) -> Void, _ originalNewValue: V?) -> Void)? = nil, customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V?) -> Void)? = nil,
affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) { affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) {
self.keyPath = keyPath self.keyPath = keyPath
@@ -802,17 +812,11 @@ public enum TransformableContainer<O: CoreStoreObject> {
object.rawObject!.isRunningInAllowedQueue() == true, object.rawObject!.isRunningInAllowedQueue() == true,
"Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue." "Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue."
) )
let customGetter = (self.customGetter ?? { $1() }) if let customGetter = self.customGetter {
return customGetter(
object,
{ () -> V? in
return object.rawObject!.getValue( return customGetter(PartialObject<O>(object.rawObject!))
forKvcKey: self.keyPath, }
didGetValue: { $0 as! V? } return object.rawObject!.value(forKey: self.keyPath) as! V?
)
}
)
} }
} }
set { set {
@@ -828,20 +832,16 @@ public enum TransformableContainer<O: CoreStoreObject> {
"Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue." "Attempted to access \(cs_typeName(O.self))'s value outside it's designated queue."
) )
CoreStore.assert( CoreStore.assert(
self.isTransient || object.rawObject!.isEditableInContext() == true, object.rawObject!.isEditableInContext() == true,
"Attempted to update a \(cs_typeName(O.self))'s value from outside a transaction." "Attempted to update a \(cs_typeName(O.self))'s value from outside a transaction."
) )
let customSetter = (self.customSetter ?? { $1($2) }) if let customSetter = self.customSetter {
customSetter(
object,
{ (newValue: V?) -> Void in
object.rawObject!.setValue( return customSetter(PartialObject<O>(object.rawObject!), newValue)
newValue, }
forKvcKey: self.keyPath object.rawObject!.setValue(
) newValue,
}, forKey: self.keyPath
newValue
) )
} }
} }
@@ -876,37 +876,33 @@ public enum TransformableContainer<O: CoreStoreObject> {
return { (_ id: Any) -> Any? in return { (_ id: Any) -> Any? in
let rawObject = id as! CoreStoreManagedObject let rawObject = id as! CoreStoreManagedObject
return customGetter( rawObject.willAccessValue(forKey: keyPath)
O.cs_fromRaw(object: rawObject), defer {
{ rawObject.getValue(forKvcKey: keyPath) as! V? }
) rawObject.didAccessValue(forKey: keyPath)
}
let value = customGetter(PartialObject<O>(rawObject))
return value
} }
} }
internal private(set) lazy var setter: CoreStoreManagedObject.CustomSetter? = cs_lazy { [unowned self] in internal private(set) lazy var setter: CoreStoreManagedObject.CustomSetter? = cs_lazy { [unowned self] in
let keyPath = self.keyPath
guard let customSetter = self.customSetter else { guard let customSetter = self.customSetter else {
guard let _ = self.customGetter else { return nil
return nil
}
return { (_ id: Any, _ newValue: Any?) -> Void in
let rawObject = id as! CoreStoreManagedObject
rawObject.setValue(newValue, forKvcKey: keyPath)
}
} }
let keyPath = self.keyPath
return { (_ id: Any, _ newValue: Any?) -> Void in return { (_ id: Any, _ newValue: Any?) -> Void in
let rawObject = id as! CoreStoreManagedObject let rawObject = id as! CoreStoreManagedObject
customSetter( rawObject.willChangeValue(forKey: keyPath)
O.cs_fromRaw(object: rawObject), defer {
{ (userValue: V?) -> Void in
rawObject.setValue(userValue, forKvcKey: keyPath) rawObject.didChangeValue(forKey: keyPath)
}, }
customSetter(
PartialObject<O>(rawObject),
newValue as! V? newValue as! V?
) )
} }
@@ -915,8 +911,8 @@ public enum TransformableContainer<O: CoreStoreObject> {
// MARK: Private // MARK: Private
private let customGetter: ((_ `self`: O, _ getValue: () -> V?) -> V?)? private let customGetter: ((_ partialObject: PartialObject<O>) -> V?)?
private let customSetter: ((_ `self`: O, _ setValue: (V?) -> Void, _ newValue: V?) -> Void)? private let customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V?) -> Void)?
} }
} }