kawoou/deli

Deli is an easy-to-use Dependency Injection(DI).

deli's Issues

Support multiple module.

In case, projects are managed by integrating them into separate modules.

Don't instantiated the DeliFactory class yourself.
Provides load methods via AppContext.

AppDelegate.swift:

import Deli
import OtherModule1
import OtherModule2

class AppDelegate {
    var window: UIWindow?

    let container = AppContext.load([
        DeliFactory.self,
        OtherModule1.DeliFactory.self,
        OtherModule2.DeliFactory.self
    ])

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        return true
    }
}

Support for specifying the name of the output class

Update Config file that supports specifies the name of output class.

Support dependency injection for without lifecycle management.

The lifecycle of UICollectionViewCell is managed by UICollectionView.
In such a case, dependency injection must be possible.

This rules in #4:

class PhotoCollectionViewCell: UICollectionViewCell, Injectable {
    func inject(_ userService: Dependency<UserService>, _ userID: Argument<String>) {
        ...
    }
}

//-----------------------------------------------------------

func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
    ...
    cell.inject(with: (userID))
    ...
    return cell
}

We temporarily used the name "Injectable". Is there a good naming?

Enhanced IDE support for error messages.

Need to change the style of error messages in a way that Xcode understands.

{FILE_PATH}:{LINE}:{CHARACTER}: {warning | error}: {MESSAGE}

Support multiple buld target on deli.yml

I want to change to this format.

deli.yml:

target:
  - Sample
  - GitHubSearch
  - Survey

config:
  Sample:
    include:
      - Tests/DeliTests/DeliSample
    exclude:
      - Tests/DeliTests/DeliSample/DeliFactory.swift
    output: Tests/DeliTests/DeliSample
  GitHubSearch:
    project: Examples/GitHubSearch/GitHubSearch
    output: GitHubSearch/DeliFactory.swift
  Survey:
    project: Examples/Survey/Survey.xcodeproj
    output: Survey/DeliFactory.swift

Error: The file “DeliFactory.swift” couldn’t be opened because there is no such file.

deli build throw below error when don't have a deli.yml file:

⛔️ Error: The file “DeliFactory.swift” couldn’t be opened because there is no such file.

Support swift 4.2

Improved loading flow for ModuleFactory

The Test Mode function is inconvenient for writing test code.
Therefore, want to improve the ModuleFactory so that it can be simplified.

class SomeControllerTests: QuickSpec {
    override func spec() {
        super.spec()

        var sut: SomeController!

        var mockUserService: MockUserService!
        var mockFriendService: MockFriendService!

        let testModule = ModuleFactory()
        testModule.register(MockUserService.self) { MockUserService() }
            .link(UserService.self)
        testModule.register(MockFriendService.self) { MockFriendService() }
            .link(FriendService.self)

        beforeEach {
            AppContext.shared.load(testModule, priority: .high)
        }
        afterEach {
            AppContext.shared.reset()
            AppContext.shared.unload(testModule)
        }

        describe("SomeController") {
            beforeEach {
                sut = AppContext.shared.get(SomeController.self)
                mockUserService = AppContext.shared.get(MockUserService.self)
                mockFriendService = AppContext.shared.get(MockFriendService.self)
            }
            ...
        }
    }
}

Fixing a branch to Travis CI

Do not need to build all the branches.
Set up to build only master, develop and PR.

Support "always" and "weak" scope.

• Always: Instantiated in advance even if not used at launch.
• weak: It is similar to "singleton" but uses "weak" as a caching strategy. (If not used, will be released on memory)

Support configuration property.

How to build

Change the Deli configuration file or include it via command line.

application-dev.properties:

environment: dev
server:
    url: https://dev.example.com/

deli.yml:

target:
- App

config:
  App:
    - project: App
    - properties:
      - Resources/Common/*.properties
      - Resources/application-dev.properties # override

command line:

deli build \
  --property "Resource/application-dev.properties" \
  --property "Resources/Common/*.properties"

How to use

1. Package

ServerConfig.swift:

struct ServerConfig: ConfigProperty {
    let target: String = "server"
    let url: String
}

NetworkManager.swift:

final class NetworkManager: Autowired {
    let serverUrl: String

    required init(_ config: ServerConfig) {
        serverUrl = config.url
    }
}

2. Single (without Validate)

NetworkManager.swift:

final class NetworkManager {
    let serverUrl = AppContext.getProperty("server.url") ?? ""
}

3. Single (with Validate)

NetworkManager.swift:

final class NetworkManager: Inject {
    let serverUrl = InjectProperty("server.url")
}

4. Qualifier on Constructor Injection

UserService.swift:

final class UserService: Autowired {
    required init(_/*environment*/ network: NetworkProvider) {
    }
}

5. Qualifier on Inject

LibraryFactory.swift:

final class LibraryFactory: Inject {
    func getBooks() -> [Book] {
        return Inject([Book].self, qualifierBy: "environment")
    }
}

Reference

• https://docs.spring.io/spring-boot/docs/current/reference/html/howto-properties-and-configuration.html
• https://laravel.com/docs/5.7/configuration
• https://github.com/yyvess/Guice-configuration

Support qualifier in Autowired.

I want to modify it so that we can specify qualifier in Autowired protocol.
But, a good way to easy-use has not thought yet.

Support user-arguments.

Payload:

struct UserPayload: Payload {
    let userID: String

    required init(with argument: (userID: String)) {
        self.userID = argument.userID
    }
}

AutowiredFactory:

class UserViewModel: AutowiredFactory {
    required init(
        _ testService: TestService,
        _ userService: UserService,
        payload: UserPayload
    ) {
        self.testService = testService
        self.userID = payload.userID
    }
}

//-----------------------------------------------------------

class UserView: UIView, Inject {
    let viewModel: UserViewModel

    init(userID: String) {
        viewModel = Inject(UserViewModel.self, with: (userID: userID))
    }
}

LazyAutowiredFactory:

class UserViewModel: LazyAutowiredFactory {
    func inject(
        _ testService: TestService,
        _ userService: UserService,
        payload: UserPayload
    ) {
        self.testService = testService
        self.userID = payload.userID
    }
    required init() {}
}

//-----------------------------------------------------------

class UserView: UIView, Inject {
    let viewModel: UserViewModel

    init(userID: String) {
        viewModel = Inject(UserViewModel.self, with: (userID: userID))
    }
}

If specified as a Factory, automatically operates as a prototype scope.