feat: Factories, Container, Thread Safety, Resolvers, & Registration

mcgaryp · mcgaryp · commit f1d764d84f44 · 2025-05-20T21:39:33.000-06:00
diff --git a/Package.swift b/Package.swift
@@ -5,6 +5,9 @@ import PackageDescription
 
 let package = Package(
     name: "Astroject",
+    platforms: [
+        .iOS(.v13)
+    ],
     products: [
         // Products define the executables and libraries a package produces, making them visible to other packages.
         .library(
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# Astroject
+Library for Dependency Injection with Swift concurrency in mind.
+
+## Overview
+Astroject is an advanced dependency injection library designed to help make dependency trees manageable and sufficient from the smallest to the largest scaled software project.
+
+## Features
+- **Thread Safety**
+- **Swift Concurrency**
+- **Ease of Use & Adaptation**
+
diff --git a/Sources/Astroject/.swift b/Sources/Astroject/.swift
@@ -0,0 +1,8 @@
+//
+//  File.swift
+//  Astroject
+//
+//  Created by Porter McGary on 2/25/25.
+//
+
+import Foundation
diff --git a/Sources/Astroject/Astroject.swift b/Sources/Astroject/Astroject.swift
diff --git a/Sources/Astroject/Container.swift b/Sources/Astroject/Container.swift
@@ -0,0 +1,52 @@
+//
+//  Container.swift
+//  Astroject
+//
+//  Created by Porter McGary on 2/25/25.
+//
+
+import Foundation
+
+// ✅ Registration
+// ✅ Resolution
+// TODO: InstanceStore
+
+public class Container {
+    var factories: ThreadSafeDictionary<FactoryKey, any FactoryRegistrable> = .init()
+    
+    public init() {}
+    
+    public func registerAsync<Product>(_ productType: Product.Type, name: String? = nil, factory block: @escaping (Resolver) async -> Product) {
+        let factoryKey = FactoryKey(productType: productType, name: name)
+        let factory = Factory.async(block)
+        let registration = FactoryRegistration(factory: factory)
+        factories.insert(registration, for: factoryKey)
+    }
+    
+    public func register<Product>(_ productType: Product.Type, name: String? = nil, factory block: @escaping (Resolver) -> Product) {
+        let factoryKey = FactoryKey(productType: productType, name: name)
+        let factory = Factory.sync(block)
+        let registration = FactoryRegistration(factory: factory)
+        factories.insert(registration, for: factoryKey)
+    }
+}
+
+extension Container: Resolver {
+    public func resolve<Product>(_ productType: Product.Type, name: String?) -> Product? {
+        let registration = registration(for: productType, with: name)
+        let product = registration?.factory.make(self)
+        return product
+    }
+    
+    public func resolveAsync<Product>(_ productType: Product.Type, name: String?) async -> Product? {
+        let registration = registration(for: productType, with: name)
+        let product = await registration?.factory.makeAsync(self)
+        return product
+    }
+    
+    func registration<Product>(for productType: Product.Type, with name: String?) -> FactoryRegistration<Product>? {
+        let factoryKey = FactoryKey(productType: productType, name: name)
+        let registration = factories.getValue(for: factoryKey) as? FactoryRegistration<Product>
+        return registration
+    }
+}
diff --git a/Sources/Astroject/Factory.swift b/Sources/Astroject/Factory.swift
@@ -0,0 +1,44 @@
+//
+//  Factory.swift
+//  Astroject
+//
+//  Created by Porter McGary on 2/25/25.
+//
+
+import Foundation
+
+enum Factory<Product> {
+    case sync((Resolver) -> Product)
+    case async((Resolver) async -> Product)
+    
+    var isSync: Bool {
+        switch self {
+        case .sync:
+            return true
+        case .async:
+            return false
+        }
+    }
+    
+    var isAsync: Bool {
+        return !isSync
+    }
+    
+    func make(_ resolver: Resolver) -> Product {
+        switch self {
+        case .sync(let closure):
+            closure(resolver)
+        case .async:
+            fatalError("Factory Method is Async. Try calling the async version of this method.")
+        }
+    }
+    
+    func makeAsync(_ resolver: Resolver) async -> Product {
+        switch self {
+        case .sync(let closure):
+            closure(resolver)
+        case .async(let closure):
+            await closure(resolver)
+        }
+    }
+}
diff --git a/Sources/Astroject/FactoryKey.swift b/Sources/Astroject/FactoryKey.swift
@@ -0,0 +1,31 @@
+//
+//  FactoryKey.swift
+//  Astroject
+//
+//  Created by Porter McGary on 2/25/25.
+//
+
+import Foundation
+
+struct FactoryKey {
+    let productType: Any.Type
+    let name: String?
+    
+    init(productType: Any.Type, name: String? = nil) {
+        self.productType = productType
+        self.name = name
+    }
+}
+
+extension FactoryKey: Hashable {
+    func hash(into hasher: inout Hasher) {
+        ObjectIdentifier(self.productType).hash(into: &hasher)
+        self.name?.hash(into: &hasher)
+    }
+}
+
+extension FactoryKey: Equatable {
+    static func == (lhs: FactoryKey, rhs: FactoryKey) -> Bool {
+        lhs.productType == rhs.productType && lhs.name == rhs.name
+    }
+}
diff --git a/Sources/Astroject/FactoryRegistrable.swift b/Sources/Astroject/FactoryRegistrable.swift
@@ -0,0 +1,14 @@
+//
+//  FactoryRegistrable.swift
+//  Astroject
+//
+//  Created by Porter McGary on 2/25/25.
+//
+
+import Foundation
+
+protocol FactoryRegistrable {
+    associatedtype Product
+    
+    var factory: Factory<Product> { get }
+}
diff --git a/Sources/Astroject/FactoryRegistration.swift b/Sources/Astroject/FactoryRegistration.swift
@@ -0,0 +1,16 @@
+//
+//  FactoryRegistration.swift
+//  Astroject
+//
+//  Created by Porter McGary on 2/25/25.
+//
+
+import Foundation
+
+struct FactoryRegistration<Product>: FactoryRegistrable {
+    let factory: Factory<Product>
+    
+    init(factory: Factory<Product>) {
+        self.factory = factory
+    }
+}
diff --git a/Sources/Astroject/Resolver.swift b/Sources/Astroject/Resolver.swift
@@ -0,0 +1,26 @@
+//
+//  Resolver.swift
+//  Astroject
+//
+//  Created by Porter McGary on 2/25/25.
+//
+
+import Foundation
+
+public protocol Resolver {
+    func resolve<Product>(_ productType: Product.Type) -> Product?
+    func resolve<Product>(_ productType: Product.Type, name: String?) -> Product?
+    
+    func resolveAsync<Product>(_ productType: Product.Type) async -> Product?
+    func resolveAsync<Product>(_ productType: Product.Type, name: String?) async -> Product?
+}
+
+public extension Resolver {
+    func resolve<Product>(_ productType: Product.Type) -> Product? {
+        resolve(productType, name: nil)
+    }
+    
+    func resolveAsync<Product>(_ productType: Product.Type) async -> Product? {
+        await resolveAsync(productType, name: nil)
+    }
+}
diff --git a/Sources/Astroject/ThreadSafeDictionary.swift b/Sources/Astroject/ThreadSafeDictionary.swift
@@ -0,0 +1,51 @@
+//
+//  ThreadSafeDictionary.swift
+//  Astroject
+//
+//  Created by Porter McGary on 2/25/25.
+//
+
+import Foundation
+
+class ThreadSafeDictionary<Key: Hashable, Value> {
+    private var queue: DispatchQueue = .init(label: "com.astrobytes.astroject")
+    private var dictionary: [Key: Value]
+    
+    init(from dictionary: [Key: Value]) {
+        self.dictionary = dictionary
+    }
+    
+    convenience init() {
+        self.init(from: [:])
+    }
+    
+    func getValue(for key: Key) -> Value? {
+        queue.sync {
+            dictionary[key]
+        }
+    }
+    
+    func insert(_ value: Value, for key: Key) {
+        queue.sync {
+            dictionary[key] = value
+        }
+    }
+    
+    func forEach(_ block: ((key: Key, value: Value)) -> Void) {
+        queue.sync {
+            dictionary.forEach(block)
+        }
+    }
+    
+    func map<T>(_ transform: ((key:Key, value: Value)) throws -> T) rethrows -> [T] {
+        try queue.sync {
+            try dictionary.map(transform)
+        }
+    }
+    
+    func removeAll() {
+        queue.sync {
+            self.dictionary.removeAll()
+        }
+    }
+}
diff --git a/Tests/AstrojectTests/AstrojectTests.swift b/Tests/AstrojectTests/AstrojectTests.swift
diff --git a/Tests/AstrojectTests/ContainerTests.swift b/Tests/AstrojectTests/ContainerTests.swift
@@ -0,0 +1,63 @@
+import Testing
+@testable import Astroject
+
+@Test func testStructRegistration() async throws {
+    let container = Container()
+    container.register(Animal.self) { resolver in
+        Cat(name: "john")
+    }
+    let key = FactoryKey(productType: Animal.self)
+    let result = container.factories.getValue(for: key) as? FactoryRegistration<Animal>
+    #expect("john" == result?.factory.make(container).name)
+}
+
+@Test func testClassRegistration() async throws {
+    let container = Container()
+    container.register(Animal.self) { resolver in
+        Dog(name: "john")
+    }
+    let key = FactoryKey(productType: Animal.self)
+    let result = container.factories.getValue(for: key) as? FactoryRegistration<Animal>
+    #expect("john" == result?.factory.make(container).name)
+}
+
+@Test func testMultipleRegistration() async throws {
+    let container = Container()
+    container.register(Animal.self) { resolver in
+        Dog(name: "john")
+    }
+    
+    container.register(Animal.self) { resolver in
+        Dog(name: "peter")
+    }
+    
+    let key = FactoryKey(productType: Animal.self)
+    let result = container.factories.getValue(for: key) as? FactoryRegistration<Animal>
+    #expect("peter" == result?.factory.make(container).name)
+}
+
+@Test func testActorRegistration() async throws {
+    let container = Container()
+    container.register(Animal.self) { resolver in
+        Fish(name: "joe")
+    }
+    let key = FactoryKey(productType: Animal.self)
+    let result = container.factories.getValue(for: key) as? FactoryRegistration<Animal>
+    let product = result?.factory.make(container)
+    Task { @MainActor in
+        #expect("joe" == product?.name)
+    }
+}
+
+@Test func testMainActorClassRegistration() async throws {
+    let container = Container()
+    container.registerAsync(Animal.self) { resolver in
+        await Pig(name: "joe")
+    }
+    let key = FactoryKey(productType: Animal.self)
+    let result = container.factories.getValue(for: key) as? FactoryRegistration<Animal>
+    let animal = await result?.factory.makeAsync(container)
+    await MainActor.run {
+        #expect("joe" == animal?.name)
+    }
+}
diff --git a/Tests/AstrojectTests/Models.swift b/Tests/AstrojectTests/Models.swift
