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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
// #![feature(
//     slice_patterns, extern_prelude, serde_impl
// )]

extern crate indexmap;

extern crate linked_hash_map;
extern crate regex;
extern crate serde;

#[macro_use]
extern crate serde_derive;
extern crate serde_yaml;

#[macro_use]
pub mod utils;
pub mod types;
pub mod yaml;

use indexmap::IndexSet;
use std::cmp;
use types::*;

#[allow(unused_imports)]
use utils::StripMargin;

#[test]
fn can_extract_headers() {
    let hdrs = vec![
        linkedhashmap![s!("foo") => s!("ggg"), s!("bar") => s!("fred"), s!("nop") => s!("no")], // foo bar nop
        linkedhashmap![s!("foo") => s!("seventy"), s!("bar") => s!("barry"), s!("nop") => s!("no"), s!("aaa") => s!("ddd")], //
        linkedhashmap![s!("bar") => s!("col has no foo"), s!("fff") => s!("ffsd")],
    ];

    let expected = indexset![s!("bar"), s!("foo"), s!("nop"), s!("aaa"), s!("fff")];
    let result = collect_headers(&hdrs);
    assert!(expected == result);
}

pub fn collect_headers(data: &[TableRow<String, String>]) -> IndexSet<String> {
    data.iter().flat_map(|hm| hm.keys().cloned()).collect()
}

#[test]
fn can_mk_header() {
    let hdr = mk_md_header(&vec![(s!("bard"), 5), (s!("other"), 8)]);

    // the | below is the margin
    let expected = "
   ||bard | other  |
   ||-----|--------|"
        .strip_margin();
    assert!(hdr == expected);
}

/// Returns a String of the heading and 2nd line of a markdown table.
///
/// # Arguments
///
/// `headings` - vector of headings (column titles over the table) and their sizes
///
pub fn mk_md_header(heading_data: &[(String, usize)]) -> String {
    let heading: String = heading_data.iter().fold(String::from("|"), |res, h| {
        format!("{}{: ^width$}|", res, h.0, width = h.1)
    });
    let dashed: String = heading_data.iter().fold(String::from("|"), |res, h| {
        format!("{}{:-^width$}|", res, "-", width = h.1)
    });

    format!("{}\n{}", heading, dashed)
}

#[test]
fn can_mk_data() {
    let tbl_md = mk_md_data(
        &vec![(s!("foo"), 5), (s!("bar"), 8)],
        &vec![
            linkedhashmap![s!("foo") => s!("ggg"), s!("bar") => s!("fred"), s!("nop") => s!("no")],
            linkedhashmap![s!("foo") => s!("seventy"), s!("bar") => s!("barry"), s!("nop") => s!("no")],
            linkedhashmap![s!("bar") => s!("col has no foo")],
        ],
        &None,
    );

    // the | below is the margin
    let expected = "
   || ggg |  fred  |
   ||seventy| barry  |
   ||     |col has no foo|"
        .strip_margin();

    println!("{}\n{}", tbl_md, expected);

    assert!(tbl_md == expected);
}

#[test]
fn can_mk_data_limiting_headers() {
    let tbl_md = mk_md_data(
        &vec![(s!("foo"), 5), (s!("bar"), 8)],
        &vec![
            linkedhashmap![s!("foo") => s!("ggg"), s!("bar") => s!("fred"), s!("nop") => s!("no")],
            linkedhashmap![s!("foo") => s!("seventy"), s!("bar") => s!("barry"), s!("nop") => s!("no")],
            linkedhashmap![s!("bar") => s!("col has no foo")],
        ],
        &None,
    );

    // the | below is the margin
    let expected = "
   || ggg |  fred  |
   ||seventy| barry  |
   ||     |col has no foo|"
        .strip_margin();

    println!("{}\n{}", tbl_md, expected);

    assert!(tbl_md == expected);
}

