musq 0.0.4

Musq is an asynchronous SQLite toolkit for Rust.
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
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
use indexmap::IndexMap;

use crate::{Result, Value, encode::Encode, expr::Expr, query::Query};

/// A value in a [`Values`] collection.
#[derive(Debug, Clone)]
pub enum ValuesEntry {
    /// A bound value (encoded immediately).
    Value(Value),
    /// A SQL expression fragment (may include its own bound parameters).
    Expr(Expr),
}

/// Convert a value into a [`ValuesEntry`].
pub trait IntoValuesEntry {
    /// Convert into a [`ValuesEntry`].
    fn into_values_entry(self) -> Result<ValuesEntry>;
}

impl<T> IntoValuesEntry for T
where
    T: Encode,
{
    fn into_values_entry(self) -> Result<ValuesEntry> {
        let encoded = self.encode().map_err(crate::Error::Encode)?;
        drop(self);
        Ok(ValuesEntry::Value(encoded))
    }
}

impl IntoValuesEntry for Expr {
    fn into_values_entry(self) -> Result<ValuesEntry> {
        Ok(ValuesEntry::Expr(self))
    }
}

impl IntoValuesEntry for Query {
    fn into_values_entry(self) -> Result<ValuesEntry> {
        Ok(ValuesEntry::Expr(self.into()))
    }
}

/// An ordered collection of key-value pairs for building dynamic SQL queries.
///
/// When used with the `sql!` macro's `{where:values}` placeholder, `NULL` values are rendered as
/// `col IS NULL` (without a bound parameter).
///
/// Values may also include SQL expression fragments (see [`crate::expr`]) for computed columns in
/// `{set:...}` and `{insert:...}` placeholders.
#[derive(Debug, Default, Clone)]
pub struct Values(IndexMap<String, ValuesEntry>);

impl Values {
    /// Creates a new, empty `Values` collection.
    pub fn new() -> Self {
        Self::default()
    }

    /// Inserts a key-value pair into the collection.
    /// The key should be the name of the database column.
    pub fn insert<K, V>(&mut self, key: K, value: V) -> Result<()>
    where
        K: Into<String>,
        V: IntoValuesEntry,
    {
        self.0.insert(key.into(), value.into_values_entry()?);
        Ok(())
    }

    /// Consumes `self`, inserts a key-value pair, and returns `Self` for
    /// chaining.
    pub fn val<K, V>(mut self, key: K, value: V) -> Result<Self>
    where
        K: Into<String>,
        V: IntoValuesEntry,
    {
        self.insert(key, value)?;
        Ok(self)
    }

    /// Returns `true` if the collection contains no elements.
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Returns the number of elements in the collection.
    pub fn len(&self) -> usize {
        self.0.len()
    }

    /// Iterate over key-value pairs in insertion order.
    pub fn iter(&self) -> impl Iterator<Item = (&String, &ValuesEntry)> {
        self.0.iter()
    }

    /// Iterate over the keys in insertion order.
    pub fn keys(&self) -> impl Iterator<Item = &String> {
        self.0.keys()
    }

    /// Iterate over the values in insertion order.
    pub fn values(&self) -> impl Iterator<Item = &ValuesEntry> {
        self.0.values()
    }

