Swift 6

Author: shackley

.github/workflows/blade.yml

@@ -15,14 +15,14 @@ concurrency:
 
 jobs:
   docc:
-    runs-on: macos-13
+    runs-on: macos-14
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Xcode Select
-        run: sudo xcode-select -s /Applications/Xcode_15.0.app
+        run: sudo xcode-select -s /Applications/Xcode_16.2.app
       - name: Build Docs
         run: swift package --allow-writing-to-directory .docs generate-documentation --target Blade --disable-indexing --transform-for-static-hosting --hosting-base-path "/swift-blade" --output-path .docs
       - name: Upload Pages Artifact
@@ -34,14 +34,14 @@ jobs:
         uses: actions/deploy-pages@v2
 
   test-mac:
-    runs-on: macos-13
+    runs-on: macos-14
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Xcode Select
-        run: sudo xcode-select -s /Applications/Xcode_15.0.app
+        run: sudo xcode-select -s /Applications/Xcode_16.2.app
       - name: Run Tests
         run: swift test
 

Package.resolved

@@ -1,4 +1,5 @@
 {
+  "originHash" : "b3761ba17478a3fdba923bf12ebdb4f8812fa881214f83bbd2515e8cc2b97238",
   "pins" : [
     {
       "identity" : "swift-docc-plugin",
@@ -23,10 +24,10 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/apple/swift-syntax.git",
       "state" : {
-        "revision" : "74203046135342e4a4a627476dd6caf8b28fe11b",
-        "version" : "509.0.0"
+        "revision" : "1103c45ece4f7fe160b8f75b4ea1ee2e5fac1841",
+        "version" : "601.0.0"
       }
     }
   ],
-  "version" : 2
+  "version" : 3
 }

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 5.9
+// swift-tools-version: 6.0
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -18,7 +18,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
-        .package(url: "https://github.com/apple/swift-syntax.git", from: "509.0.0"),
+        .package(url: "https://github.com/apple/swift-syntax.git", from: "601.0.0"),
     ],
     targets: [
         .target(

README.md

@@ -75,19 +75,16 @@ In order to do so, swift-blade must be told how to obtain instances of each type
 
 Let's go back in and add the `@Provider` attribute to the initializers of our classes so that swift-blade knows how to obtain instances of them.”
 
-> [!NOTE]
-> An initializer-based `@Provider` must have its return type specified via the `@Provider` attribute's `of` parameter.
-
 ```swift
 class ElectricHeater: Heater {
-    @Provider(of: ElectricHeater.self)
+    @Provider
     init() {}
 }
 
 class Thermosiphon: Pump {
     private let heater: Heater
 
-    @Provider(of: Thermosiphon.self)
+    @Provider
     init(heater: Heater) {
         self.heater = heater
     }
@@ -97,7 +94,7 @@ class CoffeeMaker {
     private let heater: Heater
     private let pump: Pump
 
-    @Provider(of: CoffeeMaker.self)
+    @Provider
     init(heater: Heater, pump: Pump) {
         self.heater = heater
         self.pump = pump
@@ -193,7 +190,3 @@ See [API Documentation](https://shackley.io/swift-blade/documentation/blade/) fo
 **Q: How is the dependency graph validated?**
 
 Unlike Dagger, a Blade component's dependency graph is validated at runtime immediately upon component initialization. If a dependency does not have a registered provider, a `fatalError` will occur. This is largely due to the fact that the current [macro](https://docs.swift.org/swift-book/documentation/the-swift-programming-language/macros/) implementation does not have context APIs that allow a macro to glean semantic information about types found in a delcaration at the time of expansion. If such an APIs were to be added, this validation could potentially occurr at compile time.
-
-**Q: Why do `@Provider`s attached to initializers have to specify their provided type?**
-
-Currently, swift macros are not provided with any lexical scope information at the time of expansion, so it isn't possible for a `@Provider` macro to know which type the initializer belongs to otherwise.

Sources/Blade/Blade.docc/Pages/AdvancedUsage/InstanceBinding.md

@@ -24,7 +24,7 @@ The values passed into the initializer can then be automatically provided as dep
 class CoffeeMaker {
     private let configuration: Configuration
 
-    @Provider(of: CoffeeMaker.self)
+    @Provider
     init(configuration: Configuration) {
         self.configuration = configuration
     }

Sources/Blade/Blade.docc/Pages/AdvancedUsage/LazyDependencies.md

@@ -14,7 +14,7 @@ Any dependency of type `T` can be substituted with a `Lazy<T>`. The object won't
 class GrindingCoffeeMaker {
     private let grinder: Lazy<Grinder>
 
-    @Provider(of: GrindingCoffeeMaker.self)
+    @Provider
     init(grinder: Lazy<Grinder>) {
         self.grinder = grinder
     }

Sources/Blade/Blade.docc/Pages/AdvancedUsage/NamedDependencies.md

@@ -13,7 +13,7 @@ class DualBoilerCoffeeMaker {
     private let waterHeater: Heater
     private let milkHeater: Heater
 
-    @Provider(of: DualBoilerCoffeeMaker.self)
+    @Provider
     init(
         @Named("water") waterHeater: Heater,
         @Named("milk") milkHeater: Heater

Sources/Blade/Blade.docc/Pages/Basics/Providers.md

@@ -16,13 +16,11 @@ Adding the `@Provider` attribute to an initializer will allow swift-blade to pro
 
 The parameters of the type's initializer are its dependencies. When a new instance of that type is needed, swift-blade will obtain instances of all of its dependencies and invoke its initializer.
 
-> An initializer-based `@Provider` must have its return type specified via the `@Provider` attribute's `of` parameter.
-
 ```swift
 class Thermosiphon: Pump {
     private let heater: Heater
 
-    @Provider(of: Thermosiphon.self)
+    @Provider
     init(heater: Heater) {
         self.heater = heater
     }
@@ -59,4 +57,4 @@ This pattern is commonly used to alias a concrete type to a protocol that it con
 
 ## Topics
 
-- ``Provider(of:scope:named:)``
+- ``Provider(scope:named:)``

Sources/Blade/Provider.swift

@@ -7,7 +7,7 @@
 /// When an instance of a specific type is required, the provider function that matches that type will be invoked to obtain one.
 ///
 /// - Parameters:
-///   - of: Specifies the type that is being provided. This parameter is only necessary for initializer-based providers.
+///   - of: This parameter is deprecated and will be removed in future versions of swift-blade.
 ///   - scope: Defines the lifecycle of a provided instance.
 ///   - named: Used to distinguish between multiple provider functions that return the same type.
 @attached(peer, names: named(_$BladeDependencyProvider))

Sources/BladePlugin/Diagnostics/BladeDiagnosticMessage.swift

@@ -83,12 +83,6 @@ extension BladeDiagnosticMessage {
         severity: .error
     )
 
-    static let missingProviderInitializerReturnType = BladeDiagnosticMessage(
-        message: "An initializer-based @Provider must have its provided type specified via the @Provider attributes `of` parameter",
-        id: "missing_provider_initializer_return_type",
-        severity: .error
-    )
-
     static let missingProviderFunctionReturnType = BladeDiagnosticMessage(
         message: "@Provider functions must return a non-Void type",
         id: "missing_provider_function_binding_return_type",
@@ -107,8 +101,14 @@ extension BladeDiagnosticMessage {
         severity: .error
     )
 
+    static let unknownProviderReturnType = BladeDiagnosticMessage(
+        message: "Unable to determine return type for initializer-based @Provider",
+        id: "unknown_provider_return_type",
+        severity: .error
+    )
+
     static let unnecessaryProviderFunctionReturnType = BladeDiagnosticMessage(
-        message: "Specifying the provided type is only necessary for initializer-based @Providers",
+        message: "Specifying the provided type is no longer necessary. The `of` parameter will be removed in future versions of swift-blade.",
         id: "unnecessary_provider_function_binding_return_type",
         severity: .warning
     )

Sources/BladePlugin/Macros/ProviderMacro.swift

@@ -26,10 +26,21 @@ public struct ProviderMacro: PeerMacro {
             context: context
         )
 
-        guard let returnType = attribute.returnType else {
+        if attribute.returnType != nil {
             context.diagnose(
                 node: node,
-                message: .missingProviderInitializerReturnType
+                message: .unnecessaryProviderFunctionReturnType
+            )
+        }
+
+        let providerContext = ProviderContextParser.parse(
+            lexicalContext: context.lexicalContext
+        )
+
+        guard let returnType = providerContext.type else {
+            context.diagnose(
+                node: node,
+                message: .unknownProviderReturnType
             )
             return []
         }

Sources/BladePlugin/Models/ProviderContext.swift

@@ -0,0 +1,3 @@
+struct ProviderContext {
+    let type: String?
+}

Sources/BladePlugin/SyntaxParsers/ProviderContextParser.swift

@@ -0,0 +1,26 @@
+import Foundation
+import SwiftSyntax
+import SwiftSyntaxMacros
+
+enum ProviderContextParser {
+    static func parse(
+        lexicalContext: [Syntax]
+    ) -> ProviderContext {
+        let type: String? = {
+            for syntax in lexicalContext {
+                if let classDecl = syntax.as(ClassDeclSyntax.self) {
+                    return classDecl.name.text
+                } else if let structDecl = syntax.as(StructDeclSyntax.self) {
+                    return structDecl.name.text
+                } else if let enumDecl = syntax.as(EnumDeclSyntax.self) {
+                    return enumDecl.name.text
+                }
+            }
+            return nil
+        }()
+
+        return ProviderContext(
+            type: type
+        )
+    }
+}

Tests/BladeTests/BladeTests.swift

@@ -12,12 +12,12 @@ public struct Config {
 }
 
 public class FooImpl: Foo {
-    public static var initializations: Int = 0
+    nonisolated(unsafe) public static var initializations: Int = 0
     private let config: Config
     private let key1: String
     private let key2: String
 
-    @Provider(of: FooImpl.self)
+    @Provider
     public init(
         config: Config,
         @Named("key1") key1: String,
@@ -31,21 +31,21 @@ public class FooImpl: Foo {
 }
 
 public class BarImpl: Bar {
-    public static var initializations: Int = 0
+    nonisolated(unsafe) public static var initializations: Int = 0
     private let foo: Lazy<Foo>
 
-    @Provider(of: BarImpl.self)
+    @Provider
     public init(foo: Lazy<Foo>) {
         self.foo = foo
         Self.initializations += 1
     }
 }
 
 public class BazImpl: Baz {
-    public static var initializations: Int = 0
+    nonisolated(unsafe) public static var initializations: Int = 0
     private let foo: Foo
 
-    @Provider(of: BazImpl.self, scope: .singleton)
+    @Provider(scope: .singleton)
     public init(foo: Foo) {
         self.foo = foo
         Self.initializations += 1
@@ -61,7 +61,7 @@ struct B {
 }
 
 struct C {
-    @Provider(of: C.self)
+    @Provider
     init() {}
 }
 
@@ -72,11 +72,11 @@ struct ABC {
 }
 
 public class Alphabet {
-    public static var initializations: Int = 0
+    nonisolated(unsafe) public static var initializations: Int = 0
     private let abc: ABC
     private let key1: String
 
-    @Provider(of: Alphabet.self, scope: .singleton)
+    @Provider(scope: .singleton)
     init(abc: ABC, @Named("key1") key1: String) {
         self.abc = abc
         self.key1 = key1