nanoargs 0.6.0

A minimal, zero-dependency argument parser for Rust CLI applications
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

// Feature: argument-groups
// Property tests for argument groups and conflict sets

mod common;

use nanoargs::{ArgBuilder, Flag, Opt};
use proptest::prelude::*;

use common::arb_safe_identifier;

/// Generate 2–5 distinct identifiers for use as flag/option long names.
fn arb_distinct_names(count: std::ops::RangeInclusive<usize>) -> impl Strategy<Value = Vec<String>> {
    prop::collection::vec(arb_safe_identifier(), count).prop_map(|names| {
        let mut seen = std::collections::HashSet::new();
        names.into_iter().filter(|n| n != "help" && n != "version" && seen.insert(n.clone())).collect::<Vec<_>>()
    })
}

// Feature: argument-groups, Property 1: Builder stores groups and conflicts
// **Validates: Requirements 1.1, 1.4, 3.1, 3.4**
proptest! {
    #[test]
    fn prop1_builder_stores_groups_and_conflicts(
        names in arb_distinct_names(4..=8),
        group_name in arb_safe_identifier(),
        conflict_name in arb_safe_identifier(),
    ) {
        // Need at least 4 distinct names: 2 for group members, 2 for conflict members
        prop_assume!(names.len() >= 4);

        let (group_members, rest) = names.split_at(2);
        let conflict_members = &rest[..2];

        // Register all names as flags
        let mut builder = ArgBuilder::new();
        for name in &names {
            builder = builder.flag(Flag::new(name));
        }

        let gm: Vec<&str> = group_members.iter().map(|s| s.as_str()).collect();
        let cm: Vec<&str> = conflict_members.iter().map(|s| s.as_str()).collect();

        let parser = builder
            .group(&group_name, &gm)
            .conflict(&conflict_name, &cm)
            .build()
            .unwrap();

        // Verify group stored correctly
        prop_assert_eq!(parser.groups().len(), 1);
        prop_assert_eq!(&parser.groups()[0].name, &group_name);
        prop_assert_eq!(&parser.groups()[0].members, &group_members.to_vec());

        // Verify conflict stored correctly
        prop_assert_eq!(parser.conflicts().len(), 1);
        prop_assert_eq!(&parser.conflicts()[0].name, &conflict_name);
        prop_assert_eq!(&parser.conflicts()[0].members, &conflict_members.to_vec());
    }
}

// Feature: argument-groups, Property 1 (multiple sets): Builder stores multiple groups and conflicts independently
proptest! {
    #[test]
    fn prop1b_builder_stores_multiple_groups_independently(
        names in arb_distinct_names(6..=10),
        group1_name in arb_safe_identifier(),
        group2_name in arb_safe_identifier(),
    ) {
        prop_assume!(names.len() >= 6);

        let members1 = &names[0..2];
        let members2 = &names[2..4];

        let mut builder = ArgBuilder::new();
        for name in &names {
            builder = builder.flag(Flag::new(name));
        }

        let m1: Vec<&str> = members1.iter().map(|s| s.as_str()).collect();
        let m2: Vec<&str> = members2.iter().map(|s| s.as_str()).collect();

        let parser = builder
            .group(&group1_name, &m1)
            .group(&group2_name, &m2)
            .build()
            .unwrap();

        prop_assert_eq!(parser.groups().len(), 2);
        prop_assert_eq!(&parser.groups()[0].name, &group1_name);
        prop_assert_eq!(&parser.groups()[1].name, &group2_name);
    }
}

// Feature: argument-groups, Property 2: Unknown member names cause build failure
// **Validates: Requirements 1.3, 3.3**
proptest! {
    #[test]
    fn prop2_unknown_group_member_causes_build_failure(
        known_name in arb_safe_identifier(),
        unknown_name in arb_safe_identifier(),
        group_name in arb_safe_identifier(),
    ) {
        prop_assume!(known_name != unknown_name);
        prop_assume!(known_name != "help" && known_name != "version");
        prop_assume!(unknown_name != "help" && unknown_name != "version");

        let result = ArgBuilder::new()
            .flag(Flag::new(&known_name))
            .group(&group_name, &[&known_name, &unknown_name])
            .build();

        prop_assert!(result.is_err());
        let err = result.unwrap_err();
        let msg = format!("{}", err);
        prop_assert!(msg.contains(&unknown_name), "Error should mention unknown member: {}", msg);
    }

    #[test]
    fn prop2_unknown_conflict_member_causes_build_failure(
        known_name in arb_safe_identifier(),
        unknown_name in arb_safe_identifier(),
        conflict_name in arb_safe_identifier(),
    ) {
        prop_assume!(known_name != unknown_name);
        prop_assume!(known_name != "help" && known_name != "version");
        prop_assume!(unknown_name != "help" && unknown_name != "version");

        let result = ArgBuilder::new()
            .flag(Flag::new(&known_name))
            .conflict(&conflict_name, &[&known_name, &unknown_name])
            .build();

        prop_assert!(result.is_err());
        let err = result.unwrap_err();
        let msg = format!("{}", err);
        prop_assert!(msg.contains(&unknown_name), "Error should mention unknown member: {}", msg);
    }
}

// Property 2: Too few members cause build failure
proptest! {
    #[test]
    fn prop2_too_few_group_members_causes_build_failure(
        name in arb_safe_identifier(),
        group_name in arb_safe_identifier(),
    ) {
        prop_assume!(name != "help" && name != "version");

        let result = ArgBuilder::new()
            .flag(Flag::new(&name))
            .group(&group_name, &[&name as &str])
            .build();

        prop_assert!(result.is_err());
    }

    #[test]
    fn prop2_too_few_conflict_members_causes_build_failure(
        name in arb_safe_identifier(),
        conflict_name in arb_safe_identifier(),
    ) {
        prop_assume!(name != "help" && name != "version");

        let result = ArgBuilder::new()
            .flag(Flag::new(&name))
            .conflict(&conflict_name, &[&name as &str])
            .build();

        prop_assert!(result.is_err());
    }
}

// Property 1: Groups work with options too, not just flags
proptest! {
    #[test]
    fn prop1_groups_work_with_options(
        opt1 in arb_safe_identifier(),
        opt2 in arb_safe_identifier(),
        group_name in arb_safe_identifier(),
    ) {
        prop_assume!(opt1 != opt2);
        prop_assume!(opt1 != "help" && opt1 != "version");
        prop_assume!(opt2 != "help" && opt2 != "version");

        let parser = ArgBuilder::new()
            .option(Opt::new(&opt1))
            .option(Opt::new(&opt2))
            .group(&group_name, &[&opt1 as &str, &opt2 as &str])
            .build()
            .unwrap();

        prop_assert_eq!(parser.groups().len(), 1);
        prop_assert_eq!(&parser.groups()[0].members, &vec![opt1, opt2]);
    }
}

