tusks-lib 3.0.0

Declarative CLI framework built on top of clap
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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
use syn::ItemFn;
use crate::parsing::util::attr::AttributeCheck;

use crate::models::Tusk;

impl Tusk {
    pub fn from_fn(
        item_fn: ItemFn,
        default_exists: bool,
        allow_external_subcommands: bool
    ) -> syn::Result<Option<Self>> {
        // Only consider pub functions
        if !matches!(item_fn.vis, syn::Visibility::Public(_)) || item_fn.has_attr("skip") {
            return Ok(None);
        }

        // Validate return type is either nothing, i32, or Option<i32>
        Self::validate_return_type(&item_fn.sig.output)?;

        let is_default = item_fn.has_attr("default");
        let is_async = item_fn.sig.asyncness.is_some();

        if is_async && !cfg!(feature = "async") {
            return Err(syn::Error::new_spanned(
                &item_fn.sig.asyncness,
                "async command functions require the `async` feature. \
                 Add `tusks = { version = \"...\", features = [\"async\"] }` to your Cargo.toml"
            ));
        }

        if is_default {
            default_function::validate(&item_fn, default_exists, allow_external_subcommands)?;
        }

        Ok(Some(Tusk {
            func: item_fn,
            is_default,
            is_async,
        }))
    }
    
    /// Validate that the return type is either nothing, u8, or Option<u8>
    fn validate_return_type(output: &syn::ReturnType) -> syn::Result<()> {
        match output {
            syn::ReturnType::Default => {
                // No return type - that's fine
                Ok(())
            }
            syn::ReturnType::Type(_, ty) => {
                // Check if it's u8 or Option<u8>
                if Self::is_u8_type(ty) || Self::is_option_u8_type(ty) {
                    Ok(())
                } else {
                    Err(syn::Error::new_spanned(
                        ty,
                        "command function must return (), u8, or Option<u8>"
                    ))
                }
            }
        }
    }

    /// Check if a type is u8
    pub fn is_u8_type(ty: &syn::Type) -> bool {
        let syn::Type::Path(type_path) = ty else {
            return false;
        };

        let Some(segment) = type_path.path.segments.last() else {
            return false;
        };

        segment.ident == "u8"
    }

    /// Check if a type is Option<u8>
    pub fn is_option_u8_type(ty: &syn::Type) -> bool {
        let syn::Type::Path(type_path) = ty else {
            return false;
        };

        let Some(segment) = type_path.path.segments.last() else {
            return false;
        };

        if segment.ident != "Option" {
            return false;
        }

        let syn::PathArguments::AngleBracketed(args) = &segment.arguments else {
            return false;
        };

        let Some(first_arg) = args.args.first() else {
            return false;
        };

        let syn::GenericArgument::Type(inner_ty) = first_arg else {
            return false;
        };

        Self::is_u8_type(inner_ty)
    }
}

mod default_function {
    use syn::ItemFn;

    pub fn validate(
        item_fn: &ItemFn,
        default_exists: bool,
        allow_external_subcommands: bool
    ) -> syn::Result<()> {
        check_duplicate_default(item_fn, default_exists)?;
        validate_default_function_arguments(item_fn, allow_external_subcommands)
    }

    fn check_duplicate_default(item_fn: &ItemFn, default_exists: bool) -> syn::Result<()> {
        if default_exists {
            if let Some(attr) = item_fn.attrs.iter().find(|a| a.path().is_ident("default")) {
                return Err(syn::Error::new_spanned(
                    attr,
                    "only one function can be marked with #[default]"
                ));
            }
        }
        Ok(())
    }

    fn validate_default_function_arguments(
        item_fn: &ItemFn,
        allow_external_subcommands: bool
    ) -> syn::Result<()> {
        match item_fn.sig.inputs.len() {
            0 => Ok(()),
            1 => validate_single_argument(&item_fn.sig.inputs[0], allow_external_subcommands),
            2 => validate_two_arguments(
                &item_fn.sig.inputs[0],
                &item_fn.sig.inputs[1],
                allow_external_subcommands
            ),
            _ => Err(syn::Error::new_spanned(
                &item_fn.sig.inputs,
                error_message_too_many_args(allow_external_subcommands)
            ))
        }
    }

    fn validate_single_argument(
        arg: &syn::FnArg,
        allow_external_subcommands: bool
    ) -> syn::Result<()> {
        let syn::FnArg::Typed(pat_type) = arg else {
            return Err(error_single_argument(arg, allow_external_subcommands));
        };

        // Check if it's &Parameters (reference without path)
        if is_parameters_reference(&pat_type.ty) {
            return Ok(());
        }

        // Check if it's Vec<String> (not a reference)
        if allow_external_subcommands {
            if let syn::Type::Path(type_path) = &*pat_type.ty {
                if is_vec_string(type_path) {
                    return Ok(());
                }
            }
        }

        Err(error_single_argument(arg, allow_external_subcommands))
    }

