difference between "MVC" and "Flux"

README.md

@@ -1,21 +1,52 @@
-# iOSDesignPatternSamples (MVC)
+# iOSDesignPatternSamples (Flux)
 
-This is Github user search demo app that made with MVC design pattern.
+This is Github user search demo app that made with Flux design pattern.
 
 ## Application Structure
 
 ![](./Images/structure.png)
 
 ## ViewControllers
 
-- [SearchViewController](./iOSDesignPatternSamples/Sources/UI/Search/SearchViewController.swift) -> Search Github user and show user result list
-- [FavoriteViewController](./iOSDesignPatternSamples/Sources/UI/Favorite/FavoriteViewController.swift) -> Show local on memory favorite repositories
-- [UserRepositoryViewController](./iOSDesignPatternSamples/Sources/UI/UserRepository/UserRepositoryViewController.swift) -> Show Github user's repositories
-- [RepositoryViewController](./iOSDesignPatternSamples/Sources/UI/Repository/RepositoryViewController.swift) -> Show a repository and add / remove local on memory favorites
+### [SearchViewController](./iOSDesignPatternSamples/Sources/UI/Search/SearchViewController.swift)
+Search Github user and show user result list
+
+![](./Images/search.png)
+
+- [SearchViewDataSource](./iOSDesignPatternSamples/Sources/UI/Search/SearchViewDataSource.swift) <- Adapt UITableViewDataSource and UITableViewDelegate
+- [SearchAction](./iOSDesignPatternSamples/Sources/UI/Search/Flux/SearchAction.swift)
+- [SearchStore](./iOSDesignPatternSamples/Sources/UI/Search/Flux/SearchStore.swift)
+
+### [FavoriteViewController](./iOSDesignPatternSamples/Sources/UI/Favorite/FavoriteViewController.swift)
+Show local on memory favorite repositories
+
+![](./Images/favorite.png)
+
+- [FavoriteViewDataSource](./iOSDesignPatternSamples/Sources/UI/Favorite/FavoriteViewDataSource.swift) <- Adapt UITableViewDataSource and UITableViewDelegate
+- [FavoriteAction](./iOSDesignPatternSamples/Sources/UI/Favorite/Flux/FavoriteAction.swift)
+- [FavoriteStore](./iOSDesignPatternSamples/Sources/UI/Favorite/Flux/FavoriteStore.swift)
+
+### [UserRepositoryViewController](./iOSDesignPatternSamples/Sources/UI/UserRepository/UserRepositoryViewController.swift)
+Show Github user's repositories
+
+![](./Images/user_repository.png)
+
+- [UserRepositoryViewDataSource](./iOSDesignPatternSamples/Sources/UI/UserRepository/UserRepositoryViewDataSource.swift) <- Adapt UITableViewDataSource and UITableViewDelegate
+- [UserRepositoryAction](./iOSDesignPatternSamples/Sources/UI/UserRepository/Flux/UserRepositoryAction.swift)
+- [UserRepositoryStore](./iOSDesignPatternSamples/Sources/UI/UserRepository/Flux/UserRepositoryStore.swift)
+
+### [RepositoryViewController](./iOSDesignPatternSamples/Sources/UI/Repository/RepositoryViewController.swift)
+Show a repository and add / remove local on memory favorites
+
+![](./Images/repository.png)
+
+- [RepositoryAction](./iOSDesignPatternSamples/Sources/UI/Repository/Flux/RepositoryAction.swift)
+- [RepositoryStore](./iOSDesignPatternSamples/Sources/UI/Repository/Flux/RepositoryStore.swift)
+
 
 ## How to add / remove favorites
 
-You can add / remove favorite repositories in RepositoryViewController, but an Array of favorite repository is hold by FavoriteViewController.
+You can add / remove favorite repositories in RepositoryViewController. Array of favorite repository is hold by FavoriteModel that injected to each actions, therefore you can use its reference everywhere!
 
 ## Run
 

iOSDesignPatternSamples/Sources/Common/AppDelegate.swift

@@ -6,8 +6,9 @@
 //  Copyright © 2017年 marty-suzuki. All rights reserved.
 //
 
-import UIKit
+import Combine
 import GithubKit
