tqdb 1.0.6

Tiny Query Database (TQDB) is a small library for creating a query-able database that is encoded with json.
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
//! # Tiny Query Database (TQDB)
//!
//! TQDB is a small library for creating a query-able database that is encoded with json.
//!
//! The library is well tested (~96.30% coverage according to
//! [cargo-tarpaulin](https://crates.io/crates/cargo-tarpaulin)) and simple to use with
//! the help of macros.
//!
//! ## Examples
//!
//! We can create a [database][d] using any type.
//! ```
//! # use std::iter::FromIterator;
//! use tqdb::Database;
//! let db1: Database<i32> = Database::new();
//! let db2: Database<&u8> = Database::from_iter("hello world".as_bytes().into_iter());
//! struct Vec2 { x: i32, y: i32 };
//! let db3: Database<Vec2> = Database::from_iter(vec![ Vec2 { x: 0, y: 5 }, Vec2 { x: 100, y: 50 } ]);
//! ```
//!
//! If the type is serializable, we can even save it as json!
//! ```no_run
//! # use std::error::Error;
//! # use std::iter::FromIterator;
//! # fn main() -> Result<(), Box<dyn Error>> {
//! use serde::{Serialize, Deserialize};
//! #[derive(Serialize, Deserialize)]
//! struct Vec2 { x: i32, y: i32 };
//!
//! use tqdb::Database;
//! let db1: Database<i32> = Database::new();
//! let db2: Database<&u8> = Database::from_iter("hello world".as_bytes().into_iter());
//! let db3: Database<Vec2> = Database::from_iter(vec![ Vec2 { x: 0, y: 5 }, Vec2 { x: 100, y: 50 } ]);
//!
//! db1.save_to_file("db1.json")?;
//! db2.save_to_file("db2.json")?;
//! db3.save_to_file("db3.json")?;
//! # Ok(())
//! # }
//! ```
//!
//! We can query a [database][d] using macros!
//!
//! We can [search a database](search)...
//! ```
//! # use std::iter::FromIterator;
//! use tqdb::{Database, Query, search, search_mut, remove};
//! let db = Database::from_iter(1..10);
//! let found_items = search!(&db => |it: &i32| *it >= 5 && *it <= 7);
//! ```
//! ...[search a database (with mutable access)](search_mut)
//! ```
//! # use std::iter::FromIterator;
//! # use tqdb::{Database, Query, search, search_mut, remove};
//! # let mut db = Database::from_iter(1..10);
//! let found_items_mut1 = search_mut!(&mut db => |it: &i32| *it >= 5 && *it <= 7);
//! # std::mem::drop(found_items_mut1);
//! // or
//! let found_items_mut2 = search!(&mut db => |it: &i32| *it >= 5 && *it <= 7);
//! ```
//! ...and [remove items](remove) easily!
//! ```
//! # use std::iter::FromIterator;
//! # use tqdb::{Database, Query, search, search_mut, remove};
//! # let mut db = Database::from_iter(1..10);
//! let removed_items = remove!(&mut db => |it: &i32| *it >= 5 && *it <= 7);
//! ```
//! If you don't want to use the macros, [queries][q] can be composed together like so:
//! ```
//! # use std::iter::FromIterator;
//! use tqdb::{Database, Query};
//! let db = Database::from_iter(1..10);
//! // boring, simple query
//! db.search(Query::new(|it: &i32| *it < 5));
//! // cool AND query
//! db.search( Query::new(|it: &i32| *it < 5) & Query::new(|it: &i32| *it > 2) );
//! // cool OR query
//! db.search( Query::new(|it: &i32| *it >= 5) | Query::new(|it: &i32| *it <= 2) );
//! ```
//! [d]: Database
//! [q]: Query

#![warn(rustdoc::all)]
#![feature(drain_filter)]
#![feature(fn_traits)]
#![feature(no_coverage)]

#[cfg(test)]
use mutagen::mutate;
use serde;
use serde::de::DeserializeOwned;
use serde_derive::{Deserialize, Serialize};
use std::fs::File;
use std::io::{BufReader, BufWriter, Read, Write};
use std::ops::{BitAnd, BitOr};
use std::path::Path;
use thiserror::Error;

