arc-isle 0.1.2

The Interface Specification Language for the Arc project: design and implementation
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
// mod

use crate::parser::utils::ReadError;
use std::{
    collections::HashMap,
    error::Error,
    fmt::{Debug, Display, Formatter},
};

pub struct Schema {
    pub hosts: Hosts,
    pub versioning: Versioning,
    pub types: TypeDeclResults,
    pub interfaces: InterfaceDeclResults,
}

impl Display for Schema {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let mut result = "Schema {\n".to_string();
        result.push_str(&format!("  hosts = {:?}\n", self.hosts));
        result.push_str(&format!("  versioning = {:?}\n", self.versioning));
        result.push_str(&format!(
            "  types = {}\n",
            self.types
                .iter()
                .map(|t| {
                    match t {
                        Ok(val) => format!("{}\n", val),
                        Err(err) => format!("{}\n", err),
                    }
                })
                .collect::<String>()
        ));
        result.push_str(&format!(
            "  interfaces = {}\n",
            self.interfaces
                .iter()
                .map(|t| {
                    match t {
                        Ok(val) => format!("{}\n", val),
                        Err(err) => format!("{}\n", err),
                    }
                })
                .collect::<String>()
        ));
        f.write_str(&result)
    }
}

#[derive(Debug)]
pub struct Host {
    pub env: String,
    pub address: String,
}

pub type Hosts = Vec<Host>;

#[derive(Debug)]
pub enum VersioningFormat {
    Headers,
}

#[derive(Debug)]
pub struct Versioning {
    pub format: VersioningFormat,
    pub header: Option<String>,
}

pub type TypeDeclResults = Vec<Result<TypeDecl, TypeDeclError>>;

#[derive(PartialEq, Clone, Debug)]
pub struct TypeDecl {
    pub name: String,
    pub property_decls: Vec<PropertyDecl>,
}

impl Display for TypeDecl {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let mut result = format!("type `{}` {{ ", self.name);
        for property_decl in &self.property_decls {
            match &property_decl.data_type_decl {
                Ok(data_type_decl) => {
                    result.push_str(&format!("{}: {}; ", property_decl.name, data_type_decl));
                }
                Err(err) => {
                    result.push_str(&format!("{}: {}; ", property_decl.name, err));
                }
            }
        }
        result.push_str(" }");
        f.write_str(&result)
    }
}

#[derive(Debug, PartialEq, Clone)]
pub struct PropertyDecl {
    pub name: String,
    pub data_type_decl: Result<DataTypeDecl, TypeDeclError>,
}

#[derive(Debug, PartialEq, Clone)]
pub enum TypeDeclError {
    ImportFailure(ImportError),
    UnsupportedTypeDeclaration,
    UnsupportedKeyType,
    EmptyTypeDeclaration,
    SubtypeValuesEmptyDeclaration,
    UnsupportedPrimitive(String),
}

impl TypeDeclError {
    fn default_fmt(&self, f: &mut Formatter) -> std::fmt::Result {
        match self {
            TypeDeclError::ImportFailure(import_error) => {
                write!(f, "Import failed: {}", import_error.to_string())
            }
            TypeDeclError::UnsupportedTypeDeclaration => {
                write!(f, "This type declaration format is not supported.")
            }
            TypeDeclError::UnsupportedKeyType => write!(f, "Key type must be string."),
            TypeDeclError::EmptyTypeDeclaration => write!(f, "Type declaration cannot be empty."),
            TypeDeclError::SubtypeValuesEmptyDeclaration => {
                write!(f, "Subtype declaration cannot be empty.")
            }
            TypeDeclError::UnsupportedPrimitive(value) => {
                write!(f, "Primitive {} not supported.", value)
            }
        }
    }
}

impl Error for TypeDeclError {}

impl Display for TypeDeclError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        self.default_fmt(f)
    }
}

#[derive(PartialEq, Clone, Debug)]
pub struct DataTypeDecl {
    pub data_type: DataType,
    pub is_required: bool,
}

impl Display for DataTypeDecl {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let mut result = format!("{}", self.data_type);
        if !self.is_required {
            result.push_str("?");
        }
        f.write_str(&result)
    }
}

#[derive(PartialEq, Clone, Debug)]
pub enum DataType {
    Primitive(Primitive),
    Array(Box<DataType>),
    Dict(Primitive, Box<DataType>),
    Object(String),
    ObjectDecl(TypeDecl),
}

impl Display for DataType {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            DataType::Primitive(primitive) => f.write_str(&format!("{}", primitive)),
            DataType::Array(data_type) => f.write_str(&format!("array[{}]", data_type)),
            DataType::Dict(key, value) => f.write_str(&format!("dict{{ {}: {} }}", key, value)),
            DataType::Object(ident) => f.write_str(&format!("{}", ident)),
            DataType::ObjectDecl(type_decl) => f.write_str(&format!("{}", type_decl)),
        }
    }
}

#[derive(Debug, PartialEq, Clone)]
pub enum Primitive {
    Int,
    Double,
    Bool,
    Str,
}

impl Display for Primitive {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Primitive::Int => f.write_str("int"),
            Primitive::Double => f.write_str("double"),
            Primitive::Bool => f.write_str("bool"),
            Primitive::Str => f.write_str("str"),
        }
    }
}

#[derive(Clone)]
pub enum ImportError {
    IOError(ReadError),
    InvalidInputSource,
    InvalidImportValue,
}

