aeruginous 1.1.0

/*********************** GNU General Public License 3.0 ***********************\
|                                                                              |
|  Copyright (C) 2023 Kevin Matthes                                            |
|                                                                              |
|  This program is free software: you can redistribute it and/or modify        |
|  it under the terms of the GNU General Public License as published by        |
|  the Free Software Foundation, either version 3 of the License, or           |
|  (at your option) any later version.                                         |
|                                                                              |
|  This program is distributed in the hope that it will be useful,             |
|  but WITHOUT ANY WARRANTY; without even the implied warranty of              |
|  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
|  GNU General Public License for more details.                                |
|                                                                              |
|  You should have received a copy of the GNU General Public License           |
|  along with this program.  If not, see <https://www.gnu.org/licenses/>.      |
|                                                                              |
\******************************************************************************/

use crate::{AppendAsLine, PatternWriter};
use git2::Repository;
use std::{collections::HashMap, path::PathBuf};
use sysexits::{ExitCode, Result};

/// Create comments on the latest changes to this repository.
pub struct CommentChanges {
  /// The changes to report.
  changes: HashMap<String, Vec<String>>,

  /// The delimiter to separate a category from the change description.
  delimiter: String,

  /// The count of commits to analyse.
  depth: Option<usize>,

  /// The hyperlinks to define in the output file.
  hyperlinks: Vec<(String, String)>,

  /// This repository.
  repository: Option<Repository>,
}

impl CommentChanges {
  /// What is the name of the current branch?
  ///
  /// # Errors
  ///
  /// - [`sysexits::ExitCode::Unavailable`]
  /// - See [`Self::open_repository`].
  pub fn branch_name(&mut self) -> Result<String> {
    if self.repository.is_none() {
      self.open_repository()?;
    }

    let Some(repository) = &self.repository else { unreachable!() };

    repository.head().map_or_else(
      |error| {
        eprintln!("{error}");
        Err(ExitCode::Unavailable)
      },
      |reference| {
        reference
          .name()
          .map_or(Err(ExitCode::Unavailable), |name| Ok(name.to_string()))
      },
    )
  }

  /// Generate the changelog fragment.
  #[must_use]
  pub fn generate_changelog_fragment(&self) -> String {
    let mut result = String::new();

    for (link_name, target) in &self.hyperlinks {
      result.append_as_line(format!(".. {link_name}:  {target}"));
    }

    if !self.hyperlinks.is_empty() {
      result.push('\n');
    }

    for (category, changes) in &self.changes {
      result.append_as_line(format!(
        "{category}\n{}\n",
        ".".repeat(category.len())
      ));

      for change in changes {
        result.append_as_line(format!("- {change}\n"));
      }
    }

    result
  }

  /// Analyse the latest changes and create a report.
  ///
  /// # Errors
  ///
  /// See
  ///
  /// - [`Self::open_repository`]
  /// - [`Self::query_last_n_commits`]
  /// - [`Self::report_changes`]
  pub fn main(&mut self, output_directory: &str) -> Result<()> {
    self.update_changes()?;
    self.report_changes(output_directory)
  }

  /// Create a new instance from the command line arguments.
  #[must_use]
  pub fn new(
    depth: Option<usize>,
    delimiter: String,
    hyperlinks: Vec<(String, String)>,
  ) -> Self {
    Self {
      changes: HashMap::new(),
      delimiter,
      depth,
      hyperlinks,
      repository: None,
    }
  }

  /// Open this repository.
  ///
  /// # Errors
  ///
  /// - [`sysexits::ExitCode::Usage`]
  pub fn open_repository(&mut self) -> Result<()> {
    Repository::open(".").map_or_else(
      |_| {
        eprintln!("This is not a Git repository.");
        Err(ExitCode::Usage)
      },
      |repository| {
        self.repository = Some(repository);
        Ok(())
      },
    )
  }

  /// Query the given amount of commits.
  ///
  /// # Errors
  ///
  /// - [`sysexits::ExitCode::Unavailable`]
  /// - See [`Self::open_repository`].
  pub fn query_last_n_commits(
    &mut self,
  ) -> Result<HashMap<String, Vec<String>>> {
    if self.repository.is_none() {
      self.open_repository()?;
    }

    let Some(repository) = &self.repository else { unreachable!() };
    let mut result = HashMap::new();

    match repository.revwalk() {
      Ok(mut revwalk) => match revwalk.push_head() {
        Ok(()) => {
          let mut count = 1;

          for oid in revwalk {
            if let Some(depth) = self.depth {
              if count > depth {
                break;
              }
            }

            if let Ok(oid) = oid {
              if let Ok(commit) = repository.find_commit(oid) {
                match commit.summary() {
                  Some(summary) => {
                    if let Some((category, change)) =
                      summary.trim().split_once(&self.delimiter)
                    {
                      let category = category.trim().to_string();
                      let change = change.trim().to_string();

                      if !result.contains_key(&category) {
                        result.insert(category.clone(), Vec::new());
                      }

                      let mut changes = result[&category].clone();
                      changes.push(change);
                      result.insert(category, changes);
                    }
                  }
                  None => return Err(ExitCode::Unavailable),
                }
              } else {
                eprintln!("Commit {oid} does not seem to exist.");
                return Err(ExitCode::DataErr);
              }
            } else {
              eprintln!("There were not enough commits fetched on checkout.");
              return Err(ExitCode::Usage);
            }

            count += 1;
          }

          Ok(result)
        }
        Err(error) => {
          eprintln!("{error}");
          Err(ExitCode::Unavailable)
        }
      },
      Err(error) => {
        eprintln!("{error}");
        Err(ExitCode::Unavailable)
      }
    }
  }

  /// Report the logged changes.
  ///
  /// # Errors
  ///
  /// See
  ///
  /// - [`Self::branch_name`]
  /// - [`Self::who_am_i`]
  pub fn report_changes(&mut self, output_directory: &str) -> Result<()> {
    let branch = self.branch_name()?;
    let user = self.who_am_i()?.replace(' ', "_");

    PathBuf::from(format!(
      "{output_directory}/{}_{user}_{}.rst",
      chrono::Local::now().format("%Y%m%d_%H%M%S"),
      branch.split('/').last().unwrap_or("HEAD")
    ))
    .write(Box::new(self.generate_changelog_fragment()))
  }

  /// Update the changes retrieved by this instance.
  ///
  /// # Errors
  ///
  /// See [`Self::query_last_n_commits`].
  pub fn update_changes(&mut self) -> Result<()> {
    self.changes = self.query_last_n_commits()?;
    Ok(())
  }

  /// Who is configured as user?
  ///
  /// # Errors
  ///
  /// - [`sysexits::ExitCode::DataErr`]
  /// - [`sysexits::ExitCode::Unavailable`]
  /// - See [`Self::open_repository`].
  pub fn who_am_i(&mut self) -> Result<String> {
    if self.repository.is_none() {
      self.open_repository()?;
    }

    let Some(repository) = &self.repository else { unreachable!() };

    repository.config().map_or_else(
      |error| {
        eprintln!("{error}");
        Err(ExitCode::Unavailable)
      },
      |config| {
        config.get_string("user.name").map_or_else(
          |_| {
            eprintln!("There is no Git username configured, yet.");
            Err(ExitCode::DataErr)
          },
          Ok,
        )
      },
    )
  }
}

/******************************************************************************/