instruct-macros 0.1.8

instruct-macros are a collection of simple macros that we're using in Instructor-AI to generate json schema from Serde Objects
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

extern crate instruct_macros_types;

use instruct_macros::InstructMacro;
use instruct_macros_types::{
    InstructMacro, InstructMacroResult, Parameter, ParameterInfo, StructInfo,
};

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

    #[test]
    fn test_option_type_support() {
        #[derive(InstructMacro, Debug)]
        #[allow(dead_code)]
        #[description("This is a struct with Option types")]
        struct TestOptionStruct {
            #[description("This is an optional string field")]
            pub field1: Option<String>,
            #[description("This is an optional integer field")]
            pub field2: Option<i32>,
        }

        let info = TestOptionStruct::get_info();
        let desired_struct = StructInfo {
            name: "TestOptionStruct".to_string(),
            description: "This is a struct with Option types".to_string(),
            is_optional: false,
            is_list: false,
            parameters: vec![
                Parameter::Field(ParameterInfo {
                    name: "field1".to_string(),
                    r#type: "Option<String>".to_string(),
                    comment: "This is an optional string field".to_string(),
                    is_optional: true,
                    is_list: false,
                }),
                Parameter::Field(ParameterInfo {
                    name: "field2".to_string(),
                    r#type: "Option<i32>".to_string(),
                    comment: "This is an optional integer field".to_string(),
                    is_optional: true,
                    is_list: false,
                }),
            ],
        };

        let info_struct = match info {
            InstructMacroResult::Struct(s) => s,
            _ => panic!("Expected StructInfo"),
        };

        assert_eq!(info_struct, desired_struct);
    }

    #[test]
    fn test_option_maybe_struct() {
        #[derive(InstructMacro, Debug)]
        #[allow(dead_code)]
        #[description("This is a user struct")]
        struct User {
            #[description("This is the user's name")]
            pub name: String,
            #[description("This is the user's age")]
            pub age: i32,
        }

        #[derive(InstructMacro, Debug)]
        #[allow(dead_code)]
        #[description("This is a struct with Option<user> type")]
        struct MaybeUser {
            #[description("This is an optional user field")]
            pub user: Option<User>,
        }

        let info = MaybeUser::get_info();
        let desired_struct = StructInfo {
            name: "MaybeUser".to_string(),
            description: "This is a struct with Option<user> type".to_string(),
            parameters: vec![Parameter::Struct(StructInfo {
                name: "user".to_string(),
                description: "This is an optional user field".to_string(),
                parameters: vec![
                    Parameter::Field(ParameterInfo {
                        name: "name".to_string(),
                        r#type: "String".to_string(),
                        comment: "This is the user's name".to_string(),
                        is_optional: false,
                        is_list: false,
                    }),
                    Parameter::Field(ParameterInfo {
                        name: "age".to_string(),
                        r#type: "i32".to_string(),
                        comment: "This is the user's age".to_string(),
                        is_optional: false,
                        is_list: false,
                    }),
                ],
                is_optional: true,
                is_list: false,
            })],
            is_optional: false,
            is_list: false,
        };

        let info_struct = match info {
            InstructMacroResult::Struct(s) => s,
            _ => panic!("Expected StructInfo"),
        };

        assert_eq!(info_struct, desired_struct);
    }
}