add Delete() function

Author: jftuga

example/example.go

@@ -95,4 +95,14 @@ func main() {
 	}
 	fmt.Println("ttlMap length:", t.Len())
 	fmt.Println()
+
+	fmt.Println()
+	fmt.Printf("Manually deleting '%v' key; should be successful\n", dontExpireKey)
+	success := t.Delete(ttlMap.CustomKeyType(dontExpireKey))
+	fmt.Printf("    successful? %v\n", success)
+	fmt.Printf("Manually deleting '%v' key again; should NOT be successful this time\n", dontExpireKey)
+	success = t.Delete(ttlMap.CustomKeyType(dontExpireKey))
+	fmt.Printf("    successful? %v\n", success)
+	fmt.Println("ttlMap length:", t.Len())
+	fmt.Println()
 }

ttlMap.go

@@ -30,7 +30,7 @@ import (
 	"time"
 )
 
-const version string = "1.0.0"
+const version string = "1.1.0"
 
 type CustomKeyType string
 
@@ -96,6 +96,18 @@ func (m *ttlMap) Get(k CustomKeyType) (v interface{}) {
 	return
 }
 
+func (m *ttlMap) Delete(k CustomKeyType) bool {
+	m.l.Lock()
+	_, ok := m.m[k]
+	if !ok {
+		m.l.Unlock()
+		return false
+	}
+	delete(m.m, k)
+	m.l.Unlock()
+	return true
+}
+
 func (m *ttlMap) All() map[CustomKeyType]*item {
 	return m.m
 }

ttlMap_test.go

@@ -100,3 +100,27 @@ func TestWithNoRefresh(t *testing.T) {
 		t.Errorf("t.Len should be 0, but actually equals %v\n", tm.Len())
 	}
 }
+
+func TestDelete(t *testing.T) {
+	maxTTL := 2                    // time in seconds
+	startSize := 3                 // initial number of items in map
+	pruneInterval := 4             // search for expired items every 'pruneInterval' seconds
+	refreshLastAccessOnGet := true // update item's lastAccessTime on a .Get()
+	tm := New(maxTTL, startSize, pruneInterval, refreshLastAccessOnGet)
+
+	// populate the ttlMap
+	tm.Put("myString", "a b c")
+	tm.Put("int_array", []int{1, 2, 3})
+
+	tm.Delete("int_array")
+	t.Logf("tm.len: %v\n", tm.Len())
+	if tm.Len() != 1 {
+		t.Fatalf("t.Len should equal 1, but actually equals %v\n", tm.Len())
+	}
+
+	tm.Delete("myString")
+	t.Logf("tm.len: %v\n", tm.Len())
+	if tm.Len() != 0 {
+		t.Fatalf("t.Len should equal 0, but actually equals %v\n", tm.Len())
+	}
+}