SafeDecoder

A Codable extension to decode arrays and to catch & log all decoding failures

Programming language: Swift

License: MIT License

Tags: Data Management     JSON     Parser     Codable    

Latest version: v1.2

README

SafeDecoder

A Codable extension to decode arrays and to catch & log all decoding failures

Features

SafeDecoder makes two improvements for Codable models

• When decoding arrays it can skip over invalid objects, allowing your app to show just valid objects
• It can also collect all the decoding errors and send them to your logging class or service

How to install

Add this to your CocoaPods Podfile

pod 'SafeDecoder'

How to decode arrays

To decode arrays safely, in you model's init(from decoder:) just call container.decodeArray() and pass in the model type in your array

import SafeDecoder

struct MyModel: Decodable {

    var myArray: [CGRect]

    enum CodingKeys: String, CodingKey {
        case myArray
    }

    public init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)

        // to parse an array without re-thowing an error, call decodeArray()
        myArray = try container.decodeArray(CGRect.self, forKey: .myArray)
    }
}

How to decode safely

If you want to collect all decoding errors for logging, implement your own logging code here

SafeDecoder.logger = { error, typeName in
    // replace with a call to your own logging library/service
    print(error)
}

Then in your model's init(from decoder:) call decoder.safeContainer(), then call container.decodeSafe() or container.decodeArraySafe()

SafeDecoder will collect all errors and log them before throwing the exception

import SafeDecoder

struct MyModel: Decodable {

    var myId: String
    var myArray: [CGRect]

    enum CodingKeys: String, CodingKey {
        case myId
        case myArray
    }

    public init(from decoder: Decoder) throws {
        var container = try decoder.safeContainer(keyedBy: CodingKeys.self)

        let _myId = try container.decodeSafe(String.self, forKey: .myId)
        let _myArray = try container.decodeArraySafe(CGRect.self, forKey: .myArray)

        guard
            let myId = _myId,
            let myArray = _myArray
            else {
                // this reference can be your object identifier to help find the issue with your data
                throw container.getErrors(modelType: MyModel.self, reference: _myId)
        }

        self.myId = myId
        self.myArray = myArray
    }
}

Get these while stocks last :)

An elegant solution for keeping views visible when the keyboard is being shown https://github.com/IdleHandsApps/IHKeyboardAvoiding

Button styles that are centralied and reusable, and hooked up to InterfaceBuilder https://github.com/IdleHandsApps/DesignableButton

An extension to easily set your UINavigationBar transparent and hide the shadow https://github.com/IdleHandsApps/UINavigationBar-Transparent

Author

• Fraser Scott-Morrison ([email protected])

It'd be great to hear about any cool apps that are using SafeDecoder

License

Distributed under the MIT License