krustie 0.3.0

Krustie is a simple and easy-to-use backend framework.
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
use crate::{
    server::route_handler::{HandlerResult, RouteHandler},
    HttpMethod, Middleware, Request, Response, StatusCode,
};
use endpoint::Endpoint;
use regex::Regex;
use std::{collections::HashMap, fmt::Display, iter::Peekable, slice::Iter};

pub mod endpoint;
pub mod methods;

pub(crate) type Controller = fn(&Request, &mut Response);
type RouterResult<'a> = Option<(&'a mut Endpoint, HashMap<String, String>)>;

// TODO: Look at Radix Tree

#[doc = include_str!("../docs/core/router.md")]
#[derive(Debug)]
pub struct Router {
    endpoints: Vec<Endpoint>,
    middlewares: Vec<Box<dyn Middleware>>,
    subdirs: HashMap<String, Box<Router>>,
    param_dir: Option<(String, Box<Router>)>,
}

impl Router {
    /// Creates a new router
    ///
    /// # Example
    ///
    /// To create a `GET` method for `/`
    ///
    /// ```rust
    /// use krustie::{ Router, StatusCode, Server };
    ///
    /// let mut server = Server::create();
    /// let mut main_router = Router::new();
    ///
    /// main_router.get("/", |req, res| {
    ///   res.status(StatusCode::Ok);
    /// });
    ///
    /// server.use_handler(main_router);
    /// ```
    pub fn new() -> Self {
        Self {
            endpoints: Vec::new(),
            middlewares: Vec::new(),
            subdirs: HashMap::new(),
            param_dir: None,
        }
    }

    /// Adds a subrouter to a router. It is useful for creating subdirectories.
    ///
    /// # Example
    ///
    /// Create a 'POST' method for `/user/comments`
    ///
    /// ```rust
    /// use krustie::{ Server, Router, StatusCode };
    ///
    /// let mut server = Server::create();
    ///
    /// let mut main_router = Router::new();
    /// let mut user_router = Router::new();
    /// let mut comments_router = Router::new();
    ///
    /// comments_router.post("/", |req, res| {
    ///   res.status(StatusCode::Ok);
    /// });
    ///
    /// user_router.use_router("/comments", comments_router);
    /// main_router.use_router("/user", user_router);
    ///
    /// server.use_handler(main_router);
    /// ```
    pub fn use_router(&mut self, path: &str, router: Router) {
        let path = path.trim();

        if path == "/" || path.is_empty() {
            panic!("Route already exist.");
        }

        let path_types = Self::get_path_types(path);
        let mut types_iter = path_types.into_iter().peekable();

        Self::add_router(self, router, &mut types_iter);
    }

    /// Adds an endpoint to a router.
    ///
    /// # Example
    ///
    /// Create a 'GET' method for `/user`
    ///
    /// ```rust
    /// use krustie::{ Server, Router, StatusCode, Request, Response, HttpMethod, Endpoint };
    ///
    /// let mut server = Server::create();
    /// let mut main_router = Router::new();
    ///
    /// let endpoint = Endpoint::new(HttpMethod::GET, get);
    ///
    /// main_router.use_endpoint("/user", endpoint);
    ///
    /// server.use_handler(main_router);
    ///
    /// fn get(req: &Request, res: &mut Response) {
    ///   res.status(StatusCode::Ok);
    /// }
    ///
    /// ```
    pub fn use_endpoint(&mut self, path: &str, endpoint: Endpoint) {
        let path = path.trim();

        if path == "/" || path.is_empty() {
            self.endpoints.push(endpoint);
        } else {
            let path_types = Self::get_path_types(path);
            let mut types_iter = path_types.into_iter().peekable();

            Self::add_endpoint(self, endpoint, &mut types_iter)
        }
    }

