changelogging 0.7.0

Building changelogs from fragments.
Documentation 
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

//! Application initialization.
//!
//! This module provides the [`init`] function that handles initialization of `changelogging`.

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

use miette::Diagnostic;
use thiserror::Error;

/// Represents errors that can occur during changing the current directory.
#[derive(Debug, Error, Diagnostic)]
#[error("failed to change the current directory to `{path}`")]
#[diagnostic(
    code(changelogging::init::change_current_directory),
    help("check whether the directory exists and is accessible")
)]
pub struct ChangeCurrentDirectoryError {
    /// The underlying I/O error.
    pub source: std::io::Error,
    /// The path provided.
    pub path: PathBuf,
}

impl ChangeCurrentDirectoryError {
    /// Constructs [`Self`].
    pub fn new(source: std::io::Error, path: PathBuf) -> Self {
        Self { source, path }
    }
}

/// Represents sources of errors that can occur during initialization.
#[derive(Debug, Error, Diagnostic)]
#[error(transparent)]
#[diagnostic(transparent)]
pub enum ErrorSource {
    /// Change current directory errors.
    ChangeCurrentDirectory(#[from] ChangeCurrentDirectoryError),
}

/// Represents errors that can occur during initialization.
#[derive(Debug, Error, Diagnostic)]
#[error("failed to initialize")]
#[diagnostic(
    code(changelogging::init::init),
    help("see the report for more information")
)]
pub struct Error {
    /// The source of this error.
    #[source]
    #[diagnostic_source]
    pub source: ErrorSource,
}

impl Error {
    /// Constructs [`Self`].
    pub fn new(source: ErrorSource) -> Self {
        Self { source }
    }

    /// Constructs [`Self`] from [`ChangeCurrentDirectoryError`].
    pub fn change_current_directory(error: ChangeCurrentDirectoryError) -> Self {
        Self::new(error.into())
    }

    /// Constructs [`ChangeCurrentDirectoryError`] and constructs [`Self`] from it.
    pub fn new_change_current_directory(error: std::io::Error, path: PathBuf) -> Self {
        Self::change_current_directory(ChangeCurrentDirectoryError::new(error, path))
    }
}

/// Initializes `changelogging`, optionally changing the current directory.
///
/// # Errors
///
/// [`struct@Error`] is returned when changing the current directory fails.
pub fn init<D: AsRef<Path>>(directory: Option<D>) -> Result<(), Error> {
    if let Some(path) = directory {
        let path = path.as_ref();

        set_current_dir(path)
            .map_err(|error| Error::new_change_current_directory(error, path.to_owned()))?;
    };

    Ok(())
}