Merge pull request #3 from mark0smith/dev

merge dev

Author: mark0smith

.github/workflows/go.yml

@@ -0,0 +1,38 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: Go
+
+on:
+  release:
+    types: [created]
+
+permissions:
+    contents: write
+    packages: write
+
+jobs:
+  releases-matrix:
+    name: Release Go Binary
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # build and publish in parallel: linux/386, linux/amd64, linux/arm64, windows/386, windows/amd64, darwin/amd64, darwin/arm64
+        goos: [linux, windows, darwin]
+        goarch: ["386", amd64, arm64]
+        exclude:
+          - goarch: "386"
+            goos: darwin
+          - goarch: arm64
+            goos: windows
+    steps:
+    - uses: actions/checkout@v3
+    - uses: wangyoucao577/go-release-action@v1
+      with:
+        github_token: ${{ secrets.TOKEN }}
+        goos: ${{ matrix.goos }}
+        goarch: ${{ matrix.goarch }}
+        goversion: "https://dl.google.com/go/go1.21.2.linux-amd64.tar.gz"
+        project_path: "."
+        binary_name: "goFindMyself"
+        extra_files: README.md

.gitignore

@@ -18,6 +18,9 @@
 # vendor/
 
 # Go workspace file
-go.work
+# go.work
 
 .vscode
+*.txt
+hello
+*.db

README.md

@@ -1,2 +1,84 @@
 # goFindMyself
 For Golang learning and memory practices.
+
+## Usage
+```
+> ./hello -h
+Usage of ./hello:
+  -hint int
+        If set, when recall test failes, hint will be given.
+        0 for no hint, 1 for diff hint, 2 for full hint
+  -m int
+        Generated number wont't be bigger than this number. (default 100)
+  -n int
+        Number of Random Numbers. (default 30)
+  -r rememberLogfile
+        If set, generated numbers will be logged into rememberLogfile.
+        You should set this if you want to do recall test later!
+  -r_file string
+        Filename of remember log (default "log.txt")
+  -recall
+        If set, run a recall test, instead of generating random numbers.
+  -recallLog recallLogfile
+        If set, recall info will be logged into recallLogfile. (default true)
+  -recall_file string
+        Filename of recall log (default "recall_log.txt")
+  -u    If set, all generated numbers will be unique. (default true)
+```
+
+If running without any parameters, this program generates 30 random numbers in range of (0,100).
+```
+> ./hello
+2023-10-05 22:06:51 Random Number is [48 17 29 83 97 96 14 44 78 74 35 90 58 38 68 33 77 63 85 2 3 25 81 84 9 32 61 5 53 37]
+```
+
+You can specific numbers count by `-n` and range maxium by `-m`.
+```
+> ./hello -n 4 -m 10
+2023-10-05 22:08:28 Random Number is [3 0 6 1]
+```
+
+## Memory Practice
+
+If you want to log these numbers for later recalling test, you should specific `-r`, thus numbers will be written into `log.txt`.
+You can Specific filename by `-r_file`.
+```
+> ./hello -r
+2023-10-05 22:10:58 Random Number is [64 57 8 54 79 15 97 39 37 7 13 11 67 6 78 80 36 60 32 83 70 59 25 27 92 35 9 75 1 22]
+> tail -n1 log.txt
+2023-10-05 22:10:58 [64 57 8 54 79 15 97 39 37 7 13 11 67 6 78 80 36 60 32 83 70 59 25 27 92 35 9 75 1 22]
+```
+
+If you believe you have remember these numbers and wanna have a recall test, you can add `-recall`.
+If `-hint int` is set, some hint will be given if you are wrong, 0 for no hint, 1 for diff hint, 2 for full hint
+
+```
+> ./hello -recall                                                                                                                                                   
+What do you remember?                                                                                                                                                                                             
+13 40 70 56 96 55 82 63 92 71 85 83 46 1 4 7 67 87 61 57 81 18 72 58 31 36 52 53 78                                                                                                                               
+                                                                                                                                                                                                                  
+You have entered: 13 40 70 56 96 55 82 63 92 71 85 83 46 1 4 7 67 87 61 57 81 18 72 58 31 36 52 53 78                                                                                                             
+Are you sure you remember it right?                                                                                                                                                                               
+> ./hello -recall -hint 1
+What do you remember?
+13 40 70 56 96 55 82 63 92 71 85 83 46 1 4 7 67 87 61 57 81 18 72 58 31 36 52 53 78
+
+You have entered: 13 40 70 56 96 55 82 63 92 71 85 83 46 1 4 7 67 87 61 57 81 18 72 58 31 36 52 53 78
+Are you sure you remember it right?
+
+Hint Part:
+You are missing these numbers: 26
+You add these numbers which should't exist: 
+> ./hello -recall -hint 2
+What do you remember?
+13 40 70 56 96 55 82 63 92 71 85 83 46 1 4 7 67 87 61 57 81 18 72 58 31 36 52 53 78
+
+You have entered: 13 40 70 56 96 55 82 63 92 71 85 83 46 1 4 7 67 87 61 57 81 18 72 58 31 36 52 53 78
+Are you sure you remember it right?
+
+Hint Part:
+The Right: 13 40 70 56 96 55 82 63 92 71 26 85 83 46 1 4 7 67 87 61 57 81 18 72 58 31 36 52 53 78
+The Wrong: 13 40 70 56 96 55 82 63 92 71 85 83 46 1 4 7 67 87 61 57 81 18 72 58 31 36 52 53 78
+```
+
+

go.mod

@@ -1,3 +1,11 @@
-module example/hello
+module findmyself
 
 go 1.21.1
+
+require github.com/fatih/color v1.15.0
+
+require (
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.17 // indirect
+	golang.org/x/sys v0.6.0 // indirect
+)

