Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 1.58 KB

README.md

File metadata and controls

61 lines (42 loc) · 1.58 KB

Biodag

Biodag: [pit̪akˈ] - dirk in Scottish Gaelic, a long thrusting dagger.

A Swift micro-library that provides lightweight dependency injection, originally forked from Shank

Inject dependencies via property wrappers:

final class ViewController: UIViewController {
    
    @Inject private var widgetModule: WidgetModuleType
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        widgetModule.test()
    }
}

Register modules early in your app:

class AppDelegate: UIResponder, UIApplicationDelegate {

    private let dependencies = DependencyResolver {
        // A prototype dependency (i.e. one per @Inject)
        Module { WidgetModule() as WidgetModuleType }
        // A dependency that's scoped to be a singleton
        Module(scope: .singleton) { SingletonModule() as SingletonModuleType }
    }
    
    override init() {
        super.init()
        dependencies.build()
    }
}

If you forget to build the dependency container, it will result in a run-time exception.

Installation

The easiest way to install this is via CocoaPods:

pod 'Biodag', '~> 0.3.0'

You can also use SPM. Add a dependency for Biodag like:

.package(url: "https://github.com/kerrmarin/biodag.git", from: "0.3.0")

Contributing

To run the tests, run swift test.

To open in Xcode, open the package workspace file inside the .swiftpm/xcode folder.

If you find a bug or want to suggest an improvement, open an issue and, optionally (but encouraged!), make a PR :)