Parse builtin idents into a new node type

Author: FollowTheProcess

internal/syntax/ast/ast_test.go

@@ -58,13 +58,14 @@ func TestNode(t *testing.T) {
 		},
 		{
 			name: "builtin",
-			node: ast.Ident{
-				Name:  "test",
-				Token: token.Token{Kind: token.Ident, Start: 0, End: 4},
-				Type:  ast.KindBuiltin,
+			node: ast.Builtin{
+				Name:   "test",
+				Dollar: token.Token{Kind: token.Dollar, Start: 0, End: 1},
+				Token:  token.Token{Kind: token.Ident, Start: 1, End: 4},
+				Type:   ast.KindBuiltin,
 			},
-			start: token.Token{Kind: token.Ident, Start: 0, End: 4},
-			end:   token.Token{Kind: token.Ident, Start: 0, End: 4},
+			start: token.Token{Kind: token.Dollar, Start: 0, End: 1},
+			end:   token.Token{Kind: token.Ident, Start: 1, End: 4},
 			kind:  ast.KindBuiltin,
 		},
 		{

internal/syntax/ast/expression.go

@@ -51,20 +51,24 @@ type Builtin struct {
 	// Name is the ident's name.
 	Name string `yaml:"name"`
 
+	// Dollar is the [token.Dollar] token marking
+	// the builtin.
+	Dollar token.Token `yaml:"dollar"`
+
 	// The [token.Ident] token.
 	Token token.Token `yaml:"token"`
 
 	// Type is the kind of ast node, in this case [KindBuiltin].
 	Type Kind `yaml:"type"`
 }
 
-// Start returns the first meaningful token in the Builtin, which is
-// the [token.Ident].
+// Start returns the first token in the Builtin, which is
+// the [token.Dollar] opening it.
 func (b Builtin) Start() token.Token {
-	return b.Token
+	return b.Dollar
 }
 
-// End returns the last token in the Builtin, which is also
+// End returns the last token in the Builtin, which is
 // the [token.Ident].
 func (b Builtin) End() token.Token {
 	return b.Token

internal/syntax/parser/parser.go

@@ -580,6 +580,8 @@ func (p *Parser) parseExpression(precedence int) (ast.Expression, error) {
 		expr, err = p.parseInterpolatedExpression(nil)
 	case token.Ident:
 		expr = p.parseIdent()
+	case token.Dollar:
+		expr, err = p.parseBuiltin()
 	case token.Body:
 		expr, err = p.parseBody()
 	default:
@@ -740,14 +742,34 @@ func (p *Parser) parseHeader() (ast.Header, error) {
 // parseIdent parses an Ident.
 func (p *Parser) parseIdent() ast.Ident {
 	ident := ast.Ident{
-		Name:  strings.TrimSpace(p.text()),
+		Name:  p.text(),
 		Token: p.current,
 		Type:  ast.KindIdent,
 	}
 
 	return ident
 }
 
+// parseBuiltin parses a Builtin identifier.
+func (p *Parser) parseBuiltin() (ast.Builtin, error) {
+	builtin := ast.Builtin{
+		Dollar: p.current,
+		Type:   ast.KindBuiltin,
+	}
+
+	if err := p.expect(token.Ident); err != nil {
+		return builtin, err
+	}
+
+	// TODO(@FollowTheProcess): Maybe Ident should be a child node in Builtin then?
+
+	// Now effectively just an ident
+	builtin.Token = p.current
+	builtin.Name = p.text()
+
+	return builtin, nil
+}
+
 // parseInterp parses an interpolation expression, i.e.
 // '{{' <expr> '}}'.
 func (p *Parser) parseInterp() (ast.Interp, error) {
@@ -756,8 +778,7 @@ func (p *Parser) parseInterp() (ast.Interp, error) {
 		Type: ast.KindInterp,
 	}
 
-	// TODO(@FollowTheProcess): For now we'll assume only idents are allowed here
-	if err := p.expect(token.Ident); err != nil {
+	if err := p.expect(token.Ident, token.Dollar); err != nil {
 		return result, err
 	}
 

internal/syntax/parser/parser_test.go

@@ -43,6 +43,7 @@ func TestParse(t *testing.T) {
 			p := parser.New(name, src)
 
 			parsed, err := p.Parse()
+			t.Logf("Diagnostics: %+v\n", p.Diagnostics())
 			test.Ok(t, err)
 
 			snap.Snap(parsed)

internal/syntax/parser/testdata/snapshots/TestParse/interpolation-builtin-body.http.snap

@@ -0,0 +1,85 @@
+source: parser_test.go
+expression: parsed
+---
+name: interpolation-builtin-body.http
+statements:
+  - url:
+      value: https://example.com/123
+      token:
+        kind: Text
+        start: 9
+        end: 32
+      type: TextLiteral
+    body:
+      left:
+        value: |-
+          {
+            "id": "
+        token:
+          kind: Body
+          start: 65
+          end: 76
+        type: Body
+      right:
+        value: |-
+          "
+          }
+        token:
+          kind: Body
+          start: 87
+          end: 91
+        type: Body
+      interp:
+        expr:
+          name: uuid
+          dollar:
+            kind: Dollar
+            start: 79
+            end: 80
+          token:
+            kind: Ident
+            start: 80
+            end: 84
+          type: Builtin
+        open:
+          kind: OpenInterp
+          start: 76
+          end: 78
+        close:
+          kind: CloseInterp
+          start: 85
+          end: 87
+        type: Interp
+      type: InterpolatedExpression
+    responseRedirect: null
+    responseReference: null
+    httpVersion: null
+    comment: null
+    vars: []
+    prompts: []
+    headers:
+      - value:
+          value: application/json
+          token:
+            kind: Text
+            start: 47
+            end: 63
+          type: TextLiteral
+        key: Content-Type
+        token:
+          kind: Header
+          start: 33
+          end: 45
+        type: Header
+    method:
+      token:
+        kind: MethodPost
+        start: 4
+        end: 8
+      type: Method
+    sep:
+      kind: Separator
+      start: 0
+      end: 3
+    type: Request
+type: File

internal/syntax/parser/testdata/snapshots/TestParse/interpolation-builtin-global.http.snap

@@ -0,0 +1,95 @@
+source: parser_test.go
+expression: parsed
+---
+name: interpolation-builtin-global.http
+statements:
+  - value:
+      left: null
+      right: null
+      interp:
+        expr:
+          name: uuid
+          dollar:
+            kind: Dollar
+            start: 9
+            end: 10
+          token:
+            kind: Ident
+            start: 10
+            end: 14
+          type: Builtin
+        open:
+          kind: OpenInterp
+          start: 6
+          end: 8
+        close:
+          kind: CloseInterp
+          start: 15
+          end: 17
+        type: Interp
+      type: InterpolatedExpression
+    ident:
+      name: id
+      token:
+        kind: Ident
+        start: 1
+        end: 3
+      type: Ident
+    at:
+      kind: At
+      start: 0
+      end: 1
+    type: VarStatement
+  - url:
+      left:
+        value: https://example.com/
+        token:
+          kind: Text
+          start: 32
+          end: 52
+        type: TextLiteral
+      right: null
+      interp:
+        expr:
+          name: id
+          token:
+            kind: Ident
+            start: 55
+            end: 57
+          type: Ident
+        open:
+          kind: OpenInterp
+          start: 52
+          end: 54
+        close:
+          kind: CloseInterp
+          start: 58
+          end: 60
+        type: Interp
+      type: InterpolatedExpression
+    body: null
+    responseRedirect: null
+    responseReference: null
+    httpVersion: null
+    comment:
+      text: Test
+      token:
+        kind: Comment
+        start: 23
+        end: 27
+      type: Comment
+    vars: []
+    prompts: []
+    headers: []
+    method:
+      token:
+        kind: MethodGet
+        start: 28
+        end: 31
+      type: Method
+    sep:
+      kind: Separator
+      start: 19
+      end: 22
+    type: Request
+type: File

internal/syntax/parser/testdata/snapshots/TestParse/interpolation-builtin-inline.http.snap

@@ -0,0 +1,62 @@
+source: parser_test.go
+expression: parsed
+---
+name: interpolation-builtin-inline.http
+statements:
+  - url:
+      left:
+        value: https://example.com/
+        token:
+          kind: Text
+          start: 13
+          end: 33
+        type: TextLiteral
+      right: null
+      interp:
+        expr:
+          name: uuid
+          dollar:
+            kind: Dollar
+            start: 36
+            end: 37
+          token:
+            kind: Ident
+            start: 37
+            end: 41
+          type: Builtin
+        open:
+          kind: OpenInterp
+          start: 33
+          end: 35
+        close:
+          kind: CloseInterp
+          start: 42
+          end: 44
+        type: Interp
+      type: InterpolatedExpression
+    body: null
+    responseRedirect: null
+    responseReference: null
+    httpVersion: null
+    comment:
+      text: Test
+      token:
+        kind: Comment
+        start: 4
+        end: 8
+      type: Comment
+    vars: []
+    prompts: []
+    headers: []
+    method:
+      token:
+        kind: MethodGet
+        start: 9
+        end: 12
+      type: Method
+    sep:
+      kind: Separator
+      start: 0
+      end: 3
+    type: Request
+type: File

internal/syntax/parser/testdata/valid/interpolation-builtin-body.http

@@ -0,0 +1,7 @@
+###
+POST https://example.com/123
+Content-Type: application/json
+
+{
+  "id": "{{ $uuid }}"
+}

internal/syntax/parser/testdata/valid/interpolation-builtin-global.http

@@ -0,0 +1,4 @@
+@id = {{ $uuid }}
+
+### Test
+GET https://example.com/{{ id }}

internal/syntax/parser/testdata/valid/interpolation-builtin-inline.http

@@ -0,0 +1,2 @@
+### Test
+GET https://example.com/{{ $uuid }}