alihan/dasel-data-selector
1
0
Fork 0
mirror of https://github.com/TomWright/dasel.git synced 2022-05-22 02:32:45 +03:00
Code Issues Projects Releases Wiki Activity

Add format flag to select command

Browse Source
This commit is contained in:
Tom Wright
2021-08-11 11:15:00 +01:00
parent 047f9fa09e
commit f9759d9f25
7 changed files with 101 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@@ -7,7 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
- Nothing yet.
### Added
- `--format` flag to `select` command.
## [v1.17.0] - 2021-08-08

2
internal/command/delete.go
View File

@@ -73,7 +73,7 @@ func runDeleteCommand(opts deleteOptions, cmd *cobra.Command) error {
})
}
writeParser, err := getWriteParser(readParser, opts.WriteParser, opts.Parser, opts.Out, opts.File)
writeParser, err := getWriteParser(readParser, opts.WriteParser, opts.Parser, opts.Out, opts.File, "")
if err != nil {
return err
}

53
internal/command/put.go
View File

@@ -70,7 +70,12 @@ func getReadParser(fileFlag string, readParserFlag string, parserFlag string) (s
return parser, nil
}
func getWriteParser(readParser storage.ReadParser, writeParserFlag string, parserFlag string, outFlag string, fileFlag string) (storage.WriteParser, error) {
func getWriteParser(readParser storage.ReadParser, writeParserFlag string, parserFlag string,
outFlag string, fileFlag string, formatTemplateFlag string) (storage.WriteParser, error) {
if formatTemplateFlag != "" {
writeParserFlag = "plain"
}
if writeParserFlag == "" {
writeParserFlag = parserFlag
}
@@ -136,11 +141,12 @@ func getRootNode(opts getRootNodeOpts, cmd *cobra.Command) (*dasel.Node, error)
}
type writeNodeToOutputOpts struct {
Node *dasel.Node
Parser storage.WriteParser
File string
Out string
Writer io.Writer
Node *dasel.Node
Parser storage.WriteParser
File string
Out string
Writer io.Writer
FormatTemplate string
}
type customErrorHandlingOpts struct {
@@ -195,7 +201,20 @@ func writeNodeToOutput(opts writeNodeToOutputOpts, cmd *cobra.Command, options .
opts.Writer = writer
defer writerCleanUp()
if err := storage.Write(opts.Parser, opts.Node.InterfaceValue(), opts.Node.OriginalValue, opts.Writer, options...); err != nil {
var value, originalValue interface{}
if opts.FormatTemplate == "" {
value = opts.Node.InterfaceValue()
originalValue = opts.Node.OriginalValue
} else {
result, err := dasel.FormatNode(opts.Node, opts.FormatTemplate)
if err != nil {
return fmt.Errorf("could not format node: %w", err)
}
value = result.String()
originalValue = value
}
if err := storage.Write(opts.Parser, value, originalValue, opts.Writer, options...); err != nil {
return fmt.Errorf("could not write to output file: %w", err)
}
@@ -203,11 +222,12 @@ func writeNodeToOutput(opts writeNodeToOutputOpts, cmd *cobra.Command, options .
}
type writeNodesToOutputOpts struct {
Nodes []*dasel.Node
Parser storage.WriteParser
File string
Out string
Writer io.Writer
Nodes []*dasel.Node
Parser storage.WriteParser
File string
Out string
Writer io.Writer
FormatTemplate string
}
func writeNodesToOutput(opts writeNodesToOutputOpts, cmd *cobra.Command, options ...storage.ReadWriteOption) error {
@@ -222,9 +242,10 @@ func writeNodesToOutput(opts writeNodesToOutputOpts, cmd *cobra.Command, options
for i, n := range opts.Nodes {
subOpts := writeNodeToOutputOpts{
Node: n,
Parser: opts.Parser,
Writer: buf,
Node: n,
Parser: opts.Parser,
Writer: buf,
FormatTemplate: opts.FormatTemplate,
}
if err := writeNodeToOutput(subOpts, cmd, options...); err != nil {
return fmt.Errorf("could not write node %d to output: %w", i, err)
@@ -375,7 +396,7 @@ func runGenericPutCommand(opts genericPutOptions, cmd *cobra.Command) error {
}
}
writeParser, err := getWriteParser(readParser, opts.WriteParser, opts.Parser, opts.Out, opts.File)
writeParser, err := getWriteParser(readParser, opts.WriteParser, opts.Parser, opts.Out, opts.File, "")
if err != nil {
return err
}

2
internal/command/put_document_internal.go
View File

@@ -58,7 +58,7 @@ func runPutDocumentCommand(opts putDocumentOpts, cmd *cobra.Command) error {
}
}
writeParser, err := getWriteParser(readParser, opts.WriteParser, opts.Parser, opts.Out, opts.File)
writeParser, err := getWriteParser(readParser, opts.WriteParser, opts.Parser, opts.Out, opts.File, "")
if err != nil {
return err
}

2
internal/command/put_object_internal.go
View File

@@ -76,7 +76,7 @@ func runPutObjectCommand(opts putObjectOpts, cmd *cobra.Command) error {
}
}
writeParser, err := getWriteParser(readParser, opts.WriteParser, opts.Parser, opts.Out, opts.File)
writeParser, err := getWriteParser(readParser, opts.WriteParser, opts.Parser, opts.Out, opts.File, "")
if err != nil {
return err
}

45
internal/command/root_select_test.go
View File

@@ -649,3 +649,48 @@ ESTAT,Eurostat
ILO,International Labor Organization
`, nil, "-w", "csv"))
}
func TestRootCmd_Select_JSON_Format(t *testing.T) {
t.Run("RootElementFormattedToProperty", selectTest(jsonData, "json", ".", newline(`1111`), nil,
"--format", `{{ query ".id" }}`))
t.Run("SelectorFormatted", selectTest(jsonData, "json", ".id", newline(`1111`), nil,
"--format", `{{ . }}`))
t.Run("SelectorFormattedMultiple", selectTest(jsonData, "json", ".details.addresses.[*]",
newline(`101 Some Street
34 Another Street`), nil,
"-m", "--format", `{{ query ".street" }}`))
t.Run("SelectorFormattedToMultiple", selectTest(jsonData, "json", ".",
newline(`101 Some Street
34 Another Street`), nil,
"-m", "--format", `{{ queryMultiple ".details.addresses.[*]" | format "{{ .street }}{{ if not isLast }}{{ newline }}{{end}}" }}`))
// https://github.com/TomWright/dasel/discussions/146
t.Run("Discussion146", selectTest(
`[{"name": "click", "version": "7.1.2", "latest_version": "8.0.1", "latest_filetype": "wheel"}, {"name": "decorator", "version": "4.4.2", "latest_version": "5.0.9", "latest_filetype": "wheel"}, {"name": "ipython", "version": "7.20.0", "latest_version": "7.25.0", "latest_filetype": "wheel"}, {"name": "pandas", "version": "1.3.0", "latest_version": "1.3.1", "latest_filetype": "wheel"}, {"name": "parso", "version": "0.8.1", "latest_version": "0.8.2", "latest_filetype": "wheel"}, {"name": "pip", "version": "21.1.3", "latest_version": "21.2.1", "latest_filetype": "wheel"}, {"name": "prompt-toolkit", "version": "3.0.14", "latest_version": "3.0.19", "latest_filetype": "wheel"}, {"name": "Pygments", "version": "2.7.4", "latest_version": "2.9.0", "latest_filetype": "wheel"}, {"name": "setuptools", "version": "49.2.1", "latest_version": "57.4.0", "latest_filetype": "wheel"}, {"name": "tomli", "version": "1.0.4", "latest_version": "1.1.0", "latest_filetype": "wheel"}]`,
"json", ".(name!=setuptools)(name!=six)(name!=pip)(name!=pip-tools)",
newline(`click
7.1.2
8.0.1
decorator
4.4.2
5.0.9
ipython
7.20.0
7.25.0
pandas
1.3.0
1.3.1
parso
0.8.1
0.8.2
prompt-toolkit
3.0.14
3.0.19
Pygments
2.7.4
2.9.0
tomli
1.0.4
1.1.0`), nil,
"-m", "--format", `{{ query ".name" }}{{ newline }}{{ query ".version" }}{{ newline }}{{ query ".latest_version" }}`))
}

21
internal/command/select.go
View File

@@ -22,6 +22,7 @@ type selectOptions struct {
Compact bool
DisplayLength bool
MergeInputDocuments bool
FormatTemplate string
}
func outputNodeLength(writer io.Writer, nodes ...*dasel.Node) error {
@@ -72,9 +73,10 @@ func runSelectMultiCommand(cmd *cobra.Command, rootNode *dasel.Node, opts select
}
if err := writeNodesToOutput(writeNodesToOutputOpts{
Nodes: results,
Parser: writeParser,
Writer: opts.Writer,
Nodes: results,
Parser: writeParser,
Writer: opts.Writer,
FormatTemplate: opts.FormatTemplate,
}, cmd, writeOptions...); err != nil {
return fmt.Errorf("could not write output: %w", err)
}
@@ -106,7 +108,7 @@ func runSelectCommand(opts selectOptions, cmd *cobra.Command) error {
opts.Writer = cmd.OutOrStdout()
}
writeParser, err := getWriteParser(readParser, opts.WriteParser, opts.Parser, "-", opts.File)
writeParser, err := getWriteParser(readParser, opts.WriteParser, opts.Parser, "-", opts.File, opts.FormatTemplate)
if err != nil {
return err
}
@@ -151,9 +153,10 @@ func runSelectCommand(opts selectOptions, cmd *cobra.Command) error {
}
if err := writeNodeToOutput(writeNodeToOutputOpts{
Node: res,
Parser: writeParser,
Writer: opts.Writer,
Node: res,
Parser: writeParser,
Writer: opts.Writer,
FormatTemplate: opts.FormatTemplate,
}, cmd, writeOptions...); err != nil {
return fmt.Errorf("could not write output: %w", err)
}
@@ -162,7 +165,7 @@ func runSelectCommand(opts selectOptions, cmd *cobra.Command) error {
}
func selectCommand() *cobra.Command {
var fileFlag, selectorFlag, parserFlag, readParserFlag, writeParserFlag string
var fileFlag, selectorFlag, parserFlag, readParserFlag, writeParserFlag, formatTemplateFlag string
var plainFlag, multiFlag, nullValueNotFoundFlag, compactFlag, lengthFlag, mergeInputDocumentsFlag bool
cmd := &cobra.Command{
@@ -187,6 +190,7 @@ func selectCommand() *cobra.Command {
Compact: compactFlag,
DisplayLength: lengthFlag,
MergeInputDocuments: mergeInputDocumentsFlag,
FormatTemplate: formatTemplateFlag,
}, cmd)
},
}
@@ -202,6 +206,7 @@ func selectCommand() *cobra.Command {
cmd.Flags().BoolVar(&lengthFlag, "length", false, "Output the length of the selected value.")
cmd.Flags().BoolVar(&mergeInputDocumentsFlag, "merge-input-documents", false, "Merge multiple input documents into an array.")
cmd.Flags().BoolVarP(&compactFlag, "compact", "c", false, "Compact the output by removing all pretty-printing where possible.")
cmd.Flags().StringVar(&formatTemplateFlag, "format", "", "Formatting template to use when writing results.")
_ = cmd.MarkFlagFilename("file")