abscissa 0.9.0

Application microframework with support for command-line option parsing, configuration, error handling, logging, and terminal interactions. This crate contains a CLI utility for generating new applications.
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! Template collections manage and render a set of templates intended to
//! generate an Abscissa application.

use super::{Template, iter::Iter};
use crate::{
    error::{Error, ErrorKind},
    handlebars_registry,
    prelude::*,
    properties::Properties,
};
use handlebars::Handlebars;
use std::io;

/// Include a file from the application template
macro_rules! template {
    ($path:expr) => {
        ($path, include_str!(concat!("../../template/", $path)))
    };
}

/// Handlebars template files which define the default application template.
///
/// Presently all of these need to be declared explicitly, and end in `.hbs`
// TODO(tarcieri): use `build.rs` to automatically manage these?
const DEFAULT_TEMPLATE_FILES: &[(&str, &str)] = &[
    template!(".gitignore.hbs"),
    template!("Cargo.toml.hbs"),
    template!("README.md.hbs"),
    template!("src/application.rs.hbs"),
    template!("src/bin/app/main.rs.hbs"),
    template!("src/commands.rs.hbs"),
    template!("src/commands/start.rs.hbs"),
    template!("src/config.rs.hbs"),
    template!("src/error.rs.hbs"),
    template!("src/lib.rs.hbs"),
    template!("src/prelude.rs.hbs"),
    template!("tests/acceptance.rs.hbs"),
];

/// Abscissa application template renderer
#[derive(Debug)]
pub struct Collection<'a>(Handlebars<'a>);

impl Default for Collection<'_> {
    fn default() -> Collection<'static> {
        Collection::new(
            DEFAULT_TEMPLATE_FILES
                .iter()
                .map(|(name, contents)| (*name, *contents)),
        )
        .unwrap()
    }
}

impl Collection<'_> {
    /// Create a new template collection by providing an iterator over
    /// `(&name, &contents)` tuples where "name" both names the template
    /// and provides its path within the application.
    pub fn new<'a, I>(template_files: I) -> Result<Collection<'static>, Error>
    where
        I: Iterator<Item = (&'a str, &'a str)>,
    {
        let mut hbs = handlebars_registry!();

        for (name, contents) in template_files {
            debug!("registering template: {}", name);

            hbs.register_template_string(name, contents).map_err(|e| {
                format_err!(
                    ErrorKind::Template,
                    "couldn't register template '{}': {}",
                    name,
                    e
                )
            })?;
        }

        Ok(Collection(hbs))
    }

    /// Iterate over the templates in the collection
    pub fn iter(&self) -> Iter<'_> {
        // TODO: better way of constructing this `Iter`
        Iter::new(
            self.0
                .get_templates()
                .iter()
                .map(|(path, template)| Template::new(path.as_ref(), template))
                .collect(),
        )
    }

    /// Render a template
    pub fn render<W>(
        &self,
        template: &Template<'_>,
        properties: &Properties,
        output: W,
    ) -> Result<(), Error>
    where
        W: io::Write,
    {
        let ctx = handlebars::Context::wraps(properties)?;
        let mut render_context = handlebars::RenderContext::new(template.inner.name.as_ref());
        let mut output = Output::new(output);

        use handlebars::Renderable;
        template
            .inner
            .render(&self.0, &ctx, &mut render_context, &mut output)
            .map_err(|e| format_err!(ErrorKind::Template, "render error: {}", e).into())
    }
}

/// Wrapper for writing template output to a file
struct Output<W: io::Write>(W);

impl<W: io::Write> Output<W> {
    pub fn new(writeable: W) -> Output<W> {
        Output(writeable)
    }
}

impl<W: io::Write> handlebars::Output for Output<W> {
    fn write(&mut self, seg: &str) -> Result<(), io::Error> {
        self.0.write_all(seg.as_bytes())
    }
}