amplify-swift/Amplify/Categories/DataStore/Query/QueryField.swift

//
// Copyright Amazon.com Inc. or its affiliates.
// All Rights Reserved.
//
// SPDX-License-Identifier: Apache-2.0
//

import Foundation

/// Creates a new instance of the `QueryField` that can be used to create query predicates.
///
/// ```swift
/// field("id").eq("some-uuid")
/// // or using the operator-based:
/// field("id") == "some-uuid"
/// ```
///
/// - Parameter name: the name of the field
/// - Returns: an instance of the `QueryField`
/// - seealso: `ModelKey` for `CodingKey`-based approach on predicates
public func field(_ name: String) -> QueryField {
    return QueryField(name: name)
}

/// `QueryFieldOperation` provides functions that creates predicates based on a field name.
/// These functions are matchers that get executed at a later point by specific implementations
/// of the `Model` filtering logic (e.g. SQL or GraphQL queries).
///
/// - seealso: `QueryField`
/// - seealso: `ModelKey`
public protocol QueryFieldOperation {
    // MARK: - Functions

    func beginsWith(_ value: String) -> QueryPredicateOperation
    func between(start: Persistable, end: Persistable) -> QueryPredicateOperation
    func contains(_ value: String) -> QueryPredicateOperation
    func eq(_ value: Persistable?) -> QueryPredicateOperation
    func eq(_ value: EnumPersistable) -> QueryPredicateOperation
    func ge(_ value: Persistable) -> QueryPredicateOperation
    func gt(_ value: Persistable) -> QueryPredicateOperation
    func le(_ value: Persistable) -> QueryPredicateOperation
    func lt(_ value: Persistable) -> QueryPredicateOperation
    func ne(_ value: Persistable?) -> QueryPredicateOperation
    func ne(_ value: EnumPersistable) -> QueryPredicateOperation

    // MARK: - Operators

    static func ~= (key: Self, value: String) -> QueryPredicateOperation
    static func == (key: Self, value: Persistable?) -> QueryPredicateOperation
    static func == (key: Self, value: EnumPersistable) -> QueryPredicateOperation
    static func >= (key: Self, value: Persistable) -> QueryPredicateOperation
    static func > (key: Self, value: Persistable) -> QueryPredicateOperation
    static func <= (key: Self, value: Persistable) -> QueryPredicateOperation
    static func < (key: Self, value: Persistable) -> QueryPredicateOperation
    static func != (key: Self, value: Persistable?) -> QueryPredicateOperation
    static func != (key: Self, value: EnumPersistable) -> QueryPredicateOperation
}

public struct QueryField: QueryFieldOperation {

    public let name: String

    init(name: String) {
        self.name = name
    }

    // MARK: - beginsWith
    public func beginsWith(_ value: String) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .beginsWith(value))
    }

    // MARK: - between
    public func between(start: Persistable, end: Persistable) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .between(start: start, end: end))
    }

    // MARK: - contains

    public func contains(_ value: String) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .contains(value))
    }

    public static func ~= (key: Self, value: String) -> QueryPredicateOperation {
        return key.contains(value)
    }

    // MARK: - eq

    public func eq(_ value: Persistable?) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .equals(value))
    }

    public func eq(_ value: EnumPersistable) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .equals(value.rawValue))
    }

    public static func == (key: Self, value: Persistable?) -> QueryPredicateOperation {
        return key.eq(value)
    }

    public static func == (key: Self, value: EnumPersistable) -> QueryPredicateOperation {
        return key.eq(value)
    }

    // MARK: - ge

    public func ge(_ value: Persistable) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .greaterOrEqual(value))
    }

    public static func >= (key: Self, value: Persistable) -> QueryPredicateOperation {
        return key.ge(value)
    }

    // MARK: - gt

    public func gt(_ value: Persistable) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .greaterThan(value))
    }

    public static func > (key: Self, value: Persistable) -> QueryPredicateOperation {
        return key.gt(value)
    }

    // MARK: - le

    public func le(_ value: Persistable) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .lessOrEqual(value))
    }

    public static func <= (key: Self, value: Persistable) -> QueryPredicateOperation {
        return key.le(value)
    }

    // MARK: - lt

    public func lt(_ value: Persistable) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .lessThan(value))
    }

    public static func < (key: Self, value: Persistable) -> QueryPredicateOperation {
        return key.lt(value)
    }

    // MARK: - ne

    public func ne(_ value: Persistable?) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .notEqual(value))
    }

    public func ne(_ value: EnumPersistable) -> QueryPredicateOperation {
        return QueryPredicateOperation(field: name, operator: .notEqual(value.rawValue))
    }

    public static func != (key: Self, value: Persistable?) -> QueryPredicateOperation {
        return key.ne(value)
    }

    public static func != (key: Self, value: EnumPersistable) -> QueryPredicateOperation {
        return key.ne(value)
    }
}