Merge pull request #23 from strvcom/feat/swift-testing

Feat: Swift Testing framework (2/3)

Author: DanielCech

CHANGELOG.md

@@ -17,6 +17,7 @@ __Sections__
 
 - Support for multiple arguments. Code clean up.
 - Using parameter packs for multiple arguments
+- Tests are converted to the new Swift Testing framework
 
 ## [1.0.4]
 

README.md

@@ -100,7 +100,7 @@ container.register { container in
 In the factory closure, we typically just call the dependency initializer and we resolve its input parameters from the container. You can get rid of this duplicated boiler-plate by using `autoregister` method where you specify just the initializer that should be used to initialize the dependency, instead of writing the same factories over and over again. The above example then looks like this:
 ```swift
 let container = Container()
-container.autoregister(initializer: Dependency.init)
+container.autoregister(in: .shared, initializer: Dependency.init)
 ```
 Similarly, we can use autoregistration with an argument and replace this:
 ```swift
@@ -166,7 +166,7 @@ class Singletons {
   static let container = Container()
 
   static func configure() {
-    container.autoregister(initializer: Dependency.init)
+    container.autoregister(in: .shared, initializer: Dependency.init)
   }
 }
 
@@ -183,7 +183,7 @@ class Object {
 When using the `@Injected` property wrapper, the dependency is resolved right in the moment when the property is instantiated. If you prefer to resolve the dependency only when it is accessed for the first time, you should rather use `@LazyInjected`:
 ```swift
 let container = Container()
-container.autoregister(initializer: Dependency.init)
+container.autoregister(in: .shared, initializer: Dependency.init)
 
 class Object {
   @LazyInjected(from: container) var dependency: Dependency

Sources/Container/Async/AsyncContainer.swift

@@ -99,6 +99,12 @@ public actor AsyncContainer: AsyncDependencyResolving, AsyncDependencyRegisterin
     public func tryResolve<Dependency: Sendable, each Argument: Sendable>(type: Dependency.Type, arguments: repeat each Argument) async throws -> Dependency {
         let identifier = RegistrationIdentifier(type: type, argumentTypes: repeat (each Argument).self)
 
+        if identifier.argumentCount > RegistrationIdentifierConstant.maximumArgumentCount {
+            throw ResolutionError.tooManyArguments(
+                message: "Maximum number of arguments is \(RegistrationIdentifierConstant.maximumArgumentCount). Got \(identifier.argumentCount)."
+            )
+        }
+
         let registration = try getRegistration(with: identifier)
 
         // Pack arguments into a tuple for storage - this matches how AsyncRegistration expects them

Sources/Container/Sync/Container.swift

@@ -95,6 +95,12 @@ open class Container: DependencyAutoregistering, DependencyResolving, Dependency
     open func tryResolve<Dependency, each Argument>(type: Dependency.Type, arguments: repeat each Argument) throws -> Dependency {
         let identifier = RegistrationIdentifier(type: type, argumentTypes: repeat (each Argument).self)
 
+        if identifier.argumentCount > RegistrationIdentifierConstant.maximumArgumentCount {
+            throw ResolutionError.tooManyArguments(
+                message: "Maximum number of arguments is \(RegistrationIdentifierConstant.maximumArgumentCount). Got \(identifier.argumentCount)."
+            )
+        }
+
         let registration = try getRegistration(with: identifier)
 
         // Pack arguments into a tuple for storage - this matches how Registration expects them

Sources/Models/RegistrationIdentifier.swift

@@ -7,8 +7,8 @@
 
 import Foundation
 
-/// Maximum number of arguments supported for dependency resolution
-private enum Constant {
+/// Maximum number of arguments supported for dependency resolution (enforced at resolve time)
+enum RegistrationIdentifierConstant {
     static let maximumArgumentCount = 3
 }
 
@@ -17,7 +17,11 @@ struct RegistrationIdentifier: Sendable {
     let typeIdentifier: ObjectIdentifier
     let argumentIdentifiers: [ObjectIdentifier]
 
-    /// Initializer using parameter packs for any number of argument types
+    /// Number of argument types (used to enforce maximum at resolve time)
+    var argumentCount: Int { argumentIdentifiers.count }
+
+    /// Initializer using parameter packs for any number of argument types.
+    /// Registration with more than 3 arguments is allowed; resolution with more than 3 arguments will throw.
     ///
     /// - Parameters:
     ///   - type: Type of the dependency
@@ -28,11 +32,6 @@ struct RegistrationIdentifier: Sendable {
         var identifiers: [ObjectIdentifier] = []
         repeat identifiers.append(ObjectIdentifier((each Argument).self))
 
-        precondition(
-            identifiers.count <= Constant.maximumArgumentCount,
-            "Maximum number of arguments is \(Constant.maximumArgumentCount). Got \(identifiers.count)."
-        )
-
         argumentIdentifiers = identifiers
     }
 

Sources/Models/ResolutionError.swift

@@ -15,12 +15,17 @@ public enum ResolutionError: Error {
     /// The dependency with the required type is registered within the container but the factory closure expects a different argument type
     case unmatchingArgumentType(message: String)
 
+    /// More than the maximum supported number of arguments (3) was passed to resolve
+    case tooManyArguments(message: String)
+
     public var localizedDescription: String {
         switch self {
         case let .dependencyNotRegistered(message):
             return "Dependency not registered: \(message)"
         case let .unmatchingArgumentType(message):
             return "Unmatching argument type: \(message)"
+        case let .tooManyArguments(message):
+            return "Too many arguments: \(message)"
         }
     }
 }

Sources/Protocols/Registration/Async/AsyncDependencyRegistering.swift

@@ -38,13 +38,6 @@ public protocol AsyncDependencyRegistering {
 
 // MARK: Overloaded factory methods
 public extension AsyncDependencyRegistering {
-    /// Default ``DependencyScope`` value
-    ///
-    /// The default value is `shared`
-    static var defaultScope: DependencyScope {
-        DependencyScope.shared
-    }
-
     /// Register a dependency with an implicit type determined by the factory closure return type
     ///
     /// - Parameters:

Sources/Protocols/Registration/Sync/DependencyAutoregistering.swift

@@ -148,11 +148,11 @@ public extension DependencyAutoregistering {
     ///
     /// - Parameters:
     ///   - type: Type of the dependency to register. Default value is implicitly inferred from the initializer return type
-    ///   - scope: Scope of the dependency. If `.new` is used, the initializer is called on each `resolve` call. If `.shared` is used, the initializer is called only the first time, the instance is cached and it is returned for all subsequent `resolve` calls, i.e. it is a singleton. The default value is `.shared`
+    ///   - scope: Scope of the dependency. If `.new` is used, the initializer is called on each `resolve` call. If `.shared` is used, the initializer is called only the first time, the instance is cached and it is returned for all subsequent `resolve` calls, i.e. it is a singleton
     ///   - initializer: Initializer method of the `Dependency` that should be used to instantiate the dependency when it is being resolved from the container
     func autoregister<Dependency, each Parameter>(
         type: Dependency.Type = Dependency.self,
-        in scope: DependencyScope = Self.defaultScope,
+        in scope: DependencyScope,
         initializer: @escaping (repeat each Parameter) -> Dependency
     ) {
         let factory: Factory<Dependency> = { resolver in

Sources/Protocols/Registration/Sync/DependencyRegistering.swift

@@ -38,13 +38,6 @@ public protocol DependencyRegistering {
 
 // MARK: Overloaded factory methods
 public extension DependencyRegistering {
-    /// Default ``DependencyScope`` value
-    ///
-    /// The default value is `shared`
-    static var defaultScope: DependencyScope {
-        DependencyScope.shared
-    }
-
     /// Register a dependency with an implicit type determined by the factory closure return type
     ///
     /// - Parameters: