pdbrust 0.7.0

A comprehensive Rust library for parsing and analyzing Protein Data Bank (PDB) files
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
436
437
438
439
440
441
442
443
//! Integration tests for the selection language.

#![cfg(feature = "filter")]

use pdbrust::{PdbStructure, SelectionError, parse_pdb_file};
use std::path::PathBuf;

fn get_test_file(name: &str) -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("examples")
        .join("pdb_files")
        .join(name)
}

fn load_test_structure() -> PdbStructure {
    parse_pdb_file(get_test_file("1UBQ.pdb")).expect("Failed to load test structure")
}

// ============================================================================
// Basic Selector Tests
// ============================================================================

#[test]
fn test_select_chain() {
    let structure = load_test_structure();
    let selected = structure.select("chain A").unwrap();

    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert_eq!(atom.chain_id, "A", "All atoms should be from chain A");
    }
}

#[test]
fn test_select_name_ca() {
    let structure = load_test_structure();
    let selected = structure.select("name CA").unwrap();

    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert_eq!(atom.name.trim(), "CA", "All atoms should be CA");
    }
}

#[test]
fn test_select_resname() {
    let structure = load_test_structure();
    let selected = structure.select("resname MET").unwrap();

    // 1UBQ has at least one MET residue (Met1)
    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert_eq!(
            atom.residue_name.trim(),
            "MET",
            "All atoms should be from MET residues"
        );
    }
}

#[test]
fn test_select_resid() {
    let structure = load_test_structure();
    let selected = structure.select("resid 1").unwrap();

    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert_eq!(atom.residue_seq, 1, "All atoms should be from residue 1");
    }
}

#[test]
fn test_select_resid_range() {
    let structure = load_test_structure();
    let selected = structure.select("resid 1:10").unwrap();

    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert!(
            atom.residue_seq >= 1 && atom.residue_seq <= 10,
            "All atoms should be from residues 1-10, got {}",
            atom.residue_seq
        );
    }
}

#[test]
fn test_select_element() {
    let structure = load_test_structure();
    let selected = structure.select("element N").unwrap();

    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert_eq!(
            atom.element.trim().to_uppercase(),
            "N",
            "All atoms should be nitrogen"
        );
    }
}

// ============================================================================
// Keyword Tests
// ============================================================================

#[test]
fn test_select_backbone() {
    let structure = load_test_structure();
    let selected = structure.select("backbone").unwrap();

    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert!(
            atom.is_backbone(),
            "All atoms should be backbone atoms, got {}",
            atom.name
        );
    }
}

#[test]
fn test_select_protein() {
    let structure = load_test_structure();
    let selected = structure.select("protein").unwrap();

    // 1UBQ is a protein, so most atoms should match
    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert!(
            pdbrust::filter::is_standard_amino_acid(&atom.residue_name),
            "All atoms should be from standard amino acids, got {}",
            atom.residue_name
        );
    }
}

#[test]
fn test_select_all() {
    let structure = load_test_structure();
    let selected_all = structure.select("all").unwrap();
    let selected_star = structure.select("*").unwrap();

    assert_eq!(
        selected_all.atoms.len(),
        structure.atoms.len(),
        "all should select all atoms"
    );
    assert_eq!(
        selected_star.atoms.len(),
        structure.atoms.len(),
        "* should select all atoms"
    );
}

// ============================================================================
// Boolean Operator Tests
// ============================================================================

#[test]
fn test_select_and() {
    let structure = load_test_structure();
    let selected = structure.select("chain A and name CA").unwrap();

    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert_eq!(atom.chain_id, "A", "All atoms should be from chain A");
        assert_eq!(atom.name.trim(), "CA", "All atoms should be CA");
    }
}

#[test]
fn test_select_or() {
    let structure = load_test_structure();
    let selected = structure.select("resname MET or resname GLN").unwrap();

    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        let resname = atom.residue_name.trim();
        assert!(
            resname == "MET" || resname == "GLN",
            "All atoms should be from MET or GLN residues, got {}",
            resname
        );
    }
}

#[test]
fn test_select_not() {
    let structure = load_test_structure();
    let selected = structure.select("not hydrogen").unwrap();

    for atom in &selected.atoms {
        assert!(!atom.is_hydrogen(), "No atoms should be hydrogen");
    }
}

#[test]
fn test_select_parentheses() {
    let structure = load_test_structure();
    // (resid 1 or resid 2) and name CA
    let selected = structure
        .select("(resid 1 or resid 2) and name CA")
        .unwrap();

    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert!(
            atom.residue_seq == 1 || atom.residue_seq == 2,
            "Residue should be 1 or 2, got {}",
            atom.residue_seq
        );
        assert_eq!(atom.name.trim(), "CA", "All atoms should be CA");
    }
}

#[test]
fn test_select_complex() {
    let structure = load_test_structure();
    let selected = structure
        .select("chain A and backbone and not hydrogen")
        .unwrap();

    assert!(!selected.atoms.is_empty(), "Selection should not be empty");
    for atom in &selected.atoms {
        assert_eq!(atom.chain_id, "A", "All atoms should be from chain A");
        assert!(atom.is_backbone(), "All atoms should be backbone");
        assert!(!atom.is_hydrogen(), "No atoms should be hydrogen");
    }
}

// ============================================================================
// Numeric Comparison Tests
// ============================================================================

#[test]
fn test_select_bfactor_lt() {
    let structure = load_test_structure();
    let selected = structure.select("bfactor < 20.0").unwrap();

    for atom in &selected.atoms {
        assert!(
            atom.temp_factor < 20.0,
            "B-factor should be < 20.0, got {}",
            atom.temp_factor
        );
    }
}

