Merge pull request #14 from terrastruct/mapfs

tmpfs -> mapfs

Author: nhooyr

README.md

@@ -27,9 +27,7 @@ own repo from this collection we will. Feel free to open an issue to request.
 - [./xexec](#xexec)
 - [./xhttp](#xhttp)
 - [./xmain](#xmain)
-- [./tmpfs](#tmpfs)
-
-
+- [./mapfs](#mapfs)
 
 godoc is the canonical reference but we've provided this index as the godoc UI is frankly
 garbage after the move to pkg.go.dev. It's nowhere near as clear and responsive as the old
@@ -119,6 +117,6 @@ xhttp provides HTTP helpers.
 
 xmain implements helpers for building CLI tools.
 
-### [./tmpfs](./tmpfs)
+### [./mapfs](./mapfs)
 
-Package tmpfs takes in an memory description of a filesystem and writes it to a temp directory so that it may be used as an io/fs.FS.
+Package mapfs takes in a description of a filesystem as a `map[string]string` and writes it to a temp directory so that it may be used as an io/fs.FS.

tmpfs/tmpfs.go mapfs/mapfs.go

@@ -1,6 +1,6 @@
-// Package tmpfs takes in an memory description of a filesystem
+// Package mapfs takes in a description of a filesystem as a map[string]string
 // and writes it to a temp directory so that it may be used as an io/fs.FS.
-package tmpfs
+package mapfs
 
 import (
 	"errors"
@@ -15,20 +15,20 @@ type FS struct {
 	fs.FS
 }
 
-func Make(m map[string]string) (*FS, error) {
-	tempDir, err := os.MkdirTemp("", "tmpfs-*")
+func New(m map[string]string) (*FS, error) {
+	tempDir, err := os.MkdirTemp("", "mapfs-*")
 	if err != nil {
-		return nil, fmt.Errorf("failed to create root tmpfs dir: %w", err)
+		return nil, fmt.Errorf("failed to create root mapfs dir: %w", err)
 	}
 	for p, s := range m {
 		p = path.Join(tempDir, p)
 		err = os.MkdirAll(path.Dir(p), 0755)
 		if err != nil {
-			return nil, fmt.Errorf("failed to create tmpfs dir %q: %w", path.Dir(p), err)
+			return nil, fmt.Errorf("failed to create mapfs dir %q: %w", path.Dir(p), err)
 		}
 		err = os.WriteFile(p, []byte(s), 0644)
 		if err != nil {
-			return nil, fmt.Errorf("failed to write tmpfs file %q: %w", p, err)
+			return nil, fmt.Errorf("failed to write mapfs file %q: %w", p, err)
 		}
 	}
 	return &FS{
@@ -43,7 +43,7 @@ func (fs *FS) Close() error {
 		return nil
 	}
 	if err != nil {
-		return fmt.Errorf("failed to close tmpfs.FS: %w", err)
+		return fmt.Errorf("failed to close mapfs.FS: %w", err)
 	}
 	return nil
 }

tmpfs/tmpfs_test.go mapfs/mapfs_test.go

@@ -1,14 +1,14 @@
-package tmpfs_test
+package mapfs_test
 
 import (
 	"io/fs"
 	"testing"
 
 	"oss.terrastruct.com/util-go/assert"
-	"oss.terrastruct.com/util-go/tmpfs"
+	"oss.terrastruct.com/util-go/mapfs"
 )
 
-func TestMemFS(t *testing.T) {
+func TestMapFS(t *testing.T) {
 	t.Parallel()
 
 	m := map[string]string{
@@ -18,21 +18,21 @@ func TestMemFS(t *testing.T) {
 		"nested/nested/nested/nested": "Yuppie Wannabes",
 	}
 
-	tmpfs, err := tmpfs.Make(m)
+	mapfs, err := mapfs.New(m)
 	assert.Success(t, err)
 	t.Cleanup(func() {
-		err := tmpfs.Close()
+		err := mapfs.Close()
 		assert.Success(t, err)
 	})
 
 	for p, s := range m {
-		b, err := fs.ReadFile(tmpfs, p)
+		b, err := fs.ReadFile(mapfs, p)
 		assert.Success(t, err)
 		assert.Equal(t, s, string(b))
 	}
 
-	_, err = fs.ReadFile(tmpfs, "../escape")
+	_, err = fs.ReadFile(mapfs, "../escape")
 	assert.ErrorString(t, err, "stat ../escape: invalid argument")
-	_, err = fs.ReadFile(tmpfs, "/root")
+	_, err = fs.ReadFile(mapfs, "/root")
 	assert.ErrorString(t, err, "stat /root: invalid argument")
 }