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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
use std::fmt::{Display, Formatter, Result};
use num::Num;

/// Builder for [`QueryItem`]
///
/// [`QueryItem`]: struct.QueryItem.html
#[derive(Clone, Debug)]
pub struct QueryItemBuilder {
    field: String
}

/// Struct representing one AQL comparison in a [`Query`].
///
/// [`Query`]: struct.Query.html
#[derive(Clone, Debug)]
pub struct QueryItem {
    field: String,
    comparator: String,
    value: String
}

impl QueryItemBuilder {

    /// Finalizes the current query item builder with a string equality comparison.
    /// The field to be matched should be a string.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// println!("we are in the test");
    /// let query_item = QueryItem::field("username").equals_str("felix");
    /// let query = Query::new(query_item);
    /// ```
    pub fn equals_str(self, value: &str) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "==".to_string(),
            value: format!(r#""{}""#, value)
        }
    }

    /// Finalizes the current query item builder with a string inequality comparison.
    /// The field to be matched should be a string.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("username").different_than_str("felix");
    /// let query = Query::new(query_item);
    /// ```
    pub fn different_than_str(self, value: &str) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "!=".to_string(),
            value: format!(r#""{}""#, value)
        }
    }

    /// Finalizes the current query item builder with a regular expression matching.
    /// The field to be matched should be a string.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("username").matches(r#"^[0.9](0.6)$"#);
    /// let query = Query::new(query_item);
    /// ```
    pub fn matches(self, regular_expression: &str) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "=~".to_string(),
            value: format!(r#""{}""#, regular_expression)
        }
    }

    /// Finalizes the current query item builder with an inverse regular expression matching.
    /// The field to be matched should be a string.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("username").does_not_match(r#"^[0.9](0.6)$"#);
    /// let query = Query::new(query_item);
    /// ```
    pub fn does_not_match(self, regular_expression: &str) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "!~".to_string(),
            value: format!(r#""{}""#, regular_expression)
        }
    }

    /// Finalizes the current query item builder with string comparison.
    /// The field to be matched should be a string.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("username").like("%felix%");
    /// let query = Query::new(query_item);
    /// ```
    pub fn like(self, pattern: &str) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "LIKE".to_string(),
            value: format!(r#""{}""#, pattern)
        }
    }

    /// Finalizes the current query item builder with string comparison.
    /// The field to be matched should be a string.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("username").not_like("%felix%");
    /// let query = Query::new(query_item);
    /// ```
    pub fn not_like(self, pattern: &str) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "NOT LIKE".to_string(),
            value: format!(r#""{}""#, pattern)
        }
    }
    
    /// Finalizes the current query item builder with numeric equality comparison.
    /// The field to be matched should be a numeric type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("age").equals(18);
    /// let query = Query::new(query_item);
    /// ```
    pub fn equals<T>(self, value: T) -> QueryItem where T: Num + Display {
        QueryItem {
            field: self.field,
            comparator: "==".to_string(),
            value: format!(r#"{}"#, value)
        }
    }

    /// Finalizes the current query item builder with numeric inquality comparison.
    /// The field to be matched should be a numeric type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("age").different_than(18);
    /// let query = Query::new(query_item);
    /// ```
    pub fn different_than<T>(self, value: T) -> QueryItem where T: Num + Display {
        QueryItem {
            field: self.field,
            comparator: "!=".to_string(),
            value: format!(r#"{}"#, value)
        }
    }

    /// Finalizes the current query item builder with numeric comparison.
    /// The field to be matched should be a numeric type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("age").greater_than(18);
    /// let query = Query::new(query_item);
    /// ```
    pub fn greater_than<T>(self, value: T) -> QueryItem where T: Num + Display {
        QueryItem {
            field: self.field,
            comparator: ">".to_string(),
            value: format!(r#"{}"#, value)
        }
    }

    /// Finalizes the current query item builder with numeric comparison.
    /// The field to be matched should be a numeric type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("age").greater_or_equal(18);
    /// let query = Query::new(query_item);
    /// ```
    pub fn greater_or_equal<T>(self, value: T) -> QueryItem where T: Num + Display {
        QueryItem {
            field: self.field,
            comparator: ">=".to_string(),
            value: format!(r#"{}"#, value)
        }
    }

    /// Finalizes the current query item builder with numeric comparison.
    /// The field to be matched should be a numeric type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("age").lesser_than(18);
    /// let query = Query::new(query_item);
    /// ```
    pub fn lesser_than<T>(self, value: T) -> QueryItem where T: Num + Display {
        QueryItem {
            field: self.field,
            comparator: "<".to_string(),
            value: format!(r#"{}"#, value)
        }
    }

    /// Finalizes the current query item builder with numeric comparison.
    /// The field to be matched should be a numeric type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("age").lesser_or_equal(18);
    /// let query = Query::new(query_item);
    /// ```
    pub fn lesser_or_equal<T>(self, value: T) -> QueryItem where T: Num + Display {
        QueryItem {
            field: self.field,
            comparator: "<=".to_string(),
            value: format!(r#"{}"#, value)
        }
    }

    /// Finalizes the current query item builder with an inclusion in a numeric array comparison.
    /// The field to be matched should be a numeric type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("age").in_array(&[1, 11, 16, 18]);
    /// let query = Query::new(query_item);
    /// ```
    pub fn in_array<T>(self, array: &[T]) -> QueryItem where T: Num + Display {
        QueryItem {
            field: self.field,
            comparator: "IN".to_string(),
            value: format!(r#"{}"#, Self::string_from_array(array))
        }
    }

    /// Finalizes the current query item builder with an inclusion in a numeric array comparison.
    /// The field to be matched should be a numeric type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("age").not_in_array(&[1, 11, 16, 18]);
    /// let query = Query::new(query_item);
    /// ```
    pub fn not_in_array<T>(self, array: &[T]) -> QueryItem where T: Num + Display {
        QueryItem {
            field: self.field,
            comparator: "NOT IN".to_string(),
            value: format!(r#"{}"#, Self::string_from_array(array))
        }
    }

    /// Finalizes the current query item builder with an inclusion in a string array comparison.
    /// The field to be matched should be a string type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("username").in_str_array(&["felix", "123felix"]);
    /// let query = Query::new(query_item);
    /// ```
    pub fn in_str_array(self, array: &[&str]) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "IN".to_string(),
            value: format!(r#"{}"#, Self::string_from_array_str(array))
        }
    }

    /// Finalizes the current query item builder with an inclusion in a string array comparison.
    /// The field to be matched should be a string type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("username").not_in_str_array(&["felix", "123felix"]);
    /// let query = Query::new(query_item);
    /// ```
    pub fn not_in_str_array(self, array: &[&str]) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "NOT IN".to_string(),
            value: format!(r#"{}"#, Self::string_from_array_str(array))
        }
    }

    /// Finalizes the current query item builder with a `null` comparison.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("username").is_null();
    /// let query = Query::new(query_item);
    /// ```
    pub fn is_null(self) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "==".to_string(),
            value: "null".to_string()
        }
    }

    /// Finalizes the current query item builder with a not `null` comparison.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("username").not_null();
    /// let query = Query::new(query_item);
    /// ```
    pub fn not_null(self) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "!=".to_string(),
            value: "null".to_string()
        }
    }

    /// Finalizes the current query item builder with a boolean comparison.
    /// The field to be matched should be a boolean type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("is_authorized").is_true();
    /// let query = Query::new(query_item);
    /// ```
    pub fn is_true(self) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "==".to_string(),
            value: "true".to_string()
        }
    }

    /// Finalizes the current query item builder with a boolean comparison.
    /// The field to be matched should be a boolean type.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    ///
    /// let query_item = QueryItem::field("is_authorized").is_false();
    /// let query = Query::new(query_item);
    /// ```
    pub fn is_false(self) -> QueryItem {
        QueryItem {
            field: self.field,
            comparator: "==".to_string(),
            value: "false".to_string()
        }
    }

    fn string_from_array<T>(array: &[T]) -> String where T: Num + Display {
        let mut array_str = String::from("[");
        for (i, element) in array.iter().enumerate() {
            array_str = format!("{}{}", array_str, element);
            if i < array.len() - 1 { array_str += ", " }
        }
        array_str += "]";
        array_str
    }

    fn string_from_array_str(array: &[&str]) -> String where {
        let mut array_str = String::from("[");
        for (i, element) in array.iter().enumerate() {
            array_str = format!(r#"{}"{}""#, array_str, element);
            if i < array.len() - 1 { array_str += ", " }
        }
        array_str += "]";
        array_str
    }
}