// Feature: argument-groups, Property 9: Subcommand-level groups and conflicts are independent
// **Validates: Requirements 7.1, 7.2**
proptest! {
    #[test]
    fn prop9_subcommand_group_validated_against_subcommand_args(
        global_flag in arb_safe_identifier(),
        sub_flag1 in arb_safe_identifier(),
        sub_flag2 in arb_safe_identifier(),
        subcmd_name in "[a-z][a-z0-9]{1,9}".prop_filter("avoid help", |s| s != "help"),
        group_name in arb_safe_identifier(),
        provide_sub_flag in prop::sample::select(vec![0u8, 1, 2]),
    ) {
        prop_assume!(global_flag != "help" && global_flag != "version");
        prop_assume!(sub_flag1 != "help" && sub_flag1 != "version");
        prop_assume!(sub_flag2 != "help" && sub_flag2 != "version");
        prop_assume!(sub_flag1 != sub_flag2);
        prop_assume!(global_flag != sub_flag1 && global_flag != sub_flag2);

        // Subcommand parser has a group requiring at least one of sub_flag1 or sub_flag2
        let sub_parser = ArgBuilder::new()
            .flag(Flag::new(&sub_flag1))
            .flag(Flag::new(&sub_flag2))
            .group(&group_name, &[&sub_flag1, &sub_flag2])
            .build()
            .unwrap();

        // Parent parser has a global flag but NO groups/conflicts
        let parent = ArgBuilder::new()
            .flag(Flag::new(&global_flag))
            .subcommand(&subcmd_name, "test sub", sub_parser)
            .build()
            .unwrap();

        // Always provide the global flag, vary subcommand flags
        let mut args = vec![format!("--{global_flag}"), subcmd_name.clone()];
        match provide_sub_flag {
            0 => {} // provide neither sub flag → should fail with GroupViolation
            1 => args.push(format!("--{sub_flag1}")),
            _ => args.push(format!("--{sub_flag2}")),
        }

        let result = parent.parse(args);
        if provide_sub_flag == 0 {
            // Group violation from subcommand parser
            let err = result.unwrap_err();
            let msg = format!("{}", err);
            prop_assert!(msg.contains(&group_name), "Error should mention group name: {}", msg);
        } else {
            // Should succeed
            prop_assert!(result.is_ok(), "Expected success but got: {:?}", result);
        }
    }

    #[test]
    fn prop9_subcommand_conflict_validated_against_subcommand_args(
        global_flag in arb_safe_identifier(),
        sub_flag1 in arb_safe_identifier(),
        sub_flag2 in arb_safe_identifier(),
        subcmd_name in "[a-z][a-z0-9]{1,9}".prop_filter("avoid help", |s| s != "help"),
        conflict_name in arb_safe_identifier(),
        provide_count in 0u8..3,
    ) {
        prop_assume!(global_flag != "help" && global_flag != "version");
        prop_assume!(sub_flag1 != "help" && sub_flag1 != "version");
        prop_assume!(sub_flag2 != "help" && sub_flag2 != "version");
        prop_assume!(sub_flag1 != sub_flag2);
        prop_assume!(global_flag != sub_flag1 && global_flag != sub_flag2);

        // Subcommand parser has a conflict set between sub_flag1 and sub_flag2
        let sub_parser = ArgBuilder::new()
            .flag(Flag::new(&sub_flag1))
            .flag(Flag::new(&sub_flag2))
            .conflict(&conflict_name, &[&sub_flag1, &sub_flag2])
            .build()
            .unwrap();

        // Parent parser has a global flag but NO conflicts
        let parent = ArgBuilder::new()
            .flag(Flag::new(&global_flag))
            .subcommand(&subcmd_name, "test sub", sub_parser)
            .build()
            .unwrap();

        // Always provide the global flag, vary subcommand flags
        let mut args = vec![format!("--{global_flag}"), subcmd_name.clone()];
        if provide_count >= 1 {
            args.push(format!("--{sub_flag1}"));
        }
        if provide_count >= 2 {
            args.push(format!("--{sub_flag2}"));
        }

        let result = parent.parse(args);
        if provide_count >= 2 {
            // Conflict violation from subcommand parser
            let err = result.unwrap_err();
            let msg = format!("{}", err);
            prop_assert!(msg.contains(&conflict_name), "Error should mention conflict name: {}", msg);
        } else {
            // Should succeed
            prop_assert!(result.is_ok(), "Expected success but got: {:?}", result);
        }
    }

    #[test]
    fn prop9_parent_group_independent_of_subcommand(
        parent_flag1 in arb_safe_identifier(),
        parent_flag2 in arb_safe_identifier(),
        sub_flag in arb_safe_identifier(),
        subcmd_name in "[a-z][a-z0-9]{1,9}".prop_filter("avoid help", |s| s != "help"),
        group_name in arb_safe_identifier(),
        provide_parent_flag in prop::sample::select(vec![0u8, 1, 2]),
    ) {
        prop_assume!(parent_flag1 != "help" && parent_flag1 != "version");
        prop_assume!(parent_flag2 != "help" && parent_flag2 != "version");
        prop_assume!(sub_flag != "help" && sub_flag != "version");
        prop_assume!(parent_flag1 != parent_flag2);
        prop_assume!(sub_flag != parent_flag1 && sub_flag != parent_flag2);

        // Subcommand parser has no groups/conflicts
        let sub_parser = ArgBuilder::new()
            .flag(Flag::new(&sub_flag))
            .build()
            .unwrap();

        // Parent parser has a group requiring at least one of parent_flag1 or parent_flag2
        let parent = ArgBuilder::new()
            .flag(Flag::new(&parent_flag1))
            .flag(Flag::new(&parent_flag2))
            .group(&group_name, &[&parent_flag1, &parent_flag2])
            .subcommand(&subcmd_name, "test sub", sub_parser)
            .build()
            .unwrap();

        // Always provide the sub flag, vary parent flags
        let mut args = Vec::new();
        match provide_parent_flag {
            1 => args.push(format!("--{parent_flag1}")),
            2 => args.push(format!("--{parent_flag2}")),
            _ => {} // provide no parent flag → should fail with GroupViolation
        }
        args.push(subcmd_name.clone());
        args.push(format!("--{sub_flag}"));

        let result = parent.parse(args);
        if provide_parent_flag == 0 {
            // Group violation from parent parser (global args)
            let err = result.unwrap_err();
            let msg = format!("{}", err);
            prop_assert!(msg.contains(&group_name), "Error should mention group name: {}", msg);
        } else {
            prop_assert!(result.is_ok(), "Expected success but got: {:?}", result);
        }
    }
}