active_copirate.rs

//! Records the currently active co-authors collaborating on this Git repository.

use std::fs::{self, File, OpenOptions};
use std::io::Write;
use std::path::Path;

use crate::copirate::CoPirate;
use crate::BoxResult;

const ACTIVE_COPIRATES_PATH: &str = ".git/.git-rmob-template";

/// File containing `Co-authored-by` lines for all active co-authors.
#[derive(Debug)]
pub struct ActiveCoPirates {
    file: File,
}

impl ActiveCoPirates {
    /// Opens a pre-existing co-pirates file for the repository located at `repo_dir`.
    pub fn get(repo_dir: &Path) -> BoxResult<String> {
        let active_copirates = fs::read_to_string(repo_dir.join(ACTIVE_COPIRATES_PATH))?;
        Ok(active_copirates)
    }

    /// Creates an empty active co-pirates file for the repository located at `repo_dir`.
    ///
    /// If the file already exists, its contents will be cleared.
    pub fn create_empty(repo_dir: &Path) -> BoxResult<ActiveCoPirates> {
        let active_copirates_path = repo_dir.join(ACTIVE_COPIRATES_PATH);
        fs::write(&active_copirates_path, "")?;

        let file = OpenOptions::new()
            .append(true)
            .open(active_copirates_path)?;

        Ok(ActiveCoPirates { file })
    }

    /// Generates `Co-authored-by` messages for the given co-pirates and saves the file to disk.
    pub fn save(mut self, copirates: &[&CoPirate]) -> BoxResult<()> {
        for pirate in copirates {
            writeln!(self.file, "Co-authored-by: {}", pirate)?;
        }

        Ok(())
    }
}