Merge pull request #156 from pjbgf/goroot

Align ReadDir interface with upstream `io/fs.ReadDirFS`

Author: pjbgf

embedfs/embed.go

@@ -8,12 +8,10 @@ import (
 	"io/fs"
 	"os"
 	"path/filepath"
-	"sort"
 	"strings"
 	"sync"
 
 	"github.com/go-git/go-billy/v6"
-	"github.com/go-git/go-billy/v6/memfs"
 )
 
 type Embed struct {
@@ -90,21 +88,8 @@ func (fs *Embed) Join(elem ...string) string {
 	return ""
 }
 
-func (fs *Embed) ReadDir(path string) ([]os.FileInfo, error) {
-	e, err := fs.underlying.ReadDir(path)
-	if err != nil {
-		return nil, err
-	}
-
-	entries := make([]os.FileInfo, 0, len(e))
-	for _, f := range e {
-		fi, _ := f.Info()
-		entries = append(entries, fi)
-	}
-
-	sort.Sort(memfs.ByName(entries))
-
-	return entries, nil
+func (fs *Embed) ReadDir(path string) ([]fs.DirEntry, error) {
+	return fs.underlying.ReadDir(path)
 }
 
 // Chroot is not supported.
@@ -219,16 +204,6 @@ func (f *file) Close() error {
 	return nil
 }
 
-// Lock for embedfs file is a no-op.
-func (f *file) Lock() error {
-	return nil
-}
-
-// Unlock for embedfs file is a no-op.
-func (f *file) Unlock() error {
-	return nil
-}
-
 // Truncate is not supported.
 //
 // Calls will always return billy.ErrReadOnly.

fs.go

@@ -109,7 +109,7 @@ type TempFile interface {
 type Dir interface {
 	// ReadDir reads the directory named by dirname and returns a list of
 	// directory entries sorted by filename.
-	ReadDir(path string) ([]fs.FileInfo, error)
+	ReadDir(path string) ([]fs.DirEntry, error)
 	// MkdirAll creates a directory named path, along with any necessary
 	// parents, and returns nil, or else returns an error. The permission bits
 	// perm are used for all directories that MkdirAll creates. If path is/
@@ -173,13 +173,18 @@ type File interface {
 	io.WriterAt
 	io.ReaderAt
 	io.Seeker
+	// Truncate the file.
+	Truncate(size int64) error
+}
+
+// Locker abstracts the lock and unlock of a File within the filesystem. Not
+// all filesystem implementations support it.
+type Locker interface {
 	// Lock locks the file like e.g. flock. It protects against access from
 	// other processes.
 	Lock() error
 	// Unlock unlocks the file.
 	Unlock() error
-	// Truncate the file.
-	Truncate(size int64) error
 }
 
 // Syncer interface can be implemented by filesystems that support syncing.

helper/chroot/chroot.go

@@ -134,7 +134,7 @@ func (fs *ChrootHelper) TempFile(dir, prefix string) (billy.File, error) {
 	return newFile(fs, f, fs.Join(dir, filepath.Base(f.Name()))), nil
 }
 
-func (fs *ChrootHelper) ReadDir(path string) ([]os.FileInfo, error) {
+func (fs *ChrootHelper) ReadDir(path string) ([]fs.DirEntry, error) {
 	fullpath, err := fs.underlyingPath(path)
 	if err != nil {
 		return nil, err

helper/iofs/iofs.go

@@ -52,15 +52,7 @@ func (a *adapterFs) Open(name string) (fs.File, error) {
 
 // ReadDir reads the named directory, implementing fs.ReadDirFS (returning a listing or error).
 func (a *adapterFs) ReadDir(name string) ([]fs.DirEntry, error) {
-	items, err := a.fs.ReadDir(name)
-	if err != nil {
-		return nil, err
-	}
-	entries := make([]fs.DirEntry, len(items))
-	for i, item := range items {
-		entries[i] = fs.FileInfoToDirEntry(item)
-	}
-	return entries, nil
+	return a.fs.ReadDir(name)
 }
 
 // Stat returns information on the named file, implementing fs.StatFS (returning FileInfo or error).

helper/mount/mount.go

@@ -110,7 +110,7 @@ func (h *Mount) Remove(path string) error {
 	return fs.Remove(fullpath)
 }
 
-func (h *Mount) ReadDir(path string) ([]os.FileInfo, error) {
+func (h *Mount) ReadDir(path string) ([]fs.DirEntry, error) {
 	fs, fullpath, err := h.getDirAndPath(path)
 	if err != nil {
 		return nil, err

helper/polyfill/polyfill.go

@@ -40,7 +40,7 @@ func (h *Polyfill) TempFile(dir, prefix string) (billy.File, error) {
 	return h.Basic.(billy.TempFile).TempFile(dir, prefix)
 }
 
-func (h *Polyfill) ReadDir(path string) ([]os.FileInfo, error) {
+func (h *Polyfill) ReadDir(path string) ([]fs.DirEntry, error) {
 	if !h.c.dir {
 		return nil, billy.ErrNotSupported
 	}

internal/test/mock.go

@@ -80,7 +80,7 @@ type DirMock struct {
 	MkdirAllArgs [][2]interface{}
 }
 
-func (fs *DirMock) ReadDir(path string) ([]os.FileInfo, error) {
+func (fs *DirMock) ReadDir(path string) ([]fs.DirEntry, error) {
 	fs.ReadDirArgs = append(fs.ReadDirArgs, path)
 	return nil, nil
 }

memfs/file.go

@@ -133,16 +133,6 @@ func (f *file) Stat() (os.FileInfo, error) {
 	}, nil
 }
 
-// Lock is a no-op in memfs.
-func (f *file) Lock() error {
-	return nil
-}
-
-// Unlock is a no-op in memfs.
-func (f *file) Unlock() error {
-	return nil
-}
-
 type fileInfo struct {
 	name    string
 	size    int

memfs/memory.go

@@ -4,7 +4,7 @@ package memfs // import "github.com/go-git/go-billy/v6/memfs"
 import (
 	"errors"
 	"fmt"
-	"io/fs"
+	gofs "io/fs"
 	"log"
 	"os"
 	"path/filepath"
@@ -49,7 +49,7 @@ func (fs *Memory) Open(filename string) (billy.File, error) {
 	return fs.OpenFile(filename, os.O_RDONLY, 0)
 }
 
-func (fs *Memory) OpenFile(filename string, flag int, perm fs.FileMode) (billy.File, error) {
+func (fs *Memory) OpenFile(filename string, flag int, perm gofs.FileMode) (billy.File, error) {
 	f, has := fs.s.Get(filename)
 	if !has {
 		if !isCreate(flag) {
@@ -132,13 +132,13 @@ func (fs *Memory) Lstat(filename string) (os.FileInfo, error) {
 	return f.Stat()
 }
 
-type ByName []os.FileInfo
+type ByName []gofs.DirEntry
 
 func (a ByName) Len() int           { return len(a) }
 func (a ByName) Less(i, j int) bool { return a[i].Name() < a[j].Name() }
 func (a ByName) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
 
-func (fs *Memory) ReadDir(path string) ([]os.FileInfo, error) {
+func (fs *Memory) ReadDir(path string) ([]gofs.DirEntry, error) {
 	if f, has := fs.s.Get(path); has {
 		if target, isLink := fs.resolveLink(path, f); isLink {
 			if target != path {
@@ -149,18 +149,18 @@ func (fs *Memory) ReadDir(path string) ([]os.FileInfo, error) {
 		return nil, &os.PathError{Op: "open", Path: path, Err: syscall.ENOENT}
 	}
 
-	var entries []os.FileInfo
+	var entries []gofs.DirEntry
 	for _, f := range fs.s.Children(path) {
 		fi, _ := f.Stat()
-		entries = append(entries, fi)
+		entries = append(entries, gofs.FileInfoToDirEntry(fi))
 	}
 
 	sort.Sort(ByName(entries))
 
 	return entries, nil
 }
 
-func (fs *Memory) MkdirAll(path string, perm fs.FileMode) error {
+func (fs *Memory) MkdirAll(path string, perm gofs.FileMode) error {
 	_, err := fs.s.New(path, perm|os.ModeDir, 0)
 	return err
 }
@@ -258,6 +258,6 @@ func isWriteOnly(flag int) bool {
 	return flag&os.O_WRONLY != 0
 }
 
-func isSymlink(m fs.FileMode) bool {
+func isSymlink(m gofs.FileMode) bool {
 	return m&os.ModeSymlink != 0
 }

osfs/os.go

@@ -79,22 +79,6 @@ const (
 	BoundOSFS
 )
 
-func readDir(dir string) ([]os.FileInfo, error) {
-	entries, err := os.ReadDir(dir)
-	if err != nil {
-		return nil, err
-	}
-	infos := make([]fs.FileInfo, 0, len(entries))
-	for _, entry := range entries {
-		fi, err := entry.Info()
-		if err != nil {
-			return nil, err
-		}
-		infos = append(infos, fi)
-	}
-	return infos, nil
-}
-
 func tempFile(dir, prefix string) (billy.File, error) {
 	f, err := os.CreateTemp(dir, prefix)
 	if err != nil {