learner 0.9.0

A simple library for learning stuff
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
425
426
427
428
429
430
431
432
433
434
435
use super::*;

/// Basic removal functionality tests
mod basic_operations {

  use super::*;

  #[tokio::test]
  #[traced_test]
  async fn test_remove_existing_paper() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    let paper = create_test_paper();
    Add::paper(&paper).execute(&mut learner.database).await?;

    let removed_papers = Remove::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;

    assert_eq!(removed_papers.len(), 1);
    assert_eq!(removed_papers[0].title, paper.title);
    assert_eq!(removed_papers[0].authors.len(), paper.authors.len());

    let results = Query::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;
    assert_eq!(results.len(), 0);

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_remove_nonexistent_paper() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    let removed = Remove::by_source("arxiv", "nonexistent").execute(&mut learner.database).await?;
    assert!(removed.is_empty());

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_remove_cascades_to_authors() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    let paper = create_test_paper();
    Add::paper(&paper).execute(&mut learner.database).await?;

    Remove::from_query(Query::text("test")).execute(&mut learner.database).await?;
    let authors = Query::by_author("").execute(&mut learner.database).await?;

    assert_eq!(authors.len(), 0);
    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_remove_complete_paper() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    let paper = learner.retriever.get_paper("https://arxiv.org/abs/2301.07041").await?;
    // Add paper with document
    Add::complete(&paper).execute(&mut learner.database).await?;

    // Remove it
    Remove::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;

    // Verify paper is gone
    let results = Query::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;
    assert_eq!(results.len(), 0);

    Ok(())
  }
}

/// Dry run functionality tests
mod dry_run {
  use super::*;

  #[tokio::test]
  #[traced_test]
  async fn test_dry_run_basic() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    let paper = create_test_paper();
    Add::paper(&paper).execute(&mut learner.database).await?;

    let would_remove = Remove::by_source(&paper.source, &paper.source_identifier)
      .dry_run()
      .execute(&mut learner.database)
      .await?;

    assert_eq!(would_remove.len(), 1);
    assert_eq!(would_remove[0].title, paper.title);

    let results = Query::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;
    assert_eq!(results.len(), 1);

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_dry_run_returns_complete_paper() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    let paper = create_test_paper();
    Add::paper(&paper).execute(&mut learner.database).await?;

    let would_remove =
      Remove::from_query(Query::text("test")).dry_run().execute(&mut learner.database).await?;

    assert_eq!(would_remove.len(), 1);
    let removed = &would_remove[0];

    // Verify all fields
    assert_eq!(removed.title, paper.title);
    assert_eq!(removed.abstract_text, paper.abstract_text);
    assert_eq!(removed.publication_date, paper.publication_date);
    assert_eq!(removed.source, paper.source);
    assert_eq!(removed.source_identifier, paper.source_identifier);
    assert_eq!(removed.pdf_url, paper.pdf_url);
    assert_eq!(removed.doi, paper.doi);
    assert_eq!(removed.authors.len(), paper.authors.len());

    for (removed_author, original_author) in removed.authors.iter().zip(paper.authors.iter()) {
      assert_eq!(removed_author.name, original_author.name);
      assert_eq!(removed_author.affiliation, original_author.affiliation);
      assert_eq!(removed_author.email, original_author.email);
    }

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_dry_run_with_complete_paper() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    let paper = learner.retriever.get_paper("https://arxiv.org/abs/2301.07041").await?;
    Add::complete(&paper).execute(&mut learner.database).await?;

    let would_remove = Remove::by_source(&paper.source, &paper.source_identifier)
      .dry_run()
      .execute(&mut learner.database)
      .await?;

    // Verify paper would be removed
    assert_eq!(would_remove.len(), 1);

    // But verify it's still in the database
    let results = Query::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;
    assert_eq!(results.len(), 1);

    Ok(())
  }
}

/// Query-based removal tests
mod query_based_removal {

  use super::*;

  #[tokio::test]
  #[traced_test]
  async fn test_remove_by_text_search() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    Add::paper(&create_test_paper()).execute(&mut learner.database).await?;
    Add::paper(&create_second_test_paper()).execute(&mut learner.database).await?;

    let removed = Remove::from_query(Query::text("two")).execute(&mut learner.database).await?;
    assert_eq!(removed.len(), 1);
    assert_eq!(removed[0].title, "Test Paper: Two");

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_remove_by_author() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    Add::paper(&create_test_paper()).execute(&mut learner.database).await?;
    Add::paper(&create_second_test_paper()).execute(&mut learner.database).await?;

    let removed =
      Remove::from_query(Query::by_author("John Doe")).execute(&mut learner.database).await?;
    assert_eq!(removed.len(), 1);
    assert_eq!(removed[0].authors[0].name, "John Doe");

    // Verify only the matching paper was removed
    let remaining = Query::list_all().execute(&mut learner.database).await?;
    assert_eq!(remaining.len(), 1);

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_remove_with_ordering() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    Add::paper(&create_test_paper()).execute(&mut learner.database).await?;
    Add::paper(&create_second_test_paper()).execute(&mut learner.database).await?;

    let removed =
      Remove::from_query(Query::text("test").order_by(OrderField::PublicationDate).descending())
        .execute(&mut learner.database)
        .await?;

    assert_eq!(removed.len(), 2);
    assert_eq!(removed[0].title, "Test Paper: Two"); // More recent
    assert_eq!(removed[1].title, "Test Paper");

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_remove_by_date_range() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    Add::paper(&create_test_paper()).execute(&mut learner.database).await?;
    Add::paper(&create_second_test_paper()).execute(&mut learner.database).await?;

    let cutoff_date = Utc.with_ymd_and_hms(2024, 1, 1, 0, 0, 0).unwrap();
    let removed =
      Remove::from_query(Query::before_date(cutoff_date).order_by(OrderField::PublicationDate))
        .execute(&mut learner.database)
        .await?;

    assert_eq!(removed.len(), 1);
    assert_eq!(removed[0].title, "Test Paper");

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_remove_multiple_papers_by_source() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    // Add multiple papers from same source
    let paper1 = create_test_paper();
    let paper2 = create_second_test_paper();
    Add::paper(&paper1).execute(&mut learner.database).await?;
    Add::paper(&paper2).execute(&mut learner.database).await?;

    // Use a text search that will match all papers from this source
    // alternatively we could use Query::list_all() with a source filter
    let removed = Remove::from_query(Query::text("test")).execute(&mut learner.database).await?;
    assert_eq!(removed.len(), 2);
    assert!(removed.iter().all(|p| p.source == "arxiv"));

    // Verify all papers are gone
    let remaining = Query::text("test").execute(&mut learner.database).await?;
    assert!(remaining.is_empty());

    Ok(())
  }

  // Alternative version using list_all
  #[tokio::test]
  #[traced_test]
  async fn test_remove_multiple_papers_from_source() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    // Add papers from different sources
    let paper1 = create_test_paper();
    let paper2 = create_second_test_paper();
    Add::paper(&paper1).execute(&mut learner.database).await?;
    Add::paper(&paper2).execute(&mut learner.database).await?;

    // Verify we have papers from our source before removal
    let initial = Query::list_all().execute(&mut learner.database).await?;
    assert!(initial.iter().any(|p| p.source == "arxiv"));

    // Remove all papers using list_all and checking source
    let removed = Remove::from_query(Query::list_all().order_by(OrderField::Source))
      .execute(&mut learner.database)
      .await?;

    // Count papers from our source
    let arxiv_count = removed.iter().filter(|p| p.source == "arxiv").count();
    assert_eq!(arxiv_count, 2);

    // Verify no papers remain from that source
    let remaining = Query::list_all().execute(&mut learner.database).await?;
    assert!(!remaining.iter().any(|p| p.source == "arxiv"));

    Ok(())
  }
}

/// Recovery and data integrity tests
mod recovery {
  use super::*;

  #[tokio::test]
  #[traced_test]
  async fn test_remove_papers_can_be_readded() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    let paper = create_test_paper();
    Add::paper(&paper).execute(&mut learner.database).await?;

    let removed_papers =
      Remove::from_query(Query::text("test")).execute(&mut learner.database).await?;
    assert_eq!(removed_papers.len(), 1);

    Add::paper(&removed_papers[0]).execute(&mut learner.database).await?;

    let results = Query::text("test").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1);

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_bulk_remove_and_readd() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    Add::paper(&create_test_paper()).execute(&mut learner.database).await?;
    Add::paper(&create_second_test_paper()).execute(&mut learner.database).await?;

    let removed = Remove::from_query(Query::text("test")).execute(&mut learner.database).await?;
    assert_eq!(removed.len(), 2);

    for paper in &removed {
      Add::paper(paper).execute(&mut learner.database).await?;
    }

    let results = Query::text("test").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 2);

    // Verify order is preserved
    assert_eq!(results[0].title, removed[0].title);
    assert_eq!(results[1].title, removed[1].title);

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_readd_with_different_completion() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    // Add paper without document
    let paper = learner.retriever.get_paper("https://arxiv.org/abs/2301.07041").await?;
    Add::paper(&paper).execute(&mut learner.database).await?;

    // Remove it
    let removed = Remove::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;

    // Readd with document
    Add::complete(&removed[0]).execute(&mut learner.database).await?;

    // Verify paper exists with updated data
    let results = Query::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;
    assert_eq!(results.len(), 1);

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_remove_and_readd_preserves_metadata() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    let mut paper = create_test_paper();
    // Add some optional fields
    paper.doi = Some("10.1234/test".to_string());
    paper.pdf_url = Some("https://example.com/test.pdf".to_string());

    Add::paper(&paper).execute(&mut learner.database).await?;

    let removed = Remove::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;
    Add::paper(&removed[0]).execute(&mut learner.database).await?;

    let results = Query::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;
    assert_eq!(results[0].doi, paper.doi);
    assert_eq!(results[0].pdf_url, paper.pdf_url);

    Ok(())
  }

  #[tokio::test]
  #[traced_test]
  async fn test_remove_readd_with_updated_data() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;

    let paper = create_test_paper();
    Add::paper(&paper).execute(&mut learner.database).await?;

    let mut removed = Remove::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;

    // Modify the removed paper
    let mut updated_paper = removed.remove(0);
    updated_paper.abstract_text = "Updated abstract".to_string();
    updated_paper.doi = Some("10.1234/new".to_string());

    // Readd with changes
    Add::paper(&updated_paper).execute(&mut learner.database).await?;

    let results = Query::by_source(&paper.source, &paper.source_identifier)
      .execute(&mut learner.database)
      .await?;
    assert_eq!(results[0].abstract_text, "Updated abstract");
    assert_eq!(results[0].doi, Some("10.1234/new".to_string()));

    Ok(())
  }
}