asciidoc-parser 0.14.5

Parser for AsciiDoc format
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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
use std::sync::LazyLock;

use regex::Regex;

use crate::{
    HasSpan, Parser, Span,
    content::{Content, SubstitutionGroup},
};

/// The revision line is the line directly after the author line in the document
/// header. When the content on this line is structured correctly, the processor
/// assigns the content to the built-in `revnumber`, `revdate`, and `revremark`
/// attributes.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct RevisionLine<'src> {
    revnumber: Option<String>,
    revdate: String,
    revremark: Option<String>,
    source: Span<'src>,
}

impl<'src> RevisionLine<'src> {
    pub(crate) fn parse(source: Span<'src>, parser: &mut Parser) -> Self {
        let (left_of_colon, revremark) = if let Some((loc, remark)) = source.split_once(':') {
            (loc.to_owned(), Some(remark.trim().to_owned()))
        } else {
            (source.data().to_owned(), None)
        };

        let (revnumber, revdate) = if let Some((rev, date)) = left_of_colon.split_once(',') {
            // When there's a comma, we have a revision number followed by a date.
            let rev_trimmed = rev.trim();
            let cleaned_rev = strip_non_numeric_prefix(rev_trimmed);
            (Some(cleaned_rev), date.trim().to_owned())
        } else {
            // No comma: Check if this is a standalone revision number.
            let trimmed = left_of_colon.trim();
            if is_valid_standalone_revision(trimmed) {
                // This is a standalone revision number (like "v1.2.3").
                let cleaned_rev = strip_non_numeric_prefix(trimmed);
                (Some(cleaned_rev), String::new())
            } else {
                // This is just a date or other content, not a revision number.
                (None, trimmed.to_owned())
            }
        };

        if let Some(revnumber) = revnumber.as_deref() {
            parser.set_attribute_by_value_from_header("revnumber", revnumber);
        }

        parser.set_attribute_by_value_from_header("revdate", &revdate);

        if let Some(revremark) = revremark.as_deref() {
            parser.set_attribute_by_value_from_header("revremark", revremark);
        }

        Self {
            revnumber: revnumber.map(|s| apply_header_subs(&s, parser)),
            revdate: apply_header_subs(&revdate, parser),
            revremark: revremark.map(|s| apply_header_subs(&s, parser)),
            source,
        }
    }

    /// Returns the revision number, if present.
    ///
    /// The document’s revision number or version is assigned to the built-in
    /// `revnumber` attribute. When assigned using the revision line, the
    /// version must contain at least one number, and, if it isn’t followed by a
    /// date or remark, it must begin with the letter `v` (e.g., `v7.0.6`). Any
    /// letters or symbols preceding the number, including `v`, are dropped when
    /// the document is rendered. If `revnumber` is set with an attribute entry,
    /// it doesn’t have to contain a number and the entire value is displayed in
    /// the rendered document.
    pub fn revnumber(&self) -> Option<&str> {
        self.revnumber.as_deref()
    }

    /// Returns the revision date.
    ///
    /// The date the revision was completed is assigned to the built-in
    /// `revdate` attribute. If the date is assigned using the revision line, it
    /// must be separated from the version by a comma (e.g., `78.1,
    /// 2020-10-10`). The date can contain letters, numbers, symbols, and
    /// attribute references.
    pub fn revdate(&self) -> &str {
        &self.revdate
    }

    /// Returns the revision remark, if present.
    ///
    /// Remarks about the revision of the document are assigned to the built-in
    /// `revremark` attribute. The remark must be separated by a colon (`:`)
    /// from the version or revision date when assigned using the revision line.
    pub fn revremark(&self) -> Option<&str> {
        self.revremark.as_deref()
    }
}

impl<'src> HasSpan<'src> for RevisionLine<'src> {
    fn span(&self) -> Span<'src> {
        self.source
    }
}

