Mark dotfiles which have expanded envs

Author: evanpurkhiser

config/config.go

@@ -68,10 +68,6 @@ type SourceConfig struct {
 	// environment variables. These generally look like: ${HOME}. This
 	// configuration is useful for config files that do not support environment
 	// variable expansion.
-	//
-	// TODO: Decide if this is actually something we want to implement. It
-	//       makes diffing a bit harder since we can't straight compare the
-	//       file size for single files anymore.
 	ExpandEnvironment []string `yaml:"expand_environment"`
 }
 

resolver/resolver.go

@@ -24,6 +24,7 @@ type Dotfile struct {
 	Path         string
 	Removed      bool
 	Added        bool
+	ExpandEnv    bool
 	Sources      []*SourceFile
 	InstallFiles []string
 }
@@ -185,7 +186,7 @@ func resolveOverrides(dotfiles dotfileMap, overrideSuffix string) {
 }
 
 // resolveInstalls looks for dotfiles ending in the installSuffix and will map
-// them to the dorfile theyare named after, or any dotfile's that exist within
+// them to the dorfile they are named after, or any dotfile's that exist within
 // the directory they are named after.
 func resolveInstalls(dotfiles dotfileMap, installSuffix string) {
 	for path, dotfile := range dotfiles {
@@ -233,6 +234,16 @@ func resolveRemoved(dotfiles dotfileMap, oldDotfiles []string) {
 	}
 }
 
+func resolveExpandEnv(dotfiles dotfileMap, expandPaths []string) {
+	for _, expandTarget := range expandPaths {
+		for path, dotfile := range dotfiles {
+			if expandTarget == path {
+				dotfile.ExpandEnv = true
+			}
+		}
+	}
+}
+
 // sourceLoader provides a list of files given a source path.
 var sourceLoader = func(sourcePath string) []string {
 	sources := []string{}
@@ -271,5 +282,8 @@ func ResolveDotfiles(conf config.SourceConfig, lockfile config.SourceLockfile) D
 	resolveInstalls(dotfiles, "."+conf.InstallSuffix)
 	resolveRemoved(dotfiles, lockfile.InstalledFiles)
 
+	// Mark dotfiles which will have environment expansion
+	resolveExpandEnv(dotfiles, conf.ExpandEnvironment)
+
 	return dotfiles.asList()
 }

resolver/resolver_test.go

@@ -15,6 +15,7 @@ func TestResolveDotfiles(t *testing.T) {
 		SourceFiles    []string
 		ExistingFiles  []string
 		Groups         []string
+		ExpandEnv      []string
 		OverrideSuffix string
 		InstallSuffix  string
 		Expected       Dotfiles
@@ -54,6 +55,7 @@ func TestResolveDotfiles(t *testing.T) {
 			},
 			ExistingFiles:  []string{"bash/conf", "environment"},
 			Groups:         []string{"base", "machines/desktop", "machines/server"},
+			ExpandEnv:      []string{"generic-config"},
 			OverrideSuffix: "ovrd",
 			InstallSuffix:  "inst",
 			Expected: Dotfiles{
@@ -105,8 +107,9 @@ func TestResolveDotfiles(t *testing.T) {
 					},
 				},
 				{
-					Path:  "generic-config",
-					Added: true,
+					Path:      "generic-config",
+					ExpandEnv: true,
+					Added:     true,
 					Sources: []*SourceFile{
 						{
 							Group: "base",
@@ -260,8 +263,8 @@ func TestResolveDotfiles(t *testing.T) {
 		},
 	}
 
-	ogSourceLoader := sourceLoader
-	defer func() { sourceLoader = ogSourceLoader }()
+	origSourceLoader := sourceLoader
+	defer func() { sourceLoader = origSourceLoader }()
 
 	for _, test := range tests {
 		if test.OverrideSuffix == "" {
@@ -273,9 +276,10 @@ func TestResolveDotfiles(t *testing.T) {
 		}
 
 		conf := config.SourceConfig{
-			BaseGroups:     []string{},
-			OverrideSuffix: test.OverrideSuffix,
-			InstallSuffix:  test.InstallSuffix,
+			BaseGroups:        []string{},
+			OverrideSuffix:    test.OverrideSuffix,
+			InstallSuffix:     test.InstallSuffix,
+			ExpandEnvironment: test.ExpandEnv,
 		}
 
 		lockfile := config.SourceLockfile{