[CM-929] Added colorable protocol

Author: PanchamiShenoy

Package.swift

@@ -22,7 +22,8 @@ let package = Package(
         ),
         .testTarget(
             name: "YCoreUITests",
-            dependencies: ["YCoreUI"]
+            dependencies: ["YCoreUI"],
+            resources: [.process("Assets")]
         )
     ]
 )

Sources/YCoreUI/Protocols/Colorable.swift

@@ -0,0 +1,53 @@
+//
+//  Colorable.swift
+//
+//  Created by Y Media Labs on 25/10/22.
+//
+import UIKit
+
+///  Protocol for string based enum that has names of color assets
+public protocol Colorable: RawRepresentable where RawValue == String {
+    /// The bundle containing the localized strings for this enum
+    static var bundle: Bundle { get }
+
+    /// Namespace for color asset
+    static var namespace: String? { get }
+    
+    /// Color to display error cases
+    static var fallbackColor: UIColor { get }
+    
+    /// Color to be displayed based on namespace
+    /// - Returns: Color to be displayed
+    func loadColor() -> UIColor?
+    
+    /// Color to be displayed
+    var color: UIColor { get }
+}
+
+/// Default implementation the `Colorable`
+extension Colorable {
+    /// The bundle containing the localized strings
+    static var bundle: Bundle { .main }
+
+    /// Namespace for color asset
+    static var namespace: String? { nil }
+    
+    /// Color to display error cases
+    static var fallbackColor: UIColor { .systemPink }
+    
+    /// Color to be displayed based on namespace
+    /// - Returns: Color to be displayed
+    func loadColor() -> UIColor? {
+        let name: String
+        if let validNamespace = Self.namespace {
+            name = "\(validNamespace)/\(rawValue)"
+        } else {
+            name = rawValue
+        }
+        return UIColor(named: name, in: Self.bundle, compatibleWith: nil)
+    }
+    
+    /// Color to be displayed  
+    var color: UIColor { loadColor() ?? Self.fallbackColor }
+    
+}

Tests/YCoreUITests/Assets/Colors/Media.xcassets/Contents.json

@@ -0,0 +1,6 @@
+{
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Tests/YCoreUITests/Assets/Colors/Media.xcassets/Error/Contents.json

@@ -0,0 +1,9 @@
+{
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  },
+  "properties" : {
+    "provides-namespace" : true
+  }
+}

Tests/YCoreUITests/Assets/Colors/Media.xcassets/Error/error100.colorset/Contents.json

@@ -0,0 +1,20 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0.824",
+          "green" : "0.835",
+          "red" : "1.000"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Tests/YCoreUITests/Assets/Colors/Media.xcassets/Error/error50.colorset/Contents.json

@@ -0,0 +1,20 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0.945",
+          "green" : "0.949",
+          "red" : "1.000"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Tests/YCoreUITests/Assets/Colors/Media.xcassets/warning100.colorset/Contents.json

@@ -0,0 +1,20 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0.690",
+          "green" : "0.784",
+          "red" : "0.984"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Tests/YCoreUITests/Assets/Colors/Media.xcassets/warning50.colorset/Contents.json

@@ -0,0 +1,20 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0.780",
+          "green" : "0.820",
+          "red" : "0.949"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Tests/YCoreUITests/Extensions/UIKit/ColorableProtocolTest.swift

@@ -0,0 +1,56 @@
+//
+//  ColorableProtocolTest.swift
+//  
+//
+//  Created by Y Media Labs on 26/10/22.
+//
+
+import XCTest
+@testable import YCoreUI
+
+final class ColorableProtocolTest: XCTestCase {
+    
+    func testColorsWithoutNamespace() {
+        WarningColors.allCases.forEach {
+            let color = $0.color
+            XCTAssertNotEqual(color, .systemPink)
+        }
+    }
+    
+    func testColorsWithNamespace() {
+        ErrorColors.allCases.forEach {
+            let color = $0.color
+            XCTAssertNotEqual(color, .systemPink)
+        }
+    }
+    
+    func testInvalidColor() {
+        PrimaryColors.allCases.forEach {
+            let color = $0.color
+            XCTAssertEqual(color, .systemPink)
+        }
+    }
+    
+    
+    enum ErrorColors: String, CaseIterable, Colorable {
+        case error50
+        case error100
+        
+        public static var bundle: Bundle { .module }
+    }
+    
+    enum WarningColors: String, CaseIterable, Colorable {
+        case warning50
+        case warning100
+        
+        public static var bundle: Bundle { .module }
+    }
+    
+    enum PrimaryColors: String, CaseIterable, Colorable {
+        case primary50
+        case primary100
+        
+        public static var bundle: Bundle { .module }
+    }
+    
+}