    /// Extends this collection with the key-value pairs from another `Values` collection.
    ///
    /// If a key exists in both collections, the value from `other` will overwrite
    /// the existing value in this collection. The insertion order is preserved,
    /// with existing keys maintaining their position and new keys appended.
    pub fn extend(&mut self, other: &Self) {
        self.0
            .extend(other.0.iter().map(|(k, v)| (k.clone(), v.clone())));
    }
}

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

    #[test]
    fn test_extend_with_new_keys() {
        let mut values1 = Values::new()
            .val("id", 1)
            .unwrap()
            .val("name", "Alice")
            .unwrap();

        let values2 = Values::new()
            .val("email", "alice@example.com")
            .unwrap()
            .val("status", "active")
            .unwrap();

        values1.extend(&values2);

        assert_eq!(values1.len(), 4);

        // Check that all keys are present
        let keys: Vec<&String> = values1.keys().collect();
        assert_eq!(keys, vec!["id", "name", "email", "status"]);
    }

    #[test]
    fn test_extend_with_duplicate_keys() {
        let mut values1 = Values::new()
            .val("id", 1)
            .unwrap()
            .val("name", "Alice")
            .unwrap()
            .val("status", "inactive")
            .unwrap();

        let values2 = Values::new()
            .val("status", "active")
            .unwrap()
            .val("email", "alice@example.com")
            .unwrap();

        values1.extend(&values2);

        assert_eq!(values1.len(), 4);

        // Check that duplicate key was overwritten
        let keys: Vec<&String> = values1.keys().collect();
        assert_eq!(keys, vec!["id", "name", "status", "email"]);

        // Verify the status was overwritten
        // Note: We can't easily check the actual value without accessing internals,
        // but we can verify the structure is correct
    }

    #[test]
    fn test_extend_with_empty_values() {
        let mut values1 = Values::new()
            .val("id", 1)
            .unwrap()
            .val("name", "Alice")
            .unwrap();

        let values2 = Values::new();

        values1.extend(&values2);

        assert_eq!(values1.len(), 2);
        let keys: Vec<&String> = values1.keys().collect();
        assert_eq!(keys, vec!["id", "name"]);
    }

    #[test]
    fn test_extend_empty_with_values() {
        let mut values1 = Values::new();

        let values2 = Values::new()
            .val("email", "alice@example.com")
            .unwrap()
            .val("status", "active")
            .unwrap();

        values1.extend(&values2);

        assert_eq!(values1.len(), 2);
        let keys: Vec<&String> = values1.keys().collect();
        assert_eq!(keys, vec!["email", "status"]);
    }

    #[test]
    fn test_extend_both_empty() {
        let mut values1 = Values::new();
        let values2 = Values::new();

        values1.extend(&values2);

        assert_eq!(values1.len(), 0);
        assert!(values1.is_empty());
    }

    #[test]
    fn test_extend_preserves_order() {
        let mut values1 = Values::new()
            .val("a", 1)
            .unwrap()
            .val("b", 2)
            .unwrap()
            .val("c", 3)
            .unwrap();

        let values2 = Values::new().val("d", 4).unwrap().val("e", 5).unwrap();

        values1.extend(&values2);

        let keys: Vec<&String> = values1.keys().collect();
        assert_eq!(keys, vec!["a", "b", "c", "d", "e"]);
    }

    #[test]
    fn test_extend_multiple_times() {
        let mut values1 = Values::new().val("id", 1).unwrap();

        let values2 = Values::new().val("name", "Alice").unwrap();

        let values3 = Values::new().val("email", "alice@example.com").unwrap();

        values1.extend(&values2);
        values1.extend(&values3);

        assert_eq!(values1.len(), 3);
        let keys: Vec<&String> = values1.keys().collect();
        assert_eq!(keys, vec!["id", "name", "email"]);
    }

    #[test]
    fn test_values_with_option_some() {
        let mut values = Values::new();

        // Test various Some() values
        values.insert("id", Some(42)).unwrap();
        values.insert("name", Some("Alice")).unwrap();
        values.insert("active", Some(true)).unwrap();
        values.insert("score", Some(98.5)).unwrap();

        assert_eq!(values.len(), 4);
        let keys: Vec<&String> = values.keys().collect();
        assert_eq!(keys, vec!["id", "name", "active", "score"]);
    }

    #[test]
    fn test_values_with_option_none() {
        let mut values = Values::new();

        // Test various None values
        values.insert("id", Some(1)).unwrap();
        values.insert("middle_name", None::<&str>).unwrap();
        values.insert("phone", None::<String>).unwrap();
        values.insert("age", None::<i32>).unwrap();
        values.insert("verified", None::<bool>).unwrap();

        assert_eq!(values.len(), 5);
        let keys: Vec<&String> = values.keys().collect();
        assert_eq!(keys, vec!["id", "middle_name", "phone", "age", "verified"]);
    }

    #[test]
    fn test_values_builder_with_options() {
        let values = Values::new()
            .val("id", 1)
            .unwrap()
            .val("name", Some("Bob"))
            .unwrap()
            .val("email", None::<String>)
            .unwrap()
            .val("active", Some(false))
            .unwrap()
            .val("score", None::<f64>)
            .unwrap();

        assert_eq!(values.len(), 5);
        let keys: Vec<&String> = values.keys().collect();
        assert_eq!(keys, vec!["id", "name", "email", "active", "score"]);
    }

    #[test]
    fn test_values_mixed_some_none() {
        let mut values = Values::new();

        // Mix of Some and None values for the same types
        values.insert("required_field", "always present").unwrap();
        values.insert("optional_text", Some("present")).unwrap();
        values.insert("missing_text", None::<String>).unwrap();
        values.insert("optional_number", Some(123)).unwrap();
        values.insert("missing_number", None::<i32>).unwrap();

        assert_eq!(values.len(), 5);
    }

    #[test]
    fn test_values_extend_with_options() {
        let mut values1 = Values::new()
            .val("id", 1)
            .unwrap()
            .val("name", Some("Alice"))
            .unwrap();

        let values2 = Values::new()
            .val("email", None::<String>)
            .unwrap()
            .val("phone", Some("+1-555-0123"))
            .unwrap()
            .val("age", None::<i32>)
            .unwrap();

        values1.extend(&values2);

        assert_eq!(values1.len(), 5);
        let keys: Vec<&String> = values1.keys().collect();
        assert_eq!(keys, vec!["id", "name", "email", "phone", "age"]);
    }

    #[test]
    fn test_values_option_overwrite() {
        let mut values = Values::new().val("field", Some("original")).unwrap();

        // Overwrite Some with None
        values.insert("field", None::<String>).unwrap();
        assert_eq!(values.len(), 1);

        // Overwrite None with Some
        values.insert("field", Some("updated")).unwrap();
        assert_eq!(values.len(), 1);
    }

    #[test]
    fn test_values_option_string_types() {
        let mut values = Values::new();

        // Test different string option types
        values
            .insert("owned_string", Some("hello".to_string()))
            .unwrap();
        values.insert("string_ref", Some("world")).unwrap();
        values.insert("no_owned_string", None::<String>).unwrap();
        values.insert("no_string_ref", None::<&str>).unwrap();

        assert_eq!(values.len(), 4);
    }

    #[test]
    fn test_values_with_null_constant() {
        use crate::encode::Null;

        let mut values = Values::new();

        // Test using the Null constant
        values.insert("id", 1).unwrap();
        values.insert("name", "Alice").unwrap();
        values.insert("middle_name", Null).unwrap();
        values.insert("phone", Some("+1-555-0123")).unwrap();

        assert_eq!(values.len(), 4);
        let keys: Vec<&String> = values.keys().collect();
        assert_eq!(keys, vec!["id", "name", "middle_name", "phone"]);
    }

    #[test]
    fn test_values_macro_with_null() -> crate::Result<()> {
        use crate::{encode::Null, values};

        let user_data = values! {
            "id": 1,
            "name": "Bob",
            "middle_name": Null,  // Using Null constant
            "email": Some("bob@example.com"),
            "phone": None::<String>  // Traditional None with type annotation
        }?;

        assert_eq!(user_data.len(), 5);
        let keys: Vec<&String> = user_data.keys().collect();
        assert_eq!(keys, vec!["id", "name", "middle_name", "email", "phone"]);
        Ok(())
    }

    #[test]
    fn test_values_extend_with_null() {
        use crate::encode::Null;

        let mut values1 = Values::new()
            .val("id", 1)
            .unwrap()
            .val("name", "Charlie")
            .unwrap();

        let values2 = Values::new()
            .val("middle_name", Null) // Using Null constant
            .unwrap()
            .val("last_name", "Brown")
            .unwrap();

        values1.extend(&values2);

        assert_eq!(values1.len(), 4);
        let keys: Vec<&String> = values1.keys().collect();
        assert_eq!(keys, vec!["id", "name", "middle_name", "last_name"]);
    }
}