Operators.swift

//
//  Operators.swift
//  Gloss
//
// Copyright (c) 2015 Harlan Kellaway
//
// 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

// MARK: - Operator <~~ (Decode)

/**
Decode custom operator.
*/
infix operator <~~ { associativity left precedence 150 }

/**
Convenience operator for decoding JSON to generic value.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ <T>(key: String, json: JSON) -> T? {
    return Decoder.decode(key)(json)
}

/**
 Convenience operator for decoding JSON to Decodable object.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ <T: Decodable>(key: String, json: JSON) -> T? {
    return Decoder.decodeDecodable(key)(json)
}

/**
 Convenience operator for decoding JSON to array of Decodable objects.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ <T: Decodable>(key: String, json: JSON) -> [T]? {
    return Decoder.decodeDecodableArray(key)(json)
}

/**
 Convenience operator for decoding JSON to dictionary of String to Decodable.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ <T: Decodable>(key: String, json: JSON) -> [String : T]? {
    return Decoder.decodeDecodableDictionary(key)(json)
}

/**
 Convenience operator for decoding JSON to dictionary of String to Decodable array.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ <T: Decodable>(key: String, json: JSON) -> [String : [T]]? {
    return Decoder.decodeDecodableDictionary(key)(json)
}

/**
 Convenience operator for decoding JSON to enum value.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ <T: RawRepresentable>(key: String, json: JSON) -> T? {
    return Decoder.decodeEnum(key)(json)
}

/**
 Convenience operator for decoding JSON to array of enum values.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ <T: RawRepresentable>(key: String, json: JSON) -> [T]? {
    return Decoder.decodeEnumArray(key)(json)
}

/**
 Convenience operator for decoding JSON to Int32.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ (key: String, json: JSON) -> Int32? {
    return Decoder.decodeInt32(key)(json)
}

/**
 Convenience operator for decoding JSON to Int32 array.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ (key: String, json: JSON) -> [Int32]? {
    return Decoder.decodeInt32Array(key)(json)
}

/**
Convenience operator for decoding JSON to UInt32.

- parameter key:  JSON key for value to decode.
- parameter json: JSON.

- returns: Decoded value when successful, nil otherwise.
*/
public func <~~ (key: String, json: JSON) -> UInt32? {
	return Decoder.decodeUInt32(key)(json)
}

/**
Convenience operator for decoding JSON to UInt32 array.

- parameter key:  JSON key for value to decode.
- parameter json: JSON.

- returns: Decoded value when successful, nil otherwise.
*/
public func <~~ (key: String, json: JSON) -> [UInt32]? {
	return Decoder.decodeUInt32Array(key)(json)
}

/**
 Convenience operator for decoding JSON to Int64.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ (key: String, json: JSON) -> Int64? {
    return Decoder.decodeInt64(key)(json)
}

/**
 Convenience operator for decoding JSON to Int64 array.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ (key: String, json: JSON) -> [Int64]? {
    return Decoder.decodeInt64Array(key)(json)
}

/**
Convenience operator for decoding JSON to UInt64.

- parameter key:  JSON key for value to decode.
- parameter json: JSON.

- returns: Decoded value when successful, nil otherwise.
*/
public func <~~ (key: String, json: JSON) -> UInt64? {
	return Decoder.decodeUInt64(key)(json)
}

/**
Convenience operator for decoding JSON to UInt64 array.

- parameter key:  JSON key for value to decode.
- parameter json: JSON.

- returns: Decoded value when successful, nil otherwise.
*/
public func <~~ (key: String, json: JSON) -> [UInt64]? {
	return Decoder.decodeUInt64Array(key)(json)
}

/**
 Convenience operator for decoding JSON to URL.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ (key: String, json: JSON) -> NSURL? {
    return Decoder.decodeURL(key)(json)
}

/**
 Convenience operator for decoding JSON to array of URLs.
 
 - parameter key:  JSON key for value to decode.
 - parameter json: JSON.
 
 - returns: Decoded value when successful, nil otherwise.
 */
public func <~~ (key: String, json: JSON) -> [NSURL]? {
    return Decoder.decodeURLArray(key)(json)
}

