File: JSONMapper.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (172 lines) | stat: -rw-r--r-- 5,604 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See http://swift.org/LICENSE.txt for license information
 See http://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

/// A type which can be mapped from JSON.
public protocol JSONMappable {
    /// Create an object from given JSON.
    init(json: JSON) throws
}

extension JSON {

    /// Describes an error occurred during JSON mapping.
    public enum MapError: Error {
        /// The key is missing in JSON.
        case missingKey(String)

        /// Got a different type than expected.
        case typeMismatch(key: String, expected: Any.Type, json: JSON)

        /// A custom error. Clients can use this in their mapping method.
        case custom(key: String?, message: String)
    }

    /// Returns a JSON mappable object from a given key.
    public func get<T: JSONMappable>(_ key: String) throws -> T {
        let object: JSON = try get(key)
        return try T(json: object)
    }

    public func get<T: JSONMappable>(_ type: T.Type, forKey key: String) throws -> T {
        let object: JSON = try get(key)
        return try T(json: object)
    }

    /// Returns an optional JSON mappable object from a given key.
    public func get<T: JSONMappable>(_ key: String) -> T? {
        if let object: JSON = try? get(key) {
            return try? T.init(json: object)
        }
        return nil
    }

    /// Returns a JSON mappable array from a given key.
    public func get<T: JSONMappable>(_ key: String) throws -> [T] {
        let array: [JSON] = try get(key)
        return try array.map(T.init(json:))
    }

    public func get<T: JSONMappable>(_ type: [T].Type, forKey key: String) throws -> [T] {
        let array: [JSON] = try get(key)
        return try array.map(T.init(json:))
    }

    /// Returns a JSON mappable dictionary from a given key.
    public func get<T: JSONMappable>(_ key: String) throws -> [String: T] {
        let object: JSON = try get(key)
        guard case .dictionary(let value) = object else {
            throw MapError.typeMismatch(
                key: key, expected: Dictionary<String, JSON>.self, json: object)
        }
        return try value.mapValues({ try T.init(json: $0) })
    }

    /// Returns a JSON mappable dictionary from a given key.
    public func get(_ key: String) throws -> [String: JSON] {
        let object: JSON = try get(key)
        guard case .dictionary(let value) = object else {
            throw MapError.typeMismatch(
                key: key, expected: Dictionary<String, JSON>.self, json: object)
        }
        return value
    }

    /// Returns JSON entry in the dictionary from a given key.
    public func get(_ key: String) throws -> JSON {
        guard case .dictionary(let dict) = self else {
            throw MapError.typeMismatch(
                key: key, expected: Dictionary<String, JSON>.self, json: self)
        }
        guard let object = dict[key] else {
            throw MapError.missingKey(key)
        }
        return object
    }

    public func getJSON(_ key: String) throws -> JSON {
        return try get(key)
    }

    /// Returns JSON array entry in the dictionary from a given key.
    public func get(_ key: String) throws -> [JSON] {
		let object: JSON = try get(key)
        guard case .array(let array) = object else {
            throw MapError.typeMismatch(key: key, expected: Array<JSON>.self, json: object)
        }
        return array
    }

    public func getArray(_ key: String) throws -> [JSON] {
        return try get(key)
    }

    public func getArray() throws -> [JSON] {
        guard case .array(let array) = self else {
            throw MapError.typeMismatch(key: "<self>", expected: Array<JSON>.self, json: self)
        }
        return array
    }
}

// MARK: - Conformance for basic JSON types.

extension Int: JSONMappable {
    public init(json: JSON) throws {
        guard case .int(let int) = json else {
            throw JSON.MapError.custom(key: nil, message: "expected int, got \(json)")
        }
        self = int
    }
}

extension String: JSONMappable {
    public init(json: JSON) throws {
        guard case .string(let str) = json else {
            throw JSON.MapError.custom(key: nil, message: "expected string, got \(json)")
        }
        self = str
    }
}

extension Bool: JSONMappable {
    public init(json: JSON) throws {
        guard case .bool(let bool) = json else {
            throw JSON.MapError.custom(key: nil, message: "expected bool, got \(json)")
        }
        self = bool
    }
}

extension Double: JSONMappable {
    public init(json: JSON) throws {
        guard case .double(let double) = json else {
            throw JSON.MapError.custom(key: nil, message: "expected double, got \(json)")
        }
        self = double
    }
}

extension Array where Element: JSONMappable {
    public init(json: JSON) throws {
        guard case .array(let array) = json else {
            throw JSON.MapError.custom(key: nil, message: "expected array, got \(json)")
        }
        self = try array.map({ try Element(json: $0) })
    }
}

extension Dictionary where Key == String, Value: JSONMappable {
    public init(json: JSON) throws {
        guard case .dictionary(let dictionary) = json else {
            throw JSON.MapError.custom(key: nil, message: "expected dictionary, got \(json)")
        }
        self = try dictionary.mapValues({ try Value(json: $0) })
    }
}