Merge pull request #940 from DeluxeAlonso/feature/code-cleanup

Feature/code cleanup

UpcomingMovies/DependencyInjection/DependencyAssemblers/Scenes/Account/ProfileAssembly.swift

@@ -25,7 +25,7 @@ final class ProfileAssembly: Assembly {
                                      accountUseCase: useCaseProvider.accountUseCase())
         }
 
-        container.register(ProfileViewModelProtocol.self) { (resolver, user: User) in
+        container.register(ProfileViewModelProtocol.self) { (resolver, user: UserProtocol) in
             guard let interactor = resolver.resolve(ProfileInteractorProtocol.self) else {
                 fatalError("ProfileInteractorProtocol dependency could not be resolved")
             }

UpcomingMovies/Helpers/Extensions/Entities+ImageConfiguration.swift

@@ -34,13 +34,3 @@ extension ImageConfigurable {
     }
 
 }
-
-extension User: ImageConfigurable {
-
-    var avatarImageURL: URL? {
-        guard let avatarPath, let avatarImageBaseURLString else { return nil }
-        let urlString = avatarImageBaseURLString.appending(avatarPath)
-        return URL(string: urlString)
-    }
-
-}

UpcomingMovies/Helpers/Handlers/AuthenticationHandler/AuthenticationHandler.swift

@@ -22,9 +22,9 @@ final class AuthenticationHandler: AuthenticationHandlerProtocol {
 
     // MARK: - Authentitation Persistence
 
-    func currentUser() -> User? {
+    func currentUser() -> UserProtocol? {
         guard let userId = authUseCase.currentUserId() else { return nil }
-        return userUseCase.find(with: userId)
+        return userUseCase.find(with: userId).flatMap(UserModel.init)
     }
 
     func isUserSignedIn() -> Bool {

UpcomingMovies/Helpers/Handlers/AuthenticationHandler/AuthenticationHandlerProtocol.swift

@@ -6,11 +6,9 @@
 //  Copyright © 2021 Alonso. All rights reserved.
 //
 
-import UpcomingMoviesDomain
-
 protocol AuthenticationHandlerProtocol {
 
-    func currentUser() -> User?
+    func currentUser() -> UserProtocol?
     func isUserSignedIn() -> Bool
     func deleteCurrentUser()
 

UpcomingMovies/Helpers/Protocols/Models/UserProtocol.swift

@@ -9,30 +9,46 @@
 import Foundation
 import UpcomingMoviesDomain
 
-protocol UserProtocol {
+protocol UserProtocol: ImageConfigurable {
 
     var id: Int { get }
     var name: String { get }
     var username: String { get }
     var includeAdult: Bool { get }
-    var avatarPath: String? { get }
+    var avatarImageURL: URL? { get }
+
+    func hasUpdatedInfo(_ newUserInfo: UserProtocol) -> Bool
 
 }
 
 struct UserModel: UserProtocol {
-
+    
     let id: Int
     let name: String
     let username: String
     let includeAdult: Bool
-    let avatarPath: String?
-
+
+    private let avatarPath: String?
+
+    var avatarImageURL: URL? {
+        guard let avatarPath, let avatarImageBaseURLString else { return nil }
+        let urlString = avatarImageBaseURLString.appending(avatarPath)
+        return URL(string: urlString)
+    }
+
     init(_ user: User) {
         self.id = user.id
         self.name = user.name
         self.username = user.username
         self.includeAdult = user.includeAdult
         self.avatarPath = user.avatarPath
     }
+
+    func hasUpdatedInfo(_ newUserInfo: UserProtocol) -> Bool {
+        self.id != newUserInfo.id ||
+        self.name != newUserInfo.name ||
+        self.username != newUserInfo.username ||
+        self.avatarImageURL != newUserInfo.avatarImageURL
+    }
 
 }

UpcomingMovies/Scenes/Account/AccountCoordinator.swift

@@ -7,7 +7,6 @@
 //
 
 import UIKit
-import UpcomingMoviesDomain
 
 final class AccountCoordinator: BaseCoordinator, AccountCoordinatorProtocol {
 
@@ -35,7 +34,7 @@ final class AccountCoordinator: BaseCoordinator, AccountCoordinatorProtocol {
         coordinator.start(coordinatorMode: .embed(parentViewController: parentViewController, containerView: nil))
     }
 
-    func embedProfileViewController(on parentViewController: ProfileViewControllerDelegate, for user: User) {
+    func embedProfileViewController(on parentViewController: ProfileViewControllerDelegate, for user: UserProtocol) {
         navigationController.setNavigationBarHidden(false, animated: true)
 
         let coordinator = ProfileCoordinator(navigationController: navigationController, user: user, delegate: parentViewController)

UpcomingMovies/Scenes/Account/AccountInteractor.swift

@@ -17,7 +17,7 @@ final class AccountInteractor: AccountInteractorProtocol {
         self.authHandler = authHandler
     }
 
-    func currentUser() -> User? {
+    func currentUser() -> UserProtocol? {
         authHandler.currentUser()
     }
 

UpcomingMovies/Scenes/Account/AccountProtocols.swift

@@ -7,28 +7,27 @@
 //
 
 import UIKit
-import UpcomingMoviesDomain
 
 protocol AccountViewModelProtocol {
 
     var showAuthPermission: AnyPublishBindable<URL> { get }
     var didReceiveError: AnyPublishBindable<Void> { get }
 
     func isUserSignedIn() -> Bool
-    func currentUser() -> User?
+    func currentUser() -> UserProtocol?
 
 }
 
 protocol AccountInteractorProtocol {
 
-    func currentUser() -> User?
+    func currentUser() -> UserProtocol?
 
 }
 
 protocol AccountCoordinatorProtocol: AnyObject {
 
     func embedSignInViewController(on parentViewController: SignInViewControllerDelegate)
-    func embedProfileViewController(on parentViewController: ProfileViewControllerDelegate, for user: User)
+    func embedProfileViewController(on parentViewController: ProfileViewControllerDelegate, for user: UserProtocol)
 
     func removeSignInViewController(from parentViewController: UIViewController)
     func removeProfileViewController(from parentViewController: UIViewController)

UpcomingMovies/Scenes/Account/AccountViewModel.swift

@@ -31,7 +31,7 @@ final class AccountViewModel: AccountViewModelProtocol {
         currentUser() != nil
     }
 
-    func currentUser() -> User? {
+    func currentUser() -> UserProtocol? {
         interactor.currentUser()
     }
 

UpcomingMovies/Scenes/Account/Profile/Cells/Account Info/ProfileAccountInfoCellViewModel.swift

@@ -7,7 +7,6 @@
 //
 
 import Foundation
-import UpcomingMoviesDomain
 
 protocol ProfileAccountInfoCellViewModelProtocol {
 
@@ -25,7 +24,7 @@ final class ProfileAccountInfoCellViewModel: ProfileAccountInfoCellViewModelProt
 
     // MARK: - Initializers
 
-    init(userAccount: User) {
+    init(userAccount: UserProtocol) {
         self.name = userAccount.name
         self.username = userAccount.username
         self.avatarImageURL = userAccount.avatarImageURL

UpcomingMovies/Scenes/Account/Profile/ProfileCoordinator.swift

@@ -7,14 +7,13 @@
 //
 
 import UIKit
-import UpcomingMoviesDomain
 
 final class ProfileCoordinator: BaseCoordinator, ProfileCoordinatorProtocol {
 
-    private let user: User
+    private let user: UserProtocol
     private weak var delegate: ProfileViewControllerDelegate?
 
-    init(navigationController: UINavigationController, user: User, delegate: ProfileViewControllerDelegate?) {
+    init(navigationController: UINavigationController, user: UserProtocol, delegate: ProfileViewControllerDelegate?) {
         self.user = user
         self.delegate = delegate
         super.init(navigationController: navigationController)

UpcomingMovies/Scenes/Account/Profile/ProfileInteractor.swift

@@ -24,12 +24,12 @@ final class ProfileInteractor: ProfileInteractorProtocol {
     }
 
     // TODO: - Change this method to get the account detail given the id of a user account
-    func getAccountDetail(completion: @escaping (Result<User, Error>) -> Void) {
+    func getAccountDetail(completion: @escaping (Result<UserProtocol, Error>) -> Void) {
         accountUseCase.getAccountDetail(completion: { result in
             switch result {
             case .success(let user):
                 self.userUseCase.saveUser(user)
-                completion(.success(user))
+                completion(.success(UserModel(user)))
             case .failure(let error):
                 completion(.failure(error))
             }

UpcomingMovies/Scenes/Account/Profile/ProfileProtocols.swift

@@ -6,7 +6,7 @@
 //  Copyright © 2020 Alonso. All rights reserved.
 //
 
-import UpcomingMoviesDomain
+import UIKit
 
 protocol ProfileViewModelProtocol {
 
@@ -31,7 +31,7 @@ protocol ProfileViewModelProtocol {
 
 protocol ProfileInteractorProtocol {
 
-    func getAccountDetail(completion: @escaping (Result<User, Error>) -> Void)
+    func getAccountDetail(completion: @escaping (Result<UserProtocol, Error>) -> Void)
     func signOutUser(completion: @escaping (Result<Bool, Error>) -> Void)
 
 }

UpcomingMovies/Scenes/Account/Profile/ProfileViewModel.swift

@@ -6,13 +6,13 @@
 //  Copyright © 2019 Alonso. All rights reserved.
 //
 
-import UpcomingMoviesDomain
+import Foundation
 
 final class ProfileViewModel: ProfileViewModelProtocol {
 
     // MARK: - Stored properties
 
-    private var userAccount: User
+    private var userAccount: UserProtocol
     private let interactor: ProfileInteractorProtocol
     private let factory: ProfileFactoryProtocol
 
@@ -28,7 +28,7 @@ final class ProfileViewModel: ProfileViewModelProtocol {
 
     // MARK: - Initializers
 
-    init(userAccount: User,
+    init(userAccount: UserProtocol,
          interactor: ProfileInteractorProtocol,
          factory: ProfileFactoryProtocol) {
         self.userAccount = userAccount
@@ -73,7 +73,7 @@ final class ProfileViewModel: ProfileViewModelProtocol {
             guard let user = result.wrappedValue else { return }
 
             // If there is no update to display we don't reload user account info
-            if self.userAccount != user {
+            if self.userAccount.hasUpdatedInfo(user) {
                 self.userAccount = user
                 self.reloadAccountInfo.send(())
             }

UpcomingMovies/Scenes/Movies/SearchMovies/SearchResult/SearchMoviesResultInteractor.swift

@@ -17,7 +17,7 @@ final class SearchMoviesResultInteractor: SearchMoviesResultInteractorProtocol {
 
     var didUpdateMovieSearches: (() -> Void)?
 
-    private var currentUser: User? {
+    private var currentUser: UserProtocol? {
         authHandler.currentUser()
     }
 

UpcomingMoviesTests/Account/AccountViewModelTests.swift

@@ -8,7 +8,6 @@
 
 import XCTest
 @testable import UpcomingMovies
-import UpcomingMoviesDomain
 @testable import NetworkInfrastructure
 
 final class AccountViewModelTests: XCTestCase {
@@ -30,7 +29,7 @@ final class AccountViewModelTests: XCTestCase {
 
     func testCurrentUserNotNil() {
         // Arrange
-        let userToTest = User.with()
+        let userToTest = MockUserProtocol()
         // Act
         mockInteractor.currentUserResult = userToTest
         let user = viewModelToTest.currentUser()
@@ -40,7 +39,7 @@ final class AccountViewModelTests: XCTestCase {
 
     func testCurrentUserNil() {
         // Arrange
-        let userToTest: UpcomingMoviesDomain.User? = nil
+        let userToTest: UserProtocol? = nil
         // Act
         mockInteractor.currentUserResult = userToTest
         let user = viewModelToTest.currentUser()
@@ -50,7 +49,7 @@ final class AccountViewModelTests: XCTestCase {
 
     func testIsUserSignedInTrue() {
         // Arrange
-        let userToTest = User.with()
+        let userToTest = MockUserProtocol()
         // Act
         mockInteractor.currentUserResult = userToTest
         let isUserSignedIn = viewModelToTest.isUserSignedIn()
@@ -60,7 +59,7 @@ final class AccountViewModelTests: XCTestCase {
 
     func testIsUserSignedInFalse() {
         // Arrange
-        let userToTest: UpcomingMoviesDomain.User? = nil
+        let userToTest: UserProtocol? = nil
         // Act
         mockInteractor.currentUserResult = userToTest
         let isUserSignedIn = viewModelToTest.isUserSignedIn()

UpcomingMoviesTests/Account/Profile/Cells/Account Info/ProfileAccountInfoCellViewModelTests.swift

@@ -15,7 +15,7 @@ final class ProfileAccountInfoCellViewModelTests: XCTestCase {
     func testName() {
         // Arrange
         let nameToTest = "Name"
-        let viewModel = createSUT(with: User.with(name: nameToTest))
+        let viewModel = createSUT(with: MockUserProtocol(name: nameToTest))
         // Act
         let viewModelName = viewModel.name
         // Assert
@@ -25,14 +25,14 @@ final class ProfileAccountInfoCellViewModelTests: XCTestCase {
     func testUsername() {
         // Arrange
         let usernameToTest = "Username"
-        let viewModel = createSUT(with: User.with(username: usernameToTest))
+        let viewModel = createSUT(with: MockUserProtocol(username: usernameToTest))
         // Act
         let viewModelUsername = viewModel.username
         // Assert
         XCTAssertEqual(usernameToTest, viewModelUsername)
     }
 
-    private func createSUT(with user: User) -> ProfileAccountInfoCellViewModel {
+    private func createSUT(with user: UserProtocol) -> ProfileAccountInfoCellViewModel {
         ProfileAccountInfoCellViewModel(userAccount: user)
     }
 

UpcomingMoviesTests/Account/Profile/ProfileCoordinatorTests.swift

@@ -30,14 +30,14 @@ final class ProfileCoordinatorTests: XCTestCase {
 
     func testBuild() {
         // Arrange
-        let coordinator = createSUT(user: .with())
+        let coordinator = createSUT(user: MockUserProtocol())
         // Act
         let viewController = coordinator.build()
         // Assert
         XCTAssertNotNil(viewController.delegate)
     }
 
-    private func createSUT(user: User) -> ProfileCoordinator {
+    private func createSUT(user: UserProtocol) -> ProfileCoordinator {
         ProfileCoordinator(navigationController: navigationController, user: user, delegate: delegate)
     }
 

UpcomingMoviesTests/Account/Profile/ProfileViewModelTests.swift

@@ -20,7 +20,7 @@ final class ProfileViewModelTests: XCTestCase {
         try super.setUpWithError()
         mockInteractor = MockProfileInteractor()
         mockFactory = MockProfileViewFactory()
-        viewModelToTest = ProfileViewModel(userAccount: User.with(),
+        viewModelToTest = ProfileViewModel(userAccount: MockUserProtocol(),
                                            interactor: mockInteractor,
                                            factory: mockFactory)
     }
@@ -34,7 +34,13 @@ final class ProfileViewModelTests: XCTestCase {
 
     func testGetAccountDetailSuccessInfoReloaded() {
         // Arrange
-        let userToTest = User.with(name: "Alonso")
+        let currentUser = MockUserProtocol()
+        currentUser.hasUpdatedInfoResult = true
+        viewModelToTest = ProfileViewModel(userAccount: currentUser,
+                                           interactor: mockInteractor,
+                                           factory: mockFactory)
+
+        let userToTest = MockUserProtocol(name: "Alonso")
         let expectation = XCTestExpectation(description: "Reload account info")
         // Act
         viewModelToTest.reloadAccountInfo.bind { _ in
@@ -48,7 +54,7 @@ final class ProfileViewModelTests: XCTestCase {
 
     func testGetAccountDetailSuccessInfoNotReloaded() {
         // Arrange
-        let userToTest = User.with()
+        let userToTest = MockUserProtocol()
         let expectation = XCTestExpectation(description: "Should not reload account info")
         expectation.isInverted = true
         // Act