From c011c6fd8bde6f9a480bd0e4b5e46e12646da01a Mon Sep 17 00:00:00 2001 From: plastikfan Date: Fri, 27 Sep 2024 16:09:23 +0100 Subject: [PATCH] ref(lfs): rename nfs to lfs (#199) --- Taskfile.yml | 8 ++++---- director.go | 4 ++-- internal/feat/filter/scheme-sampler.go | 4 ++-- internal/feat/sampling/controller.go | 4 ++-- internal/filtering/sample.go | 6 +++--- internal/kernel/contents.go | 4 ++-- internal/laboratory/directory-tree-builder.go | 4 ++-- internal/types/definitions.go | 4 ++-- {nfs => lfs}/ensure-path-at.go | 2 +- {nfs => lfs}/ensure-path-at_test.go | 10 +++++----- {nfs => lfs}/file-systems.go | 14 +++++++------- {nfs => lfs}/from-file-info.go | 2 +- {nfs => lfs}/matchers_test.go | 6 +++--- {nfs => lfs}/nfs-defs.go | 6 +++--- {nfs => lfs}/nfs-suite_test.go | 2 +- {nfs => lfs}/resolve-mocks.go | 2 +- {nfs => lfs}/resolve-path.go | 2 +- {nfs => lfs}/resolve-path_test.go | 18 +++++++++--------- {nfs => lfs}/separate.go | 2 +- {nfs => lfs}/split-parent.go | 2 +- tapable/tapable_test.go | 2 +- traverse-api.go | 16 ++++++++-------- 22 files changed, 62 insertions(+), 62 deletions(-) rename {nfs => lfs}/ensure-path-at.go (99%) rename {nfs => lfs}/ensure-path-at_test.go (92%) rename {nfs => lfs}/file-systems.go (67%) rename {nfs => lfs}/from-file-info.go (97%) rename {nfs => lfs}/matchers_test.go (91%) rename {nfs => lfs}/nfs-defs.go (88%) rename {nfs => lfs}/nfs-suite_test.go (99%) rename {nfs => lfs}/resolve-mocks.go (98%) rename {nfs => lfs}/resolve-path.go (98%) rename {nfs => lfs}/resolve-path_test.go (88%) rename {nfs => lfs}/separate.go (98%) rename {nfs => lfs}/split-parent.go (92%) diff --git a/Taskfile.yml b/Taskfile.yml index a50f5b6..cd1f17a 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -64,6 +64,10 @@ tasks: cmds: - go test ./cycle + tfs: + cmds: + - go test ./lfs + tk: cmds: - go test ./internal/kernel @@ -76,10 +80,6 @@ tasks: cmds: - go test ./locale - tn: - cmds: - - go test ./nfs - tcore: cmds: - go test ./core diff --git a/director.go b/director.go index 51fec90..49e0d9f 100644 --- a/director.go +++ b/director.go @@ -81,7 +81,7 @@ func Prime(using *pref.Using, settings ...pref.Option) *Builders { return using.GetReadDirFS() } - return NewNativeFS(using.Root) + return NewLocalFS(using.Root) }), queryFS: pref.CreateQueryStatusFS(func(qsys fs.FS) fs.StatFS { if using.GetQueryStatusFS != nil { @@ -141,7 +141,7 @@ func Resume(was *Was, settings ...pref.Option) *Builders { if was.Using.GetReadDirFS != nil { return was.Using.GetReadDirFS() } - return NewNativeFS(was.Root) + return NewLocalFS(was.Root) }), queryFS: pref.CreateQueryStatusFS(func(fsys fs.FS) fs.StatFS { if was.Using.GetQueryStatusFS != nil { diff --git a/internal/feat/filter/scheme-sampler.go b/internal/feat/filter/scheme-sampler.go index 311595c..1df4e34 100644 --- a/internal/feat/filter/scheme-sampler.go +++ b/internal/feat/filter/scheme-sampler.go @@ -8,7 +8,7 @@ import ( "github.com/snivilised/traverse/internal/filtering" "github.com/snivilised/traverse/internal/third/lo" "github.com/snivilised/traverse/internal/types" - "github.com/snivilised/traverse/nfs" + "github.com/snivilised/traverse/lfs" ) type samplerScheme struct { @@ -43,7 +43,7 @@ func (s *samplerScheme) next(node *core.Node, ) (bool, error) { if node.Extension.Scope.IsRoot() { matching := s.filter.Matching( - []fs.DirEntry{nfs.FromFileInfo(node.Info)}, + []fs.DirEntry{lfs.FromFileInfo(node.Info)}, ) result := len(matching) > 0 diff --git a/internal/feat/sampling/controller.go b/internal/feat/sampling/controller.go index 18b63b2..13e8988 100644 --- a/internal/feat/sampling/controller.go +++ b/internal/feat/sampling/controller.go @@ -7,7 +7,7 @@ import ( "github.com/snivilised/traverse/enums" "github.com/snivilised/traverse/internal/third/lo" "github.com/snivilised/traverse/internal/types" - "github.com/snivilised/traverse/nfs" + "github.com/snivilised/traverse/lfs" "github.com/snivilised/traverse/pref" ) @@ -27,7 +27,7 @@ func (p *controller) Next(_ *core.Node, _ types.Inspection) (bool, error) { func (p *controller) sample(result []fs.DirEntry, _ error, _ fs.ReadDirFS, _ string, ) ([]fs.DirEntry, error) { - files, folders := nfs.Separate(result) + files, folders := lfs.Separate(result) return union(&readResult{ files: files, diff --git a/internal/filtering/sample.go b/internal/filtering/sample.go index 775ab3f..c2b2815 100644 --- a/internal/filtering/sample.go +++ b/internal/filtering/sample.go @@ -6,8 +6,8 @@ import ( "github.com/snivilised/traverse/core" "github.com/snivilised/traverse/enums" "github.com/snivilised/traverse/internal/third/lo" + "github.com/snivilised/traverse/lfs" "github.com/snivilised/traverse/locale" - "github.com/snivilised/traverse/nfs" "github.com/snivilised/traverse/pref" ) @@ -80,12 +80,12 @@ func NewSample(def *core.SampleFilterDef, } func (f *Sample) files(entries []fs.DirEntry) (wanted, others []fs.DirEntry) { - wanted, others = nfs.Separate(entries) + wanted, others = lfs.Separate(entries) return wanted, others } func (f *Sample) folders(entries []fs.DirEntry) (wanted, others []fs.DirEntry) { - others, wanted = nfs.Separate(entries) + others, wanted = lfs.Separate(entries) return wanted, others } diff --git a/internal/kernel/contents.go b/internal/kernel/contents.go index 161caed..6d7bfcc 100644 --- a/internal/kernel/contents.go +++ b/internal/kernel/contents.go @@ -6,7 +6,7 @@ import ( "github.com/snivilised/traverse/core" "github.com/snivilised/traverse/enums" "github.com/snivilised/traverse/internal/third/lo" - "github.com/snivilised/traverse/nfs" + "github.com/snivilised/traverse/lfs" "github.com/snivilised/traverse/pref" "github.com/snivilised/traverse/tapable" ) @@ -20,7 +20,7 @@ func newContents(behaviour *pref.SortBehaviour, hook: hook, } - contents.files, contents.folders = nfs.Separate(entries) + contents.files, contents.folders = lfs.Separate(entries) return &contents } diff --git a/internal/laboratory/directory-tree-builder.go b/internal/laboratory/directory-tree-builder.go index 21feaef..039de3a 100644 --- a/internal/laboratory/directory-tree-builder.go +++ b/internal/laboratory/directory-tree-builder.go @@ -12,7 +12,7 @@ import ( "github.com/snivilised/traverse/collections" "github.com/snivilised/traverse/internal/third/lo" - "github.com/snivilised/traverse/nfs" + "github.com/snivilised/traverse/lfs" ) const ( @@ -55,7 +55,7 @@ func Provision(provider *IOProvider, verbose bool, portions ...string) (root str func ensure(root string, provider *IOProvider, verbose bool) error { repo := Repo("") index := Path(repo, "test/data/musico-index.xml") - parent, _ := nfs.SplitParent(root) + parent, _ := lfs.SplitParent(root) builder := directoryTreeBuilder{ root: TrimRoot(root), stack: collections.NewStackWith([]string{parent}), diff --git a/internal/types/definitions.go b/internal/types/definitions.go index 63af3e3..8fe1ce6 100644 --- a/internal/types/definitions.go +++ b/internal/types/definitions.go @@ -9,7 +9,7 @@ import ( "github.com/snivilised/traverse/enums" "github.com/snivilised/traverse/internal/measure" "github.com/snivilised/traverse/internal/opts" - "github.com/snivilised/traverse/nfs" + "github.com/snivilised/traverse/lfs" "github.com/snivilised/traverse/pref" ) @@ -66,7 +66,7 @@ type ( // Resources are dependencies required for navigation Resources struct { - FS nfs.FileSystems + FS lfs.FileSystems Supervisor *measure.Supervisor Binder *opts.Binder } diff --git a/nfs/ensure-path-at.go b/lfs/ensure-path-at.go similarity index 99% rename from nfs/ensure-path-at.go rename to lfs/ensure-path-at.go index 00605b3..27914e8 100644 --- a/nfs/ensure-path-at.go +++ b/lfs/ensure-path-at.go @@ -1,4 +1,4 @@ -package nfs +package lfs import ( "os" diff --git a/nfs/ensure-path-at_test.go b/lfs/ensure-path-at_test.go similarity index 92% rename from nfs/ensure-path-at_test.go rename to lfs/ensure-path-at_test.go index 91c742f..876b422 100644 --- a/nfs/ensure-path-at_test.go +++ b/lfs/ensure-path-at_test.go @@ -1,4 +1,4 @@ -package nfs_test +package lfs_test import ( "errors" @@ -12,13 +12,13 @@ import ( "github.com/snivilised/li18ngo" lab "github.com/snivilised/traverse/internal/laboratory" + "github.com/snivilised/traverse/lfs" "github.com/snivilised/traverse/locale" - "github.com/snivilised/traverse/nfs" ) var _ = Describe("EnsurePathAt", Ordered, func() { var ( - mocks *nfs.ResolveMocks + mocks *lfs.ResolveMocks mfs *mkDirAllMapFS ) @@ -33,7 +33,7 @@ var _ = Describe("EnsurePathAt", Ordered, func() { }) BeforeEach(func() { - mocks = &nfs.ResolveMocks{ + mocks = &lfs.ResolveMocks{ HomeFunc: func() (string, error) { return filepath.Join(string(filepath.Separator), "home", "prodigy"), nil }, @@ -60,7 +60,7 @@ var _ = Describe("EnsurePathAt", Ordered, func() { location += string(filepath.Separator) } - actual, err := nfs.EnsurePathAt(location, "default-test.log", perm, mfs) + actual, err := lfs.EnsurePathAt(location, "default-test.log", perm, mfs) directory, _ := filepath.Split(actual) directory = filepath.Clean(directory) expected := lab.TrimRoot(lab.Path(home, entry.expected)) diff --git a/nfs/file-systems.go b/lfs/file-systems.go similarity index 67% rename from nfs/file-systems.go rename to lfs/file-systems.go index d70fe45..b885cf7 100644 --- a/nfs/file-systems.go +++ b/lfs/file-systems.go @@ -1,26 +1,26 @@ -package nfs +package lfs import ( "io/fs" "os" ) -type nativeFS struct { +type localFS struct { fsys fs.FS } -// NewNativeFS creates a native file system. -func NewNativeFS(path string) fs.ReadDirFS { - return &nativeFS{ +// NewLocalFS creates a native file system. +func NewLocalFS(path string) fs.ReadDirFS { + return &localFS{ fsys: os.DirFS(path), } } -func (n *nativeFS) Open(path string) (fs.File, error) { +func (n *localFS) Open(path string) (fs.File, error) { return n.fsys.Open(path) } -func (n *nativeFS) ReadDir(name string) ([]fs.DirEntry, error) { +func (n *localFS) ReadDir(name string) ([]fs.DirEntry, error) { return fs.ReadDir(n.fsys, name) } diff --git a/nfs/from-file-info.go b/lfs/from-file-info.go similarity index 97% rename from nfs/from-file-info.go rename to lfs/from-file-info.go index eb5bb44..5f0483b 100644 --- a/nfs/from-file-info.go +++ b/lfs/from-file-info.go @@ -1,4 +1,4 @@ -package nfs +package lfs import ( "io/fs" diff --git a/nfs/matchers_test.go b/lfs/matchers_test.go similarity index 91% rename from nfs/matchers_test.go rename to lfs/matchers_test.go index 94f4625..529ef89 100644 --- a/nfs/matchers_test.go +++ b/lfs/matchers_test.go @@ -1,10 +1,10 @@ -package nfs_test +package lfs_test import ( "fmt" "github.com/onsi/gomega/types" - "github.com/snivilised/traverse/nfs" + "github.com/snivilised/traverse/lfs" ) type PathExistsMatcher struct { @@ -21,7 +21,7 @@ func ExistInFS(fs interface{}) types.GomegaMatcher { } func (m *PathExistsMatcher) Match(actual interface{}) (bool, error) { - FS, fileSystemOK := m.FS.(nfs.MkDirAllFS) + FS, fileSystemOK := m.FS.(lfs.MkDirAllFS) if !fileSystemOK { return false, fmt.Errorf("โŒ matcher expected a VirtualFS instance (%T)", FS) } diff --git a/nfs/nfs-defs.go b/lfs/nfs-defs.go similarity index 88% rename from nfs/nfs-defs.go rename to lfs/nfs-defs.go index d231ac7..3d19499 100644 --- a/nfs/nfs-defs.go +++ b/lfs/nfs-defs.go @@ -1,12 +1,12 @@ -package nfs +package lfs import ( "io/fs" "os" ) -// ๐Ÿ“ฆ pkg: nfs - contains file system abstractions for navigation. Since -// there are no standard write-able file system interfaces, +// ๐Ÿ“ฆ pkg: lfs - contains local file system abstractions for navigation. +// Since there are no standard write-able file system interfaces, // we need to define proprietary ones here in this package. // This is a low level package that should not use anything else in // traverse. diff --git a/nfs/nfs-suite_test.go b/lfs/nfs-suite_test.go similarity index 99% rename from nfs/nfs-suite_test.go rename to lfs/nfs-suite_test.go index 34b1121..ca07a3a 100644 --- a/nfs/nfs-suite_test.go +++ b/lfs/nfs-suite_test.go @@ -1,4 +1,4 @@ -package nfs_test +package lfs_test import ( "io/fs" diff --git a/nfs/resolve-mocks.go b/lfs/resolve-mocks.go similarity index 98% rename from nfs/resolve-mocks.go rename to lfs/resolve-mocks.go index 6d34abb..776329a 100644 --- a/nfs/resolve-mocks.go +++ b/lfs/resolve-mocks.go @@ -1,4 +1,4 @@ -package nfs +package lfs // AbsFunc signature of function used to obtain the absolute representation of // a path. diff --git a/nfs/resolve-path.go b/lfs/resolve-path.go similarity index 98% rename from nfs/resolve-path.go rename to lfs/resolve-path.go index ff146d8..7659718 100644 --- a/nfs/resolve-path.go +++ b/lfs/resolve-path.go @@ -1,4 +1,4 @@ -package nfs +package lfs import ( "os" diff --git a/nfs/resolve-path_test.go b/lfs/resolve-path_test.go similarity index 88% rename from nfs/resolve-path_test.go rename to lfs/resolve-path_test.go index b5f1bb0..40fdf57 100644 --- a/nfs/resolve-path_test.go +++ b/lfs/resolve-path_test.go @@ -1,4 +1,4 @@ -package nfs_test +package lfs_test import ( "fmt" @@ -9,8 +9,8 @@ import ( . "github.com/onsi/gomega" //nolint:revive // ok "github.com/snivilised/li18ngo" + "github.com/snivilised/traverse/lfs" "github.com/snivilised/traverse/locale" - "github.com/snivilised/traverse/nfs" ) var _ = Describe("ResolvePath", Ordered, func() { @@ -26,19 +26,19 @@ var _ = Describe("ResolvePath", Ordered, func() { DescribeTable("Overrides provided", func(entry *RPEntry) { - mocks := nfs.ResolveMocks{ + mocks := lfs.ResolveMocks{ HomeFunc: fakeHomeResolver, AbsFunc: fakeAbsResolver, } if filepath.Separator == '/' { - actual := nfs.ResolvePath(entry.path, mocks) + actual := lfs.ResolvePath(entry.path, mocks) Expect(actual).To(Equal(entry.expect)) } else { normalisedPath := strings.ReplaceAll(entry.path, "/", string(filepath.Separator)) normalisedExpect := strings.ReplaceAll(entry.expect, "/", string(filepath.Separator)) - actual := nfs.ResolvePath(normalisedPath, mocks) + actual := lfs.ResolvePath(normalisedPath, mocks) Expect(actual).To(Equal(normalisedExpect)) } }, @@ -81,25 +81,25 @@ var _ = Describe("ResolvePath", Ordered, func() { When("No overrides provided", func() { Context("and: home", func() { It("๐Ÿงช should: not fail", func() { - nfs.ResolvePath("~/") + lfs.ResolvePath("~/") }) }) Context("and: abs cwd", func() { It("๐Ÿงช should: not fail", func() { - nfs.ResolvePath("./") + lfs.ResolvePath("./") }) }) Context("and: abs parent", func() { It("๐Ÿงช should: not fail", func() { - nfs.ResolvePath("../") + lfs.ResolvePath("../") }) }) Context("and: abs grand parent", func() { It("๐Ÿงช should: not fail", func() { - nfs.ResolvePath("../..") + lfs.ResolvePath("../..") }) }) }) diff --git a/nfs/separate.go b/lfs/separate.go similarity index 98% rename from nfs/separate.go rename to lfs/separate.go index e8667a4..bdead76 100644 --- a/nfs/separate.go +++ b/lfs/separate.go @@ -1,4 +1,4 @@ -package nfs +package lfs import ( "io/fs" diff --git a/nfs/split-parent.go b/lfs/split-parent.go similarity index 92% rename from nfs/split-parent.go rename to lfs/split-parent.go index 0629e71..ddad317 100644 --- a/nfs/split-parent.go +++ b/lfs/split-parent.go @@ -1,4 +1,4 @@ -package nfs +package lfs import ( "path/filepath" diff --git a/tapable/tapable_test.go b/tapable/tapable_test.go index 2ed23ad..e3565ea 100644 --- a/tapable/tapable_test.go +++ b/tapable/tapable_test.go @@ -212,7 +212,7 @@ var _ = Describe("Tapable", Ordered, func() { }, ) - sys := tv.NewNativeFS(root) + sys := tv.NewLocalFS(root) _, _ = o.Hooks.ReadDirectory.Default()(sys, root) _, _ = o.Hooks.ReadDirectory.Invoke()(sys, root) diff --git a/traverse-api.go b/traverse-api.go index d20216a..b375b1c 100644 --- a/traverse-api.go +++ b/traverse-api.go @@ -6,7 +6,7 @@ import ( "github.com/snivilised/traverse/core" "github.com/snivilised/traverse/enums" "github.com/snivilised/traverse/internal/filtering" - "github.com/snivilised/traverse/nfs" + "github.com/snivilised/traverse/lfs" "github.com/snivilised/traverse/pref" ) @@ -53,8 +53,8 @@ type ( Subscription = enums.Subscription ResumeStrategy = enums.ResumeStrategy - // ๐ŸŒ€ nfs - FileSystems = nfs.FileSystems + // ๐ŸŒ€ lfs + FileSystems = lfs.FileSystems // ๐ŸŒ€ pref Option = pref.Option @@ -80,14 +80,14 @@ const ( ) var ( - // ๐ŸŒ€ nfs + // ๐ŸŒ€ lfs - // NewNativeFS creates a native file system. - NewNativeFS = nfs.NewNativeFS + // NewLocalFS creates a native file system. + NewLocalFS = lfs.NewLocalFS // NewQueryStatusFS defines a file system that has a Stat // method to determine the existence of a path. - NewQueryStatusFS = nfs.NewQueryStatusFS + NewQueryStatusFS = lfs.NewQueryStatusFS // ๐ŸŒ€ filtering @@ -283,7 +283,7 @@ var ( // core: [] // enums: [none] // measure: [] -// nfs: +// lfs: // --- // ============================================================================ //