Skip to content

Access properties with explicit self in encode(to encoder:) #699

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Dec 11, 2024
Merged

Access properties with explicit self in encode(to encoder:) #699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Sources/_OpenAPIGeneratorCore/Translator/CommonTranslations/translateCodable.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ extension FileTranslator {
.try(
.identifierPattern("container").dot("encode\(property.typeUsage.isOptional ? "IfPresent" : "")")
.call([
.init(label: nil, expression: .identifierPattern(property.swiftSafeName)),
.init(label: nil, expression: .identifierPattern("self").dot(property.swiftSafeName)),
.init(label: "forKey", expression: .dot(property.swiftSafeName)),
])
)
Expand Down
8 changes: 8 additions & 0 deletions Tests/OpenAPIGeneratorReferenceTests/Resources/Docs/petstore.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,14 @@ components:
type: [array, null]
items:
type: [string, null]
# To catch the clashes of members and the decoding container.
TypedAdditionalPropertiesWithPropertyNamedContainer:
type: object
properties:
container:
type: string
additionalProperties:
type: integer
CodeError:
type: object
properties:
Expand Down
44 changes: 42 additions & 2 deletions Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/Petstore/Types.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ public enum Components {
public func encode(to encoder: any Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encodeIfPresent(
foo,
self.foo,
forKey: .foo
)
try encoder.encodeAdditionalProperties(additionalProperties)
Expand Down Expand Up @@ -677,7 +677,7 @@ public enum Components {
public func encode(to encoder: any Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encodeIfPresent(
foo,
self.foo,
forKey: .foo
)
try encoder.encodeAdditionalProperties(additionalProperties)
Expand All @@ -698,6 +698,46 @@ public enum Components {
case foo
}
}
/// - Remark: Generated from `#/components/schemas/TypedAdditionalPropertiesWithPropertyNamedContainer`.
public struct TypedAdditionalPropertiesWithPropertyNamedContainer: Codable, Hashable, Sendable {
/// - Remark: Generated from `#/components/schemas/TypedAdditionalPropertiesWithPropertyNamedContainer/container`.
public var container: Swift.String?
/// A container of undocumented properties.
public var additionalProperties: [String: Swift.Int]
/// Creates a new `TypedAdditionalPropertiesWithPropertyNamedContainer`.
///
/// - Parameters:
/// - container:
/// - additionalProperties: A container of undocumented properties.
public init(
container: Swift.String? = nil,
additionalProperties: [String: Swift.Int] = .init()
) {
self.container = container
self.additionalProperties = additionalProperties
}
public enum CodingKeys: String, CodingKey {
case container
}
public init(from decoder: any Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
self.container = try container.decodeIfPresent(
Swift.String.self,
forKey: .container
)
additionalProperties = try decoder.decodeAdditionalProperties(knownKeys: [
"container"
])
}
public func encode(to encoder: any Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encodeIfPresent(
self.container,
forKey: .container
)
try encoder.encodeAdditionalProperties(additionalProperties)
}
}
/// - Remark: Generated from `#/components/schemas/CodeError`.
public struct CodeError: Codable, Hashable, Sendable {
/// - Remark: Generated from `#/components/schemas/CodeError/code`.
Expand Down
28 changes: 25 additions & 3 deletions Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,20 +547,42 @@ final class SnippetBasedReferenceTests: XCTestCase {
schemas:
MyObject:
type: object
properties: {}
properties:
id:
type: string
additionalProperties: true
""",
"""
public enum Schemas {
public struct MyObject: Codable, Hashable, Sendable {
public var id: Swift.String?
public var additionalProperties: OpenAPIRuntime.OpenAPIObjectContainer
public init(additionalProperties: OpenAPIRuntime.OpenAPIObjectContainer = .init()) {
public init(
id: Swift.String? = nil,
additionalProperties: OpenAPIRuntime.OpenAPIObjectContainer = .init()
) {
self.id = id
self.additionalProperties = additionalProperties
}
public enum CodingKeys: String, CodingKey {
case id
}
public init(from decoder: any Decoder) throws {
additionalProperties = try decoder.decodeAdditionalProperties(knownKeys: [])
let container = try decoder.container(keyedBy: CodingKeys.self)
self.id = try container.decodeIfPresent(
Swift.String.self,
forKey: .id
)
additionalProperties = try decoder.decodeAdditionalProperties(knownKeys: [
"id"
])
}
public func encode(to encoder: any Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encodeIfPresent(
self.id,
forKey: .id
)
try encoder.encodeAdditionalProperties(additionalProperties)
}
}
Expand Down
Loading