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

wip xml encoding

Browse Source
This commit is contained in:
Mike Farah 2021-12-22 11:58:52 +11:00
parent e869f4b81f
commit 9c6d84d184
3 changed files with 85 additions and 252 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/yqlib/decoder_xml.go
View File

@ -74,7 +74,6 @@ func (dec *xmlDecoder) createMap(n *xmlNode) (*yaml.Node, error) {
label := keyValuePair.K label := keyValuePair.K
children := keyValuePair.V children := keyValuePair.V
labelNode := createScalarNode(label, label) labelNode := createScalarNode(label, label)
// labelNode.HeadComment = n.HeadComment
var valueNode *yaml.Node var valueNode *yaml.Node
var err error var err error
log.Debug("len of children in %v is %v", label, len(children)) log.Debug("len of children in %v is %v", label, len(children))
@ -89,7 +88,6 @@ func (dec *xmlDecoder) createMap(n *xmlNode) (*yaml.Node, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
if i == len(n.Children)-1 { if i == len(n.Children)-1 {
valueNode.FootComment = n.FootComment valueNode.FootComment = n.FootComment
} }

180
pkg/yqlib/doc/usage/xml.md
View File

@ -22,83 +22,8 @@ XML nodes that have attributes then plain content, e.g:
The content of the node will be set as a field in the map with the key "+content". Use the `--xml-content-name` flag to change this. The content of the node will be set as a field in the map with the key "+content". Use the `--xml-content-name` flag to change this.
## Parse xml: simple ## Round trip: with comments
Given a sample.xml file of: A best effort is made, but comment positions and white space are not preserved perfectly.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<cat>meow</cat>
```
then
```bash
yq e -p=xml '.' sample.xml
```
will output
```yaml
cat: meow
```
## Parse xml: array
Consecutive nodes with identical xml names are assumed to be arrays.
Given a sample.xml file of:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<animal>1</animal>
<animal>2</animal>
```
then
```bash
yq e -p=xml '.' sample.xml
```
will output
```yaml
animal:
- "1"
- "2"
```
## Parse xml: attributes
Attributes are converted to fields, with the attribute prefix.
Given a sample.xml file of:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<cat legs="4">
<legs>7</legs>
</cat>
```
then
```bash
yq e -p=xml '.' sample.xml
```
will output
```yaml
cat:
+legs: "4"
legs: "7"
```
## Parse xml: attributes with content
Content is added as a field, using the content name
Given a sample.xml file of:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<cat legs="4">meow</cat>
```
then
```bash
yq e -p=xml '.' sample.xml
```
will output
```yaml
cat:
+content: meow
+legs: "4"
```
## Parse xml: with comments
A best attempt is made to preserve comments.
Given a sample.xml file of: Given a sample.xml file of:
```xml ```xml
@ -139,104 +64,3 @@ cat:
# after cat # after cat
``` ```
## Encode xml: simple
Given a sample.yml file of:
```yaml
cat: purrs
```
then
```bash
yq e -o=xml '.' sample.yml
```
will output
```xml
<cat>purrs</cat>
```
## Encode xml: array
Given a sample.yml file of:
```yaml
pets:
cat:
- purrs
- meows
```
then
```bash
yq e -o=xml '.' sample.yml
```
will output
```xml
<pets>
<cat>purrs</cat>
<cat>meows</cat>
</pets>
```
## Encode xml: attributes
Fields with the matching xml-attribute-prefix are assumed to be attributes.
Given a sample.yml file of:
```yaml
cat:
+name: tiger
meows: true
```
then
```bash
yq e -o=xml '.' sample.yml
```
will output
```xml
<cat name="tiger">
<meows>true</meows>
</cat>
```
## Encode xml: attributes with content
Fields with the matching xml-content-name is assumed to be content.
Given a sample.yml file of:
```yaml
cat:
+name: tiger
+content: cool
```
then
```bash
yq e -o=xml '.' sample.yml
```
will output
```xml
<cat name="tiger">cool</cat>
```
## Encode xml: comments
A best attempt is made to copy comments to xml.
Given a sample.yml file of:
```yaml
# above_cat
cat: # inline_cat
# above_array
array: # inline_array
- val1 # inline_val1
# above_val2
- val2 # inline_val2
# below_cat
```
then
```bash
yq e -o=xml '.' sample.yml
```
will output
```xml
<!-- above_cat inline_cat--><cat><!-- above_array inline_array-->
<array><!-- inline_val1-->val1</array>
<array><!-- above_val2 inline_val2-->val2</array>
</cat><!-- below_cat-->
```

155
pkg/yqlib/xml_test.go
View File

@ -89,6 +89,16 @@ cat:
# after cat # after cat
` `
var expectedRoundtripXmlWithComments = `<!-- before cat--><cat><!--in cat before-->
<x><!--multi
line comment
for x-->3</x>
<y><!--in y before-->
<d><!--in d before in d after-->4</d><!--in y after-->
</y><!--in_cat_after-->
</cat><!--after cat-->
`
var yamlWithComments = `# above_cat var yamlWithComments = `# above_cat
cat: # inline_cat cat: # inline_cat
# above_array # above_array
@ -106,81 +116,82 @@ var expectedXmlWithComments = `<!-- above_cat inline_cat--><cat><!-- above_array
` `
var xmlScenarios = []xmlScenario{ var xmlScenarios = []xmlScenario{
{ // {
description: "Parse xml: simple", // description: "Parse xml: simple",
input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat>meow</cat>", // input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat>meow</cat>",
expected: "D0, P[], (doc)::cat: meow\n", // expected: "D0, P[], (doc)::cat: meow\n",
}, // },
{ // {
description: "Parse xml: array", // description: "Parse xml: array",
subdescription: "Consecutive nodes with identical xml names are assumed to be arrays.", // subdescription: "Consecutive nodes with identical xml names are assumed to be arrays.",
input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<animal>1</animal>\n<animal>2</animal>", // input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<animal>1</animal>\n<animal>2</animal>",
expected: "D0, P[], (doc)::animal:\n - \"1\"\n - \"2\"\n", // expected: "D0, P[], (doc)::animal:\n - \"1\"\n - \"2\"\n",
}, // },
{ // {
description: "Parse xml: attributes", // description: "Parse xml: attributes",
subdescription: "Attributes are converted to fields, with the attribute prefix.", // subdescription: "Attributes are converted to fields, with the attribute prefix.",
input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat legs=\"4\">\n <legs>7</legs>\n</cat>", // input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat legs=\"4\">\n <legs>7</legs>\n</cat>",
expected: "D0, P[], (doc)::cat:\n +legs: \"4\"\n legs: \"7\"\n", // expected: "D0, P[], (doc)::cat:\n +legs: \"4\"\n legs: \"7\"\n",
}, // },
{ // {
description: "Parse xml: attributes with content", // description: "Parse xml: attributes with content",
subdescription: "Content is added as a field, using the content name", // subdescription: "Content is added as a field, using the content name",
input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat legs=\"4\">meow</cat>", // input: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<cat legs=\"4\">meow</cat>",
expected: "D0, P[], (doc)::cat:\n +content: meow\n +legs: \"4\"\n", // expected: "D0, P[], (doc)::cat:\n +content: meow\n +legs: \"4\"\n",
}, // },
{ // {
description: "Parse xml: with comments", // description: "Parse xml: with comments",
subdescription: "A best attempt is made to preserve comments.", // subdescription: "A best attempt is made to preserve comments.",
input: inputXmlWithComments, // input: inputXmlWithComments,
expected: expectedDecodeYamlWithComments, // expected: expectedDecodeYamlWithComments,
scenarioType: "decode", // scenarioType: "decode",
}, // },
{ // {
description: "Encode xml: simple", // description: "Encode xml: simple",
input: "cat: purrs", // input: "cat: purrs",
expected: "<cat>purrs</cat>\n", // expected: "<cat>purrs</cat>\n",
scenarioType: "encode", // scenarioType: "encode",
}, // },
{ // {
description: "Encode xml: array", // description: "Encode xml: array",
input: "pets:\n cat:\n - purrs\n - meows", // input: "pets:\n cat:\n - purrs\n - meows",
expected: "<pets>\n <cat>purrs</cat>\n <cat>meows</cat>\n</pets>\n", // expected: "<pets>\n <cat>purrs</cat>\n <cat>meows</cat>\n</pets>\n",
scenarioType: "encode", // scenarioType: "encode",
}, // },
{ // {
description: "Encode xml: attributes", // description: "Encode xml: attributes",
subdescription: "Fields with the matching xml-attribute-prefix are assumed to be attributes.", // subdescription: "Fields with the matching xml-attribute-prefix are assumed to be attributes.",
input: "cat:\n +name: tiger\n meows: true\n", // input: "cat:\n +name: tiger\n meows: true\n",
expected: "<cat name=\"tiger\">\n <meows>true</meows>\n</cat>\n", // expected: "<cat name=\"tiger\">\n <meows>true</meows>\n</cat>\n",
scenarioType: "encode", // scenarioType: "encode",
}, // },
{
skipDoc: true,
input: "cat:\n ++name: tiger\n meows: true\n",
expected: "<cat +name=\"tiger\">\n <meows>true</meows>\n</cat>\n",
scenarioType: "encode",
},
{
description: "Encode xml: attributes with content",
subdescription: "Fields with the matching xml-content-name is assumed to be content.",
input: "cat:\n +name: tiger\n +content: cool\n",
expected: "<cat name=\"tiger\">cool</cat>\n",
scenarioType: "encode",
},
{
description: "Encode xml: comments",
subdescription: "A best attempt is made to copy comments to xml.",
input: yamlWithComments,
expected: expectedXmlWithComments,
scenarioType: "encode",
},
// { // {
// skipDoc: true, // skipDoc: true,
// input: "<!-- beforeCat --><cat><!-- in cat -->value<!-- after --></cat><!-- after cat -->", // input: "cat:\n ++name: tiger\n meows: true\n",
// expected: "<!-- beforeCat --><cat><!-- in cat -->value</cat><!-- after cat -->", // expected: "<cat +name=\"tiger\">\n <meows>true</meows>\n</cat>\n",
// scenarioType: "roundtrip", // scenarioType: "encode",
// }, // },
// {
// description: "Encode xml: attributes with content",
// subdescription: "Fields with the matching xml-content-name is assumed to be content.",
// input: "cat:\n +name: tiger\n +content: cool\n",
// expected: "<cat name=\"tiger\">cool</cat>\n",
// scenarioType: "encode",
// },
// {
// description: "Encode xml: comments",
// subdescription: "A best attempt is made to copy comments to xml.",
// input: yamlWithComments,
// expected: expectedXmlWithComments,
// scenarioType: "encode",
// },
{
description: "Round trip: with comments",
subdescription: "A best effort is made, but comment positions and white space are not preserved perfectly.",
input: inputXmlWithComments,
expected: expectedRoundtripXmlWithComments,
scenarioType: "roundtrip",
},
} }
func testXmlScenario(t *testing.T, s xmlScenario) { func testXmlScenario(t *testing.T, s xmlScenario) {