taboc 0.2.105

A table of contents generator for markdown documents.
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

/*!
Setting up the application is as simple as:

```rust
use taboc::prelude::*;

fn main() -> Result<(), Error> {
    // The error assert is done because the project already has a table of contents.
    assert!(App::init()?.run().is_err());

    Ok(())
}
```

Alternatively, you can also make the app from existing args too:

```rust
use taboc::prelude::*;

fn main() -> Result<(), Error> {
    let args = Opt::parse();

    // The error assert is done because the project already has a table of contents.
    assert!(App::from_args(&args)?.run().is_err());

    Ok(())
}
```
*/

use std::{borrow::Cow, fs::File, path::PathBuf};

use crate::prelude::*;

pub struct App<'a> {
    pub args: Cow<'a, Opt>,
    pub path: PathBuf,
    pub taboc: Taboc,
}

impl<'a> App<'a> {
    /// Make the `App` struct.
    pub fn init() -> Result<Self, Error> {
        let args: Cow<'a, Opt> = Cow::Owned(Opt::parse());
        let path = args.input.path().path().to_path_buf();
        let taboc = Taboc::new(File::open(&path)?, args.max_depth);

        Ok(Self { args, path, taboc })
    }

    /// Make the `App` struct from pre-existing `args`.
    #[allow(dead_code)]
    pub fn from_args(args: &'a Opt) -> Result<Self, Error> {
        let path = args.input.path().path().to_path_buf();
        let table_of_contents = Taboc::new(File::open(&path)?, args.max_depth);

        Ok(Self {
            args: Cow::Borrowed(args),
            path,
            taboc: table_of_contents,
        })
    }

    /// Run the main application logic.
    pub fn run(&self) -> Result<(), Error> {
        if self.args.no_file_update {
            println!("{}", self.taboc.parse()?);
            return Ok(());
        }

        if !self.args.no_vcs {
            #[cfg(feature = "git")]
            Git::run_allow_dirty_checks(&self.args, &self.path)?;
        }

        self.taboc
            .write_to_file(&self.path, &self.taboc.parse()?, self.args.update_existing)?;

        Ok(())
    }
}