go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/data/text/templateproto/loader.go (about)

     1  // Copyright 2016 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package templateproto
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"go.chromium.org/luci/common/proto"
    21  )
    22  
    23  // LoadFile loads a File from a string containing the template text protobuf.
    24  //
    25  // Expects config.Interface to be in the context already.
    26  func LoadFile(data string) (file *File, err error) {
    27  	file = &File{}
    28  	if err = proto.UnmarshalTextML(data, file); err != nil {
    29  		return
    30  	}
    31  	err = file.Normalize()
    32  	return
    33  }
    34  
    35  // Render renders the specified template with the given parameters.
    36  func (f *File) Render(spec *Specifier) (string, error) {
    37  	ret, err := f.Template[spec.TemplateName].Render(spec.Params)
    38  	if err != nil {
    39  		err = fmt.Errorf("rendering %q: %s", spec.TemplateName, err)
    40  	}
    41  	return ret, err
    42  }
    43  
    44  // RenderL renders a specified template with go literal arguments.
    45  func (f *File) RenderL(templName string, params LiteralMap) (ret string, err error) {
    46  	spec := &Specifier{TemplateName: templName}
    47  	spec.Params, err = params.Convert()
    48  	if err != nil {
    49  		return
    50  	}
    51  	return f.Render(spec)
    52  }