/// A type for declaring a function that takes some argument by reference and returns a boolean value.
type Predicate<T> = dyn Fn(&T) -> bool;

/// A sized [Predicate].
type BoxPredicate<T> = Box<Predicate<T>>;

/// Database error
#[derive(Error, Debug)]
pub enum DatabaseError {
    /// We could not parse json when loading from a file
    /// Raised in [Database::try_from].
    #[error("Had trouble parsing json database!")]
    BadJsonParse,
    /// We tried to use [Database::insert_unique] but the item already
    /// existed in the Database.
    #[error("Cannot insert duplicate items!")]
    DuplicateItemInsertion,
    /// We tried to write to a file with [Database::save_to_file] but was
    /// unsuccessful.
    #[error("Could not successfully write to writer!")]
    BadWrite,
}

/// A database stores many items in an unordered fashion.
///
/// ## Examples
///
/// We can create a database using any type.
/// ```
/// # use std::iter::FromIterator;
/// use tqdb::Database;
/// let db1: Database<i32> = Database::new();
/// let db2: Database<&u8> = Database::from_iter("hello world".as_bytes().into_iter());
/// struct Vec2 { x: i32, y: i32 };
/// let db3: Database<Vec2> = Database::from_iter(vec![ Vec2 { x: 0, y: 5 }, Vec2 { x: 100, y: 50 } ]);
/// ```
///
/// If the type is serializable, we can even save it as json!
/// ```no_run
/// # use std::error::Error;
/// # use std::iter::FromIterator;
/// # fn main() -> Result<(), Box<dyn Error>> {
/// use serde::{Serialize, Deserialize};
/// #[derive(Serialize, Deserialize)]
/// struct Vec2 { x: i32, y: i32 };
///
/// use tqdb::Database;
/// let db1: Database<i32> = Database::new();
/// let db2: Database<&u8> = Database::from_iter("hello world".as_bytes().into_iter());
/// let db3: Database<Vec2> = Database::from_iter(vec![ Vec2 { x: 0, y: 5 }, Vec2 { x: 100, y: 50 } ]);
///
/// db1.save_to_file("db1.json")?;
/// db2.save_to_file("db2.json")?;
/// db3.save_to_file("db3.json")?;
/// # Ok(())
/// # }
/// ```
///
/// We can query a database using macros!
///
/// We can [search a database](search)...
/// ```
/// # use std::iter::FromIterator;
/// use tqdb::{Database, Query, search, search_mut, remove};
/// let db = Database::from_iter(1..10);
/// let found_items = search!(&db => |it: &i32| *it >= 5 && *it <= 7);
/// ```
/// ...[search a database (with mutable access)](search_mut)
/// ```
/// # use std::iter::FromIterator;
/// # use tqdb::{Database, Query, search, search_mut, remove};
/// # let mut db = Database::from_iter(1..10);
/// let found_items_mut1 = search_mut!(&mut db => |it: &i32| *it >= 5 && *it <= 7);
/// # std::mem::drop(found_items_mut1);
/// // or
/// let found_items_mut2 = search!(&mut db => |it: &i32| *it >= 5 && *it <= 7);
/// ```
/// ...and [remove items](Database::remove) easily!
/// ```
/// # use std::iter::FromIterator;
/// # use tqdb::{Database, Query, search, search_mut, remove};
/// # let mut db = Database::from_iter(1..10);
/// let removed_items = remove!(&mut db => |it: &i32| *it >= 5 && *it <= 7);
/// ```
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default, Serialize, Deserialize)]
pub struct Database<T>(Vec<T>);

unsafe impl<T: Send> Send for Database<T> {}
unsafe impl<T: Sync> Sync for Database<T> {}