impl QueryItem {
    /// Instantiates a new builder for a `QueryItem` with the specified `field_name`.
    /// The field will be used as the left value of the comparison.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use aragog::query::QueryItem;
    /// let query_item_builder = QueryItem::field("username");
    /// ```
    pub fn field(field_name: &str) -> QueryItemBuilder {
        QueryItemBuilder {
            field: field_name.to_string()
        }
    }

    /// Instantiates a new builder for a `QueryItem` with the specified `array_field_name`.
    /// The field should be an array, as all items in the array will have to match the comparison
    /// to succeed.
    ///
    /// # Example
    ///
    /// In this example the query will render all documents where every price is above 10.
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    /// Query::new(QueryItem::all("prices").greater_or_equal(10));
    /// ```
    pub fn all(array_field_name: &str) -> QueryItemBuilder {
        QueryItemBuilder {
            field: format!("{} ALL", array_field_name)
        }
    }

    /// Instantiates a new builder for a `QueryItem` with the specified `array_field_name`.
    /// The field should be an array, none of the items in the array can match the comparison to succeed.
    ///
    /// # Example
    ///
    /// In this example the query will render all documents where every price is not above 10.
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    /// Query::new(QueryItem::none("prices").greater_or_equal(10));
    /// ```
    pub fn none(array_field_name: &str) -> QueryItemBuilder {
        QueryItemBuilder {
            field: format!("{} NONE", array_field_name)
        }
    }
    /// Instantiates a new builder for a `QueryItem` with the specified `array_field_name`.
    /// The field should be an array, at least one of the items in the array must match the
    /// comparison to succeed.
    ///
    /// # Example
    ///
    /// In this example the query will render all documents where at least one price is above 10.
    /// ```rust
    /// # use aragog::query::{QueryItem, Query};
    /// Query::new(QueryItem::any("prices").greater_or_equal(10));
    /// ```
    pub fn any(array_field_name: &str) -> QueryItemBuilder {
        QueryItemBuilder {
            field: format!("{} ANY", array_field_name)
        }
    }
}

impl Display for QueryItem {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
        write!(f, "{} {} {}", self.field, self.comparator, self.value)
    }
}