go.sum

@@ -0,0 +1,10 @@
+github.com/fatih/color v1.15.0 h1:kOqh6YHBtK8aywxGerMG2Eq3H6Qgoqeo13Bk2Mv/nBs=
+github.com/fatih/color v1.15.0/go.mod h1:0h5ZqXfHYED7Bhv2ZJamyIOUej9KtShiJESRwBDUSsw=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng=
+github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

go.work

@@ -0,0 +1,6 @@
+go 1.21.2
+
+use (
+	.
+	./utils
+)

hello.go

@@ -1,24 +1,103 @@
 package main
 
 import (
+	"flag"
 	"fmt"
-	"math/rand"
+	"log"
+	"strings"
+	"time"
+
+	"utils"
+
+	"github.com/fatih/color"
 )
 
-func generateUniqueRandomNumbers(n, max int) []int {
-	set := make(map[int]bool)
-	var result []int
-	for len(set) < n {
-		value := rand.Intn(max)
-		if !set[value] {
-			set[value] = true
-			result = append(result, value)
-		}
+// recall func
+func checkRecall(rememberLogfile string, recallLogfile string, recallLog bool, showhint int, dbfile string) {
+
+	fmt.Println("What do you remember?")
+	recallString := utils.ReadAndFormat()
+	fmt.Printf("\nYou have entered: %s\n", recallString)
+
+	// toCheck := fmt.Sprintf("[%s]", recallString)
+	// correctStr := utils.FindContentInFile(rememberLogfile, recallString)
+	correctStr := utils.FindContentInDB(dbfile, recallString)
+	recallResult := utils.CompareHint(dbfile, recallString, correctStr, showhint, true)
+
+	datetime := time.Now()
+	datetimeFormatted := datetime.Format("2006-01-02 15:04:05")
+	utils.AddRecalls(dbfile, []string{datetimeFormatted}, []string{recallString}, []string{fmt.Sprintf("%t", recallResult)})
+
+	if recallLog {
+		datetime := time.Now()
+		datetimeFormatted := datetime.Format("2006-01-02 15:04:05")
+		info := fmt.Sprintf("%s Recall: %s, Result: %v\n", datetimeFormatted, recallString, recallResult)
+		utils.WriteInfo(recallLogfile, info)
 	}
-	return result
 }
 
 func main() {
-	uniqueRandomNumbers := generateUniqueRandomNumbers(10, 100)
-	fmt.Printf("Random Number is %d\n", uniqueRandomNumbers)
+	log.SetFlags(log.Ldate | log.Ltime | log.Lmicroseconds | log.Llongfile)
+
+	num := flag.Int("n", 30, "Number of Random Numbers.")
+	maxium := flag.Int("m", 100, "Generated number wont't be bigger than this number.")
+	unique := flag.Bool("u", true, "If set, all generated numbers will be unique.")
+	remember := flag.Bool("r", false, "If set, generated numbers will be logged into `rememberLogfile`.\nYou should set this if you want to do recall test later!")
+	rememberLogfile := flag.String("r_file", "log.txt", "Filename of remember log")
+	recall := flag.Bool("recall", false, "If set, run a recall test, instead of generating random numbers.")
+	recallLog := flag.Bool("recallLog", true, "If set, recall info will be logged into `recallLogfile`.")
+	recallLogfile := flag.String("recall_file", "recall_log.txt", "Filename of recall log")
+	recallShowHint := flag.Int("hint", 0, "If set, when recall test failes, hint will be given.\n0 for no hint, 1 for diff hint, 2 for full hint")
+	dbFilename := flag.String("db", "data.db", "Filename of database")
+	migratedb := flag.Bool("migratedb", true, "If set, recall info will be logged into `recallLogfile`.")
+
+	flag.Parse()
+
+	if *migratedb {
+		utils.InitDB(*rememberLogfile, *recallLogfile, *dbFilename)
+	}
+
+	if *recall {
+		defer utils.Timer("checkRecall")()
+		checkRecall(*rememberLogfile, *recallLogfile, *recallLog, *recallShowHint, *dbFilename)
+		return
+	}
+
+	datetime := time.Now()
+	datetimeFormatted := datetime.Format("2006-01-02 15:04:05")
+
+	uniqueRandomNumbers := utils.GenerateRandomNumbers(*num, *maxium, *unique)
+
+	// format output string, making it easier to remember
+	var outputStr string
+	boldBlue := color.New(color.Bold, color.FgHiBlue).SprintFunc()
+	for idx, val := range uniqueRandomNumbers {
+		info := ""
+		if (idx+1)%5 == 0 {
+			info = fmt.Sprintf(" %-2s", boldBlue(fmt.Sprintf("%-2d", val)))
+			if (idx+1)%10 == 0 {
+				info += "\n"
+			}
+		} else {
+			if (idx+1)%10 == 1 {
+				info = fmt.Sprintf("%-2d", val)
+			} else {
+				info = fmt.Sprintf(" %-2d", val)
+			}
+		}
+		outputStr += info
+	}
+
+	fmt.Printf("%s Random Number Generated:\n%s\n", datetimeFormatted, outputStr)
+
+	// type of remember is a pointer, add `*` prefix to get its value
+	if *remember {
+		info := fmt.Sprintf("%s %d\n", datetimeFormatted, uniqueRandomNumbers)
+		filename := *rememberLogfile
+		utils.WriteInfo(filename, info)
+		numbersStr := fmt.Sprintf("%v", uniqueRandomNumbers)
+		numbersStr = strings.TrimPrefix(numbersStr, "[")
+		numbersStr = strings.TrimSuffix(numbersStr, "]")
+		utils.AddNumbers(*dbFilename, []string{datetimeFormatted}, []string{numbersStr})
+	}
 }