-
Notifications
You must be signed in to change notification settings - Fork 3
/
node_builder.rs
484 lines (439 loc) · 13 KB
/
node_builder.rs
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
use std::fmt::Display;
pub trait ToNodeBuilder<T: Display = Self>: Display {
fn quoted(&self) -> String {
format!("\"{self}\"")
}
/// Draws the start of a relation `->node`
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "user".with("project");
///
/// assert_eq!("user->project", s);
/// ```
fn with(&self, relation_or_node: &str) -> String {
// write the arrow only if the first character is not a special character.
// there are cases where the `node` string that was passed starts with
// an arrow or a dot, in which case we do not want to push a new arrow
// ourselves.
if !relation_or_node.starts_with("->") && !relation_or_node.starts_with(".") {
format!("{self}->{relation_or_node}")
} else {
format!("{self}{relation_or_node}")
}
}
/// Draws the end of a relation `<-node`
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "user".from("project");
///
/// assert_eq!("user<-project", s);
/// ```
fn from(&self, node: &str) -> String {
format!("{self}<-{node}")
}
/// Take the current string and add in front of it the given label name as to
/// make a string of the following format `LabelName:CurrentString`
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let label = "John".as_named_label("Account");
///
/// assert_eq!(label, "Account:John");
/// ```
fn as_named_label(&self, label_name: &str) -> String {
format!("{label_name}:{self}")
}
fn as_param(&self) -> String {
self
.to_string()
.replace(".", "_")
.replace("->", "_")
.replace("<-", "_")
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "user".equals("John");
///
/// // Note that it doesn't add quotes around strings
/// assert_eq!("user = John", s);
/// ```
fn equals(&self, value: &str) -> String {
format!("{self} = {value}")
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "age".compares(">=", "45");
///
/// assert_eq!("age >= 45", s);
/// ```
fn compares(&self, operator: &str, value: &str) -> String {
format!("{self} {operator} {value}")
}
/// Take the current string and add the given operator plus ` $current_string` after it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "age".compares_parameterized(">=");
///
/// assert_eq!("age >= $age", s);
/// ```
fn compares_parameterized(&self, operator: &str) -> String {
format!("{self} {operator} ${}", self.as_param())
}
/// Take the current string and add `= $current_string` after it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "account".equals_parameterized();
///
/// assert_eq!("account = $account", s);
/// ```
fn equals_parameterized(&self) -> String {
format!("{self} = ${}", self.as_param())
}
/// Take the current string and add `+= $current_string` after it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "account".plus_equal_parameterized();
///
/// assert_eq!("account += $account", s);
/// ```
fn plus_equal_parameterized(&self) -> String {
format!("{self} += ${}", self.as_param())
}
/// Take the current string and add `> $current_string` after it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "age".greater_parameterized();
///
/// assert_eq!("age > $age", s);
/// ```
fn greater_parameterized(&self) -> String {
format!("{self} > ${}", self.as_param())
}
/// Take the current string and add `< $current_string` after it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "age".lower_parameterized();
///
/// assert_eq!("age < $age", s);
/// ```
fn lower_parameterized(&self) -> String {
format!("{self} < ${}", self.as_param())
}
/// Take the current string and add `> value` after it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "account".greater_than("5");
///
/// assert_eq!("account > 5", s);
/// ```
fn greater_than(&self, value: &str) -> String {
format!("{self} > {value}")
}
/// Take the current string and add `+= value` after it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "friends".plus_equal("account:john");
///
/// assert_eq!("friends += account:john", s);
/// ```
fn plus_equal(&self, value: &str) -> String {
format!("{self} += {value}")
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "account".contains_one("'c'");
///
/// assert_eq!("account CONTAINS 'c'", s);
/// ```
fn contains_one(&self, value: &str) -> String {
format!("{self} CONTAINS {value}")
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "account".contains_not("'z'");
///
/// assert_eq!("account CONTAINSNOT 'z'", s);
/// ```
fn contains_not(&self, value: &str) -> String {
format!("{self} CONTAINSNOT {value}")
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "account".contains_all("['a', 'c', 'u']");
///
/// assert_eq!("account CONTAINSALL ['a', 'c', 'u']", s);
/// ```
fn contains_all(&self, values: &str) -> String {
format!("{self} CONTAINSALL {values}")
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "account".contains_any("['a', 'c', 'u']");
///
/// assert_eq!("account CONTAINSANY ['a', 'c', 'u']", s);
/// ```
fn contains_any(&self, values: &str) -> String {
format!("{self} CONTAINSANY {values}")
}
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "account".contains_none("['z', 'd', 'f']");
///
/// assert_eq!("account CONTAINSNONE ['z', 'd', 'f']", s);
/// ```
fn contains_none(&self, values: &str) -> String {
format!("{self} CONTAINSNONE {values}")
}
/// Take the current string and add `as alias` after it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "account->manage->project".as_alias("account_projects");
///
/// assert_eq!("account->manage->project AS account_projects", s);
/// ```
fn as_alias(&self, alias: &str) -> String {
format!("{self} AS {alias}")
}
/// Take the current string, extract the last segment if it is a nested property,
/// then add parenthesis around it and add the supplied condition in them.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let path = "account->manage->project";
/// let s = path.filter("name = 'a_cool_project'");
///
/// assert_eq!("account->manage->(project WHERE name = 'a_cool_project')", s);
/// ```
///
fn filter(&self, condition: &str) -> String {
// This is a default implementation, but since we need the original string
// to iterate over the chars the function does two string allocations.
let original = self.to_string();
let original_size = original.len();
// this yields the size of the last segment, until a non alphanumeric character
// is found.
let last_segment_size = original
.chars()
.rev()
.take_while(|c| c.is_alphanumeric())
.count();
let left = &original[..original_size - last_segment_size];
let right = &original[original_size - last_segment_size..];
format!("{left}({right} WHERE {condition})")
}
/// write a comma at the end of the string and append `right` after it.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let select = "*".comma("<-manage<-User as authors");
/// let query = format!("select {select} from Files");
///
/// assert_eq!("select *, <-manage<-User as authors from Files", query);
/// ```
fn comma(&self, right: &str) -> String {
format!("{self}, {right}")
}
/// write a `count()` around the current string so that it sits between the
/// parenthesis.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let count = "id".count();
/// let query = format!("select {count} from Files");
///
/// assert_eq!("select count(id) from Files", query);
/// ```
fn count(&self) -> String {
format!("count({self})")
}
/// Add the supplied `id` right after the current string in order to get the a
/// new string in the following format `current:id`
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = "Account".with_id("John");
///
/// assert_eq!(query, "Account:John");
/// ```
fn with_id(&self, id: &str) -> String {
format!("{self}:{id}")
}
/// Add the supplied composite `id` right after the current string in order to
/// get the a new string in the following format `current:⟨id⟩`. The `⟨` and `⟩`
/// are automatically added around the id, if you wish to set a regular id then
/// refer to [with_id()](ToNodeBuilder::with_id)
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let query = "Account".with_composite_id("John/Doe");
///
/// assert_eq!(query, "Account:⟨John/Doe⟩");
/// ```
fn with_composite_id(&self, id: &str) -> String {
format!("{self}:⟨{id}⟩")
}
}
impl<'a> ToNodeBuilder for &'a str {
fn filter(&self, condition: &str) -> String {
// unlike the default implementation of this trait function, the &str impl
// does only one allocation.
let original_size = self.len();
// this yields the size of the last segment, until a non alphanumeric character
// is found.
let last_segment_size = self
.chars()
.rev()
.take_while(|c| c.is_alphanumeric())
.count();
let left = &self[..original_size - last_segment_size];
let right = &self[original_size - last_segment_size..];
format!("{left}({right} WHERE {condition})")
}
}
pub trait NodeBuilder<T: Display = Self>: Display {
/// Draws the start of a relation `->node`
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "user".with("project");
///
/// assert_eq!("user->project", s);
/// ```
fn with(&mut self, relation_or_node: &str) -> &mut String;
/// Allows you to pass a lambda that should mutate the current string when the
/// passed `condition` is `true`. If `condition` is `false` then the `action`
/// lambda is ignored and the string stays intact.
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// // demonstrate how the given closure is ignored if the condition is `false`
/// let mut label = "John".as_named_label("User");
/// let intact = &mut label
/// .if_then(false, |s| s.with("LOVES").with("User"))
/// .with("FRIEND")
/// .with("User");
///
/// assert_eq!("User:John->FRIEND->User", *intact);
///
/// // demonstrate how the given closure is executed if the condition is `true`
/// let mut label = "John".as_named_label("User");
/// let modified = &mut label
/// .if_then(true, |s| s.with("LOVES").with("User"))
/// .with("FRIEND")
/// .with("User");
///
/// assert_eq!("User:John->LOVES->User->FRIEND->User", *modified);
/// ```
fn if_then(&mut self, condition: bool, action: fn(&mut Self) -> &mut Self) -> &mut String;
/// Take the current string add add `> value` after it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "account".greater_than("5");
///
/// assert_eq!("account > 5", s);
/// ```
fn greater_than(&mut self, value: &str) -> &mut String;
/// Take the current string and add `+= value` after it
///
/// # Example
/// ```
/// use surreal_simple_querybuilder::prelude::*;
///
/// let s = "friends".plus_equal("account:john");
///
/// assert_eq!("friends += account:john", s);
/// ```
fn plus_equal(&mut self, value: &str) -> &mut String;
}
impl NodeBuilder for String {
fn with(&mut self, node: &str) -> &mut String {
// push the arrow only if the first character is not a special character.
// there are cases where the `node` string that was passed starts with
// an arrow or a dot, in which case we do not want to push a new arrow
// ourselves.
if !node.starts_with("->") && !node.starts_with(".") {
self.push_str("->");
}
self.push_str(node);
self
}
fn if_then(&mut self, condition: bool, action: fn(&mut Self) -> &mut Self) -> &mut String {
match condition {
true => action(self),
false => self,
}
}
fn greater_than(&mut self, value: &str) -> &mut String {
self.push_str(" > ");
self.push_str(value);
self
}
fn plus_equal(&mut self, value: &str) -> &mut String {
self.push_str(" += ");
self.push_str(value);
self
}
}
impl ToNodeBuilder for String {}