txtpp 0.2.4

A simple-to-use general purpose preprocessor for text files.
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
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

mod common;
use common::*;

use txtpp::*;

testit!(tests__examples__empty_test, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("empty1", "empty1.txtpp");
    env.assert_file_eq("empty2", "empty2.txtpp");
    env.assert_file_eq("emptyempty", "emptyempty.txtpp");
});

testit!(tests__examples__include, |env| {
    env.cfg.mode = Mode::Verify;
    // before output
    assert!(env.run().is_err());
    env.cfg.mode = Mode::Build;
    assert!(env.run().is_ok());
    env.assert_file_eq("foo.txt", "foo.txt.expected");
    env.assert_file_eq("biz.txt", "biz.txt.expected");
    env.cfg.mode = Mode::Verify;
    assert!(env.run().is_ok());
    env.set_file("foo.txt", "not the same");
    assert!(env.run().is_err());
    env.cfg.mode = Mode::Clean;
    assert!(env.run().is_ok());
    env.assert_path_exists("foo.txt", false);
    // non-existent target should error
    env.cfg.mode = Mode::Build;
    env.cfg.inputs = vec!["a.txt".to_string()];
    assert!(env.run().is_err());
    env.cfg.inputs = vec!["a.txtpp".to_string()];
    assert!(env.run().is_err());
});

#[cfg(not(windows))]
testit!(tests__examples__multiple_include, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("a", "a.expected");
    env.assert_file_eq("b", "b.expected");
    env.assert_file_eq("c", "c.expected");
});

#[cfg(windows)]
testit!(tests__examples__multiple_include_windows, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("a", "a.expected");
    env.assert_file_eq("b", "b.expected");
    env.assert_file_eq("c", "c.expected");
});

testit!(tests__examples__run, |env| {
    env.cfg.mode = Mode::Build;
    env.cfg.inputs = vec!["foo.txt.txtpp".to_string()];
    assert!(env.run().is_ok());
    env.assert_file_eq("foo.txt", "foo.txt.expected");
    env.cfg.inputs = vec!["invalid.txtpp".to_string()];
    assert!(env.run().is_err());
});

testit!(tests__examples__circular_dep, |env| {
    env.cfg.mode = Mode::Build;
    env.cfg.inputs = vec!["a.txt".to_string()];
    assert!(env.run().is_err());
    env.assert_file_eq("c.txt", "c.txt.expected");
});

testit!(tests__examples__circular_dep_self, |env| {
    assert!(env.run().is_err());
    env.assert_file_eq("invalid", "invalid.expected");
});

testit!(tests__examples__temp__write_clean, |env| {
    assert!(env.run().is_ok());
    // content should match
    env.assert_file_eq("exp", "exp.expected");
    env.assert_file_eq("temp.out", "temp.out.expected");
    env.cfg.mode = Mode::Clean;
    assert!(env.run().is_ok());
    env.assert_path_exists("temp.out", false);
    env.assert_path_exists("exp", false);
    // verify should fail fast, so temp.out is not created
    env.cfg.mode = Mode::Verify;
    assert!(env.run().is_err());
    env.set_file("exp", "not the same");
    assert!(env.run().is_err());
    env.assert_path_exists("temp.out", false);
    env.set_file(
        "exp",
        "This example writes to a temp file, then include it\nThis line should be in the output",
    );
    // since the first part is the same, it will create the temp file
    assert!(env.run().is_err());
    env.assert_path_exists("temp.out", true);
});

testit!(tests__examples__temp__python_script, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("city.js", "city.js.expected");
    env.assert_file_eq("gen_cities.g.py", "gen_cities.g.py.expected");
    env.cfg.mode = Mode::Clean;
    assert!(env.run().is_ok());
    env.assert_path_exists("city.js", false);
    env.assert_path_exists("gen_cities.g.py", false);
});