impl PartialEq for ImportError {
    fn eq(&self, other: &Self) -> bool {
        match (self, other) {
            (ImportError::IOError(lhs), ImportError::IOError(rhs)) => lhs == rhs,
            (ImportError::InvalidInputSource, ImportError::InvalidInputSource) => true,
            (ImportError::InvalidImportValue, ImportError::InvalidImportValue) => true,
            _ => false,
        }
    }
}

// MARK - Interface

pub type InterfaceDeclResults = Vec<Result<InterfaceDecl, InterfaceDeclError>>;

#[derive(PartialEq, Debug)]
pub struct InterfaceDecl {
    pub ident: String,
    pub params: Vec<String>,
    pub spec: InterfaceSpec,
}

impl Display for InterfaceDecl {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let InterfaceSpec::Api(api) = &self.spec;
        let mut result = format!("{:?} /{}\n", api.method, self.ident);
        if let Some(payload) = &api.payload {
            match payload {
                HttpPayload::Body(body) => {
                    result.push_str(&format!("Body: {:?}\n", body));
                }
                HttpPayload::Query(query) => {
                    result.push_str(&format!("Query: {:?}\n", query));
                }
            }
        }
        if let Some(responses) = &api.responses {
            result.push_str(&format!(
                "Responses: {}",
                responses
                    .iter()
                    .map(|(k, v)| { format!("{}: {}\n", k, v) })
                    .collect::<String>()
            ));
        }
        f.write_str(&result)
    }
}

#[derive(PartialEq)]
pub enum InterfaceSpec {
    Api(ApiSpec),
}

impl Debug for InterfaceSpec {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            InterfaceSpec::Api(api_spec) => f.write_str(&format!("{}", api_spec)),
        }
    }
}

#[derive(PartialEq, Debug)]
pub struct ApiSpec {
    pub method: HttpMethod,
    pub payload: Option<HttpPayload>,
    pub responses: HttpResponses,
}

impl Display for ApiSpec {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let mut result = format!("method: {}\n", self.method);
        if let Some(payload) = &self.payload {
            result.push_str(&format!("\t{}\n", payload));
        }
        if let Some(responses) = &self.responses {
            result.push_str(&format!("\t{:?}", responses));
        }
        f.write_str(&result)
    }
}

pub type HttpResponses = Option<HashMap<StatusCode, TypeDecl>>;

#[derive(Eq, Hash, PartialEq, Clone, Debug)]
pub enum StatusCode {
    Fixed(u16),
    Prefix(u16),
}

impl StatusCode {
    pub fn as_key(&self) -> String {
        match self {
            StatusCode::Fixed(val) => val.to_string(),
            StatusCode::Prefix(val) => val.to_string() + "xx",
        }
    }
}

impl Display for StatusCode {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            StatusCode::Fixed(val) => f.write_str(&val.to_string()),
            StatusCode::Prefix(val) => f.write_str(&(val.to_string() + "xx")),
        }
    }
}

#[derive(Debug, PartialEq)]
pub enum HttpMethod {
    Get,
    Post,
    Put,
    Delete,
    Patch,
    Head,
}

impl Display for HttpMethod {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            HttpMethod::Get => f.write_str("GET"),
            HttpMethod::Post => f.write_str("POST"),
            HttpMethod::Put => f.write_str("PUT"),
            HttpMethod::Delete => f.write_str("DELETE"),
            HttpMethod::Patch => f.write_str("PATCH"),
            HttpMethod::Head => f.write_str("HEAD"),
        }
    }
}

#[derive(Debug, PartialEq)]
pub enum HttpPayload {
    Query(Vec<PropertyDecl>),
    Body(Vec<PropertyDecl>),
}

impl Display for HttpPayload {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            HttpPayload::Query(query) => {
                let mut result = "Query: {\n".to_string();
                for property_decl in query {
                    result.push_str(&format!(
                        "    {}: {:?}\n",
                        property_decl.name, property_decl.data_type_decl
                    ));
                }
                result.push_str("}\n");
                f.write_str(&result)
            }
            HttpPayload::Body(body) => {
                let mut result = "Body: {\n".to_string();
                for property_decl in body {
                    result.push_str(&format!(
                        "    {}: {:?}\n",
                        property_decl.name, property_decl.data_type_decl
                    ));
                }
                result.push_str("}\n");
                f.write_str(&result)
            }
        }
    }
}

#[derive(Debug, PartialEq)]
pub enum InterfaceDeclError {
    ImportFailure(ImportError),
    BodyNotAllowed,
    QueryNotAllowed,
    InvalidKey,
    InvalidStatusCode,
    TypeNotFound(String),
    InvalidResponseDeclaration,
    InvalidInterfaceDeclaration,
    InvalidIdent,
    EmptyParam,
    InvalidMethod,
    InvalidQuery,
    InvalidBody,
    InvalidResponseTypeDeclaration,
}

impl Error for InterfaceDeclError {}

impl Display for InterfaceDeclError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            _ => f.write_str("InterfaceDeclError"),
        }
    }
}

pub type TypeUsageMeta = Option<Vec<UnknownType>>;

#[derive(Debug, PartialEq, Clone)]
pub enum UnknownType {
    InTypeDeclaration(usize, usize),
    InPayload(usize, usize),
    InResponse(usize, StatusCode, usize)
}