Generate required initializer via FixIt instead of code-generation

dfed · Jul 22, 2024 · e523efc · e523efc
1 parent fbf0df1
commit e523efc
Show file tree

Hide file tree

Showing 16 changed files with 798 additions and 429 deletions.
diff --git a/Examples/ExamplePackageIntegration/Package.resolved b/Examples/ExamplePackageIntegration/Package.resolved
@@ -1,4 +1,5 @@
 {
+  "originHash" : "4828c1967a8becd3449664c8ced8013fc851b1b749c97f36a6b6e17c68977693",
   "pins" : [
     {
       "identity" : "jjliso8601dateformatter",
@@ -30,7 +31,7 @@
     {
       "identity" : "swift-syntax",
       "kind" : "remoteSourceControl",
-      "location" : "https://github.com/apple/swift-syntax.git",
+      "location" : "https://github.com/swiftlang/swift-syntax.git",
       "state" : {
         "revision" : "fa8f95c2d536d6620cc2f504ebe8a6167c9fc2dd",
         "version" : "510.0.1"
@@ -55,5 +56,5 @@
       }
     }
   ],
-  "version" : 2
+  "version" : 3
 }
diff --git a/Examples/ExamplePackageIntegration/Sources/ChildAModule/ChildA.swift b/Examples/ExamplePackageIntegration/Sources/ChildAModule/ChildA.swift
@@ -24,6 +24,11 @@ import SharedModule
 
 @Instantiable
 public final class ChildA: Instantiable {
+    public init(shared: SharedThing, grandchildA: GrandchildA) {
+        self.shared = shared
+        self.grandchildA = grandchildA
+    }
+
     @Received let shared: SharedThing
 
     @Instantiated let grandchildA: GrandchildA

diff --git a/Examples/ExamplePackageIntegration/Sources/ChildBModule/ChildB.swift b/Examples/ExamplePackageIntegration/Sources/ChildBModule/ChildB.swift
@@ -24,6 +24,11 @@ import SharedModule
 
 @Instantiable
 public final class ChildB: Instantiable {
+    public init(shared: SharedThing, grandchildB: GrandchildB) {
+        self.shared = shared
+        self.grandchildB = grandchildB
+    }
+
     @Received let shared: SharedThing
 
     @Instantiated let grandchildB: GrandchildB

diff --git a/Examples/ExamplePackageIntegration/Sources/ChildCModule/ChildC.swift b/Examples/ExamplePackageIntegration/Sources/ChildCModule/ChildC.swift
@@ -24,6 +24,11 @@ import SharedModule
 
 @Instantiable
 public final class ChildC: Instantiable {
+    public init(shared: SharedThing, grandchildC: GrandchildC) {
+        self.shared = shared
+        self.grandchildC = grandchildC
+    }
+
     @Received let shared: SharedThing
 
     @Instantiated let grandchildC: GrandchildC

diff --git a/Examples/ExamplePackageIntegration/Sources/GrandchildrenModule/GrandchildA.swift b/Examples/ExamplePackageIntegration/Sources/GrandchildrenModule/GrandchildA.swift
@@ -23,5 +23,9 @@ import SharedModule
 
 @Instantiable
 public final class GrandchildA: Instantiable {
+    public init(shared: SharedThing) {
+        self.shared = shared
+    }
+
     @Received let shared: SharedThing
 }
diff --git a/Examples/ExamplePackageIntegration/Sources/GrandchildrenModule/GrandchildB.swift b/Examples/ExamplePackageIntegration/Sources/GrandchildrenModule/GrandchildB.swift
@@ -23,5 +23,9 @@ import SharedModule
 
 @Instantiable
 public actor GrandchildB: Instantiable {
+    public init(shared: SharedThing) {
+        self.shared = shared
+    }
+
     @Received let shared: SharedThing
 }
diff --git a/Examples/ExamplePackageIntegration/Sources/GrandchildrenModule/GrandchildC.swift b/Examples/ExamplePackageIntegration/Sources/GrandchildrenModule/GrandchildC.swift
@@ -23,5 +23,9 @@ import SharedModule
 
 @Instantiable
 public struct GrandchildC: Instantiable {
+    public init(shared: SharedThing) {
+        self.shared = shared
+    }
+
     @Received let shared: SharedThing
 }
diff --git a/Examples/ExamplePackageIntegration/Sources/RootModule/Root.swift b/Examples/ExamplePackageIntegration/Sources/RootModule/Root.swift
@@ -27,6 +27,14 @@ import SharedModule
 
 @Instantiable
 public final class Root: Instantiable {
+    public init(childA: ChildA, childB: ChildB, childC: ChildC, shared: SharedThing, userDefaults: UserDefaults) {
+        self.childA = childA
+        self.childB = childB
+        self.childC = childC
+        self.shared = shared
+        self.userDefaults = userDefaults
+    }
+
     static let shared = Root()
 
     @Instantiated let childA: ChildA

diff --git a/Examples/ExamplePackageIntegration/Sources/SharedModule/SharedThing.swift b/Examples/ExamplePackageIntegration/Sources/SharedModule/SharedThing.swift
@@ -21,4 +21,6 @@
 import SafeDI
 
 @Instantiable
-public final class SharedThing: Instantiable {}
+public final class SharedThing: Instantiable {
+    public init() {}
+}
diff --git a/README.md b/README.md
@@ -382,7 +382,7 @@ To install the SafeDI framework into your package with [Swift Package Manager](h
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/dfed/SafeDI", from: "0.7.0"),
+    .package(url: "https://github.com/dfed/SafeDI", from: "0.8.0"),
 ]
 ```
 

diff --git a/Sources/SafeDICore/Errors/FixableInstantiableError.swift b/Sources/SafeDICore/Errors/FixableInstantiableError.swift
@@ -31,7 +31,13 @@ public enum FixableInstantiableError: DiagnosticError {
     case dependencyHasTooManyAttributes
     case dependencyHasInitializer
     case missingPublicOrOpenAttribute
-    case missingRequiredInitializer(hasInjectableProperties: Bool)
+    case missingRequiredInitializer(MissingInitializer)
+
+    public enum MissingInitializer {
+        case hasOnlyInjectableProperties
+        case hasInjectableAndNotInjectableProperties
+        case hasNoInjectableProperties
+    }
 
     public var description: String {
         switch self {
@@ -55,10 +61,13 @@ public enum FixableInstantiableError: DiagnosticError {
             "Dependency must not have hand-written initializer"
         case .missingPublicOrOpenAttribute:
             "@\(InstantiableVisitor.macroName)-decorated type must be `public` or `open`"
-        case let .missingRequiredInitializer(hasInjectableProperties):
-            if hasInjectableProperties {
+        case let .missingRequiredInitializer(missingInitializer):
+            switch missingInitializer {
+            case .hasOnlyInjectableProperties:
+                "@\(InstantiableVisitor.macroName)-decorated type must have a `public` or `open` initializer with a parameter for each @\(Dependency.Source.instantiatedRawValue), @\(Dependency.Source.receivedRawValue), or @\(Dependency.Source.forwardedRawValue)-decorated property."
+            case .hasInjectableAndNotInjectableProperties:
                 "@\(InstantiableVisitor.macroName)-decorated type must have a `public` or `open` initializer with a parameter for each @\(Dependency.Source.instantiatedRawValue), @\(Dependency.Source.receivedRawValue), or @\(Dependency.Source.forwardedRawValue)-decorated property. Parameters in this initializer that do not correspond to a decorated property must have default values."
-            } else {
+            case .hasNoInjectableProperties:
                 "@\(InstantiableVisitor.macroName)-decorated type with no @\(Dependency.Source.instantiatedRawValue), @\(Dependency.Source.receivedRawValue), or @\(Dependency.Source.forwardedRawValue)-decorated properties must have a `public` or `open` initializer that either takes no parameters or has a default value for each parameter."
             }
         }

diff --git a/Sources/SafeDICore/Models/Initializer.swift b/Sources/SafeDICore/Models/Initializer.swift
@@ -155,7 +155,10 @@ public struct Initializer: Codable, Hashable, Sendable {
                                 leadingTrivia: .space,
                                 trailingTrivia: .space
                             ),
-                            rightOperand: DeclReferenceExprSyntax(baseName: TokenSyntax.identifier(dependency.property.label))
+                            rightOperand: DeclReferenceExprSyntax(
+                                baseName: TokenSyntax.identifier(dependency.property.label),
+                                trailingTrivia: dependency == dependencies.last ? .newline : nil
+                            )
                         )))
                     )
                 }

diff --git a/Sources/SafeDICore/Models/Property.swift b/Sources/SafeDICore/Models/Property.swift
@@ -83,7 +83,10 @@ public struct Property: Codable, Hashable, Comparable, Sendable {
                         ))
                         if let attributes {
                             for attribute in attributes {
-                                AttributeSyntax(attributeName: IdentifierTypeSyntax(name: .identifier(attribute)))
+                                AttributeSyntax(
+                                    attributeName: IdentifierTypeSyntax(name: .identifier(attribute)),
+                                    trailingTrivia: .space
+                                )
                             }
                         }
                     },

diff --git a/Sources/SafeDICore/Visitors/InstantiableVisitor.swift b/Sources/SafeDICore/Visitors/InstantiableVisitor.swift
@@ -33,14 +33,14 @@ public final class InstantiableVisitor: SyntaxVisitor {
 
     public override func visit(_ node: VariableDeclSyntax) -> SyntaxVisitorContinueKind {
         guard
-            declarationType.isTypeDefinition
-            && node.modifiers.staticModifier == nil
+            declarationType.isTypeDefinition,
+            node.modifiers.staticModifier == nil
         else {
             return .skipChildren
         }
         // Check attributes and extract dependency source.
         let dependencySources = node.attributes.dependencySources
-        guard dependencySources.isEmpty || dependencySources.count == 1 else {
+        if dependencySources.count > 1 {
             diagnostics.append(Diagnostic(
                 node: node.attributes,
                 error: FixableInstantiableError.dependencyHasTooManyAttributes,
@@ -51,7 +51,6 @@ public final class InstantiableVisitor: SyntaxVisitor {
                     ),
                 ]
             ))
-            return .skipChildren
         }
         guard let dependencySource = dependencySources.first?.source else {
             // This dependency is not part of the DI system.

diff --git a/Sources/SafeDIMacros/Macros/InstantiableMacro.swift b/Sources/SafeDIMacros/Macros/InstantiableMacro.swift
@@ -106,20 +106,29 @@ public struct InstantiableMacro: MemberMacro {
                 .contains(where: { $0.isValid(forFulfilling: visitor.dependencies) })
             guard hasMemberwiseInitializerForInjectableProperties else {
                 if visitor.uninitializedNonOptionalPropertyNames.isEmpty {
-                    var initializer = Initializer.generateRequiredInitializer(
-                        for: visitor.dependencies,
-                        declarationType: concreteDeclaration.declType
+                    var membersWithInitializer = declaration.memberBlock.members
+                    membersWithInitializer.insert(
+                        MemberBlockItemSyntax(
+                            leadingTrivia: .newline,
+                            decl: Initializer.generateRequiredInitializer(
+                                for: visitor.dependencies,
+                                declarationType: concreteDeclaration.declType
+                            ),
+                            trailingTrivia: .newline
+                        ),
+                        at: membersWithInitializer.startIndex
                     )
-                    initializer.leadingTrivia = Trivia(stringLiteral: """
-                    // A generated initializer that has one argument per SafeDI-injected property.
-                    // Because this initializer is generated by a Swift Macro, it can not be used by other Swift Macros.
-                    // As a result, this initializer can not be used within a #Preview macro closure.
-                    // This initializer is generated only because you have not written an appropriate initializer yourself.
-                    // Copy/pasting this generated initializer into your code will enable this initializer to be used within other Swift Macros.
-
-                    """)
-                    return [DeclSyntax(initializer)]
-                        + generateForwardedProperties(from: forwardedProperties)
+                    context.diagnose(Diagnostic(
+                        node: Syntax(declaration.memberBlock),
+                        error: FixableInstantiableError.missingRequiredInitializer(.hasOnlyInjectableProperties),
+                        changes: [
+                            .replace(
+                                oldNode: Syntax(declaration.memberBlock.members),
+                                newNode: Syntax(membersWithInitializer)
+                            ),
+                        ]
+                    ))
+                    return []
                 } else {
                     var membersWithInitializer = declaration.memberBlock.members
                     membersWithInitializer.insert(
@@ -137,7 +146,9 @@ public struct InstantiableMacro: MemberMacro {
                     // TODO: Create separate fixit if just `public` or `open` are missing.
                     context.diagnose(Diagnostic(
                         node: Syntax(declaration.memberBlock),
-                        error: FixableInstantiableError.missingRequiredInitializer(hasInjectableProperties: !visitor.dependencies.isEmpty),
+                        error: FixableInstantiableError.missingRequiredInitializer(
+                            visitor.dependencies.isEmpty ? .hasNoInjectableProperties : .hasInjectableAndNotInjectableProperties
+                        ),
                         changes: [
                             .replace(
                                 oldNode: Syntax(declaration.memberBlock.members),