refactor: let 'volt migrate plugconf/config-func' use JSON DSL

Author: tyru

dsl/ops/func_migrate_plugconf_config_func.go

@@ -0,0 +1,107 @@
+package ops
+
+import (
+	"bytes"
+	"context"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/pkg/errors"
+	"github.com/vim-volt/volt/config"
+	"github.com/vim-volt/volt/dsl/dslctx"
+	"github.com/vim-volt/volt/dsl/ops/util"
+	"github.com/vim-volt/volt/dsl/types"
+	"github.com/vim-volt/volt/lockjson"
+	"github.com/vim-volt/volt/pathutil"
+	"github.com/vim-volt/volt/plugconf"
+	"github.com/vim-volt/volt/subcmd/builder"
+)
+
+func init() {
+	opsMap[MigratePlugconfConfigFuncOp.String()] = MigratePlugconfConfigFuncOp
+}
+
+type migratePlugconfConfigFuncOp struct {
+	funcBase
+}
+
+// MigratePlugconfConfigFuncOp is "migrate/plugconf/config-func" operator
+var MigratePlugconfConfigFuncOp = &migratePlugconfConfigFuncOp{
+	funcBase("migrate/plugconf/config-func"),
+}
+
+func (*migratePlugconfConfigFuncOp) Bind(args ...types.Value) (types.Expr, error) {
+	if err := util.Signature().Check(args); err != nil {
+		return nil, err
+	}
+	retType := types.VoidType
+	return types.NewExpr(MigratePlugconfConfigFuncOp, args, retType), nil
+}
+
+func (*migratePlugconfConfigFuncOp) InvertExpr(_ context.Context, args []types.Value) (types.Value, error) {
+	return MigratePlugconfConfigFuncOp.Bind(args...)
+}
+
+func (*migratePlugconfConfigFuncOp) EvalExpr(ctx context.Context, args []types.Value) (_ types.Value, rollback func(), result error) {
+	rollback = NoRollback
+	lockJSON := ctx.Value(dslctx.LockJSONKey).(*lockjson.LockJSON)
+	cfg := ctx.Value(dslctx.ConfigKey).(*config.Config)
+
+	parseResults, parseErr := plugconf.ParseMultiPlugconf(lockJSON.Repos)
+	if parseErr.HasErrs() {
+		var errMsg bytes.Buffer
+		errMsg.WriteString("Please fix the following errors before migration:")
+		for _, err := range parseErr.Errors().Errors {
+			for _, line := range strings.Split(err.Error(), "\n") {
+				errMsg.WriteString("  ")
+				errMsg.WriteString(line)
+			}
+		}
+		result = errors.New(errMsg.String())
+		return
+	}
+
+	type plugInfo struct {
+		path    string
+		content []byte
+	}
+	infoList := make([]plugInfo, 0, len(lockJSON.Repos))
+
+	// Collects plugconf infomations and check errors
+	parseResults.Each(func(reposPath pathutil.ReposPath, info *plugconf.ParsedInfo) {
+		if !info.ConvertConfigToOnLoadPreFunc() {
+			return // no s:config() function
+		}
+		content, err := info.GeneratePlugconf()
+		if err != nil {
+			result = errors.Wrap(err, "could not generate converted plugconf")
+			return
+		}
+		infoList = append(infoList, plugInfo{
+			path:    reposPath.Plugconf(),
+			content: content,
+		})
+	})
+	if result != nil {
+		return
+	}
+
+	// After checking errors, write the content to files
+	for _, info := range infoList {
+		os.MkdirAll(filepath.Dir(info.path), 0755)
+		err := ioutil.WriteFile(info.path, info.content, 0644)
+		if err != nil {
+			result = errors.Wrapf(err, "could not write to file %s", info.path)
+			return
+		}
+	}
+
+	// Build ~/.vim/pack/volt dir
+	result = builder.Build(false, lockJSON, cfg)
+	if result != nil {
+		result = errors.Wrap(result, "could not build "+pathutil.VimVoltDir())
+	}
+	return
+}

migration/plugconf-config-func.go

@@ -1,19 +1,14 @@
 package migration
 
 import (
-	"io/ioutil"
-	"os"
-	"path/filepath"
-	"strings"
+	"context"
 
 	"github.com/pkg/errors"
 	"github.com/vim-volt/volt/config"
+	"github.com/vim-volt/volt/dsl"
+	"github.com/vim-volt/volt/dsl/dslctx"
+	"github.com/vim-volt/volt/dsl/ops"
 	"github.com/vim-volt/volt/lockjson"
-	"github.com/vim-volt/volt/logger"
-	"github.com/vim-volt/volt/pathutil"
-	"github.com/vim-volt/volt/plugconf"
-	"github.com/vim-volt/volt/subcmd/builder"
-	"github.com/vim-volt/volt/transaction"
 )
 
 func init() {
@@ -41,63 +36,11 @@ Description
 }
 
 func (*plugconfConfigMigrater) Migrate(lockJSON *lockjson.LockJSON, cfg *config.Config) (result error) {
-	results, parseErr := plugconf.ParseMultiPlugconf(lockJSON.Repos)
-	if parseErr.HasErrs() {
-		logger.Error("Please fix the following errors before migration:")
-		for _, err := range parseErr.Errors().Errors {
-			for _, line := range strings.Split(err.Error(), "\n") {
-				logger.Errorf("  %s", line)
-			}
-		}
-		return nil
-	}
-
-	type plugInfo struct {
-		path    string
-		content []byte
-	}
-	infoList := make([]plugInfo, 0, len(lockJSON.Repos))
-
-	// Collects plugconf infomations and check errors
-	results.Each(func(reposPath pathutil.ReposPath, info *plugconf.ParsedInfo) {
-		if !info.ConvertConfigToOnLoadPreFunc() {
-			return // no s:config() function
-		}
-		content, err := info.GeneratePlugconf()
-		if err != nil {
-			logger.Errorf("Could not generate converted plugconf: %s", err)
-			return
-		}
-		infoList = append(infoList, plugInfo{
-			path:    reposPath.Plugconf(),
-			content: content,
-		})
-	})
-
-	// After checking errors, write the content to files
-	for _, info := range infoList {
-		os.MkdirAll(filepath.Dir(info.path), 0755)
-		err := ioutil.WriteFile(info.path, info.content, 0644)
-		if err != nil {
-			return err
-		}
-	}
-
-	// Begin transaction
-	trx, err := transaction.Start()
-	if err != nil {
-		return err
-	}
-	defer func() {
-		if err := trx.Done(); err != nil {
-			result = err
-		}
-	}()
-
-	// Build ~/.vim/pack/volt dir
-	err = builder.Build(false, lockJSON, cfg)
+	ctx := dslctx.WithDSLValues(context.Background(), lockJSON, cfg)
+	expr, err := ops.MigratePlugconfConfigFuncOp.Bind()
 	if err != nil {
-		return errors.Wrap(err, "could not build "+pathutil.VimVoltDir())
+		return errors.Wrapf(err, "cannot bind %s operator", ops.LockJSONWriteOp.String())
 	}
-	return nil
+	_, err = dsl.Execute(ctx, expr)
+	return err
 }