clipv 0.4.0

Command line interpretor parser (and future validator)
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

//SPDX-FileCopyrightText: 2024 Claire Bts <claxxx.bts@gmail.com>
//SPDX-License-Identifier: GPL-3.0-or-later

// clipv aims to simplify writing cli and/or parser in general

//Copyright (C) 2024 Claire Bts claxxx.bts@gmail.com

//This program is free software: you can redistribute it and/or modify it under the terms of the
//GNU General Public License as published by the Free Software Foundation, either version 3 of the
//License, or (at your option) any later version.

//This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
//even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
//General Public License for more details.

//You should have received a copy of the GNU General Public License along with this program. If
//not, see <https://www.gnu.org/licenses/>.


#[cfg(feature = "derive")]
mod derive_test {
use clipv::describe::arg::{Arg, ArgGroup, ArgType, AsArg, Choices};
use clipv::AsArg;

#[allow(dead_code)]
#[derive(AsArg)]
struct SimpleNamed {
    /// first structure field
    var1: u8,
    var2: String,
    /// This is a more
    /// complexe documentation
    var3: usize,
}

#[test]
fn it_should_support_struct_with_named_and_single_depth_fields() {
    assert_eq!(
        SimpleNamed::arguments(),
        ArgType::Group(ArgGroup(vec![
            Arg::new("var1", Some("first structure field")),
            Arg::new("var2", None),
            Arg::new("var3", Some("This is a more\ncomplexe documentation"))
        ]))
    );
}

#[allow(dead_code)]
#[derive(AsArg)]
enum SimpleEnum {
    Variant1,
    /// provides some documentation
    Variant2,
}

fn simple_enum_arguments() -> ArgType {
    ArgType::Choices(Choices(vec![
        Arg::new("Variant1", None),
        Arg::new("Variant2", Some("provides some documentation")),
    ]))
}

#[test]
fn it_should_support_enum_with_a_single_depth_field() {
    assert_eq!(SimpleEnum::arguments(), simple_enum_arguments());
}

#[allow(dead_code)]
#[derive(AsArg)]
struct SimpleUnnamed(
    /// first structure field
    u8,
    std::string::String,
    /// This is a more
    /// complexe documentation
    usize,
);

#[test]
fn it_should_support_struct_with_unnamed_and_single_depth_fields() {
    assert_eq!(
        SimpleUnnamed::arguments(),
        ArgType::Group(ArgGroup(vec![
            Arg::new("u8", Some("first structure field")),
            Arg::new("String", None),
            Arg::new("usize", Some("This is a more\ncomplexe documentation"))
        ]))
    );
}

#[allow(dead_code)]
#[derive(AsArg)]
enum NestedStruct {
    /// this is a nested structure variable
    Struct {
        a: u8,
        /// b is a subvariable of a struct
        b: u8,
    },
    Tuple(u8, u8),
    Unit,
}

fn nested_struct_arguments() -> ArgType {
    ArgType::Choices(Choices(vec![
        Arg::with_type(
            "Struct",
            Some("this is a nested structure variable"),
            ArgType::Group(ArgGroup(vec![
                Arg::new("a", None),
                Arg::new("b", Some("b is a subvariable of a struct")),
            ])),
        ),
        Arg::with_type(
            "Tuple",
            None,
            ArgType::Group(ArgGroup(vec![Arg::new("u8", None), Arg::new("u8", None)])),
        ),
        Arg::new("Unit", None),
    ]))
}

#[test]
fn it_should_support_nested_struct() {
    assert_eq!(NestedStruct::arguments(), nested_struct_arguments());
}

#[allow(dead_code)]
#[derive(AsArg)]
struct NestedStructWithAttributes {
    /// subgroup searching for the nestedstruct arguments
    #[group]
    nested_struct: NestedStruct,
    #[choices]
    /// sub enum
    subenum: SimpleEnum,
}

#[test]
fn it_should_support_arg_attribute() {
    assert_eq!(
        NestedStructWithAttributes::arguments(),
        ArgType::Group(ArgGroup(vec![
            Arg::with_type(
                "nested_struct",
                Some("subgroup searching for the nestedstruct arguments"),
                nested_struct_arguments()
            ),
            Arg::with_type("subenum", Some("sub enum"), simple_enum_arguments())
        ]))
    );
}
}