SwiftLint/Source/SwiftLintFramework/Rules/RuleConfigurations/RequiredEnumCaseRuleConfiguration.swift

//
//  RequiredEnumCaseRuleConfiguration.swift
//  SwiftLint
//
//  Created by Ritter, Donald on 9/13/17.
//  Copyright © 2017 Realm. All rights reserved.
//

import Foundation

public struct RequiredEnumCaseRuleConfiguration: RuleConfiguration, Equatable {
    struct RequiredCase: Equatable, Hashable {
        var name: String
        var severity: ViolationSeverity

        init(name: String, severity: ViolationSeverity = .warning) {
            self.name = name
            self.severity = severity
        }

        var hashValue: Int {
            return name.hashValue
        }

        static func == (lhs: RequiredCase, rhs: RequiredCase) -> Bool {
            return lhs.name == rhs.name && lhs.severity == rhs.severity
        }
    }

    var protocols: [String: Set<RequiredCase>] = [:]

    public var consoleDescription: String {
        let protocols = self.protocols.sorted(by: { $0.key < $1.key }) .flatMap { name, required in
            let caseNames: [String] = required.sorted(by: { $0.name < $1.name }).flatMap {
                "[name: \"\($0.name)\", severity: \"\($0.severity.rawValue)\"]"
            }

            return "[protocol: \"\(name)\", cases: [\(caseNames.joined(separator: ", "))]]"
        }.joined(separator: ", ")

        let instructions = "No protocols configured.  In config add 'required_enum_case' to 'opt_in_rules' and " +
            "config using :\n\n" +
            "'required_enum_case:\n" +
            "  {Protocol Name}:\n" +
            "    {Case Name}:{warning|error}\n" +
            "    {Case Name}:{warning|error}\n"

        return protocols.isEmpty ? instructions : protocols
    }

    public mutating func apply(configuration: Any) throws {
        guard let config = configuration as? [String: [String: String]] else {
            throw ConfigurationError.unknownConfiguration
        }

        register(protocols: config)
    }

    mutating func register(protocols: [String: [String: String]]) {
        for (name, cases) in protocols {
            register(protocol: name, cases: cases)
        }
    }

    mutating func register(protocol name: String, cases: [String: String]) {
        var requiredCases: Set<RequiredCase> = []

        for (caseName, severity) in cases {
            let parsedSeverity: ViolationSeverity = (severity == "error") ? .error : .warning
            requiredCases.insert(RequiredCase(name: caseName, severity: parsedSeverity))
        }

        protocols[name] = requiredCases
    }

    public static func == (lhs: RequiredEnumCaseRuleConfiguration,
                           rhs: RequiredEnumCaseRuleConfiguration) -> Bool {

        return lhs.protocols == rhs.protocols
    }
}