fn apply_header_subs(source: &str, parser: &Parser) -> String {
    let span = Span::new(source);

    let mut content = Content::from(span);
    SubstitutionGroup::Header.apply(&mut content, parser, None);

    content.rendered().to_string()
}

fn is_valid_standalone_revision(s: &str) -> bool {
    STANDALONE_REVISION.is_match(s)
}

fn strip_non_numeric_prefix(s: &str) -> String {
    NON_NUMERIC_PREFIX
        .captures(s)
        .and_then(|captures| captures.get(1))
        .map_or_else(|| s.to_owned(), |m| m.as_str().to_owned())
}

static STANDALONE_REVISION: LazyLock<Regex> = LazyLock::new(|| {
    #[allow(clippy::unwrap_used)]
    Regex::new(r"^v\d").unwrap()
});

static NON_NUMERIC_PREFIX: LazyLock<Regex> = LazyLock::new(|| {
    #[allow(clippy::unwrap_used)]
    Regex::new(r"^[^0-9]*(.*)$").unwrap()
});

#[cfg(test)]
mod tests {
    #![allow(clippy::unwrap_used)]

    use crate::{Span, tests::prelude::*};

    #[test]
    fn v_prefix_standalone() {
        let mut parser = Parser::default();
        let result = crate::document::RevisionLine::parse(Span::new("v1.2.3"), &mut parser);

        assert_eq!(result.revnumber(), Some("1.2.3"));
        assert_eq!(result.revdate(), "");
        assert_eq!(result.revremark(), None);
    }

    #[test]
    fn standalone_number_without_v_prefix() {
        let mut parser = Parser::default();
        let result = crate::document::RevisionLine::parse(Span::new("1.2.3"), &mut parser);

        // According to Asciidoctor behavior, standalone numbers without "v" are not
        // revision numbers
        assert_eq!(result.revnumber(), None);
        assert_eq!(result.revdate(), "1.2.3");
        assert_eq!(result.revremark(), None);
    }

    #[test]
    fn other_prefix_standalone() {
        let mut parser = Parser::default();
        let result = crate::document::RevisionLine::parse(Span::new("LPR1.2.3"), &mut parser);

        // Other prefixes don't have special standalone treatment
        assert_eq!(result.revnumber(), None);
        assert_eq!(result.revdate(), "LPR1.2.3");
        assert_eq!(result.revremark(), None);
    }

    #[test]
    fn v_prefix_with_comma_and_date() {
        let mut parser = Parser::default();
        let result =
            crate::document::RevisionLine::parse(Span::new("v1.2.3, 2023-01-15"), &mut parser);

        assert_eq!(result.revnumber(), Some("1.2.3"));
        assert_eq!(result.revdate(), "2023-01-15");
        assert_eq!(result.revremark(), None);
    }

    #[test]
    fn other_prefix_with_comma_and_date() {
        let mut parser = Parser::default();
        let result =
            crate::document::RevisionLine::parse(Span::new("LPR1.2.3, 2023-01-15"), &mut parser);

        // With comma, other prefixes should be stripped from revision number
        assert_eq!(result.revnumber(), Some("1.2.3"));
        assert_eq!(result.revdate(), "2023-01-15");
        assert_eq!(result.revremark(), None);
    }

    #[test]
    fn revision_with_colon_and_remark() {
        let mut parser = Parser::default();
        let result =
            crate::document::RevisionLine::parse(Span::new("v1.2.3: A great release"), &mut parser);

        assert_eq!(result.revnumber(), Some("1.2.3"));
        assert_eq!(result.revdate(), "");
        assert_eq!(result.revremark(), Some("A great release"));
    }

    #[test]
    fn full_revision_line() {
        let mut parser = Parser::default();
        let result = crate::document::RevisionLine::parse(
            Span::new("v2.1.0, 2023-12-25: Christmas release"),
            &mut parser,
        );

        assert_eq!(result.revnumber(), Some("2.1.0"));
        assert_eq!(result.revdate(), "2023-12-25");
        assert_eq!(result.revremark(), Some("Christmas release"));
    }

