1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
//! ## Logs
//! There are parts of the application where the use or registration of logs
//! is needed either to show them to the user graphically or to register
//! them in session files.
//!
//! This is where the mod logs appears, which contains functions
//! that will help us to do this job.

use colored::*;

/// these are possible levels for a log.
/// we can use them as follows:
/// ```rust
/// use windsh_core::logs::LogLevel;
///
/// let log_level_error = LogLevel::Error;
/// let log_level_warning = LogLevel::Warning;
/// ```
/// the functionality possible here is very basic,
/// that is why it is usually used together with the `Log` structure
#[derive(Debug, Clone, PartialEq)]
pub enum LogLevel {
    Info,
    Ok,
    Error,
    Warning,
}

/// this is the structure that a log should have, this is global for any level
/// we can use them as follows:
/// ```rust
/// use windsh_core::logs::{Log, LogLevel};
///
/// // this print a log
/// Log::new(LogLevel::Warning, 0, "This is a test log.").show();
///
/// // this return a log
/// let my_log: Log = Log::new(LogLevel::Warning, 0, "This is a test log.");
///
/// // we can also print an existing log
/// my_log.show();
/// ```
/// these are some uses that this structure can be given.
#[derive(Clone)]
pub struct Log {
    level: LogLevel,
    code: u16,
    message: String,
}

impl Log {
    /// This function allows us to create a new log in a very intuitive and easy way,
    /// it also allows us to do extra things like print it in the console
    pub fn new(level: LogLevel, code: u16, message: &str) -> Self {
        Self {
            level,
            code,
            message: String::from(message),
        }
    }

    pub fn show(&self) {
        match self.level {
            LogLevel::Info => {
                println!("{} {}", "Info:".bold().green(), self.message);
            }
            LogLevel::Ok => {
                println!("{} {}", "Ok:".bold().cyan(), self.message);
            }
            LogLevel::Error => {
                println!("{} {}", "Error:".bold().red(), self.message);
            }
            LogLevel::Warning => {
                println!("{} {}", "Warning:".bold().yellow(), self.message);
            }
        }
    }

    pub fn set_level(&mut self, level: LogLevel) {
        self.level = level;
    }

    pub fn set_code(&mut self, code: u16) {
        self.code = code;
    }

    pub fn set_message(&mut self, message: &str) {
        self.message = String::from(message);
    }

    pub fn get_level(&self) -> LogLevel {
        self.level.clone()
    }

    pub fn get_code(&self) -> u16 {
        self.code.clone()
    }

    pub fn get_message(&self) -> String {
        self.message.clone()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_new_log() {
        let log_new = Log::new(LogLevel::Error, 1, "message");

        assert_eq!(log_new.level, LogLevel::Error);
        assert_eq!(log_new.code, 1);
        assert_eq!(log_new.message, "message");
    }

    #[test]
    pub fn test_get_level() {
        let log_new = Log::new(LogLevel::Error, 1, "message");

        assert_eq!(log_new.level, log_new.get_level());
    }

    #[test]
    pub fn test_get_code() {
        let log_new = Log::new(LogLevel::Info, 1_20, "message");

        assert_eq!(log_new.code, log_new.get_code());
    }

    #[test]
    pub fn test_get_message() {
        let log_new = Log::new(LogLevel::Ok, 12, "message");

        assert_eq!(log_new.message, log_new.get_message());
    }

    #[test]
    pub fn test_set_level() {
        let mut log_new =
            Log::new(LogLevel::Warning, 1_23_20, "This is awesome");

        assert_eq!(log_new.level, LogLevel::Warning);

        log_new.set_level(LogLevel::Error);
        assert_eq!(log_new.level, LogLevel::Error);
        assert_ne!(log_new.level, LogLevel::Warning);
    }

    #[test]
    pub fn test_set_code() {
        let mut log_new = Log::new(LogLevel::Warning, 12345, "This is awesome");

        assert_eq!(log_new.code, 12345);

        log_new.set_code(1234);
        assert_eq!(log_new.code, 1234);
        assert_ne!(log_new.code, 12345);
    }

    #[test]
    pub fn test_set_message() {
        let mut log_new = Log::new(LogLevel::Warning, 12345, "Hello, World!");

        assert_eq!(log_new.message, "Hello, World!");

        log_new.set_message("This is awesome!");
        assert_eq!(log_new.message, "This is awesome!");
        assert_ne!(log_new.message, "Hello, World!");
    }
}