tramlines-md 0.2.2

Checks markdown documents against a schema, and derives the scaffold a schema implies.
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

//! Heading slugs, formed as repository hosts form theirs (TLMD_101).

/// Lowercase; keep letters, digits, spaces, hyphens and underscores; drop
/// every other character; spaces to hyphens.
// sokf-implements: TLMD_101
pub fn slug(heading: &str) -> String {
    heading
        .to_lowercase()
        .chars()
        .filter(|c| c.is_alphanumeric() || *c == ' ' || *c == '-' || *c == '_')
        .map(|c| if c == ' ' { '-' } else { c })
        .collect()
}

#[cfg(test)]
mod tests {
    use proptest::prelude::*;

    use super::*;
    use crate::markdown::is_slug;

    #[test]
    fn forms_slugs_like_a_repository_host() {
        assert_eq!(slug("Acceptance Criteria"), "acceptance-criteria");
        assert_eq!(slug("CLI-1_AC-2"), "cli-1_ac-2");
        assert_eq!(slug("What's `this`? (v2)"), "whats-this-v2");
        assert_eq!(slug("  two  spaces "), "--two--spaces-");
        assert_eq!(slug("Ünïcode Ok"), "ünïcode-ok");
        assert_eq!(slug(""), "");
    }

    #[test]
    fn recognizes_spec_5_slugs() {
        for ok in ["a", "issue-004-retry", "x1-2y"] {
            assert!(is_slug(ok), "{ok}");
        }
        for bad in ["", "-a", "a-", "a--b", "A", "a_b", "a b", "é"] {
            assert!(!is_slug(bad), "{bad}");
        }
    }

    // sokf-tests: TLMD_101
    proptest! {
        #![proptest_config(ProptestConfig::with_cases(256))]

        #[test]
        fn slug_is_idempotent_and_well_formed(heading in "\\PC{0,40}") {
            let once = slug(&heading);
            prop_assert_eq!(slug(&once), once.clone());
            for c in once.chars() {
                prop_assert!(c.is_alphanumeric() || c == '-' || c == '_');
            }
            prop_assert_eq!(once.to_lowercase(), once.clone());
        }
    }
}