Awesome Open Source
Awesome Open Source

Tranquillity

DITranquillity

Tranquillity is a lightweight but powerful dependency injection library for swift.

The name "Tranquillity" laid the foundation in the basic principles of library: clarity, simplicity and security.

It says - use the library and you will be calm for your dependencies.

Language switch: English, Russian

About Dependendy Injection

Dependency Injections is a software design pattern in which someone delivers dependencies to an object.

Is one form of the broader technique of Inversion Of Control and help the Dependency Inversion Principle

For more details you can read this link

Also I recommend you to read Glossary which will help to better understand the terms.

Features

Core

UI

Graph API

Installing

The library supports three popular package managers: Cocoapods, Carthage, SwiftPM.

CocoaPods

Add the following lines to your Podfile:

pod 'DITranquillity'

SwiftPM

You can use "Xcode/File/Swift Packages/Add Package Dependency..." and write github url:

https://github.com/ivlevAstef/DITranquillity

Also you can edit your Package.swift and the following line into section dependencies:

.package(url: "https://github.com/ivlevAstef/DITranquillity.git", from: "3.8.4")

And don't forget to specify in your section target wrote dependency line:

.product(name: "DITranquillity")

Attention! - SwiftPM unsupport features from the "UI" section.

Carthage

Add the following lines to your Cartfile:

github "ivlevAstef/DITranquillity"

Carthage support "UI" and "GraphAPI" section no additional actions.

Usage

The library uses a declarative style of dependency description, and allows you to separate your application code from dependency description code.

For a quick entry, let's look at an example code of one simplified VIPER screen:

.................................................
/// Dependency description

let container = DIContainer()

container.register(LoginRouter.init)

container.register(LoginPresenterImpl.init)
  .as(LoginPresenter.self)
  .lifetime(.objectGraph)

container.register(LoginViewController.init)
  .injection(cycle: true, \.presenter)
  .as(LoginView.self)
  .lifetime(.objectGraph)

container.register(AuthInteractorImpl.init)
  .as(AuthInteractor.self)

.................................................
/// Application start point

let router: LoginRouter = container.resolve()
window.rootViewController = router.rootViewController
router.start()

.................................................
/// Application Code

import SwiftLazy

class LoginRouter {
    let rootViewController = UINavigationController()
    private let loginPresenterProvider: Provider<LoginPresenter>
    
    init(loginPresenterProvider: Provider<LoginPresenter>) {
        loginPresenterProvider = loginPresenterProvider
    }
    
    func start() {
        let presenter = loginPresenterProvider.value
        presenter.loginSuccessCallback = { [weak self] _ in
            ...
        }
        // Your can write code without force cast, it's code simple example
        rootViewController.push(presenter.view as! UIViewController)
    }
}

protocol LoginPresenter: class {
    var loginSuccessCallback: ((_ userId: String) -> Void)?
    func login(name: String, password: String)
}

protocol LoginView: class {
    func showError(text: String)
}

class LoginPresenterImpl: LoginPresenter {
    private weak var view: LoginView?
    private let authInteractor: AuthInteractor
    init(view: LoginView, authInteractor: AuthInteractor) {
        self.view = view
        self.authInteractor = authInteractor
    }
    
    func login(name: String, password: String) {
        if name.isEmpty || password.isEmpty {
            view?.showError(text: "fill input")
            return
        }
        
        authInteractor.login(name: name, password: password, completion: { [weak self] result in
            switch result {
            case .failure(let error): 
                self?.view?.showError(text: "\(error)")
            case .success(let userId):
                self?.loginSuccessCallback?(userId)
            }
        })
    }
}

class LoginViewController: UIViewController, LoginView {
    var presenter: LoginPresenter!
    ...
    func showError(text: String) {
        showAlert(title: "Error", message: text)
    }
    
    private func tapOnLoginButton() {
        presenter.login(name: nameTextField.text ?? "", password: passwordTextField.text ?? "")
    }
}

protocol AuthInteractor: class {
    func login(name: String, password: String, completion: (Result<String, Error>) -> Void)
}

class AuthInteractorImpl: AuthInteractor {
    func login(name: String, password: String, completion: (Result<String, Error>) -> Void) {
        ...
    }
}

As you can see, the dependency description code takes a small part, and the application code doen't know about how dependencies are implemented.

Also your can show samples:

Also your can read articles:

Requirements

iOS 9.0+,macOS 10.10+,tvOS 9.0+, watchOS, linux; ARC

  • Swift 5.0-5.3: Xcode 10.2-12.3; version >= 3.6.3
  • Swift 4.2: Xcode 10; version >= 3.4.3
  • Swift 4.1: Xcode 9.3; version >= 3.2.3
  • Swift 4.0: Xcode 9.0; version >= 3.0.5
  • Swift 3.0-3.2: Xcode 8.0-9.0; 0.9.5 <= version < 3.7.0
  • Swift 2.3: Xcode 7.0; version < 0.9.5

Changelog

See CHANGELOG file or releases.

History and Plans

  • [x] v1.x.x - Started
  • [x] v2.x.x - Stabilization
  • [x] v3.x.x - Evolution and Features
  • [ ] v4.x.x - Graph API and Optimization. Also Documentation and Marketing
  • [ ] v5.x.x - Pre compile time validation

Feedback

I've found a bug, or have a feature request

Please raise a GitHub issue.

I've found a defect in documentation, or thought up how to improve it

Please help library development and create pull requests

Plea

If you like my library, then support the library by putting star.

You can also support the author of the library with a donation:

Donate

Question?

You can feel free to ask the question at e-mail: [email protected].


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
swift (7,699
ios (3,582
dependency-injection (219
ioc (95
inversion-of-control (21
di (20