/// A query lets us check our database
/// ## Examples
/// [Searching a database](search)
/// ```
/// # use std::iter::FromIterator;
/// use tqdb::{Database, Query, search, search_mut, remove};
/// let db = Database::from_iter(1..10);
/// let found_items = search!(&db => |it: &i32| *it >= 5 && *it <= 7);
/// ```
/// ...[searching a database (with mutable access)](search_mut)
/// ```
/// # use std::iter::FromIterator;
/// # use tqdb::{Database, Query, search, search_mut, remove};
/// # let mut db = Database::from_iter(1..10);
/// let found_items_mut1 = search_mut!(&mut db => |it: &i32| *it >= 5 && *it <= 7);
/// # std::mem::drop(found_items_mut1);
/// // or even use
/// let found_items_mut2 = search!(&mut db => |it: &i32| *it >= 5 && *it <= 7);
/// ```
/// ...and [remove items](remove) easily!
/// ```
/// # use std::iter::FromIterator;
/// # use tqdb::{Database, Query, search, search_mut, remove};
/// # let mut db = Database::from_iter(1..10);
/// let removed_items = remove!(&mut db => |it: &i32| *it >= 5 && *it <= 7);
/// ```
/// If you don't want to use the macros, [queries][Query] can be composed together like so:
///
/// Simple query
/// ```
/// # use std::iter::FromIterator;
/// use tqdb::{Database, Query};
/// let db = Database::from_iter(1..10);
/// db.search(Query::new(|it: &i32| *it < 5));
/// ```
/// We can also chain together queries with the `&` and `|` operators
/// ```
/// # use std::iter::FromIterator;
/// # use tqdb::{Database, Query};
/// # let db = Database::from_iter(1..10);
/// // cool AND query
/// db.search( Query::new(|it: &i32| *it < 5) & Query::new(|it: &i32| *it > 2) );
/// // cool OR query
/// db.search( Query::new(|it: &i32| *it >= 5) | Query::new(|it: &i32| *it <= 2) );
/// ```
pub struct Query<T>(BoxPredicate<T>);

/// Generic library result returning something or [DatabaseError].
type Result<T> = core::result::Result<T, DatabaseError>;

impl<T> Query<T> {
    /// Allows us to create a new query from a predicate
    /// Try to use [search!](search), [search_mut!](search_mut), or [remove!](remove) instead of this,
    /// because it is smaller!
    #[cfg_attr(test, mutate)]
    pub fn new<P: 'static + Fn(&T) -> bool>(f: P) -> Self {
        Self(Box::new(f))
    }

    /// Check if this query accepts an item.
    /// Invalidates the query (Queries can only be called once)
    fn check(&self, it: &T) -> bool {
        self.0.call((it,))
    }
}

impl<T> Database<T> {
    /// We can search a database with a [Query]. Usually done with the [search!](search) macro.
    ///
    /// ## Examples
    /// Simple query
    /// ```
    /// # use std::iter::FromIterator;
    /// use tqdb::{Database, Query};
    /// let db = Database::from_iter(1..10);
    /// assert!([&1,&2,&3,&4].into_iter().eq(db.search(Query::new(|it: &i32| *it < 5))));
    /// ```
    /// We can also chain together queries with the `&` and `|` operators
    /// ```
    /// # use std::iter::FromIterator;
    /// # use tqdb::{Database, Query};
    /// # let mut db = Database::from_iter(1..10);
    /// // cool AND query
    /// assert!([&3,&4].into_iter().eq(
    ///     db.search( Query::new(|it: &i32| *it < 5) & Query::new(|it: &i32| *it > 2) )));
    /// // cool OR query
    /// assert!([&1,&2,&5,&6,&7,&8,&9].into_iter().eq(
    ///     db.search( Query::new(|it: &i32| *it >= 5) | Query::new(|it: &i32| *it <= 2) )));
    /// ```
    #[cfg_attr(test, mutate)]
    pub fn search(&self, query: Query<T>) -> impl Iterator<Item = &T> {
        self.0.iter().filter(move |it| query.check(it))
    }

