mirror of
https://github.com/JohnEstropia/CoreStore.git
synced 2026-01-12 04:10:36 +01:00
304 lines
13 KiB
Swift
304 lines
13 KiB
Swift
//
|
|
// Transformable.Optional.swift
|
|
// CoreStore
|
|
//
|
|
// Copyright © 2020 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: - TransformableContainer
|
|
|
|
extension TransformableContainer {
|
|
|
|
// MARK: - Optional
|
|
|
|
/**
|
|
The containing type for optional transformable properties. Any type that conforms to `NSCoding & NSCopying` are supported.
|
|
```
|
|
class Animal: CoreStoreObject {
|
|
let species = Value.Required<String>("species", initial: "")
|
|
let nickname = Value.Optional<String>("nickname")
|
|
let color = Transformable.Optional<UIColor>("color")
|
|
}
|
|
```
|
|
- Important: `Transformable.Optional` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
|
|
*/
|
|
public final class Optional<V: NSCoding & NSCopying>: AttributeKeyPathStringConvertible, AttributeProtocol {
|
|
|
|
/**
|
|
Initializes the metadata for the property.
|
|
```
|
|
class Animal: CoreStoreObject {
|
|
let species = Value.Required<String>("species", initial: "")
|
|
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 initial: the initial value for the property that is shared for all instances of this object. Note that this is evaluated during `DataStack` setup, not during object creation. Defaults to the `ImportableAttributeType`'s empty value if not specified.
|
|
- 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 allowsExternalBinaryDataStorage: `true` if the attribute allows external binary storage, otherwise `false`.
|
|
- 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 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 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 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(
|
|
_ keyPath: KeyPathString,
|
|
initial: @autoclosure @escaping () -> V? = nil,
|
|
isTransient: Bool = false,
|
|
allowsExternalBinaryDataStorage: Bool = false,
|
|
versionHashModifier: @autoclosure @escaping () -> String? = nil,
|
|
renamingIdentifier: @autoclosure @escaping () -> String? = nil,
|
|
customGetter: ((_ partialObject: PartialObject<O>) -> V?)? = nil,
|
|
customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V?) -> Void)? = nil,
|
|
affectedByKeyPaths: @autoclosure @escaping () -> Set<String> = []) {
|
|
|
|
self.keyPath = keyPath
|
|
self.entityDescriptionValues = {
|
|
(
|
|
attributeType: .transformableAttributeType,
|
|
isOptional: true,
|
|
isTransient: isTransient,
|
|
allowsExternalBinaryDataStorage: allowsExternalBinaryDataStorage,
|
|
versionHashModifier: versionHashModifier(),
|
|
renamingIdentifier: renamingIdentifier(),
|
|
affectedByKeyPaths: affectedByKeyPaths(),
|
|
defaultValue: initial()
|
|
)
|
|
}
|
|
self.customGetter = customGetter
|
|
self.customSetter = customSetter
|
|
}
|
|
|
|
/**
|
|
The attribute value
|
|
*/
|
|
public var value: ReturnValueType {
|
|
|
|
get {
|
|
|
|
Internals.assert(
|
|
self.rawObject != nil,
|
|
"Attempted to access values from a \(Internals.typeName(O.self)) meta object. Meta objects are only used for querying keyPaths and infering types."
|
|
)
|
|
return withExtendedLifetime(self.rawObject!) { (object) in
|
|
|
|
Internals.assert(
|
|
object.isRunningInAllowedQueue() == true,
|
|
"Attempted to access \(Internals.typeName(O.self))'s value outside it's designated queue."
|
|
)
|
|
if let customGetter = self.customGetter {
|
|
|
|
return customGetter(PartialObject<O>(object))
|
|
}
|
|
return object.value(forKey: self.keyPath) as! V?
|
|
}
|
|
}
|
|
set {
|
|
|
|
Internals.assert(
|
|
self.rawObject != nil,
|
|
"Attempted to access values from a \(Internals.typeName(O.self)) meta object. Meta objects are only used for querying keyPaths and infering types."
|
|
)
|
|
return withExtendedLifetime(self.rawObject!) { (object) in
|
|
|
|
Internals.assert(
|
|
object.isRunningInAllowedQueue() == true,
|
|
"Attempted to access \(Internals.typeName(O.self))'s value outside it's designated queue."
|
|
)
|
|
Internals.assert(
|
|
object.isEditableInContext() == true,
|
|
"Attempted to update a \(Internals.typeName(O.self))'s value from outside a transaction."
|
|
)
|
|
if let customSetter = self.customSetter {
|
|
|
|
return customSetter(PartialObject<O>(object), newValue)
|
|
}
|
|
object.setValue(
|
|
newValue,
|
|
forKey: self.keyPath
|
|
)
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: AnyKeyPathStringConvertible
|
|
|
|
public var cs_keyPathString: String {
|
|
|
|
return self.keyPath
|
|
}
|
|
|
|
|
|
// MARK: KeyPathStringConvertible
|
|
|
|
public typealias ObjectType = O
|
|
public typealias DestinationValueType = V
|
|
|
|
|
|
// MARK: AttributeKeyPathStringConvertible
|
|
|
|
public typealias ReturnValueType = DestinationValueType?
|
|
|
|
|
|
// MARK: PropertyProtocol
|
|
|
|
internal let keyPath: KeyPathString
|
|
|
|
|
|
// MARK: AttributeProtocol
|
|
|
|
internal let entityDescriptionValues: () -> AttributeProtocol.EntityDescriptionValues
|
|
internal var rawObject: CoreStoreManagedObject?
|
|
|
|
internal private(set) lazy var getter: CoreStoreManagedObject.CustomGetter? = Internals.with { [unowned self] in
|
|
|
|
guard let customGetter = self.customGetter else {
|
|
|
|
return nil
|
|
}
|
|
let keyPath = self.keyPath
|
|
return { (_ id: Any) -> Any? in
|
|
|
|
let rawObject = id as! CoreStoreManagedObject
|
|
rawObject.willAccessValue(forKey: keyPath)
|
|
defer {
|
|
|
|
rawObject.didAccessValue(forKey: keyPath)
|
|
}
|
|
let value = customGetter(PartialObject<O>(rawObject))
|
|
return value
|
|
}
|
|
}
|
|
|
|
internal private(set) lazy var setter: CoreStoreManagedObject.CustomSetter? = Internals.with { [unowned self] in
|
|
|
|
guard let customSetter = self.customSetter else {
|
|
|
|
return nil
|
|
}
|
|
let keyPath = self.keyPath
|
|
return { (_ id: Any, _ newValue: Any?) -> Void in
|
|
|
|
let rawObject = id as! CoreStoreManagedObject
|
|
rawObject.willChangeValue(forKey: keyPath)
|
|
defer {
|
|
|
|
rawObject.didChangeValue(forKey: keyPath)
|
|
}
|
|
customSetter(
|
|
PartialObject<O>(rawObject),
|
|
newValue as! V?
|
|
)
|
|
}
|
|
}
|
|
|
|
internal var valueForSnapshot: Any? {
|
|
|
|
return self.value
|
|
}
|
|
|
|
|
|
// MARK: Private
|
|
|
|
private let customGetter: ((_ partialObject: PartialObject<O>) -> V?)?
|
|
private let customSetter: ((_ partialObject: PartialObject<O>, _ newValue: V?) -> Void)?
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: - Operations
|
|
|
|
infix operator .= : AssignmentPrecedence
|
|
infix operator .== : ComparisonPrecedence
|
|
|
|
extension TransformableContainer.Optional {
|
|
|
|
/**
|
|
Assigns an optional transformable value to the property. The operation
|
|
```
|
|
animal.color .= UIColor.red
|
|
```
|
|
is equivalent to
|
|
```
|
|
animal.color.value = UIColor.red
|
|
```
|
|
*/
|
|
public static func .= (_ property: TransformableContainer<O>.Optional<V>, _ newValue: V?) {
|
|
|
|
property.value = newValue
|
|
}
|
|
|
|
/**
|
|
Assigns an optional transformable value from another property. The operation
|
|
```
|
|
animal.color .= anotherAnimal.color
|
|
```
|
|
is equivalent to
|
|
```
|
|
animal.color.value = anotherAnimal.color.value
|
|
```
|
|
*/
|
|
public static func .= <O2>(_ property: TransformableContainer<O>.Optional<V>, _ property2: TransformableContainer<O2>.Optional<V>) {
|
|
|
|
property.value = property2.value
|
|
}
|
|
|
|
/**
|
|
Assigns a transformable value from another property. The operation
|
|
```
|
|
animal.color .= anotherAnimal.color
|
|
```
|
|
is equivalent to
|
|
```
|
|
animal.color.value = anotherAnimal.color.value
|
|
```
|
|
*/
|
|
public static func .= <O2>(_ property: TransformableContainer<O>.Optional<V>, _ property2: TransformableContainer<O2>.Required<V>) {
|
|
|
|
property.value = property2.value
|
|
}
|
|
}
|