Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digipolitan/dependency-injector
Dependency injector made in pure Swift
https://github.com/digipolitan/dependency-injector
carthage cocoapods dependency-injection fastlane framework ios osx swift tvos watchos
Last synced: about 23 hours ago
JSON representation
Dependency injector made in pure Swift
- Host: GitHub
- URL: https://github.com/digipolitan/dependency-injector
- Owner: Digipolitan
- License: bsd-3-clause
- Created: 2017-02-07T22:31:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-30T18:02:49.000Z (over 5 years ago)
- Last Synced: 2024-12-28T15:47:10.579Z (20 days ago)
- Topics: carthage, cocoapods, dependency-injection, fastlane, framework, ios, osx, swift, tvos, watchos
- Language: Swift
- Homepage:
- Size: 178 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
DependencyInjector
=================================
[](https://developer.apple.com/swift/)
[](https://travis-ci.org/Digipolitan/dependency-injector)
[](https://img.shields.io/cocoapods/v/DependencyInjector.svg)
[](https://github.com/Carthage/Carthage)
[](https://swift.org/package-manager/)
[](http://cocoadocs.org/docsets/DependencyInjector)
[](http://twitter.com/Digipolitan)
Dependency injector Swift. Compatible for swift server-side and swift for iOS
## Installation
### CocoaPods
To install DependencyInjector with CocoaPods, add the following lines to your `Podfile`.
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!
pod 'DependencyInjector'
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate DependencyInjector into your Xcode project using Carthage, specify it in your `Cartfile`:
```
github 'Digipolitan/dependency-injector' ~> 2.0
```
Run `carthage update` to build the framework and drag the built `DependencyInjector.framework` into your Xcode project.
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler.
Once you have your Swift package set up, adding DependencyInjector as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/Digipolitan/dependency-injector.git", from: "2.0.0")
]
```
## The Basics
First you must create a Module and register some providers
```swift
let module = Module()
module.bind(IAnimal.self).to(Dog.self)
```
IAnimal is a protocol that MUST be implemented by the Dog class
```swift
public protocol IAnimal {
var name: String { get }
func scream() -> String
}
open class Dog: IAnimal, Injectable {
public var name: String
public required convenience init(injector: Injector, arguments: [String : Any]?) throws {
self.init(name: arguments?["name"] as? String ?? "Athina")
}
init(name: String) {
self.name = name
}
public func scream() -> String {
return "Barking"
}
}
```
After that, you must register your module inside an injector
```swift
Injector.default.register(module: module)
```
Finally, inject an IAnimal and retrieve a concrete class registered inside your module
```swift
if let animal = try? Injector.default.inject(IAnimal.self) {
print(animal.name) // print Athina
print(animal.scream()) // print Barking
}
```
## Advanced
### Arguments
Register a provider that handle arguments :
```swift
let module = Module()
module.bind(IAnimal.self).with { (_, arguments) -> IAnimal? in
if let name = arguments?["name"] as? String {
return Dog(name: name)
}
return nil
}
Injector.default.register(module: module)
```
Inject an IAnimal with arguments Dictionary :
```swift
if let animal = Injector.default.inject(IAnimal.self, arguments: ["name": "Athina"]) {
print(animal.name) // print Athina
print(animal.scream()) // print Barking
}
if let otherAnimal = Injector.default.inject(IAnimal.self, arguments: ["name": "Yoda"]) {
print(otherAnimal.name) // print Yoda
print(otherAnimal.scream()) // print Barking
}
```
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details!
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report
unacceptable behavior to [[email protected]](mailto:[email protected]).
## License
DependencyInjector is licensed under the [BSD 3-Clause license](LICENSE).