Merge pull request #356 from kimdv/kimdv/add-protocol-test

Add `ProtocolDecl` test cases

Author: ahoppen

Sources/SwiftSyntaxBuilder/gyb_generated/ExpressibleAsProtocols.swift

@@ -82,10 +82,17 @@ public extension ExpressibleAsSyntaxBuildable {
   }
 }
 
-public protocol ExpressibleAsTypeBuildable {
+public protocol ExpressibleAsTypeBuildable: ExpressibleAsReturnClause {
   func createTypeBuildable() -> TypeBuildable
 }
 
+public extension ExpressibleAsTypeBuildable {
+  /// Conformance to `ExpressibleAsReturnClause`.
+  func createReturnClause() -> ReturnClause {
+    return ReturnClause(returnType: self)
+  }
+}
+
 public protocol ExpressibleAsCodeBlockItem: ExpressibleAsCodeBlockItemList {
   func createCodeBlockItem() -> CodeBlockItem
 }

Sources/SwiftSyntaxBuilder/gyb_helpers/ExpressibleAsConformances.py

@@ -33,6 +33,9 @@
         'BinaryOperatorExpr',
         'DeclModifier',
         'IdentifierExpr'
+    ],
+    'TypeBuildable': [
+        'ReturnClause'
     ]
 }
 

Tests/SwiftSyntaxBuilderTest/ProtocolDeclTests.swift

@@ -0,0 +1,29 @@
+import XCTest
+import SwiftSyntax
+import SwiftSyntaxBuilder
+
+final class ProtocolDeclTests: XCTestCase {
+  func testProtocolDecl() {
+    let returnType = ArrayType(elementType: "DeclSyntax")
+    let input = ParameterClause(parameterListBuilder: {
+      FunctionParameter(firstName: .identifier("format"), colon: .colon, type: "Format", trailingComma: .comma, attributesBuilder: {})
+      FunctionParameter(firstName: .identifier("leadingTrivia"), colon: .colon, type: OptionalType(wrappedType: "Trivia"), attributesBuilder: {})
+    })
+    let functionSignature = FunctionSignature(input: input, output: returnType)
+
+    // FIXME: We need to add the `modifiersBuilder` with a non-empty value, otherwise will the builder omit newline.
+    let functionDecl = FunctionDecl(identifier: .identifier("buildDeclList"), signature: functionSignature, modifiersBuilder: { TokenSyntax.public })
+    let buildable = ProtocolDecl(modifiers: TokenSyntax.public, identifier: .identifier("DeclListBuildable"), members: functionDecl)
+
+    let syntax = buildable.buildSyntax(format: Format())
+
+    var text = ""
+    syntax.write(to: &text)
+
+    XCTAssertEqual(text, """
+    public protocol DeclListBuildable{
+        public func buildDeclList(format: Format, leadingTrivia: Trivia?)-> [DeclSyntax]
+    }
+    """)
+  }
+}

Tests/SwiftSyntaxBuilderTest/ReturnClauseTests.swift

@@ -8,6 +8,7 @@ final class ReturnClauseTests: XCTestCase {
 
     let testCases: [UInt: (ExpressibleAsReturnClause, String)] = [
       #line: (ReturnClause(returnType: "Int"), "␣-> Int"),
+      #line: (ArrayType(elementType: "Int"), "␣-> [Int]"),
       #line: ("Int", "␣-> Int"),
     ]