improve test coverage

Author: stackus

.github/workflows/test.yaml

@@ -0,0 +1,31 @@
+name: Test & Coverage
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+# a single job to run tests and coverage for a Golang project; report coverage to Coveralls
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.21
+      - name: Install dependencies
+        run: go mod download
+      - name: Run tests
+        run: go test -v -vet=all -coverprofile=profile.cov ./...
+      - name: Install goveralls
+        run: go install github.com/mattn/goveralls@latest
+      - name: Report coverage to Coveralls
+        env:
+          COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: goveralls -coverprofile=covprofile -service=github

compiler/source_map_test.go

@@ -0,0 +1,226 @@
+package compiler
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestSourceMap_Add(t *testing.T) {
+	type args struct {
+		t         token
+		destRange Range
+	}
+	tests := map[string]struct {
+		args     args
+		toSource map[int]map[int]Position
+		toTarget map[int]map[int]Position
+	}{
+		"first line": {
+			args: args{
+				t: token{
+					lit:  "foo",
+					line: 1,
+					col:  1,
+				},
+				destRange: Range{
+					From: Position{Line: 1, Col: 1},
+					To:   Position{Line: 1, Col: 3},
+				},
+			},
+			toSource: map[int]map[int]Position{
+				0: {
+					0: {Line: 0, Col: 0},
+					1: {Line: 0, Col: 1},
+					2: {Line: 0, Col: 2},
+					3: {Line: 0, Col: 3},
+				},
+			},
+			toTarget: map[int]map[int]Position{
+				0: {
+					0: {Line: 0, Col: 0},
+					1: {Line: 0, Col: 1},
+					2: {Line: 0, Col: 2},
+					3: {Line: 0, Col: 3},
+				},
+			},
+		},
+		"non-first line": {
+			args: args{
+				t: token{
+					lit:  "foo",
+					line: 2,
+					col:  10,
+				},
+				destRange: Range{
+					From: Position{Line: 5, Col: 3},
+					To:   Position{Line: 5, Col: 5},
+				},
+			},
+			toSource: map[int]map[int]Position{
+				1: {
+					9:  {Line: 4, Col: 2},
+					10: {Line: 4, Col: 3},
+					11: {Line: 4, Col: 4},
+					12: {Line: 4, Col: 5},
+				},
+			},
+			toTarget: map[int]map[int]Position{
+				4: {
+					2: {Line: 1, Col: 9},
+					3: {Line: 1, Col: 10},
+					4: {Line: 1, Col: 11},
+					5: {Line: 1, Col: 12},
+				},
+			},
+		},
+	}
+	for name, tt := range tests {
+		t.Run(name, func(t *testing.T) {
+			sm := &SourceMap{
+				SourceLinesToTarget: make(map[int]map[int]Position),
+				TargetLinesToSource: make(map[int]map[int]Position),
+			}
+			sm.Add(tt.args.t, tt.args.destRange)
+			if !reflect.DeepEqual(tt.toSource, sm.SourceLinesToTarget) {
+				t.Errorf("expected source lines to target to be %v, got %v", tt.toSource, sm.SourceLinesToTarget)
+			}
+			if !reflect.DeepEqual(tt.toTarget, sm.TargetLinesToSource) {
+				t.Errorf("expected target lines to source to be %v, got %v", tt.toTarget, sm.TargetLinesToSource)
+			}
+		})
+	}
+}
+
+func TestSourceMap_SourcePositionFromTarget(t *testing.T) {
+	sm := &SourceMap{
+		SourceLinesToTarget: map[int]map[int]Position{
+			0: {
+				0: {Line: 0, Col: 0},
+				1: {Line: 0, Col: 1},
+				2: {Line: 0, Col: 2},
+				3: {Line: 0, Col: 3},
+			},
+			4: {
+				2: {Line: 1, Col: 9},
+				3: {Line: 1, Col: 10},
+				4: {Line: 1, Col: 11},
+				5: {Line: 1, Col: 12},
+			},
+		},
+		TargetLinesToSource: map[int]map[int]Position{
+			0: {
+				0: {Line: 0, Col: 0},
+				1: {Line: 0, Col: 1},
+				2: {Line: 0, Col: 2},
+				3: {Line: 0, Col: 3},
+			},
+			1: {
+				9:  {Line: 4, Col: 2},
+				10: {Line: 4, Col: 3},
+				11: {Line: 4, Col: 4},
+				12: {Line: 4, Col: 5},
+			},
+		},
+	}
+	type args struct {
+		line int
+		col  int
+	}
+	tests := map[string]struct {
+		args     args
+		expected Position
+		ok       bool
+	}{
+		"first line": {
+			args:     args{line: 0, col: 1},
+			expected: Position{Line: 0, Col: 1},
+			ok:       true,
+		},
+		"not found": {
+			args: args{line: 1, col: 1},
+		},
+		"non-first line": {
+			args:     args{line: 1, col: 10},
+			expected: Position{Line: 4, Col: 3},
+			ok:       true,
+		},
+	}
+	for name, tt := range tests {
+		t.Run(name, func(t *testing.T) {
+			got, ok := sm.SourcePositionFromTarget(tt.args.line, tt.args.col)
+			if !reflect.DeepEqual(tt.expected, got) {
+				t.Errorf("expected source position to be %v, got %v", tt.expected, got)
+			}
+			if tt.ok != ok {
+				t.Errorf("expected ok to be %v, got %v", tt.ok, ok)
+			}
+		})
+	}
+}
+
+func TestSourceMap_TargetPositionFromSource(t *testing.T) {
+	sm := &SourceMap{
+		SourceLinesToTarget: map[int]map[int]Position{
+			0: {
+				0: {Line: 0, Col: 0},
+				1: {Line: 0, Col: 1},
+				2: {Line: 0, Col: 2},
+				3: {Line: 0, Col: 3},
+			},
+			4: {
+				2: {Line: 1, Col: 9},
+				3: {Line: 1, Col: 10},
+				4: {Line: 1, Col: 11},
+				5: {Line: 1, Col: 12},
+			},
+		},
+		TargetLinesToSource: map[int]map[int]Position{
+			0: {
+				0: {Line: 0, Col: 0},
+				1: {Line: 0, Col: 1},
+				2: {Line: 0, Col: 2},
+				3: {Line: 0, Col: 3},
+			},
+			1: {
+				9:  {Line: 4, Col: 2},
+				10: {Line: 4, Col: 3},
+				11: {Line: 4, Col: 4},
+				12: {Line: 4, Col: 5},
+			},
+		},
+	}
+	type args struct {
+		line int
+		col  int
+	}
+	tests := map[string]struct {
+		args     args
+		expected Position
+		ok       bool
+	}{
+		"first line": {
+			args:     args{line: 0, col: 1},
+			expected: Position{Line: 0, Col: 1},
+			ok:       true,
+		},
+		"not found": {
+			args: args{line: 1, col: 1},
+		},
+		"non-first line": {
+			args:     args{line: 4, col: 3},
+			expected: Position{Line: 1, Col: 10},
+			ok:       true,
+		},
+	}
+	for name, tt := range tests {
+		t.Run(name, func(t *testing.T) {
+			got, ok := sm.TargetPositionFromSource(tt.args.line, tt.args.col)
+			if !reflect.DeepEqual(tt.expected, got) {
+				t.Errorf("expected target position to be %v, got %v", tt.expected, got)
+			}
+			if tt.ok != ok {
+				t.Errorf("expected ok to be %v, got %v", tt.ok, ok)
+			}
+		})
+	}
+}