/// Takes an ordered list of tuples; (heading_data) (key, column_width) and a slice of TableRows, the cell values
/// The TableRow could carry more data than the keys provided. That is, only hm.get(key) will appear in the output.
///
/// returns a string of Markdown rows; `\n` separated in the form, layed out in the
/// width as per the heading_data.
///
///
/// ```text
/// | val1 | val3 | val4 | val5 |
/// ...
/// | val1 | val3 | val4 | val5 |
/// ```
///
/// # Arguments
///
/// `heading_data` - Name of column, and the width to use for each row.
/// `data`         - Vector of TableRows
/// `render_options` - Set of "config" that drives filtering, ordering, output.
///
pub fn mk_md_data(
    heading_data: &[(String, usize)],
    data: &[TableRow<String, String>],
    render_options: &Option<RenderOptions>,
) -> String {
    let filters: Option<Vec<KVFilter>> = render_options.clone().and_then(|ro| ro.filters);

    let iter: Box<Iterator<Item = &TableRow<String, String>>> = match filters {
        None => Box::new(data.iter()),
        Some(vfilts) => Box::new(
            data.iter()
                .filter(move |row| filter_tablerows(row, &vfilts)),
        ),
    };

    let ret: Vec<String> =
        iter.map(|hm| {
            heading_data.iter().fold(String::from("|"), |res, k| {
                let s = match hm.get(&k.0) {
                    Some(x) => x.to_string(),
                    None => "".into(),
                };

                format!("{}{: ^width$}|", res, s, width = k.1)
            })
        }).collect::<Vec<String>>();

    // make a new String of all the concatenated fields
    ret.join("\n")
}

///
/// For every filter im the Vec of filters, return true, immediately
/// if the tablerow passes the filter. (ignore all other filters)
///
fn filter_tablerows(row: &TableRow<String, String>, vfilters: &Vec<KVFilter>) -> bool {
    vfilters.iter().all(|f| tablerow_filter(row, f))
}

///
/// Per row filter. Takes a regex and the row.
/// If the "regex" for a key and a value returns one or more
/// matches (a key - to a cell), then this row is "kept". (returns true)
///
/// If the regex pair in KVFilter returns no matches across all cells the this
/// row is filtered out (return false)
fn tablerow_filter(row: &TableRow<String, String>, filt: &KVFilter) -> bool {
    row.keys()
        .filter(|k| {
            filt.key_re.is_match(k) && match row.get(k.clone()) {
                Some(v) => filt.value_re.is_match(v),
                None => false,
            }
        })
        .collect::<Vec<_>>()
        .len() > 0
}

#[test]
fn can_make_table() {
    let tbl_md = mk_table(
        &vec![
            linkedhashmap![s!("foo") => s!("ggg"), s!("bar") => s!("fred"), s!("nop") => s!("no")],
            linkedhashmap![s!("foo") => s!("seventy"), s!("bar") => s!("barry"), s!("nop") => s!("no")],
            linkedhashmap![s!("bar") => s!("col has no foo")],
        ],
        &Some(RenderOptions {
            headings: Some(vec![s!("foo"), s!("bar")]),
            ..Default::default()
        }),
    );

    // the | below is the margin
    let expected = "
    ||  foo  |     bar      |
    ||-------|--------------|
    ||  ggg  |     fred     |
    ||seventy|    barry     |
    ||       |col has no foo|"
        .strip_margin();

    assert!(tbl_md == expected);
}

#[test]
fn can_make_table_all_cols() {
    let tbl_md = mk_table(
        &vec![
            linkedhashmap![s!("foo") => s!("ggg"), s!("bar") => s!("fred"), s!("nop") => s!("no")],
            linkedhashmap![s!("foo") => s!("seventy"), s!("bar") => s!("barry"), s!("nop") => s!("no")],
            linkedhashmap![s!("bar") => s!("col has no foo")],
        ],
        &None,
    );

    // the | below is the margin
    let expected = "
    ||  foo  |     bar      |nop|
    ||-------|--------------|---|
    ||  ggg  |     fred     |no |
    ||seventy|    barry     |no |
    ||       |col has no foo|   |"
        .strip_margin();

    println!("{}\n{}", tbl_md, expected);

    assert!(tbl_md == expected);
}

