-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve support for optionals in singleValueContainer
- Loading branch information
Showing
4 changed files
with
183 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
162 changes: 162 additions & 0 deletions
162
Tests/BinaryCodableTests/PropertyWrapperCodingTests.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| import XCTest | ||
| import BinaryCodable | ||
|
|
||
| /// While from the perspective of `Codable` nothing about property wrapper is special, | ||
| /// they tend to encode their values via `singleValueContainer()`, which requires | ||
| /// some considerations when it comes to dealing with optionals. | ||
| /// | ||
| final class PropertyWrapperCodingTests: XCTestCase { | ||
| struct KeyedWrapper<T: Codable & Equatable>: Codable, Equatable { | ||
| enum CodingKeys: String, CodingKey { | ||
| case wrapper | ||
| } | ||
|
|
||
| @Wrapper | ||
| var value: T | ||
|
|
||
| init(_ value: T) { | ||
| self._value = Wrapper(wrappedValue: value) | ||
| } | ||
|
|
||
| init(from decoder: Decoder) throws { | ||
| let container = try decoder.container(keyedBy: CodingKeys.self) | ||
| self._value = try container.decode(Wrapper<T>.self, forKey: .wrapper) | ||
| } | ||
|
|
||
| func encode(to encoder: Encoder) throws { | ||
| var container = encoder.container(keyedBy: CodingKeys.self) | ||
| try container.encode(_value, forKey: .wrapper) | ||
| } | ||
| } | ||
|
|
||
| @propertyWrapper | ||
| struct Wrapper<T: Codable & Equatable>: Codable, Equatable { | ||
| let wrappedValue: T | ||
|
|
||
| init(wrappedValue: T) { | ||
| self.wrappedValue = wrappedValue | ||
| } | ||
|
|
||
| init(from decoder: Decoder) throws { | ||
| let container = try decoder.singleValueContainer() | ||
| self.wrappedValue = try container.decode(T.self) | ||
| } | ||
|
|
||
| func encode(to encoder: Encoder) throws { | ||
| var container = encoder.singleValueContainer() | ||
| try container.encode(wrappedValue) | ||
| } | ||
| } | ||
|
|
||
| struct WrappedString: Codable, Equatable { | ||
| let val: String | ||
| } | ||
|
|
||
| func assert<T: Codable & Equatable>( | ||
| encoding wrapped: T, | ||
| as type: T.Type = T.self, | ||
| expectByteSuffix byteSuffix: [UInt8], | ||
| file: StaticString = #file, | ||
| line: UInt = #line | ||
| ) throws { | ||
| let bytePrefix: [UInt8] = [ | ||
| 0b01111010, 119, 114, 97, 112, 112, 101, 114, // String key 'wrapper', varint, | ||
| ] | ||
|
|
||
| let wrapper = KeyedWrapper<T>(wrapped) | ||
| let data = try BinaryEncoder.encode(wrapper) | ||
|
|
||
| // If the prefix differs, this error affects the test helper, so report it here | ||
| XCTAssertEqual(Array(data.prefix(bytePrefix.count)), bytePrefix) | ||
|
|
||
| // If the suffix differs, this error is specific to the individual test case, | ||
| // so report it on the call-side | ||
| XCTAssertEqual(Array(data.suffix(from: bytePrefix.count)), byteSuffix, file: file, line: line) | ||
|
|
||
| let decodedWrapper: KeyedWrapper<T> = try BinaryDecoder.decode(from: data) | ||
| XCTAssertEqual(decodedWrapper, wrapper, file: file, line: line) | ||
| } | ||
|
|
||
| func testOptionalWrappedStringSome() throws { | ||
| try assert( | ||
| encoding: WrappedString(val: "Some"), | ||
| as: WrappedString?.self, | ||
| expectByteSuffix: [ | ||
| 11, // Length 11 | ||
| 1, // 1 as in the optional is present | ||
| 9, // Length 9 | ||
| 0b00111010, 118, 97, 108, // String key 'val', varint | ||
| 4, // Length 4, | ||
| 83, 111, 109, 101, // String "Some" | ||
| ] | ||
| ) | ||
| } | ||
|
|
||
| func testOptionalWrappedStringNone() throws { | ||
| try assert( | ||
| encoding: nil, | ||
| as: WrappedString?.self, | ||
| expectByteSuffix: [ | ||
| 1, // Length 1 | ||
| 0, // Optional is absent | ||
| ] | ||
| ) | ||
| } | ||
|
|
||
| func testOptionalBool() throws { | ||
| try assert( | ||
| encoding: .some(true), | ||
| as: Bool?.self, | ||
| expectByteSuffix: [ | ||
| 2, // Length 2 | ||
| 1, // Optional is present | ||
| 1, // Boolean is true | ||
| ] | ||
| ) | ||
|
|
||
| try assert( | ||
| encoding: .some(false), | ||
| as: Bool?.self, | ||
| expectByteSuffix: [ | ||
| 2, // Length 2 | ||
| 1, // Optional is present | ||
| 0, // Boolean is false | ||
| ] | ||
| ) | ||
|
|
||
| try assert( | ||
| encoding: nil, | ||
| as: Bool?.self, | ||
| expectByteSuffix: [ | ||
| 1, // Length 1 | ||
| 0, // Optional is present | ||
| ] | ||
| ) | ||
| } | ||
|
|
||
| func testDoubleOptionalBool() throws { | ||
| try assert( | ||
| encoding: .some(.some(true)), | ||
| as: Bool??.self, | ||
| expectByteSuffix: [3, 1, 1, 1] | ||
| ) | ||
|
|
||
| try assert( | ||
| encoding: .some(.some(false)), | ||
| as: Bool??.self, | ||
| expectByteSuffix: [3, 1, 1, 0] | ||
| ) | ||
|
|
||
| try assert( | ||
| encoding: .some(nil), | ||
| as: Bool??.self, | ||
| expectByteSuffix: [2, 1, 0] | ||
| ) | ||
|
|
||
| try assert( | ||
| encoding: nil, | ||
| as: Bool??.self, | ||
| expectByteSuffix: [1, 0] | ||
| ) | ||
| } | ||
| } |