FabrizioBrancati/BFKit-Swift

//
//  Collection+Extensions.swift
//  BFKit-Swift
//
//  The MIT License (MIT)
//
//  Copyright (c) 2015 - 2019 Fabrizio Brancati.
//
//  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: - Collection extension

/// This extension adds some useful functions to Collection protocol.
public extension Collection {
    // MARK: - Functions
    
    /// Convert self to JSON as String.
    ///
    /// - Returns: Returns the JSON as String or nil if error while parsing.
    /// - Throws: Throws JSONSerialization and BFKitError.jsonSerialization errors.
    func json() throws -> String {
        let jsonData: Data = try JSONSerialization.data(withJSONObject: self, options: [])
        
        guard let json = NSString(data: jsonData, encoding: String.Encoding.utf8.rawValue) else {
            throw BFKitError.jsonSerialization
        }
        
        return String(describing: json)
    }
}