    fn add_router<'a>(
        router: &'a mut Router,
        new_router: Router,
        iter: &mut Peekable<std::vec::IntoIter<PathType>>,
    ) {
        match iter.next() {
            Some(PathType::Subdirectory(path)) => {
                match router.subdirs.get_mut(&path) {
                    Some(found_router) => {
                        // Router Found
                        Self::add_router(found_router, new_router, iter);
                    }
                    _ => {
                        if iter.peek().is_some() {
                            // No Router & Iteration Continues
                            let mut inserted_router = Box::new(Router::new());
                            Self::add_router(inserted_router.as_mut(), new_router, iter);
                            router.subdirs.insert(path, inserted_router);
                        } else {
                            // No Router & Iteration Ends
                            router.subdirs.insert(path, Box::new(new_router));
                        }
                    }
                }
            }
            Some(PathType::Parameter(param)) => {
                match &mut router.param_dir {
                    Some(found_router) => {
                        // Router Found
                        Self::add_router(found_router.1.as_mut(), new_router, iter);
                    }
                    _ => {
                        if iter.peek().is_some() {
                            // No Router & Iteration Continues
                            let mut inserted_router = Box::new(Router::new());
                            Self::add_router(inserted_router.as_mut(), new_router, iter);
                            router.param_dir = Some((param, Box::new(Router::new())));
                        } else {
                            // No Router & Iteration Ends
                            router.param_dir = Some((param, Box::new(new_router)));
                        }
                    }
                }
            }
            None => {
                panic!("Route already exist. (Merging routers is not allowed for now.)");
            }
        }
    }

    fn add_endpoint<'a>(
        router: &'a mut Router,
        endpoint: Endpoint,
        iter: &mut Peekable<std::vec::IntoIter<PathType>>,
    ) {
        match iter.next() {
            Some(PathType::Subdirectory(path)) => {
                if iter.peek().is_some() {
                    // Iteration Will Continue
                    match router.subdirs.get_mut(&path) {
                        Some(found_router) => {
                            // Router Found
                            Self::add_endpoint(found_router, endpoint, iter);
                        }
                        _ => {
                            // No Router
                            let mut inserted_router = Box::new(Router::new());
                            Self::add_endpoint(inserted_router.as_mut(), endpoint, iter);
                            router.subdirs.insert(path, inserted_router);
                        }
                    }
                } else {
                    // Iteration Will End
                    match router.subdirs.get_mut(&path) {
                        Some(found_router) => {
                            // Router Found
                            found_router.endpoints.push(endpoint);
                        }
                        _ => {
                            // No Router
                            let mut inserted_router = Box::new(Router::new());
                            inserted_router.endpoints.push(endpoint);
                            router.subdirs.insert(path, inserted_router);
                        }
                    }
                }
            }
            Some(PathType::Parameter(param)) => {
                if iter.peek().is_some() {
                    // Iteration Will Continue
                    match &mut router.param_dir {
                        Some(found_router) => {
                            // Router Found
                            Self::add_endpoint(found_router.1.as_mut(), endpoint, iter);
                        }
                        _ => {
                            // No Router
                            let mut inserted_router = Box::new(Router::new());
                            Self::add_endpoint(inserted_router.as_mut(), endpoint, iter);
                            router.param_dir = Some((param, inserted_router));
                        }
                    }
                } else {
                    // Iteration Will End
                    match &mut router.param_dir {
                        Some(found_router) => {
                            // Router Found
                            found_router.1.endpoints.push(endpoint);
                        }
                        _ => {
                            // No Router
                            let mut inserted_router = Box::new(Router::new());
                            inserted_router.endpoints.push(endpoint);
                            router.param_dir = Some((param, inserted_router));
                        }
                    }
                }
            }
            None => {
                panic!("Error: Route already exist.")
            }
        }
    }

    fn route_handler<'a>(
        &'a mut self,
        path_array: &Vec<String>,
        method: &HttpMethod,
    ) -> RouterResult<'a> {
        let params: HashMap<String, String> = HashMap::new();
        let iter: Iter<'_, String> = path_array.iter();

        Self::handle_routes(self, method, params, iter)
    }

    fn handle_routes<'a, 'b>(
        router: &'a mut Router,
        method: &HttpMethod,
        mut params: HashMap<String, String>,
        mut iter: Iter<'_, String>,
    ) -> RouterResult<'a> {
        if let Some(route) = iter.next() {
            let route = route
                .split('?')
                .collect::<Vec<&str>>()
                .first()
                .unwrap()
                .to_string();

            if route.is_empty() {
                return Self::handle_routes(router, method, params, iter);
            }
            // Iteration Continues
            match router.subdirs.get_mut(route.as_str()) {
                Some(founded_router) => {
                    // Router Found
                    Self::handle_routes(founded_router.as_mut(), method, params, iter)
                }
                _ => {
                    match router.param_dir.as_mut() {
                        Some((param_name, founded_router)) => {
                            // Parameter Found
                            params.insert(param_name.clone(), route);
                            Self::handle_routes(founded_router, method, params, iter)
                        }
                        _ => None,
                    }
                }
            }
        } else {
            // Iteration Ends
            match router
                .endpoints
                .iter_mut()
                .find(|endpoint| endpoint.is_method(method))
            {
                Some(endpoint) => Some((endpoint, params)),
                None => None,
            }
        }
    }

    fn get_path_types(path: &str) -> Vec<PathType> {
        path.split('/')
            .into_iter()
            .filter(|path| !path.is_empty())
            .map(|path| match PathType::try_from(path) {
                Ok(path_type) => path_type,
                Err(err) => panic!("Error while adding router: {}", err),
            })
            .collect::<Vec<PathType>>()
    }
}

