mirror of
https://github.com/JohnEstropia/CoreStore.git
synced 2026-01-13 04:40:32 +01:00
497 lines
17 KiB
Swift
497 lines
17 KiB
Swift
//
|
|
// Select.swift
|
|
// CoreStore
|
|
//
|
|
// Copyright © 2015 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 Foundation
|
|
import CoreGraphics
|
|
import CoreData
|
|
|
|
|
|
// MARK: - SelectResultType
|
|
|
|
/**
|
|
The `SelectResultType` protocol is implemented by return types supported by the `Select` clause.
|
|
*/
|
|
public protocol SelectResultType {}
|
|
|
|
|
|
// MARK: - SelectAttributesResultType
|
|
|
|
/**
|
|
The `SelectAttributesResultType` protocol is implemented by return types supported by the `queryAttributes(...)` methods.
|
|
*/
|
|
public protocol SelectAttributesResultType: SelectResultType {
|
|
|
|
static func cs_fromQueryResultsNativeType(_ result: [Any]) -> [[String: Any]]
|
|
}
|
|
|
|
|
|
// MARK: - SelectTerm
|
|
|
|
/**
|
|
The `SelectTerm` is passed to the `Select` clause to indicate the attributes/aggregate keys to be queried.
|
|
*/
|
|
public enum SelectTerm: ExpressibleByStringLiteral, Hashable {
|
|
|
|
/**
|
|
Provides a `SelectTerm` to a `Select` clause for querying an entity attribute. A shorter way to do the same is to assign from the string keypath directly:
|
|
```
|
|
let fullName = CoreStore.queryValue(
|
|
From<MyPersonEntity>(),
|
|
Select<String>(.attribute("fullName")),
|
|
Where("employeeID", isEqualTo: 1111)
|
|
)
|
|
```
|
|
is equivalent to:
|
|
```
|
|
let fullName = CoreStore.queryValue(
|
|
From<MyPersonEntity>(),
|
|
Select<String>("fullName"),
|
|
Where("employeeID", isEqualTo: 1111)
|
|
)
|
|
```
|
|
- parameter keyPath: the attribute name
|
|
- returns: a `SelectTerm` to a `Select` clause for querying an entity attribute
|
|
*/
|
|
public static func attribute(_ keyPath: KeyPath) -> SelectTerm {
|
|
|
|
return ._attribute(keyPath)
|
|
}
|
|
|
|
/**
|
|
Provides a `SelectTerm` to a `Select` clause for querying the average value of an attribute.
|
|
```
|
|
let averageAge = CoreStore.queryValue(
|
|
From<MyPersonEntity>(),
|
|
Select<Int>(.average("age"))
|
|
)
|
|
```
|
|
- parameter keyPath: the attribute name
|
|
- parameter alias: the dictionary key to use to access the result. Ignored when the query return value is not an `NSDictionary`. If `nil`, the default key "average(<attributeName>)" is used
|
|
- returns: a `SelectTerm` to a `Select` clause for querying the average value of an attribute
|
|
*/
|
|
public static func average(_ keyPath: KeyPath, as alias: KeyPath? = nil) -> SelectTerm {
|
|
|
|
return ._aggregate(
|
|
function: "average:",
|
|
keyPath: keyPath,
|
|
alias: alias ?? "average(\(keyPath))",
|
|
nativeType: .decimalAttributeType
|
|
)
|
|
}
|
|
|
|
/**
|
|
Provides a `SelectTerm` to a `Select` clause for a count query.
|
|
```
|
|
let numberOfEmployees = CoreStore.queryValue(
|
|
From<MyPersonEntity>(),
|
|
Select<Int>(.count("employeeID"))
|
|
)
|
|
```
|
|
- parameter keyPath: the attribute name
|
|
- parameter alias: the dictionary key to use to access the result. Ignored when the query return value is not an `NSDictionary`. If `nil`, the default key "count(<attributeName>)" is used
|
|
- returns: a `SelectTerm` to a `Select` clause for a count query
|
|
*/
|
|
public static func count(_ keyPath: KeyPath, as alias: KeyPath? = nil) -> SelectTerm {
|
|
|
|
return ._aggregate(
|
|
function: "count:",
|
|
keyPath: keyPath,
|
|
alias: alias ?? "count(\(keyPath))",
|
|
nativeType: .integer64AttributeType
|
|
)
|
|
}
|
|
|
|
/**
|
|
Provides a `SelectTerm` to a `Select` clause for querying the maximum value for an attribute.
|
|
```
|
|
let maximumAge = CoreStore.queryValue(
|
|
From<MyPersonEntity>(),
|
|
Select<Int>(.maximum("age"))
|
|
)
|
|
```
|
|
- parameter keyPath: the attribute name
|
|
- parameter alias: the dictionary key to use to access the result. Ignored when the query return value is not an `NSDictionary`. If `nil`, the default key "max(<attributeName>)" is used
|
|
- returns: a `SelectTerm` to a `Select` clause for querying the maximum value for an attribute
|
|
*/
|
|
public static func maximum(_ keyPath: KeyPath, as alias: KeyPath? = nil) -> SelectTerm {
|
|
|
|
return ._aggregate(
|
|
function: "max:",
|
|
keyPath: keyPath,
|
|
alias: alias ?? "max(\(keyPath))",
|
|
nativeType: .undefinedAttributeType
|
|
)
|
|
}
|
|
|
|
/**
|
|
Provides a `SelectTerm` to a `Select` clause for querying the minimum value for an attribute.
|
|
```
|
|
let minimumAge = CoreStore.queryValue(
|
|
From<MyPersonEntity>(),
|
|
Select<Int>(.minimum("age"))
|
|
)
|
|
```
|
|
- parameter keyPath: the attribute name
|
|
- parameter alias: the dictionary key to use to access the result. Ignored when the query return value is not an `NSDictionary`. If `nil`, the default key "min(<attributeName>)" is used
|
|
- returns: a `SelectTerm` to a `Select` clause for querying the minimum value for an attribute
|
|
*/
|
|
public static func minimum(_ keyPath: KeyPath, as alias: KeyPath? = nil) -> SelectTerm {
|
|
|
|
return ._aggregate(
|
|
function: "min:",
|
|
keyPath: keyPath,
|
|
alias: alias ?? "min(\(keyPath))",
|
|
nativeType: .undefinedAttributeType
|
|
)
|
|
}
|
|
|
|
/**
|
|
Provides a `SelectTerm` to a `Select` clause for querying the sum value for an attribute.
|
|
```
|
|
let totalAge = CoreStore.queryValue(
|
|
From<MyPersonEntity>(),
|
|
Select<Int>(.sum("age"))
|
|
)
|
|
```
|
|
- parameter keyPath: the attribute name
|
|
- parameter alias: the dictionary key to use to access the result. Ignored when the query return value is not an `NSDictionary`. If `nil`, the default key "sum(<attributeName>)" is used
|
|
- returns: a `SelectTerm` to a `Select` clause for querying the sum value for an attribute
|
|
*/
|
|
public static func sum(_ keyPath: KeyPath, as alias: KeyPath? = nil) -> SelectTerm {
|
|
|
|
return ._aggregate(
|
|
function: "sum:",
|
|
keyPath: keyPath,
|
|
alias: alias ?? "sum(\(keyPath))",
|
|
nativeType: .decimalAttributeType
|
|
)
|
|
}
|
|
|
|
/**
|
|
Provides a `SelectTerm` to a `Select` clause for querying the `NSManagedObjectID`.
|
|
```
|
|
let objectID = CoreStore.queryValue(
|
|
From<MyPersonEntity>(),
|
|
Select<NSManagedObjectID>(),
|
|
Where("employeeID", isEqualTo: 1111)
|
|
)
|
|
```
|
|
- parameter keyPath: the attribute name
|
|
- parameter alias: the dictionary key to use to access the result. Ignored when the query return value is not an `NSDictionary`. If `nil`, the default key "objecID" is used
|
|
- returns: a `SelectTerm` to a `Select` clause for querying the sum value for an attribute
|
|
*/
|
|
public static func objectID(as alias: KeyPath? = nil) -> SelectTerm {
|
|
|
|
return ._identity(
|
|
alias: alias ?? "objectID",
|
|
nativeType: .objectIDAttributeType
|
|
)
|
|
}
|
|
|
|
|
|
// MARK: ExpressibleByStringLiteral
|
|
|
|
public init(stringLiteral value: KeyPath) {
|
|
|
|
self = ._attribute(value)
|
|
}
|
|
|
|
public init(unicodeScalarLiteral value: KeyPath) {
|
|
|
|
self = ._attribute(value)
|
|
}
|
|
|
|
public init(extendedGraphemeClusterLiteral value: KeyPath) {
|
|
|
|
self = ._attribute(value)
|
|
}
|
|
|
|
|
|
// MARK: Equatable
|
|
|
|
public static func == (lhs: SelectTerm, rhs: SelectTerm) -> Bool {
|
|
|
|
switch (lhs, rhs) {
|
|
|
|
case (._attribute(let keyPath1), ._attribute(let keyPath2)):
|
|
return keyPath1 == keyPath2
|
|
|
|
case (._aggregate(let function1, let keyPath1, let alias1, let nativeType1),
|
|
._aggregate(let function2, let keyPath2, let alias2, let nativeType2)):
|
|
return function1 == function2
|
|
&& keyPath1 == keyPath2
|
|
&& alias1 == alias2
|
|
&& nativeType1 == nativeType2
|
|
|
|
case (._identity(let alias1, let nativeType1), ._identity(let alias2, let nativeType2)):
|
|
return alias1 == alias2 && nativeType1 == nativeType2
|
|
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: Hashable
|
|
|
|
public var hashValue: Int {
|
|
|
|
switch self {
|
|
|
|
case ._attribute(let keyPath):
|
|
return 0 ^ keyPath.hashValue
|
|
|
|
case ._aggregate(let function, let keyPath, let alias, let nativeType):
|
|
return 1 ^ function.hashValue ^ keyPath.hashValue ^ alias.hashValue ^ nativeType.hashValue
|
|
|
|
case ._identity(let alias, let nativeType):
|
|
return 3 ^ alias.hashValue ^ nativeType.hashValue
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: Internal
|
|
|
|
case _attribute(KeyPath)
|
|
case _aggregate(function: String, keyPath: KeyPath, alias: String, nativeType: NSAttributeType)
|
|
case _identity(alias: String, nativeType: NSAttributeType)
|
|
}
|
|
|
|
|
|
// MARK: - Select
|
|
|
|
/**
|
|
The `Select` clause indicates the attribute / aggregate value to be queried. The generic type is a `SelectResultType`, and will be used as the return type for the query.
|
|
|
|
You can bind the return type by specializing the initializer:
|
|
```
|
|
let maximumAge = CoreStore.queryValue(
|
|
From<MyPersonEntity>(),
|
|
Select<Int>(.maximum("age"))
|
|
)
|
|
```
|
|
or by casting the type of the return value:
|
|
```
|
|
let maximumAge: Int = CoreStore.queryValue(
|
|
From<MyPersonEntity>(),
|
|
Select(.maximum("age"))
|
|
)
|
|
```
|
|
Valid return types depend on the query:
|
|
|
|
- for `queryValue(...)` methods:
|
|
- all types that conform to `QueryableAttributeType` protocol
|
|
- for `queryAttributes(...)` methods:
|
|
- `NSDictionary`
|
|
|
|
- parameter sortDescriptors: a series of `NSSortDescriptor`s
|
|
*/
|
|
public struct Select<T: SelectResultType>: Hashable {
|
|
|
|
/**
|
|
The `SelectResultType` type for the query's return value
|
|
*/
|
|
public typealias ReturnType = T
|
|
|
|
/**
|
|
Initializes a `Select` clause with a list of `SelectTerm`s
|
|
|
|
- parameter selectTerm: a `SelectTerm`
|
|
- parameter selectTerms: a series of `SelectTerm`s
|
|
*/
|
|
public init(_ selectTerm: SelectTerm, _ selectTerms: SelectTerm...) {
|
|
|
|
self.selectTerms = [selectTerm] + selectTerms
|
|
}
|
|
|
|
/**
|
|
Initializes a `Select` clause with a list of `SelectTerm`s
|
|
|
|
- parameter selectTerms: a series of `SelectTerm`s
|
|
*/
|
|
public init(_ selectTerms: [SelectTerm]) {
|
|
|
|
self.selectTerms = selectTerms
|
|
}
|
|
|
|
|
|
// MARK: Equatable
|
|
|
|
public static func == <T: SelectResultType, U: SelectResultType>(lhs: Select<T>, rhs: Select<U>) -> Bool {
|
|
|
|
return lhs.selectTerms == rhs.selectTerms
|
|
}
|
|
|
|
|
|
// MARK: Hashable
|
|
|
|
public var hashValue: Int {
|
|
|
|
return self.selectTerms.map { $0.hashValue }.reduce(0, ^)
|
|
}
|
|
|
|
|
|
// MARK: Internal
|
|
|
|
internal let selectTerms: [SelectTerm]
|
|
}
|
|
|
|
public extension Select where T: NSManagedObjectID {
|
|
|
|
public init() {
|
|
|
|
self.init(.objectID())
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: - NSDictionary: SelectAttributesResultType
|
|
|
|
extension NSDictionary: SelectAttributesResultType {
|
|
|
|
// MARK: SelectAttributesResultType
|
|
|
|
public static func cs_fromQueryResultsNativeType(_ result: [Any]) -> [[String : Any]] {
|
|
|
|
return result as! [[String: Any]]
|
|
}
|
|
}
|
|
|
|
|
|
// MARK: - Internal
|
|
|
|
internal extension Collection where Iterator.Element == SelectTerm {
|
|
|
|
internal func applyToFetchRequest<T>(_ fetchRequest: NSFetchRequest<NSFetchRequestResult>, owner: T) {
|
|
|
|
fetchRequest.includesPendingChanges = false
|
|
fetchRequest.resultType = .dictionaryResultType
|
|
|
|
func attributeDescription(for keyPath: String, in entity: NSEntityDescription) -> NSAttributeDescription? {
|
|
|
|
let components = keyPath.components(separatedBy: ".")
|
|
switch components.count {
|
|
|
|
case 0:
|
|
return nil
|
|
|
|
case 1:
|
|
return entity.attributesByName[components[0]]
|
|
|
|
default:
|
|
guard let relationship = entity.relationshipsByName[components[0]] else {
|
|
|
|
return nil
|
|
}
|
|
return attributeDescription(
|
|
for: components.dropFirst().joined(separator: "."),
|
|
in: relationship.entity
|
|
)
|
|
}
|
|
}
|
|
|
|
var propertiesToFetch = [Any]()
|
|
for term in self {
|
|
|
|
switch term {
|
|
|
|
case ._attribute(let keyPath):
|
|
let entityDescription = fetchRequest.entity!
|
|
if let attributeDescription = attributeDescription(for: keyPath, in: entityDescription) {
|
|
|
|
propertiesToFetch.append(attributeDescription)
|
|
}
|
|
else {
|
|
|
|
CoreStore.log(
|
|
.warning,
|
|
message: "The key path \"\(keyPath)\" could not be resolved in entity \(cs_typeName(entityDescription.managedObjectClassName)) as an attribute and will be ignored by \(cs_typeName(owner)) query clause."
|
|
)
|
|
}
|
|
|
|
case ._aggregate(let function, let keyPath, let alias, let nativeType):
|
|
let entityDescription = fetchRequest.entity!
|
|
if let attributeDescription = attributeDescription(for: keyPath, in: entityDescription) {
|
|
|
|
let expressionDescription = NSExpressionDescription()
|
|
expressionDescription.name = alias
|
|
if nativeType == .undefinedAttributeType {
|
|
|
|
expressionDescription.expressionResultType = attributeDescription.attributeType
|
|
}
|
|
else {
|
|
|
|
expressionDescription.expressionResultType = nativeType
|
|
}
|
|
expressionDescription.expression = NSExpression(
|
|
forFunction: function,
|
|
arguments: [NSExpression(forKeyPath: keyPath)]
|
|
)
|
|
propertiesToFetch.append(expressionDescription)
|
|
}
|
|
else {
|
|
|
|
CoreStore.log(
|
|
.warning,
|
|
message: "The key path \"\(keyPath)\" could not be resolved in entity \(cs_typeName(entityDescription.managedObjectClassName)) as an attribute and will be ignored by \(cs_typeName(owner)) query clause."
|
|
)
|
|
}
|
|
|
|
case ._identity(let alias, let nativeType):
|
|
let expressionDescription = NSExpressionDescription()
|
|
expressionDescription.name = alias
|
|
if nativeType == .undefinedAttributeType {
|
|
|
|
expressionDescription.expressionResultType = .objectIDAttributeType
|
|
}
|
|
else {
|
|
|
|
expressionDescription.expressionResultType = nativeType
|
|
}
|
|
expressionDescription.expression = NSExpression.expressionForEvaluatedObject()
|
|
|
|
propertiesToFetch.append(expressionDescription)
|
|
}
|
|
}
|
|
|
|
fetchRequest.propertiesToFetch = propertiesToFetch
|
|
}
|
|
|
|
internal func keyPathForFirstSelectTerm() -> KeyPath {
|
|
|
|
switch self.first! {
|
|
|
|
case ._attribute(let keyPath):
|
|
return keyPath
|
|
|
|
case ._aggregate(_, _, let alias, _):
|
|
return alias
|
|
|
|
case ._identity(let alias, _):
|
|
return alias
|
|
}
|
|
}
|
|
}
|