more updates to ReadMe

Signed-off-by: Matt Bruce <mbrucedogs@gmail.com>

EmployeeDirectory/Extensions/String.swift

@@ -12,11 +12,9 @@ extension String {
     /// Non-numeric characters are removed, and formatting is applied based on the length of the string.
     /// - Returns: A formatted phone number as a string.
     internal func formatUSNumber() -> String {
-        // format the number
-        return format(with: "XXX-XXX-XXXX", phone: self)
-    }
-    
-    internal func format(with mask: String, phone: String) -> String {
+        // mask for the phone numver
+        let mask = "XXX-XXX-XXXX"
+        
         let numbers = filter { $0.isNumber }
         var result = ""
         var index = numbers.startIndex // numbers iterator
@@ -35,6 +33,6 @@ extension String {
             }
         }
         return result
-    }
+    }    
 }
 

EmployeeDirectory/Extensions/URL.swift

@@ -8,6 +8,8 @@ import Foundation
 import CryptoKit
 
 extension URL {
+    
+    /// This will has the URL absoluteString into a that is consistent.
     internal var uniqueIdentifier: String {
         let data = Data(absoluteString.utf8)
         let hash = SHA256.hash(data: data)

EmployeeDirectory/Models/Employees.swift

@@ -8,6 +8,8 @@ import Foundation
 
 /// Wrapper JSON Class for the Employees
 public struct Employees: Codable {
+        
+    /// Array of Employees
     public var employees: [Employee]
     
     private enum CodingKeys: String, CodingKey {

EmployeeDirectory/Protocols/EmployeeServiceProtocol.swift

@@ -5,6 +5,12 @@
 //  Created by Matt Bruce on 1/20/25.
 //
 
+
+/// This will be the interface for the API for Employees
 public protocol EmployeeServiceProtocol {
+    
+    /// This will get a list of all employees
+    /// - Parameter serviceMode: Mode in which to hit.
+    /// - Returns: An Employees struct
     func getEmployees(_ serviceMode: EmployeeServiceMode) async throws -> Employees
 }

EmployeeDirectory/Services/EmployeeService.swift

@@ -12,6 +12,7 @@ public enum EmployeeServiceMode: String, CaseIterable {
     case malformed
     case empty
     
+    /// Enpoint in which to grabe employees from.
     public var endpoint: String {
         switch self {
         case .production:
@@ -26,11 +27,18 @@ public enum EmployeeServiceMode: String, CaseIterable {
 
 /// Service Layer for Employees
 public class EmployeeService: EmployeeServiceProtocol {
-    
+    // MARK: - Properties
+    public static let shared = EmployeeService() // Default shared instance
+
+    // MARK: - Initializer
+
     public init() {}
     
-    /// Service to get Employees
-    /// - Returns: Array of Employee Structs
+    // MARK: - Public Methods
+
+    /// This will get a list of all employees
+    /// - Parameter serviceMode: Mode in which to hit.
+    /// - Returns: An Employees struct
     public func getEmployees(_ serviceMode: EmployeeServiceMode = .production) async throws -> Employees {
         return try await NetworkService.shared.fetchData(from: serviceMode.endpoint, as: Employees.self)
     }

EmployeeDirectory/Services/ImageCacheService.swift

@@ -8,49 +8,80 @@
 import Foundation
 import UIKit
 
+/// A service that handles image caching using memory, disk, and network in priority order.
 public class ImageCacheService {
+    // MARK: - Properties
     public static let shared = ImageCacheService() // Default shared instance
 
+    /// Memory cache for storing images in RAM.
     private let memoryCache = NSCache<NSString, UIImage>()
+    
+    /// File manager for handling disk operations.
     private let fileManager = FileManager.default
+    
+    /// Directory where cached images are stored on disk.
     private let cacheDirectory: URL = {
-       FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask)[0]
+        FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask)[0]
     }()
     
+    // MARK: - Initializer
+    
     public init() {}
 
+    // MARK: - Public Methods
+    
+    /// Loads an image from memory, disk, or network.
+    ///
+    /// - Parameter url: The URL of the image to load.
+    /// - Returns: The loaded `UIImage` or `nil` if the image could not be loaded.
     public func loadImage(from url: URL) async -> UIImage? {
         let uniqueKey = url.uniqueIdentifier
         let cacheKey = uniqueKey as NSString
-    
+
+        // Step 1: Check the memory cache
         if let cachedImage = memoryCache.object(forKey: cacheKey) {
             return cachedImage
         }
         
+        // Step 2: Check the disk cache
         let diskImagePath = cacheDirectory.appendingPathComponent(uniqueKey)
         if let diskImage = UIImage(contentsOfFile: diskImagePath.path) {
-            memoryCache.setObject(diskImage, forKey: cacheKey)
+            memoryCache.setObject(diskImage, forKey: cacheKey) // Cache in memory for faster access next time
             return diskImage
         }
         
+        // Step 3: Fetch the image from the network
         if let networkImage = await fetchFromNetwork(url: url) {
-            memoryCache.setObject(networkImage, forKey: cacheKey)
-            try? saveImageToDisk(image: networkImage, at: diskImagePath)
+            memoryCache.setObject(networkImage, forKey: cacheKey) // Cache in memory
+            try? saveImageToDisk(image: networkImage, at: diskImagePath) // Cache on disk
             return networkImage
         }
         
+        // Step 4: Return nil if all options fail
         return nil
     }
     
+    // MARK: - Private Methods
+    
+    /// Fetches an image from the network.
+    ///
+    /// - Parameter url: The URL of the image to fetch.
+    /// - Returns: The fetched `UIImage` or `nil` if the network request fails.
     private func fetchFromNetwork(url: URL) async -> UIImage? {
         do {
             let (data, _) = try await URLSession.shared.data(from: url)
             return UIImage(data: data)
         } catch {
+            print("Failed to fetch image from network for URL: \(url). Error: \(error)")
             return nil
         }
     }
     
+    /// Saves an image to disk at the specified path.
+    ///
+    /// - Parameters:
+    ///   - image: The `UIImage` to save.
+    ///   - path: The file path where the image should be saved.
     private func saveImageToDisk(image: UIImage, at path: URL) throws {
         guard let data = image.pngData() else { return }
         try data.write(to: path)

EmployeeDirectory/Services/NetworkService.swift

@@ -26,15 +26,22 @@ public enum NetworkServiceError: Error {
 
 public class NetworkService {
     
+    // MARK: - Properties
+
     public static let shared = NetworkService() // Default shared instance
 
     private let session: URLSession
 
+
+    // MARK: - Initializer
+
     /// Public initializer to allow customization
     public init(session: URLSession = .shared) {
         self.session = session
     }
 
+    // MARK: - Public Methods
+
     /// Fetches data from a URL and decodes it into a generic Decodable type.
     /// - Parameters:
     ///   - endpoint: The url to fetch data from.

EmployeeDirectory/ViewControllers/EmployeesViewController.swift

@@ -9,13 +9,30 @@ import UIKit
 import Combine
 
 class EmployeesViewController: UIViewController {
+    
+    // MARK: - Properties
+
+    
+    /// List for the employees
     private let tableView = UITableView()
+    
+    /// Will only show when fetching data occurs
     private let activityIndicator = UIActivityIndicatorView(style: .large)
+    
+    /// Allows the user to pick between service modes
     private let modeSegmentedControl = UISegmentedControl(items: EmployeeServiceMode.allCases.map{ $0.rawValue } )
+    
+    /// ViewModel in which drives the screen
     private let viewModel = EmployeesViewModel()
+    
+    /// Holds onto the ViewModels Subscribers
     private var cancellables = Set<AnyCancellable>()
+    
+    /// Will show specific state of the viewModel
     private var footerView: TableFooterView?
     
+    // MARK: - Public Methods
+
     public override func viewDidLoad() {
         super.viewDidLoad()
         setupUI()
@@ -23,6 +40,9 @@ class EmployeesViewController: UIViewController {
         viewModel.fetchEmployees()
     }
     
+    // MARK: - Private Methods
+        
+    /// Setup the UI by adding the views to the main view
     private func setupUI() {
         view.backgroundColor = .white
         
@@ -46,6 +66,7 @@ class EmployeesViewController: UIViewController {
         navigationItem.titleView = modeSegmentedControl
     }
     
+    /// Using the ViewModel setup combine handlers
     private func bindViewModel() {
         viewModel.$employees
             .receive(on: RunLoop.main)
@@ -74,7 +95,8 @@ class EmployeesViewController: UIViewController {
             }
             .store(in: &cancellables)
     }
-        
+    
+    /// Show state in specific use-cases for the EmployeesViewModel
     private func updateFooter() {
         var message: String? {
             guard !viewModel.isLoading else { return nil }
@@ -96,11 +118,16 @@ class EmployeesViewController: UIViewController {
     }
 }
 
+// Mark: - Objective-C Methods
 extension EmployeesViewController {
+    
+    /// Fetch the Employees
     @objc private func didPullToRefresh() {
         viewModel.fetchEmployees()
     }
     
+    /// This will handle services changes to test conditions to ensure UI works correctly.
+    /// - Parameter sender: Mode in which to test
     @objc private func onServiceModeChange(_ sender: UISegmentedControl) {
         let selectedMode: EmployeeServiceMode
         switch sender.selectedSegmentIndex {
@@ -113,6 +140,7 @@ extension EmployeesViewController {
     }
 }
 
+/// Mark: - UITableViewDataSource
 extension EmployeesViewController: UITableViewDataSource {
     public func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
         return viewModel.employees.count

EmployeeDirectory/ViewModels/EmployeeCellViewModel.swift

@@ -8,8 +8,11 @@
 import Foundation
 import UIKit
 
+/// ViewModel that will be used along with the EmployeeTableViewCell.
 @MainActor
 public class EmployeeCellViewModel: ObservableObject {
+    // MARK: - Properties
+
     private let employee: Employee
     
     public private(set) var uuid: String
@@ -21,18 +24,21 @@ public class EmployeeCellViewModel: ObservableObject {
     public private(set) var employeeType: String
     @Published public private(set) var smallPhoto: UIImage?
     
+    // MARK: - Initializer
+
     public init(employee: Employee) {
         self.employee = employee
         
         // Initialize properties
-        self.uuid = employee.uuid.uuidString
-        self.fullName = employee.fullName
-        self.phoneNumber = employee.phoneNumber?.formatUSNumber()
-        self.emailAddress = employee.emailAddress
-        self.biography = employee.biography
-        self.team = employee.team
-        self.employeeType = employee.employeeType.description
+        uuid = employee.uuid.uuidString
+        fullName = employee.fullName
+        phoneNumber = employee.phoneNumber?.formatUSNumber()
+        emailAddress = employee.emailAddress
+        biography = employee.biography
+        team = employee.team
+        employeeType = employee.employeeType.description
         
+        // Fetch the image for the url if it exists
         if let endpoint = employee.photoURLSmall {
             Task{
                 if let smallPhotoURL = URL(string: endpoint) {

EmployeeDirectory/ViewModels/EmployeesViewModel.swift

@@ -7,18 +7,17 @@
 
 import Foundation
 
+/// ViewModel that will be bound to an Employees model and used
+/// specifically with the EmployeesViewController.
 @MainActor
 public class EmployeesViewModel: ObservableObject {
-    private let service: EmployeeService
     private var serviceMode: EmployeeServiceMode = .production
 
     @Published public private(set) var employees: [Employee] = []
     @Published public private(set) var errorMessage: String? = nil
     @Published public private(set) var isLoading: Bool = false
     
-    public init(service: EmployeeService = EmployeeService()) {
-        self.service = service
-    }
+    public init() {}
     
     public func fetchEmployees() {
         // resetting values out the values before fetching new data
@@ -28,17 +27,17 @@ public class EmployeesViewModel: ObservableObject {
         Task {
             do {
                 // Fetch employees using the async method
-                let wrapper = try await service.getEmployees(serviceMode)
+                let wrapper = try await EmployeeService.shared.getEmployees(serviceMode)
                 
                 // Update published properties
-                self.employees = wrapper.employees
-                self.isLoading = false
+                employees = wrapper.employees
+                isLoading = false
 
             } catch {
                 // Handle errors
-                self.employees = []
-                self.isLoading = false
-                self.errorMessage = "An unexpected error occurred, please try to refresh"
+                employees = []
+                isLoading = false
+                errorMessage = "An unexpected error occurred, please try to refresh"
             }
         }
 

EmployeeDirectory/Views/EmployeeTableViewCell.swift

@@ -7,9 +7,17 @@
 import UIKit
 import Combine
 
+/// This is the Cell used in the EmployeesTableViewController to show
+/// the properties of an Employee model.
 public class EmployeeTableViewCell: UITableViewCell {
-    static let identifier = "EmployeeTableViewCell"
     
+    /// Used in the TableView registration
+    static let identifier = "EmployeeTableViewCell"
+
+    // MARK: - Properties
+
+    
+    /// UI Elements
     private let photoImageView = UIImageView()
     private let nameLabel = UILabel()
     private let emailLabel = UILabel()
@@ -19,7 +27,10 @@ public class EmployeeTableViewCell: UITableViewCell {
     private let bioLabel = UILabel()
     private let stackView = UIStackView()
     
-    private var cancellable: AnyCancellable?
+    /// Used for grabbing the photo
+    private var smallPhotoSubscriber: AnyCancellable?
+
+    // MARK: - Initializer
 
     public override init(style: UITableViewCell.CellStyle, reuseIdentifier: String?) {
         super.init(style: style, reuseIdentifier: reuseIdentifier)
@@ -30,6 +41,8 @@ public class EmployeeTableViewCell: UITableViewCell {
         fatalError("init(coder:) has not been implemented")
     }
     
+    // MARK: - Private Methods
+    
     private func setupUI() {
         // Configure photoImageView
         photoImageView.contentMode = .scaleAspectFill
@@ -93,9 +106,13 @@ public class EmployeeTableViewCell: UITableViewCell {
         ])
     }
     
+    // MARK: - Public Methods
+
+    
+    /// Override for setting back to a default state
     public override func prepareForReuse() {
         super.prepareForReuse()
-        cancellable = nil
+        smallPhotoSubscriber = nil
         photoImageView.image = UIImage(systemName: "person.crop.circle")
         nameLabel.text = nil
         emailLabel.text = nil
@@ -105,10 +122,12 @@ public class EmployeeTableViewCell: UITableViewCell {
         bioLabel.text = nil
     }
 
+    /// Configures the UI Elements with the properties of the EmployeeCellViewModel.
+    /// - Parameter viewModel: Employee Model wrapped for Cell.
     public func configure(with viewModel: EmployeeCellViewModel) {
 
         // Bind the image to the photoImageView
-        cancellable = viewModel.$smallPhoto
+        smallPhotoSubscriber = viewModel.$smallPhoto
             .receive(on: DispatchQueue.main)
             .sink { [weak self] image in
                 self?.photoImageView.image = image

EmployeeDirectory/Views/TableFooterView.swift

@@ -6,8 +6,11 @@
 //
 import UIKit
 
+/// Meant to be used as a Message for State in a TableView.
 public class TableFooterView: UIView {
     
+    // MARK: - Properties
+
     /// Label used to show the message
     private let messageLabel: UILabel = {
         let label = UILabel()
@@ -20,6 +23,8 @@ public class TableFooterView: UIView {
         return label
     }()
     
+    // MARK: - Initializer
+
     init(message: String) {
         super.init(frame: .zero)
         setupUI()
@@ -30,6 +35,8 @@ public class TableFooterView: UIView {
         fatalError("init(coder:) has not been implemented")
     }
     
+    // MARK: - Private Methods
+
     /// Setup the UI
     private func setupUI() {
         addSubview(messageLabel)
@@ -41,7 +48,8 @@ public class TableFooterView: UIView {
         ])
     }
     
-    
+    // MARK: - Public Methods
+
     /// Updates the Current Message
     /// - Parameter message: message to show
     public func update(message: String) {

EmployeeDirectoryTests/EmployeeDirectoryTests.swift

@@ -6,7 +6,6 @@
 //
 
 import Testing
-import XCTest
 
 @testable import EmployeeDirectory
 
@@ -14,36 +13,57 @@ struct EmployeeDirectoryTests {
     
     @Test func getEmployeesValid() async throws {
         do {
-            let wrapper = try await EmployeeService().getEmployees(.production)
+            let wrapper = try await EmployeeService.shared.getEmployees(.production)
             #expect(wrapper.employees.count == 11)
         } catch {
-            XCTFail("Unexpected error: \(error)")
+            #expect(Bool(false), "Unexpected error: \(error)")
         }
     }
     
     @Test func getEmployeesMalformed() async throws {
         do {
-            let wrapper = try await EmployeeService().getEmployees(.malformed)
-            XCTFail("Expected to throw, but got \(wrapper.employees.count) employees")
+            _ = try await EmployeeService.shared.getEmployees(.malformed)
+            #expect(Bool(false), "Expected invalidResponse error, but no error was thrown")
         } catch let error as NetworkServiceError {
             switch error {
-            case .invalidResponse:
-                XCTAssertTrue(true, "Correctly threw invalidResponse error")
+            case .decodingError(let decodingError):
+                #expect(Bool(true), "Expected NetworkServiceError.decodingError, but got \(decodingError)")
             default:
-                XCTFail("Expected NetworkServiceError.invalidResponse, but got \(error)")
+                #expect(Bool(false), "Expected NetworkServiceError.decodingError, but got \(error)")
             }
         } catch {
-            XCTFail("Unexpected error: \(error)")
+            #expect(Bool(false), "Unexpected error: \(error)")
         }
+
     }
     
     @Test func getEmployeesEmpty() async throws {
         do {
-            let wrapper = try await EmployeeService().getEmployees(.empty)
+            let wrapper = try await EmployeeService.shared.getEmployees(.empty)
             #expect(wrapper.employees.count == 0)
         } catch {
-            XCTFail("Unexpected error: \(error)")
+            #expect(Bool(false), "Unexpected error: \(error)")
         }
     }
 
 }
+
+// Testing extension since this isn't needed in the code.
+extension NetworkServiceError: @retroactive Equatable {
+    public static func == (lhs: NetworkServiceError, rhs: NetworkServiceError) -> Bool {
+        switch (lhs, rhs) {
+        case (.invalidResponse, .invalidResponse):
+            return true
+        case (.invalidURL, .invalidURL):
+            return true
+        case (.decodingError(let lhsError), .decodingError(let rhsError)):
+            return lhsError.localizedDescription == rhsError.localizedDescription
+        case (.networkError(let lhsError), .networkError(let rhsError)):
+            return lhsError.code == rhsError.code
+        case (.unknownError(let lhsError), .unknownError(let rhsError)):
+            return lhsError.localizedDescription == rhsError.localizedDescription
+        default:
+            return false
+        }
+    }
+}

README.MD

@@ -1,21 +1,39 @@
 # Employee Directory
 
 ## Build tools & versions used
+Xcode 16.2, built with Swift 5.9.
 
 ## Steps to run the app
+No additional steps are required. Simply build and run the project. The app supports iPhone and iPad in portrait mode.
 
 ## What areas of the app did you focus on?
+I focused on designing a robust architecture using a separation of concerns approach. I also implemented a functional UI for the employee directory.
 
 ## What was the reason for your focus? What problems were you trying to solve?
+My primary goal was to ensure the app's architecture was clean, modular, and easy to maintain or extend. I aimed to minimize tightly coupled code and ensure future features could be added with minimal changes. This approach improves testability and makes the codebase easier for others to understand and work with.
 
 ## How long did you spend on this project?
+Approximately 5 hours:
+- 4 hours on development and testing.
+- 1 hour on code refinement, documentation, and ensuring best practices.
 
 ## Did you make any trade-offs for this project? What would you have done differently with more time?
+**Trade-offs**:
+- The networking layer currently lacks a request builder. This limits the ability to add query parameters or authentication headers in a structured way.
+- The UI uses standard UIKit components, which could be improved for a more modern or visually appealing design.
+
+**With more time**, I would:
+- Implement a dedicated `RequestBuilder` to make the networking layer more flexible and extensible.
+- Enhance the UI by incorporating more modern design elements, animations, and responsiveness.
+- Expand test coverage to include additional edge cases and integration tests.
 
 ## What do you think is the weakest part of your project?
+The weakest areas are:
+- The UI, which is functional but minimal, using standard UIKit elements.
+- The networking layer, which, while functional, would benefit from additional abstraction (e.g., `RequestBuilder`) to handle authentication or dynamic query parameters more effectively.
 
 ## Did you copy any code or dependencies? Please make sure to attribute them here!
-### String.swift extension for dealing with TelephoneNumber from a generic regEx formatter I found on stackoverflow.
- 
-## Is there any other information you’d like us to know?
+I adapted a regular expression-based string extension for phone number formatting from a Stack Overflow post. While the logic was modified for this project, credit is due to the original author for the inspiration.
 
+## Is there any other information you’d like us to know?
+When building projects from scratch, I prioritize setting up the API/Service/Model layer and validating it with tests before focusing on the UI. My strengths lie in designing clean, scalable app architectures. While I am proficient in UIKit, I am less experienced with SwiftUI but eager to continue improving in that area.