Make TopLevelEncoder implementation overridable #182
Conversation
| // MARK: - TopLevelEncoder | ||
|
|
||
| open func encode<T>(_ value: T) throws -> Data where T: Encodable { | ||
| try encode(value, withRootKey: nil, rootAttributes: nil, header: nil) |
There was a problem hiding this comment.
| try encode(value, withRootKey: nil, rootAttributes: nil, header: nil) | |
| return try encode(value, withRootKey: nil, rootAttributes: nil, header: nil) |
| @@ -27,6 +27,12 @@ private struct Foo: Codable { | |||
| var name: String | |||
| } | |||
|
|
|||
| final class CustomEncoder: XMLEncoder { | |||
| override func encode<T>(_ value: T) throws -> Data where T : Encodable { | |||
| try self.encode(value, withRootKey: "bar", rootAttributes: nil, header: nil) | |||
There was a problem hiding this comment.
| try self.encode(value, withRootKey: "bar", rootAttributes: nil, header: nil) | |
| return try self.encode(value, withRootKey: "bar", rootAttributes: nil, header: nil) |
There was a problem hiding this comment.
Thanks for the PR. I've added a few suggestions, as we should maintain backwards compatibility with Swift 4.2 syntax. Even though Combine is not available with Swift 4.2, it still seems like older compiler versions still attempt to parse and type check this code.
Codecov Report
@@ Coverage Diff @@
## master #182 +/- ##
=======================================
Coverage 73.32% 73.32%
=======================================
Files 43 43
Lines 2332 2332
=======================================
Hits 1710 1710
Misses 622 622
Continue to review full report at Codecov.
|
| @@ -27,6 +27,12 @@ private struct Foo: Codable { | |||
| var name: String | |||
| } | |||
|
|
|||
| final class CustomEncoder: XMLEncoder { | |||
| override func encode<T>(_ value: T) throws -> Data where T : Encodable { | |||
There was a problem hiding this comment.
| override func encode<T>(_ value: T) throws -> Data where T : Encodable { | |
| override func encode<T>(_ value: T) throws -> Data where T: Encodable { |
There was a problem hiding this comment.
I'm sorry I didn't check SwiftFormat. I fixed in 18282b5.
| @@ -27,6 +27,12 @@ private struct Foo: Codable { | |||
| var name: String | |||
| } | |||
|
|
|||
| final class CustomEncoder: XMLEncoder { | |||
| override func encode<T>(_ value: T) throws -> Data where T : Encodable { | |||
| return try self.encode(value, withRootKey: "bar", rootAttributes: nil, header: nil) | |||
There was a problem hiding this comment.
| return try self.encode(value, withRootKey: "bar", rootAttributes: nil, header: nil) | |
| return try encode(value, withRootKey: "bar", rootAttributes: nil, header: nil) |
|
@MaxDesiatov It seems that danger-lint has failed in |
|
No worries, that seems like a SwiftLint bug 🙂 |
`TopLevelEncoder` implementation was added by CoreOffice#175. However, its method cannot be overridden. If it can be, we can use custom root key, root attributes, or header even when we use Combine-style like this: ```swift final class MyEncoder: XMLEncoder { override func encode<T>(_ value: T) throws -> Data where T : Encodable { try self.encode(value, withRootKey: "foo", rootAttributes: nil, header: XMLHeader(version: 1.0, encoding: "UTF-8")) } } ```
TopLevelEncoderimplementation was added by #175. However, its method cannot be overridden. If it can be, we can use custom root key, root attributes, or header even when we use Combine-style like this:So, I proposed the solution.