/// Takes an ordered list of headings and a Vector of TableRows, the cell values
/// and produces a formatted Markdown Table.
///
/// # Arguments
///
/// `data`           - Slice of TableRows
/// `render_options` - Set of "config" that drives filtering, ordering, output.
///
pub fn mk_table(
    data: &[TableRow<String, String>],
    render_options: &Option<RenderOptions>,
) -> String {
    // for each heading, find the "widest" heading, or value

    let headings = match render_options {
        Some(RenderOptions {
            headings: Some(h), ..
        }) => h.clone(),
        _ => collect_headers(data).into_iter().collect(),
    };

    let heading_data: Vec<(String, usize)> = headings
        .iter()
        .map(|h| {
            (
                h.clone(),
                data.iter().fold(h.len(), |max, hm| {
                    cmp::max(
                        max,
                        match hm.get(h) {
                            Some(v) => v.to_string().len(),
                            None => 0,
                        },
                    )
                }),
            )
        })
        .collect::<Vec<(String, usize)>>();

    format!(
        "{}\n{}",
        mk_md_header(&heading_data),
        mk_md_data(&heading_data, data, render_options)
    )
}

#[test]
fn can_mk_table_with_1_filter() {
    let tbl_md = mk_table(
        &vec![
            linkedhashmap![s!("foo") => s!("ggg"), s!("bar") => s!("fred"), s!("nop") => s!("no")],
            linkedhashmap![s!("foo") => s!("seventy"), s!("bar") => s!("barry"), s!("nop") => s!("no")],
            linkedhashmap![s!("bar") => s!("col has no foo")],
        ],
        &Some(RenderOptions {
            headings: Some(vec![s!("foo"), s!("bar")]),
            filters: Some(vec![KVFilter::new(s!("foo"), s!("ggg"))]),

            ..Default::default()
        }),
    );

    // the | below is the margin
    let expected = "
    ||  foo  |     bar      |
    ||-------|--------------|
    ||  ggg  |     fred     |"
        .strip_margin();

    println!("{}\n{}", tbl_md, expected);

    assert!(tbl_md == expected);
}

#[test]
fn can_mk_table_with_2_filter() {
    let tbl_md = mk_table(
        &vec![
            linkedhashmap![s!("foo") => s!("ggg"), s!("bar") => s!("fred"), s!("nop") => s!("no")],
            linkedhashmap![s!("foo") => s!("ggg"), s!("bar") => s!("barry"), s!("nop") => s!("no")],
            linkedhashmap![s!("bar") => s!("col has no foo")],
        ],
        &Some(RenderOptions {
            headings: Some(vec![s!("foo"), s!("bar")]),
            filters: Some(vec![
                KVFilter::new(s!("foo"), s!("ggg")),
                KVFilter::new(s!("bar"), s!("barry")),
            ]),

            ..Default::default()
        }),
    );

    // the | below is the margin
    let expected = "
    ||foo|     bar      |
    ||---|--------------|
    ||ggg|    barry     |"
        .strip_margin();

    println!("{}\n{}", tbl_md, expected);

    assert!(tbl_md == expected);
}

///
/// We want to see if the regexp finds values in other "not" aligned cells
/// and because a "heading" filter is applied (afte the fact) the cell that has
/// an 'r' in it, doesn't come in the output.
#[test]
fn can_mk_table_with_value_regex() {
    let tbl_md = mk_table(
        &vec![
            linkedhashmap![s!("foo") => s!("ggg"), s!("bar") => s!("fred"), s!("nop") => s!("no")],
            linkedhashmap![s!("foo") => s!("ggg"), s!("bar") => s!("abc"), s!("nop") => s!("has an r here")],
            linkedhashmap![s!("bar") => s!("col has no foo")],
        ],
        &Some(RenderOptions {
            headings: Some(vec![s!("foo"), s!("bar")]),
            filters: Some(vec![KVFilter::new(s!(".*"), s!(".*r.*"))]),

            ..Default::default()
        }),
    );

    // the | below is the margin
    let expected = "
    ||foo|     bar      |
    ||---|--------------|
    ||ggg|     fred     |
    ||ggg|     abc      |"
        .strip_margin();

    println!("{}\n{}", tbl_md, expected);

    assert!(tbl_md == expected);
}

///
/// From Spreadsheets, or keyed YAML files, the table could be named.
/// When we generate the Markdown, we optionally may want the title of the
/// table at the beginning.
///
pub fn named_table_to_md(
    table: Result<NamedTable<String, String>, ErroredTable>,
    print_name: bool,
    render_options: &Option<RenderOptions>,
) -> String {
    match table {
        Err((name, error)) => format!("Sheet `{}` errored: {}", name, error),
        Ok((name, table_data)) => {
            if print_name {
                format!("**{}**\n{}", name, mk_table(&table_data, render_options))
            } else {
                mk_table(&table_data, render_options)
            }
        }
    }
}