feat: Add optional metrics; Add load spinner while solving puzzle (#45)

* feat: Add optional metrics; Add load spinner while solving puzzle

* fix: Linter warnings

* fix: Linter warnings

* chore: Remove deadcode

Author: obalunenko

cmd/aoc-cli/main.go

@@ -8,7 +8,9 @@ import (
 	"fmt"
 	"os"
 	"strings"
+	"time"
 
+	"github.com/briandowns/spinner"
 	"github.com/manifoldco/promptui"
 	log "github.com/obalunenko/logger"
 	"github.com/obalunenko/version"
@@ -42,6 +44,8 @@ func main() {
 	app.Version = version.GetVersion()
 	app.Email = "[email protected]"
 
+	app.Flags = flags()
+
 	app.Action = menu(ctx)
 	app.Before = printVersion
 	app.After = onExit
@@ -55,6 +59,41 @@ func main() {
 	}
 }
 
+const (
+	flagElapsed        = "elapsed"
+	flagShortElapsed   = "e"
+	flagBenchmark      = "bench"
+	flagShortBenchmark = "b"
+)
+
+func flags() []cli.Flag {
+	var res []cli.Flag
+
+	elapsed := cli.BoolFlag{
+		Name:        fmt.Sprintf("%s, %s", flagElapsed, flagShortElapsed),
+		Usage:       "Enables elapsed time metric",
+		EnvVar:      "",
+		FilePath:    "",
+		Required:    false,
+		Hidden:      false,
+		Destination: nil,
+	}
+
+	benchmark := cli.BoolFlag{
+		Name:        fmt.Sprintf("%s, %s", flagBenchmark, flagShortBenchmark),
+		Usage:       "Enables benchmark metric",
+		EnvVar:      "",
+		FilePath:    "",
+		Required:    false,
+		Hidden:      false,
+		Destination: nil,
+	}
+
+	res = append(res, elapsed, benchmark)
+
+	return res
+}
+
 func onExit(_ *cli.Context) error {
 	fmt.Println("Exit...")
 
@@ -63,6 +102,8 @@ func onExit(_ *cli.Context) error {
 
 func menu(ctx context.Context) cli.ActionFunc {
 	return func(c *cli.Context) error {
+		ctx = contextWithOptions(ctx, optionsFromCli(c))
+
 		years := puzzles.GetYears()
 
 		prompt := promptui.Select{
@@ -156,13 +197,19 @@ func handlePuzzleChoices(ctx context.Context, year string, opt promptui.Select)
 			return nil
 		}
 
-		res, err := run(year, choice)
+		stopSpinner := setSpinner()
+
+		res, err := run(ctx, year, choice)
 		if err != nil {
 			log.WithError(ctx, err).Error("Puzzle run failed")
 
+			stopSpinner()
+
 			continue
 		}
 
+		stopSpinner()
+
 		fmt.Println(res.String())
 	}
 }
@@ -179,7 +226,44 @@ func isBack(in string) bool {
 	return strings.EqualFold(back, in)
 }
 
-func run(year, day string) (puzzles.Result, error) {
+func optionsFromCli(c *cli.Context) []puzzles.RunOption {
+	const optsnum = 2
+
+	options := make([]puzzles.RunOption, 0, optsnum)
+
+	if c.GlobalBool(flagElapsed) || c.GlobalBool(flagShortElapsed) {
+		options = append(options, puzzles.WithElapsed())
+	}
+
+	if c.GlobalBool(flagBenchmark) || c.GlobalBool(flagShortBenchmark) {
+		options = append(options, puzzles.WithBenchmark())
+	}
+
+	return options
+}
+
+type optsCtxKey struct{}
+
+func contextWithOptions(ctx context.Context, opts []puzzles.RunOption) context.Context {
+	if len(opts) == 0 {
+		return ctx
+	}
+
+	return context.WithValue(ctx, optsCtxKey{}, opts)
+}
+
+func optionsFromContext(ctx context.Context) []puzzles.RunOption {
+	v := ctx.Value(optsCtxKey{})
+
+	opts, ok := v.([]puzzles.RunOption)
+	if !ok {
+		return []puzzles.RunOption{}
+	}
+
+	return opts
+}
+
+func run(ctx context.Context, year, day string) (puzzles.Result, error) {
 	s, err := puzzles.GetSolver(year, day)
 	if err != nil {
 		return puzzles.Result{}, fmt.Errorf("failed to get solver: %w", err)
@@ -195,10 +279,34 @@ func run(year, day string) (puzzles.Result, error) {
 		return puzzles.Result{}, fmt.Errorf("failed to open input data: %w", err)
 	}
 
-	res, err := puzzles.Run(s, bytes.NewReader(asset))
+	opts := optionsFromContext(ctx)
+
+	res, err := puzzles.Run(s, bytes.NewReader(asset), opts...)
 	if err != nil {
 		return puzzles.Result{}, fmt.Errorf("failed to run [%s]: %w", fullName, err)
 	}
 
 	return res, nil
 }
+
+// setSpinner runs the displaying of spinner to handle long time operations. Returns stop func.
+func setSpinner() func() {
+	const delayms = 100
+
+	s := spinner.New(
+		spinner.CharSets[62],
+		delayms*time.Millisecond,
+		spinner.WithFinalMSG("Solved!"),
+		spinner.WithHiddenCursor(true),
+		spinner.WithColor("yellow"),
+		spinner.WithWriter(os.Stderr),
+	)
+
+	s.Prefix = "Solving in progress..."
+
+	s.Start()
+
+	return func() {
+		s.Stop()
+	}
+}

cmd/aoc-cli/main_test.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -23,6 +24,8 @@ type testcase struct {
 
 // Regression tests for all puzzles. Check that answers still correct.
 func Test_run(t *testing.T) {
+	ctx := context.Background()
+
 	var tests []testcase
 
 	tests = append(tests, invalid()...)
@@ -35,7 +38,7 @@ func Test_run(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got, err := run(tt.args.year, tt.args.name)
+			got, err := run(ctx, tt.args.year, tt.args.name)
 			if tt.wantErr {
 				require.Error(t, err)
 

go.mod

@@ -3,6 +3,7 @@ module github.com/obalunenko/advent-of-code
 go 1.17
 
 require (
+	github.com/briandowns/spinner v1.13.0
 	github.com/manifoldco/promptui v0.9.0
 	github.com/obalunenko/logger v0.1.0
 	github.com/obalunenko/version v1.1.0
@@ -16,7 +17,10 @@ require (
 	github.com/cpuguy83/go-md2man/v2 v2.0.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/evalphobia/logrus_sentry v0.8.2 // indirect
+	github.com/fatih/color v1.7.0 // indirect
 	github.com/getsentry/raven-go v0.2.0 // indirect
+	github.com/mattn/go-colorable v0.1.2 // indirect
+	github.com/mattn/go-isatty v0.0.8 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect

go.sum

@@ -1,4 +1,6 @@
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/briandowns/spinner v1.13.0 h1:q/Y9LtpwtvL0CRzXrAMj0keVXqNhBYUFg6tBOUiY8ek=
+github.com/briandowns/spinner v1.13.0/go.mod h1:QOuQk7x+EaDASo80FEXwlwiA+j/PPIcX3FScO+3/ZPQ=
 github.com/certifi/gocertifi v0.0.0-20210507211836-431795d63e8d h1:S2NE3iHSwP0XV47EEXL8mWmRdEfGscSJ+7EgePNgt0s=
 github.com/certifi/gocertifi v0.0.0-20210507211836-431795d63e8d/go.mod h1:sGbDF6GwGcLpkNXPUTkMRoywsNa/ol15pxFe6ERfguA=
 github.com/chzyer/logex v1.1.10 h1:Swpa1K6QvQznwJRcfTfQJmTE72DqScAa40E+fbHEXEE=
@@ -15,10 +17,16 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/evalphobia/logrus_sentry v0.8.2 h1:dotxHq+YLZsT1Bb45bB5UQbfCh3gM/nFFetyN46VoDQ=
 github.com/evalphobia/logrus_sentry v0.8.2/go.mod h1:pKcp+vriitUqu9KiWj/VRFbRfFNUwz95/UkgG8a6MNc=
+github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
+github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/getsentry/raven-go v0.2.0 h1:no+xWJRb5ZI7eE8TWgIq1jLulQiIoLG0IfYxv5JYMGs=
 github.com/getsentry/raven-go v0.2.0/go.mod h1:KungGk8q33+aIAZUIVWZDr2OfAEBsO49PX4NzFV5kcQ=
 github.com/manifoldco/promptui v0.9.0 h1:3V4HzJk1TtXW1MTZMP7mdlwbBpIinw3HztaIlYthEiA=
 github.com/manifoldco/promptui v0.9.0/go.mod h1:ka04sppxSGFAtxX0qhlYQjISsg9mR4GWtQEhdbn6Pgg=
+github.com/mattn/go-colorable v0.1.2 h1:/bC9yWikZXAL9uJdulbSfyVNIR3n3trXl+v8+1sx8mU=
+github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
+github.com/mattn/go-isatty v0.0.8 h1:HLtExJ+uU2HOZ+wI0Tt5DtUDrx8yhUqDcp7fYERX4CE=
+github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
 github.com/obalunenko/logger v0.1.0 h1:CSdZZPXznz8DJQ1zFoy/uwCyynAVsZHuYdNLmtC/gSg=
 github.com/obalunenko/logger v0.1.0/go.mod h1:09zbNCrGvrIzuiKLQFy2yWWDh3R/lXkz3TZUtUa6FRg=
 github.com/obalunenko/version v1.1.0 h1:yVua7OHnK3+MJpendeMmAlfzVmq7R1h8MO3Ufz7HEec=
@@ -40,6 +48,7 @@ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/urfave/cli v1.22.5 h1:lNq9sAHXK2qfdI8W+GRItjCEkI+2oR4d+MEHy1CKXoU=
 github.com/urfave/cli v1.22.5/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0=
 golang.org/x/sys v0.0.0-20181122145206-62eef0e2fa9b/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20211109184856-51b60fd695b3 h1:T6tyxxvHMj2L1R2kZg0uNMpS8ZhB9lRa9XRGTCSA65w=
 golang.org/x/sys v0.0.0-20211109184856-51b60fd695b3/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

internal/puzzles/utils/intcomputer/doc.go renamed to internal/puzzles/common/intcomputer/doc.go

@@ -54,3 +54,10 @@ const (
 
 	yearSentinel
 )
+
+const (
+	unknown    = "unknown"
+	unsolved   = "not solved"
+	undefined  = "undefined"
+	inProgress = "in progress"
+)

internal/puzzles/utils/intcomputer/intcomputer.go renamed to internal/puzzles/common/intcomputer/intcomputer.go

@@ -0,0 +1,12 @@
+package puzzles
+
+import "errors"
+
+var (
+	// ErrInvalidPuzzleName means that such puzzle not exist.
+	ErrInvalidPuzzleName = errors.New("invalid puzzle name")
+	// ErrInvalidYear means that such year not exist.
+	ErrInvalidYear = errors.New("invalid year")
+	// ErrNotImplemented signal that puzzle in not implemented yet.
+	ErrNotImplemented = errors.New("not implemented")
+)