impl RouteHandler for Router {
    fn handle(&mut self, request: &Request, response: &mut Response) -> HandlerResult {
        while let Some(middleware) = self.middlewares.iter_mut().next() {
            match middleware.middleware(request, response) {
                HandlerResult::End => {
                    return HandlerResult::End;
                }
                HandlerResult::Next => (),
            }
        }

        match self.route_handler(request.get_path_array(), request.get_method()) {
            Some((endpoint, params)) => {
                while let Some(middleware) = endpoint.get_middlewares().iter_mut().next() {
                    match middleware.middleware(request, response) {
                        HandlerResult::End => {
                            return HandlerResult::End;
                        }
                        HandlerResult::Next => (),
                    }
                }

                let mut request = request.clone();
                request.add_param(params);

                endpoint.get_controller()(&request, response);
                return HandlerResult::Next;
            }
            None => {
                response.status(StatusCode::NotFound);
                return HandlerResult::Next;
            }
        }
    }
}

impl Clone for Router {
    fn clone(&self) -> Self {
        let endpoints: Vec<Endpoint> = self.endpoints.clone();
        let middlewares: Vec<Box<dyn Middleware>> = self.middlewares.clone();
        let subdirs: HashMap<String, Box<Router>> = self.subdirs.clone();
        let param_dir: Option<(String, Box<Router>)> = match &self.param_dir {
            Some((key, router)) => Some((key.clone(), router.clone())),
            None => None,
        };

        Self {
            endpoints,
            middlewares,
            subdirs,
            param_dir,
        }
    }
}

#[derive(Eq, Hash, PartialEq, Debug)]
enum PathType {
    Subdirectory(String),
    Parameter(String),
}

impl TryFrom<&str> for PathType {
    type Error = ParsePathTypeError;
    fn try_from(value: &str) -> Result<Self, Self::Error> {
        if value.starts_with(':') {
            return Ok(Self::Parameter(value.chars().skip(1).collect::<String>()));
        } else {
            let regex = Regex::new(r"^[a-zA-Z0-9_\-.]+$").unwrap();

            if regex.is_match(value) {
                return Ok(Self::Subdirectory(value.to_string()));
            } else {
                return Err(ParsePathTypeError(value.to_string()));
            }
        }
    }
}

/// Error for parsing path types while adding a router.
#[derive(Debug, Clone)]
pub struct ParsePathTypeError(String);

impl Display for ParsePathTypeError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "Invalid path value for router: {}", self.0)
    }
}