acorns 1.2.4

Generate an AsciiDoc release notes document from tracking tickets.
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
89
90
91
92
93
94
95

/*
acorns: Generate an AsciiDoc release notes document from tracking tickets.
Copyright (C) 2023  Marek Suchánek  <msuchane@redhat.com>

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/>.
*/

/*!
A subcommand that initializes an empty directory with all the necessary aCoRNs configuration files.

This makes it more convenient to set up a new release notes project from scratch.
*/

use std::fs;
use std::path::Path;

use color_eyre::{eyre::WrapErr, Result};
use include_dir::{include_dir, Dir, DirEntry};

/// The `example` directory in the aCoRNs source repository.
static EXAMPLE_DIR: Dir = include_dir!("$CARGO_MANIFEST_DIR/example");

/// Copy example configuration files into the selected directory.
///
/// If the directory doesn't exist, create it.
pub fn initialize_directory(dir: &Path) -> Result<()> {
    if !dir.exists() {
        log::info!("The directory does not exist. Creating.");
        fs::create_dir_all(dir).wrap_err("Failed to create the project directory.")?;
    }

    // The absolute path to the selected target directory.
    let absolute_target = dir.canonicalize()?;
    log::info!(
        "Initializing a release notes project in {}",
        absolute_target.display()
    );

    let files = display_files(&EXAMPLE_DIR, &absolute_target);
    log::info!("Creating files:\n{}", files);

    EXAMPLE_DIR
        .extract(dir)
        .wrap_err("Failed to copy files to the project directory.")?;

    Ok(())
}

/// List all file paths from the example directory as a newline-separated string.
fn display_files(dir: &Dir, abs_target: &Path) -> String {
    let rel_paths = files_in_entries(dir.entries());

    let abs_paths = rel_paths.iter().map(|rel_path| abs_target.join(rel_path));

    let strings: Vec<String> = abs_paths
        .map(|path| format!("• {}", path.display()))
        .collect();
    strings.join("\n")
}

/// Return all the file paths from the example directory, recursively.
fn files_in_entries<'a>(entries: &'a [DirEntry<'a>]) -> Vec<&'a Path> {
    // This has to be written iteratively.
    // I tried the functional iter-map-collect chain and ran into:
    // error[E0277]: a value of type `Vec<&std::path::Path>` cannot be built
    // from an iterator over elements of type `Vec<&std::path::Path>`
    let mut results = Vec::new();

    for entry in entries {
        let mut files = files_in_entry(entry);
        results.append(&mut files);
    }
    results
}

/// A helper function for `files_in_entries` that distinguishes files and recursive directories.
fn files_in_entry<'a>(entry: &'a DirEntry) -> Vec<&'a Path> {
    match entry {
        DirEntry::File(file) => {
            vec![file.path()]
        }
        DirEntry::Dir(dir) => files_in_entries(dir.entries()),
    }
}