gq-core 0.1.0

Core library for the GQ project. Currently is not intended for use outside of GQ frontends. Breaking changes may occur at any time.
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

use std::{
    fmt::{self, Display, Formatter},
    rc::Rc,
};

use derive_getters::Getters;

use super::query_key::{QueryKey, RawKey};

#[derive(Debug, Clone, Copy)]
pub enum JsonPathEntry<'a> {
    // TODO: should we use &str or RawKey?
    Key(&'a str),
    Index(usize),
}

// TODO: use Cow instead of an owned version like the AtomicQueryKey
#[derive(Debug, Clone)]
pub enum OwnedJsonPathEntry {
    Key(String),
    Index(usize),
}

impl From<&JsonPathEntry<'_>> for OwnedJsonPathEntry {
    fn from(entry: &JsonPathEntry) -> Self {
        match entry {
            JsonPathEntry::Key(key) => OwnedJsonPathEntry::Key(key.to_string()),
            JsonPathEntry::Index(index) => OwnedJsonPathEntry::Index(*index),
        }
    }
}

#[derive(Debug, Clone)]
pub enum JsonPath<'a> {
    Root,
    Node {
        entry: JsonPathEntry<'a>,
        parent: Rc<JsonPath<'a>>,
    },
}

impl<'a> JsonPath<'a> {
    pub fn push(&self, entry: JsonPathEntry<'a>) -> Self {
        Self::Node {
            entry,
            parent: Rc::new(self.clone()),
        }
    }
}

// TODO: check if this works ok for keys with \n and etc
impl Display for JsonPath<'_> {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        match self {
            JsonPath::Root => write!(f, "."),
            JsonPath::Node { entry, parent } => {
                match **parent {
                    JsonPath::Root => {}
                    _ => parent.fmt(f)?,
                }
                match entry {
                    JsonPathEntry::Key(key) => write!(f, ".{key}"),
                    JsonPathEntry::Index(index) => write!(f, "[{index}]"),
                }
            }
        }
    }
}

#[derive(Debug, Clone)]
pub struct OwnedJsonPath(pub Vec<OwnedJsonPathEntry>);

impl From<&JsonPath<'_>> for OwnedJsonPath {
    fn from(json_path: &JsonPath) -> Self {
        let mut key_path = Vec::new();
        let mut current = json_path;
        while let JsonPath::Node { entry, parent } = current {
            key_path.push(OwnedJsonPathEntry::from(entry));
            current = parent;
        }
        key_path.reverse();
        OwnedJsonPath(key_path)
    }
}

// TODO: check if this works ok for keys with \n and etc
impl Display for OwnedJsonPath {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        if self.0.is_empty() {
            return write!(f, ".");
        }
        for entry in &self.0 {
            match entry {
                OwnedJsonPathEntry::Key(key) => write!(f, ".{key}")?,
                OwnedJsonPathEntry::Index(index) => write!(f, "[{index}]")?,
            }
        }
        Ok(())
    }
}

#[derive(Debug, Clone, Getters)]
pub struct ArrayContext<'a> {
    path: JsonPath<'a>,
}

#[derive(Debug, Clone, Getters)]
pub struct Context<'a> {
    path: JsonPath<'a>,
    array_context: Option<ArrayContext<'a>>,
}

impl<'a> Context<'a> {
    pub fn new() -> Self {
        Self::default()
    }

    // TODO: see if &'a is necessary
    pub fn push_raw_key(&self, raw_key: &'a RawKey) -> Context<'a> {
        let entry = JsonPathEntry::Key(raw_key.as_str());
        self.push_entry(entry)
    }

    pub fn push_index(&self, index: usize) -> Context<'a> {
        let entry = JsonPathEntry::Index(index);
        self.push_entry(entry)
    }

    // TODO: see if &'a is necessary
    pub fn push_query_key(&self, query_key: &'a QueryKey) -> Context<'a> {
        let mut path = self.path.clone();
        // TODO: cleanup here
        for atomic_query_key in query_key.keys() {
            path = path.push(JsonPathEntry::Key(atomic_query_key.key().as_str()));
        }
        Self {
            path,
            ..self.clone()
        }
    }

    pub fn enter_array(&self) -> Self {
        Self {
            array_context: Some(ArrayContext {
                path: self.path.clone(),
            }),
            ..self.clone()
        }
    }

    fn push_entry(&self, entry: JsonPathEntry<'a>) -> Context<'a> {
        Self {
            path: self.path.push(entry),
            ..self.clone()
        }
    }
}

impl Default for Context<'_> {
    fn default() -> Self {
        Self {
            path: JsonPath::Root,
            array_context: None,
        }
    }
}