DynamicCodable

1.1.0

Easily preserve arbitrary Codable data structures when unarchiving
mochidev/DynamicCodable

What's New

1.1.0

2021-04-18T02:09:37Z
  • Fixed an issue where testing on 32-bit would not compile.
  • Fixed minimum swift version to 5.3 due to usage of Comparable.
  • Added support for literals when composing DynamicCodable manually.

DynamicCodable

Test Status

DynamicCodable aims to make it easy to preserve arbitrary Codable data structures when unarchiving, allowing you to inspect those structures in a type safe way after the decoding is finished.

Installation

Add DynamicCodable as a dependency in your Package.swift file to start using it. Then, add import DynamicCodable to any file you wish to use the library in.

Please check the releases for recommended versions.

dependencies: [
    .package(url: "https://github.com/mochidev/DynamicCodable.git", .upToNextMinor(from: "1.0.0")),
],
...
targets: [
    .target(
        name: "MyPackage",
        dependencies: [
            "DynamicCodable",
        ]
    )
]

What is DynamicCodable?

DynamicCodable is an enumeration that represents the various primitive types that are themselves codable. Using it is easy — simply mark the portion of your graph as being of type DynamicCodable to enable that subtree to be preserved during decoding:

struct ServerResponse: Codable {
    let status: String
    let metadata: DynamicCodable
}

let response = try JSONDecoder().decode(ServerResponse.self, from: data)

// Consume the metadata whole
print(response.metadata)

// Dig into the metadata — it's just an enum!
switch response.metadata {
case .keyed(let dictionary)
    print(dictionary["debugInfo"], default: .empty) // Convenience for dictionary[.string("debugInfo"), default: .empty]
case .bool(false):
    print("Metadata disabled")
case .nil:
    print("Metadata unavailable")
default: break
}

Note that DynamicCodable is not limited to be used with JSON coders - it can be used with any Codable-compatible coder!

Contributing

Contribution is welcome! Please take a look at the issues already available, or start a new issue to discuss a new feature. Although guarantees can't be made regarding feature requests, PRs that fit with the goals of the project and that have been discussed before hand are more than welcome!

Please make sure that all submissions have clean commit histories, are well documented, and thoroughly tested. Please rebase your PR before submission rather than merge in main. Linear histories are required.

Description

  • Swift Tools 5.3.0
View More Packages from this Author

Dependencies

  • None
Last updated: Thu Nov 11 2021 13:37:31 GMT-0500 (GMT-05:00)