tekton 0.3.0

A blazingly fast code snippet sorter
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

//! Structures to model the JSON snippet format

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// A custom type to shorten function signatures
pub type Table = HashMap<String, FriendlySnippetBody>;

/// The Struct representing the JSON file of snippets
#[derive(Debug, Serialize, Deserialize)]
pub struct FriendlySnippets {
    /// The hashmap (table) that represents the source snippet file
    #[serde(flatten)]
    pub snippets: Table,
}

impl FriendlySnippets {
    pub fn new() -> Self {
        Self {
            snippets: HashMap::new(),
        }
    }
}

impl Default for FriendlySnippets {
    fn default() -> Self {
        Self::new()
    }
}

/// A struct representing the body of a snippet from the `FriendlySnippets` hashmap
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq, Clone)]
pub struct FriendlySnippetBody {
    /// The trigger for the snippet
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prefix: Option<String>,
    /// The 'snippet' contents
    pub body: Vec<String>,
    /// An optional description explaining the snippet
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

impl FriendlySnippetBody {
    pub fn new(
        prefix: Option<String>,
        body: Vec<String>,
        description: Option<String>,
    ) -> FriendlySnippetBody {
        FriendlySnippetBody {
            prefix,
            body,
            description,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_snippet_body_creation() {
        let body = FriendlySnippetBody::new(
            Some("snip".to_string()),
            Vec::new(),
            Some("Description".to_string()),
        );
        assert_eq!(body.prefix, Some("snip".to_string()));
        assert_eq!(body.body.len(), 0);
    }

    #[test]
    fn test_friendly_snippets() {
        let mut hp: FriendlySnippets = FriendlySnippets {
            snippets: HashMap::new(),
        };
        let body = FriendlySnippetBody::new(
            Some("snip".to_string()),
            Vec::new(),
            Some("Description".to_string()),
        );
        let expected_body = FriendlySnippetBody::new(
            Some("snip".to_string()),
            Vec::new(),
            Some("Description".to_string()),
        );
        hp.snippets.insert("test".to_string(), body);
        assert_eq!(
            hp.snippets.get(&"test".to_string()).unwrap(),
            &expected_body
        );
    }

    #[test]
    fn friendly_description_is_none() {
        let mut hp: FriendlySnippets = FriendlySnippets {
            snippets: HashMap::new(),
        };
        let body = FriendlySnippetBody::new(Some("snip".to_string()), Vec::new(), None);
        let expected_body = FriendlySnippetBody::new(Some("snip".to_string()), Vec::new(), None);
        hp.snippets.insert("test".to_string(), body);
        assert_eq!(
            hp.snippets.get(&"test".to_string()).unwrap(),
            &expected_body
        );
    }
}