+import UIKit
 
 @UIApplicationMain
 class AppDelegate: UIResponder, UIApplicationDelegate {
@@ -22,24 +23,76 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             for value in viewControllers.enumerated() {
                 switch value {
                 case let (0, nc as UINavigationController):
+                    let repositoryDispatcher = RepositoryDispatcher()
+                    let searchDispatcher = SearchDispatcher()
+                    let userRepositoryDispatcher = UserRepositoryDispatcher()
                     let searchVC = SearchViewController(
-                        searchModel: SearchModel(
-                            sendRequest: ApiSession.shared.send,
-                            asyncAfter: { DispatchQueue.global().asyncAfter(deadline: $0, execute: $1) },
-                            mainAsync: { work in DispatchQueue.main.async { work() } }
-                        ),
-                        makeFavoriteModel: { [favoriteModel] in favoriteModel },
-                        makeRepositoryModel: {
-                            RepositoryModel(
-                                user: $0,
+                        action: SearchAction(
+                            notificationCenter: .default,
+                            dispatcher: searchDispatcher,
+                            searchModel: SearchModel(
                                 sendRequest: ApiSession.shared.send
                             )
+                        ),
+                        store: SearchStore(
+                            dispatcher: searchDispatcher
+                        ),
+                        makeUserRepositoryAction: { user in
+                            UserRepositoryAction(
+                                dispatcher: userRepositoryDispatcher,
+                                repositoryModel: RepositoryModel(
+                                    user: user,
+                                    sendRequest: ApiSession.shared.send
+                                )
+                            )
+                        },
+                        makeUserRepositoryStore: { user in
+                            UserRepositoryStore(
+                                user: user,
+                                dispatcher: userRepositoryDispatcher
+                            )
+                        },
+                        makeRepositoryAction: { [favoriteModel] repository in
+                            RepositoryAction(
+                                repository: repository,
+                                dispatcher: repositoryDispatcher,
+                                favoriteModel: favoriteModel
+                            )
+                        },
+                        makeRepositoryStore: { repository in
+                            RepositoryStore(
+                                repository: repository,
+                                dispatcher: repositoryDispatcher
+                            )
                         }
                     )
                     nc.setViewControllers([searchVC], animated: false)
 
                 case let (1, nc as UINavigationController):
-                    let favoriteVC = FavoriteViewController(favoriteModel: favoriteModel)
+                    let favoriteDispatcher = FavoriteDispatcher()
+                    let repositoryDispatcher = RepositoryDispatcher()
+                    let favoriteVC = FavoriteViewController(
+                        action: FavoriteAction(
+                            dispatcher: favoriteDispatcher,
+                            favoriteModel: favoriteModel
+                        ),
+                        store: FavoriteStore(
+                            dispatcher: favoriteDispatcher
+                        ),
+                        makeRepositoryAction: { [favoriteModel] repository in
+                            RepositoryAction(
+                                repository: repository,
+                                dispatcher: repositoryDispatcher,
+                                favoriteModel: favoriteModel
+                            )
+                        },
+                        makeRepositoryStore: { repository in
+                            RepositoryStore(
+                                repository: repository,
+                                dispatcher: repositoryDispatcher
+                            )
+                        }
+                    )
                     nc.setViewControllers([favoriteVC], animated: false)
 
                 default:
@@ -51,4 +104,3 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         return true
     }
 }
-

iOSDesignPatternSamples/Sources/Common/Extension/ApiSession.extension.swift

@@ -16,4 +16,4 @@ extension ApiSession {
     }()
 }
 
-typealias SendRequest<T: Request> = (T, @escaping (Result<T.ResponseType, Swift.Error>) -> ()) -> AnyCancellable
+typealias SendRequest<T: Request> = (T) -> AnyPublisher<T.ResponseType, Swift.Error>

iOSDesignPatternSamples/Sources/Common/FavoriteModel.swift

@@ -6,43 +6,71 @@
 //  Copyright © 2017年 marty-suzuki. All rights reserved.
 //
 
+import Combine
 import GithubKit
 
-protocol FavoriteModelDelegate: AnyObject {
-    func favoriteDidChange()
-}
-
-extension FavoriteModelDelegate {
-    func favoriteDidChange() {}
-}
-
 protocol FavoriteModelType: AnyObject {
     var favorites: [Repository] { get }
-    var delegate: FavoriteModelDelegate? { get set }
+    var favoritePublisher: Published<[Repository]>.Publisher { get }
     func addFavorite(_ repository: Repository)
     func removeFavorite(_ repository: Repository)
+    func contains(_ repository: Repository) -> AnyPublisher<Bool, Never>
 }
 
 final class FavoriteModel: FavoriteModelType {
-    private(set) var favorites: [Repository] = [] {
-        didSet {
-            delegate?.favoriteDidChange()
-        }
+    @Published
+    private(set) var favorites: [Repository] = []
+    var favoritePublisher: Published<[Repository]>.Publisher {
+        $favorites
     }
-
-    weak var delegate: FavoriteModelDelegate?
-
+
+    private let _addFavorite = PassthroughSubject<Repository, Never>()
+    private let _removeFavorite = PassthroughSubject<Repository, Never>()
+    private var cancellables = Set<AnyCancellable>()
+
+    init() {
+        let favorites1 = _addFavorite
+            .flatMap { [weak self] repository -> AnyPublisher<[Repository], Never> in
+                guard let me = self else {
+                    return Empty().eraseToAnyPublisher()
+                }
+                var favorites = me.favorites
+                if favorites.firstIndex(where: { $0.url == repository.url }) != nil {
+                    return Empty().eraseToAnyPublisher()
+                }
+                favorites.append(repository)
+                return Just(favorites).eraseToAnyPublisher()
+            }
+
+        let favorites2 = _removeFavorite
+            .flatMap { [weak self] repository -> AnyPublisher<[Repository], Never> in
+                guard let me = self else {
+                    return Empty().eraseToAnyPublisher()
+                }
+                var favorites = me.favorites
+                guard let index = favorites.firstIndex(where: { $0.url == repository.url }) else {
+                    return Empty().eraseToAnyPublisher()
+                }
+                favorites.remove(at: index)
+                return Just(favorites).eraseToAnyPublisher()
+            }
+
+        favorites1.merge(with: favorites2)
+            .assign(to: \.favorites, on: self)
+            .store(in: &cancellables)
+    }
+
     func addFavorite(_ repository: Repository) {
-        if favorites.firstIndex(where: { $0.url == repository.url }) != nil {
-            return
-        }
-        favorites.append(repository)
+        _addFavorite.send(repository)
     }
-    
+
     func removeFavorite(_ repository: Repository) {
-        guard let index = favorites.firstIndex(where: { $0.url == repository.url }) else {
-            return
-        }
-        favorites.remove(at: index)
+        _removeFavorite.send(repository)
+    }
+
+    func contains(_ repository: Repository) -> AnyPublisher<Bool, Never> {
+        $favorites
+            .map { $0.contains { $0.url == repository.url } }
+            .eraseToAnyPublisher()
     }
 }