[Issue-46] Add a separate rgbDebugDisplayString method

Author: Mark Pospesel

Sources/YCoreUI/Extensions/UIKit/UIColor+rgbValue.swift

@@ -15,6 +15,19 @@ public extension UIColor {
     ///   - isUppercase: whether the hex values should be upper or lower case
     /// - Returns: the formatted hexadecimal string
     func rgbDisplayString(prefix: String? = nil, isUppercase: Bool = true) -> String {
+        _rgbDisplayString(prefix: prefix, isUppercase: isUppercase, isDebug: false)
+    }
+
+    /// Formats a color as an RGB hexadecimal string. Appropriate for debug printing.
+    /// - Parameters:
+    ///   - prefix: optional prefix to precede the hexadecimal value such as `0x` or `#` (default = nil)
+    ///   - isUppercase: whether the hex values should be upper or lower case
+    /// - Returns: the formatted hexadecimal string (with an `⚠️` for colors that fall outside of the sRGB color space)
+    func rgbDebugDisplayString(prefix: String? = nil, isUppercase: Bool = true) -> String {
+        _rgbDisplayString(prefix: prefix, isUppercase: isUppercase, isDebug: true)
+    }
+
+    private func _rgbDisplayString(prefix: String?, isUppercase: Bool, isDebug: Bool) -> String {
         let comp = rgbaComponents
         let format = isUppercase ? "%02X%02X%02X" : "%02x%02x%02x"
         let r = Int(round(comp.red * 255))
@@ -30,6 +43,6 @@ public extension UIColor {
         if !isRGB && YCoreUI.isLoggingEnabled {
             YCoreUI.colorLogger.warning("Color \(self) falls outside of the sRGB color space.")
         }
-        return "\(prefix ?? "")\(value)\(isRGB ? "" : "⚠️")"
+        return "\(prefix ?? "")\(value)\(isDebug && !isRGB ? "⚠️" : "")"
     }
 }

Tests/YCoreUITests/Extensions/UIKit/UIColor+rgbValueTests.swift

@@ -47,6 +47,8 @@ final class UIColorRgbValueTests: XCTestCase {
     func testSuffixes() {
         testCases.forEach {
             XCTAssertFalse($0.color.rgbDisplayString().hasSuffix("⚠️"))
+            XCTAssertFalse($0.color.rgbDebugDisplayString().hasSuffix("⚠️"))
+            XCTAssertEqual($0.color.rgbDisplayString(), $0.color.rgbDebugDisplayString())
         }
 
         let p3Colors = [
@@ -65,7 +67,8 @@ final class UIColorRgbValueTests: XCTestCase {
         ]
 
         p3Colors.forEach {
-            XCTAssertTrue($0.rgbDisplayString().hasSuffix("⚠️"))
+            XCTAssertFalse($0.rgbDisplayString().hasSuffix("⚠️"))
+            XCTAssertTrue($0.rgbDebugDisplayString().hasSuffix("⚠️"))
             YCoreUI.isLoggingEnabled = false
         }