add customedit function (#93)

* add customedit function

* move to v2

* explicitly import package as hcl

* Revert "explicitly import package as hcl"

This reverts commit a8051d6.

.github/workflows/lint.yml

@@ -10,7 +10,9 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Lint
-        uses: reviewdog/action-golangci-lint@v1
+        uses: reviewdog/action-golangci-lint@v2

.github/workflows/test.yml

@@ -20,13 +20,5 @@ jobs:
         with:
           go-version: ${{ matrix.go }}
 
-      - name: Cache
-        uses: actions/cache@v2
-        with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-
-
       - name: Test
         run: go test -v -race ./...

hcledit.go

@@ -173,6 +173,12 @@ func (h *HCLEditor) Delete(queryStr string, opts ...Option) error {
 	return w.Walk(h.writeFile.Body(), queries, 0, []string{})
 }
 
+// CustomEdit executes a custom function on the underlying file
+func (h *HCLEditor) CustomEdit(fn func(*hclwrite.Body) error) error {
+	defer h.reload()
+	return fn(h.writeFile.Body())
+}
+
 // reload re-parse the HCL file. Some operation causes like `WithAfter` modifies Body token structure
 // drastically (it re-construct it from scratch...) and, because of it, some operation will not work
 // properly after it

hcledit_test.go

@@ -6,6 +6,8 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
+	"github.com/hashicorp/hcl/v2/hclwrite"
+	"github.com/zclconf/go-cty/cty"
 
 	"go.mercari.io/hcledit"
 )
@@ -840,3 +842,70 @@ object1 = {
 		})
 	}
 }
+
+func TestCustomEdit(t *testing.T) {
+	cases := map[string]struct {
+		input    string
+		function func(*hclwrite.Body) error
+		want     string
+	}{
+		"Attribute": {
+			input: `
+`,
+			function: func(b *hclwrite.Body) error {
+				block := b.AppendNewBlock("block", []string{"test"})
+				blockBody := block.Body()
+				blockBody.SetAttributeValue("attribute", cty.StringVal("A"))
+				return nil
+			},
+			want: `
+block "test" {
+  attribute = "A"
+}
+`,
+		},
+		"Existing block with identical labels": {
+			input: `
+block "test" {
+  existing = "A"
+}
+`,
+			function: func(b *hclwrite.Body) error {
+				block := b.AppendNewBlock("block", []string{"test"})
+				blockBody := block.Body()
+				blockBody.SetAttributeValue("attribute", cty.StringVal("A"))
+				return nil
+			},
+			want: `
+block "test" {
+  existing = "A"
+}
+block "test" {
+  attribute = "A"
+}
+`,
+		},
+	}
+
+	for name, tc := range cases {
+		tc := tc
+		t.Run(name, func(t *testing.T) {
+			editor, err := hcledit.Read(strings.NewReader(tc.input), "")
+			if err != nil {
+				t.Fatal(err)
+			}
+			if err := editor.CustomEdit(tc.function); err != nil {
+				t.Fatal(err)
+			}
+
+			diff := cmp.Diff(tc.want, string(editor.Bytes()),
+				cmpopts.AcyclicTransformer("multiline", func(s string) []string {
+					return strings.Split(s, "\n")
+				}),
+			)
+			if diff != "" {
+				t.Errorf("CustomEdit() mismatch (-want +got):\n%s", diff)
+			}
+		})
+	}
+}