Add search for cli menu (#78)

* feat: Implement search for cli menu

* chore(internal/utils): Add tests for helper functions

* refactor: Fix sonar code smells

* fix(scripts): Fix style fmt script

* style: Gofmt

* refactor: Fix codecl warnings

* refactor: Fix sonar bugs

* tests: Improve tests coverage

Author: obalunenko

cmd/aoc-cli/handlers.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/briandowns/spinner"
 	"github.com/manifoldco/promptui"
+	promptlist "github.com/manifoldco/promptui/list"
 	log "github.com/obalunenko/logger"
 	"github.com/urfave/cli/v2"
 
@@ -73,19 +74,21 @@ func menu(ctx context.Context) cli.ActionFunc {
 
 		years := puzzles.GetYears()
 
+		items := makeMenuItemsList(years, exit)
+
 		prompt := promptui.Select{
 			Label:             "Years menu (exit' for exit)",
-			Items:             append(years, exit),
+			Items:             items,
 			Size:              pageSize,
 			CursorPos:         0,
 			IsVimMode:         false,
 			HideHelp:          false,
 			HideSelected:      false,
 			Templates:         nil,
 			Keys:              nil,
-			Searcher:          nil,
+			Searcher:          searcher(items),
 			StartInSearchMode: false,
-			Pointer:           nil,
+			Pointer:           promptui.DefaultCursor,
 			Stdin:             nil,
 			Stdout:            nil,
 		}
@@ -97,17 +100,19 @@ func menu(ctx context.Context) cli.ActionFunc {
 func menuPuzzle(ctx context.Context, year string) error {
 	solvers := puzzles.DaysByYear(year)
 
+	items := makeMenuItemsList(solvers, back, exit)
+
 	prompt := promptui.Select{
 		Label:             "Puzzles menu (exit' for exit; back - to return to year selection)",
-		Items:             append(solvers, back, exit),
+		Items:             items,
 		Size:              pageSize,
 		CursorPos:         0,
 		IsVimMode:         false,
 		HideHelp:          false,
 		HideSelected:      false,
 		Templates:         nil,
 		Keys:              nil,
-		Searcher:          nil,
+		Searcher:          searcher(items),
 		StartInSearchMode: false,
 		Pointer:           promptui.DefaultCursor,
 		Stdin:             nil,
@@ -117,6 +122,28 @@ func menuPuzzle(ctx context.Context, year string) error {
 	return handlePuzzleChoices(ctx, year, prompt)
 }
 
+func makeMenuItemsList(list []string, commands ...string) []string {
+	items := make([]string, 0, len(list)+len(commands))
+
+	items = append(items, list...)
+
+	items = append(items, commands...)
+
+	return items
+}
+
+func searcher(items []string) promptlist.Searcher {
+	return func(input string, index int) bool {
+		itm := items[index]
+
+		itm = strings.ReplaceAll(strings.ToLower(itm), " ", "")
+
+		input = strings.ReplaceAll(strings.ToLower(input), " ", "")
+
+		return strings.Contains(itm, input)
+	}
+}
+
 func handleYearChoices(ctx context.Context, opt promptui.Select) error {
 	for {
 		_, choice, err := opt.Run()

cmd/aoc-cli/handlers_test.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_makeMenuItemsList(t *testing.T) {
+	type args struct {
+		list     []string
+		commands []string
+	}
+
+	tests := []struct {
+		name string
+		args args
+		want []string
+	}{
+		{
+			name: "without commands",
+			args: args{
+				list:     []string{"1", "2", "3"},
+				commands: nil,
+			},
+			want: []string{"1", "2", "3"},
+		},
+		{
+			name: "with commands",
+			args: args{
+				list:     []string{"1", "2", "3"},
+				commands: []string{"cmd1", "cmd2"},
+			},
+			want: []string{"1", "2", "3", "cmd1", "cmd2"},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := makeMenuItemsList(tt.args.list, tt.args.commands...)
+
+			assert.Equal(t, tt.want, got)
+		})
+	}
+}
+
+func Test_searcher(t *testing.T) {
+	items := makeMenuItemsList([]string{"one", "two", "three"}, exit)
+
+	s := searcher(items)
+
+	assert.True(t, s("o", 0))
+
+	assert.Panics(t, func() {
+		s("o", 10)
+	})
+
+	assert.True(t, s("t", 2))
+
+	assert.False(t, s("1", 2))
+}

internal/puzzles/common/utils/file_test.go

@@ -0,0 +1,47 @@
+package utils
+
+import (
+	"io"
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestReaderFromFile(t *testing.T) {
+	type args struct {
+		tb    testing.TB
+		fpath string
+	}
+
+	tests := []struct {
+		name string
+		args args
+		want io.Reader
+	}{
+		{
+			name: "",
+			args: args{
+				tb:    t,
+				fpath: filepath.Join("testdata", "reader.txt"),
+			},
+			want: strings.NewReader("Hello there!\n"),
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := ReaderFromFile(tt.args.tb, tt.args.fpath)
+
+			gotR, err := io.ReadAll(got)
+			require.NoError(t, err)
+
+			wantR, err := io.ReadAll(tt.want)
+			require.NoError(t, err)
+
+			assert.Equal(t, string(wantR), string(gotR))
+		})
+	}
+}

internal/puzzles/common/utils/testdata/reader.txt

@@ -0,0 +1 @@
+Hello there!

internal/puzzles/solutions/2016/day02/solution.go

@@ -36,16 +36,16 @@ func (s solution) Part2(input io.Reader) (string, error) {
 func part2(input io.Reader) (string, error) {
 	kpd := loadKeypadPart2()
 
-	return getPassword(kpd, input)
+	return getDoorCode(kpd, input)
 }
 
 func part1(input io.Reader) (string, error) {
 	kpd := loadKeypadPart1()
 
-	return getPassword(kpd, input)
+	return getDoorCode(kpd, input)
 }
 
-func getPassword(kpd keypad, input io.Reader) (string, error) {
+func getDoorCode(kpd keypad, input io.Reader) (string, error) {
 	reader := bufio.NewReader(input)
 
 	var pwd strings.Builder

scripts/style/fmt.sh

@@ -15,6 +15,6 @@ checkInstalled 'gofmt'
 
 GO_FILES=$(find . -type f -name '*.go' | grep -v 'vendor' | grep -v '.git')
 
-gofmt -s -w -l ${GO_FILES}
+gofmt -s -w ${GO_FILES}
 
 echo "${SCRIPT_NAME} done."