Skip to content

[Generator] Accept header #185

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 11 commits into from
Aug 24, 2023
Merged

[Generator] Accept header #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0e4b57c
[Prototype] Accept header
czechboy0 Aug 10, 2023
838303d
Merge branch 'main' into hd-accept-header-prototype
czechboy0 Aug 14, 2023
2bc4fc1
Merge branch 'main' into hd-accept-header-prototype
czechboy0 Aug 14, 2023
d051353
PR feedback
czechboy0 Aug 15, 2023
5c45519
Merge branch 'main' into hd-accept-header-prototype
czechboy0 Aug 15, 2023
6ad1630
Prototype working end-to-end
czechboy0 Aug 15, 2023
ed03f89
Merge branch 'main' into hd-accept-header-prototype
czechboy0 Aug 23, 2023
6cefe2b
Fixed up bad merges
czechboy0 Aug 23, 2023
4220717
Formatting
czechboy0 Aug 23, 2023
b9ace9a
PR feedback
czechboy0 Aug 24, 2023
2f96123
Bump runtime to 0.1.10
czechboy0 Aug 24, 2023
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
6 changes: 4 additions & 2 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,10 @@ let package = Package(
from: "1.0.1"
),

// Tests-only: Runtime library linked by generated code
.package(url: "https://github.com/apple/swift-openapi-runtime", .upToNextMinor(from: "0.1.9")),
// Tests-only: Runtime library linked by generated code, and also
// helps keep the runtime library new enough to work with the generated
// code.
.package(url: "https://github.com/apple/swift-openapi-runtime", .upToNextMinor(from: "0.1.10")),

// Build and preview docs
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
Expand Down
31 changes: 14 additions & 17 deletions Sources/_OpenAPIGeneratorCore/Translator/ClientTranslator/translateClientMethod.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,23 +71,20 @@ extension ClientFileTranslator {
for: description
)
if !acceptContent.isEmpty {
// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept
let acceptValue =
acceptContent
.map(\.headerValueForValidation)
.joined(separator: ", ")
let addAcceptHeaderExpr: Expression = .try(
.identifier("converter").dot("setHeaderFieldAsText")
.call([
.init(
label: "in",
expression: .inOut(.identifier("request").dot("headerFields"))
),
.init(label: "name", expression: "accept"),
.init(label: "value", expression: .literal(acceptValue)),
])
)
requestExprs.append(addAcceptHeaderExpr)
let setAcceptHeaderExpr: Expression =
.identifier("converter")
.dot("setAcceptHeader")
.call([
.init(
label: "in",
expression: .inOut(.identifier("request").dot("headerFields"))
),
.init(
label: "contentTypes",
expression: .identifier("input").dot("headers").dot("accept")
),
])
requestExprs.append(setAcceptHeaderExpr)
}

if let requestBody = try typedRequestBody(in: description) {
Expand Down
217 changes: 217 additions & 0 deletions ...s/_OpenAPIGeneratorCore/Translator/CommonTranslations/translateRawRepresentableEnum.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftOpenAPIGenerator open source project
//
// Copyright (c) 2023 Apple Inc. and the SwiftOpenAPIGenerator project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftOpenAPIGenerator project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
import OpenAPIKit30

extension FileTranslator {

/// Returns a declaration of the specified raw representable enum.
/// - Parameters:
/// - typeName: The name of the type to give to the declared enum.
/// - conformances: The list of types the enum conforms to.
/// - userDescription: The contents of the documentation comment.
/// - cases: The list of cases to generate.
/// - unknownCaseName: The name of the extra unknown case that preserves
/// the string value that doesn't fit any of the cases. If nil is
/// passed, the unknown case is not generated.
/// - unknownCaseDescription: The contents of the documentation comment
/// for the unknown case.
/// - customSwitchedExpression: A closure
func translateRawRepresentableEnum(
typeName: TypeName,
conformances: [String],
userDescription: String?,
cases: [(caseName: String, rawValue: String)],
unknownCaseName: String?,
unknownCaseDescription: String?,
customSwitchedExpression: (Expression) -> Expression = { $0 }
) throws -> Declaration {

let generateUnknownCases = unknownCaseName != nil
let knownCases: [Declaration] =
cases
.map { caseName, rawValue in
.enumCase(
name: caseName,
kind: generateUnknownCases ? .nameOnly : .nameWithRawValue(rawValue)
)
}

let otherMembers: [Declaration]
if let unknownCaseName {
let undocumentedCase: Declaration = .commentable(
unknownCaseDescription.flatMap { .doc($0) },
.enumCase(
name: unknownCaseName,
kind: .nameWithAssociatedValues([
.init(type: "String")
])
)
)
let rawRepresentableInitializer: Declaration
do {
let knownCases: [SwitchCaseDescription] = cases.map { caseName, rawValue in
.init(
kind: .case(.literal(rawValue)),
body: [
.expression(
.assignment(
Expression
.identifier("self")
.equals(
.dot(caseName)
)
)
)
]
)
}
let unknownCase = SwitchCaseDescription(
kind: .default,
body: [
.expression(
.assignment(
Expression
.identifier("self")
.equals(
.functionCall(
calledExpression: .dot(
unknownCaseName
),
arguments: [
.identifier("rawValue")
]
)
)
)
)
]
)
rawRepresentableInitializer = .function(
.init(
accessModifier: config.access,
kind: .initializer(failable: true),
parameters: [
.init(label: "rawValue", type: "String")
],
body: [
.expression(
.switch(
switchedExpression: customSwitchedExpression(
.identifier("rawValue")
),
cases: knownCases + [unknownCase]
)
)
]
)
)
}

let rawValueGetter: Declaration
do {
let knownCases: [SwitchCaseDescription] = cases.map { caseName, rawValue in
.init(
kind: .case(.dot(caseName)),
body: [
.expression(
.return(.literal(rawValue))
)
]
)
}
let unknownCase = SwitchCaseDescription(
kind: .case(
.valueBinding(
kind: .let,
value: .init(
calledExpression: .dot(
unknownCaseName
),
arguments: [
.identifier("string")
]
)
)
),
body: [
.expression(
.return(.identifier("string"))
)
]
)

let variableDescription = VariableDescription(
accessModifier: config.access,
kind: .var,
left: "rawValue",
type: "String",
body: [
.expression(
.switch(
switchedExpression: .identifier("self"),
cases: [unknownCase] + knownCases
)
)
]
)

rawValueGetter = .variable(
variableDescription
)
}

let allCasesGetter: Declaration
do {
let caseExpressions: [Expression] = cases.map { caseName, _ in
.memberAccess(.init(right: caseName))
}
allCasesGetter = .variable(
.init(
accessModifier: config.access,
isStatic: true,
kind: .var,
left: "allCases",
type: "[Self]",
body: [
.expression(.literal(.array(caseExpressions)))
]
)
)
}
otherMembers = [
undocumentedCase,
rawRepresentableInitializer,
rawValueGetter,
allCasesGetter,
]
} else {
otherMembers = []
}

let enumDescription = EnumDescription(
isFrozen: true,
accessModifier: config.access,
name: typeName.shortSwiftName,
conformances: conformances,
members: knownCases + otherMembers
)
let comment: Comment? =
typeName
.docCommentWithUserDescription(userDescription)
return .commentable(
comment,
.enum(enumDescription)
)
}
}
Loading