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
//! Utilities to include queried fields in APIs

use serde::{Deserialize, Deserializer, Serialize, Serializer};

/// This type represents the fields queried by a request.
///
/// Nested fields are allowed using a dot (`.`) separator.
/// ```ignore
/// vec![
///   "fieldOne",
///   "fieldTwo.child",
///   "fieldTwo.otherChild.field"
/// ];
/// ```
///
/// It's serialized as an optional `Vec<String>` so it can be directly used in query strings or bodies.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum QueriedFields {
    /// Query all the fields available
    All,
    /// query just the listed fields
    Fields(Vec<String>),
}
impl Serialize for QueriedFields {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match self {
            QueriedFields::All => serializer.serialize_none(),
            QueriedFields::Fields(fields) => serializer.serialize_some(fields),
        }
    }
}
impl<'de> Deserialize<'de> for QueriedFields {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let fields: Option<Vec<String>> = serde::Deserialize::deserialize(deserializer)?;
        match fields {
            Some(fields) => Ok(Self::Fields(fields)),
            None => Ok(Self::All),
        }
    }
}
impl From<Option<Vec<String>>> for QueriedFields {
    fn from(value: Option<Vec<String>>) -> Self {
        match value {
            Some(fields) => QueriedFields::Fields(fields),
            None => QueriedFields::All,
        }
    }
}
impl From<QueriedFields> for Option<Vec<String>> {
    fn from(value: QueriedFields) -> Self {
        match value {
            QueriedFields::All => None,
            QueriedFields::Fields(fields) => Some(fields),
        }
    }
}
impl From<Vec<String>> for QueriedFields {
    fn from(value: Vec<String>) -> Self {
        Self::Fields(value)
    }
}
impl From<&[String]> for QueriedFields {
    fn from(value: &[String]) -> Self {
        Self::Fields(value.to_vec())
    }
}
impl From<Vec<&str>> for QueriedFields {
    fn from(value: Vec<&str>) -> Self {
        Self::Fields(value.into_iter().map(String::from).collect())
    }
}
impl From<&[&str]> for QueriedFields {
    fn from(value: &[&str]) -> Self {
        Self::Fields(value.iter().map(|&s| s.into()).collect())
    }
}

impl QueriedFields {
    /// Returns wether every field is being queried or not
    pub fn all_fields_queried(&self) -> bool {
        match self {
            QueriedFields::All => true,
            QueriedFields::Fields(_) => false,
        }
    }

    /// Checks wether no fields are being queried
    pub fn is_empty(&self) -> bool {
        match self {
            QueriedFields::All => false,
            QueriedFields::Fields(f) => f.is_empty(),
        }
    }

    /// Checks if a given field is being queried.
    ///
    /// ## Examples:
    /// ``` rust
    /// # use graphql_starter::queried_fields::QueriedFields;
    /// let query = QueriedFields::from(vec!["a", "a.b.c", "a.b.d", "b", "c.d"]);
    ///
    /// assert!(query.contains("a"));
    /// assert!(query.contains("a.b"));
    /// assert!(!query.contains("d"));
    /// ```
    pub fn contains(&self, field: &str) -> bool {
        match self {
            QueriedFields::All => true,
            QueriedFields::Fields(fields) => {
                let prefix = format!("{field}.");
                fields.iter().any(|f| f == field || f.starts_with(&prefix))
            }
        }
    }

    /// Checks if there are other top-level fields queried not present on the list.
    ///
    /// This method will return true always if all fields are queried, no matter if you manually provide all of them.
    ///
    /// # Examples:
    /// ``` rust
    /// # use graphql_starter::queried_fields::QueriedFields;
    /// let query = QueriedFields::from(vec!["a", "b", "b.d", "c"]);
    ///
    /// assert!(query.other_than(&["a", "b"]));
    /// assert!(!query.other_than(&["a", "b", "c"]));
    /// ```
    pub fn other_than(&self, fields: &[&str]) -> bool {
        match self {
            QueriedFields::All => true,
            QueriedFields::Fields(queried_fields) => queried_fields.iter().any(|f| match f.split_once('.') {
                Some((f, _)) => !fields.contains(&f),
                None => !fields.contains(&f.as_str()),
            }),
        }
    }

    /// Returns the [QueriedFields] for a given child field.
    ///
    /// ## Examples:
    /// ``` rust
    /// # use graphql_starter::queried_fields::QueriedFields;
    /// let query = QueriedFields::from(vec!["a", "a.b.c", "a.b.d", "b", "c.d"]);
    ///
    /// assert!(query.child("d").is_empty());
    /// assert!(query.child("a.b").contains("c"));
    /// assert!(query.child("a.b").contains("d"));
    /// ```
    pub fn child(&self, field: &str) -> QueriedFields {
        match self {
            QueriedFields::All => QueriedFields::All,
            QueriedFields::Fields(fields) => {
                if fields.is_empty() {
                    QueriedFields::Fields(Vec::default())
                } else {
                    let prefix = format!("{field}.");
                    QueriedFields::Fields(
                        fields
                            .iter()
                            .filter_map(|s| s.strip_prefix(&prefix).map(|stripped| stripped.to_string()))
                            .collect(),
                    )
                }
            }
        }
    }

    /// Returns the [QueriedFields] for the [Edge's](crate::pagination::Edge) `node` in a
    /// [Page](crate::pagination::Page).
    ///
    /// ## Examples:
    /// ``` rust
    /// # use graphql_starter::queried_fields::QueriedFields;
    /// let query = QueriedFields::from(vec![
    ///     "pageInfo.hasNextCursor",
    ///     "pageInfo.endCursor",
    ///     "totalItems",
    ///     "edges.node.a",
    ///     "nodes.b",
    /// ]);
    ///
    /// assert!(query.nodes().contains("a"));
    /// assert!(query.nodes().contains("b"));
    /// assert!(!query.nodes().contains("c"));
    /// ```
    pub fn nodes(&self) -> QueriedFields {
        match self {
            QueriedFields::All => QueriedFields::All,
            QueriedFields::Fields(fields) => {
                if fields.is_empty() {
                    QueriedFields::Fields(Vec::default())
                } else {
                    match (self.child("nodes"), self.child("edges").child("node")) {
                        (QueriedFields::Fields(mut nodes_fields), QueriedFields::Fields(mut edges_fields)) => {
                            nodes_fields.append(&mut edges_fields);
                            nodes_fields.sort();
                            nodes_fields.dedup();
                            QueriedFields::Fields(nodes_fields)
                        }
                        _ => QueriedFields::All,
                    }
                }
            }
        }
    }

    #[cfg(feature = "graphql")]
    /// Returns the [QueriedFields] for the [GraphQLMap's](crate::graphql::GraphQLMap)
    /// [entry](crate::graphql::GraphQLMapEntry) `values`.
    ///
    /// It's really a shortcut to `.child("value")`
    ///
    /// ## Examples:
    /// ``` rust
    /// # use graphql_starter::queried_fields::QueriedFields;
    /// let query = QueriedFields::from(vec!["a", "b.key", "b.value.c", "b.value.d"]);
    ///
    /// assert!(query.child("b").entry_values().contains("c"));
    /// assert!(query.child("b").entry_values().contains("d"));
    /// ```
    pub fn entry_values(&self) -> QueriedFields {
        self.child("value")
    }
}