🚨
Deprecation Notice
🚨
Gloss has been deprecated in favor of Swift's Codable framework.
The existing Gloss source is not going away, however updates will only be made to support migration to Codable. Read the MIGRATION GUIDE now to get started.
If you do not yet have any Gloss models in your project yet are considering it for JSON parsing, turn around now! Select Swift's Codable framework instead.
I understand, I'm Using Gloss Anyway
See the former README.md on instructions for using Gloss pre-Codable migration.
Credits
Gloss was created by Harlan Kellaway
Thank you to all contributors and the Swift community for 5 years of Gloss!
License 
See the LICENSE file for more info.
Codable Migration Quick Reference
The following is a reference for what your Gloss models and call-sites should look like after preparing to migrate to Codable.
See the MIGRATION GUIDE for more detail.
Version
Use version 3.2.0 or higher to take advantage of migration helpers.
Deserialization
Given a Gloss model that conforms to JSONDecodable, add conformance to Decodable. A model that looks like this:
import Gloss
struct MyModel: JSONDecodable {
let id: Int?
init?(json: JSON) {
self.id = "id" <~~ json
}
}
adds
extension MyModel: Decodable {
init(from decoder: Swift.Decoder) throws {
// Proper Decodable definition or throw GlossError.decodableMigrationUnimplemented
// Remove this method if Codable can synthesize decoding for you
}
}
Initializing a Model from JSON
Where initializing that model currently looks like:
let myModel = MyModel(json: someJSON)
it becomes:
let myModel: MyModel = .from(decodableJSON: someJSON)
Serialization
Given a Gloss model that conforms to JSONEncodable, add conformance to Encodable. A model that looks like this:
import Gloss
struct MyModel: JSONEncodable {
let id: Int?
func toJSON() -> JSON? {
return jsonify(["id" ~~> self.id])
}
}
adds
extension MyModel: Encodable {
func encode(to encoder: Swift.Encoder) throws {
// Proper Encodable defintion or throw GlossError.encodableMigrationUnimplemented
// Remove this method if Codable can synthesize encoding for you
}
}
Translating Model Objects to JSON
Where translating to JSON currently looks like this:
let json: JSON? = myModel.toJSON()
it becomes:
let json: JSON? = myModel.toEncodableJSON()
JSON Arrays
Similar usage applies to arrays of Decodable and Encodable models, with from(decodableJSONArray:) and toEncodableJSONArray() respectively.
Configuring JSONDecoder and JSONEncoder
If your Codable definitions are sound but you're encountering Codable errors, make sure your JSONDecoder or JSONEncoder instances are configured properly and pass them at call-sites:
let mySharedJSONDecoder: JSONDecoder = ...
let myModel: MyModel = .from(decodableJSON: someJSON, jsonDecoder: mySharedJSONDecoder)
let mySharedJSONEncoder: JSONEncoder = ...
let json: JSON? = myModel.toEncodableJSON(jsonEncoder: mySharedJSONEncoder)
Using Data Instead of JSON to Create Models
In the places where you've come to rely on Gloss's JSON type, you'll eventually need to pass Data, as that is what Codable uses. To get a jump using decode(:), one option is use the same method Gloss uses to do Data transformation:
import Gloss
let sharedGlossSerializer: GlossJSONSerializer = ...
let json: JSON = ...
if let data: Data? = sharedGlossSerializer.data(from: json, options: nil) {
let myModel: MyModel = try? myJSONDecoder.decode(MyModel.self, from : data)
...
}
Take the opportunity with this migration to pare your models down to the slim amount of code Codable needs to work its magic and detangle your networking code from the details of JSON serialization. Future you will be grateful!
EOF
![[GLOSS] Value found for key](https://avatars.githubusercontent.com/u/11052642?v=4)
43 Dec 15, 2022
9 Aug 22, 2022
1.1k Jan 1, 2023
22 Dec 15, 2022
1 Nov 25, 2021
4 Nov 21, 2022
8 Nov 22, 2022
0 Oct 29, 2021
31 Nov 22, 2021
454 Oct 30, 2022
9 Jul 20, 2022
799 Dec 6, 2022
16 Dec 30, 2022
178 Mar 18, 2022
1.2k Dec 29, 2022
3.5k Dec 20, 2022
3 Apr 2, 2022
252 Oct 28, 2022