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 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
use std::fmt::{ Display, Formatter, Result }; use std::thread; use std::time::Duration; use std::sync::{ Arc, RwLock }; use std::io::prelude::*; use std::io; use chrono::{ Timelike, Utc }; use colored::*; /// Contains definitions for icons that can be /// used in the terminal. See [this github repo](https://github.com/sindresorhus/figures) /// for an entire list. Use this in combination with printing macros. pub enum LogIcon { /// A check mark, use when things go well /// /// # Example /// ``` /// # use paris::LogIcon; /// println!("{} Everything went well", LogIcon::Tick); /// // ✔ Everything went well /// ``` Tick, /// A cross, use when things go bad, or be creative /// /// # Example /// ``` /// # use paris::LogIcon; /// println!("{} Oops, try again!", LogIcon::Cross); /// // ✖ Oops, try again! /// ``` Cross, /// A fancy 'i', for information /// /// # Example /// ``` /// # use paris::LogIcon; /// println!("{} In Switzerland it is illegal to own just one guinea pig", LogIcon::Info); /// // ℹ In Switzerland it is illegal to own just one guinea pig. /// ``` Info, /// A triangle with an exclamation mark in it, dangerous /// /// # Example /// ``` /// # use paris::LogIcon; /// println!("{} Things are starting to catch fire!", LogIcon::Warning); /// // ⚠ Things are starting to catch fire! /// ``` Warning, /// ❤️🦄 /// # Example /// ``` /// // You get it... /// ``` Heart } impl Display for LogIcon { /// Match the enum value and print out the equivalent icon. /// On Windows, icons will be replaced with other *things* that /// are supported. See [this github repo](https://github.com/sindresorhus/figures) /// for all replacements fn fmt(&self, f: &mut Formatter<'_>) -> Result { let (mut t, mut c, mut i, mut w, mut h) = ("✔", "✖", "ℹ", "⚠", "♥"); if cfg!(windows) { t = "√"; c = "×"; i = "i"; w = "‼"; h = "♥"; } match *self { LogIcon::Tick => write!(f, "{}", t), LogIcon::Cross => write!(f, "{}", c), LogIcon::Info => write!(f, "{}", i), LogIcon::Warning => write!(f, "{}", w), LogIcon::Heart => write!(f, "{}", h) } } } // Only works in Logger! macro_rules! output { ($text:expr, $self:ident) => ( match $self.same_line { true => print!("{}{}", $self.timestamp(), $text), false => println!("{}{}", $self.timestamp(), $text) } ); ($text:expr, $icon:expr, $self:ident) => ( match $self.same_line { true => print!("{} {}{}", $icon, $self.timestamp(), $text), false => println!("{} {}{}", $icon, $self.timestamp(), $text) } $self.same_line = false; ); ($text:expr, $icon:expr, $self:ident, $e:ident) => ( match $self.same_line { true => eprint!("{} {}{}", $icon, $self.timestamp(), $text), false => eprintln!("{} {}{}", $icon, $self.timestamp(), $text) } $self.same_line = false; ); } pub struct Logger { is_loading: Arc<RwLock<bool>>, loading_message: String, // TODO: Use Option<> loading_handle: Option<thread::JoinHandle<()>>, with_timestamp: bool, same_line: bool } impl Logger { /// Initializes a new logger /// /// # Example /// ``` /// use paris::Logger; /// let logger = Logger::new(true); // Passing true will add timestamps to all logs /// ``` pub fn new(timestamp: bool) -> Logger { Logger { is_loading : Arc::new(RwLock::new(false)), loading_message : String::from(""), loading_handle : None, with_timestamp : if timestamp { true } else { false }, same_line : false } } /// Prints to stdout with no bells and whistles. I does however /// add a timestamp if enabled. /// /// # Example /// ``` /// # use paris::Logger; /// let mut logger = Logger::new(false); /// /// logger.log("Basic and boring."); // Basic and boring. /// ``` pub fn log<T: Display>(&mut self, message: T) -> &mut Logger { output!(message, self); self } /// Prints to stdout and adds some info flair to the text /// /// # Example /// ``` /// # use paris::Logger; /// # let mut logger = Logger::new(false); /// logger.info("This is some info"); /// ``` pub fn info<T: Display>(&mut self, message: T) -> &mut Logger { self.done(); let icon = format!("{}", LogIcon::Info); output!(message, icon.cyan(), self); self } /// Prints to stdout and adds some success flair to text /// /// # Example /// ``` /// # use paris::Logger; /// # let mut logger = Logger::new(false); /// logger.success("Everything went great!"); /// ``` pub fn success<T: Display>(&mut self, message: T) -> &mut Logger { self.done(); let icon = format!("{}", LogIcon::Tick); output!(message, icon.green(), self); self } /// Prints to stdout and adds some warning flare to text /// /// # Example /// ``` /// # use paris::Logger; /// # let mut logger = Logger::new(false); /// logger.warn("This is a warning"); /// ``` pub fn warn<T: Display>(&mut self, message: T) -> &mut Logger { self.done(); let icon = format!("{}", LogIcon::Warning); output!(message, icon.yellow(), self, true); self } /// Prints to stderr and adds some error flare to text /// /// # Example /// ``` /// # use paris::Logger; /// # let mut logger = Logger::new(false); /// logger.error("Something broke, here's the error"); /// ``` pub fn error<T: Display>(&mut self, message: T) -> &mut Logger { self.done(); let icon = format!("{}", LogIcon::Cross); output!(message, icon.red(), self, true); self } /// Prints a specified amount of newlines to stdout /// /// # Example /// ``` /// # use paris::Logger; /// # let mut logger = Logger::new(false); /// logger /// .newline(5) /// .info("Some newlines before info") /// .newline(2) /// .info("And some more in between"); /// ``` pub fn newline(&mut self, amount: usize) -> &mut Logger { self.done(); print!("{}", "\n".repeat(amount)); self } /// Prints a specified amount of tabs to stdout /// /// # Example /// ``` /// # use paris::Logger; /// # let mut logger = Logger::new(false); /// logger /// .indent(1) /// .warn("Indented warning eh? Stands out a bit") /// .newline(5); /// ``` pub fn indent(&mut self, amount: usize) -> &mut Logger { self.done(); print!("{}", "\t".repeat(amount)); self } /// Starts a loading animation with the given message. /// /// # Example /// ``` /// # use paris::Logger; /// let mut logger = Logger::new(false); /// logger.loading("Counting to 52!"); /// /// // counting happens here (somehow) /// /// logger /// .done() /// .success("Done counting, only took 1 million years"); /// ``` /// /// That's one way of doing it, but having to always call `.done()` doesn't /// look that tidy. Well you don't have to, unless you want. All other functions /// (success, info, error, etc.) call `.done()` just in case a loading thread is running /// already. A cleaner example would be: /// ``` /// # use paris::Logger; /// let mut logger = Logger::new(false); /// logger.loading("Counting to 52! again"); /// /// // .... /// /// logger.error("I give up, I can't do it again!"); /// ``` pub fn loading<T: Display>(&mut self, message: T) -> &mut Logger { let mut status = self.is_loading.write().unwrap(); *status = true; drop(status); // Release the lock so a mutable can be returned let status = self.is_loading.clone(); let thread_message = message.to_string().clone(); self.loading_message = message.to_string(); self.loading_handle = Some(thread::spawn(move || { let frames: [&str; 6] = ["⠦", "⠇", "⠋", "⠙", "⠸", "⠴"]; let mut i = 1; while *status.read().unwrap() { if i == frames.len() { i = 0; } print!("\r{} {}", frames[i].cyan(), thread_message); io::stdout().flush().unwrap(); thread::sleep(Duration::from_millis(100)); i = i + 1; } })); self } /// Stops the loading animation and clears the line so you can print something else /// when loading is done, maybe a success message. All other methods (success, warning, error, etc.) /// call this one automatically when called so you can use one of those directly /// for less clutter. pub fn done(&mut self) -> &mut Logger { if !*self.is_loading.read().unwrap() { return self; } let mut status = self.is_loading.write().unwrap(); *status = false; drop(status); // Release the lock so a mutable can be returned self.loading_handle .take().expect("Called stop on a non-existing thread") .join().expect("Could not join spawned thread"); let clearing_length = self.loading_message.len() + 5; print!("\r{}\r", " ".repeat(clearing_length)); io::stdout().flush().unwrap(); self } /// Forces the next statement to not output a newline /// /// # Example /// ``` /// # use paris::Logger; /// # let mut logger = Logger::new(false); /// /// logger /// .same().log("This is on one line") /// .indent(4) /// .log("This is on the same line!"); /// ``` pub fn same(&mut self) -> &mut Logger { self.same_line = true; self } /// Gets current timestamp in "00:00:00 AM/PM" format fn timestamp(&self) -> ColoredString { if !self.with_timestamp { return String::from("").normal(); } let now = Utc::now(); let (is_pm, hour) = now.hour12(); format!( "{:02}:{:02}:{:02}.{:03} {} > ", hour, now.minute(), now.second(), now.nanosecond() / 1_000_000, if is_pm { "PM" } else { "AM" } ).bold() } } #[cfg(test)] mod tests { use super::*; #[test] fn timestamp() { let mut logger = Logger::new(false); assert_eq!(logger.with_timestamp, false); logger.info("It doesn't have a timestamp"); let mut logger = Logger::new(true); assert_eq!(logger.with_timestamp, true); logger.info("It has a timestamp"); } #[test] fn loading() { let mut logger = Logger::new(false); logger.loading("Loading in the middle of a test is not good!"); // Long thing here logger.done().success("Done loading!"); logger.info("About to load again"); logger .loading("Loading something else") .done() .error("Done loading instantly lol"); } #[test] fn same() { let mut logger = Logger::new(false); logger .same().success("This is on one line") .indent(1) .info("This is on the same line!!!") .error("But this one isn't"); logger.same(); assert!(logger.same_line); } #[test] fn it_works() { let mut logger = Logger::new(true); logger .info("Somebody") .error("Once") .warn("Told") .success("Me") .newline(5) .log("A basic log eh") .indent(2) .info("If it didn't crash it's fine"); assert_eq!(logger.with_timestamp, true); } }