Add comments, add tests

Author: andrey

generators/testdata/consts.go

@@ -13,6 +13,7 @@ const (
 	PackageDB         = "db"
 	PackageVT         = "vt"
 	PackageVTTemplate = "vt-template"
+	PackageVTUpdated  = "vt-updated"
 
 	PrefixAll    = "all"
 	PrefixEntity = "entities"
@@ -21,14 +22,13 @@ const (
 var (
 	PathActual   = filepath.Join(DirParent, DirTestdata, "actual")
 	PathExpected = filepath.Join(DirParent, DirTestdata, "expected")
-	PathUpdated  = filepath.Join(DirParent, DirTestdata, "updated")
 
 	PathActualMFD                = filepath.Join(PathActual, FilenameMFD)
 	PathExpectedMFD              = filepath.Join(PathExpected, FilenameMFD)
 	PathActualDB                 = filepath.Join(PathActual, PackageDB)
 	PathExpectedDB               = filepath.Join(PathExpected, PackageDB)
 	PathActualVT                 = filepath.Join(PathActual, PackageVT)
-	PathUpdatedVT                = filepath.Join(PathUpdated, PackageVT)
+	PathUpdatedVT                = filepath.Join(PathActual, PackageVTUpdated)
 	PathExpectedVT               = filepath.Join(PathExpected, PackageVT)
 	PathActualVTTemplateAll      = filepath.Join(PathActual, PackageVTTemplate, PrefixAll)
 	PathExpectedVTTemplateAll    = filepath.Join(PathExpected, PackageVTTemplate, PrefixAll)

generators/testdata/updated/vt/portal_actual.txt renamed to generators/testdata/expected/vt-updated/portal.go

@@ -211,6 +211,8 @@ func (s NewsService) dbSort(ops *ViewOps) db.OpFunc {
 		v = db.WithSort(db.NewSortField(ops.SortColumn, ops.SortDesc))
 	}
 
+	//data
+
 	return v
 }
 

generators/testdata/updated/vt/portal.go renamed to generators/testdata/expected/vt-updated/portal_actual.txt

@@ -52,6 +52,7 @@ func NewNewsSummary(in *db.News) *NewsSummary {
 		Category: NewCategorySummary(in.Category),
 		Status:   NewStatus(in.StatusID),
 	}
+	//data
 }
 
 func NewNews(in *db.News) *News {
@@ -74,6 +75,7 @@ func NewNews(in *db.News) *News {
 		Status:   NewStatus(in.StatusID),
 	}
 
+	//data
 	return news
 }
 

generators/testdata/updated/vt/portal_converter.go renamed to generators/testdata/expected/vt-updated/portal_converter.go

@@ -33,6 +33,7 @@ func (n *News) ToDB() *db.News {
 		StatusID:    n.StatusID,
 	}
 
+	//data
 	return news
 }
 
@@ -94,6 +95,7 @@ type News struct {
 
 	Category *CategorySummary `json:"category"`
 	Status   *Status          `json:"status"`
+	//data
 }
 
 func (ns *NewsSearch) ToDB() *db.NewsSearch {
@@ -112,6 +114,7 @@ func (ns *NewsSearch) ToDB() *db.NewsSearch {
 		StatusID:     ns.StatusID,
 		IDs:          ns.IDs,
 	}
+	//data
 }
 
 type NewsSearch struct {

generators/testdata/updated/vt/portal_converter_actual.txt renamed to generators/testdata/expected/vt-updated/portal_converter_actual.txt

@@ -243,6 +243,27 @@ func PrintServer(namespaces []*mfd.VTNamespace, tmpl string, options Options) er
 	return nil
 }
 
