Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support for afero.Fs filesystem abstraction #101

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

support for afero.Fs filesystem abstraction #101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
454f264
made watcher work against afero.Fs abstraction and added SetFileSystem()
progrium Apr 3, 2020
88c0f93
replacing filepath.Abs with filepath.Clean since using afero.Fs means…
progrium Apr 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 18 additions & 24 deletions watcher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ package watcher
import (
"errors"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"regexp"
"strings"
"sync"
"time"

"github.com/spf13/afero"
)

var (
Expand Down Expand Up @@ -129,6 +130,7 @@ type Watcher struct {
ops map[Op]struct{} // Op filtering.
ignoreHidden bool // ignore hidden files or not.
maxEvents int // max sent events per cycle
fs afero.Fs // filesystem to use
}

// New creates a new Watcher.
Expand All @@ -147,9 +149,16 @@ func New() *Watcher {
files: make(map[string]os.FileInfo),
ignored: make(map[string]struct{}),
names: make(map[string]bool),
fs: afero.NewOsFs(),
}
}

// SetFileSystem lets you specify an alternative FS to work against.
// The default is afero's OsFs which maps to the system FS.
func (w *Watcher) SetFileSystem(fs afero.Fs) {
w.fs = fs
}

// SetMaxEvents controls the maximum amount of events that are sent on
// the Event channel per watching cycle. If max events is less than 1, there is
// no limit, which is the default.
Expand Down Expand Up @@ -190,10 +199,7 @@ func (w *Watcher) Add(name string) (err error) {
w.mu.Lock()
defer w.mu.Unlock()

name, err = filepath.Abs(name)
if err != nil {
return err
}
name = filepath.Clean(name)

// If name is on the ignored list or if hidden files are
// ignored and name is a hidden file or directory, simply return.
Expand Down Expand Up @@ -227,7 +233,7 @@ func (w *Watcher) list(name string) (map[string]os.FileInfo, error) {
fileList := make(map[string]os.FileInfo)

// Make sure name exists.
stat, err := os.Stat(name)
stat, err := w.fs.Stat(name)
if err != nil {
return nil, err
}
Expand All @@ -240,7 +246,7 @@ func (w *Watcher) list(name string) (map[string]os.FileInfo, error) {
}

// It's a directory.
fInfoList, err := ioutil.ReadDir(name)
fInfoList, err := afero.ReadDir(w.fs, name)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -281,10 +287,7 @@ func (w *Watcher) AddRecursive(name string) (err error) {
w.mu.Lock()
defer w.mu.Unlock()

name, err = filepath.Abs(name)
if err != nil {
return err
}
name = filepath.Clean(name)

fileList, err := w.listRecursive(name)
if err != nil {
Expand All @@ -303,7 +306,7 @@ func (w *Watcher) AddRecursive(name string) (err error) {
func (w *Watcher) listRecursive(name string) (map[string]os.FileInfo, error) {
fileList := make(map[string]os.FileInfo)

return fileList, filepath.Walk(name, func(path string, info os.FileInfo, err error) error {
return fileList, afero.Walk(w.fs, name, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
Expand Down Expand Up @@ -344,10 +347,7 @@ func (w *Watcher) Remove(name string) (err error) {
w.mu.Lock()
defer w.mu.Unlock()

name, err = filepath.Abs(name)
if err != nil {
return err
}
name = filepath.Clean(name)

// Remove the name from w's names list.
delete(w.names, name)
Expand Down Expand Up @@ -380,10 +380,7 @@ func (w *Watcher) RemoveRecursive(name string) (err error) {
w.mu.Lock()
defer w.mu.Unlock()

name, err = filepath.Abs(name)
if err != nil {
return err
}
name = filepath.Clean(name)

// Remove the name from w's names list.
delete(w.names, name)
Expand Down Expand Up @@ -413,10 +410,7 @@ func (w *Watcher) RemoveRecursive(name string) (err error) {
// For files that are already added, Ignore removes them.
func (w *Watcher) Ignore(paths ...string) (err error) {
for _, path := range paths {
path, err = filepath.Abs(path)
if err != nil {
return err
}
path = filepath.Clean(path)
// Remove any of the paths that were already added.
if err := w.RemoveRecursive(path); err != nil {
return err
Expand Down