0.2.3 iteration. CSV Output for []map, XML Output for html (needs fix for residual @ attrs compliant w/ tag > json spec)

Author: JFryy

README.md

@@ -105,9 +105,9 @@ Note: these unsupported formats are on a roadmap for inclusion.
 | HCL         | ✅ Supported   | ✅ Supported   |
 | TF          | ✅ Supported   | ✅ Supported   |
 | GRON        | ✅ Supported   | ✅ Supported   |
-| CSV         | ✅ Supported   | ❌ Not Supported |
+| CSV         | ✅ Supported   | ✅ Supported |
 | Protobuf    | ❌ Not Supported | ❌ Not Supported |
-| HTML        | ✅ Supported   | ❌ Not Supported |
+| HTML        | ✅ Supported   | ✅ Supported |
 | TXT (newline)| ✅ Supported   | ❌ Not Supported |
 
 

cli/qq.go

@@ -23,7 +23,7 @@ func CreateRootCmd() *cobra.Command {
 		encodings += t.Ext.String() + ", "
 	}
 	encodings = strings.TrimSuffix(encodings, ", ")
-	v := "v0.2.2"
+	v := "v0.2.3"
 	desc := fmt.Sprintf("qq is a interoperable configuration format transcoder with jq querying ability powered by gojq. qq is multi modal, and can be used as a replacement for jq or be interacted with via a repl with autocomplete and realtime rendering preview for building queries. Supported formats include %s", encodings)
 	cmd := &cobra.Command{
 		Use:   "qq [expression] [file] [flags] \n  cat [file] | qq [expression] [flags] \n  qq -I file",

codec/codec.go

@@ -81,11 +81,11 @@ var SupportedFileTypes = []Encoding{
 	{TOML, toml.Unmarshal, toml.Marshal},
 	{HCL, hcltf.Unmarshal, hcltf.Marshal},
 	{TF, hcltf.Unmarshal, hcltf.Marshal},
-	{CSV, sv.Unmarshal, jsn.Marshal},
+	{CSV, sv.Unmarshal, sv.Marshal},
 	{XML, xmll.Unmarshal, xmll.Marshal},
 	{INI, inii.Unmarshal, inii.Marshal},
 	{GRON, grn.Unmarshal, grn.Marshal},
-	{HTML, htm.Unmarshal, jsn.Marshal},
+	{HTML, htm.Unmarshal, xmll.Marshal},
 	{LINE, lines.Unmarshal, jsn.Marshal},
 	{TXT, lines.Unmarshal, jsn.Marshal},
 }

codec/csv/csv.go

@@ -3,10 +3,13 @@ package csv
 import (
 	"bytes"
 	"encoding/csv"
+	"errors"
 	"fmt"
 	"github.com/JFryy/qq/codec/util"
 	"github.com/goccy/go-json"
 	"io"
+	"reflect"
+	"slices"
 	"strings"
 )
 
@@ -37,6 +40,59 @@ func (c *Codec) detectDelimiter(input []byte) rune {
 	return maxDelimiter
 }
 
+func (c *Codec) Marshal(v interface{}) ([]byte, error) {
+	var buf bytes.Buffer
+	w := csv.NewWriter(&buf)
+
+	rv := reflect.ValueOf(v)
+	if rv.Kind() != reflect.Slice {
+		return nil, errors.New("input data must be a slice")
+	}
+
+	if rv.Len() == 0 {
+		return nil, errors.New("no data to write")
+	}
+
+	firstElem := rv.Index(0).Interface()
+	firstElemValue, ok := firstElem.(map[string]interface{})
+	if !ok {
+		return nil, errors.New("slice elements must be of type map[string]interface{}")
+	}
+
+	var headers []string
+	for key := range firstElemValue {
+		headers = append(headers, key)
+	}
+	slices.Sort(headers)
+
+	if err := w.Write(headers); err != nil {
+		return nil, fmt.Errorf("error writing CSV headers: %v", err)
+	}
+
+	for i := 0; i < rv.Len(); i++ {
+		recordMap := rv.Index(i).Interface().(map[string]interface{})
+		row := make([]string, len(headers))
+		for j, header := range headers {
+			if value, ok := recordMap[header]; ok {
+				row[j] = fmt.Sprintf("%v", value)
+			} else {
+				row[j] = ""
+			}
+		}
+		if err := w.Write(row); err != nil {
+			return nil, fmt.Errorf("error writing CSV record: %v", err)
+		}
+	}
+
+	w.Flush()
+
+	if err := w.Error(); err != nil {
+		return nil, fmt.Errorf("error flushing CSV writer: %v", err)
+	}
+
+	return buf.Bytes(), nil
+}
+
 func (c *Codec) Unmarshal(input []byte, v interface{}) error {
 	delimiter := c.detectDelimiter(input)
 	r := csv.NewReader(strings.NewReader(string(input)))

go.mod

@@ -18,7 +18,7 @@ require (
 	github.com/spf13/cobra v1.8.1
 	github.com/tmccombs/hcl2json v0.6.4
 	github.com/zclconf/go-cty v1.15.0
-	golang.org/x/net v0.29.0
+	golang.org/x/net v0.30.0
 	gopkg.in/ini.v1 v1.67.0
 )
 
@@ -47,8 +47,8 @@ require (
 	github.com/spf13/pflag v1.0.5 // indirect
 	golang.org/x/mod v0.21.0 // indirect
 	golang.org/x/sync v0.8.0 // indirect
-	golang.org/x/sys v0.25.0 // indirect
-	golang.org/x/text v0.18.0 // indirect
-	golang.org/x/tools v0.25.0 // indirect
+	golang.org/x/sys v0.26.0 // indirect
+	golang.org/x/text v0.19.0 // indirect
+	golang.org/x/tools v0.26.0 // indirect
 	golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da // indirect
 )

go.sum

@@ -97,23 +97,23 @@ github.com/zclconf/go-cty v1.15.0 h1:tTCRWxsexYUmtt/wVxgDClUe+uQusuI443uL6e+5sXQ
 github.com/zclconf/go-cty v1.15.0/go.mod h1:VvMs5i0vgZdhYawQNq5kePSpLAoz8u1xvZgrPIxfnZE=
 github.com/zclconf/go-cty-debug v0.0.0-20240509010212-0d6042c53940 h1:4r45xpDWB6ZMSMNJFMOjqrGHynW3DIBuR2H9j0ug+Mo=
 github.com/zclconf/go-cty-debug v0.0.0-20240509010212-0d6042c53940/go.mod h1:CmBdvvj3nqzfzJ6nTCIwDTPZ56aVGvDrmztiO5g3qrM=
-golang.org/x/crypto v0.27.0 h1:GXm2NjJrPaiv/h1tb2UH8QfgC/hOf/+z0p6PT8o1w7A=
-golang.org/x/crypto v0.27.0/go.mod h1:1Xngt8kV6Dvbssa53Ziq6Eqn0HqbZi5Z6R0ZpwQzt70=
+golang.org/x/crypto v0.28.0 h1:GBDwsMXVQi34v5CCYUm2jkJvu4cbtru2U4TN2PSyQnw=
+golang.org/x/crypto v0.28.0/go.mod h1:rmgy+3RHxRZMyY0jjAJShp2zgEdOqj2AO7U0pYmeQ7U=
 golang.org/x/mod v0.21.0 h1:vvrHzRwRfVKSiLrG+d4FMl/Qi4ukBCE6kZlTUkDYRT0=
 golang.org/x/mod v0.21.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
-golang.org/x/net v0.29.0 h1:5ORfpBpCs4HzDYoodCDBbwHzdR5UrLBZ3sOnUJmFoHo=
-golang.org/x/net v0.29.0/go.mod h1:gLkgy8jTGERgjzMic6DS9+SP0ajcu6Xu3Orq/SpETg0=
+golang.org/x/net v0.30.0 h1:AcW1SDZMkb8IpzCdQUaIq2sP4sZ4zw+55h6ynffypl4=
+golang.org/x/net v0.30.0/go.mod h1:2wGyMJ5iFasEhkwi13ChkO/t1ECNC4X4eBKkVFyYFlU=
 golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ=
 golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=
-golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/text v0.18.0 h1:XvMDiNzPAl0jr17s6W9lcaIhGUfUORdGCNsuLmPG224=
-golang.org/x/text v0.18.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
-golang.org/x/tools v0.25.0 h1:oFU9pkj/iJgs+0DT+VMHrx+oBKs/LJMV+Uvg78sl+fE=
-golang.org/x/tools v0.25.0/go.mod h1:/vtpO8WL1N9cQC3FN5zPqb//fRXskFHbLKk4OW1Q7rg=
+golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo=
+golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM=
+golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
+golang.org/x/tools v0.26.0 h1:v/60pFQmzmT9ExmjDv2gGIfi3OqfKoEP6I5+umXlbnQ=
+golang.org/x/tools v0.26.0/go.mod h1:TPVVj70c7JJ3WCazhD8OdXcZg/og+b9+tH/KxylGwH0=
 golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da h1:noIWHXmPHxILtqtCOPIhSt0ABwskkZKjD3bXGnZGpNY=
 golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da/go.mod h1:NDW/Ps6MPRej6fsCIbMTohpP40sJ/P/vI1MoTEGwX90=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

tests/test.sh

@@ -1,6 +1,8 @@
+#!/bin/bash
+
 set -e
 
-if [ -z $(which jq) ]; then
+if [ -z "$(which jq)" ]; then
     echo "jq is not installed. Please install jq."
     exit 1
 fi
@@ -22,26 +24,30 @@ print() {
     esac
 }
 
-
-# ini has edge cases that prevent transcoding to other formats
 extensions=$(ls -1 tests/* | grep -Ev '.sh|ini')
 for i in ${extensions}; do
     echo "Testing $i"
+    input=$(echo $i | cut -d. -f2)
+
     for f in ${extensions}; do
         extension=$(echo $f | cut -d. -f2)
-        input=$(echo $i | cut -d. -f2)
-        # csv is not supported for toml and xml output
-        case $input in
-            csv)
-                if [ $(echo $extension | grep -E 'toml') ]; then
-                    continue
-                fi
-                ;;
-        esac
+
+        if [[ "$input" == "csv" && "$extension" != "csv" ]]
+        then
+            print "yellow" "Skipping unsupported conversion from CSV to non-CSV compatible structure"
+            continue
+        fi
+
+        if [[ "$input" != csv && $extension == "csv" ]]
+        then
+            print "yellow" "Skipping unsupported conversion from CSV to non-CSV compatible structure"
+            continue
+        fi
+
         print "" "============================================"
         print "" "Executing: cat $i | grep -v '#' | bin/qq -i $input -o $extension"
         print "" "============================================"
-        cat $i | grep -v "#" | bin/qq -i $(echo $i | cut -d. -f2) -o $extension
+        cat "$i" | grep -v "#" | bin/qq -i "$input" -o "$extension"
         print "green" "============================================"
         print "green" "Success."
         print "green" "============================================"
@@ -52,20 +58,24 @@ for i in ${extensions}; do
         print "" "============================================"
         print "yellow" "Testing case: qq $case $i"
         print "" "============================================"
-        echo $test_cases
-        cat $i | grep -v \# | bin/qq ${case} $i
+        cat "$i" | grep -v \# | bin/qq "${case}" "$i"
     done
 done
 
-# conversions to jq and back
 previous_ext="json"
 for file in ${extensions}; do
+    if [[ $(echo -n $file | grep csv) ]]
+    then
+        continue
+    fi
+    print "" $file
     print "" "============================================"
     print "" "Executing: cat $file | jq . | bin/qq -o $previous_ext"
     print "" "============================================"
-    bin/qq $file | jq . | bin/qq -o $previous_ext
+    bin/qq "$file" | jq . | bin/qq -o "$previous_ext"
     print "green" "============================================"
     print "green" "Success."
     print "green" "============================================"
-    previous_ext=$(echo $file | cut -d. -f2)
+    previous_ext=$(echo "$file" | cut -d. -f2)
 done
+