TypeErasedCodable

A property wrapper that allows porting incompatible Objective-C types like NSNumber to Swift and Codable

Motivation

When migrating an older codebase from Objective-C to Swift, it's common to have Objective-C types like NSNumber used to represent optional numbers in parsed JSON. Unfortunately, if you want to convert these types to Codable and still have Objective-C call sites, then you will run into many interoperability errors.

Imagine the following Objective-C class:

@interface Person : NSObject
@property (readwrite, nullable) NSNumber *age;
@end

When converting it to Swift it would ideally look like:

@objc class Person: NSObject, Codable {
    @objc let age: Int?
}

But the optional integer does not bridge to Objective-C

Property cannot be marked @objc because its type cannot be represented in Objective-C

Usage

To fix the above example, change the implementation to use TypeErasedCodable:

@objc class Person: NSObject, Codable {
    @TypeErasedCodable<NSNumberToIntConverter> @objc var age: NSNumber?
}

You can make your own converters, and the usages go beyond Objective-C bridging. Here we convert a non present Boolean to false to avoid having to deal with optionals:

struct Person: Codable {
   @TypeErasedCodable<NonPresentBoolToFalse> var isAdult: Bool
}

Installation

Add the following to your project's Package.swift file:

.package(url: "https://github.com/jackgmarch/TypeErasedCodable", from: "0.0.1")

or add this package via the Xcode UI by going to File > Swift Packages > Add Package Dependency.

License

MIT License

Copyright (c) 2022 Jack March

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.

jackgmarch / typeerasedcodable Goto Github PK