    #[test]
    fn only_date() {
        let mut parser = Parser::default();
        let result = crate::document::RevisionLine::parse(Span::new("2023-01-15"), &mut parser);

        // Just a date, no revision number
        assert_eq!(result.revnumber(), None);
        assert_eq!(result.revdate(), "2023-01-15");
        assert_eq!(result.revremark(), None);
    }

    #[test]
    fn date_with_remark() {
        let mut parser = Parser::default();
        let result = crate::document::RevisionLine::parse(
            Span::new("2023-01-15: New year update"),
            &mut parser,
        );

        assert_eq!(result.revnumber(), None);
        assert_eq!(result.revdate(), "2023-01-15");
        assert_eq!(result.revremark(), Some("New year update"));
    }

    #[test]
    fn whitespace_handling() {
        let mut parser = Parser::default();
        let result = crate::document::RevisionLine::parse(
            Span::new("  v1.0.0  ,   Jan 1, 2023   :   Initial release  "),
            &mut parser,
        );

        assert_eq!(result.revnumber(), Some("1.0.0"));
        assert_eq!(result.revdate(), "Jan 1, 2023");
        assert_eq!(result.revremark(), Some("Initial release"));
    }

    #[test]
    fn v_only_no_digits() {
        let mut parser = Parser::default();
        let result = crate::document::RevisionLine::parse(Span::new("v"), &mut parser);

        // "v" without digits should not be treated as a standalone revision
        assert_eq!(result.revnumber(), None);
        assert_eq!(result.revdate(), "v");
        assert_eq!(result.revremark(), None);
    }

    #[test]
    fn complex_version_with_v() {
        let mut parser = Parser::default();
        let result = crate::document::RevisionLine::parse(Span::new("v1.2.3-beta.1"), &mut parser);

        assert_eq!(result.revnumber(), Some("1.2.3-beta.1"));
        assert_eq!(result.revdate(), "");
        assert_eq!(result.revremark(), None);
    }

    #[test]
    fn numeric_prefix_stripped() {
        let mut parser = Parser::default();
        let result =
            crate::document::RevisionLine::parse(Span::new("abc123def, 2023-01-01"), &mut parser);

        // Non-numeric prefix should be stripped, leaving "123def"
        assert_eq!(result.revnumber(), Some("123def"));
        assert_eq!(result.revdate(), "2023-01-01");
        assert_eq!(result.revremark(), None);
    }

    #[test]
    fn no_numeric_content() {
        let mut parser = Parser::default();
        let result =
            crate::document::RevisionLine::parse(Span::new("nodigits, 2023-01-01"), &mut parser);

        // When there are no digits, the prefix stripping should leave empty string
        assert_eq!(result.revnumber(), Some(""));
        assert_eq!(result.revdate(), "2023-01-01");
        assert_eq!(result.revremark(), None);
    }

    #[test]
    fn sets_document_attributes_with_all_components() {
        let mut parser = Parser::default();
        let _result = crate::document::RevisionLine::parse(
            Span::new("v2.1.0, 2023-12-25: Christmas release"),
            &mut parser,
        );

        assert_eq!(
            parser.attribute_value("revnumber").as_maybe_str(),
            Some("2.1.0")
        );

        assert_eq!(
            parser.attribute_value("revdate").as_maybe_str(),
            Some("2023-12-25")
        );

        assert_eq!(
            parser.attribute_value("revremark").as_maybe_str(),
            Some("Christmas release")
        );
    }

    #[test]
    fn sets_document_attributes_revision_number_only() {
        let mut parser = Parser::default();
        let _result = crate::document::RevisionLine::parse(Span::new("v1.2.3"), &mut parser);

        assert_eq!(
            parser.attribute_value("revnumber").as_maybe_str(),
            Some("1.2.3")
        );

        assert_eq!(parser.attribute_value("revdate").as_maybe_str(), Some(""));
        assert_eq!(parser.attribute_value("revremark").as_maybe_str(), None);
    }

