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
//! Bravery router
//!
//! A radix tree implementation in rust without unsafe code
//!
//! ```
//! use bravery_router::{create_root_node, add, optimize, find};
//!
//! let mut root = create_root_node();
//! add(&mut root, "/foo", 1);
//! add(&mut root, "/users/:userId", 2);
//! add(&mut root, "/*", 3);
//!
//! let root = optimize(root);
//!
//! let ret = find(&root, "/foo");
//! assert_eq!(ret.value, Some(&1));
//!
//! let ret = find(&root, "/users/42");
//! assert_eq!(ret.value, Some(&2));
//! assert_eq!(ret.params, vec!["42"]);
//!
//! let ret = find(&root, "/bar");
//! assert_eq!(ret.value, Some(&3));
//! assert_eq!(ret.params, vec!["bar"]);
//! ```
extern crate regex;

#[macro_use]
extern crate log;

#[macro_use]
extern crate lazy_static;

mod add;
mod find;
mod node;
mod optimize;

use crate::node::NodeType;

pub use crate::add::add;

pub use crate::find::{find, FindResult};
pub use crate::node::Node;

pub use crate::optimize::optimize;

/// Create the root node from which all begins.
///
/// # Examples
///
/// ```
/// use bravery_router::{create_root_node};
/// let mut node = create_root_node::<usize>();
/// ```
pub fn create_root_node<T>() -> Node<T> {
    Node {
        node_type: NodeType::Static(vec![b'/']),
        value: None,
        static_children: vec![],
        regex_children: vec![],
        wildcard_children: vec![],
    }
}

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

    impl std::fmt::Debug for NodeType {
        fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
            match self {
                NodeType::Static(p) => write!(f, "NodeType::Static {:?}", p),
                NodeType::Regex(r) => write!(f, "NodeType::Regex {:?}", r),
                NodeType::Wildcard() => write!(f, "NodeType::Wildcard"),
            }
        }
    }

    impl<'node> std::fmt::Debug for Node<u8> {
        fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
            write!(
                f,
                "Node {{\n  t: {:?}\n  v: {:?}\n  s: {:?}\n  r: {:?}\n  w: {:?}\n  }}",
                self.node_type,
                self.value,
                self.static_children,
                self.regex_children,
                self.wildcard_children
            )
        }
    }

    impl<'node> std::fmt::Debug for Node<String> {
        fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
            write!(
                f,
                "Node {{\n  t: {:?}\n  v: {:?}\n  s: {:?}\n  r: {:?}\n  w: {:?}\n  }}",
                self.node_type,
                self.value,
                self.static_children,
                self.regex_children,
                self.wildcard_children
            )
        }
    }

    impl<'req> std::cmp::PartialEq for FindResult<'req, u8> {
        fn eq(&self, other: &Self) -> bool {
            self.params == other.params && self.value == other.value
        }
    }

    #[test]
    fn all() {
        let mut root = create_root_node();

        add(&mut root, "/foo", 1);
        add(&mut root, "/bar", 2);
        add(&mut root, "/foobar", 3);
        add(&mut root, "/:name/b", 4);
        add(&mut root, "/aa/bb/cc/dd/*", 5);

        let optimized = optimize(root);

        let result: FindResult<u8> = find(&optimized, "/foo");
        assert_eq!(&1, result.value.unwrap());

        let result: FindResult<u8> = find(&optimized, "/bar");
        assert_eq!(&2, result.value.unwrap());

        let result: FindResult<u8> = find(&optimized, "/foobar");
        assert_eq!(&3, result.value.unwrap());

        let result: FindResult<u8> = find(&optimized, "/tom/b");
        assert_eq!(&4, result.value.unwrap());

        let result: FindResult<u8> = find(&optimized, "/aa/bb/cc/dd/ee");
        assert_eq!(&5, result.value.unwrap());

        let result: FindResult<u8> = find(&optimized, "/not-found");
        assert_eq!(true, result.value.is_none());
    }

    #[test]
    fn bench_regex() {
        let mut root = create_root_node();
        add(
            &mut root,
            "/posts/:post_id/comments/:id",
            "comments".to_owned(),
        );
        add(&mut root, "/posts/:post_id/comments", "comments".to_owned());

        let optimized = optimize(root);

        find(&optimized, "/posts/12/comments").value.unwrap();
    }

    pub trait Handler<T: Clone> {
        fn invoke(&self) -> Result<u8, u8>;
    }

    #[derive(Clone)]
    struct HandlerFor404 {}

    impl<'node> std::fmt::Debug for Node<HandlerFor404> {
        fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
            write!(f, "Node {{ HandlerFor404 }}")
        }
    }

    impl PartialEq<HandlerFor404> for HandlerFor404 {
        fn eq(&self, _other: &HandlerFor404) -> bool {
            true
        }
    }

    #[test]
    fn with_struct() {
        let handler = HandlerFor404 {};
        let mut root = create_root_node();
        add(&mut root, "/posts/:post_id/comments/:id", handler);

        let optimized = optimize(root);

        assert_eq!(true, find(&optimized, "/posts/12/comments").value.is_none());
        assert_eq!(
            true,
            find(&optimized, "/posts/12/comments/foo").value.is_some()
        );
    }
}