    /// We can search a database with a [Query]. Usually done with the [search_mut!](search_mut) macro.
    ///
    /// ## Examples
    /// Simple query
    /// ```
    /// # use std::iter::FromIterator;
    /// use tqdb::{Database, Query};
    /// let mut db = Database::from_iter(1..10);
    /// assert!([&mut 1,&mut 2,&mut 3,&mut 4].into_iter().eq(
    ///     db.search_mut(Query::new(|it: &i32| *it < 5))));
    /// ```
    /// We can also chain together queries with the `&` and `|` operators
    /// ```
    /// # use std::iter::FromIterator;
    /// # use tqdb::{Database, Query};
    /// # let mut db = Database::from_iter(1..10);
    /// // cool AND query
    /// assert!([&mut 3,&mut 4].into_iter().eq(
    ///     db.search( Query::new(|it: &i32| *it < 5) & Query::new(|it: &i32| *it > 2) )));
    /// // cool OR query
    /// assert!([&mut 1,&mut 2,&mut 5,&mut 6,&mut 7,&mut 8,&mut 9].into_iter().eq(
    ///     db.search( Query::new(|it: &i32| *it > 4) | Query::new(|it: &i32| *it < 3) )));
    /// ```
    #[cfg_attr(test, mutate)]
    pub fn search_mut(&mut self, query: Query<T>) -> impl Iterator<Item = &mut T> {
        self.0.iter_mut().filter(move |it| query.check(it))
    }

    /// We can insert an item into a database
    ///
    /// ## Example
    /// ```
    /// use tqdb::Database;
    /// let mut db: Database<i32> = Database::new();
    /// db.insert(0);
    /// ```
    #[cfg_attr(test, mutate)]
    pub fn insert(&mut self, item: T) {
        self.0.push(item)
    }

    /// We can insert a unique item into a database
    /// ## Raises
    /// May raise an [DatabaseError::DuplicateItemInsertion] if trying to insert a duplicate item.
    /// ## Example
    /// ```
    /// use tqdb::Database;
    /// let mut db: Database<i32> = Database::new();
    /// assert!(db.insert_unique(0).is_ok());
    /// assert!(db.insert_unique(1).is_ok());
    /// assert!(db.insert_unique(0).is_err());
    /// assert!(db.insert_unique(1).is_err());
    /// assert!(db.insert_unique(2).is_ok());
    /// ```
    #[cfg_attr(test, mutate)]
    pub fn insert_unique(&mut self, item: T) -> Result<()>
    where
        T: PartialEq,
    {
        if self.0.contains(&item) {
            Err(DatabaseError::DuplicateItemInsertion)
        } else {
            self.0.push(item);
            Ok(())
        }
    }