    #[test]
    fn sets_document_attributes_date_only() {
        let mut parser = Parser::default();
        let _result = crate::document::RevisionLine::parse(Span::new("2023-01-15"), &mut parser);

        assert_eq!(parser.attribute_value("revnumber").as_maybe_str(), None);

        assert_eq!(
            parser.attribute_value("revdate").as_maybe_str(),
            Some("2023-01-15")
        );

        assert_eq!(parser.attribute_value("revremark").as_maybe_str(), None);
    }

    #[test]
    fn sets_document_attributes_date_with_remark() {
        let mut parser = Parser::default();
        let _result = crate::document::RevisionLine::parse(
            Span::new("2023-01-15: New year update"),
            &mut parser,
        );

        assert_eq!(parser.attribute_value("revnumber").as_maybe_str(), None);

        assert_eq!(
            parser.attribute_value("revdate").as_maybe_str(),
            Some("2023-01-15")
        );

        assert_eq!(
            parser.attribute_value("revremark").as_maybe_str(),
            Some("New year update")
        );
    }

    #[test]
    fn sets_document_attributes_revision_with_date() {
        let mut parser = Parser::default();
        let _result =
            crate::document::RevisionLine::parse(Span::new("v1.2.3, 2023-01-15"), &mut parser);

        assert_eq!(
            parser.attribute_value("revnumber").as_maybe_str(),
            Some("1.2.3")
        );

        assert_eq!(
            parser.attribute_value("revdate").as_maybe_str(),
            Some("2023-01-15")
        );

        assert_eq!(parser.attribute_value("revremark").as_maybe_str(), None);
    }

    #[test]
    fn sets_document_attributes_revision_with_remark_only() {
        let mut parser = Parser::default();
        let _result =
            crate::document::RevisionLine::parse(Span::new("v1.2.3: A great release"), &mut parser);

        assert_eq!(
            parser.attribute_value("revnumber").as_maybe_str(),
            Some("1.2.3")
        );

        assert_eq!(parser.attribute_value("revdate").as_maybe_str(), Some(""));

        assert_eq!(
            parser.attribute_value("revremark").as_maybe_str(),
            Some("A great release")
        );
    }

    #[test]
    fn sets_document_attributes_with_whitespace_handling() {
        let mut parser = Parser::default();
        let _result = crate::document::RevisionLine::parse(
            Span::new("  v1.0.0  ,   Jan 1, 2023   :   Initial release  "),
            &mut parser,
        );

        assert_eq!(
            parser.attribute_value("revnumber").as_maybe_str(),
            Some("1.0.0")
        );

        assert_eq!(
            parser.attribute_value("revdate").as_maybe_str(),
            Some("Jan 1, 2023")
        );

        assert_eq!(
            parser.attribute_value("revremark").as_maybe_str(),
            Some("Initial release")
        );
    }

    #[test]
    fn sets_document_attributes_with_prefix_stripping() {
        let mut parser = Parser::default();
        let _result =
            crate::document::RevisionLine::parse(Span::new("abc123def, 2023-01-01"), &mut parser);

        assert_eq!(
            parser.attribute_value("revnumber").as_maybe_str(),
            Some("123def")
        );

        assert_eq!(
            parser.attribute_value("revdate").as_maybe_str(),
            Some("2023-01-01")
        );

        assert_eq!(parser.attribute_value("revremark").as_maybe_str(), None);
    }

    #[test]
    fn sets_document_attributes_complex_version() {
        let mut parser = Parser::default();
        let _result = crate::document::RevisionLine::parse(Span::new("v1.2.3-beta.1"), &mut parser);

        assert_eq!(
            parser.attribute_value("revnumber").as_maybe_str(),
            Some("1.2.3-beta.1")
        );

        assert_eq!(parser.attribute_value("revdate").as_maybe_str(), Some(""));
        assert_eq!(parser.attribute_value("revremark").as_maybe_str(), None);
    }
}