More refactoring

Author: goergisn

Sources/Helpers/LogFileLogger.swift renamed to Sources/Helpers/Logging/LogFileLogger.swift

@@ -0,0 +1,32 @@
+import Foundation
+
+enum LogLevel {
+    /// No logs
+    case quiet
+    /// All logs except `debug`
+    case `default`
+    /// All logs
+    case debug
+    
+    var shouldLog: Bool {
+        switch self {
+        case .quiet:
+            return false
+        case .default:
+            return true
+        case .debug:
+            return true
+        }
+    }
+    
+    var shouldDebugLog: Bool {
+        switch self {
+        case .quiet:
+            return false
+        case .default:
+            return false
+        case .debug:
+            return true
+        }
+    }
+}

Sources/Helpers/Logging/LogLevel.swift

@@ -1,9 +1,3 @@
-//
-// Copyright (c) 2024 Adyen N.V.
-//
-// This file is open source and available under the MIT license. See the LICENSE file for more info.
-//
-
 import Foundation
 import OSLog
 

Sources/Helpers/LoggingGroup.swift renamed to Sources/Helpers/Logging/LoggingGroup.swift

@@ -1,30 +1,18 @@
 import Foundation
 
-fileprivate enum ChangeType {
-    case change(old: String, new: String)
-    case removal(String)
-    case addition(String)
-    
-    var title: String {
-        switch self {
-        case .change: "Changed"
-        case .removal: "Removed"
-        case .addition: "Added"
-        }
-    }
-    
-    static func `for`(oldValue: String?, newValue: String?) -> Self? {
-        if oldValue == newValue { return nil }
-        if let oldValue, let newValue { return .change(old: oldValue, new: newValue) }
-        if let oldValue { return .removal(oldValue) }
-        if let newValue { return .addition(newValue) }
-        return nil
-    }
-}
-
 extension SwiftInterfaceElement {
 
-    func diffDescription(propertyType: String?, oldValue: String?, newValue: String?) -> [String] {
+    /// Returns a description for a change between an old and new value
+    /// - Parameters:
+    ///   - propertyType: The (optional) property type name (e.g. "accessor", "modifier", "generic where clause", ...) for additional information
+    ///   - oldValue: The (optional) old value
+    ///   - newValue: The (optional) new value
+    /// - Returns: A list with a single item that represents a change description caused by a value change
+    func diffDescription(
+        propertyType: String?,
+        oldValue: String?,
+        newValue: String?
+    ) -> [String] {
 
         guard let changeType: ChangeType = .for(oldValue: oldValue, newValue: newValue) else { return [] }
 
@@ -47,6 +35,12 @@ extension SwiftInterfaceElement {
         return [diffDescription]
     }
 
+    /// Returns a list of change descriptions for changes between the old and new values
+    /// - Parameters:
+    ///   - propertyType: The (optional) property type name (e.g. "accessor", "modifier", "generic where clause", ...) for additional information
+    ///   - oldValue: The (optional) old values
+    ///   - newValue: The (optional) new values
+    /// - Returns: A list of change descriptions caused by a value change
     func diffDescription(propertyType: String, oldValues: [String]?, newValues: [String]?) -> [String] {
 
         if let oldValues, let newValues {
@@ -68,3 +62,28 @@ extension SwiftInterfaceElement {
         return []
     }
 }
+
+// MARK: -
+
+/// File-private helper to produce detailed descriptions
+fileprivate enum ChangeType {
+    case change(old: String, new: String)
+    case removal(String)
+    case addition(String)
+    
+    var title: String {
+        switch self {
+        case .change: "Changed"
+        case .removal: "Removed"
+        case .addition: "Added"
+        }
+    }
+    
+    static func `for`(oldValue: String?, newValue: String?) -> Self? {
+        if oldValue == newValue { return nil }
+        if let oldValue, let newValue { return .change(old: oldValue, new: newValue) }
+        if let oldValue { return .removal(oldValue) }
+        if let newValue { return .addition(newValue) }
+        return nil
+    }
+}

Sources/Helpers/SystemLogger.swift renamed to Sources/Helpers/Logging/SystemLogger.swift

@@ -55,34 +55,6 @@ protocol ProjectAnalyzing {
     ) throws -> ProjectAnalyzerResult
 }
 
-enum LogLevel {
-    case quiet
-    case `default`
-    case debug
-    
-    var shouldLog: Bool {
-        switch self {
-        case .quiet:
-            return false
-        case .default:
-            return true
-        case .debug:
-            return true
-        }
-    }
-    
-    var shouldDebugLog: Bool {
-        switch self {
-        case .quiet:
-            return false
-        case .default:
-            return false
-        case .debug:
-            return true
-        }
-    }
-}
-
 protocol Logging {
 
     func log(_ message: String, from subsystem: String)