[WIP] Revamping Library Interface and Resolving Design Mistakes. (v1.1.0) (#8)

Author: MaximBazarov

.swiftpm/xcode/package.xcworkspace/xcshareddata/IDETemplateMacros.plist

@@ -3,8 +3,7 @@
 <plist version="1.0">
 <dict>
     <key>FILEHEADER</key>
-    <string>
-//===----------------------------------------------------------------------===//
+    <string>===----------------------------------------------------------------------===//
 //
 // This source file is part of the Inject package open source project
 //
@@ -16,7 +15,6 @@
 //
 // SPDX-License-Identifier: MIT
 //
-//===----------------------------------------------------------------------===//
-//</string>
+//===----------------------------------------------------------------------===//</string>
 </dict>
 </plist>

Sources/Inject.docc/Inject.md renamed to Inject.docc/Inject.md

@@ -33,7 +33,7 @@ let package = Package(
             name: "Inject", dependencies: [], path: "Sources"
         ),
         .testTarget(
-            name: "Inject-Tests", dependencies: ["Inject"], path: "Tests"
-        )
+            name: "Tests", dependencies: ["Inject"], path: "Tests"
+        ),
     ]
 )

Package.swift

@@ -14,48 +14,8 @@
 
 import Foundation
 
-/// Provides an interface to extend with computed properties.
-/// Each computed property provides a name to reference in ``Injected``
-/// and a type for enclosed ``Dependency``.
-/// ```swift
-/// extension DefaultValues {
-///     var testService: TestServiceInterface { TestService() }
-/// }
-/// ```
-///> Warning:
-/// **Never use the @Injected inside another @Injected**
-/// it will create a cycle and your application will hang and
-/// then possibly killed by the system.
-/// ```swift
-/// var auth: Auth {
-///     @Injected(\.network) var network // DON'T
-///     Auth(network: network.instance)
-/// }
-///
-/// var network: Networking {
-///     @Injected(\.auth) var auth // DON'T
-///     Networking(auth: auth.instance)
-/// }
-/// ```
-/// Instead, move the dependency from the initializer into the injected property.
-/// ```swift
-/// final class Networking {
-///   @Injected(\.auth) var auth
-/// }
-///
-/// final class Auth {
-///   @Injected(\.network) var network
-/// }
-/// ```
-/// now you can remove them from initializer and can safely resolve this cross dependency.
-/// ```swift
-/// extension DefaultValues {
-///     var auth: Auth { Auth() }
-///     var network: Networking { Networking() }
-/// }
-/// ```
-@MainActor
-public final class DefaultValues {
+@available(*, deprecated, message: "Inject doesn't use DefaultValues any more, please refer to Readme.")
+@MainActor public final class DefaultValues {
     public typealias KeyPath<Value> = Swift.KeyPath<DefaultValues, Value>
 
     private static let shared = DefaultValues()

Sources/DefaultValues.swift renamed to Sources/Deprecating/DefaultValues.swift

@@ -15,6 +15,7 @@
 import Foundation
 
 // MARK: - Public interface
+@available(*, deprecated, message: "Inject doesn't use Dependency<Value> any more, please refer to Readme.")
 extension Dependency {
     /// An instance of the dependency.
     public var instance: Value {
@@ -28,65 +29,8 @@ extension Dependency {
     }
 }
 
-// MARK: - Dependency<Value>
-/// A type that represents a dependency with given ``Scope`` and ``Lifespan``.
-///
-/// When you use
-/// ```swift
-/// final class MyAwesomeComponent: Injectable {
-///     @Injected(\.someServiceKey, .temporary, .local) var service
-/// }
-/// ```
-/// `service` variable is of type ``Dependency``.
-/// The instance itself, using ``Dependency/instance``
-/// is of type `someServiceKey` in ``DefaultValues`` is e.g.
-/// `SomeServiceInterface` protocol.
-///
-/// ``Injectable`` marks the class to tell the compiler
-/// it has ``Injectable/injecting(_:for:)`` function.
-///
-/// ## Scope and Lifespan configuration
-///
-/// **`.temporary`** is the configuration of the ``Lifespan`` meaning
-/// we don't want to hold the instance of this service once we are done.
-///
-/// **`.local`** is the ``Scope`` of the injection,
-/// which means we want our personal instance to be provided,
-/// not the one that is shared with others.
-///
-/// _You can omit both `.temporary` and `.local` since these are_
-/// _the default values for the configuration._
-/// ```swift
-/// final class MyAwesomeComponent: Injectable {
-///     @Injected(\.someServiceKey) var service
-/// }
-/// ```
-///
-/// Now you can access your instance using the ``Dependency/instance`` computed property.
-/// ```swift
-/// func do() {
-///     service.instance.doWork()
-/// }
-/// ```
-///
-/// ## Injecting
-/// To inject another than production instance in your tests or previews
-/// or anywhere else:
-/// ```swift
-/// let component = MyAwesomeComponent()
-///    .injecting(
-///        SomeMock(), // injected instance
-///        for: \.service
-///    )
-/// // component.service.instance is the injected instance that we provided.
-/// ```
-///
-/// Note that we use the `KeyPath` to the variable in `MyAwesomeComponent` and
-/// not in the ``DefaultValues`` that's because we want to inject only
-/// for `MyAwesomeComponent` without affecting other consumers of the service.
-///
-@MainActor
-public final class Dependency<Value> {
+@available(*, deprecated, message: "Inject doesn't use Dependency<Value> any more, please refer to Readme.")
+@MainActor public final class Dependency<Value> {
     typealias StorageKeyPath = DefaultValues.KeyPath<Value>
 
     private let storageKeyPath: StorageKeyPath

Sources/Dependency.swift renamed to Sources/Deprecating/Dependency.swift

@@ -13,17 +13,12 @@
 //===----------------------------------------------------------------------===//
 import Foundation
 
-/// Adds ``injecting(_:for:)`` to enable ``Dependency`` overriding.
+@available(*, deprecated, message: "This api isn't available, please refer to Readme.")
 public protocol Injectable {}
 
+@available(*, deprecated, message: "This api isn't available, please refer to Readme.")
 public extension Injectable {
-    
-    /// Replaces the instance of the `Value` for given ``Injected`` property.
-    ///
-    /// - Parameters:
-    ///   - newValue: A value to replace with.
-    ///   - keyPath: Key path to the ``Injected`` property.
-    /// - Returns: An instance of the dependency of type `Value`
+    @available(*, deprecated, message: "This api isn't available, please refer to Readme.")
     @MainActor func injecting<Value>(
         _ newValue: Value,
         for keyPath: KeyPath<Self, Dependency<Value>>

Sources/DependencyKey.swift renamed to Sources/Deprecating/DependencyKey.swift

@@ -14,22 +14,7 @@
 
 import Foundation
 
-/// An injected property that provides an ``Dependency/instance``
-/// based on configuration.
-///
-/// To define an injection point anywhere in your app:
-/// ```swift
-/// final class MyAwesomeView: Injectable {
-///     @Injected(\.testService) var service
-/// }
-/// ```
-/// Then you can access the `testService` instance in your code
-/// by using ``Dependency/instance`` computed property.
-/// ```swift
-/// service.instance.doSomething()
-/// ```
-/// Depending on the ``Scope`` and ``Lifespan``
-/// provided it will be the new or shared instance.
+@available(*, deprecated, message: "This api isn't available, please refer to Readme.")
 @MainActor
 @propertyWrapper
 public final

Sources/Injectable.swift renamed to Sources/Deprecating/Injectable.swift

@@ -12,8 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-/// Dependency lifespan defines whether dependency
-/// needs to stay after consumer is deallocated.
+@available(*, deprecated, message: "This api isn't available, please refer to Readme.")
 public enum Lifespan {
     /// Stays until application is alive.
     case permanent

Sources/Injected-PropertyWrapper.swift renamed to Sources/Deprecating/Injected-PropertyWrapper.swift

@@ -12,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-/// Defines the way an instance is obtained.
+@available(*, deprecated, message: "This api isn't available, please refer to Readme.")
 public enum Scope {
     /// New instance of a dependency.
     case local