fix: PR comments: Add unit tests for icon_utils

Author: lazysegtree

src/internal/common/icon_utils.go

@@ -7,11 +7,11 @@ import (
 	"github.com/yorukot/superfile/src/config/icon"
 )
 
-func GetElementIcon(file string, isDir bool) icon.Style {
+func GetElementIcon(file string, isDir bool, nerdFont bool) icon.Style {
 	ext := strings.TrimPrefix(filepath.Ext(file), ".")
 	name := file
 
-	if !Config.Nerdfont {
+	if !nerdFont {
 		return icon.Style{
 			Icon:  "",
 			Color: Theme.FilePanelFG,

src/internal/common/icon_utils_test.go

@@ -0,0 +1,83 @@
+package common
+
+import (
+	"testing"
+
+	"github.com/yorukot/superfile/src/config/icon"
+)
+
+func TestGetElementIcon(t *testing.T) {
+	tests := []struct {
+		name     string
+		file     string
+		isDir    bool
+		nerdFont bool
+		expected icon.Style
+	}{
+		{
+			name:     "Non-nerdfont returns empty icon",
+			file:     "test.txt",
+			isDir:    false,
+			nerdFont: false,
+			expected: icon.Style{
+				Icon:  "",
+				Color: Theme.FilePanelFG,
+			},
+		},
+		{
+			name:     "Directory with nerd font",
+			file:     "folder",
+			isDir:    true,
+			nerdFont: true,
+			expected: icon.Folders["folder"],
+		},
+		{
+			name:     "File with known extension",
+			file:     "test.go",
+			isDir:    false,
+			nerdFont: true,
+			expected: icon.Icons["go"],
+		},
+		{
+			name:     ".git directory",
+			file:     ".git",
+			isDir:    true,
+			nerdFont: true,
+			expected: icon.Folders[".git"],
+		},
+		{
+			name:     "superfile directory",
+			file:     "superfile",
+			isDir:    true,
+			nerdFont: true,
+			expected: icon.Folders["superfile"],
+		},
+		{
+			name:     "package.json file",
+			file:     "package.json",
+			isDir:    false,
+			nerdFont: true,
+			expected: icon.Icons["package"],
+		},
+		{
+			name:     "File with unknown extension",
+			file:     "test.xyz",
+			isDir:    false,
+			nerdFont: true,
+			expected: icon.Style{
+				Icon: icon.Icons["file"].Icon,
+				// Theme is not defined here, so this will be blank
+				Color: Theme.FilePanelFG,
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := GetElementIcon(tt.file, tt.isDir, tt.nerdFont)
+			if result.Icon != tt.expected.Icon || result.Color != tt.expected.Color {
+				t.Errorf("GetElementIcon() = %v, want %v", result, tt.expected)
+			}
+		})
+	}
+}

src/internal/common/string_function.go

@@ -15,16 +15,16 @@ import (
 	"github.com/charmbracelet/x/exp/term/ansi"
 )
 
-func TruncateText(text string, maxChars int, talis string) string {
-	truncatedText := ansi.Truncate(text, maxChars-len(talis), "")
+func TruncateText(text string, maxChars int, tails string) string {
+	truncatedText := ansi.Truncate(text, maxChars-len(tails), "")
 	if text != truncatedText {
-		return truncatedText + talis
+		return truncatedText + tails
 	}
 
 	return text
 }
 
-func TruncateTextBeginning(text string, maxChars int, talis string) string {
+func TruncateTextBeginning(text string, maxChars int, tails string) string {
 	if ansi.StringWidth(text) <= maxChars {
 		return text
 	}
@@ -38,27 +38,27 @@ func TruncateTextBeginning(text string, maxChars int, talis string) string {
 		truncatedWidth = ansi.StringWidth(string(truncatedRunes))
 	}
 
-	if len(truncatedRunes) > len(talis) {
-		truncatedRunes = append([]rune(talis), truncatedRunes[len(talis):]...)
+	if len(truncatedRunes) > len(tails) {
+		truncatedRunes = append([]rune(tails), truncatedRunes[len(tails):]...)
 	}
 
 	return string(truncatedRunes)
 }
 
-func TruncateMiddleText(text string, maxChars int, talis string) string {
+func TruncateMiddleText(text string, maxChars int, tails string) string {
 	if utf8.RuneCountInString(text) <= maxChars {
 		return text
 	}
 
 	halfEllipsisLength := (maxChars - 3) / 2
-
-	truncatedText := text[:halfEllipsisLength] + talis + text[utf8.RuneCountInString(text)-halfEllipsisLength:]
+	// Todo : Use ansi.Substring to correctly handle ANSI escape codes
+	truncatedText := text[:halfEllipsisLength] + tails + text[utf8.RuneCountInString(text)-halfEllipsisLength:]
 
 	return truncatedText
 }
 
 func PrettierName(name string, width int, isDir bool, isSelected bool, bgColor lipgloss.Color) string {
-	style := GetElementIcon(name, isDir)
+	style := GetElementIcon(name, isDir, Config.Nerdfont)
 	if isSelected {
 		return StringColorRender(lipgloss.Color(style.Color), bgColor).
 			Background(bgColor).
@@ -73,15 +73,15 @@ func PrettierName(name string, width int, isDir bool, isSelected bool, bgColor l
 }
 
 func PrettierDirectoryPreviewName(name string, isDir bool, bgColor lipgloss.Color) string {
-	style := GetElementIcon(name, isDir)
+	style := GetElementIcon(name, isDir, Config.Nerdfont)
 	return StringColorRender(lipgloss.Color(style.Color), bgColor).
 		Background(bgColor).
 		Render(style.Icon+" ") +
 		FilePanelStyle.Render(name)
 }
 
 func ClipboardPrettierName(name string, width int, isDir bool, isSelected bool) string {
-	style := GetElementIcon(name, isDir)
+	style := GetElementIcon(name, isDir, Config.Nerdfont)
 	if isSelected {
 		return StringColorRender(lipgloss.Color(style.Color), FooterBGColor).
 			Background(FooterBGColor).
@@ -152,8 +152,8 @@ func IsBufferPrintable(buffer []byte) bool {
 	return true
 }
 
-// IsExensionExtractable checks if a string is a valid compressed archive file extension.
-func IsExensionExtractable(ext string) bool {
+// IsExtensionExtractable checks if a string is a valid compressed archive file extension.
+func IsExtensionExtractable(ext string) bool {
 	// Extensions based on the types that package: `xtractr` `ExtractFile` function handles.
 	validExtensions := map[string]struct{}{
 		".zip":     {},

src/internal/common/string_function_test.go

@@ -109,7 +109,7 @@ func TestIsExtensionExtractable(t *testing.T) {
 
 	for _, tt := range inputs {
 		t.Run(tt.ext, func(t *testing.T) {
-			result := IsExensionExtractable(tt.ext)
+			result := IsExtensionExtractable(tt.ext)
 			if result != tt.expected {
 				t.Errorf("IsExensionExtractable (%q) = %v; want %v", tt.ext, result, tt.expected)
 			}

src/internal/function.go

@@ -325,6 +325,8 @@ func (m *model) returnMetaData() {
 	if fileInfo.IsDir() {
 		m.fileMetaData.metaData = append(m.fileMetaData.metaData, [2]string{"Name", fileInfo.Name()})
 		if m.focusPanel == metadataFocus {
+			// Todo : Calling dirSize() could be expensive for large directories, as it recursively
+			// walks the entire tree. Consider lazy loading, caching, or an async approach to avoid UI lockups.
 			m.fileMetaData.metaData = append(m.fileMetaData.metaData, [2]string{"Size", common.FormatFileSize(dirSize(filePath))})
 		}
 		m.fileMetaData.metaData = append(m.fileMetaData.metaData, [2]string{"Date Modified", fileInfo.ModTime().String()})

src/internal/handle_file_operations.go

@@ -502,7 +502,7 @@ func (m *model) extractFile() {
 	}
 
 	ext := strings.ToLower(filepath.Ext(panel.element[panel.cursor].location))
-	if !common.IsExensionExtractable(ext) {
+	if !common.IsExtensionExtractable(ext) {
 		slog.Error(fmt.Sprintf("Error unexpected file extension type: %s", ext), "error", errors.ErrUnsupported)
 		return
 	}

src/internal/ui/sidebar/ReadMe.md

@@ -8,12 +8,10 @@ This is for the sidebar UI, and for fetching and updating sidebar directories
 - Implementing a proper state transitioning for the sidebar's different modes (normal, search, rename)
 - Some methods could be made more pure by reducing side effects
 
-# Coverage
 # Coverage
 
 ```bash
-cd /path/to/ui/prompt
+cd /path/to/ui/sidebar
 go test -cover
 ```
-Current coverage is 74.0%.
-Current coverage
+Current coverage is 29.3%.

src/internal/utils/fzf_utils.go

@@ -6,6 +6,8 @@ import "github.com/reinhrst/fzf-lib"
 func FzfSearch(query string, source []string) []fzf.MatchResult {
 	fzfSearcher := fzf.New(source, fzf.DefaultOptions())
 	fzfSearcher.Search(query)
+	// Todo : This is a blocking call, which will cause the UI to freeze if the query is slow.
+	// Need to put a timeout on this
 	fzfResults := <-fzfSearcher.GetResultChannel()
 	fzfSearcher.End()
 	return fzfResults.Matches