cargo-sync-rdme 0.8.0

Cargo subcommand to synchronize README with crate 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

use indoc::formatdoc;
use similar_asserts::assert_eq;

use crate::{
    config::{badge::Badge, rustdoc::Rustdoc},
    manifest::Manifest,
    source::SourceFile,
};

pub(crate) use crate::testing::*;

pub(crate) fn badge_manifest(badge: &str) -> String {
    formatdoc! {r#"
        [package]
        name = "foo"
        version = "0.1.0"

        [package.metadata.cargo-sync-rdme.badge]
        {badge}
    "#}
}

pub(crate) fn rustdoc_manifest(rustdoc: &str) -> String {
    formatdoc! {r#"
        [package]
        name = "foo"
        version = "0.1.0"

        [package.metadata.cargo-sync-rdme.rustdoc]
        {rustdoc}
    "#}
}

#[track_caller]
pub(crate) fn manifest(source: &str) -> Manifest {
    let source = SourceFile::new_for_test("Cargo.toml", source);
    Manifest::new_for_test(&source).unwrap()
}

#[track_caller]
pub(crate) fn parse_config_err(source: &str, prefix: &str, spanned: &str) {
    let source = SourceFile::new_for_test("Cargo.toml", source);
    let (message, label, source_code) = Manifest::new_for_test(&source)
        .unwrap_err()
        .into_toml()
        .into_parse_toml();
    assert!(message.starts_with(prefix), "message: {message:?}");
    let label = label.unwrap();
    let span = label.offset()..label.offset() + label.len();
    assert_eq!(source.text().get(span).unwrap(), spanned);
    assert_eq!(source_code.name(), "Cargo.toml");
}

#[track_caller]
pub(crate) fn deserialize_config_err(source: &str, prefix: &str, spanned: &str) {
    let (message, label, source_code) = manifest(source)
        .package_config()
        .unwrap_err()
        .into_toml()
        .into_deserialize_toml();
    assert!(message.starts_with(prefix), "message: {message:?}");
    let label = label.unwrap();
    let span = label.offset()..label.offset() + label.len();
    assert_eq!(source.get(span).unwrap(), spanned);
    assert_eq!(source_code.name(), "Cargo.toml");
}

#[track_caller]
pub(crate) fn parse_badge(source: &str) -> Badge {
    manifest(source).package_config().unwrap().unwrap().badge
}

#[track_caller]
pub(crate) fn parse_rustdoc(source: &str) -> Rustdoc {
    manifest(source).package_config().unwrap().unwrap().rustdoc
}