fix: remove redundant test TestRemove (#8)

This test offers the same functionality as `TestAddItem`.

Reviewed-on: #8
Co-authored-by: M.V. Hutz <git@maximhutz.me>
Co-committed-by: M.V. Hutz <git@maximhutz.me>

.claude/settings.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(curl -s -w \"\\\\n---HTTP_STATUS:%{http_code}---\" https://raw.githubusercontent.com/kubernetes/kubernetes/master/.markdownlint.yaml)"
+    ]
+  }
+}

.gitea/workflows/ci.yml

@@ -39,6 +39,14 @@ jobs:
       - name: Run mutation tests
         run: make lint-makefile
 
+  lint-markdown:
+    name: Markdown Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: DavidAnson/markdownlint-cli2-action@v19
+
   test-unit:
     name: Unit Tests
     runs-on: ubuntu-latest

.gremlins.yaml

@@ -4,4 +4,6 @@ unleash:
   timeout-coefficient: 50
   
   workers: 4
-  dry-run: false
+  dry-run: false
+  threshold:
+    efficacy: 1.0

.markdownlint.yml

@@ -0,0 +1,17 @@
+default: true
+heading-style:
+  style: atx
+ul-indent:
+  indent: 2
+line-length: false
+no-duplicate-heading:
+  siblings_only: true
+no-inline-html:
+  allowed_elements:
+    - br
+    - details
+    - summary
+    - img
+    - picture
+    - source
+first-line-heading: true

Makefile

@@ -1,4 +1,4 @@
-.PHONY: all help install clean test-unit test-mutation test-fuzz test docs lint-go lint-makefile lint
+.PHONY: all help install clean test-unit test-mutation test-fuzz test docs lint-go lint-makefile lint-markdown lint
 
 help: ## Show this help
 	@grep -E '^[a-zA-Z_-]+:.*##' $(MAKEFILE_LIST) | awk -F ':.*## ' '{printf "  %-15s %s\n", $$1, $$2}'
@@ -32,7 +32,10 @@ lint-go: ## Lint Go code
 lint-makefile: ## Lint the Makefile
 	checkmake Makefile
 
-lint: lint-go lint-makefile ## Lint all code
+lint-markdown: ## Lint Markdown files
+	docker run --rm -v $(CURDIR):/workdir davidanson/markdownlint-cli2 "**/*.md"
+
+lint: lint-go lint-makefile lint-markdown ## Lint all code
 
 docs: ## Serve godoc locally
 	@echo ">>> Visit: http://localhost:6060/pkg/$$(go list -m)"

README.md

@@ -1,3 +1,3 @@
-# go-cuckoo
+# <img height="30" src="assets/logo.svg" alt="Go Cuckoo, by `mvhutz`."> Go Cuckoo
 
