VersionUpdate.swift

//
//  VersionUpdate.swift
//  LoopKit
//
//  Created by Rick Pasetto on 9/8/21.
//  Copyright © 2021 LoopKit Authors. All rights reserved.
//

import Foundation

// Note: order is important for VersionUpdate.  Later version updates are more critical than earlier ones.  Do not reorder!
public enum VersionUpdate: Comparable, CaseIterable {
    /// No version update needed.
    case noUpdateNeeded
    /// A update is available, but it is just informational (supported update).
    case available
    /// The version is unsupported; the app needs to be updated to the latest "supported" version.  Not a critical update.
    case recommended
    /// The app must be updated immediately.
    case required
}

extension VersionUpdate: RawRepresentable {
    public typealias RawValue = String
    public init?(rawValue: RawValue) {
        switch rawValue {
        case "noUpdateNeeded": self = .noUpdateNeeded
        case "available": self = .available
        case "recommended": self = .recommended
        case "required": self = .required
        default: return nil
        }
    }
    public var rawValue: RawValue {
        switch self {
        case .noUpdateNeeded: return "noUpdateNeeded"
        case .available: return "available"
        case .recommended: return "recommended"
        case .required:  return "required"
        }
    }
}

extension VersionUpdate {
    public static let `default` = VersionUpdate.noUpdateNeeded

    public var softwareUpdateAvailable: Bool { self > .noUpdateNeeded }
}

extension VersionUpdate {
    public var localizedDescription: String {
        switch self {
        case .noUpdateNeeded:
            return LocalizedString("No Update", comment: "Description of no software update needed")
        case .available:
            return LocalizedString("Update Available", comment: "Description of informational software update needed")
        case .recommended:
            return LocalizedString("Recommended Update", comment: "Description of supported software update needed")
        case .required:
            return LocalizedString("Critical Update", comment: "Description of critical software update needed")
        }
    }
}

public extension Notification.Name {
    static let SoftwareUpdateAvailable = Notification.Name(rawValue: "com.loopkit.Loop.SoftwareUpdateAvailable")
}