Merge pull request #10 from AppCron/generic-error-handling

Florian Rieger · web-flow · commit 3a4d7831e2d8 · 2016-08-07T15:42:31.000+02:00
Generic error handling
diff --git a/Sources/ErrorHandlerExtension.swift b/Sources/ErrorHandlerExtension.swift
@@ -0,0 +1,20 @@
+import Foundation
+
+public protocol ErrorHandler {
+    func handleError(request: ErrorRequest, error: ErrorType)
+}
+
+
+public extension ErrorHandler where Self: Interactor {
+    
+    func handleError(request: ErrorRequest, error: ErrorType) {
+        if let error = error as? InteractorError {
+            request.onError?(error)
+        } else {
+            let nsError = error as NSError
+            let errorWrapper = InteractorError(error: nsError)
+            request.onError?(errorWrapper)
+        }
+    }
+
+}
diff --git a/Sources/Interactor.swift b/Sources/Interactor.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-public protocol Interactor: AnyObject {
+public protocol Interactor: AnyObject, ErrorHandler {
     associatedtype Request
     func execute(request: Request)
 }
diff --git a/Sources/InteractorError.swift b/Sources/InteractorError.swift
@@ -3,6 +3,7 @@ import Foundation
 public class InteractorError: ErrorType {
     
     public var message: String
+    public var errorCode = 0
     public var nsError: NSError?
     
     public init(message:String) {
@@ -11,6 +12,8 @@ public class InteractorError: ErrorType {
     
     public init(error:NSError) {
         self.message = error.localizedDescription
+        self.errorCode = error.code
         self.nsError = error
     }
-}
+    
+}
diff --git a/Sources/LazyInteractor.swift b/Sources/LazyInteractor.swift
@@ -25,3 +25,12 @@ class LazyInteractor<InteractorType: Interactor>: Interactor {
     }
     
 }
+
+
+extension LazyInteractor: ErrorHandler {
+    
+    func handleError(request: ErrorRequest, error: ErrorType) {
+        self.getInteractor().handleError(request, error: error)
+    }
+    
+}
diff --git a/Tests/ErrorHandlerExtensionTests.swift b/Tests/ErrorHandlerExtensionTests.swift
@@ -0,0 +1,64 @@
+import XCTest
+@testable import ACInteractor
+
+class ErrorHandlerExtensionTests: XCTestCase {
+    
+    let interactor = TestInteractor()
+    let request = TestInteractor.Request()
+    var onErrorResponse: ErrorType?
+    
+    override func setUp() {
+        super.setUp()
+        // Put setup code here. This method is called before the invocation of each test method in the class.
+        
+        request.onError = { [unowned self] (error: ErrorType) in
+            self.onErrorResponse = error
+        }
+    }
+    
+    // MARK: handleError()
+    
+    func testHandleError_withInteractorError_callsOnError_withInteractorError() {
+        // Arrange
+        let error = InteractorError(message: "TestError")
+        
+        // Act
+        interactor.handleError(request, error: error)
+        
+        // Assert
+        let errorResponse = onErrorResponse as? InteractorError
+        XCTAssert(errorResponse === error)
+    }
+    
+    func testHandleError_withNsError_callsOnError_withWrappedNsError() {
+        // Arrange
+        let nsErrorMessage = "NSError Message"
+        let nsError = NSError(domain: "", code: 0, userInfo: [NSLocalizedDescriptionKey: nsErrorMessage])
+        
+        // Act
+        interactor.handleError(request, error: nsError)
+        
+        // Assert
+        let errorResponse = onErrorResponse as? InteractorError
+        XCTAssertEqual(errorResponse?.message, nsErrorMessage)
+        XCTAssert(errorResponse?.nsError === nsError)
+    }
+
+    
+    // MARK: Test Interactor
+    
+    class TestInteractor: Interactor {
+        class Request: InteractorRequest<Void> {
+        }
+        
+        func execute(request: Request) {
+        }
+    }
+    
+    
+    // MARK: Test Error
+    
+    class TestError: ErrorType {
+    }
+        
+}
diff --git a/Tests/InteractorErrorTests.swift b/Tests/InteractorErrorTests.swift
@@ -39,4 +39,12 @@ class InteractorErrorTests: XCTestCase {
         XCTAssertEqual(error.nsError, nsError)
     }
     
+    func testInit_withNsError_setsErrorCode() {
+        // Act
+        let error = InteractorError(error: nsError)
+        
+        // Assert
+        XCTAssertEqual(error.errorCode, 42)
+    }
+    
 }
