docket 0.1.2

Simple markdown to HTML documentation rendering
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

//! Markdown to HTML Documentation Generator

extern crate docopt;
#[macro_use]
extern crate serde_derive;
extern crate pulldown_cmark;
#[macro_use]
extern crate log;
extern crate env_logger;
extern crate failure;

mod docket;
mod page;
mod util;
mod toc;
mod index;
mod renderable;
mod renderer;

use docopt::*;
use std::path::PathBuf;
use docket::Docket;

/// Usage Information
///
/// This is a [Docopt] compliant usage description of this program.
///
///  [Docopt]: http://docopt.org/
const USAGE: &'static str = "
Docket Documentation Generator

Usage: docket [options]

Options:
  -h --help           Show this screen.
  -s, --source=<in>   Documentation directory, default is current directory.
  -t, --target=<out>  Write the output to <out>, default is `./build/`.
";

/// Program Arguments
///
/// Structure to capture the command line arguments for the
/// program. This is filled in for us by Docopt.
#[derive(Debug, Deserialize)]
struct Args {
    flag_source: Option<String>,
    flag_target: Option<String>,
}

/// Path or Default
///
/// Try to convert a command line argument to a path. Falling back to
/// the default if none is provided.
fn path_or_default(maybe_path: Option<String>, default: &str) -> PathBuf {
    maybe_path
        .map({
            |p| PathBuf::from(p)
        })
        .unwrap_or(default.to_owned().into())
}

fn main() {

    let _ = env_logger::init();

    let args: Args = Docopt::new(USAGE)
        .and_then(|d| d.deserialize())
        .unwrap_or_else(|e| e.exit());

    let source = path_or_default(args.flag_source, ".");
    let target = path_or_default(args.flag_target, "build/");
    Docket::new(&source).unwrap().render(&target);

}

#[cfg(test)]
mod test {

    use std::path::Path;
    use super::*;

    #[test]
    fn path_or_default_with_valid_argument() {
        let source = Some("/Users/foo/".to_owned());
        assert_eq!(Path::new("/Users/foo/"), path_or_default(source, "."));
    }

    #[test]
    fn path_or_default_without_argument() {
        let source = None;
        assert_eq!(Path::new("baz/"), path_or_default(source, "baz/"));
    }
}