ed_journals/modules/logs/
log_dir.rs

use std::path::{Path, PathBuf};

use thiserror::Error;

use crate::modules::logs::{LogFile, LogFileError};

/// Provides an abstraction for all the log files in the journal directory.
#[derive(Debug)]
pub struct LogDir {
    dir_path: PathBuf,
}

#[derive(Debug, Error)]
pub enum LogDirError {
    #[error("Failed to represent OS string")]
    FailedToRepresentOsString,

    #[error(transparent)]
    JournalFileError(#[from] LogFileError),

    #[error(transparent)]
    IO(#[from] std::io::Error),
}

impl LogDir {
    pub fn new(dir_path: PathBuf) -> LogDir {
        LogDir { dir_path }
    }

    pub fn path(&self) -> &Path {
        self.dir_path.as_path()
    }

    /// Returns a list of journal log files found in the directory in any order.
    pub fn journal_logs(&self) -> Result<Vec<LogFile>, LogDirError> {
        self.dir_path
            .read_dir()?
            .filter_map(|entry| match entry {
                Ok(entry) => match LogFile::try_from(entry) {
                    Ok(journal_file) => Some(Ok(journal_file)),
                    Err(LogFileError::IncorrectFileName) => None,
                    Err(err) => Some(Err(err.into())),
                },
                Err(err) => Some(Err(err.into())),
            })
            .collect::<Result<Vec<LogFile>, LogDirError>>()
    }

    /// Returns a list of journal log files found in the directory, returning the oldest journal
    /// logs first.
    pub fn journal_logs_oldest_first(&self) -> Result<Vec<LogFile>, LogDirError> {
        let mut logs = self.journal_logs()?;
        logs.sort();

        Ok(logs)
    }

    /// Returns a list of journal log files found in the directory, returning the newest journal
    /// logs first.
    pub fn journal_logs_newest_first(&self) -> Result<Vec<LogFile>, LogDirError> {
        let mut logs = self.journal_logs()?;
        logs.sort();
        logs.reverse();

        Ok(logs)
    }
}

#[cfg(test)]
mod tests {
    use std::env::current_dir;

    use crate::logs::LogDir;

    #[test]
    fn journal_files_oldest_first_are_returned_in_the_correct_order() {
        let dir_path = current_dir().unwrap().join("test-files").join("journals");

        let journal_dir = LogDir::new(dir_path);

        let mut journal_files = journal_dir.journal_logs_oldest_first().unwrap().into_iter();

        let journal_1 = journal_files.next().unwrap();
        let journal_2 = journal_files.next().unwrap();

        let date_1 = journal_1.date_time();
        let date_2 = journal_2.date_time();

        assert!(date_2 > date_1);
    }

    #[test]
    fn journal_files_newest_first_are_returned_in_the_correct_order() {
        let dir_path = current_dir().unwrap().join("test-files").join("journals");

        let journal_dir = LogDir::new(dir_path);

        let mut journal_files = journal_dir.journal_logs_newest_first().unwrap().into_iter();

        let journal_1 = journal_files.next().unwrap();
        let journal_2 = journal_files.next().unwrap();

        let date_1 = journal_1.date_time();
        let date_2 = journal_2.date_time();

        assert!(date_2 < date_1);
    }
}
ed_journals/modules/logs/log_dir.rs

ed_journals/modules/logs/
log_dir.rs
