feat: added equatable conformance (#88)

* feat: added equatable conformance

* chore: assertions on arrays of screen views

Author: robinphillips

Sources/GDSAnalytics/Screens/ErrorScreenView.swift

@@ -52,3 +52,15 @@ public struct ErrorScreenView<Screen: ScreenType>: ScreenViewProtocol, LoggableE
         hash = error.hash
     }
 }
+
+extension ErrorScreenView: Equatable {
+    public static func == (lhs: Self, rhs: Self) -> Bool {
+        return (
+            type(of: lhs) == type(of: rhs) &&
+            lhs.id == rhs.id &&
+            lhs.screen.name == rhs.screen.name &&
+            lhs.title == rhs.title &&
+            lhs.parameters == rhs.parameters
+        )
+    }
+}

Sources/GDSAnalytics/Screens/ScreenView.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-public protocol ScreenViewProtocol {
+public protocol ScreenViewProtocol: Equatable {
     associatedtype Screen: ScreenType
     var id: String? { get }
     var screen: Screen { get }
@@ -30,3 +30,15 @@ public struct ScreenView<Screen: ScreenType>: ScreenViewProtocol {
         self.title = titleKey.englishString(variableKeys, bundle: bundle).formattedAsParameter
     }
 }
+
+extension ScreenView: Equatable {
+    public static func == (lhs: Self, rhs: Self) -> Bool {
+        return (
+            type(of: lhs) == type(of: rhs) &&
+            lhs.id == rhs.id &&
+            lhs.screen.name == rhs.screen.name &&
+            lhs.title == rhs.title &&
+            lhs.parameters == rhs.parameters
+        )
+    }
+}

Tests/GDSAnalyticsTests/Screens/ErrorScreenViewTests.swift

@@ -81,4 +81,56 @@ final class ErrorScreenViewTests: XCTestCase {
             ]
         )
     }
+    
+    func testEquatableTrue() {
+        let uuid = UUID().uuidString.lowercased()
+        
+        let view1 = ErrorScreenView(
+            id: uuid,
+            screen: MockScreen.error,
+            titleKey: "Something went wrong",
+            reason: "network",
+            endpoint: "appInfo",
+            statusCode: "401",
+            hash: "83766358f64858b51afb745bbdde91bb"
+        )
+        
+        let view2 = ErrorScreenView(
+            id: uuid,
+            screen: MockScreen.error,
+            titleKey: "Something went wrong",
+            reason: "network",
+            endpoint: "appInfo",
+            statusCode: "401",
+            hash: "83766358f64858b51afb745bbdde91bb"
+        )
+        
+        XCTAssertEqual(view1, view2)
+    }
+    
+    func testEquatableFalse() {
+        let uuid = UUID().uuidString.lowercased()
+        
+        let view1 = ErrorScreenView(
+            id: uuid,
+            screen: MockScreen.error,
+            titleKey: "Something went wrong",
+            reason: "network",
+            endpoint: "appInfo",
+            statusCode: "401",
+            hash: "83766358f64858b51afb745bbdde91bb"
+        )
+        
+        let view2 = ErrorScreenView(
+            id: uuid,
+            screen: MockScreen.error,
+            titleKey: "Went wrong",
+            reason: "network",
+            endpoint: "appInfo",
+            statusCode: "401",
+            hash: "83766358f64858b51afb745bbdde91bb"
+        )
+        
+        XCTAssertNotEqual(view1, view2)
+    }
 }

Tests/GDSAnalyticsTests/Screens/ScreenViewTests.swift

@@ -39,4 +39,60 @@ final class ScreenViewTests: XCTestCase {
             ["is_error": "false"]
         )
     }
+    
+    func testEquatableTrue() {
+        let view1 = ScreenView(
+            screen: MockScreen.welcome,
+            titleKey: "Welcome to this app with a really really really really really really really really really really long name"
+        )
+        
+        let view2 = ScreenView(
+            screen: MockScreen.welcome,
+            titleKey: "Welcome to this app with a really really really really really really really really really really long name"
+        )
+        
+        XCTAssertEqual(view1, view2)
+    }
+    
+    func testEquatableArray() {
+        let view1 = ScreenView(
+            screen: MockScreen.welcome,
+            titleKey: "Welcome to this app with a really really really really really really really really really really long name"
+        )
+        
+        let view2 = ScreenView(
+            screen: MockScreen.welcome,
+            titleKey: "Welcome to this app with a really really really really really really really really really really long name"
+        )
+        
+        XCTAssertEqual([view1], [view2])
+    }
+    
+    func testEquatableFalse() {
+        let view1 = ScreenView(
+            screen: MockScreen.welcome,
+            titleKey: "Welcome to this app with a really really really really really really really really really really long name"
+        )
+        
+        let view2 = ScreenView(
+            screen: MockScreen.error,
+            titleKey: "Welcome to this app with a really really really really really really really really really really long name"
+        )
+        
+        XCTAssertNotEqual(view1, view2)
+    }
+    
+    func testEquatableArrayFalse() {
+        let view1 = ScreenView(
+            screen: MockScreen.welcome,
+            titleKey: "Welcome to this app with a really really really really really really really really really really long name"
+        )
+        
+        let view2 = ScreenView(
+            screen: MockScreen.error,
+            titleKey: "Welcome to this app with a really really really really really really really really really really long name"
+        )
+        
+        XCTAssertNotEqual([view1], [view2])
+    }
 }