Refactor gitignore

pkg/config/config.go

@@ -2,12 +2,11 @@ package config
 
 import (
 	"io/ioutil"
-	"strings"
 
+	"github.com/caitlinelfring/woke/pkg/ignore"
 	"github.com/caitlinelfring/woke/pkg/rule"
 	"github.com/caitlinelfring/woke/pkg/util"
 
-	gitignore "github.com/sabhiram/go-gitignore"
 	"gopkg.in/yaml.v2"
 )
 
@@ -16,15 +15,11 @@ type Config struct {
 	Rules       []*rule.Rule `yaml:"rules"`
 	IgnoreFiles []string     `yaml:"ignore_files"`
 
-	_gitIgnore      *gitignore.GitIgnore
 	hasAbsolutePath bool
 
-	files []string
-}
+	ignoreMatcherFunc func(string) bool
 
-// DefaultIgnore is the default list of file globs that will be ignored
-var DefaultIgnore = []string{
-	".git",
+	files []string
 }
 
 func NewConfig(filename string) (*Config, error) {
@@ -38,8 +33,11 @@ func NewConfig(filename string) (*Config, error) {
 	c.AddDefaultRules()
 
 	// Ignore the config filename, it will always match on its own rules
-	c.IgnoreFiles = append(c.IgnoreFiles, filename)
-	c.compileIgnoreGlobs()
+	ignorer, err := ignore.NewIgnore(append(c.IgnoreFiles, filename))
+	if err != nil {
+		return &c, err
+	}
+	c.ignoreMatcherFunc = ignorer.Match
 
 	return &c, nil
 }
@@ -49,25 +47,13 @@ func (c *Config) SetFiles(fileGlobs []string) {
 	allFiles, hasAbsolutePath, _ := util.GetFilesInGlobs(fileGlobs)
 	c.hasAbsolutePath = hasAbsolutePath
 	for _, f := range allFiles {
-		if c._gitIgnore.MatchesPath(f) {
+		if c.ignoreMatcherFunc(f) {
 			continue
 		}
 		c.files = append(c.files, f)
 	}
 }
 
-// compileIgnoreGlobs pre-compiles globs
-// See https://github.com/gobwas/glob#performance
-func (c *Config) compileIgnoreGlobs() {
-	ignoreLines := []string{}
-	if buffer, err := ioutil.ReadFile(".gitignore"); err == nil {
-		ignoreLines = append(ignoreLines, strings.Split(string(buffer), "\n")...)
-	}
-	ignoreLines = append(ignoreLines, c.IgnoreFiles...)
-	ignoreLines = append(ignoreLines, DefaultIgnore...)
-	c._gitIgnore, _ = gitignore.CompileIgnoreLines(ignoreLines...)
-}
-
 // GetFiles returns files that may be parsed
 func (c *Config) GetFiles() []string {
 	return c.files

pkg/ignore/ignore.go

@@ -0,0 +1,42 @@
+package ignore
+
+import (
+	"io/ioutil"
+	"strings"
+
+	gitignore "github.com/sabhiram/go-gitignore"
+)
+
+// DefaultIgnores is the default list of file globs that will be ignored
+var DefaultIgnores = []string{
+	".git",
+}
+
+type Ignore struct {
+	compiled *gitignore.GitIgnore
+}
+
+// NewIgnore produces an Ignore object, with compiled lines from .gitignore and DefaultIgnores
+// which you can match files against
+func NewIgnore(lines []string) (*Ignore, error) {
+	compiled, err := compileIgnoreLines(lines)
+	if err != nil {
+		return nil, err
+	}
+	return &Ignore{compiled: compiled}, nil
+}
+
+// Match returns true if the provided file matches any of the defined ignores
+func (i *Ignore) Match(f string) bool {
+	return i.compiled.MatchesPath(f)
+}
+
+func compileIgnoreLines(lines []string) (*gitignore.GitIgnore, error) {
+	lines = append(lines, DefaultIgnores...)
+
+	if buffer, err := ioutil.ReadFile(".gitignore"); err == nil {
+		lines = append(lines, strings.Split(string(buffer), "\n")...)
+	}
+
+	return gitignore.CompileIgnoreLines(lines...)
+}