diff --git a/Tests/InteractorExecuterTests.swift b/Tests/InteractorExecuterTests.swift
@@ -16,7 +16,7 @@ class InteractorTests: XCTestCase {
         super.setUp()
         // Put setup code here. This method is called before the invocation of each test method in the class.
         
-        firstRequest.onError = { (error: InteractorError) -> Void in
+        firstRequest.onError = { [unowned self] (error: InteractorError) -> Void in
             self.errorMessageFromFirstRequest = error.message
         }
     }
diff --git a/Tests/LazyInteractorTests.swift b/Tests/LazyInteractorTests.swift
@@ -60,14 +60,33 @@ class LazyInteractorTests: XCTestCase {
         XCTAssert(interactor.executedRequest === request)
     }
     
+    // MARK: handleError()
     
-    // MARK: Test Interactors
+    func testHandleError_callsHandleErrorOfInteractor() {
+        // Arrange
+        let request = TestInteractor.Request()
+        let error = InteractorError(message: "TestError")
+        
+        // Act
+        lazyInteractor.handleError(request, error: error)
+        
+        // Assert
+        let interactor = lazyInteractor.getInteractor()
+        XCTAssert(interactor.handledErrorRequest === request)
+        XCTAssert(interactor.handledError as? AnyObject === error)
+    }
+    
+    
+    // MARK: Test Interactor
     
     class TestInteractor: Interactor {
         let dependency: String
         var numberOfExceuteCalls = 0
         var executedRequest: Request?
         
+        var handledErrorRequest: ErrorRequest?
+        var handledError: ErrorType?
+        
         init(dependency: String) {
             self.dependency = dependency
         }
@@ -79,6 +98,11 @@ class LazyInteractorTests: XCTestCase {
             self.numberOfExceuteCalls += 1
             self.executedRequest = request
         }
+        
+        func handleError(request: ErrorRequest, error: ErrorType) {
+            self.handledErrorRequest = request
+            self.handledError = error
+        }
     }
 
 }
diff --git a/Xcode/ACInteractor.xcodeproj/project.pbxproj b/Xcode/ACInteractor.xcodeproj/project.pbxproj
@@ -15,6 +15,8 @@
 		173A77D21D3849E200FF88BA /* ACInteractor.h in Headers */ = {isa = PBXBuildFile; fileRef = 173A77431D3849E100FF88BA /* ACInteractor.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		17567E551D3A61C900C464BB /* InteractorError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 17567E541D3A61C900C464BB /* InteractorError.swift */; };
 		17567E591D3A640000C464BB /* InteractorErrorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 17567E581D3A640000C464BB /* InteractorErrorTests.swift */; };
+		1794818F1D57475000CA3590 /* ErrorHandlerExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 1794818E1D57475000CA3590 /* ErrorHandlerExtension.swift */; };
+		179481921D5749A800CA3590 /* ErrorHandlerExtensionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 179481901D57490900CA3590 /* ErrorHandlerExtensionTests.swift */; };
 		17B0BF701D3CD057004AA98B /* LazyInteractor.swift in Sources */ = {isa = PBXBuildFile; fileRef = 17B0BF6F1D3CD057004AA98B /* LazyInteractor.swift */; };
 		17B0BF721D3CD0A9004AA98B /* LazyInteractorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 17B0BF711D3CD0A9004AA98B /* LazyInteractorTests.swift */; };
 /* End PBXBuildFile section */
