mbrucedogs/block-employee-directory
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: mbrucedogs:8efd109a4627c99bb1582b8d18ba85b0f4df0ecc
Branches Tags
mbrucedogs:develop
mbrucedogs:requestBuilder-search
mbrucedogs:requestBuilder
mbrucedogs:search
mbrucedogs:bugfix/afterSubmittal
mbrucedogs:main
..
compare: mbrucedogs:0895013cdcf7c3099f5df08001404f266cd756c0
Branches Tags
mbrucedogs:requestBuilder-search
mbrucedogs:requestBuilder
mbrucedogs:search
mbrucedogs:bugfix/afterSubmittal
mbrucedogs:develop
mbrucedogs:main

No commits in common. "8efd109a4627c99bb1582b8d18ba85b0f4df0ecc" and "0895013cdcf7c3099f5df08001404f266cd756c0" have entirely different histories.
8efd109a46 ... 0895013cdc

14 changed files with 51 additions and 183 deletions
Show Stats Expand all files Collapse all files

6
EmployeeDirectory.xcodeproj/project.pbxproj
View File

@ -301,7 +301,8 @@
INFOPLIST_FILE = EmployeeDirectory/Info.plist;
INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES;
INFOPLIST_KEY_UILaunchStoryboardName = LaunchScreen;
INFOPLIST_KEY_UISupportedInterfaceOrientations = UIInterfaceOrientationPortrait;
INFOPLIST_KEY_UISupportedInterfaceOrientations_iPad = "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
INFOPLIST_KEY_UISupportedInterfaceOrientations_iPhone = "UIInterfaceOrientationPortrait UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
LD_RUNPATH_SEARCH_PATHS = (
"$(inherited)",
"@executable_path/Frameworks",
@ -327,7 +328,8 @@
INFOPLIST_FILE = EmployeeDirectory/Info.plist;
INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES;
INFOPLIST_KEY_UILaunchStoryboardName = LaunchScreen;
INFOPLIST_KEY_UISupportedInterfaceOrientations = UIInterfaceOrientationPortrait;
INFOPLIST_KEY_UISupportedInterfaceOrientations_iPad = "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
INFOPLIST_KEY_UISupportedInterfaceOrientations_iPhone = "UIInterfaceOrientationPortrait UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
LD_RUNPATH_SEARCH_PATHS = (
"$(inherited)",
"@executable_path/Frameworks",

10
EmployeeDirectory/Extensions/String.swift
View File

@ -12,9 +12,11 @@ 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 {
// mask for the phone numver
let mask = "XXX-XXX-XXXX"
// format the number
return format(with: "XXX-XXX-XXXX", phone: self)
}
internal func format(with mask: String, phone: String) -> String {
let numbers = filter { $0.isNumber }
var result = ""
var index = numbers.startIndex // numbers iterator
@ -33,6 +35,6 @@ extension String {
}
}
return result
}
}
}

2
EmployeeDirectory/Extensions/URL.swift
View File

@ -8,8 +8,6 @@ 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)

2
EmployeeDirectory/Models/Employees.swift
View File

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

6
EmployeeDirectory/Protocols/EmployeeServiceProtocol.swift
View File

@ -5,12 +5,6 @@
// 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
}

14
EmployeeDirectory/Services/EmployeeService.swift
View File

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

41
EmployeeDirectory/Services/ImageCacheService.swift
View File

@ -8,80 +8,49 @@
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) // Cache in memory for faster access next time
memoryCache.setObject(diskImage, forKey: cacheKey)
return diskImage
}
// Step 3: Fetch the image from the network
if let networkImage = await fetchFromNetwork(url: url) {
memoryCache.setObject(networkImage, forKey: cacheKey) // Cache in memory
try? saveImageToDisk(image: networkImage, at: diskImagePath) // Cache on disk
memoryCache.setObject(networkImage, forKey: cacheKey)
try? saveImageToDisk(image: networkImage, at: diskImagePath)
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)

7
EmployeeDirectory/Services/NetworkService.swift
View File

@ -26,22 +26,15 @@ 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.

30
EmployeeDirectory/ViewControllers/EmployeesViewController.swift
View File