testit!(tests__examples__trailing_newline, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("source", "source.expected.trailing");
    env.cfg.trailing_newline = false;
    assert!(env.run().is_ok());
    env.assert_file_eq("source", "source.expected");
});

testit!(tests__examples__tag__inject_one, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("a", "a.expected");
});

#[cfg(target_os = "linux")]
testit!(tests__examples__tag__inject_serial, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("b.html", "b.html.expected");
});

#[cfg(windows)]
testit!(tests__examples__tag__inject_serial_windows, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("b.html", "b.html.expected");
});

#[cfg(target_os = "linux")]
testit!(tests__examples__tag__inject_multiple, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("test.txt", "test.txt.expected");
});

#[cfg(windows)]
testit!(tests__examples__tag__inject_multiple_windows, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("test.txt", "test.txt.expected");
});

testit!(tests__examples__tag__no_output_skip, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("test", "test.expected");
    env.assert_file_eq("temp", "temp.expected");
});

testit!(tests__examples__tag__error, |env| {
    env.cfg.inputs = vec!["tag_multiple_same".to_string()];
    assert!(env.run().is_err());
    env.cfg.inputs = vec!["tag_multiple_prefix".to_string()];
    assert!(env.run().is_err());
    env.cfg.inputs = vec!["tag_multiple_prefix2".to_string()];
    assert!(env.run().is_err());
});

testit!(tests__examples__tag__inject_once, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("test", "test.expected");
});

testit!(tests__examples__tag__unused_at_end, |env| {
    assert!(env.run().is_err());
});

testit!(tests__examples__tag__complex, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("test", "test.expected");
});

testit!(tests__examples__temp__save_txtpp, |env| {
    // should not be able to save a txtpp file
    assert!(env.run().is_err());
    env.set_file("temp.txtpp", "something");
    env.cfg.mode = Mode::Clean;
    assert!(env.run().is_ok());
    // clean should not clean temp files that end with txtpp
    env.assert_path_exists("temp.txtpp", true);
});

testit!(tests__examples__write__normal, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("nonewline", "nonewline.expected");
    env.assert_file_eq("newline", "newline.expected");
});

testit!(tests__examples__write__escape, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("test", "test.expected");
});

testit!(tests__examples__write__inject_tags, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("test", "test.expected");
});

testit!(tests__examples__other__txtpp_subcommand, |env| {
    assert!(env.run().is_err());
});

testit!(tests__examples__temp__no_rewrite, |env| {
    assert!(env.run().is_ok());
    env.assert_file_eq("test", "test.expected");
    env.assert_path_exists("hello.txt", true);
    env.assert_path_exists("test", true);
    let modified = env.get_modification_time("hello.txt").unwrap();
    let modified_out = env.get_modification_time("test").unwrap();

    // call verify now, should not rewrite
    env.cfg.mode = Mode::Verify;
    assert!(env.run().is_ok());
    let modified2 = env.get_modification_time("hello.txt").unwrap();
    let modified_out2 = env.get_modification_time("test").unwrap();
    assert_eq!(modified, modified2);
    assert_eq!(modified_out, modified_out2);

    // using in memory build should not rewrite
    env.cfg.mode = Mode::InMemoryBuild;
    assert!(env.run().is_ok());
    let modified3 = env.get_modification_time("hello.txt").unwrap();
    let modified_out3 = env.get_modification_time("test").unwrap();
    assert_eq!(modified, modified3);
    assert_eq!(modified_out, modified_out3);

    // using regular build should rewrite
    env.cfg.mode = Mode::Build;
    assert!(env.run().is_ok());
    let modified4 = env.get_modification_time("hello.txt").unwrap();
    let modified_out4 = env.get_modification_time("test").unwrap();
    assert_eq!(modified, modified4); // temp file is always checked before re-written
    assert_ne!(modified_out, modified_out4);
});

testit!(tests__examples__after, |env| {
    env.cfg_mut().inputs = vec!["example".to_string()];
    assert!(env.run().is_ok());
    env.assert_file_eq("example", "example.expected");
});