    /// We can remove an item from a database with a [Query]. Usually done with [remove!](remove) macro.
    /// ## Examples
    /// Simple query
    /// ```
    /// # use std::iter::FromIterator;
    /// use tqdb::{Database, Query};
    /// let mut db = Database::from_iter(1..10);
    /// assert!([1,2,3,4].into_iter().eq(
    ///     db.remove(Query::new(|it: &i32| *it < 5))));
    /// assert!([&5,&6,&7,&8,&9].into_iter().eq(
    ///     db.iter()));
    /// ```
    #[cfg_attr(test, mutate)]
    pub fn remove(&mut self, query: Query<T>) -> impl Iterator<Item = T> + '_ {
        self.0.drain_filter(move |it| query.check(it))
    }

    /// Save the database to a Writer
    /// ## Raises:
    /// May raise a [DatabaseError::BadWrite] if we could not successfully write to the writer.
    /// ## Examples
    /// ```
    /// # use std::fmt::Write;
    /// # use std::iter::FromIterator;
    /// # use tqdb::Database;
    /// // given a simple writer
    /// struct StringWriter(String);
    /// impl std::io::Write for StringWriter {
    ///     fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
    ///         self.0.write_str(std::str::from_utf8(buf).unwrap()).unwrap();
    ///         Ok(buf.len())
    ///     }
    ///
    ///     fn flush(&mut self) -> std::io::Result<()> {
    ///         Ok(())
    ///     }
    /// }
    ///
    /// let db = Database::from_iter(1..10);
    /// let mut output = StringWriter { 0: String::new() };
    /// assert!(db.save(&mut output).is_ok());
    /// assert_eq!("[1,2,3,4,5,6,7,8,9]", output.0.as_str());
    /// ```
    #[cfg_attr(test, mutate)]
    pub fn save(&self, w: &mut dyn Write) -> Result<()>
    where
        T: serde::Serialize,
    {
        serde_json::to_writer(w, &self.0).map_err(|_| DatabaseError::BadWrite)
    }

    /// Allows us to save the database as json to a file.
    /// ## Raises:
    /// May raise a [DatabaseError::BadWrite] if we could not successfully write to the file.
    /// ## Examples:
    /// ```no_run
    /// # use std::iter::FromIterator;
    /// # use tqdb::DatabaseError;
    /// use tqdb::Database;
    /// # fn main() -> Result<(), DatabaseError> {
    /// let db: Database<i32> = Database::from_iter(1..10);
    /// db.save_to_file("test.db.json")?;
    /// # Ok(())
    /// # }
    /// ```
    #[cfg_attr(test, mutate)]
    pub fn save_to_file<P: AsRef<Path>>(&self, p: P) -> Result<()>
    where
        T: serde::Serialize,
    {
        let outfile = File::create(p).map_err(|_| DatabaseError::BadWrite)?;
        self.save(&mut BufWriter::new(outfile))
    }

    /// Lets us construct a new empty database.
    #[cfg_attr(test, mutate)]
    pub fn new() -> Self {
        Self { 0: Vec::new() }
    }

    /// Lets us see all the items in our database
    /// ## Examples
    /// ```
    /// # use std::iter::FromIterator;
    /// use tqdb::Database;
    /// let db: Database<i32> = Database::from_iter(1..10);
    /// for item in db.iter() {
    ///     println!("Item is {}!", item);
    /// }
    /// ```
    #[cfg_attr(test, mutate)]
    pub fn iter(&self) -> impl Iterator<Item = &T> + '_ {
        self.0.iter()
    }

    /// Allows us to see all of the items in our database and mutate them
    /// ## Examples
    /// ```
    /// # use std::iter::FromIterator;
    /// use tqdb::Database;
    /// let mut db: Database<i32> = Database::from_iter(1..10);
    /// for mut item in db.iter_mut() {
    ///     println!("Item was {}!", item);
    ///     *item += 5;
    ///     println!("Item is now {}!", item);
    /// }
    /// ```
    #[cfg_attr(test, mutate)]
    pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T> + '_ {
        self.0.iter_mut()
    }
}

impl<T: 'static> BitAnd for Query<T> {
    type Output = Query<T>;

    fn bitand(self, rhs: Self) -> Self::Output {
        let f: BoxPredicate<T> = Box::new(move |it| self.check(it) && rhs.check(it));
        Self { 0: f }
    }
}

impl<T: 'static> BitOr for Query<T> {
    type Output = Query<T>;

    fn bitor(self, rhs: Self) -> Self::Output {
        let f: BoxPredicate<T> = Box::new(move |it| self.check(it) || rhs.check(it));
        Self { 0: f }
    }
}

impl<R: Read, T: DeserializeOwned> TryFrom<BufReader<R>> for Database<T> {
    type Error = DatabaseError;

    fn try_from(r: BufReader<R>) -> Result<Self> {
        let data = serde_json::from_reader(r).map_err(|_| DatabaseError::BadJsonParse)?;
        Ok(Self { 0: data })
    }
}

impl<T> FromIterator<T> for Database<T> {
    fn from_iter<It: IntoIterator<Item = T>>(iter: It) -> Self {
        Self {
            0: Vec::from_iter(iter),
        }
    }
}

impl<T> Extend<T> for Database<T> {
    fn extend<It: IntoIterator<Item = T>>(&mut self, iter: It) {
        self.0.extend(iter)
    }
}

impl<T> IntoIterator for Database<T> {
    type Item = T;
    type IntoIter = <std::vec::Vec<T> as IntoIterator>::IntoIter;

    fn into_iter(self) -> Self::IntoIter {
        self.0.into_iter()
    }
}

impl<T> From<Vec<T>> for Database<T> {
    fn from(v: Vec<T>) -> Self {
        Self { 0: v }
    }
}

