add support for patterns from config file

Author: seletskiy

compile_format_option.go renamed to compile_format.go

@@ -8,12 +8,22 @@ import (
 	"github.com/reconquest/hierr-go"
 )
 
-func CompileFormatOption(
-	args map[string]interface{},
-) (*Format, error) {
-	value := args["--format"].(string)
+var (
+	// because we can have specific formats for different file types defined
+	// in config file, we need to cache templates to prevent overhead in
+	// runtime
+	compiledFormatsCache = map[string]*Format{}
+)
+
+func compileFormat(definition string) (*Format, error) {
+	if format, ok := compiledFormatsCache[definition]; ok {
+		return format, nil
+	}
 
-	value = strings.NewReplacer(`\n`, "\n", `\t`, "\t").Replace(value)
+	definition = strings.NewReplacer(
+		`\n`, "\n",
+		`\t`, "\t",
+	).Replace(definition)
 
 	funcs := template.FuncMap{
 		"name": func(path string) string {
@@ -30,18 +40,22 @@ func CompileFormatOption(
 		err    error
 	)
 
-	format.Template, err = template.New("format").Funcs(funcs).Parse(value)
+	format.Template, err = template.New("format").Funcs(funcs).Parse(
+		definition,
+	)
 	if err != nil {
 		return nil, NewError(
 			hierr.Errorf(
 				err,
-				"failed to compile template for --format option",
+				"failed to compile format template",
 			),
 
 			"Check template syntax accordingly to text/template "+
 				"documentation:\n\thttps://golang.org/pkg/text/template/",
 		)
 	}
 
+	compiledFormatsCache[definition] = &format
+
 	return &format, nil
 }

config.go

@@ -3,17 +3,33 @@ package main
 import (
 	"os"
 
+	"github.com/gobwas/glob"
+	"github.com/imdario/mergo"
 	"github.com/kovetskiy/ko"
+	hierr "github.com/reconquest/hierr-go"
 	yaml "gopkg.in/yaml.v2"
 )
 
+type FileConfig struct {
+	Pull struct {
+		Format string
+	}
+
+	Push struct {
+		Type       string
+		Directives map[string]string
+	}
+}
+
 type Config struct {
 	UserID    string `yaml:"user_id",required:"true"`
 	Secret    string `yaml:"secret",required:"true"`
 	AccountID string `yaml:"account_id"`
 	ProjectID string `yaml:"project_id"`
 	Threads   int    `yaml:"threads"`
 
+	Files map[string]FileConfig `yaml:"files"`
+
 	path string
 }
 
@@ -33,3 +49,43 @@ func NewConfig(path string) (Config, error) {
 
 	return config, nil
 }
+
+func (config *Config) GetFileConfig(path string) (FileConfig, error) {
+	var match *FileConfig
+
+	for key, candidate := range config.Files {
+		pattern, err := glob.Compile(key, '/')
+		if err != nil {
+			return FileConfig{}, NewError(
+				hierr.Errorf(
+					err,
+					`unable to compile pattern from config file (key "%s")`,
+					key,
+				),
+
+				`File match pattern is malformed. Check out help for more `+
+					`information on globbing patterns.`,
+			)
+		}
+
+		if pattern.Match(path) {
+			match = &candidate
+		}
+	}
+
+	defaults := config.Files["default"]
+
+	if match == nil {
+		return defaults, nil
+	}
+
+	err := mergo.Merge(match, defaults)
+	if err != nil {
+		return FileConfig{}, NewError(
+			hierr.Errorf(err, "unable to merge file config options"),
+			`It's internal error. Consider reporting bug.`,
+		)
+	}
+
+	return *match, nil
+}

do_files_list.go

@@ -24,7 +24,7 @@ func doFilesList(
 		args["--format"] = defaultFilesListFormat
 	}
 
-	format, err := CompileFormatOption(args)
+	format, err := compileFormat(args["--format"].(string))
 	if err != nil {
 		return err
 	}

do_files_pull.go

@@ -10,21 +10,14 @@ func doFilesPull(
 	args map[string]interface{},
 ) error {
 	var (
-		directory = args["--directory"].(string)
-		project   = args["--project"].(string)
-		uri, _    = args["<uri>"].(string)
-		source    = args["--source"].(bool)
+		project = args["--project"].(string)
+		uri, _  = args["<uri>"].(string)
 	)
 
 	if args["--format"] == nil {
 		args["--format"] = defaultFilePullFormat
 	}
 
-	format, err := CompileFormatOption(args)
-	if err != nil {
-		return err
-	}
-
 	files, err := globFiles(client, project, uri)
 	if err != nil {
 		return err
@@ -36,14 +29,7 @@ func doFilesPull(
 		// func closure required to pass different file objects to goroutines
 		func(file smartling.File) {
 			pool.Do(func() {
-				err := downloadFileTranslations(
-					client,
-					project,
-					file,
-					format,
-					directory,
-					source,
-				)
+				err := downloadFileTranslations(client, config, args, file)
 
 				if err != nil {
 					logger.Error(err)

do_files_status.go

@@ -18,13 +18,15 @@ func doFilesStatus(
 		project   = args["--project"].(string)
 		uri, _    = args["<uri>"].(string)
 		directory = args["--directory"].(string)
+
+		defaultFormat, _ = args["--format"].(string)
 	)
 
-	if args["--format"] == nil {
-		args["--format"] = defaultFileStatusFormat
+	if defaultFormat == "" {
+		defaultFormat = defaultFileStatusFormat
 	}
 
-	format, err := CompileFormatOption(args)
+	info, err := client.GetProjectDetails(project)
 	if err != nil {
 		return err
 	}
@@ -34,68 +36,73 @@ func doFilesStatus(
 		return err
 	}
 
-	var (
-		table = NewTableWriter(os.Stdout)
-	)
+	var table = NewTableWriter(os.Stdout)
 
 	for _, file := range files {
-		path, err := format.Execute(map[string]interface{}{
-			"FileURI": file.FileURI,
-		})
-		if err != nil {
-			return err
-		}
-
 		status, err := client.GetFileStatus(project, file.FileURI)
 		if err != nil {
 			return err
 		}
 
-		path = filepath.Join(directory, path)
-
-		state := "source"
-		if !isFileExists(path) {
-			state = "missing"
-		}
-
-		writeFileStatus(table, map[string]string{
-			"Path":     path,
-			"State":    state,
-			"Progress": "source",
-			"Strings":  fmt.Sprint(status.TotalStringCount),
-			"Words":    fmt.Sprint(status.TotalWordCount),
-		})
-
-		for _, locale := range status.Items {
-			path, err := format.Execute(map[string]interface{}{
-				"FileURI": file.FileURI,
-				"Locale":  locale.LocaleID,
-			})
+		translations := status.Items
+
+		translations = append(
+			[]smartling.FileStatusTranslation{
+				{
+					CompletedStringCount: status.TotalStringCount,
+					CompletedWordCount:   status.TotalWordCount,
+				},
+			},
+			translations...,
+		)
+
+		for _, translation := range translations {
+			path, err := executeFileFormat(
+				config,
+				file,
+				defaultFormat,
+				usePullFormat,
+				map[string]interface{}{
+					"FileURI": file.FileURI,
+					"Locale":  translation.LocaleID,
+				},
+			)
 			if err != nil {
 				return err
 			}
 
 			path = filepath.Join(directory, path)
 
-			state := "remote"
-			if !isFileExists(path) {
-				state = "missing"
-			}
+			var (
+				locale   = info.SourceLocaleID
+				state    = "source"
+				progress = "source"
+			)
 
-			writeFileStatus(table, map[string]string{
-				"Path":   path,
-				"Locale": locale.LocaleID,
-				"State":  state,
-				"Progress": fmt.Sprintf(
+			if translation.LocaleID != "" {
+				locale = translation.LocaleID
+				state = "remote"
+				progress = fmt.Sprintf(
 					"%d%%",
 					int(
 						100*
-							float64(locale.CompletedStringCount)/
+							float64(translation.CompletedStringCount)/
 							float64(status.TotalStringCount),
 					),
-				),
-				"Strings": fmt.Sprint(locale.CompletedStringCount),
-				"Words":   fmt.Sprint(locale.CompletedWordCount),
+				)
+			}
+
+			if !isFileExists(path) {
+				state = "missing"
+			}
+
+			writeFileStatus(table, map[string]string{
+				"Path":     path,
+				"Locale":   locale,
+				"State":    state,
+				"Progress": progress,
+				"Strings":  fmt.Sprint(translation.CompletedStringCount),
+				"Words":    fmt.Sprint(translation.CompletedWordCount),
 			})
 		}
 	}

download_file_translations.go

@@ -10,12 +10,22 @@ import (
 
 func downloadFileTranslations(
 	client *smartling.Client,
-	project string,
+	config Config,
+	args map[string]interface{},
 	file smartling.File,
-	format *Format,
-	directory string,
-	original bool,
 ) error {
+	var (
+		project   = args["--project"].(string)
+		directory = args["--directory"].(string)
+		source    = args["--source"].(bool)
+
+		defaultFormat, _ = args["--format"].(string)
+	)
+
+	if defaultFormat == "" {
+		defaultFormat = defaultFileStatusFormat
+	}
+
 	status, err := client.GetFileStatus(project, file.FileURI)
 	if err != nil {
 		return hierr.Errorf(
@@ -28,14 +38,18 @@ func downloadFileTranslations(
 
 	translations := status.Items
 
-	if original {
+	if source {
 		translations = append(translations, smartling.FileStatusTranslation{
 			LocaleID: "",
 		})
 	}
 
 	for _, locale := range translations {
-		path, err := format.Execute(
+		path, err := executeFileFormat(
+			config,
+			file,
+			defaultFormat,
+			usePullFormat,
 			map[string]interface{}{
 				"FileURI": file.FileURI,
 				"Locale":  locale.LocaleID,