Clarify talismanrc method notes and names

Authored-by: Owen Nelson <[email protected]>

Author: tw-owen-nelson

talismanrc/rc_file.go

@@ -20,16 +20,17 @@ var (
 	currentRCFileName = DefaultRCFileName
 )
 
+// Load creates a TalismanRC struct based on a .talismanrc file, if present
 func Load() (*TalismanRC, error) {
 	fileContents, err := afero.ReadFile(fs, currentRCFileName)
 	if err != nil {
 		// File does not exist or is not readable, proceed as if there is no .talismanrc
 		fileContents = []byte{}
 	}
-	return newPersistedRC(fileContents)
+	return talismanRCFromYaml(fileContents)
 }
 
-func newPersistedRC(fileContents []byte) (*TalismanRC, error) {
+func talismanRCFromYaml(fileContents []byte) (*TalismanRC, error) {
 	talismanRCFromFile := TalismanRC{}
 	err := yaml.Unmarshal(fileContents, &talismanRCFromFile)
 	if err != nil {

talismanrc/rc_file_test.go

@@ -59,7 +59,7 @@ fileignoreconfig:
 custom_patterns:
 - 'pwd_[a-z]{8,20}'`)
 
-		rc, err := newPersistedRC(fileContents)
+		rc, err := talismanRCFromYaml(fileContents)
 		assert.Nil(t, err, "Should successfully unmarshal valid yaml")
 		assert.Equal(t, 1, len(rc.FileIgnoreConfig))
 		assert.Equal(t, 1, len(rc.CustomPatterns))
@@ -75,7 +75,7 @@ fileignoreconfig:
 - filename: testfile_3.yml
   checksum: file3_checksum`)
 
-		rc, _ := newPersistedRC(fileContent)
+		rc, _ := talismanRCFromYaml(fileContent)
 		assert.Equal(t, 3, len(rc.FileIgnoreConfig))
 
 		assert.Equal(t, rc.FileIgnoreConfig[0].GetFileName(), "testfile_1.yml")
@@ -88,7 +88,7 @@ fileignoreconfig:
 
 	t.Run("Should read severity level", func(t *testing.T) {
 		talismanRCContents := []byte("threshold: high")
-		persistedTalismanrc, _ := newPersistedRC(talismanRCContents)
+		persistedTalismanrc, _ := talismanRCFromYaml(talismanRCContents)
 		assert.Equal(t, persistedTalismanrc.Threshold, severity.High)
 	})
 
@@ -98,15 +98,15 @@ custom_severities:
 - detector: Base64Content
   severity: low
 `)
-		talismanRC, _ := newPersistedRC(talismanRCContents)
+		talismanRC, _ := talismanRCFromYaml(talismanRCContents)
 		assert.Equal(t, talismanRC.CustomSeverities, []CustomSeverityConfig{{Detector: "Base64Content", Severity: severity.Low}})
 	})
 }
 
 func TestShouldIgnoreUnformattedFiles(t *testing.T) {
 	for _, s := range []string{"#", "#monkey", "# this monkey likes bananas  "} {
 		fileContents := []byte(s)
-		talismanRC, err := newPersistedRC(fileContents)
+		talismanRC, err := talismanRCFromYaml(fileContents)
 		assert.Nil(t, err, "Should successfully unmarshal commented yaml")
 		assert.Equal(t, &TalismanRC{Version: "1.0"}, talismanRC, "Expected commented line '%s' to result in an empty TalismanRC")
 	}

talismanrc/talismanrc.go

@@ -23,15 +23,15 @@ type TalismanRC struct {
 	Version          string                 `yaml:"version"`
 }
 
-// SuggestRCFor returns the talismanRC file content corresponding to input ignore configs
+// SuggestRCFor returns a string representation of a .talismanrc for the specified FileIgnoreConfigs
 func SuggestRCFor(configs []FileIgnoreConfig) string {
 	tRC := TalismanRC{FileIgnoreConfig: configs, Version: DefaultRCVersion}
 	result, _ := yaml.Marshal(tRC)
 
 	return string(result)
 }
 
-// Accept answers true if the Addition.Path is configured to be checked by the detectors
+// Accept answers true if the Addition should be checked by the specified detector
 func (tRC *TalismanRC) Accept(addition gitrepo.Addition, detectorName string) bool {
 	return !tRC.Deny(addition, detectorName)
 }
@@ -62,6 +62,7 @@ func (tRC *TalismanRC) FilterAdditions(additions []gitrepo.Addition) []gitrepo.A
 	return result
 }
 
+// AddIgnores inserts the specified FileIgnoreConfigs to an existing .talismanrc file, or creates one if it doesn't exist.
 func (tRC *TalismanRC) AddIgnores(entriesToAdd []FileIgnoreConfig) {
 	if len(entriesToAdd) > 0 {
 		logr.Debugf("Adding entries: %v", entriesToAdd)
@@ -112,7 +113,7 @@ func combineFileIgnores(exsiting, incoming []FileIgnoreConfig) []FileIgnoreConfi
 	return result
 }
 
-// Deny answers true if the Addition.Path is configured to be ignored and not checked by the detectors
+// Deny answers true if the Addition should NOT be checked by the specified detector
 func (tRC *TalismanRC) Deny(addition gitrepo.Addition, detectorName string) bool {
 	for _, pattern := range tRC.effectiveRules(detectorName) {
 		if addition.Matches(pattern) {
@@ -122,7 +123,7 @@ func (tRC *TalismanRC) Deny(addition gitrepo.Addition, detectorName string) bool
 	return false
 }
 
-// Strip git addition
+// Remove globally- and per-file allowed patterns from an Addition
 func (tRC *TalismanRC) FilterAllowedPatternsFromAddition(addition gitrepo.Addition) string {
 	additionPathAsString := string(addition.Path)
 	// Processing global allowed patterns