suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2024-11-12 05:38:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

More efficient front matter processor

Browse Source
This commit is contained in:
Mike Farah 2021-07-20 10:38:42 +10:00
parent 4e628327c4
commit 8508d3309b
6 changed files with 49 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cmd/evaluate_all_command.go
View File

@ -98,10 +98,7 @@ func evaluateAll(cmd *cobra.Command, args []string) error {
args[firstFileIndex] = frontMatterHandler.GetYamlFrontMatterFilename()
if frontMatter == "process" {
reader, err := os.Open(frontMatterHandler.GetContentFilename()) // #nosec
if err != nil {
return err
}
reader := frontMatterHandler.GetContentReader()
printer.SetAppendix(reader)
defer yqlib.SafelyCloseReader(reader)
}

5
cmd/evalute_sequence_command.go
View File

@ -112,10 +112,7 @@ func evaluateSequence(cmd *cobra.Command, args []string) error {
args[firstFileIndex] = frontMatterHandler.GetYamlFrontMatterFilename()
if frontMatter == "process" {
reader, err := os.Open(frontMatterHandler.GetContentFilename()) // #nosec
if err != nil {
return err
}
reader := frontMatterHandler.GetContentReader()
printer.SetAppendix(reader)
defer yqlib.SafelyCloseReader(reader)
}

3
examples/front-matter.yaml
View File

@ -2,4 +2,5 @@
a: apple
b: bannana
---
<h1>I like {{a}} and {{b}} </h1>
hello there
apples: great

63
pkg/yqlib/front_matter.go
View File

@ -9,47 +9,48 @@ import (
type frontMatterHandler interface {
Split() error
GetYamlFrontMatterFilename() string
GetContentFilename() string
GetContentReader() io.Reader
CleanUp()
}
type frontMatterHandlerImpl struct {
originalFilename string
yamlFrontMatterFilename string
contentFilename string
contentReader io.Reader
}
func NewFrontMatterHandler(originalFilename string) frontMatterHandler {
return &frontMatterHandlerImpl{originalFilename, "", ""}
return &frontMatterHandlerImpl{originalFilename, "", nil}
}
func (f *frontMatterHandlerImpl) GetYamlFrontMatterFilename() string {
return f.yamlFrontMatterFilename
}
func (f *frontMatterHandlerImpl) GetContentFilename() string {
return f.contentFilename
func (f *frontMatterHandlerImpl) GetContentReader() io.Reader {
return f.contentReader
}
func (f *frontMatterHandlerImpl) CleanUp() {
tryRemoveFile(f.yamlFrontMatterFilename)
tryRemoveFile(f.contentFilename)
}
// Splits the given file by yaml front matter
// yaml content will be saved to first temporary file
// remaining content will be saved to second temporary file
func (f *frontMatterHandlerImpl) Split() error {
var reader io.Reader
var reader *bufio.Reader
var err error
if f.originalFilename == "-" {
reader = bufio.NewReader(os.Stdin)
} else {
reader, err = os.Open(f.originalFilename) // #nosec
file, err := os.Open(f.originalFilename) // #nosec
if err != nil {
return err
}
reader = bufio.NewReader(file)
}
f.contentReader = reader
yamlTempFile, err := createTempFile()
if err != nil {
@ -58,39 +59,35 @@ func (f *frontMatterHandlerImpl) Split() error {
f.yamlFrontMatterFilename = yamlTempFile.Name()
log.Debug("yamlTempFile: %v", yamlTempFile.Name())
contentTempFile, err := createTempFile()
if err != nil {
return err
}
f.contentFilename = contentTempFile.Name()
log.Debug("contentTempFile: %v", contentTempFile.Name())
scanner := bufio.NewScanner(reader)
lineCount := 0
yamlContentBlock := true
for scanner.Scan() {
line := scanner.Text()
if lineCount > 0 && line == "---" {
//we've finished reading the yaml content
yamlContentBlock = false
}
if yamlContentBlock {
_, err = yamlTempFile.Write([]byte(line + "\n"))
} else {
_, err = contentTempFile.Write([]byte(line + "\n"))
}
if err != nil {
for {
peekBytes, err := reader.Peek(3)
if err == io.EOF {
// we've finished reading the yaml content..I guess
break
} else if err != nil {
return err
}
if lineCount > 0 && string(peekBytes) == "---" {
// we've finished reading the yaml content..
break
}
line, errReading := reader.ReadString('\n')
lineCount = lineCount + 1
if errReading != nil && errReading != io.EOF {
return errReading
}
_, errWriting := yamlTempFile.Write([]byte(line))
if errWriting != nil {
return errWriting
}
}
safelyCloseFile(yamlTempFile)
safelyCloseFile(contentTempFile)
return scanner.Err()
return nil
}

21
pkg/yqlib/front_matter_test.go
View File

@ -60,8 +60,11 @@ yaml: doc
test.AssertResult(t, expectedYamlFm, yamlFm)
content := readFile(fmHandler.GetContentFilename())
test.AssertResult(t, expectedContent, content)
contentBytes, err := ioutil.ReadAll(fmHandler.GetContentReader())
if err != nil {
panic(err)
}
test.AssertResult(t, expectedContent, string(contentBytes))
tryRemoveFile(file)
fmHandler.CleanUp()
@ -94,8 +97,11 @@ yaml: doc
test.AssertResult(t, expectedYamlFm, yamlFm)
content := readFile(fmHandler.GetContentFilename())
test.AssertResult(t, expectedContent, content)
contentBytes, err := ioutil.ReadAll(fmHandler.GetContentReader())
if err != nil {
panic(err)
}
test.AssertResult(t, expectedContent, string(contentBytes))
tryRemoveFile(file)
fmHandler.CleanUp()
@ -125,8 +131,11 @@ yaml: doc
test.AssertResult(t, expectedYamlFm, yamlFm)
content := readFile(fmHandler.GetContentFilename())
test.AssertResult(t, expectedContent, content)
contentBytes, err := ioutil.ReadAll(fmHandler.GetContentReader())
if err != nil {
panic(err)
}
test.AssertResult(t, expectedContent, string(contentBytes))
tryRemoveFile(file)
fmHandler.CleanUp()

5
pkg/yqlib/printer.go
View File

@ -28,7 +28,6 @@ type resultsPrinter struct {
previousFileIndex int
printedMatches bool
treeNavigator DataTreeNavigator
preambleReader io.Reader
appendixReader io.Reader
}
@ -45,10 +44,6 @@ func NewPrinter(writer io.Writer, outputToJSON bool, unwrapScalar bool, colorsEn
}
}
func (p *resultsPrinter) SetPreamble(reader io.Reader) {
p.preambleReader = reader
}
func (p *resultsPrinter) SetAppendix(reader io.Reader) {
p.appendixReader = reader
}