rename to linkedpage, split out meta page interface

kevmo314 · Jun 20, 2024 · ccbcf41 · ccbcf41
1 parent 9dcf226
commit ccbcf41
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 31 deletions.
diff --git a/examples/visualizer/main.go b/examples/visualizer/main.go
@@ -82,7 +82,7 @@ func main() {
 			// this is a linked meta page
 			lmps = lmps[1:]
 
-			// metaPage, err := metapage.NewMultiBPTree(pf, int(i))
+			// metaPage, err := linkedpage.NewMultiBPTree(pf, int(i))
 			// if err != nil {
 			// 	panic(err)
 			// }

diff --git a/pkg/appendable/appendable_test.go b/pkg/appendable/appendable_test.go
@@ -2,7 +2,7 @@ package appendable
 
 import (
 	"github.com/kevmo314/appendable/pkg/buftest"
-	"github.com/kevmo314/appendable/pkg/metapage"
+	"github.com/kevmo314/appendable/pkg/linkedpage"
 	"github.com/kevmo314/appendable/pkg/pagefile"
 	"reflect"
 	"testing"
@@ -16,7 +16,7 @@ func TestMarshalMetadata(t *testing.T) {
 			t.Fatal(err)
 		}
 
-		tree, err := metapage.NewMultiBPTree(p, 0)
+		tree, err := linkedpage.NewMultiBPTree(p, 0)
 		if err != nil {
 			t.Fatal(err)
 		}
@@ -69,7 +69,7 @@ func TestMarshalMetadata(t *testing.T) {
 			t.Fatal(err)
 		}
 
-		tree, err := metapage.NewMultiBPTree(p, 0)
+		tree, err := linkedpage.NewMultiBPTree(p, 0)
 		if err != nil {
 			t.Fatal(err)
 		}

diff --git a/pkg/appendable/index_file.go b/pkg/appendable/index_file.go
@@ -3,7 +3,7 @@ package appendable
 import (
 	"errors"
 	"fmt"
-	"github.com/kevmo314/appendable/pkg/metapage"
+	"github.com/kevmo314/appendable/pkg/linkedpage"
 	"io"
 	"time"
 
@@ -21,7 +21,7 @@ type DataHandler interface {
 
 // IndexFile is a representation of the entire index file.
 type IndexFile struct {
-	tree        *metapage.LinkedMetaPage
+	tree        *linkedpage.LinkedMetaPage
 	dataHandler DataHandler
 
 	pf                *pagefile.PageFile
@@ -36,7 +36,7 @@ func NewIndexFile(f io.ReadWriteSeeker, dataHandler DataHandler, searchHeaders [
 		return nil, fmt.Errorf("failed to create page file: %w", err)
 	}
 
-	tree, err := metapage.NewMultiBPTree(pf, 0)
+	tree, err := linkedpage.NewMultiBPTree(pf, 0)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create multi b+ tree: %w", err)
 	}
@@ -101,7 +101,7 @@ func (i *IndexFile) SetMetadata(metadata *FileMeta) error {
 	return i.tree.SetMetadata(buf)
 }
 
-func (i *IndexFile) Indexes() (*metapage.LinkedMetaPage, error) {
+func (i *IndexFile) Indexes() (*linkedpage.LinkedMetaPage, error) {
 	return i.tree.Next()
 }
 
@@ -146,7 +146,7 @@ func (i *IndexFile) IndexFieldNames() ([]string, error) {
 	return fieldNames, nil
 }
 
-func (i *IndexFile) FindOrCreateIndex(name string, fieldType FieldType) (*metapage.LinkedMetaPage, *IndexMeta, error) {
+func (i *IndexFile) FindOrCreateIndex(name string, fieldType FieldType) (*linkedpage.LinkedMetaPage, *IndexMeta, error) {
 	mp := i.tree
 	for {
 		next, err := mp.Next()

diff --git a/pkg/bptree/bptree.go b/pkg/bptree/bptree.go
@@ -3,23 +3,16 @@ package bptree
 import (
 	"bytes"
 	"fmt"
+	"github.com/kevmo314/appendable/pkg/metapage"
 	"io"
 	"slices"
 
 	"github.com/kevmo314/appendable/pkg/pagefile"
 	"github.com/kevmo314/appendable/pkg/pointer"
 )
 
-// MetaPage is an abstract interface over the root page of a bptree
-// This allows the caller to control the memory location of the meta
-// pointer
-type MetaPage interface {
-	Root() (pointer.MemoryPointer, error)
-	SetRoot(pointer.MemoryPointer) error
-}
-
 type BPTree struct {
-	MetaPage MetaPage
+	MetaPage metapage.MetaPage
 	PageFile pagefile.ReadWriteSeekPager
 
 	Data       []byte

diff --git a/pkg/handlers/equality_test.go b/pkg/handlers/equality_test.go
@@ -4,7 +4,7 @@ import (
 	"bytes"
 	"encoding/binary"
 	"fmt"
-	"github.com/kevmo314/appendable/pkg/metapage"
+	"github.com/kevmo314/appendable/pkg/linkedpage"
 	"github.com/kevmo314/appendable/pkg/pointer"
 	"log/slog"
 	"math"
@@ -133,7 +133,7 @@ func compareFieldNames(i1, i2 []string) (bool, string) {
 	return true, ""
 }
 
-func compareIndexMeta(i1, i2 []*metapage.LinkedMetaPage) (bool, string) {
+func compareIndexMeta(i1, i2 []*linkedpage.LinkedMetaPage) (bool, string) {
 
 	for i, collected1 := range i1 {
 		buf1, err := collected1.Metadata()
@@ -180,7 +180,7 @@ func compareIndexMeta(i1, i2 []*metapage.LinkedMetaPage) (bool, string) {
 	return true, ""
 }
 
-func compareMetaPages(i1, i2 []*metapage.LinkedMetaPage, jr, cr []byte) (bool, string) {
+func compareMetaPages(i1, i2 []*linkedpage.LinkedMetaPage, jr, cr []byte) (bool, string) {
 	h1 := [2]string{"test1", "test3"}
 	h2 := [2]float64{37.3, 4}
 

diff --git a/pkg/handlers/jsonl_test.go b/pkg/handlers/jsonl_test.go
@@ -6,7 +6,7 @@ import (
 	"math"
 	"testing"
 
-	"github.com/kevmo314/appendable/pkg/metapage"
+	"github.com/kevmo314/appendable/pkg/linkedpage"
 	"github.com/kevmo314/appendable/pkg/ngram"
 	"github.com/kevmo314/appendable/pkg/pointer"
 
@@ -144,7 +144,7 @@ func TestJSONL(t *testing.T) {
 			t.Errorf("got len(i.Indexes) = %d, want 4", len(collected))
 		}
 
-		var strIndexes []*metapage.LinkedMetaPage
+		var strIndexes []*linkedpage.LinkedMetaPage
 
 		for _, ms := range collected {
 			buf, err := ms.Metadata()
@@ -490,7 +490,7 @@ func TestJSONL(t *testing.T) {
 			t.Errorf("got len(i.Indexes) = %d, want 5", len(collected))
 		}
 
-		var vanillaIndexes []*metapage.LinkedMetaPage
+		var vanillaIndexes []*linkedpage.LinkedMetaPage
 
 		for _, ms := range collected {
 			buf, err := ms.Metadata()
@@ -567,7 +567,7 @@ func TestJSONL(t *testing.T) {
 			t.Errorf("got len(i.Indexes) = %d, want 2", len(collected))
 		}
 
-		var vanillaIndexes []*metapage.LinkedMetaPage
+		var vanillaIndexes []*linkedpage.LinkedMetaPage
 
 		for _, ms := range collected {
 			buf, err := ms.Metadata()
@@ -765,7 +765,7 @@ func TestJSONL(t *testing.T) {
 			t.Fatalf("expected 4 pages, got: %v", len(collected))
 		}
 
-		var tripage []*metapage.LinkedMetaPage
+		var tripage []*linkedpage.LinkedMetaPage
 
 		for _, ms := range collected {
 			buf, err := ms.Metadata()
@@ -833,7 +833,7 @@ func TestJSONL(t *testing.T) {
 			t.Fatalf("expected 4 pages, got: %v", len(collected))
 		}
 
-		var tripages []*metapage.LinkedMetaPage
+		var tripages []*linkedpage.LinkedMetaPage
 
 		for _, ms := range collected {
 			buf, err := ms.Metadata()

diff --git a/pkg/metapage/multi.go → pkg/linkedpage/multi.go b/pkg/metapage/multi.go → pkg/linkedpage/multi.go
@@ -1,4 +1,4 @@
-package metapage
+package linkedpage
 
 import (
 	"encoding"

diff --git a/pkg/metapage/multi_test.go → pkg/linkedpage/multi_test.go b/pkg/metapage/multi_test.go → pkg/linkedpage/multi_test.go
@@ -1,4 +1,4 @@
-package metapage
+package linkedpage
 
 import (
 	"reflect"

diff --git a/pkg/metapage/metapage.go b/pkg/metapage/metapage.go
@@ -0,0 +1,11 @@
+package metapage
+
+import "github.com/kevmo314/appendable/pkg/pointer"
+
+// MetaPage is an abstract interface over the root page of a bptree
+// This allows the caller to control the memory location of the meta
+// pointer
+type MetaPage interface {
+	Root() (pointer.MemoryPointer, error)
+	SetRoot(pointer.MemoryPointer) error
+}
diff --git a/pkg/mocks/metadata.go b/pkg/mocks/metadata.go
@@ -6,7 +6,7 @@ import (
 
 	"github.com/kevmo314/appendable/pkg/appendable"
 	"github.com/kevmo314/appendable/pkg/buftest"
-	"github.com/kevmo314/appendable/pkg/metapage"
+	"github.com/kevmo314/appendable/pkg/linkedpage"
 	"github.com/kevmo314/appendable/pkg/pagefile"
 )
 
@@ -16,7 +16,7 @@ func generateFilledMetadata() {
 	if err != nil {
 		log.Fatalf("%v", err)
 	}
-	tree, err := metapage.NewMultiBPTree(p, 0)
+	tree, err := linkedpage.NewMultiBPTree(p, 0)
 	if err != nil {
 		log.Fatalf("%v", err)
 	}