protoschema 0.1.9

📐 Programmatically define protobuf contracts using flexible, modular and reusable elements
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

use std::{ops::Range, sync::Arc};

use askama::Template;
use convert_case::{Case, Casing};

use crate::{
  enums::{EnumData, EnumVariant},
  extensions::ExtensionData,
  fields::FieldData,
  files::FileData,
  messages::MessageData,
  oneofs::OneofData,
  packages::PackageData,
  services::ServiceData,
  ProtoOption,
};

/// The struct containing all of the processed data for a protobuf file template
#[derive(Debug, Clone, Template, Default)]
#[template(path = "file.proto.j2")]
pub struct FileTemplate {
  pub name: Arc<str>,
  pub imports: Vec<Arc<str>>,
  pub package: Arc<str>,
  pub messages: Vec<MessageTemplate>,
  pub enums: Vec<EnumTemplate>,
  pub services: Vec<ServiceData>,
  pub extensions: Vec<ExtensionData>,
  pub options: Box<[ProtoOption]>,
}

/// The struct containing all of the processed data for a protobuf message template
#[derive(Clone, Debug, Default, Template)]
#[template(path = "message.proto.j2")]
pub struct MessageTemplate {
  pub name: Arc<str>,
  pub package: Arc<str>,
  pub file: Arc<str>,
  pub fields: Box<[(u32, FieldData)]>,
  pub messages: Vec<MessageTemplate>,
  pub oneofs: Box<[OneofData]>,
  pub enums: Vec<EnumTemplate>,
  pub options: Box<[ProtoOption]>,
  pub reserved_names: Box<[Box<str>]>,
  pub reserved_numbers: Box<[u32]>,
  pub reserved_ranges: Box<[Range<u32>]>,
}

/// The struct containing all of the processed data for a protobuf enum template
#[derive(Clone, Debug, Default, Template)]
#[template(path = "enum.proto.j2")]
pub struct EnumTemplate {
  pub name: Arc<str>,
  pub variants: Box<[(i32, EnumVariant)]>,
  pub reserved_numbers: Box<[i32]>,
  pub reserved_ranges: Box<[Range<i32>]>,
  pub reserved_names: Box<[Box<str>]>,
  pub options: Box<[ProtoOption]>,
}

impl From<EnumData> for EnumTemplate {
  fn from(mut value: EnumData) -> Self {
    value.variants.sort_by_key(|t| t.0);

    let full_variants: Vec<(i32, EnumVariant)> = value
      .variants
      .into_iter()
      .map(|(tag, mut variant)| {
        variant.name = format!("{}_{}", value.name.to_case(Case::UpperSnake), variant.name).into();
        (tag, variant)
      })
      .collect();

    EnumTemplate {
      name: value.name.clone(),
      variants: full_variants.into_boxed_slice(),
      reserved_numbers: value.reserved_numbers,
      reserved_ranges: value.reserved_ranges,
      reserved_names: value.reserved_names,
      options: value.options,
    }
  }
}

impl FileData {
  pub(crate) fn build_template(&self, package: &PackageData) -> FileTemplate {
    let mut imports = self.imports.clone();

    let file_messages: Vec<MessageTemplate> = self
      .messages
      .iter()
      .map(|id| {
        let msg = &package.messages[*id];
        msg.imports.iter().for_each(|i| {
          if i.as_ref() != self.name.as_ref() {
            imports.insert(i.clone());
          };
        });
        msg.build_template(package)
      })
      .collect();

    let built_enums: Vec<EnumTemplate> = self
      .enums
      .iter()
      .map(|id| package.enums[*id].clone().into())
      .collect();

    let services: Vec<ServiceData> = self
      .services
      .iter()
      .map(|id| package.services[*id].clone())
      .collect();

    let mut sorted_imports: Vec<Arc<str>> = imports.iter().cloned().collect();
    sorted_imports.sort();

    FileTemplate {
      name: self.name.clone(),
      package: package.name.clone(),
      messages: file_messages,
      options: self.options.clone().into_boxed_slice(),
      imports: sorted_imports,
      extensions: self.extensions.clone(),
      enums: built_enums,
      services,
    }
  }
}

impl MessageData {
  pub(crate) fn build_template(&self, package: &PackageData) -> MessageTemplate {
    let built_messages: Vec<MessageTemplate> = self
      .messages
      .iter()
      .map(|id| {
        let data = &package.messages[*id];

        data.build_template(package)
      })
      .collect();

    let enums: Vec<EnumTemplate> = self
      .enums
      .iter()
      .map(|id| package.enums[*id].clone().into())
      .collect();

    MessageTemplate {
      name: self.name.clone(),
      package: self.import_path.package.clone(),
      file: self.import_path.file.clone(),
      fields: self.fields.clone(),
      oneofs: self.oneofs.clone().into_boxed_slice(),
      options: self.options.clone().into_boxed_slice(),
      messages: built_messages,
      enums,
      reserved_names: self.reserved_names.clone(),
      reserved_numbers: self.reserved_numbers.clone(),
      reserved_ranges: self.reserved_ranges.clone(),
    }
  }
}