Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/improve decodable configuration #8

Merged
merged 5 commits into from
Jun 2, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Remove overloads for decode helpers. Add doc comments for decode helpers
feature/improve-decodable-configuration
roanutil committed Jun 2, 2023

Partially verified

This commit is signed with the committer’s verified signature.
gsmet’s contribution has been verified via GPG key.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.
commit 38bdd47a0605e31c723d784e61f4e15fc668b56f
52 changes: 23 additions & 29 deletions Sources/ArgumentEncoding/DecoderUserInfo+OptionHelpers.swift
Original file line number Diff line number Diff line change
@@ -5,9 +5,25 @@

import Foundation

/// Helper functions for configuring a decoder's `userInfo` dictionary for decoding `Option`.
/// Each of the overloads that does not require the configuration closure, will configure both
/// `Option<T>` and `Option<T?>`.
///
/// ```swift
/// struct Container: ArgumentGroup, FormatterNode {
/// let flagFormatter: FlagFormatter = .init(prefix: .doubleDash)
/// let optionFormatter: OptionFormatter = .init(prefix: .doubleDash)
/// @Option var option: String = "value"
/// }
/// let encoded = try JSONEncoder().encode(Container())
/// let decoder = JSONDecoder()
/// decoder.userInfo.addOptionConfiguration(for: String.self)
/// let decoded = try decoder.decode(Container.self, from: encoded)
/// // decoded = ["--option", "value"]
/// ```
extension [CodingUserInfoKey: Any] {
public mutating func addOptionConfiguration<T>(
for _: Option<T>.Type,
for _: T.Type,
configuration: @escaping Option<T>.DecodingConfiguration
) where T: Decodable {
guard let key = Option<T>.configurationCodingUserInfoKey() else {
@@ -16,46 +32,24 @@ extension [CodingUserInfoKey: Any] {
self[key] = configuration
}

public mutating func addOptionConfiguration<T>(for _: Option<T>.Type) where T: Decodable,
T: CustomStringConvertible
{
addOptionConfiguration(for: Option<T>.self, configuration: Option<T>.unwrap(_:))
addOptionConfiguration(for: Option<T>.self, configuration: Option<T?>.unwrap(_:))
}

public mutating func addOptionConfiguration<T>(for _: Option<T>.Type) where T: Decodable, T: RawRepresentable,
T.RawValue: CustomStringConvertible
{
addOptionConfiguration(for: Option<T>.self, configuration: Option<T>.unwrap(_:))
addOptionConfiguration(for: Option<T>.self, configuration: { $0.rawValue.description })
}

public mutating func addOptionConfiguration<T>(for _: Option<T>.Type) where T: Decodable,
T: CustomStringConvertible,
T: RawRepresentable, T.RawValue: CustomStringConvertible
{
addOptionConfiguration(for: Option<T>.self, configuration: Option<T>.unwrap(_:))
addOptionConfiguration(for: Option<T>.self, configuration: Option<T?>.unwrap(_:))
}

public mutating func addOptionConfiguration<T>(for _: T.Type) where T: Decodable,
T: CustomStringConvertible
{
addOptionConfiguration(for: Option<T>.self, configuration: Option<T>.unwrap(_:))
addOptionConfiguration(for: Option<T>.self, configuration: Option<T?>.unwrap(_:))
addOptionConfiguration(for: T.self, configuration: Option<T>.unwrap(_:))
addOptionConfiguration(for: T.self, configuration: Option<T?>.unwrap(_:))
}

public mutating func addOptionConfiguration<T>(for _: T.Type) where T: Decodable, T: RawRepresentable,
T.RawValue: CustomStringConvertible
{
addOptionConfiguration(for: Option<T>.self, configuration: Option<T>.unwrap(_:))
addOptionConfiguration(for: Option<T>.self, configuration: { $0.rawValue.description })
addOptionConfiguration(for: T.self, configuration: Option<T>.unwrap(_:))
addOptionConfiguration(for: T.self, configuration: { $0.rawValue.description })
}

public mutating func addOptionConfiguration<T>(for _: T.Type) where T: Decodable, T: CustomStringConvertible,
T: RawRepresentable, T.RawValue: CustomStringConvertible
{
addOptionConfiguration(for: Option<T>.self, configuration: Option<T>.unwrap(_:))
addOptionConfiguration(for: Option<T>.self, configuration: Option<T?>.unwrap(_:))
addOptionConfiguration(for: T.self, configuration: Option<T>.unwrap(_:))
addOptionConfiguration(for: T.self, configuration: Option<T?>.unwrap(_:))
}
}
44 changes: 16 additions & 28 deletions Sources/ArgumentEncoding/DecoderUserInfo+OptionSetHelpers.swift
Original file line number Diff line number Diff line change
@@ -5,17 +5,23 @@

import Foundation

/// Helper functions for configuring a decoder's `userInfo` dictionary for decoding `OptionSet`.
/// Each of the overloads that does not require the configuration closure, will configure both
/// `OptionSet<T>` and `OptionSet<T?>`.
///
/// ```swift
/// struct Container: ArgumentGroup, FormatterNode {
/// let flagFormatter: FlagFormatter = .init(prefix: .doubleDash)
/// let optionFormatter: OptionFormatter = .init(prefix: .doubleDash)
/// @OptionSet var option: [String] = ["value1", "value2"]
/// }
/// let encoded = try JSONEncoder().encode(Container())
/// let decoder = JSONDecoder()
/// decoder.userInfo.addOptionConfiguration(for: String.self)
/// let decoded = try decoder.decode(Container.self, from: encoded)
/// // decoded = ["--option", "value1", "--option", "value2"]
/// ```
extension [CodingUserInfoKey: Any] {
public mutating func addOptionSetConfiguration<T>(
for _: T.Type,
configuration: @escaping Option<T>.DecodingConfiguration
) where T: Decodable {
guard let key = Option<T>.configurationCodingUserInfoKey() else {
return
}
self[key] = configuration
}

public mutating func addOptionSetConfiguration<T>(
for _: OptionSet<T>.Type,
configuration: @escaping OptionSet<T>.DecodingConfiguration
@@ -26,24 +32,6 @@ extension [CodingUserInfoKey: Any] {
self[key] = configuration
}

public mutating func addOptionSetConfiguration<T>(for _: OptionSet<T>.Type) where T: Decodable, T: Sequence,
T.Element: CustomStringConvertible
{
addOptionSetConfiguration(for: OptionSet<T>.self, configuration: OptionSet<T>.unwrap(_:))
}

public mutating func addOptionSetConfiguration<T>(for _: OptionSet<T>.Type) where T: Decodable, T: Sequence,
T.Element: RawRepresentable, T.Element.RawValue: CustomStringConvertible
{
addOptionSetConfiguration(for: OptionSet<T>.self, configuration: OptionSet<T>.unwrap(_:))
}

public mutating func addOptionSetConfiguration<T>(for _: OptionSet<T>.Type) where T: Decodable, T: Sequence,
T.Element: CustomStringConvertible, T.Element: RawRepresentable, T.Element.RawValue: CustomStringConvertible
{
addOptionSetConfiguration(for: OptionSet<T>.self, configuration: OptionSet<T>.unwrap(_:))
}

public mutating func addOptionSetConfiguration<T>(for _: T.Type) where T: Decodable, T: Sequence,
T.Element: CustomStringConvertible
{
4 changes: 2 additions & 2 deletions Tests/ArgumentEncodingTests/OptionDecodingTests.swift
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ final class OptionDecodingTests: XCTestCase {
let option = Option(wrappedValue: "value")
let data = try encoder.encode(option)
let decoder = JSONDecoder()
decoder.userInfo.addOptionConfiguration(for: Option<String>.self)
decoder.userInfo.addOptionConfiguration(for: String.self)
let decoded = try decoder.decode(Option<String>.self, from: data)
XCTAssertEqual(decoded, option)
}
@@ -23,7 +23,7 @@ final class OptionDecodingTests: XCTestCase {
let container = OptionContainer(option: "value")
let data = try encoder.encode(container)
let decoder = JSONDecoder()
decoder.userInfo.addOptionConfiguration(for: Option<String>.self)
decoder.userInfo.addOptionConfiguration(for: String.self)
let decoded = try decoder.decode(OptionContainer.self, from: data)
XCTAssertEqual(decoded, container)
}
4 changes: 2 additions & 2 deletions Tests/ArgumentEncodingTests/OptionSetDecodingTests.swift
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ final class OptionSetDecodingTests: XCTestCase {
let optionSet = OptionSet(wrappedValue: ["value1", "value2"])
let data = try encoder.encode(optionSet)
let decoder = JSONDecoder()
decoder.userInfo.addOptionSetConfiguration(for: OptionSet<[String]>.self)
decoder.userInfo.addOptionSetConfiguration(for: [String].self)
let decoded = try decoder.decode(OptionSet<[String]>.self, from: data)
XCTAssertEqual(decoded, optionSet)
}
@@ -23,7 +23,7 @@ final class OptionSetDecodingTests: XCTestCase {
let container = OptionSetContainer(option: ["value1", "value2"])
let data = try encoder.encode(container)
let decoder = JSONDecoder()
decoder.userInfo.addOptionSetConfiguration(for: OptionSet<[String]>.self)
decoder.userInfo.addOptionSetConfiguration(for: [String].self)
let decoded = try decoder.decode(OptionSetContainer.self, from: data)
XCTAssertEqual(decoded, container)
}