    fn validate_two_arguments(
        arg1: &syn::FnArg,
        arg2: &syn::FnArg,
        allow_external_subcommands: bool
    ) -> syn::Result<()> {
        if !allow_external_subcommands {
            return Err(syn::Error::new_spanned(
                quote::quote! { #arg1, #arg2 },
                "default function must have either no arguments \
                    or exactly one argument of type &Parameters"
            ));
        }

        let (syn::FnArg::Typed(pat_type1), syn::FnArg::Typed(pat_type2)) = (arg1, arg2) else {
            return Err(error_two_arguments_signature(arg1, arg2));
        };

        // First must be &Parameters, second must be Vec<String>
        if !is_parameters_reference(&pat_type1.ty) {
            return Err(error_two_arguments_signature(arg1, arg2));
        }

        let syn::Type::Path(type_path2) = &*pat_type2.ty else {
            return Err(error_two_arguments_signature(arg1, arg2));
        };

        if !is_vec_string(type_path2) {
            return Err(error_two_arguments_signature(arg1, arg2))
        }

        Ok(())
    }

    /// Check if type is &Parameters (reference to Parameters without path)
    fn is_parameters_reference(ty: &syn::Type) -> bool {
        let syn::Type::Reference(type_ref) = ty else {
            return false;
        };

        let syn::Type::Path(type_path) = &*type_ref.elem else {
            return false;
        };

        // Check that it's just "Parameters" without any path segments
        type_path.path.segments.len() == 1 
        && type_path.path.segments[0].ident == "Parameters"
        && type_path.qself.is_none()
    }

    fn error_single_argument(
        arg: &syn::FnArg,
        allow_external_subcommands: bool
    ) -> syn::Error {
        let message = if allow_external_subcommands {
            "default function must have either no arguments, \
                a &Parameters argument, \
                a Vec<String> argument, \
                or both (&Parameters, Vec<String>)"
        } else {
            "default function must have either no arguments \
                or exactly one argument of type &Parameters"
        };
        syn::Error::new_spanned(arg, message)
    }

    fn error_two_arguments_signature(arg1: &syn::FnArg, arg2: &syn::FnArg) -> syn::Error {
        syn::Error::new_spanned(
            quote::quote! { #arg1, #arg2 },
            "default function with two arguments must have signature: \
                (&Parameters, Vec<String>)"
        )
    }

    fn error_message_too_many_args(allow_external_subcommands: bool) -> &'static str {
        if allow_external_subcommands {
            "default function must have at most two arguments: \
                &Parameters and Vec<String>"
        } else {
            "default function must have either no arguments \
                or exactly one argument of type &Parameters"
        }
    }


    /// Helper function to check if a type is Vec<String>
    fn is_vec_string(type_path: &syn::TypePath) -> bool {
        let Some(segment) = type_path.path.segments.last() else {
            return false;
        };

        if segment.ident != "Vec" {
            return false;
        }

        let syn::PathArguments::AngleBracketed(args) = &segment.arguments else {
            return false;
        };

        if args.args.len() != 1 {
            return false;
        }

        let syn::GenericArgument::Type(syn::Type::Path(inner_type)) = &args.args[0] else {
            return false;
        };

        inner_type.path.is_ident("String")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn parse_fn(code: &str) -> ItemFn {
        syn::parse_str::<ItemFn>(code).unwrap()
    }

    // --- Type checking helpers ---

    fn parse_type(code: &str) -> syn::Type {
        syn::parse_str::<syn::Type>(code).unwrap()
    }

    #[test]
    fn is_u8_type_accepts_u8() {
        assert!(Tusk::is_u8_type(&parse_type("u8")));
    }

    #[test]
    fn is_u8_type_rejects_u32() {
        assert!(!Tusk::is_u8_type(&parse_type("u32")));
    }

    #[test]
    fn is_u8_type_rejects_string() {
        assert!(!Tusk::is_u8_type(&parse_type("String")));
    }

    #[test]
    fn is_option_u8_accepts_option_u8() {
        assert!(Tusk::is_option_u8_type(&parse_type("Option<u8>")));
    }

    #[test]
    fn is_option_u8_rejects_option_u32() {
        assert!(!Tusk::is_option_u8_type(&parse_type("Option<u32>")));
    }

    #[test]
    fn is_option_u8_rejects_option_string() {
        assert!(!Tusk::is_option_u8_type(&parse_type("Option<String>")));
    }

    #[test]
    fn is_option_u8_rejects_bare_u8() {
        assert!(!Tusk::is_option_u8_type(&parse_type("u8")));
    }

    #[test]
    fn is_option_u8_rejects_vec_u8() {
        assert!(!Tusk::is_option_u8_type(&parse_type("Vec<u8>")));
    }

    // --- Tusk::from_fn ---

    #[test]
    fn from_fn_public_no_return() {
        let f = parse_fn("pub fn hello() {}");
        let result = Tusk::from_fn(f, false, false).unwrap();
        assert!(result.is_some());
        assert!(!result.unwrap().is_default);
    }

    #[test]
    fn from_fn_public_returns_u8() {
        let f = parse_fn("pub fn hello() -> u8 { 0 }");
        let result = Tusk::from_fn(f, false, false).unwrap();
        assert!(result.is_some());
    }

    #[test]
    fn from_fn_public_returns_option_u8() {
        let f = parse_fn("pub fn hello() -> Option<u8> { None }");
        let result = Tusk::from_fn(f, false, false).unwrap();
        assert!(result.is_some());
    }

    #[test]
    fn from_fn_rejects_invalid_return_type() {
        let f = parse_fn("pub fn hello() -> String { String::new() }");
        let err = Tusk::from_fn(f, false, false).unwrap_err();
        assert!(err.to_string().contains("must return (), u8, or Option<u8>"));
    }

    #[test]
    fn from_fn_rejects_i32_return() {
        let f = parse_fn("pub fn hello() -> i32 { 0 }");
        let err = Tusk::from_fn(f, false, false).unwrap_err();
        assert!(err.to_string().contains("must return (), u8, or Option<u8>"));
    }

    #[test]
    fn from_fn_skips_private() {
        let f = parse_fn("fn hello() {}");
        let result = Tusk::from_fn(f, false, false).unwrap();
        assert!(result.is_none());
    }

    #[test]
    fn from_fn_skips_skip_attribute() {
        let f = parse_fn("#[skip] pub fn hello() {}");
        let result = Tusk::from_fn(f, false, false).unwrap();
        assert!(result.is_none());
    }

    #[test]
    fn from_fn_default_attribute() {
        let f = parse_fn("#[default] pub fn hello() {}");
        let result = Tusk::from_fn(f, false, false).unwrap();
        assert!(result.is_some());
        assert!(result.unwrap().is_default);
    }

    #[test]
    fn from_fn_duplicate_default_errors() {
        let f = parse_fn("#[default] pub fn hello() {}");
        let err = Tusk::from_fn(f, true, false).unwrap_err();
        assert!(err.to_string().contains("only one function can be marked with #[default]"));
    }

    // --- Default function argument validation ---

    #[test]
    fn default_fn_zero_args_ok() {
        let f = parse_fn("#[default] pub fn hello() {}");
        assert!(Tusk::from_fn(f, false, false).is_ok());
    }

    #[test]
    fn default_fn_parameters_arg_ok() {
        let f = parse_fn("#[default] pub fn hello(p: &Parameters) {}");
        assert!(Tusk::from_fn(f, false, false).is_ok());
    }

    #[test]
    fn default_fn_vec_string_without_external_subcommands_fails() {
        let f = parse_fn("#[default] pub fn hello(args: Vec<String>) {}");
        let err = Tusk::from_fn(f, false, false).unwrap_err();
        assert!(err.to_string().contains("&Parameters"));
    }

    #[test]
    fn default_fn_vec_string_with_external_subcommands_ok() {
        let f = parse_fn("#[default] pub fn hello(args: Vec<String>) {}");
        assert!(Tusk::from_fn(f, false, true).is_ok());
    }

    #[test]
    fn default_fn_two_args_with_external_subcommands_ok() {
        let f = parse_fn("#[default] pub fn hello(p: &Parameters, args: Vec<String>) {}");
        assert!(Tusk::from_fn(f, false, true).is_ok());
    }

    #[test]
    fn default_fn_two_args_without_external_subcommands_fails() {
        let f = parse_fn("#[default] pub fn hello(p: &Parameters, args: Vec<String>) {}");
        let err = Tusk::from_fn(f, false, false).unwrap_err();
        assert!(err.to_string().contains("&Parameters"));
    }

    #[test]
    fn default_fn_three_args_fails() {
        let f = parse_fn("#[default] pub fn hello(a: String, b: String, c: String) {}");
        let err = Tusk::from_fn(f, false, true).unwrap_err();
        assert!(err.to_string().contains("at most two arguments"));
    }

    #[test]
    fn default_fn_wrong_single_arg_type_fails() {
        let f = parse_fn("#[default] pub fn hello(x: String) {}");
        let err = Tusk::from_fn(f, false, false).unwrap_err();
        assert!(err.to_string().contains("&Parameters"));
    }

    #[test]
    fn default_fn_two_args_wrong_order_fails() {
        // Vec<String> first, &Parameters second — wrong order
        let f = parse_fn("#[default] pub fn hello(args: Vec<String>, p: &Parameters) {}");
        let err = Tusk::from_fn(f, false, true).unwrap_err();
        assert!(err.to_string().contains("(&Parameters, Vec<String>)"));
    }

    // --- Async detection ---

    #[test]
    fn sync_fn_is_not_async() {
        let f = parse_fn("pub fn hello() {}");
        let tusk = Tusk::from_fn(f, false, false).unwrap().unwrap();
        assert!(!tusk.is_async);
    }

    #[test]
    #[cfg(feature = "async")]
    fn async_fn_detected() {
        let f = parse_fn("pub async fn hello() {}");
        let tusk = Tusk::from_fn(f, false, false).unwrap().unwrap();
        assert!(tusk.is_async);
    }

    #[test]
    #[cfg(not(feature = "async"))]
    fn async_fn_without_feature_errors() {
        let f = parse_fn("pub async fn hello() {}");
        let err = Tusk::from_fn(f, false, false).unwrap_err();
        assert!(err.to_string().contains("async"));
    }
}