#[test]
fn test_select_bfactor_ge() {
    let structure = load_test_structure();
    let selected = structure.select("bfactor >= 10.0").unwrap();

    for atom in &selected.atoms {
        assert!(
            atom.temp_factor >= 10.0,
            "B-factor should be >= 10.0, got {}",
            atom.temp_factor
        );
    }
}

#[test]
fn test_select_occupancy() {
    let structure = load_test_structure();
    let selected = structure.select("occupancy > 0.5").unwrap();

    for atom in &selected.atoms {
        assert!(
            atom.occupancy > 0.5,
            "Occupancy should be > 0.5, got {}",
            atom.occupancy
        );
    }
}

// ============================================================================
// Alternative Keyword Tests
// ============================================================================

#[test]
fn test_select_alternative_keywords() {
    let structure = load_test_structure();

    // Test various alternative forms
    let _ = structure.select("chainid A").unwrap();
    let _ = structure.select("atomname CA").unwrap();
    let _ = structure.select("resn MET").unwrap();
    let _ = structure.select("resi 1").unwrap();
    let _ = structure.select("elem N").unwrap();
    let _ = structure.select("bb").unwrap(); // backbone
}

#[test]
fn test_select_case_insensitive() {
    let structure = load_test_structure();

    // Keywords should be case-insensitive
    let upper = structure.select("CHAIN A AND NAME CA").unwrap();
    let lower = structure.select("chain a and name ca").unwrap();

    assert_eq!(
        upper.atoms.len(),
        lower.atoms.len(),
        "Case should not matter for keywords"
    );
}

// ============================================================================
// Equivalence Tests (compare with existing filter methods)
// ============================================================================

#[test]
fn test_select_equivalence_chain() {
    let structure = load_test_structure();

    let via_select = structure.select("chain A").unwrap();
    let via_filter = structure.keep_only_chain("A");

    assert_eq!(
        via_select.atoms.len(),
        via_filter.atoms.len(),
        "select('chain A') should be equivalent to keep_only_chain('A')"
    );
}

#[test]
fn test_select_equivalence_ca() {
    let structure = load_test_structure();

    let via_select = structure.select("name CA").unwrap();
    let via_filter = structure.keep_only_ca();

    assert_eq!(
        via_select.atoms.len(),
        via_filter.atoms.len(),
        "select('name CA') should be equivalent to keep_only_ca()"
    );
}

#[test]
fn test_select_equivalence_backbone() {
    let structure = load_test_structure();

    let via_select = structure.select("backbone").unwrap();
    let via_filter = structure.keep_only_backbone();

    assert_eq!(
        via_select.atoms.len(),
        via_filter.atoms.len(),
        "select('backbone') should be equivalent to keep_only_backbone()"
    );
}

#[test]
fn test_select_equivalence_protein() {
    let structure = load_test_structure();

    let via_select = structure.select("protein").unwrap();
    let via_filter = structure.remove_ligands();

    assert_eq!(
        via_select.atoms.len(),
        via_filter.atoms.len(),
        "select('protein') should be equivalent to remove_ligands() for a pure protein"
    );
}

#[test]
fn test_select_equivalence_chain_and_ca() {
    let structure = load_test_structure();

    let via_select = structure.select("chain A and name CA").unwrap();
    let via_filter = structure.keep_only_chain("A").keep_only_ca();

    assert_eq!(
        via_select.atoms.len(),
        via_filter.atoms.len(),
        "select('chain A and name CA') should be equivalent to keep_only_chain('A').keep_only_ca()"
    );
}

// ============================================================================
// Error Handling Tests
// ============================================================================

#[test]
fn test_select_error_empty() {
    let structure = load_test_structure();
    let result = structure.select("");

    assert!(matches!(result, Err(SelectionError::EmptySelection)));
}

#[test]
fn test_select_error_unclosed_paren() {
    let structure = load_test_structure();
    let result = structure.select("(chain A and name CA");

    assert!(matches!(
        result,
        Err(SelectionError::UnclosedParenthesis { .. })
    ));
}

#[test]
fn test_select_error_unknown_keyword() {
    let structure = load_test_structure();
    let result = structure.select("unknown_keyword");

    assert!(matches!(result, Err(SelectionError::UnknownKeyword { .. })));
}

#[test]
fn test_select_error_missing_value() {
    let structure = load_test_structure();
    let result = structure.select("chain and name CA");

    // "chain and" should fail because "and" is parsed as the chain value
    // then "name" becomes an unknown keyword (we need an operator)
    assert!(result.is_err());
}

// ============================================================================
// Validation Tests
// ============================================================================

#[test]
fn test_validate_selection_valid() {
    assert!(PdbStructure::validate_selection("chain A").is_ok());
    assert!(PdbStructure::validate_selection("chain A and name CA").is_ok());
    assert!(PdbStructure::validate_selection("(chain A or chain B) and backbone").is_ok());
    assert!(PdbStructure::validate_selection("resid 1:100 and protein").is_ok());
    assert!(PdbStructure::validate_selection("bfactor < 30.0").is_ok());
}

#[test]
fn test_validate_selection_invalid() {
    assert!(PdbStructure::validate_selection("").is_err());
    assert!(PdbStructure::validate_selection("(chain A").is_err());
    assert!(PdbStructure::validate_selection("unknown_keyword").is_err());
    assert!(PdbStructure::validate_selection("chain and").is_err());
}