feat: specs format

.gitignore

@@ -4,3 +4,5 @@
 dist/
 
 coverage.*
+
+.direnv

go.mod

@@ -5,8 +5,11 @@ go 1.22.1
 require (
 	github.com/antlr4-go/antlr/v4 v4.13.1
 	github.com/gkampitakis/go-snaps v0.5.13
+	github.com/sergi/go-diff v1.0.0
 )
 
+require gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
+
 require github.com/goccy/go-yaml v1.18.0 // indirect
 
 require (

go.sum

@@ -37,6 +37,8 @@ github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/f
 github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII=
 github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ=
+github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
 github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
 github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
@@ -59,7 +61,8 @@ golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
 golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

internal/ansi/ansi.go

@@ -1,22 +1,95 @@
 package ansi
 
-import "fmt"
+import (
+	"fmt"
+	"strings"
+)
 
 const resetCol = "\033[0m"
 
+func Compose(cols ...func(string) string) func(string) string {
+	return func(s string) string {
+		for _, mod := range cols {
+			s = mod(s)
+		}
+		return s
+	}
+}
+
+func replaceLast(s, oldStr, newStr string) string {
+	lastIndex := strings.LastIndex(s, oldStr)
+	if lastIndex == -1 {
+		return s
+	}
+	return s[:lastIndex] + newStr + s[lastIndex+len(oldStr):]
+}
+
 func col(s string, code int) string {
-	c := fmt.Sprintf("\033[%dm", code)
-	return c + s + resetCol
+	colorCode := fmt.Sprintf("\033[%dm", code)
+	// This trick should allow to stack colors (TODO test)
+	s = replaceLast(s, resetCol, resetCol+colorCode)
+	return colorCode + s + resetCol
 }
 
 func ColorRed(s string) string {
 	return col(s, 31)
 }
 
+func ColorWhite(s string) string {
+	return col(s, 37)
+}
+
+func ColorGreen(s string) string {
+	return col(s, 32)
+}
+
 func ColorYellow(s string) string {
 	return col(s, 33)
 }
 
 func ColorCyan(s string) string {
 	return col(s, 36)
 }
+
+func ColorLight(s string) string {
+	return col(s, 97) // Bright white → light
+}
+
+func ColorBrightBlack(s string) string {
+	return col(s, 90)
+}
+
+func ColorBrightRed(s string) string {
+	return col(s, 91)
+}
+
+func ColorBrightGreen(s string) string {
+	return col(s, 92)
+}
+
+func ColorBrightYellow(s string) string {
+	return col(s, 93)
+}
+
+// BG
+func BgDark(s string) string {
+	return col(s, 100)
+}
+
+func BgRed(s string) string {
+	return col(s, 41)
+}
+
+func BgGreen(s string) string {
+	return col(s, 42)
+}
+
+// modifiers
+
+func Bold(s string) string {
+	return col(s, 1)
+}
+
+func Underline(s string) string {
+	return col(s, 4)
+}

internal/cmd/root.go

@@ -25,6 +25,7 @@ func Execute(options CliOptions) {
 
 	rootCmd.AddCommand(lspCmd)
 	rootCmd.AddCommand(checkCmd)
+	rootCmd.AddCommand(getTestCmd())
 	rootCmd.AddCommand(getRunCmd())
 
 	if err := rootCmd.Execute(); err != nil {

internal/cmd/run.go

@@ -8,7 +8,6 @@ import (
 	"os"
 	"strings"
 
-	"github.com/formancehq/numscript/internal/ansi"
 	"github.com/formancehq/numscript/internal/flags"
 	"github.com/formancehq/numscript/internal/interpreter"
 	"github.com/formancehq/numscript/internal/parser"
@@ -21,7 +20,7 @@ const (
 	OutputFormatJson   = "json"
 )
 
-type Args struct {
+type runArgs struct {
 	VariablesOpt string
 	BalancesOpt  string
 	MetaOpt      string
@@ -38,7 +37,7 @@ type inputOpts struct {
 	Balances  interpreter.Balances         `json:"balances"`
 }
 
-func (o *inputOpts) fromRaw(opts Args) error {
+func (o *inputOpts) fromRaw(opts runArgs) error {
 	if opts.RawOpt == "" {
 		return nil
 	}
@@ -50,7 +49,7 @@ func (o *inputOpts) fromRaw(opts Args) error {
 	return nil
 }
 
-func (o *inputOpts) fromStdin(opts Args) error {
+func (o *inputOpts) fromStdin(opts runArgs) error {
 	if !opts.StdinFlag {
 		return nil
 	}
@@ -67,7 +66,7 @@ func (o *inputOpts) fromStdin(opts Args) error {
 	return nil
 }
 
-func (o *inputOpts) fromOptions(path string, opts Args) error {
+func (o *inputOpts) fromOptions(path string, opts runArgs) error {
 	if path != "" {
 		numscriptContent, err := os.ReadFile(path)
 		if err != nil {
@@ -108,7 +107,7 @@ func (o *inputOpts) fromOptions(path string, opts Args) error {
 	return nil
 }
 
-func run(path string, opts Args) error {
+func run(path string, opts runArgs) error {
 	opt := inputOpts{
 		Variables: make(map[string]string),
 		Meta:      make(interpreter.AccountsMetadata),
@@ -172,26 +171,19 @@ func showJson(result *interpreter.ExecutionResult) error {
 }
 
 func showPretty(result *interpreter.ExecutionResult) error {
-	fmt.Println(ansi.ColorCyan("Postings:"))
-	postingsJson, err := json.MarshalIndent(result.Postings, "", "  ")
-	if err != nil {
-		return fmt.Errorf("error marshaling postings: %w", err)
-	}
-	fmt.Println(string(postingsJson))
-
-	fmt.Println()
+	fmt.Println("Postings:")
+	fmt.Println(interpreter.PrettyPrintPostings(result.Postings))
 
-	fmt.Println(ansi.ColorCyan("Meta:"))
-	txMetaJson, err := json.MarshalIndent(result.Metadata, "", "  ")
-	if err != nil {
-		return fmt.Errorf("error marshaling metadata: %w", err)
+	if len(result.Metadata) != 0 {
+		fmt.Println("Meta:")
+		fmt.Println(interpreter.PrettyPrintMeta(result.Metadata))
 	}
-	fmt.Println(string(txMetaJson))
+
 	return nil
 }
 
 func getRunCmd() *cobra.Command {
-	opts := Args{}
+	opts := runArgs{}
 
 	cmd := cobra.Command{
 		Use:   "run",

internal/cmd/test.go

@@ -0,0 +1,51 @@
+package cmd
+
+import (
+	"os"
+
+	"github.com/formancehq/numscript/internal/specs_format"
+	"github.com/spf13/cobra"
+)
+
+type testArgs struct {
+	paths []string
+}
+
+var opts = testArgs{}
+
+func runTestCmd() {
+	files, err := specs_format.ReadSpecsFiles(opts.paths)
+	if err != nil {
+		_, _ = os.Stderr.Write([]byte(err.Error()))
+		os.Exit(1)
+		return
+	}
+
+	pass := specs_format.RunSpecs(os.Stdout, os.Stderr, files)
+	if !pass {
+		os.Exit(1)
+	}
+}
+
+func getTestCmd() *cobra.Command {
+
+	cmd := &cobra.Command{
+		Use:   "test folder...",
+		Short: "Test numscript file using the numscript specs format",
+		Long: `Searches for any <file>.num.specs files in the given directory (or directories),
+and tests the corresponding <file>.num file (if any).
+Defaults to "." if there are no given paths`,
+		Args: cobra.MatchAll(),
+		Run: func(cmd *cobra.Command, paths []string) {
+
+			if len(paths) == 0 {
+				paths = []string{"."}
+			}
+
+			opts.paths = paths
+			runTestCmd()
+		},
+	}
+
+	return cmd
+}

internal/interpreter/__snapshots__/balances_test.snap

@@ -0,0 +1,7 @@
+
+[TestPrettyPrintBalance - 1]
+| Account | Asset | Balance |
+| alice   | EUR/2    | 1       |
+| alice   | USD/1234 | 999999  |
+| bob     | BTC      | 3       |
+---

internal/interpreter/accounts_metadata.go

@@ -0,0 +1,50 @@
+package interpreter
+
+import (
+	"github.com/formancehq/numscript/internal/utils"
+)
+
+func (m AccountsMetadata) fetchAccountMetadata(account string) AccountMetadata {
+	return utils.MapGetOrPutDefault(m, account, func() AccountMetadata {
+		return AccountMetadata{}
+	})
+}
+
+func (m AccountsMetadata) DeepClone() AccountsMetadata {
+	cloned := make(AccountsMetadata)
+	for account, accountBalances := range m {
+		for asset, metadataValue := range accountBalances {
+			clonedAccountBalances := cloned.fetchAccountMetadata(account)
+			utils.MapGetOrPutDefault(clonedAccountBalances, asset, func() string {
+				return metadataValue
+			})
+		}
+	}
+	return cloned
+}
+
+func (m AccountsMetadata) Merge(update AccountsMetadata) {
+	for acc, accBalances := range update {
+		cachedAcc := utils.MapGetOrPutDefault(m, acc, func() AccountMetadata {
+			return AccountMetadata{}
+		})
+
+		for curr, amt := range accBalances {
+			cachedAcc[curr] = amt
+		}
+	}
+}
+
+func (m AccountsMetadata) PrettyPrint() string {
+	header := []string{"Account", "Name", "Value"}
+
+	var rows [][]string
+	for account, accMetadata := range m {
+		for name, value := range accMetadata {
+			row := []string{account, name, value}
+			rows = append(rows, row)
+		}
+	}
+
+	return utils.CsvPretty(header, rows, true)
+}