Merge pull request #16 from yannick2009/master

Feature and Refactor: Custom Text Support, Logging Cleanup, and CLI Refinement

Author: prime-run

cmd/fetch.go

@@ -5,61 +5,35 @@ package cmd
 import (
 	"encoding/json"
 	"fmt"
-	"github.com/spf13/cobra"
-	"io"
-	"net/http"
 	"strings"
-	"time"
-)
-
-func formatText(text string) string {
-	text = strings.TrimSpace(text)
-
-	text = strings.Join(strings.Fields(text), " ")
 
-	text = strings.Map(func(r rune) rune {
-		if r < 32 || r > 126 {
-			return -1
-		}
-		return r
-	}, text)
+	"github.com/prime-run/go-typer/types"
+	"github.com/prime-run/go-typer/utils"
+	"github.com/spf13/cobra"
+)
 
-	return text
-}
+const (
+	ModeDefault   types.Mode = "default"   // default mode
+	ModeWords     types.Mode = "words"     // word mode
+	ModeSentences types.Mode = "sentences" // sentence mode
 
-func formatForGameMode(text string, mode string) string {
-	text = formatText(text)
+	zenQuotesAPIURL = "https://zenquotes.io/api/random" // ZenQuotes API URL
+	bibleAPIURL     = "https://bible-api.com/john+3:16" // Bible API URL
+)
 
-	switch mode {
-	case "words":
-		words := strings.Fields(text)
-		return strings.Join(words, "\n")
-	case "sentences":
-		text = strings.ReplaceAll(text, ".", ".\n")
-		text = strings.ReplaceAll(text, "!", "!\n")
-		text = strings.ReplaceAll(text, "?", "?\n")
-		lines := strings.Split(text, "\n")
-		var cleanLines []string
-		for _, line := range lines {
-			if clean := strings.TrimSpace(line); clean != "" {
-				cleanLines = append(cleanLines, clean)
-			}
-		}
-		return strings.Join(cleanLines, "\n")
-	default:
-		return text
-	}
+func init() {
+	rootCmd.AddCommand(fetchCmd)
 }
 
 var fetchCmd = &cobra.Command{
 	Use:   "fetch",
 	Short: "Test text fetching from APIs",
 	Run: func(cmd *cobra.Command, args []string) {
-		modes := []string{"default", "words", "sentences"}
+		modes := []types.Mode{ModeDefault, ModeWords, ModeSentences}
 
 		fmt.Println("Trying ZenQuotes API...")
-		zenQuotes := &TextSource{
-			URL: "https://zenquotes.io/api/random",
+		zenQuotes := &types.TextSource{
+			URL: zenQuotesAPIURL,
 			Parser: func(body []byte) (string, error) {
 				var result []struct {
 					Quote  string `json:"q"`
@@ -72,11 +46,11 @@ var fetchCmd = &cobra.Command{
 					return "", fmt.Errorf("no quotes found in response")
 				}
 
-				quote := formatText(result[0].Quote)
-				author := formatText(result[0].Author)
+				quote := utils.FormatText(result[0].Quote)
+				author := utils.FormatText(result[0].Author)
 
 				formattedQuote := quote
-				if !strings.HasSuffix(quote, ".") && !strings.HasSuffix(quote, "!") && !strings.HasSuffix(quote, "?") {
+				if utils.HasPonctuationSuffix(quote) {
 					formattedQuote += "."
 				}
 				return fmt.Sprintf("%s - %s", formattedQuote, author), nil
@@ -88,27 +62,23 @@ var fetchCmd = &cobra.Command{
 			fmt.Printf("\nZenQuotes API success:\n")
 			for _, mode := range modes {
 				formatted := formatForGameMode(text, mode)
-				fmt.Printf("\nMode: %s\n", mode)
-				fmt.Printf("Text:\n%s\n", formatted)
-				fmt.Printf("Character count: %d\n", len(formatted))
-				fmt.Printf("Line count: %d\n", len(strings.Split(formatted, "\n")))
+				utils.PrintTextStats(mode, formatted)
 			}
 		}
 
 		fmt.Println("\nTrying Bible API...")
-		bible := &TextSource{
-			URL: "https://bible-api.com/john+3:16",
+		bible := &types.TextSource{
+			URL: bibleAPIURL,
 			Parser: func(body []byte) (string, error) {
 				var result struct {
-					Text      string `json:"text"`
-					Reference string `json:"reference"`
+					Text string `json:"text"`
 				}
 				if err := json.Unmarshal(body, &result); err != nil {
 					return "", fmt.Errorf("failed to parse JSON: %w", err)
 				}
 
-				verse := formatText(result.Text)
-				// WARN:don't include the reference for typing practice
+				verse := utils.FormatText(result.Text)
+				// !WARN: don't include the reference for typing practice
 				return verse, nil
 			},
 		}
@@ -118,47 +88,44 @@ var fetchCmd = &cobra.Command{
 			fmt.Printf("\nBible API success:\n")
 			for _, mode := range modes {
 				formatted := formatForGameMode(text, mode)
-				fmt.Printf("\nMode: %s\n", mode)
-				fmt.Printf("Text:\n%s\n", formatted)
-				fmt.Printf("Character count: %d\n", len(formatted))
-				fmt.Printf("Line count: %d\n", len(strings.Split(formatted, "\n")))
+				utils.PrintTextStats(mode, formatted)
 			}
 		}
 	},
 }
 
-type TextSource struct {
-	URL    string
-	Parser func([]byte) (string, error)
-}
-
-func (s *TextSource) FetchText() (string, error) {
-	client := &http.Client{
-		Timeout: 10 * time.Second,
-	}
+// formatForGameMode formats the text based on the specified game mode.
+func formatForGameMode(text string, mode types.Mode) string {
+	text = utils.FormatText(text)
 
-	fmt.Printf("Fetching from URL: %s\n", s.URL)
-	resp, err := client.Get(s.URL)
-	if err != nil {
-		return "", fmt.Errorf("failed to fetch: %w", err)
+	switch mode {
+	case ModeWords:
+		return formatForWords(text)
+	case ModeSentences:
+		return formatForSentences(text)
+	default:
+		return text
 	}
-	defer resp.Body.Close()
+}
 
-	if resp.StatusCode != http.StatusOK {
-		return "", fmt.Errorf("API returned status %d", resp.StatusCode)
-	}
+// formatForWords formats the text for word mode by splitting it into lines based on spaces.
+// Each word is placed on a new line.
+func formatForWords(text string) string {
+	words := strings.Fields(text)
+	return strings.Join(words, "\n")
+}
 
-	body, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return "", fmt.Errorf("failed to read response: %w", err)
-	}
+// formatForSentences formats the text for sentence mode by splitting it into lines based on punctuation.
+func formatForSentences(text string) string {
+	text = strings.ReplaceAll(text, ".", ".\n")
+	text = strings.ReplaceAll(text, "!", "!\n")
+	text = strings.ReplaceAll(text, "?", "?\n")
 
-	if s.Parser != nil {
-		return s.Parser(body)
+	var cleanLines []string
+	for line := range strings.Lines(text) {
+		if clean := strings.TrimSpace(line); clean != "" {
+			cleanLines = append(cleanLines, clean)
+		}
 	}
-	return string(body), nil
-}
-
-func init() {
-	rootCmd.AddCommand(fetchCmd)
+	return strings.Join(cleanLines, "\n")
 }

cmd/main.go

@@ -2,31 +2,40 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/prime-run/go-typer/ui"
-	"github.com/spf13/cobra"
 	"os"
 	"path/filepath"
 	"strings"
+
+	devlog "github.com/prime-run/go-typer/log"
+	"github.com/prime-run/go-typer/ui"
+	"github.com/prime-run/go-typer/utils"
+	"github.com/spf13/cobra"
 )
 
-var cursorType string
-var themeName string
-var listThemes bool
-var debugMode bool
+var (
+	cursorType string // Cursor type (block or underline)
+	themeName  string // Theme name or path to custom theme file
+	listThemes bool   // List available themes and exit
+	debugMode  bool   // Enable debug mode for performance analysis
+	customText string // Custom text to display in the game
+	filePath   string // Custom text file to read from
+)
 
 var startCmd = &cobra.Command{
 	Use:   "start",
 	Short: "Start a new game",
-	Long:  `Start a new game of Go Typer. This command will initialize a new game session.`,
+	Long:  "Start a new game of Go Typer. This command will initialize a new game session.",
 	Run: func(cmd *cobra.Command, args []string) {
+		// check if the debug mode is enabled and set the log level accordingly
 		if debugMode {
-			ui.DebugEnabled = true
-			ui.InitDebugLog()
-			defer ui.CloseDebugLog()
+			devlog.DebugEnabled = true
+			devlog.InitLog()
+			defer devlog.CloseLog()
 
-			cmd.Printf("Debug mode enabled, logging to %s\n", filepath.Join(getConfigDirPath(), "debug.log"))
+			cmd.Printf("Debug mode enabled, logging to %s\n", filepath.Join(utils.GetConfigDirPath(), "debug.log"))
 		}
 
+		// check if listThemes is enabled and list available themes
 		if listThemes {
 			themes := ui.ListAvailableThemes()
 			fmt.Println("Available themes:")
@@ -36,91 +45,61 @@ var startCmd = &cobra.Command{
 			return
 		}
 
+		// check for theme name and load the theme
 		if themeName != "" {
+			fmt.Printf("Theme name provided: %s", themeName)
 			if strings.HasPrefix(themeName, "-") {
 				cmd.Printf("Warning: Invalid theme name '%s'. Theme names cannot start with '-'.\n", themeName)
 				cmd.Println("Using saved settings")
-			} else if isValidThemeName(themeName) {
+			} else if utils.IsValidThemeName(themeName) {
 				if err := ui.LoadTheme(themeName); err != nil {
 					cmd.Printf("Warning: Could not load theme '%s': %v\n", themeName, err)
 					cmd.Println("Using saved settings")
 				} else {
 					ui.UpdateStyles()
-					cmd.Printf("Using theme: %s\n", getDisplayThemeName(themeName))
-
+					cmd.Printf("Using theme: %s\n", utils.GetDisplayThemeName(themeName))
 					ui.CurrentSettings.ThemeName = themeName
 				}
 			} else {
 				cmd.Printf("Warning: Invalid theme name '%s'. Using saved settings.\n", themeName)
 			}
 		}
 
+		// check for custom text and set it
+		if filePath != "" {
+			data, err := os.ReadFile(filePath)
+			if err != nil {
+				cmd.Printf("Warning: Could not read custom text file '%s': %v\n", filePath, err)
+			} else {
+				customText = string(data)
+			}
+		}
+
+		// check for cursor type and set it
 		if cursorType != "" {
 			ui.CurrentSettings.CursorType = cursorType
 		}
 
+		// apply settings and start loading
 		ui.ApplySettings()
-
-		ui.StartLoadingWithOptions(ui.CurrentSettings.CursorType)
+		ui.StartLoadingWithOptions(ui.CurrentSettings.CursorType, customText)
 	},
 }
 
-func getConfigDirPath() string {
-	configDir, err := ui.GetConfigDir()
-	if err != nil {
-		return os.TempDir()
-	}
-	return configDir
-}
-
-func isValidThemeName(name string) bool {
-	if strings.Contains(name, ".") && !strings.HasSuffix(name, ".yml") {
-		return false
-	}
-
-	if strings.Contains(name, "/") || strings.Contains(name, "\\") {
-		_, err := os.Stat(name)
-		return err == nil
-	}
-
-	for _, c := range name {
-		if !isValidThemeNameChar(c) {
-			return false
-		}
-	}
-
-	return true
-}
-
-func isValidThemeNameChar(c rune) bool {
-	return (c >= 'a' && c <= 'z') ||
-		(c >= 'A' && c <= 'Z') ||
-		(c >= '0' && c <= '9') ||
-		c == '_' || c == '-'
-}
-
-func getDisplayThemeName(themeName string) string {
-	if strings.Contains(themeName, "/") || strings.Contains(themeName, "\\") {
-		themeName = filepath.Base(themeName)
-	}
-
-	themeName = strings.TrimSuffix(themeName, ".yml")
-
-	words := strings.Split(themeName, "_")
-	for i, word := range words {
-		if len(word) > 0 {
-			words[i] = strings.ToUpper(word[0:1]) + word[1:]
-		}
-	}
-
-	return strings.Join(words, " ")
-}
-
 func init() {
-	rootCmd.AddCommand(startCmd)
-	startCmd.Flags().BoolP("verbose", "v", false, "Enable verbose output")
+	// Cursor and theme configuration
 	startCmd.Flags().StringVarP(&cursorType, "cursor", "c", "block", "Cursor type (block or underline)")
 	startCmd.Flags().StringVarP(&themeName, "theme", "t", "", "Theme name or path to custom theme file (default: default)")
 	startCmd.Flags().BoolVar(&listThemes, "list-themes", false, "List available themes and exit")
+
+	// Debug and logging options
+	startCmd.Flags().BoolP("verbose", "v", false, "Enable verbose output")
 	startCmd.Flags().BoolVar(&debugMode, "debug", false, "Enable debug mode for performance analysis")
+
+	// Custom text option
+	startCmd.Flags().StringVarP(&customText, "text", "x", "", "Custom text to display in the game (default: random text)")
+	startCmd.Flags().StringVarP(&filePath, "file", "f", "", "Custom text file to read from")
+
+	// Add command to root
+	rootCmd.AddCommand(startCmd)
 }

cmd/root.go

@@ -28,6 +28,5 @@ func Execute() {
 
 func init() {
 	ui.InitSettings()
-
-	rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
+	// rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }