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

use chrono::Datelike;

use super::*;

/// Basic paper search functionality
mod paper_search {
  use super::*;

  #[tokio::test]
  #[traced_test]
  async fn test_basic_paper_search() -> 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 results = Query::by_paper(&paper).execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].title, "Test Paper");
    Ok(())
  }
}

/// Basic text search functionality
mod text_search {
  use super::*;

  #[tokio::test]
  #[traced_test]
  async fn test_basic_text_search() -> 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 results = Query::text("test paper").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].title, "Test Paper");
    Ok(())
  }

  #[traced_test]
  #[tokio::test]
  async fn test_case_insensitive_search() -> 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 results = Query::text("TEST PAPER").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].title, "Test Paper");

    Ok(())
  }

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

    let mut paper = create_test_paper();
    paper.title = "Testing Paper".to_string();
    Add::paper(&paper).execute(&mut learner.database).await?;

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

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

    let results = Query::text("est").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 0, "Partial word match should not work");

    Ok(())
  }

  #[traced_test]
  #[tokio::test]
  async fn test_abstract_search() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;
    let mut paper = create_test_paper();
    paper.abstract_text = "This is a unique phrase in the abstract".to_string();
    Add::paper(&paper).execute(&mut learner.database).await?;

    // Search should only match title by default since that's what we indexed
    let results = Query::text("unique phrase").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 0);

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

    Ok(())
  }

  #[traced_test]
  #[tokio::test]
  async fn test_multiple_term_search() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;
    let mut paper = create_test_paper();
    paper.title = "Machine Learning Research".to_string();
    paper.abstract_text = "A study about neural networks".to_string();
    Add::paper(&paper).execute(&mut learner.database).await?;

    // Each term should be searched independently in title
    let results = Query::text("machine").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1, "Should match single term in title");

    let results = Query::text("learning research").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1, "Should match multiple terms in title");

    // Abstract text isn't searched
    let results = Query::text("neural").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 0, "Should not match terms in abstract");

    Ok(())
  }
}

/// Author search functionality
mod author_search {
  use super::*;

  #[tokio::test]
  async fn test_exact_author_match() -> 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 results = Query::by_author("John Doe").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1);
    Ok(())
  }

  #[traced_test]
  #[tokio::test]
  async fn test_partial_author_name() -> TestResult<()> {
    let (mut learner, _cfg_dir, _db_dir, _strg_dir) = create_test_learner().await;
    let mut paper = create_test_paper();
    paper.authors =
      vec![Author { name: "John Smith".to_string(), affiliation: None, email: None }, Author {
        name:        "Jane Smith".to_string(),
        affiliation: None,
        email:       None,
      }];
    Add::paper(&paper).execute(&mut learner.database).await?;

    let results = Query::by_author("Smith").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].authors.len(), 2);

    let results = Query::by_author("SMITH").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1, "Author search should be case insensitive");

    Ok(())
  }

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

    let mut paper1 = create_test_paper();
    let mut paper2 = create_second_test_paper();

    // Give both papers the same author
    let author =
      Author { name: "Shared Author".to_string(), affiliation: None, email: None };
    paper1.authors = vec![author.clone()];
    paper2.authors = vec![author];

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

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

    Ok(())
  }

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

    let mut paper = create_test_paper();
    paper.authors = vec![Author {
      name:        "John Doe".to_string(),
      affiliation: Some("Test University".to_string()),
      email:       Some("john@test.edu".to_string()),
    }];

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

    let results = Query::by_author("John Doe").execute(&mut learner.database).await?;
    assert_eq!(results[0].authors[0].affiliation, Some("Test University".to_string()));
    assert_eq!(results[0].authors[0].email, Some("john@test.edu".to_string()));

    Ok(())
  }
}

/// Source-based search functionality
mod source_search {
  use super::*;

