-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add the @PolymorphicTransactionConstraintEntry macro to simplify crea…
…ting enumerations conforming to the PolymorphicTransactionConstraintEntry protocol. (#40)
- Loading branch information
1 parent
de7ebcd
commit c5b1b60
Showing
7 changed files
with
264 additions
and
170 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the DynamoDBTables open source project | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // See CONTRIBUTORS.txt for the list of DynamoDBTables authors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| // | ||
| // BaseEntryMacro.swift | ||
| // DynamoDBTablesMacros | ||
| // | ||
|
|
||
| import SwiftDiagnostics | ||
| import SwiftSyntax | ||
| import SwiftSyntaxMacros | ||
|
|
||
| protocol MacroAttributes { | ||
| static var macroName: String { get } | ||
|
|
||
| static var protocolName: String { get } | ||
|
|
||
| static var transformType: String { get } | ||
|
|
||
| static var contextType: String { get } | ||
| } | ||
|
|
||
| enum BaseEntryDiagnostic<Attributes: MacroAttributes>: String, DiagnosticMessage { | ||
| case notAttachedToEnumDeclaration | ||
| case enumMustHaveSendableConformance | ||
| case enumMustNotHaveZeroCases | ||
| case enumCasesMustHaveASingleParameter | ||
|
|
||
| var diagnosticID: MessageID { | ||
| MessageID(domain: "\(Attributes.macroName)Macro", id: rawValue) | ||
| } | ||
|
|
||
| var severity: DiagnosticSeverity { .error } | ||
|
|
||
| static var obj: String { "" } | ||
|
|
||
| var message: String { | ||
| switch self { | ||
| case .notAttachedToEnumDeclaration: | ||
| return "@\(Attributes.macroName) must be attached to an enum declaration." | ||
| case .enumMustHaveSendableConformance: | ||
| return "@\(Attributes.macroName) decorated enum must conform to Sendable." | ||
| case .enumMustNotHaveZeroCases: | ||
| return "@\(Attributes.macroName) decorated enum must be have at least a singe case." | ||
| case .enumCasesMustHaveASingleParameter: | ||
| return "@\(Attributes.macroName) decorated enum can only have case entries with a single parameter." | ||
| } | ||
| } | ||
| } | ||
|
|
||
| enum BaseEntryMacro<Attributes: MacroAttributes>: ExtensionMacro { | ||
| private static func getCases(caseMembers: [EnumCaseDeclSyntax], context: some MacroExpansionContext, passCompositePrimaryKey: Bool) | ||
| -> (hasDiagnostics: Bool, handleCases: SwitchCaseListSyntax, compositePrimaryKeyCases: SwitchCaseListSyntax) | ||
| { | ||
| var handleCases: SwitchCaseListSyntax = [] | ||
| var compositePrimaryKeyCases: SwitchCaseListSyntax = [] | ||
| var hasDiagnostics = false | ||
| for caseMember in caseMembers { | ||
| for element in caseMember.elements { | ||
| // ensure that the enum case only has one parameter | ||
| guard let parameterClause = element.parameterClause, parameterClause.parameters.count == 1 else { | ||
| context.diagnose(.init(node: element, message: BaseEntryDiagnostic<Attributes>.enumCasesMustHaveASingleParameter)) | ||
| hasDiagnostics = true | ||
| // do nothing for this case | ||
| continue | ||
| } | ||
|
|
||
| // TODO: when made possible by the language, check that the type of the parameter conforms to `WriteEntry` or `TransactionConstraintEntry` | ||
| // https://github.com/swift-server-community/dynamo-db-tables/issues/38 | ||
|
|
||
| let handleCaseSyntax = SwitchCaseListSyntax.Element( | ||
| """ | ||
| case let .\(element.name)(writeEntry): | ||
| return try context.transform(writeEntry) | ||
| """) | ||
|
|
||
| handleCases.append(handleCaseSyntax) | ||
|
|
||
| if passCompositePrimaryKey { | ||
| let compositePrimaryKeyCaseSyntax = SwitchCaseListSyntax.Element( | ||
| """ | ||
| case let .\(element.name)(writeEntry): | ||
| return writeEntry.compositePrimaryKey | ||
| """) | ||
|
|
||
| compositePrimaryKeyCases.append(compositePrimaryKeyCaseSyntax) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return (hasDiagnostics, handleCases, compositePrimaryKeyCases) | ||
| } | ||
|
|
||
| static func expansion( | ||
| of node: AttributeSyntax, | ||
| attachedTo declaration: some DeclGroupSyntax, | ||
| providingExtensionsOf type: some TypeSyntaxProtocol, | ||
| conformingTo protocols: [TypeSyntax], | ||
| in context: some MacroExpansionContext) throws -> [ExtensionDeclSyntax] | ||
| { | ||
| let passCompositePrimaryKey: Bool | ||
| if let arguments = node.arguments, case let .argumentList(argumentList) = arguments, let firstArgument = argumentList.first, argumentList.count == 1, | ||
| firstArgument.label?.text == "passCompositePrimaryKey", let expression = firstArgument.expression.as(BooleanLiteralExprSyntax.self), | ||
| case let .keyword(keyword) = expression.literal.tokenKind, keyword == SwiftSyntax.Keyword.false | ||
| { | ||
| passCompositePrimaryKey = false | ||
| } else { | ||
| passCompositePrimaryKey = true | ||
| } | ||
|
|
||
| // make sure this is attached to an enum | ||
| guard let enumDeclaration = declaration as? EnumDeclSyntax else { | ||
| context.diagnose(.init(node: declaration, message: BaseEntryDiagnostic<Attributes>.notAttachedToEnumDeclaration)) | ||
|
|
||
| return [] | ||
| } | ||
|
|
||
| let requiresProtocolConformance = protocols.reduce(false) { partialResult, protocolSyntax in | ||
| if let identifierTypeSyntax = protocolSyntax.as(IdentifierTypeSyntax.self), identifierTypeSyntax.name.text == Attributes.protocolName { | ||
| return true | ||
| } | ||
|
|
||
| return partialResult | ||
| } | ||
|
|
||
| // make sure the type is conforming to Sendable | ||
| let hasSendableConformance = declaration.inheritanceClause?.inheritedTypes.reduce(false) { partialResult, inheritedType in | ||
| if let identifierTypeSyntax = inheritedType.type.as(IdentifierTypeSyntax.self), identifierTypeSyntax.name.text == "Sendable" { | ||
| return true | ||
| } | ||
|
|
||
| return partialResult | ||
| } ?? false | ||
|
|
||
| guard hasSendableConformance else { | ||
| context.diagnose(.init(node: declaration, message: BaseEntryDiagnostic<Attributes>.enumMustHaveSendableConformance)) | ||
|
|
||
| return [] | ||
| } | ||
|
|
||
| let memberBlock = enumDeclaration.memberBlock.members | ||
|
|
||
| let caseMembers: [EnumCaseDeclSyntax] = memberBlock.compactMap { member in | ||
| if let caseMember = member.decl.as(EnumCaseDeclSyntax.self) { | ||
| return caseMember | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // make sure this is attached to an enum | ||
| guard !caseMembers.isEmpty else { | ||
| context.diagnose(.init(node: declaration, message: BaseEntryDiagnostic<Attributes>.enumMustNotHaveZeroCases)) | ||
|
|
||
| return [] | ||
| } | ||
|
|
||
| let (hasDiagnostics, handleCases, compositePrimaryKeyCases) = self.getCases(caseMembers: caseMembers, context: context, | ||
| passCompositePrimaryKey: passCompositePrimaryKey) | ||
|
|
||
| if hasDiagnostics { | ||
| return [] | ||
| } | ||
|
|
||
| let type = TypeSyntax(extendedGraphemeClusterLiteral: requiresProtocolConformance ? "\(type.trimmed): \(Attributes.protocolName) " | ||
| : "\(type.trimmed) ") | ||
| let extensionDecl = try ExtensionDeclSyntax( | ||
| extendedType: type, | ||
| memberBlockBuilder: { | ||
| try FunctionDeclSyntax( | ||
| "func handle<Context: \(raw: Attributes.contextType)>(context: Context) throws -> Context.\(raw: Attributes.transformType)") | ||
| { | ||
| SwitchExprSyntax(subject: ExprSyntax(stringLiteral: "self"), cases: handleCases) | ||
| } | ||
|
|
||
| if passCompositePrimaryKey { | ||
| try VariableDeclSyntax("var compositePrimaryKey: StandardCompositePrimaryKey?") { | ||
| SwitchExprSyntax(subject: ExprSyntax(stringLiteral: "self"), cases: compositePrimaryKeyCases) | ||
| } | ||
| } | ||
| }) | ||
|
|
||
| return [extensionDecl] | ||
| } | ||
| } |
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
45 changes: 45 additions & 0 deletions
45
Sources/DynamoDBTablesMacros/PolymorphicTransactionConstraintEntryMacro.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,45 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the DynamoDBTables open source project | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // See CONTRIBUTORS.txt for the list of DynamoDBTables authors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| // | ||
| // PolymorphicTransactionConstraintEntryMacro.swift | ||
| // DynamoDBTablesMacros | ||
| // | ||
|
|
||
| import SwiftDiagnostics | ||
| import SwiftSyntax | ||
| import SwiftSyntaxMacros | ||
|
|
||
| struct PolymorphicTransactionConstraintEntryMacroAttributes: MacroAttributes { | ||
| static var macroName: String = "PolymorphicTransactionConstraintEntry" | ||
|
|
||
| static var protocolName: String = "PolymorphicTransactionConstraintEntry" | ||
|
|
||
| static var transformType: String = "WriteTransactionConstraintType" | ||
|
|
||
| static var contextType: String = "PolymorphicWriteEntryContext" | ||
| } | ||
|
|
||
| public enum PolymorphicTransactionConstraintEntryMacro: ExtensionMacro { | ||
| public static func expansion( | ||
| of node: AttributeSyntax, | ||
| attachedTo declaration: some DeclGroupSyntax, | ||
| providingExtensionsOf type: some TypeSyntaxProtocol, | ||
| conformingTo protocols: [TypeSyntax], | ||
| in context: some MacroExpansionContext) throws -> [ExtensionDeclSyntax] | ||
| { | ||
| try BaseEntryMacro<PolymorphicTransactionConstraintEntryMacroAttributes>.expansion(of: node, | ||
| attachedTo: declaration, | ||
| providingExtensionsOf: type, | ||
| conformingTo: protocols, | ||
| in: context) | ||
| } | ||
| } |
Oops, something went wrong.