/// A simple macro to remove an item from a database using a query
/// ## Examples
/// ```
/// # use std::iter::FromIterator;
/// use tqdb::{Database, Query, remove};
/// let mut db = Database::from_iter(1..10);
/// let removed_items = remove!(&mut db => |it: &i32| *it >= 5 && *it <= 7);
/// ```
#[macro_export]
macro_rules! remove {
    (&mut $db:expr => $p:expr) => {
        $db.remove(Query::new($p))
    };
}

/// A simple macro to search items in a database using a query
/// ## Examples
/// ```
/// # use std::iter::FromIterator;
/// use tqdb::{Database, Query, search};
/// let db = Database::from_iter(1..10);
/// let found_items = search!(&db => |it: &i32| *it >= 5 && *it <= 7);
/// ```
/// Also lets us get a mutable iterator
/// ```
/// # use std::iter::FromIterator;
/// use tqdb::{Database, Query, search};
/// let mut db = Database::from_iter(1..10);
/// let found_items = search!(&mut db => |it: &i32| *it < 5).for_each(|mut item| *item += 5);
/// ```
#[macro_export]
macro_rules! search {
    (&$db:expr => $p:expr) => {
        $db.search(Query::new($p))
    };
    (&mut $db:expr => $p:expr) => {
        $db.search_mut(Query::new($p))
    };
}

/// A simple macro to search items in a database (retaining a mutable reference) using a query
/// ## Examples
/// ```
/// # use std::iter::FromIterator;
/// use tqdb::{Database, Query, search_mut};
/// let mut db = Database::from_iter(1..10);
/// let found_items = search_mut!(&mut db => |it: &i32| *it < 5).for_each(|mut item| *item += 5);
/// ```
/// Also see [search]
#[macro_export]
macro_rules! search_mut {
    (&mut $db:expr => $p:expr) => {
        $db.search_mut(Query::new($p))
    };
}

#[cfg(test)]
mod tests {
    use crate::*;
    use serde_derive::{Deserialize, Serialize};
    use std::fmt::Write;

    #[test]
    fn test_search() {
        let db = Database::from_iter(1..10);
        type Q = Query<i32>;
        assert_eq!(
            vec![&4, &6],
            db.search(Q::new(|it| *it > 3) & Q::new(|it| *it < 7) & Q::new(|it| *it != 5))
                .collect::<Vec<&i32>>()
        );
        assert_eq!(
            vec![&1, &2, &3, &5, &7, &8, &9],
            db.search(Q::new(|it| *it <= 3) | Q::new(|it| *it >= 7) | Q::new(|it| *it == 5))
                .collect::<Vec<&i32>>()
        );
    }

    #[test]
    fn test_insert() {
        let mut db = Database::new();
        db.insert(1);
        db.insert(2);
        db.insert(3);
        db.insert(1);
        db.insert(2);
        db.insert(3);
        assert!(vec![&1, &2, &3, &1, &2, &3]
            .into_iter()
            .eq(db.search(Query::new(|_| true))));
    }

    #[test]
    fn test_insert_unique() {
        let mut db = Database::new();
        db.insert(1);
        db.insert(2);
        assert!(db.insert_unique(3).is_ok());
        assert!(db.insert_unique(1).is_err());
    }

    #[test]
    fn test_search_mut() {
        let mut db = Database::from_iter(1..10);
        type Q = Query<i32>;
        db.search_mut(Q::new(|it| *it < 5)).for_each(|it| *it += 5);
        assert!(vec![6, 7, 8, 9, 5, 6, 7, 8, 9]
            .into_iter()
            .eq(db.into_iter()))
    }

    #[test]
    fn test_delete() {
        let mut db = Database::from_iter(1..10);
        type Q = Query<i32>;
        assert!(vec![1, 2, 3, 4]
            .into_iter()
            .eq(db.remove(Q::new(|it| *it < 5))));
        assert!(vec![5, 6, 7, 8, 9].into_iter().eq(db.into_iter()));
    }

    #[test]
    fn test_iter() {
        let db = Database::from_iter(1..10);
        assert!(Vec::from_iter(1..10).iter().eq(db.iter()))
    }