+// PartialUpdate updates parts of the project by generating model, converter, and service files based on specified templates.
+//
+// Parameters:
+//   - project: a pointer to the mfd.Project to be updated.
+//   - modelTemplate: the path to the model template file.
+//   - converterTemplate: the path to the converter template file.
+//   - serviceTemplate: the path to the service template file.
+//
+// Returns:
+//   - error: an error if there was an issue updating the files or at other stages.
+//
+// Example usage:
+//
+//		project := ... // initialize the project
+//		modelTemplate := "path/to/model_template.tmpl"
+//		converterTemplate := "path/to/converter_template.tmpl"
+//		serviceTemplate := "path/to/service_template.tmpl"
+//		err := g.PartialUpdate(project, modelTemplate, converterTemplate, serviceTemplate)
+//		if err != nil {
+//	    log.Fatal(err)
+//		}
 func (g *Generator) PartialUpdate(project *mfd.Project, modelTemplate, converterTemplate, serviceTemplate string) error {
 	for _, namespace := range g.options.Namespaces {
 		ns := project.VTNamespace(namespace)
@@ -297,7 +318,14 @@ func (g *Generator) PartialUpdate(project *mfd.Project, modelTemplate, converter
 	return nil
 }
 
-// TargetServiceEntityData validate contains entities in ns
+// TargetServiceEntityData filters and returns the model entity data that are located in the specified namespace.
+//
+// Parameters:
+//   - s: a ServiceNamespaceData object containing information about the namespace and its entities.
+//
+// Returns:
+//   - [ ] ServiceEntityData: an array of entity data that are located in the specified namespace.
+//   - error: an error if no entities were found or if some entities were not found in the specified namespace.
 func (g *Generator) TargetServiceEntityData(s ServiceNamespaceData) ([]ServiceEntityData, error) {
 	var ee []ServiceEntityData
 	le := len(g.options.Entities)
@@ -316,7 +344,14 @@ func (g *Generator) TargetServiceEntityData(s ServiceNamespaceData) ([]ServiceEn
 	return ee, nil
 }
 
-// TargetModelEntityData validate contains entities in modelData
+// TargetModelEntityData filters and returns the model entity data that are located in the specified namespace.
+//
+// Parameters:
+//   - s: a NamespaceData object containing information about the namespace and its entities.
+//
+// Returns:
+//   - [ ] EntityData: an array of entity data that are located in the specified namespace.
+//   - error: an error if no entities were found or if some entities were not found in the specified namespace.
 func (g *Generator) TargetModelEntityData(s NamespaceData) ([]EntityData, error) {
 	var ee []EntityData
 	le := len(g.options.Entities)

generators/testdata/updated/vt/portal_model.go renamed to generators/testdata/expected/vt-updated/portal_model.go

@@ -32,10 +32,18 @@ func getDataCommentCount(path string) int {
 
 // returnTestData function prepare test data
 func returnTestData() (err error) {
+	folderPath := testdata.PathActual + "/vt-updated/"
+	if _, err := os.Stat(folderPath); os.IsNotExist(err) {
+		err := os.Mkdir(folderPath, 0755)
+		if err != nil {
+			return err
+		}
+	}
+
 	ff := make(map[string]string)
-	ff[testdata.PathUpdated+"/vt/portal_actual.txt"] = testdata.PathUpdated + "/vt/portal.go"
-	ff[testdata.PathUpdated+"/vt/portal_model_actual.txt"] = testdata.PathUpdated + "/vt/portal_model.go"
-	ff[testdata.PathUpdated+"/vt/portal_converter_actual.txt"] = testdata.PathUpdated + "/vt/portal_converter.go"
+	ff[testdata.PathExpected+"/vt-updated/portal_actual.txt"] = testdata.PathExpected + "/vt-updated/portal.go"
+	ff[testdata.PathExpected+"/vt-updated/portal_model_actual.txt"] = testdata.PathExpected + "/vt-updated/portal_model.go"
+	ff[testdata.PathExpected+"/vt-updated/portal_converter_actual.txt"] = testdata.PathExpected + "/vt-updated/portal_converter.go"
 
 	for srcPath, destPath := range ff {
 		srcFile, err := os.Open(srcPath)
@@ -76,16 +84,17 @@ func TestGenerator_Generate(t *testing.T) {
 			_ = returnTestData()
 
 			// get count comment before used generator
-			startCountServiceComment := getDataCommentCount(testdata.PathUpdated + "/vt/portal.go")
-			startCountModelComment := getDataCommentCount(testdata.PathUpdated + "/vt/portal_model.go")
-			startCountConvertComment := getDataCommentCount(testdata.PathUpdated + "/vt/portal_converter.go")
+			startCountServiceComment := getDataCommentCount(testdata.PathExpected + "/vt-updated/portal.go")
+			startCountModelComment := getDataCommentCount(testdata.PathExpected + "/vt-updated/portal_model.go")
+			startCountConvertComment := getDataCommentCount(testdata.PathExpected + "/vt-updated/portal_converter.go")
 
+			// generate
 			generator := New()
 
 			generator.options.Def()
 			generator.options.Output = testdata.PathUpdatedVT
 			generator.options.MFDPath = testdata.PathExpectedMFD
-			generator.options.Package = testdata.PackageVT
+			generator.options.Package = testdata.PackageVTUpdated
 			generator.options.Namespaces = []string{"portal"}
 
 			// added entity what need updated
@@ -98,9 +107,9 @@ func TestGenerator_Generate(t *testing.T) {
 			So(err, ShouldBeNil)
 
 			// get count comment after used generator
-			endCountServiceComment := getDataCommentCount(testdata.PathUpdated + "/vt/portal.go")
-			endCountModelComment := getDataCommentCount(testdata.PathUpdated + "/vt/portal_model.go")
-			endCountConvertComment := getDataCommentCount(testdata.PathUpdated + "/vt/portal_converter.go")
+			endCountServiceComment := getDataCommentCount(testdata.PathUpdatedVT + "/portal.go")
+			endCountModelComment := getDataCommentCount(testdata.PathUpdatedVT + "/portal_model.go")
+			endCountConvertComment := getDataCommentCount(testdata.PathUpdatedVT + "/portal_converter.go")
 
 			// checked that after generate struct or function rewrite but not all
 			So(startCountServiceComment, ShouldNotEqual, endCountServiceComment)

generators/testdata/updated/vt/portal_model_actual.txt renamed to generators/testdata/expected/vt-updated/portal_model_actual.txt

@@ -380,5 +380,4 @@ const serverDefaultTemplate = `
 `
 
 const StructPattern = `type (\w+) struct {`
-
-const FuncPattern = `func (\w+)`
+const FuncPattern = `^func (\w+)`

generators/vt/generator.go

@@ -195,6 +195,25 @@ func FormatAndSave(data interface{}, output, tmpl string, format bool) (bool, er
 	return Save(buffer.Bytes(), output)
 }
 
+// renderTemplate generates data based on a template and returns it in a buffer.
+//
+// Parameters:
+//   - data: the data used to populate the template.
+//   - tmpl: the string containing the template for data generation.
+//
+// Returns:
+//   - bytes.Buffer: a buffer containing the generated data.
+//   - error: an error if there was an issue parsing or executing the template.
+//
+// Example usage:
+//
+//		data := ... // data for the template
+//		tmpl := "Template string with {{.}}"
+//		buffer, err := renderTemplate(data, tmpl)
+//		if err != nil {
+//	    log.Fatal(err)
+//		}
+//		fmt.Println("Rendered template:", buffer.String())
 func renderTemplate(data interface{}, tmpl string) (bytes.Buffer, error) {
 	var buffer bytes.Buffer
 	parsed, err := template.New("base").Funcs(TemplateFunctions).Parse(tmpl)
@@ -208,6 +227,32 @@ func renderTemplate(data interface{}, tmpl string) (bytes.Buffer, error) {
 	return buffer, nil
 }
 
+// replaceFragmentInFile replaces fragments of text in a file with new data if they match a given regular expression.
+//
+// Parameters:
+// - output: the path to the file where the replacement will take place.
+// - findData: the string to search for within the fragment to be replaced.
+// - newData: the string to replace the found fragment with.
+// - pattern: a pointer to a compiled regular expression used to find the fragments.
+//
+// Returns:
+//
+// - bool: true if the replacement was successful, and false otherwise.
+//
+// - error: an error if there was an issue reading the file or replacing the fragments.
+//
+// Example usage:
+//
+//		output := "path/to/file.txt"
+//		findData := "old text"
+//		newData := "new text"
+//		pattern := regexp.MustCompile(`pattern`)
+//		success, err := replaceFragmentInFile(output, findData, newData, pattern)
+//		if err != nil {
+//	    log.Fatal(err)
+//		}
+//
+// fmt.Println("Replacement successful:", success)
 func replaceFragmentInFile(output, findData, newData string, pattern *regexp.Regexp) (bool, error) {
 	content, err := os.ReadFile(output)
 	if err != nil {
@@ -245,7 +290,31 @@ func replaceFragmentInFile(output, findData, newData string, pattern *regexp.Reg
 	return util.FmtAndSave([]byte(newContent), output)
 }
 
-// extractFragments returned array with coordinates start and end text
+// extractFragments searches for fragments of text in the provided lines that match the given regular expression.
+// It returns an array of tuples, each containing the start and end coordinates of the text fragments found.
+//
+// Parameters:
+//
+// - re: a pointer to a compiled regular expression used to find matches in the lines.
+//
+// - lines: an array of strings to search for matching text fragments.
+//
+// Returns:
+//
+// - [][2]int: an array of tuples, each containing the start and end indices of the found text fragments.
+//
+// - error: an error if no matching fragments are found.
+//
+// Example usage:
+//
+//		re := regexp.MustCompile(`pattern`)
+//		lines := []string{"text1", "text2", "pattern", "text3", "}"}
+//		fragments, err := extractFragments(re, lines)
+//		if err != nil {
+//	    log.Fatal(err)
+//		}
+//
+// fmt.Println(fragments) // [[2, 5]]
 func extractFragments(re *regexp.Regexp, lines []string) ([][2]int, error) {
 	var (
 		reFragments [][2]int
@@ -255,12 +324,16 @@ func extractFragments(re *regexp.Regexp, lines []string) ([][2]int, error) {
 	for i, line := range lines {
 		if re.MatchString(line) {
 			if start != -1 {
+				// added fragment in slice
 				reFragments = append(reFragments, [2]int{start, i})
 			}
+			// first coordinate in fragment
 			start = i
 		}
 	}
 
+	// if the last fragment is not closed in the loop
+	// think that this fragment is to the end of the lines
 	if start != -1 {
 		reFragments = append(reFragments, [2]int{start, len(lines)})
 	}
@@ -287,14 +360,40 @@ func extractFragments(re *regexp.Regexp, lines []string) ([][2]int, error) {
 	return ff, nil
 }
 
+// UpdateFile updates a file by replacing specific fragments with new data generated from a template.
+//
+// Parameters:
+//   - data: the data used to populate the template.
+//   - output: the path to the file where the replacement will take place.
+//   - tmpl: the path to the template file.
+//   - pattern: a pointer to a compiled regular expression used to find the fragments.
+//
+// Returns:
+//   - bool: true if the update was successful, and false otherwise.
+//   - error: an error if there was an issue generating the data, replacing the fragments, or at other stages.
+//
+// Example usage:
+//
+//		data := ... // data for the template
+//		output := "path/to/file.txt"
+//		tmpl := "path/to/template.tmpl"
+//		pattern := regexp.MustCompile(`pattern`)
+//		success, err := UpdateFile(data, output, tmpl, pattern)
+//		if err != nil {
+//	    log.Fatal(err)
+//		}
+//
+// fmt.Println("Update successful:", success)
 func UpdateFile(data interface{}, output, tmpl string, pattern *regexp.Regexp) (bool, error) {
 	buffer, err := renderTemplate(data, tmpl)
 	if err != nil {
 		return false, fmt.Errorf("generating data error: %w", err)
 	}
 
+	// get []string from generate template
 	lines := strings.Split(buffer.String(), "\n")
 
+	// search fragment from our template
 	fragments, err := extractFragments(pattern, lines)
 
 	for _, fragment := range fragments {
@@ -318,7 +417,7 @@ func UpdateFile(data interface{}, output, tmpl string, pattern *regexp.Regexp) (
 
 // isStartedRow find row where start function or structure
 func isStartedRow(row string) bool {
-	if strings.Contains(row, "func") || strings.Contains(row, "struct") {
+	if (strings.Contains(row, "func") || strings.Contains(row, "struct")) && !strings.Contains(row, "//") {
 		return true
 	}
 	return false