postgrest-parser 0.2.0

PostgREST URL-to-SQL parser for Rust and WASM
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ItemType {
    Field,
    Relation,
    Spread,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ItemHint {
    Inner(String),
    JsonPathCast(Vec<String>, String),
    JsonPath(Vec<String>),
    Cast(String),
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SelectItem {
    pub item_type: ItemType,
    pub name: String,
    pub alias: Option<String>,
    pub children: Option<Vec<SelectItem>>,
    pub hint: Option<ItemHint>,
}

impl SelectItem {
    pub fn field(name: impl Into<String>) -> Self {
        Self {
            item_type: ItemType::Field,
            name: name.into(),
            alias: None,
            children: None,
            hint: None,
        }
    }

    pub fn with_alias(mut self, alias: impl Into<String>) -> Self {
        self.alias = Some(alias.into());
        self
    }

    pub fn with_children(mut self, children: Vec<SelectItem>) -> Self {
        self.children = Some(children);
        self
    }

    pub fn with_hint(mut self, hint: ItemHint) -> Self {
        self.hint = Some(hint);
        self
    }

    pub fn relation(name: impl Into<String>) -> Self {
        Self {
            item_type: ItemType::Relation,
            name: name.into(),
            alias: None,
            children: None,
            hint: None,
        }
    }

    pub fn spread(name: impl Into<String>) -> Self {
        Self {
            item_type: ItemType::Spread,
            name: name.into(),
            alias: None,
            children: None,
            hint: None,
        }
    }

    pub fn wildcard() -> Self {
        Self::field("*".to_string())
    }
}

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

    #[test]
    fn test_select_item_field() {
        let item = SelectItem::field("id");
        assert_eq!(item.item_type, ItemType::Field);
        assert_eq!(item.name, "id");
        assert!(item.alias.is_none());
    }

    #[test]
    fn test_select_item_with_alias() {
        let item = SelectItem::field("name").with_alias("user_name");
        assert_eq!(item.alias, Some("user_name".to_string()));
    }

    #[test]
    fn test_select_item_with_children() {
        let item = SelectItem::relation("client")
            .with_children(vec![SelectItem::field("id"), SelectItem::field("name")]);
        assert_eq!(item.item_type, ItemType::Relation);
        assert_eq!(item.children.as_ref().unwrap().len(), 2);
    }

    #[test]
    fn test_select_item_wildcard() {
        let item = SelectItem::wildcard();
        assert_eq!(item.name, "*");
        assert_eq!(item.item_type, ItemType::Field);
    }

    #[test]
    fn test_select_item_spread() {
        let item = SelectItem::spread("profile");
        assert_eq!(item.item_type, ItemType::Spread);
        assert_eq!(item.name, "profile");
    }

    #[test]
    fn test_select_item_serialization() {
        let item = SelectItem::field("id").with_alias("user_id");
        let json = serde_json::to_string(&item).unwrap();
        assert!(json.contains("id"));
        assert!(json.contains("user_id"));
    }
}