@@ -40,6 +42,8 @@
 		173A77D11D3849E200FF88BA /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		17567E541D3A61C900C464BB /* InteractorError.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = InteractorError.swift; sourceTree = "<group>"; };
 		17567E581D3A640000C464BB /* InteractorErrorTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = InteractorErrorTests.swift; sourceTree = "<group>"; };
+		1794818E1D57475000CA3590 /* ErrorHandlerExtension.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ErrorHandlerExtension.swift; sourceTree = "<group>"; };
+		179481901D57490900CA3590 /* ErrorHandlerExtensionTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ErrorHandlerExtensionTests.swift; sourceTree = "<group>"; };
 		17B0BF6F1D3CD057004AA98B /* LazyInteractor.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LazyInteractor.swift; sourceTree = "<group>"; };
 		17B0BF711D3CD0A9004AA98B /* LazyInteractorTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LazyInteractorTests.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
@@ -90,6 +94,7 @@
 				17567E541D3A61C900C464BB /* InteractorError.swift */,
 				173A77381D3844D400FF88BA /* InteractorExecuter.swift */,
 				17B0BF6F1D3CD057004AA98B /* LazyInteractor.swift */,
+				1794818E1D57475000CA3590 /* ErrorHandlerExtension.swift */,
 			);
 			name = Sources;
 			path = ../Sources;
@@ -101,6 +106,7 @@
 				173A77401D38461D00FF88BA /* InteractorExecuterTests.swift */,
 				17567E581D3A640000C464BB /* InteractorErrorTests.swift */,
 				17B0BF711D3CD0A9004AA98B /* LazyInteractorTests.swift */,
+				179481901D57490900CA3590 /* ErrorHandlerExtensionTests.swift */,
 			);
 			name = Tests;
 			path = ../Tests;
@@ -228,6 +234,7 @@
 				173A773C1D3844D400FF88BA /* InteractorExecuter.swift in Sources */,
 				173A773D1D3844D400FF88BA /* InteractorRequest.swift in Sources */,
 				17B0BF701D3CD057004AA98B /* LazyInteractor.swift in Sources */,
+				1794818F1D57475000CA3590 /* ErrorHandlerExtension.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -237,6 +244,7 @@
 			files = (
 				17B0BF721D3CD0A9004AA98B /* LazyInteractorTests.swift in Sources */,
 				173A77411D38461D00FF88BA /* InteractorExecuterTests.swift in Sources */,
+				179481921D5749A800CA3590 /* ErrorHandlerExtensionTests.swift in Sources */,
 				17567E591D3A640000C464BB /* InteractorErrorTests.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import Foundation`
`2`	`2`
`3`		`-public protocol Interactor: AnyObject {`
	`3`	`+public protocol Interactor: AnyObject, ErrorHandler {`
`4`	`4`	`associatedtype Request`
`5`	`5`	`func execute(request: Request)`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,3 +25,12 @@ class LazyInteractor<InteractorType: Interactor>: Interactor {`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`}`
	`28`	`+`
	`29`	`+`
	`30`	`+extension LazyInteractor: ErrorHandler {`
	`31`	`+`
	`32`	`+ func handleError(request: ErrorRequest, error: ErrorType) {`
	`33`	`+ self.getInteractor().handleError(request, error: error)`
	`34`	`+ }`
	`35`	`+`
	`36`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,12 @@ class InteractorErrorTests: XCTestCase {`
`39`	`39`	`XCTAssertEqual(error.nsError, nsError)`
`40`	`40`	`}`
`41`	`41`
	`42`	`+ func testInit_withNsError_setsErrorCode() {`
	`43`	`+ // Act`
	`44`	`+ let error = InteractorError(error: nsError)`
	`45`	`+`
	`46`	`+ // Assert`
	`47`	`+ XCTAssertEqual(error.errorCode, 42)`
	`48`	`+ }`
	`49`	`+`
`42`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class InteractorTests: XCTestCase {`
`16`	`16`	`super.setUp()`
`17`	`17`	`// Put setup code here. This method is called before the invocation of each test method in the class.`
`18`	`18`
`19`		`- firstRequest.onError = { (error: InteractorError) -> Void in`
	`19`	`+ firstRequest.onError = { [unowned self] (error: InteractorError) -> Void in`
`20`	`20`	`self.errorMessageFromFirstRequest = error.message`
`21`	`21`	`}`
`22`	`22`	`}`