apivolve_generator_api 0.1.1

Api for creating generators for Apivolve, an API evolution tool that helps keep your APIs backwards compatible yet clean.
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

use ::semver::Version;
use ::tempdir::TempDir;

use crate::gen1::{AcceptsConfig, Evolution, GenerationPreferences, Generator};
use crate::gen1::data::{IntWidth, Length, Message, NamedType, RecordType, Signed, TextType, Typ};
use crate::gen1::tests::generate::test_with_data;
use crate::util::Identifier;

pub fn generate_no_versions<G, GenFn>(
    accepts_config: AcceptsConfig,
    make_generator: GenFn,
) -> Result<TempDir, String>
where
    G: Generator,
    GenFn: FnOnce(GenerationPreferences) -> Result<G, String>,
{
    test_with_data(accepts_config, make_generator, None, vec![])
}

pub fn generate_core_features<
    G: Generator,
    GenFn: FnOnce(GenerationPreferences) -> Result<G, String>,
>(
    accepts_config: AcceptsConfig,
    make_generator: GenFn,
) -> Result<TempDir, String> {
    test_with_data(
        accepts_config,
        make_generator,
        None,
        vec![
            (
                Version::new(0, 2, 0),
                Evolution {
                    operations: vec![
                        //TODO @mark: fields
                        Message::new(RecordType::named(
                            Identifier::new("person").unwrap(),
                            vec![]
                        )),
                    ],
                    messages: vec![],
                },
            ),
            (
                Version::new(0, 1, 0),
                Evolution {
                    operations: vec![
                        //TODO @mark: fields
                        Message::new(RecordType::named(
                            Identifier::new("person").unwrap(),
                            vec![]
                        )),
                    ],
                    messages: vec![],
                },
            ),
        ],
    )
}

pub fn generate_with_pending<
    G: Generator,
    GenFn: FnOnce(GenerationPreferences) -> Result<G, String>,
>(
    accepts_config: AcceptsConfig,
    make_generator: GenFn,
) -> Result<TempDir, String> {
    test_with_data(
        accepts_config,
        make_generator,
        Some(Evolution {
            operations: vec![
                //TODO @mark: fields
                Message::new(RecordType::named(
                    Identifier::new("person").unwrap(),
                    vec![]
                )),
            ],
            messages: vec![],
        }),
        vec![
            (
                Version::new(0, 2, 0),
                Evolution {
                    operations: vec![
                        //TODO @mark: fields
                        Message::new(RecordType::named(
                            Identifier::new("person").unwrap(),
                            vec![
                                NamedType::new(Identifier::new("name").unwrap(), Typ::Text(TextType::new(Length::unknown()))),
                                NamedType::new(Identifier::new("balance").unwrap(), Typ::Int(IntType::new(IntWidth::Bit32, Signed::Signed))),
                            ]
                        )),
                    ],
                    messages: vec![],
                },
            ),
            (
                Version::new(0, 1, 0),
                Evolution {
                    operations: vec![
                        //TODO @mark: fields
                        Message::new(RecordType::named(
                            Identifier::new("person").unwrap(),
                            vec![]
                        )),
                    ],
                    messages: vec![],
                },
            ),
        ],
    )
}