RepresentationKit-mirror/RepresentationKit/Classes/Representations/JSONRepresentation.swift

//
//  JSONRepresentation.swift
//  RepresentationKit
//
//  Created by Georges Boumis on 20/6/2016.
//
//  Licensed to the Apache Software Foundation (ASF) under one
//  or more contributor license agreements.  See the NOTICE file
//  distributed with this work for additional information
//  regarding copyright ownership.  The ASF licenses this file
//  to you under the Apache License, Version 2.0 (the
//  "License"); you may not use this file except in compliance
//  with the License.  You may obtain a copy of the License at
//  
//    http://www.apache.org/licenses/LICENSE-2.0
//  
//  Unless required by applicable law or agreed to in writing,
//  software distributed under the License is distributed on an
//  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
//  KIND, either express or implied.  See the License for the
//  specific language governing permissions and limitations
//  under the License.
//

import Foundation

/// Describes a json representation. Also the conforming class can be
/// represented itself.
///
///     struct Book: Representable {
///       let name: String
///       let edition: String
///
///       func represent(using representation: Representation) -> Representation {
///           return representation
///               .with(key: "name", value: self.name)
///               .with(key: "edition", value: self.edition)
///       }
///     }
///
///     let book = Book(name: "Super title", edition: "Pepper's")
///
///     var representation: DictionaryRepresentation = /* */
///     representation = book.represent(using: representation)
///
///     print(representation.dictionary)
///     // Prints ["name" : "Super title", "edition" : "Pepper's"]
///
public protocol JSONRepresentation: DictionaryRepresentation {
    
    /// the json string representation
	var json: String { get }
    
    /// the json data representation
	var jsonData: Data? { get }
}

public extension JSONRepresentation {
    
	var jsonData: Data? {
		do {
			var data : Data? = nil
            let dictionary = self.dictionary
            try data       = JSONSerialization.data(withJSONObject: dictionary, options: [])
            let json       = (String(data: data!, encoding: String.Encoding.utf8))! + "\n"
            data           = json.data(using: String.Encoding.utf8)
			return data
		} catch {}
		return nil;
	}

	var json: String {
		if let dt = self.jsonData {
			return NSString(data: dt, encoding: String.Encoding.utf8.rawValue)! as String
		}
		return "";
	}

    var string: String {
        return self.json
    }
}