// MARK: - Operator ~~> (Encode)

/**
Encode custom operator.
*/
infix operator ~~> { associativity left precedence 150 }

/**
Convenience operator for encoding generic value to JSON
*/

/**
 Convenience operator for encoding a generic value to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> <T>(key: String, property: T?) -> JSON? {
    return Encoder.encode(key)(property)
}

/**
 Convenience operator for encoding an array of generic values to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> <T>(key: String, property: [T]?) -> JSON? {
    return Encoder.encodeArray(key)(property)
}

/**
 Convenience operator for encoding an Encodable object to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> <T: Encodable>(key: String, property: T?) -> JSON? {
    return Encoder.encodeEncodable(key)(property)
}

/**
 Convenience operator for encoding an array of Encodable objects to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> <T: Encodable>(key: String, property: [T]?) -> JSON? {
    return Encoder.encodeEncodableArray(key)(property)
}

/**
 Convenience operator for encoding a dictionary of String to Encodable to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> <T: Encodable>(key: String, property: [String : T]?) -> JSON? {
    return Encoder.encodeEncodableDictionary(key)(property)
}

/**
 Convenience operator for encoding a dictionary of String to Encodable array to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> <T: Encodable>(key: String, property: [String : [T]]?) -> JSON? {
    return Encoder.encodeEncodableDictionary(key)(property)
}

/**
 Convenience operator for encoding an enum value to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> <T: RawRepresentable>(key: String, property: T?) -> JSON? {
    return Encoder.encodeEnum(key)(property)
}

/**
 Convenience operator for encoding an array of enum values to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> <T: RawRepresentable>(key: String, property: [T]?) -> JSON? {
    return Encoder.encodeEnumArray(key)(property)
}

/**
 Convenience operator for encoding an Int32 to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> (key: String, property: Int32?) -> JSON? {
    return Encoder.encodeInt32(key)(property)
}

/**
 Convenience operator for encoding an Int32 array to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> (key: String, property: [Int32]?) -> JSON? {
    return Encoder.encodeInt32Array(key)(property)
}

/**
Convenience operator for encoding an UInt32 to JSON.

- parameter key:      JSON key for value to encode.
- parameter property: Object to encode to JSON.

- returns: JSON when successful, nil otherwise.
*/
public func ~~> (key: String, property: UInt32?) -> JSON? {
	return Encoder.encodeUInt32(key)(property)
}

/**
Convenience operator for encoding an UInt32 array to JSON.

- parameter key:      JSON key for value to encode.
- parameter property: Object to encode to JSON.

- returns: JSON when successful, nil otherwise.
*/
public func ~~> (key: String, property: [UInt32]?) -> JSON? {
	return Encoder.encodeUInt32Array(key)(property)
}

/**
 Convenience operator for encoding an Int64 to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> (key: String, property: Int64?) -> JSON? {
    return Encoder.encodeInt64(key)(property)
}

/**
 Convenience operator for encoding an Int64 array to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> (key: String, property: [Int64]?) -> JSON? {
    return Encoder.encodeInt64Array(key)(property)
}

/**
Convenience operator for encoding an UInt64 to JSON.

- parameter key:      JSON key for value to encode.
- parameter property: Object to encode to JSON.

- returns: JSON when successful, nil otherwise.
*/
public func ~~> (key: String, property: UInt64?) -> JSON? {
	return Encoder.encodeUInt64(key)(property)
}

/**
Convenience operator for encoding an UInt64 array to JSON.

- parameter key:      JSON key for value to encode.
- parameter property: Object to encode to JSON.

- returns: JSON when successful, nil otherwise.
*/
public func ~~> (key: String, property: [UInt64]?) -> JSON? {
	return Encoder.encodeUInt64Array(key)(property)
}

/**
 Convenience operator for encoding a URL to JSON.
 
 - parameter key:      JSON key for value to encode.
 - parameter property: Object to encode to JSON.
 
 - returns: JSON when successful, nil otherwise.
 */
public func ~~> (key: String, property: NSURL?) -> JSON? {
    return Encoder.encodeURL(key)(property)
}