@ -9,30 +9,13 @@ 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()
@ -40,9 +23,6 @@ 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
@ -66,7 +46,6 @@ class EmployeesViewController: UIViewController {
navigationItem.titleView = modeSegmentedControl
}
/// Using the ViewModel setup combine handlers
private func bindViewModel() {
viewModel.$employees
.receive(on: RunLoop.main)
@ -95,8 +74,7 @@ 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 }
@ -118,16 +96,11 @@ 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 {
@ -140,7 +113,6 @@ extension EmployeesViewController {
}
}
/// Mark: - UITableViewDataSource
extension EmployeesViewController: UITableViewDataSource {
public func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
return viewModel.employees.count

20
EmployeeDirectory/ViewModels/EmployeeCellViewModel.swift
View File

@ -8,11 +8,8 @@
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
@ -24,21 +21,18 @@ 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
uuid = employee.uuid.uuidString
fullName = employee.fullName
phoneNumber = employee.phoneNumber?.formatUSNumber()
emailAddress = employee.emailAddress
biography = employee.biography
team = employee.team
employeeType = employee.employeeType.description
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
// Fetch the image for the url if it exists
if let endpoint = employee.photoURLSmall {
Task{
if let smallPhotoURL = URL(string: endpoint) {

19
EmployeeDirectory/ViewModels/EmployeesViewModel.swift
View File

@ -7,17 +7,18 @@
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() {}
public init(service: EmployeeService = EmployeeService()) {
self.service = service
}
public func fetchEmployees() {
// resetting values out the values before fetching new data
@ -27,17 +28,17 @@ public class EmployeesViewModel: ObservableObject {
Task {
do {
// Fetch employees using the async method
let wrapper = try await EmployeeService.shared.getEmployees(serviceMode)
let wrapper = try await service.getEmployees(serviceMode)
// Update published properties
employees = wrapper.employees
isLoading = false
self.employees = wrapper.employees
self.isLoading = false
} catch {
// Handle errors
employees = []
isLoading = false
errorMessage = "An unexpected error occurred, please try to refresh"
self.employees = []
self.isLoading = false
self.errorMessage = "An unexpected error occurred, please try to refresh"
}
}

25
EmployeeDirectory/Views/EmployeeTableViewCell.swift
View File

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

10
EmployeeDirectory/Views/TableFooterView.swift
View File

@ -6,11 +6,8 @@
//
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()
@ -23,8 +20,6 @@ public class TableFooterView: UIView {
return label
}()
// MARK: - Initializer
init(message: String) {
super.init(frame: .zero)
setupUI()
@ -35,8 +30,6 @@ public class TableFooterView: UIView {
fatalError("init(coder:) has not been implemented")
}
// MARK: - Private Methods
/// Setup the UI
private func setupUI() {
addSubview(messageLabel)
@ -48,8 +41,7 @@ public class TableFooterView: UIView {
])
}
// MARK: - Public Methods
/// Updates the Current Message
/// - Parameter message: message to show
public func update(message: String) {

42
EmployeeDirectoryTests/EmployeeDirectoryTests.swift
View File

@ -6,6 +6,7 @@
//
import Testing
import XCTest
@testable import EmployeeDirectory
@ -13,57 +14,36 @@ struct EmployeeDirectoryTests {
@Test func getEmployeesValid() async throws {
do {
let wrapper = try await EmployeeService.shared.getEmployees(.production)
let wrapper = try await EmployeeService().getEmployees(.production)
#expect(wrapper.employees.count == 11)
} catch {
#expect(Bool(false), "Unexpected error: \(error)")
XCTFail("Unexpected error: \(error)")
}
}
@Test func getEmployeesMalformed() async throws {
do {
_ = try await EmployeeService.shared.getEmployees(.malformed)
#expect(Bool(false), "Expected invalidResponse error, but no error was thrown")
let wrapper = try await EmployeeService().getEmployees(.malformed)
XCTFail("Expected to throw, but got \(wrapper.employees.count) employees")
} catch let error as NetworkServiceError {
switch error {
case .decodingError(let decodingError):
#expect(Bool(true), "Expected NetworkServiceError.decodingError, but got \(decodingError)")
case .invalidResponse:
XCTAssertTrue(true, "Correctly threw invalidResponse error")
default:
#expect(Bool(false), "Expected NetworkServiceError.decodingError, but got \(error)")
XCTFail("Expected NetworkServiceError.invalidResponse, but got \(error)")
}
} catch {
#expect(Bool(false), "Unexpected error: \(error)")
XCTFail("Unexpected error: \(error)")
}
}
@Test func getEmployeesEmpty() async throws {
do {
let wrapper = try await EmployeeService.shared.getEmployees(.empty)
let wrapper = try await EmployeeService().getEmployees(.empty)
#expect(wrapper.employees.count == 0)
} catch {
#expect(Bool(false), "Unexpected error: \(error)")
XCTFail("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
}
}
}