Merge pull request #335 from kimdv/kimdv/conform-string-to-expressible-as-protocols

Make `String` conform to `ExpressibleAs` protocols

Author: kimdv

Sources/SwiftSyntaxBuilder/Buildables.swift.gyb

@@ -301,4 +301,20 @@ extension ExpressibleAs${protocol} {
 }
 
 %   end
+%   if 'TypeAnnotation' in conformances:
+extension ExpressibleAs${protocol} {
+  public func createTypeAnnotation() -> TypeAnnotation {
+    TypeAnnotation(type: self)
+  }
+}
+
+%   end
+%   if 'TypeExpr' in conformances:
+ extension ExpressibleAs${protocol} {
+   public func createTypeExpr() -> TypeExpr {
+     TypeExpr(type: self)
+   }
+ }
+
+ %   end
 % end

Sources/SwiftSyntaxBuilder/FunctionCallExprConvenienceInitializers.swift

@@ -15,15 +15,15 @@ import Foundation
 
 extension FunctionCallExpr {
   public init(
-    _ calledExpression: IdentifierExpr,
+    _ calledExpression: ExpressibleAsIdentifierExpr,
     leftParen: ExpressibleAsTokenSyntax? = nil,
     rightParen: ExpressibleAsTokenSyntax? = nil,
     trailingClosure: ExpressibleAsClosureExpr? = nil,
     @TupleExprElementListBuilder argumentListBuilder: () -> TupleExprElementList = { .empty },
     @MultipleTrailingClosureElementListBuilder additionalTrailingClosuresBuilder: () -> MultipleTrailingClosureElementList? = { nil }
   ) {
     self.init(
-      calledExpression: calledExpression,
+      calledExpression: calledExpression.createIdentifierExpr(),
       leftParen: leftParen,
       argumentList: argumentListBuilder(),
       rightParen: rightParen,

Sources/SwiftSyntaxBuilder/StringConvenienceInitializers.swift

@@ -0,0 +1,49 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+extension String: ExpressibleAsSimpleTypeIdentifier {
+  public func createSimpleTypeIdentifier() -> SimpleTypeIdentifier {
+    SimpleTypeIdentifier(self)
+  }
+}
+
+extension String: ExpressibleAsIdentifierPattern {
+  public func createIdentifierPattern() -> IdentifierPattern {
+    IdentifierPattern(self)
+  }
+}
+
+extension String: ExpressibleAsIdentifierExpr {
+  public func createIdentifierExpr() -> IdentifierExpr {
+    IdentifierExpr(self)
+  }
+}
+
+extension String: ExpressibleAsStringLiteralExpr {
+  public func createStringLiteralExpr() -> StringLiteralExpr {
+    StringLiteralExpr(self)
+  }
+}
+
+/// Default conformance to `ExpressibleByTypeBuildable`
+extension String {
+  public func createTypeBuildable() -> TypeBuildable {
+    SimpleTypeIdentifier(self)
+  }
+}
+
+/// Default conformance to `ExpressibleByPatternBuildable`
+extension String {
+  public func createPatternBuildable() -> PatternBuildable {
+    IdentifierPattern(self)
+  }
+}

Sources/SwiftSyntaxBuilder/VariableDeclConvenienceInitializers.swift

@@ -13,10 +13,12 @@
 import SwiftSyntax
 
 extension VariableDecl {
-  public init(_ letOrVarKeyword: TokenSyntax, name: String, type: String) {
+  public init(_ letOrVarKeyword: TokenSyntax,
+              name: ExpressibleAsIdentifierPattern,
+              type: ExpressibleAsTypeAnnotation) {
     self.init(letOrVarKeyword: letOrVarKeyword, bindingsBuilder: {
-      PatternBinding(pattern: IdentifierPattern(name),
-                     typeAnnotation: TypeAnnotation(type))
+      PatternBinding(pattern: name.createIdentifierPattern(),
+                     typeAnnotation: type.createTypeAnnotation())
       })
   }
 }

Sources/SwiftSyntaxBuilder/gyb_generated/Buildables.swift

@@ -9548,7 +9548,7 @@ public struct SimpleTypeIdentifier: TypeBuildable {
   }
 }
 
-public protocol ExpressibleAsSimpleTypeIdentifier {
+public protocol ExpressibleAsSimpleTypeIdentifier: ExpressibleAsTypeAnnotation, ExpressibleAsTypeBuildable, ExpressibleAsTypeExpr {
   func createSimpleTypeIdentifier() -> SimpleTypeIdentifier
 }
 
@@ -10624,7 +10624,7 @@ public struct IdentifierPattern: PatternBuildable {
   }
 }
 
-public protocol ExpressibleAsIdentifierPattern {
+public protocol ExpressibleAsIdentifierPattern: ExpressibleAsPatternBuildable {
   func createIdentifierPattern() -> IdentifierPattern
 }
 
@@ -11450,3 +11450,15 @@ extension ExpressibleAsExprList {
   }
 }
 
+extension ExpressibleAsSimpleTypeIdentifier {
+  public func createTypeAnnotation() -> TypeAnnotation {
+    TypeAnnotation(type: self)
+  }
+}
+
+ extension ExpressibleAsSimpleTypeIdentifier {
+   public func createTypeExpr() -> TypeExpr {
+     TypeExpr(type: self)
+   }
+ }
+

Tests/SwiftSyntaxBuilderTest/EnumCaseElementTests.swift

@@ -15,7 +15,7 @@ final class EnumCaseElementTests: XCTestCase {
 
     let initializerClause = InitializerClause(value: stringLiteralExpr)
 
-    let enumCase = EnumCaseElement(identifier: SyntaxFactory.makeIdentifier("TestEnum"),
+    let enumCase = EnumCaseElement(identifier: "TestEnum",
                                    rawValue: initializerClause)
 
     let test = enumCase.buildSyntax(format: Format(), leadingTrivia: leadingTrivia)

Tests/SwiftSyntaxBuilderTest/ExpressibleBuildablesTests.swift

@@ -9,8 +9,7 @@ final class ExpressibleBuildablesTests: XCTestCase {
 
       // We use `MemberDeclListItem` to ensure and show we can combine it with `ExpressibleAsMemberDeclListItem`
       MemberDeclListItem(decl: VariableDecl(letOrVarKeyword: TokenSyntax.let, bindingsBuilder: {
-        PatternBinding(pattern: IdentifierPattern(identifier: TokenSyntax.identifier("myOtherLet")),
-                       typeAnnotation: TypeAnnotation(type: SimpleTypeIdentifier("String")))
+        PatternBinding(pattern: "myOtherLet", typeAnnotation: "String")
       })
       )
 
@@ -48,7 +47,7 @@ final class ExpressibleBuildablesTests: XCTestCase {
 
   func testExpressibleAsSwitchStmt() {
     let versions = [("version_1", "1.0.0"), ("version_2", "2.0.0"), ("version_3", "3.0.0"), ("version_3_1", "3.1.0")]
-    let expression = IdentifierExpr(identifier: SyntaxFactory.makeIdentifier("version"))
+    let expression = IdentifierExpr("version")
 
     let switchStmt = SwitchStmt(labelName: nil,
                                 expression: expression,

Tests/SwiftSyntaxBuilderTest/FunctionTests.swift

@@ -7,14 +7,14 @@ final class FunctionTests: XCTestCase {
     let leadingTrivia = Trivia.garbageText("␣")
 
     let input = ParameterClause(parameterListBuilder: {
-      FunctionParameter(firstName: TokenSyntax.wildcard, secondName: TokenSyntax.identifier("n"), colon: TokenSyntax.colon, type: SimpleTypeIdentifier("Int"), attributesBuilder: {})
+      FunctionParameter(firstName: TokenSyntax.wildcard, secondName: TokenSyntax.identifier("n"), colon: TokenSyntax.colon, type: "Int", attributesBuilder: {})
     })
 
     let ifCodeBlock = CodeBlock(statementsBuilder: {
       ReturnStmt(expression: IntegerLiteralExpr(digits: "n"))
     })
 
-    let signature = FunctionSignature(input: input, output: ReturnClause(returnType: SimpleTypeIdentifier("Int")))
+    let signature = FunctionSignature(input: input, output: ReturnClause(returnType: "Int"))
 
 
     let codeBlock = CodeBlock(statementsBuilder: {

Tests/SwiftSyntaxBuilderTest/IdentifierExprTests.swift

@@ -6,7 +6,7 @@ final class IdentifierExprTests: XCTestCase {
   func testStringLiteral() {
     let leadingTrivia = Trivia.garbageText("␣")
 
-    let testCases: [UInt: (IdentifierExpr, String)] = [
+    let testCases: [UInt: (ExpressibleAsIdentifierExpr, String)] = [
       #line: (IdentifierExpr(identifier: .identifier("Test")), "␣Test"),
       #line: (IdentifierExpr(stringLiteral: "Test"), "␣Test"),
       #line: (IdentifierExpr("Test"), "␣Test"),
@@ -15,7 +15,8 @@ final class IdentifierExprTests: XCTestCase {
 
     for (line, testCase) in testCases {
       let (builder, expected) = testCase
-      let syntax = builder.buildSyntax(format: Format(), leadingTrivia: leadingTrivia)
+      let identifierExpr = builder.createIdentifierExpr()
+      let syntax = identifierExpr.buildSyntax(format: Format(), leadingTrivia: leadingTrivia)
 
       var text = ""
       syntax.write(to: &text)

Tests/SwiftSyntaxBuilderTest/IdentifierPatternTests.swift

@@ -6,7 +6,7 @@ final class IdentifierPatternTests: XCTestCase {
   func testStringLiteral() {
     let leadingTrivia = Trivia.garbageText("␣")
 
-    let testCases: [UInt: (IdentifierPattern, String)] = [
+    let testCases: [UInt: (ExpressibleAsIdentifierPattern, String)] = [
       #line: (IdentifierPattern(identifier: .identifier("Test")), "␣Test"),
       #line: (IdentifierPattern(stringLiteral: "Test"), "␣Test"),
       #line: (IdentifierPattern("Test"), "␣Test"),
@@ -15,7 +15,8 @@ final class IdentifierPatternTests: XCTestCase {
 
     for (line, testCase) in testCases {
       let (builder, expected) = testCase
-      let syntax = builder.buildSyntax(format: Format(), leadingTrivia: leadingTrivia)
+      let identifierPattern = builder.createIdentifierPattern()
+      let syntax = identifierPattern.buildSyntax(format: Format(), leadingTrivia: leadingTrivia)
 
       var text = ""
       syntax.write(to: &text)