Added forced brackets for optional existential and opaque types

krzysztofzablocki · Dec 14, 2023 · 50ff6e7 · 50ff6e7
1 parent cca37ec
commit 50ff6e7
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 2 deletions.
diff --git a/SourceryFramework/Sources/Parsing/SwiftSyntax/AST/TypeName+SwiftSyntax.swift b/SourceryFramework/Sources/Parsing/SwiftSyntax/AST/TypeName+SwiftSyntax.swift
@@ -64,7 +64,12 @@ extension TypeName {
             self.init(name: name, isProtocolComposition: true)
         } else if let typeIdentifier = node.as(OptionalTypeSyntax.self) {
             let type = TypeName(typeIdentifier.wrappedType)
-            let needsWrapping = type.isClosure || type.isProtocolComposition
+            let needsWrapping = [
+                type.isClosure,
+                type.isProtocolComposition,
+                type.isExistential,
+                type.isOpaque,
+            ].contains(true)
             self.init(name: needsWrapping ? "(\(type.asSource))" : type.name,
                       isOptional: true,
                       isImplicitlyUnwrappedOptional: false,
@@ -77,7 +82,12 @@ extension TypeName {
             )
         } else if let typeIdentifier = node.as(ImplicitlyUnwrappedOptionalTypeSyntax.self) {
             let type = TypeName(typeIdentifier.wrappedType)
-            let needsWrapping = type.isClosure || type.isProtocolComposition
+            let needsWrapping = [
+                type.isClosure,
+                type.isProtocolComposition,
+                type.isExistential,
+                type.isOpaque,
+            ].contains(true)
             self.init(name: needsWrapping ? "(\(type.asSource))" : type.name,
                       isOptional: false,
                       isImplicitlyUnwrappedOptional: true,

diff --git a/SourceryRuntime/Sources/AST/TypeName/TypeName.swift b/SourceryRuntime/Sources/AST/TypeName/TypeName.swift
@@ -95,6 +95,18 @@ public final class TypeName: NSObject, SourceryModelWithoutDescription, Lossless
         return name == "Void" || name == "()" || unwrappedTypeName == "Void"
     }
 
+    // sourcery: skipEquality
+    /// Whether type is existential type (`any FooBar`)
+    public var isExistential: Bool {
+        return name.hasPrefix("any")
+    }
+
+    // sourcery: skipEquality
+    /// Whether type is opaque type (`some FooBar`)
+    public var isOpaque: Bool {
+        return name.hasPrefix("some")
+    }
+
     /// Whether type is a tuple
     public var isTuple: Bool {
         actualTypeName?.tuple != nil || tuple != nil

diff --git a/SourceryTests/Parsing/FileParser_TypeNameSpec.swift b/SourceryTests/Parsing/FileParser_TypeNameSpec.swift
@@ -187,6 +187,33 @@ class TypeNameSpec: QuickSpec {
                     expect(typeName("(@MainActor @Sendable (Int) -> Void)!").name).to(equal("(@MainActor @Sendable (Int) -> Void)!"))
                 }
             }
+
+            context("given optional opaque type") {
+                it("unwrappedTypeName keeps brackets") {
+                    expect(typeName("(some FooBar)?").unwrappedTypeName).to(equal("(some FooBar)"))
+                }
+                it("name keeps brackets") {
+                    expect(typeName("(some FooBar)?").name).to(equal("(some FooBar)?"))
+                }
+            }
+
+            context("given implicitly unwrapped optional opaque type") {
+                it("unwrappedTypeName keeps brackets") {
+                    expect(typeName("(some FooBar)!").unwrappedTypeName).to(equal("(some FooBar)"))
+                }
+                it("name keeps brackets") {
+                    expect(typeName("(some FooBar)!").name).to(equal("(some FooBar)!"))
+                }
+            }
+
+            context("given implicitly unwrapped optional existential type") {
+                it("unwrappedTypeName keeps brackets") {
+                    expect(typeName("(any FooBar)!").unwrappedTypeName).to(equal("(any FooBar)"))
+                }
+                it("name keeps brackets") {
+                    expect(typeName("(any FooBar)!").name).to(equal("(any FooBar)!"))
+                }
+            }
         }
     }
 }