  #[traced_test]
  #[tokio::test]
  async fn test_basic_source_search() -> 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 results = Query::by_source("arxiv", "2301.00000").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].source_identifier, "2301.00000");
    Ok(())
  }

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

    let mut paper1 = create_test_paper();
    let mut paper2 = create_second_test_paper();
    paper1.source = "arxiv".to_string();
    paper2.source = "doi".to_string();

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

    let results =
      Query::list_all().order_by(OrderField::Source).execute(&mut learner.database).await?;
    assert_eq!(results.len(), 2);
    assert!(results.iter().any(|p| p.source == "arxiv"));
    assert!(results.iter().any(|p| p.source == "doi"));

    Ok(())
  }

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

    let mut paper = create_test_paper();
    paper.source = "doi".to_string();
    paper.source_identifier = "10.1234/test".to_string();
    paper.doi = Some(paper.source_identifier.clone());

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

    let results = Query::by_source("doi", "10.1234/test").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].doi, Some("10.1234/test".to_string()));

    Ok(())
  }
}

/// Ordering and pagination tests
mod ordering {
  use super::*;

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

    let paper1 = create_test_paper(); // 2023
    let paper2 = create_second_test_paper(); // 2024

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

    let results = Query::list_all()
      .order_by(OrderField::PublicationDate)
      .execute(&mut learner.database)
      .await?;
    assert_eq!(results[0].publication_date.year(), 2023);
    assert_eq!(results[1].publication_date.year(), 2024);

    let results = Query::list_all()
      .order_by(OrderField::PublicationDate)
      .descending()
      .execute(&mut learner.database)
      .await?;
    assert_eq!(results[0].publication_date.year(), 2024);
    assert_eq!(results[1].publication_date.year(), 2023);

    Ok(())
  }

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

    let mut paper1 = create_test_paper();
    let mut paper2 = create_second_test_paper();
    paper1.title = "Beta Paper".to_string();
    paper2.title = "Alpha Paper".to_string();

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

    let results =
      Query::list_all().order_by(OrderField::Title).execute(&mut learner.database).await?;
    assert_eq!(results[0].title, "Alpha Paper");
    assert_eq!(results[1].title, "Beta Paper");

    Ok(())
  }
}

/// Edge cases and special conditions
mod edge_cases {
  use super::*;

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

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

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

    let results = Query::by_author("any author").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 0);

    Ok(())
  }

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

    let mut paper = create_test_paper();
    // Use simpler special characters that FTS5 can handle
    paper.title = "Test Paper: A Study".to_string();
    paper.authors = vec![Author {
      name:        "O'Connor Smith".to_string(),
      affiliation: None,
      email:       None,
    }];

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

    // Search with and without special characters
    let results = Query::text("Test Paper").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1);

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

    // Author search should still work with apostrophe
    let results = Query::by_author("O'Connor").execute(&mut learner.database).await?;
    assert_eq!(results.len(), 1);

    Ok(())
  }

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

    let mut paper = create_test_paper();
    paper.title = "A ".repeat(500) + "unique marker";

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

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

    Ok(())
  }
}

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

  let mut paper = create_test_paper();
  paper.title = "Testing: Advanced Search & Queries".to_string();
  paper.abstract_text = "This is a complex abstract with many terms".to_string();
  Add::paper(&paper).execute(&mut learner.database).await?;

  // Basic word search works
  let results = Query::text("Testing").execute(&mut learner.database).await?;
  assert_eq!(results.len(), 1);

  // Words are tokenized properly
  let results = Query::text("Advanced Search").execute(&mut learner.database).await?;
  assert_eq!(results.len(), 1);

  // Special characters are treated as word boundaries
  let results = Query::text("Queries").execute(&mut learner.database).await?;
  assert_eq!(results.len(), 1);

  // Only title is searchable
  let results = Query::text("complex abstract").execute(&mut learner.database).await?;
  assert_eq!(results.len(), 0);

  Ok(())
}