citum-engine 0.53.0

Citum citation and bibliography processor
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

/*
SPDX-License-Identifier: MIT OR Apache-2.0
SPDX-FileCopyrightText: © 2023-2026 Bruce D'Arcus
*/

#![allow(missing_docs, reason = "test")]
#![allow(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::panic,
    clippy::indexing_slicing,
    clippy::todo,
    clippy::unimplemented,
    clippy::unreachable,
    clippy::get_unwrap,
    reason = "Panicking is acceptable and often desired in test, benchmark, and example code."
)]

/*
SPDX-License-Identifier: MIT OR Apache-2.0
SPDX-FileCopyrightText: © 2023-2026 Bruce D'Arcus
*/

mod common;
use common::*;

use citum_engine::Processor;
use citum_schema::{
    CitationSpec, Style, StyleInfo,
    citation::{Citation, CitationItem},
    options::{Config, ContributorConfig, NameForm},
};
use rstest::rstest;

/// Build a test style with configurable name-form and initialize-with options.
fn build_name_form_test_style(
    name_form: Option<NameForm>,
    initialize_with: Option<String>,
) -> Style {
    Style {
        info: StyleInfo {
            title: Some("Name Form Test".to_string()),
            id: Some("name-form-test".into()),
            ..Default::default()
        },
        options: Some(Config {
            contributors: Some(ContributorConfig {
                name_form,
                initialize_with,
                ..Default::default()
            }),
            ..Default::default()
        }),
        citation: Some(CitationSpec {
            template: Some(vec![citum_schema::tc_contributor!(Author, Long)]),
            ..Default::default()
        }),
        ..Default::default()
    }
}

/// Test matrix: (name_form, initialize_with, expected_output)
#[rstest]
#[case(Some(NameForm::Full), None, "John Samuel Doe")]
#[case(Some(NameForm::Initials), Some("".to_string()), "JS Doe")]
#[case(Some(NameForm::Initials), Some(" ".to_string()), "J S Doe")]
#[case(Some(NameForm::Initials), Some(". ".to_string()), "J. S. Doe")]
#[case(None, None, "John Samuel Doe")] // Default is Full
#[case(None, Some("".to_string()), "John Samuel Doe")] // initialize-with alone has no effect without name-form: initials
fn name_form_controls_given_name_rendering(
    #[case] name_form: Option<NameForm>,
    #[case] initialize_with: Option<String>,
    #[case] expected_output: &str,
) {
    let style = build_name_form_test_style(name_form, initialize_with);
    let bibliography = citum_schema::bib_map![
        "kuhn-1962" => make_book(
            "kuhn-1962",
            "Doe",
            "John Samuel",
            1962,
            "The Structure of Scientific Revolutions",
        )
    ];

    let processor = Processor::new(style, bibliography);
    let citation = Citation {
        items: vec![CitationItem {
            id: "kuhn-1962".to_string(),
            ..Default::default()
        }],
        ..Default::default()
    };

    let rendered = processor
        .process_citation(&citation)
        .expect("Failed to render citation");

    // Extract just the author name part (before any dates)
    let author_part = rendered
        .split_whitespace()
        .take(3)
        .collect::<Vec<_>>()
        .join(" ");
    assert_eq!(
        author_part, expected_output,
        "Name form + initialize-with combination incorrect"
    );
}