    #[test]
    fn test_iter_mut() {
        let mut db = Database::from_iter(1..10);
        db.iter_mut().for_each(|it| *it += 5);
        let mut vec = Vec::from_iter(1..10);
        vec.iter_mut().for_each(|it| *it += 5);
        assert!(vec.iter().eq(db.iter()))
    }

    // set up small mocking for writer
    struct StringWriter(String);

    impl std::io::Write for StringWriter {
        fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
            self.0.write_str(std::str::from_utf8(buf).unwrap()).unwrap();
            Ok(buf.len())
        }

        #[no_coverage]
        fn flush(&mut self) -> std::io::Result<()> {
            Ok(())
        }
    }

    #[test]
    fn test_save() {
        let db = Database::from_iter(1..10);
        let mut output = StringWriter { 0: String::new() };
        assert!(db.save(&mut output).is_ok());
        assert_eq!("[1,2,3,4,5,6,7,8,9]", output.0.as_str());
    }

    #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
    struct Coordinate {
        x: i32,
        y: i32,
    }

    impl Coordinate {
        #[cfg_attr(test, mutate)]
        pub fn new(x: i32, y: i32) -> Self {
            Self { x, y }
        }
    }

    #[test]
    fn test_save_complex() {
        let db = Database::from_iter([Coordinate::new(0, 0), Coordinate::new(1, 1)].into_iter());
        let mut output = StringWriter { 0: String::new() };
        assert!(db.save(&mut output).is_ok());
        assert_eq!(r#"[{"x":0,"y":0},{"x":1,"y":1}]"#, output.0.as_str());
    }

    #[test]
    fn test_search_macro() {
        let mut db =
            Database::from_iter([Coordinate::new(0, 0), Coordinate::new(0, 1)].into_iter());
        assert_eq!(
            search!(&db => |it: &Coordinate| it.x == it.y).collect::<Vec<&Coordinate>>(),
            vec![&Coordinate::new(0, 0)]
        );
        assert_eq!(
            search!(&mut db => |it: &Coordinate| it.x == it.y).collect::<Vec<&mut Coordinate>>(),
            vec![&mut Coordinate::new(0, 0)]
        );
    }

    #[test]
    fn test_search_mut_macro() {
        let mut db =
            Database::from_iter([Coordinate::new(0, 0), Coordinate::new(0, 1)].into_iter());
        assert_eq!(
            search_mut!(&mut db => |it: &Coordinate| it.x == it.y)
                .collect::<Vec<&mut Coordinate>>(),
            vec![&mut Coordinate::new(0, 0)]
        );
    }

    #[test]
    fn test_remove_macro() {
        let mut db =
            Database::from_iter([Coordinate::new(0, 0), Coordinate::new(0, 1)].into_iter());
        assert_eq!(
            remove!(&mut db => |it: &Coordinate| it.x == it.y).collect::<Vec<Coordinate>>(),
            vec![Coordinate::new(0, 0)]
        );
        assert_eq!(
            db.iter().collect::<Vec<&Coordinate>>(),
            vec![&mut Coordinate::new(0, 1)]
        );
    }

    #[test]
    fn test_default() {
        let mut db = Database::<i32>::default();
        assert!(db.insert_unique(1).is_ok());
        assert_eq!(vec![1], db.into_iter().collect::<Vec<i32>>())
    }

    #[test]
    fn test_extend() {
        let mut db = Database::<i32>::from_iter(1..5);
        db.extend(5..10);
        assert!(Vec::from_iter(1..10).iter().eq(db.iter()));
    }

    #[test]
    fn test_from_vec() {
        let db = Database::from(vec![1, 2, 3, 4, 5]);
        assert!(vec![1, 2, 3, 4, 5].iter().eq(db.iter()));
    }

    #[test]
    fn test_macro_with_complex() {
        struct T(Database<i32>);
        let db = T { 0: Database::from_iter(1..10) };
        assert!(Vec::from_iter(1..5).iter().eq(
            search!(&db.0 => |it: &i32| *it<5)
        ));
    }
}