Rename template related methods and fields

Author: dpup

data/service.go

@@ -35,8 +35,8 @@ func (s Services) HasUnaryCallMethod() bool {
 	return false
 }
 
-// NeedsFetchModule returns whether the given services needs fetch module support
-func (s Services) NeedsFetchModule() bool {
+// RequiresFetchModule returns whether the given services needs fetch module support
+func (s Services) RequiresFetchModule() bool {
 	hasServices := len(s) > 0
 	return hasServices && (s.HasUnaryCallMethod() || s.HasServerStreamingMethod())
 }

generator/generator.go

@@ -34,10 +34,10 @@ func (t *TypeScriptGRPCGatewayGenerator) Generate(req *plugin.CodeGeneratorReque
 	if err != nil {
 		return nil, errors.Wrap(err, "error analysing proto files")
 	}
-	tmpl := GetTemplate(t.Registry)
+	tmpl := ServiceTemplate(t.Registry)
 	log.Debugf("files to generate %v", req.GetFileToGenerate())
 
-	needToGenerateFetchModule := false
+	requiresFetchModule := false
 	// feed fileData into rendering process
 	for _, fileData := range filesData {
 		if !t.Registry.IsFileToGenerate(fileData.Name) {
@@ -46,7 +46,7 @@ func (t *TypeScriptGRPCGatewayGenerator) Generate(req *plugin.CodeGeneratorReque
 		}
 
 		log.Debugf("generating file for %s", fileData.TSFileName)
-		data := &templateData{
+		data := &TemplateData{
 			File:               fileData,
 			EnableStylingCheck: t.Registry.EnableStylingCheck,
 			UseStaticClasses:   t.Registry.UseStaticClasses,
@@ -56,12 +56,11 @@ func (t *TypeScriptGRPCGatewayGenerator) Generate(req *plugin.CodeGeneratorReque
 			return nil, errors.Wrap(err, "error generating file")
 		}
 		resp.File = append(resp.File, generated)
-		needToGenerateFetchModule = needToGenerateFetchModule || fileData.Services.NeedsFetchModule()
+		requiresFetchModule = requiresFetchModule || fileData.Services.RequiresFetchModule()
 	}
 
-	if needToGenerateFetchModule {
-		// generate fetch module
-		fetchTmpl := GetFetchModuleTemplate()
+	if requiresFetchModule {
+		fetchTmpl := FetchModuleTemplate()
 		log.Debugf("generate fetch template")
 		generatedFetch, err := t.generateFetchModule(fetchTmpl)
 		if err != nil {
@@ -74,7 +73,7 @@ func (t *TypeScriptGRPCGatewayGenerator) Generate(req *plugin.CodeGeneratorReque
 	return resp, nil
 }
 
-func (t *TypeScriptGRPCGatewayGenerator) generateFile(data *templateData, tmpl *template.Template) (*plugin.CodeGeneratorResponse_File, error) {
+func (t *TypeScriptGRPCGatewayGenerator) generateFile(data *TemplateData, tmpl *template.Template) (*plugin.CodeGeneratorResponse_File, error) {
 	w := bytes.NewBufferString("")
 
 	if data.IsEmpty() {
@@ -99,7 +98,7 @@ func (t *TypeScriptGRPCGatewayGenerator) generateFile(data *templateData, tmpl *
 func (t *TypeScriptGRPCGatewayGenerator) generateFetchModule(tmpl *template.Template) (*plugin.CodeGeneratorResponse_File, error) {
 	w := bytes.NewBufferString("")
 	fileName := filepath.Join(t.Registry.FetchModuleDirectory, t.Registry.FetchModuleFilename)
-	err := tmpl.Execute(w, &templateData{
+	err := tmpl.Execute(w, &TemplateData{
 		EnableStylingCheck: t.Registry.EnableStylingCheck,
 		UseStaticClasses:   t.Registry.UseStaticClasses,
 	})

generator/template.go

@@ -35,14 +35,14 @@ var fetchTmplHeader = `{{- if not .EnableStylingCheck}}
 var fetchTmpl = fetchTmplHeader + fetchTmplScript
 
 // Data object injected into the templates.
-type templateData struct {
+type TemplateData struct {
 	*data.File
 	EnableStylingCheck bool
 	UseStaticClasses   bool
 }
 
-// GetTemplate gets the templates to for the typescript file
-func GetTemplate(r *registry.Registry) *template.Template {
+// ServiceTemplate gets the template for the primary typescript file.
+func ServiceTemplate(r *registry.Registry) *template.Template {
 	t := template.New("file")
 	t = t.Funcs(sprig.TxtFuncMap())
 
@@ -63,6 +63,12 @@ func GetTemplate(r *registry.Registry) *template.Template {
 	return t
 }
 
+// FetchModuleTemplate returns the go template for fetch module.
+func FetchModuleTemplate() *template.Template {
+	t := template.New("fetch")
+	return template.Must(t.Parse(fetchTmpl))
+}
+
 func fieldName(r *registry.Registry) func(name string) string {
 	return func(name string) string {
 		if r.UseProtoNames {
@@ -124,12 +130,6 @@ func buildInitReq(method data.Method) string {
 	return strings.Join(fields, ", ")
 }
 
-// GetFetchModuleTemplate returns the go template for fetch module
-func GetFetchModuleTemplate() *template.Template {
-	t := template.New("fetch")
-	return template.Must(t.Parse(fetchTmpl))
-}
-
 // include is the include template functions copied from
 // copied from: https://github.com/helm/helm/blob/8648ccf5d35d682dcd5f7a9c2082f0aaf071e817/pkg/engine/engine.go#L147-L154
 func include(t *template.Template) func(name string, data interface{}) (string, error) {

registry/file.go

@@ -51,7 +51,7 @@ func (r *Registry) analyseFile(f *descriptorpb.FileDescriptorProto) (*data.File,
 }
 
 func (r *Registry) addFetchModuleDependencies(fileData *data.File) error {
-	if !fileData.Services.NeedsFetchModule() {
+	if !fileData.Services.RequiresFetchModule() {
 		log.Debugf("no services found for %s, skipping fetch module", fileData.Name)
 		return nil
 	}