use aferofs

cluttercode · Feb 11, 2021 · 96b9062 · 96b9062
1 parent d102028
commit 96b9062
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 10 deletions.
diff --git a/cmd/clutter/cmd_index.go b/cmd/clutter/cmd_index.go
@@ -53,7 +53,7 @@ var (
 			scan := func() error {
 				z.Info("scanning")
 
-				scan, err := scanner.NewScanner(z.Named("scanner"), cfg.Scanner)
+				scan, err := scanner.NewScanner(nil, z.Named("scanner"), cfg.Scanner)
 				if err != nil {
 					return fmt.Errorf("new scanner: %w", err)
 				}

diff --git a/cmd/clutter/index.go b/cmd/clutter/index.go
@@ -43,7 +43,7 @@ func readIndex(c *cli.Context) (func() (*index.Entry, error), func(), error) {
 }
 
 func readAdHocIndex() (func() (*index.Entry, error), error) {
-	scan, err := scanner.NewScanner(z.Named("scanner"), cfg.Scanner)
+	scan, err := scanner.NewScanner(nil, z.Named("scanner"), cfg.Scanner)
 	if err != nil {
 		return nil, fmt.Errorf("new scanner: %w", err)
 	}

diff --git a/go.mod b/go.mod
@@ -8,10 +8,12 @@ require (
 	github.com/ghodss/yaml v1.0.0
 	github.com/go-git/go-git v4.7.0+incompatible
 	github.com/gobwas/glob v0.2.3
+	github.com/spf13/afero v1.5.1
 	github.com/stretchr/testify v1.7.0
 	github.com/urfave/cli/v2 v2.3.0
 	go.uber.org/zap v1.16.0
 	golang.org/x/sys v0.0.0-20210113181707-4bcb84eeeb78 // indirect
+	golang.org/x/text v0.3.5 // indirect
 	golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5
 	gopkg.in/src-d/go-git.v4 v4.13.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect

diff --git a/go.sum b/go.sum
@@ -28,6 +28,7 @@ github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
 github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
 github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
+github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
@@ -38,6 +39,7 @@ github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrk
 github.com/pelletier/go-buffruneio v0.2.0/go.mod h1:JkE26KsDizTr40EUHkXVtNPvgGtbSNq5BcowyYOWdKo=
 github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
 github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pkg/sftp v1.10.1/go.mod h1:lYOWFsE0bwd1+KfKJaKeuokY15vzFx25BLbzYYoAxZI=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
@@ -46,6 +48,8 @@ github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQD
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
 github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
 github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
+github.com/spf13/afero v1.5.1 h1:VHu76Lk0LSP1x254maIu2bplkWpfBWI+B+6fdoZprcg=
+github.com/spf13/afero v1.5.1/go.mod h1:Ai8FlHk4v/PARR026UzYexafAt9roJ7LcLMAmO6Z93I=
 github.com/src-d/gcfg v1.4.0 h1:xXbNR5AlLSA315x2UO+fTSSAXCDf+Ar38/6oyGbDKQ4=
 github.com/src-d/gcfg v1.4.0/go.mod h1:p/UMsR43ujA89BJY9duynAwIpvqEujIH/jFlfL7jWoI=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
@@ -68,6 +72,7 @@ golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnf
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/crypto v0.0.0-20190701094942-4def268fd1a4/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/crypto v0.0.0-20190820162420-60c769a6c586/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
 golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc=
 golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
@@ -85,6 +90,10 @@ golang.org/x/sys v0.0.0-20210113181707-4bcb84eeeb78 h1:nVuTkr9L6Bq62qpUqKo/RnZCF
 golang.org/x/sys v0.0.0-20210113181707-4bcb84eeeb78/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
+golang.org/x/text v0.3.3 h1:cokOdA+Jmi5PJGXLlLllQSgYigAEfHXJAERHVMaCc2k=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.5 h1:i6eZZ+zk0SOf0xgBpEpPD18qWcJda6q1sxt3S0kzyUQ=
+golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
 golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=

diff --git a/internal/pkg/scanner/scan.go b/internal/pkg/scanner/scan.go
@@ -4,9 +4,9 @@ import (
 	"bufio"
 	"fmt"
 	"io"
-	"os"
 	"strings"
 
+	"github.com/spf13/afero"
 	"go.uber.org/zap"
 	"golang.org/x/tools/godoc/util"
 )
@@ -15,7 +15,7 @@ func ScanReader(
 	z *zap.SugaredLogger,
 	cfg BracketConfig,
 	r io.ReadSeeker,
-	f func(*RawElement) error, // will not include path.
+	f func(*RawElement) error, // will not include path. path is filled in [# .fill-path #].
 ) error {
 	re, err := cfg.Regexp()
 	if err != nil {
@@ -77,12 +77,17 @@ func ScanReader(
 }
 
 func ScanFile(
+	fs afero.Fs,
 	z *zap.SugaredLogger,
 	cfg BracketConfig,
 	path string,
 	f func(*RawElement) error,
 ) error {
-	fp, err := os.Open(path)
+	if fs == nil {
+		fs = afero.NewOsFs()
+	}
+
+	fp, err := fs.Open(path)
 	if err != nil {
 		return fmt.Errorf("open %q: %w", path, err)
 	}
@@ -94,7 +99,7 @@ func ScanFile(
 		cfg,
 		fp,
 		func(e *RawElement) error {
-			e.Loc.Path = path
+			e.Loc.Path = path // [# .fill-path #]
 			return f(e)
 		},
 	)

diff --git a/internal/pkg/scanner/scanner.go b/internal/pkg/scanner/scanner.go
@@ -3,13 +3,17 @@ package scanner
 import (
 	"fmt"
 	"os"
-	"path/filepath"
 	"strings"
 
+	"github.com/spf13/afero"
 	"go.uber.org/zap"
 )
 
-func NewScanner(z *zap.SugaredLogger, cfg Config) (func(root string, f func(*RawElement) error) ([]*RawElement, error), error) {
+func NewScanner(fs afero.Fs, z *zap.SugaredLogger, cfg Config) (func(root string, f func(*RawElement) error) ([]*RawElement, error), error) {
+	if fs == nil {
+		fs = afero.NewOsFs()
+	}
+
 	filter, err := NewFilter(z, cfg)
 	if err != nil {
 		return nil, err
@@ -22,7 +26,7 @@ func NewScanner(z *zap.SugaredLogger, cfg Config) (func(root string, f func(*Raw
 
 		var elems []*RawElement
 
-		if err := filepath.Walk(root, func(path string, fi os.FileInfo, err error) error {
+		if err := afero.Walk(fs, root, func(path string, fi os.FileInfo, err error) error {
 			z := z.With("path", path)
 
 			if err != nil {
@@ -35,7 +39,7 @@ func NewScanner(z *zap.SugaredLogger, cfg Config) (func(root string, f func(*Raw
 
 			stopped := false
 
-			if err := ScanFile(z, cfg.Bracket, path, func(elem *RawElement) error {
+			if err := ScanFile(fs, z, cfg.Bracket, path, func(elem *RawElement) error {
 				if strings.HasPrefix(elem.Text, "%") {
 					switch elem.Text[1:] {
 					case "stop":