examples/attributes/additional.goht

@@ -1,3 +1,4 @@
+package attributes
 
 // Additional attributes may be added to an element using the `@attributes`
 // command. This command accepts a list of additional attributes in the

examples/attributes/additional.goht.go

@@ -1,3 +1,4 @@
+package attributes
 
 // The class attribute is a bit special. You will often find yourself
 // working with not one, but several classes. This is why repeating

examples/attributes/classes.goht

@@ -1,3 +1,5 @@
+package attributes
+
 // Goht supports the Ruby 1.9 hash style of attributes. The other styles
 // such as HTML style, or Ruby rocket style are not supported. This should
 // not be a problem as the Ruby 1.9 style is very similar to the style used
@@ -23,7 +25,7 @@ var myDynamicValue = "foo"
 // You may include a comma after the last attribute if you wish but it is
 // not required.
 
-@goht MultiLineAttrs() {
+@goht MultilineAttrs() {
 %p{
   class: #{myDynamicValue},
   id: "bar",

examples/attributes/classes.goht.go

@@ -1,3 +1,5 @@
+package attributes
+
 // For most attribute names you can include the name in the list
 // of attributes just as you expect it to appear in the HTML. Names
 // that contain alphanumeric characters, dashes (-), and

examples/attributes/general.goht

@@ -1,3 +1,4 @@
+package attributes
 
 // Attributes may conditionally appear in the output. For example, you may
 // want to add the `disabled` attribute to a button if a variable is true.

examples/attributes/general.goht.go

@@ -1,3 +1,5 @@
+package commands
+
 // Any template can be included into another template; assuming that
 // you have not created a circular reference, this will not cause the
 // compiler to loop but will instead cause the generated code to

examples/attributes/names.goht

@@ -1,3 +1,5 @@
+package commands
+
 // You include other templates using the `@render` command. It takes
 // the name of the template to render.
 // The `@render` command is used in combination with the rendering
@@ -15,5 +17,5 @@
 @goht RenderWithChildrenExample() {
 %p The other template will be rendered below.
 = @render ChildrenExample()
-  %p this content will be rendered by the other template.
+  %span this content will be rendered by the other template.
 }