add tests; clean up

Cargo.toml

@@ -1,9 +1,6 @@
 [package]
+authors = ["Phineas Walton <[email protected]>"]
 name = "domain-lookup-tree"
 version = "0.1.0"
 edition = "2018"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
-generational-arena = "0.2"
+readme="./README.md"

README.md

@@ -1,5 +1,7 @@
 # domain-lookup-tree
 
+## Overview
+
 DomainLookupTree is a data structure which provides efficient domain name lookup matching with support for wildcard entries.
 
 Requirements for this implementation:
@@ -17,9 +19,11 @@ If, when performing a lookup, the domain contains segments deeper than the wildc
 It's good to keep in mind that, when traversing the tree, domain names are sorted by top level to infinite n-level, or in simpler terms, in reverse. This means that if "google.com" is looked up in the tree, it would split by ".", reverse the vector, then first perform a root node lookup for "com", and so on.
 
 Walking down the tree - the story of a lookup:
-Let's say have a RuleTree with an entry ".giggl.app" which means that the tree looks like this:
+Let's say have a DomainLookupTree with an entry ".giggl.app" which means that the tree looks like this:
 
-app
+app 
 └── giggl [wildcard]
 
 A rule lookup for "canary.giggl.app" is requested. First, "app" is matched, but it's not a wildcard, so it's ignored. We now check the decendants of "app" for "giggl" - it matches, and it's a wildcard match, so we store it within the context of the lookup. This lookup will now 100% return a match, even if it isn't absolute. Anyway, we now check the decendants of "giggl" for "canary", though it doesn't exist, and the traversal ends. Now, we didn't have an absolute match, but we did have a wildcard match earlier on for ".giggl.app", so we successfully return the result ".giggl.app" from the lookup function.
+
+## Usage

src/lib.rs

@@ -72,21 +72,19 @@ impl Node {
 }
 
 impl DomainLookupTree {
- pub fn new(minimum_level: usize) -> DomainLookupTree {
+ pub fn new() -> DomainLookupTree {
  DomainLookupTree {
  nodes: Default::default(),
- minimum_level,
+ minimum_level: 0,
  }
  }
 
- // For inserting an item into the tree, we need to make sure that t
  pub fn insert(&mut self, domain: &str) {
  let is_wildcard = domain.starts_with(".");
  let segments = domain_to_rseg(domain);
  let n_segments = segments.len();
 
  let mut head = &mut self.nodes;
- // let mut fqdn = String::new();
  for (i, segment) in segments.iter().copied().enumerate() {
  let node = head
  .entry(segment.to_owned())

tests/tests.rs

@@ -0,0 +1,57 @@
+extern crate domain_lookup_tree;
+
+use domain_lookup_tree::DomainLookupTree;
+
+#[test]
+fn matches_wildcard_upper_level() {
+ let mut tree = DomainLookupTree::new();
+
+ tree.insert(".test.com");
+
+ assert_eq!(tree.lookup("123.test.com"), Some(".test.com".to_string()))
+}
+
+#[test]
+fn matches_wildcard_direct() {
+ let mut tree = DomainLookupTree::new();
+ tree.insert(".test.com");
+ assert_eq!(tree.lookup("test.com"), Some(".test.com".to_string()))
+}
+
+#[test]
+fn does_not_match_noninserted() {
+ let mut tree = DomainLookupTree::new();
+ tree.insert(".test.com");
+ assert_eq!(tree.lookup("google.com"), None)
+}
+
+#[test]
+fn matches_direct() {
+ let mut tree = DomainLookupTree::new();
+ tree.insert("test.com");
+ assert_eq!(tree.lookup("test.com"), Some("test.com".to_string()))
+}
+
+#[test]
+fn matches_wildcard_n_upper_level() {
+ let mut tree = DomainLookupTree::new();
+ tree.insert(".test.com");
+
+ assert_eq!(
+ tree.lookup("a.b.c.123.test.com"),
+ Some(".test.com".to_string())
+ )
+}
+
+#[test]
+fn matches_multiple_inserts_under_common_gtld() {
+ let mut tree = DomainLookupTree::new();
+ tree.insert(".test.com");
+ tree.insert("google.com");
+ tree.insert("abc.com");
+ tree.insert("phineas.io");
+
+ assert_eq!(tree.lookup("google.com"), Some("google.com".to_string()));
+ assert_eq!(tree.lookup("phineas.io"), Some("phineas.io".to_string()));
+ assert_eq!(tree.lookup("test.com"), Some(".test.com".to_string()))
+}