FabrizioBrancati/SwiftyBot

//
//  LocalizedGreeting.swift
//  SwiftyBot
//
//  The MIT License (MIT)
//
//  Copyright (c) 2016 - 2019 Fabrizio Brancati.
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in all
//  copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
//  SOFTWARE.

import Foundation
import Helper

/// Localized Greeting helper.
public struct LocalizedGreeting: Codable, Equatable {
    /// Available templates, to be used in the text property.
    public enum Template: String {
        /// User first name.
        case firstName = "{{user_first_name}}"
        /// User last name.
        case lastName = "{{user_last_name}}"
        /// User full name.
        case fullName = "{{user_full_name}}"
    }
    
    /// Locale.
    public private(set) var locale: Language
    /// Text shown for the locale.
    public private(set) var text: String
    
    /// Creates a LocalizedGreeting.
    ///
    /// - Parameters:
    ///   - locale: Locale.
    ///   - text: Text for the locale.
    public init(locale: Language, text: String) {
        self.locale = locale
        self.text = text
    }
}