-A hash table that uses cuckoo hashing to achieve a worst-case O(1) lookup time.
+A hash table that uses cuckoo hashing to achieve a worst-case O(1) lookup time. Read more about it in [the package documentation](https://pkg.go.dev/git.maximhutz.com/tools/go-cuckoo).

assets/logo.svg

@@ -0,0 +1 @@
+<svg width="16" height="16" xmlns="http://www.w3.org/2000/svg" shape-rendering="crispEdges"><path fill="#2a1512" d="M3,6h1v1h-1v-1M2,7h1v1h-1v-1M12,7h1v1h-1v-1M1,8h1v1h-1v-1M4,8h1v2h-1v-2M14,8h1v1h-1v-1M11,9h1v2h-2v-1h1v-1M5,10h1v1h-1v-1M1,13h2v1h1v1h-2v-1h-1v-1M13,13h2v1h-1v1h-1v1h-1v-2h1v-1M4,15h1v1h-1v-1"/><path fill="#38231f" d="M4,6h1v1h-1v-1M11,6h1v1h-1v-1M13,7h1v1h-1v-1M1,9h1v2h-1v-2M14,9h1v1h-1v-1M14,11h1v2h-1v-2M1,12h1v1h-1v-1M5,15h3v1h-3v-1M10,15h2v1h-2v-1"/><path fill="#3f3f74" d="M7,3h2v1h-2v-1M6,4h1v1h-1v-1M9,4h1v1h-1v-1M5,5h1v5h-1v-5M10,5h1v5h-1v-5M6,10h4v1h-4v-1"/><path fill="#6262ab" d="M9,5h1v1h-1v-1M6,9h1v1h-1v-1M9,9h1v1h-1v-1"/><path fill="#663931" d="M11,8h1v1h-1v-1M2,9h1v1h-1v-1M14,10h1v1h-1v-1M1,11h1v1h-1v-1M3,11h2v1h-2v-1M13,11h1v1h-1v-1M2,12h1v1h-1v-1M5,12h1v1h-1v-1M10,12h3v2h-1v-1h-2v-1M3,13h1v1h-1v-1M8,13h2v1h-2v-1M4,14h3v1h-3v-1M10,14h2v1h-2v-1M8,15h2v1h-2v-1"/><path fill="#8d8dcb" d="M9,6h1v3h-1v1h-2v-1h1v-1h1v-2M6,8h1v1h-1v-1"/><path fill="#8f563b" d="M2,8h1v1h-1v-1M12,9h1v1h-1v-1M2,10h1v1h-1v-1M13,10h1v1h-1v-1M7,11h1v1h-1v-1M11,11h2v1h-2v-1M4,12h1v1h1v-1h1v2h-3v-2M13,12h1v1h-1v-1M10,13h2v1h-2v-1M7,14h3v1h-3v-1"/><path fill="#a4a4d5" d="M8,4h1v4h-1v1h-1v-1h-1v-2h1v-1h1v-1"/><path fill="#ab764a" d="M4,7h1v1h-1v-1M3,8h1v2h-1v-2M12,10h1v1h-1v-1M2,11h1v1h-1v-1M8,11h1v1h-1v-1M3,12h1v1h-1v-1M7,12h1v2h-1v-2"/><path fill="#cacaea" d="M7,4h1v1h-1v-1M6,5h1v1h-1v-1"/><path fill="#d9a066" d="M3,7h1v1h-1v-1M11,7h1v1h-1v-1M12,8h2v2h-1v-1h-1v-1M3,10h2v1h-2v-1M5,11h2v1h-2v-1M9,11h2v1h-1v1h-2v-1h1v-1"/></svg>

bucket.go

@@ -17,6 +17,8 @@ type bucket[K, V any] struct {
 	compare        EqualFunc[K]
 }
 
+// location determines where in the bucket a certain key would be placed. If the
+// capacity is 0, this will panic.
 func (b bucket[K, V]) location(key K) uint64 {
 	return b.hash(key) % b.capacity
 }

cuckoo_test.go

@@ -1,6 +1,7 @@
 package cuckoo_test
 
 import (
+	"errors"
 	"maps"
 	"math/rand/v2"
 	"testing"
@@ -117,18 +118,6 @@ func TestGetMany(t *testing.T) {
 	}
 }
 
-func TestRemove(t *testing.T) {
-	assert := assert.New(t)
-	table := cuckoo.NewTable[int, bool]()
-
-	assert.False(table.Has(0))
-
-	err := table.Put(0, true)
-	assert.NoError(err)
-
-	assert.True(table.Has(0))
-}
-
 func TestDropExistingItem(t *testing.T) {
 	assert := assert.New(t)
 	key, value := 0, true
@@ -153,3 +142,88 @@ func TestDropNoItem(t *testing.T) {
 	assert.Equal(0, table.Size())
 	assert.False(table.Has(key))
 }
+
+func TestDropItemCapacity(t *testing.T) {
+	assert := assert.New(t)
+	key := 0
+	table := cuckoo.NewTable[int, bool](
+		cuckoo.Capacity(64),
+		cuckoo.GrowthFactor(2),
+	)
+
+	startingCapacity := table.TotalCapacity()
+	err := table.Drop(key)
+	endingCapacity := table.TotalCapacity()
+
+	assert.NoError(err)
+	assert.Equal(0, table.Size())
+	assert.Equal(uint64(128), startingCapacity)
+	assert.Equal(uint64(64), endingCapacity)
+}
+
+func TestPutNoCapacity(t *testing.T) {
+	assert := assert.New(t)
+	key, value := 0, true
+	table := cuckoo.NewTable[int, bool](
+		cuckoo.Capacity(0),
+	)
+
+	err := table.Put(key, value)
+
+	assert.NoError(err)
+	assert.Equal(1, table.Size())
+	assert.True(table.Has(key))
+}
+
+func TestBadHashCapacity(t *testing.T) {
+	assert := assert.New(t)
+	table := cuckoo.NewCustomTable[int, bool](
+		func(int) uint64 { return 0 },
+		func(int) uint64 { return 0 },
+		func(a, b int) bool { return a == b },
+		cuckoo.Capacity(20),
+	)
+
+	err1 := table.Put(0, true)
+	err2 := table.Put(1, true)
+	err3 := table.Put(2, true)
+
+	assert.NoError(err1)
+	assert.NoError(err2)
+	assert.Error(err3)
+
+	assert.Equal(uint64(80), table.TotalCapacity())
+}
+
+func TestDropResizeCapacity(t *testing.T) {
+	assert := assert.New(t)
+	table := cuckoo.NewTable[int, bool](
+		cuckoo.Capacity(10),
+	)
+
+	err1 := table.Put(0, true)
+	err2 := table.Put(1, true)
+	err3 := table.Drop(1)
+
+	assert.NoError(errors.Join(err1, err2, err3))
+	assert.Equal(uint64(20), table.TotalCapacity())
+}
+
+func TestNewTableBy(t *testing.T) {
+	type User struct {
+		_    func()
+		id   string
+		name string
+	}
+
+	assert := assert.New(t)
+	table := cuckoo.NewTableBy[User, bool](
+		func(u User) string { return u.id },
+	)
+
+	err := table.Put(User{nil, "1", "Robert"}, true)
+
+	assert.NoError(err)
+	assert.Equal(1, table.Size())
+	assert.True(table.Has(User{nil, "1", "Robbie"}))
+}

go.mod

@@ -4,6 +4,8 @@ go 1.25.6
 
 require github.com/stretchr/testify v1.11.1
 
+require github.com/kr/pretty v0.3.1 // indirect
+
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect

go.sum

@@ -1,12 +1,21 @@
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
+github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
 github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
 github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
 github.com/trailofbits/go-fuzz-utils v0.0.0-20260318143407-0907cafe7589 h1:UmBZCTPdDYore2IEHN+U4eIqEaRq6METh9pKiPumkqc=
 github.com/trailofbits/go-fuzz-utils v0.0.0-20260318143407-0907cafe7589/go.mod h1:zh+T+w9XT/3o4E0WLEGCdmLJ8Yqx/zY3o538tQY3OjY=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

table.go

@@ -45,6 +45,9 @@ func (t Table[K, V]) load() float64 {
 	return float64(t.Size()) / float64(t.TotalCapacity())
 }
 
+// resize clears all buckets, changes the sizes of them to a specific capacity,
+// and fills them back up again. It is a helper function for [Table.grow] and
+// [Table.shrink]; use them instead.
 func (t *Table[K, V]) resize(capacity uint64) error {
 	entries := make([]entry[K, V], 0, t.Size())
 	for k, v := range t.Entries() {
@@ -63,6 +66,8 @@ func (t *Table[K, V]) resize(capacity uint64) error {
 	return nil
 }
 
+// grow increases the table's capacity by the [Table.growthFactor]. If the
+// capacity is 0, it increases it to 1.
 func (t *Table[K, V]) grow() error {
 	var newCapacity uint64
 
@@ -75,6 +80,8 @@ func (t *Table[K, V]) grow() error {
 	return t.resize(newCapacity)
 }
 
+// shrink reduces the table's capacity by the [Table.growthFactor]. It may
+// reduce it down to 0.
 func (t *Table[K, V]) shrink() error {
 	return t.resize(t.bucketA.capacity / t.growthFactor)
 }

testdata/fuzz/FuzzInsertLookup/663e746d1518e2f5

@@ -1,2 +0,0 @@
-go test fuzz v1
-[]byte("B000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000")