Skip to content

Add comprehensive relationship and search API #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AdamIsrael merged 8 commits into from
Dec 7, 2025
Merged

Add comprehensive relationship and search API #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7936fa1
Add comprehensive relationship and search API with benchmarks
AdamIsrael Dec 7, 2025
fe8a277
Fix clippy warnings in relationship functions
AdamIsrael Dec 7, 2025
7d48e34
Fix ordinal numbering to start at 2nd for relationship descriptions
AdamIsrael Dec 7, 2025
b4d7622
Follow Grandparent pattern for Aunt/Uncle and Niece/Nephew relationships
AdamIsrael Dec 7, 2025
1989433
Add roadmap for date parsing
AdamIsrael Dec 7, 2025
77f8a35
Address PR review feedback: gender-aware child descriptions and namin…
AdamIsrael Dec 7, 2025
a8bde5b
Fix Aunt/Uncle naming consistency for Great-Grand prefix
AdamIsrael Dec 7, 2025
88a75b6
Refactor Death event matching to use helper function
AdamIsrael Dec 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 108 additions & 3 deletions benches/parse_gedcom.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
use criterion::{criterion_group, criterion_main, Criterion};
use criterion::{black_box, criterion_group, criterion_main, Criterion};
use gedcom_rs::parse::{parse_gedcom, GedcomConfig};
use gedcom_rs::types::EventType;

use std::time::Duration;

const FILENAME: &str = "data/complete.ged";

fn criterion_benchmark(c: &mut Criterion) {
fn parse_benchmark(c: &mut Criterion) {
let mut group = c.benchmark_group("parse-gedcom");
group.measurement_time(Duration::from_secs(30));

Expand All @@ -19,5 +20,109 @@ fn criterion_benchmark(c: &mut Criterion) {
group.finish();
}

criterion_group!(benches, criterion_benchmark);
fn search_benchmark(c: &mut Criterion) {
let mut group = c.benchmark_group("search");
group.measurement_time(Duration::from_secs(5));

let config = GedcomConfig::new();
let gedcom = parse_gedcom(FILENAME, &config).expect("Failed to parse GEDCOM");

group.bench_function("find_individual_by_xref", |b| {
b.iter(|| gedcom.find_individual_by_xref(black_box("@I1@")))
});

group.bench_function("find_individuals_by_name", |b| {
b.iter(|| gedcom.find_individuals_by_name(black_box("Torture")))
});

group.bench_function("find_family_by_xref", |b| {
b.iter(|| gedcom.find_family_by_xref(black_box("@F1@")))
});

group.bench_function("find_individuals_by_event_date", |b| {
b.iter(|| {
gedcom.find_individuals_by_event_date(black_box(EventType::Birth), black_box("1965"))
})
});

group.finish();
}

fn basic_relationships_benchmark(c: &mut Criterion) {
let mut group = c.benchmark_group("basic-relationships");
group.measurement_time(Duration::from_secs(5));

let config = GedcomConfig::new();
let gedcom = parse_gedcom(FILENAME, &config).expect("Failed to parse GEDCOM");
let person = gedcom
.find_individual_by_xref("@I1@")
.expect("Failed to find person");

group.bench_function("get_parents", |b| {
b.iter(|| gedcom.get_parents(black_box(person)))
});

group.bench_function("get_children", |b| {
b.iter(|| gedcom.get_children(black_box(person)))
});

group.bench_function("get_spouses", |b| {
b.iter(|| gedcom.get_spouses(black_box(person)))
});

group.bench_function("get_siblings", |b| {
b.iter(|| gedcom.get_siblings(black_box(person)))
});

group.bench_function("get_full_siblings", |b| {
b.iter(|| gedcom.get_full_siblings(black_box(person)))
});

group.bench_function("get_half_siblings", |b| {
b.iter(|| gedcom.get_half_siblings(black_box(person)))
});

group.finish();
}

fn advanced_relationships_benchmark(c: &mut Criterion) {
let mut group = c.benchmark_group("advanced-relationships");
group.measurement_time(Duration::from_secs(5));

let config = GedcomConfig::new();
let gedcom = parse_gedcom(FILENAME, &config).expect("Failed to parse GEDCOM");
let person = gedcom
.find_individual_by_xref("@I1@")
.expect("Failed to find person");

group.bench_function("get_ancestors", |b| {
b.iter(|| gedcom.get_ancestors(black_box(person), black_box(Some(5))))
});

group.bench_function("get_descendants", |b| {
b.iter(|| gedcom.get_descendants(black_box(person), black_box(Some(5))))
});

let person2 = gedcom
.find_individual_by_xref("@I3@")
.expect("Failed to find person 2");

group.bench_function("find_relationship_path", |b| {
b.iter(|| gedcom.find_relationship_path(black_box(person), black_box(person2)))
});

group.bench_function("find_relationship", |b| {
b.iter(|| gedcom.find_relationship(black_box(person), black_box(person2)))
});

group.finish();
}

criterion_group!(
benches,
parse_benchmark,
search_benchmark,
basic_relationships_benchmark,
advanced_relationships_benchmark
);
criterion_main!(benches);
8 changes: 8 additions & 0 deletions docs/ROADMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,14 @@ Filters should allow for the partial parsing of genealogical data. TBD the exten
- Implement filtering capabilities for genealogical data
- Enhance search and query functionalities

6. **Date Parsing**

Dates are a freeform field, with some common conventions. We need to implement parsing and validation, as much as it's possible, to enable searching through events by date.

- Implement date parsing and validation
- Support various date formats and ranges
- Enhance date-related functionalities

### Medium Priority

4. **Source Record Parsing (SOUR)** ✅ Complete
Expand Down
Loading
Loading