render_tree/
component.rs

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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
use crate::{Document, Render};

pub trait BlockComponent: Sized {
    fn with<F: FnOnce(Document) -> Document>(
        component: Self,
        block: F,
    ) -> CurriedBlockComponent<Self, F> {
        CurriedBlockComponent { component, block }
    }

    fn append(self, block: impl FnOnce(Document) -> Document, document: Document) -> Document;
}

pub struct CurriedBlockComponent<B: BlockComponent, Block: FnOnce(Document) -> Document> {
    component: B,
    block: Block,
}

impl<B: BlockComponent, Block: FnOnce(Document) -> Document> Render
    for CurriedBlockComponent<B, Block>
{
    fn render(self, document: Document) -> Document {
        (self.component).append(self.block, document)
    }
}

// IterBlockComponent //

pub trait IterBlockComponent: Sized {
    type Item;

    fn with<F: FnMut(Self::Item, Document) -> Document>(
        component: Self,
        block: F,
    ) -> CurriedIterBlockComponent<Self, F> {
        CurriedIterBlockComponent { component, block }
    }

    fn append(
        self,
        block: impl FnMut(Self::Item, Document) -> Document,
        document: Document,
    ) -> Document;
}

pub struct CurriedIterBlockComponent<
    B: IterBlockComponent,
    Block: FnMut(B::Item, Document) -> Document,
> {
    component: B,
    block: Block,
}

impl<B: IterBlockComponent, Block: FnMut(B::Item, Document) -> Document> Render
    for CurriedIterBlockComponent<B, Block>
{
    fn render(self, document: Document) -> Document {
        (self.component).append(self.block, document)
    }
}

// OnceBlockComponent //

pub trait OnceBlockComponent: Sized {
    type Item;

    fn with<F: FnOnce(Self::Item, Document) -> Document>(
        component: Self,
        block: F,
    ) -> CurriedOnceBlockComponent<Self, F> {
        CurriedOnceBlockComponent { component, block }
    }

    fn append(
        self,
        block: impl FnOnce(Self::Item, Document) -> Document,
        document: Document,
    ) -> Document;
}

pub struct CurriedOnceBlockComponent<
    B: OnceBlockComponent,
    Block: FnOnce(B::Item, Document) -> Document,
> {
    component: B,
    block: Block,
}

impl<B: OnceBlockComponent, Block: FnOnce(B::Item, Document) -> Document> Render
    for CurriedOnceBlockComponent<B, Block>
{
    fn render(self, document: Document) -> Document {
        (self.component).append(self.block, document)
    }
}

// InlineComponent //

struct CurriedInlineComponent<T> {
    function: fn(T, Document) -> Document,
    data: T,
}

impl<T> Render for CurriedInlineComponent<T> {
    fn render(self, document: Document) -> Document {
        (self.function)(self.data, document)
    }
}

#[allow(non_snake_case)]
pub fn Component<T>(function: fn(T, Document) -> Document, data: T) -> impl Render {
    CurriedInlineComponent { function, data }
}

/// This trait defines a renderable entity with arguments. Types that implement
/// `RenderComponent` can be packaged up together with their arguments in a
/// `Component`, and the `Component` is renderable.
///
/// # Example
///
/// ```
/// #[macro_use]
/// extern crate render_tree;
/// extern crate termcolor;
/// use render_tree::{Document, Line, Render, RenderComponent};
/// use termcolor::StandardStream;
///
/// struct MessageContents {
///     code: usize,
///     header: String,
///     body: String,
/// }
///
/// fn Message(args: MessageContents, into: Document) -> Document {
///     into.add(tree! {
///         <Line as {
///             {args.code} ":" {args.header}
///         }>
///
///         <Line as {
///             {args.body}
///         }>
///     })
/// }
///
/// fn main() -> std::io::Result<()> {
///     let message = MessageContents {
///         code: 200,
///         header: "Hello world".to_string(),
///         body: "This is the body of the message".to_string()
///     };
///
///     let document = tree! { <Message args={message}> };
///
///     document.write()
/// }
/// ```
pub trait RenderComponent<'args> {
    type Args;

    fn render(&self, args: Self::Args, into: Document) -> Document;
}

pub struct OnceBlock<F: FnOnce(Document) -> Document>(pub F);

impl<F> Render for OnceBlock<F>
where
    F: FnOnce(Document) -> Document,
{
    fn render(self, into: Document) -> Document {
        (self.0)(into)
    }
}

#[cfg(test)]
mod tests {
    use crate::component::*;

    #[test]
    fn test_inline_component() -> ::std::io::Result<()> {
        struct Header {
            code: usize,
            message: &'static str,
        }

        impl Render for Header {
            fn render(self, document: Document) -> Document {
                document.add(tree! {
                    {self.code} {": "} {self.message}
                })
            }
        }

        let code = 1;
        let message = "Something went wrong";

        let document = tree! {
            <Header code={code} message={message}>
        };

        assert_eq!(document.to_string()?, "1: Something went wrong");

        Ok(())
    }

    #[test]
    fn test_block_component() -> ::std::io::Result<()> {
        struct Message {
            code: usize,
            message: &'static str,
            trailing: &'static str,
        }

        impl BlockComponent for Message {
            fn append(
                self,
                block: impl FnOnce(Document) -> Document,
                mut document: Document,
            ) -> Document {
                document = document.add(tree! {
                    {self.code} {": "} {self.message} {" "}
                });

                document = block(document);

                document = document.add(tree! {
                    {self.trailing}
                });

                document
            }
        }

        let code = 1;
        let message = "Something went wrong";

        let document = tree! {
            <Message code={code} message={message} trailing={" -- yikes!"} as {
                {"!!! It's really quite bad !!!"}
            }>
        };

        assert_eq!(
            document.to_string()?,
            "1: Something went wrong !!! It's really quite bad !!! -- yikes!"
        );

        Ok(())
    }

    #[test]
    fn test_once_block_component() -> ::std::io::Result<()> {
        struct Message {
            code: usize,
            message: Option<&'static str>,
            trailing: &'static str,
        }

        impl OnceBlockComponent for Message {
            type Item = String;

            fn append(
                self,
                block: impl FnOnce(String, crate::Document) -> crate::Document,
                mut document: crate::Document,
            ) -> crate::Document {
                document = document.add(tree! {
                    {self.code} {": "}
                });

                if let Some(message) = self.message {
                    document = block(message.to_string(), document);
                }

                document = document.add(tree! {
                    {" "} {self.trailing}
                });

                document
            }
        }

        let code = 1;
        let message = Some("Something went wrong");

        let document = tree! {
            <Message code={code} message={message} trailing={"-- yikes!"} as |message| {
                {message} {" "} {"!!! It's really quite bad !!!"}
            }>
        };

        assert_eq!(
            document.to_string()?,
            "1: Something went wrong !!! It's really quite bad !!! -- yikes!"
        );

        Ok(())
    }
}