Update mob and item list functionality (#351)

Jasrags · web-flow · commit 06317f0926f2 · 2025-04-27T20:21:25.000-05:00
* Added in Getters for Screen width and height to apply default values if no screen information has been received and cast the native uint32 to int as that is the downstream type that is used.

* Added templates/layout.go and the shared DynamicList function as part of a larger refactor

* Modifed mob and item list to use DynamicList for rendering of results as well as fixing sort by tolowering the names

* Added a message if no items are returned

* added tests
diff --git a/internal/connections/clientsettings.go b/internal/connections/clientsettings.go
@@ -1,17 +1,39 @@
 package connections
 
+const (
+	// DefaultScreenWidth is the default width of the screen
+	DefaultScreenWidth = 80
+	// DefaultScreenHeight is the default height of the screen
+	DefaultScreenHeight = 24
+)
+
 type ClientSettings struct {
 	Display DisplaySettings
 	// Is MSP enabled?
 	MSPEnabled        bool // Do they accept sound in their client?
 	SendTelnetGoAhead bool // Defaults false, should we send a IAC GA after prompts?
 }
 
+func (c ClientSettings) IsMsp() bool {
+	return c.MSPEnabled
+}
+
 type DisplaySettings struct {
 	ScreenWidth  uint32
 	ScreenHeight uint32
 }
 
-func (c ClientSettings) IsMsp() bool {
-	return c.MSPEnabled
+func (c DisplaySettings) GetScreenWidth() int {
+	if c.ScreenWidth == 0 {
+		return DefaultScreenWidth
+	}
+
+	return int(c.ScreenWidth)
+}
+
+func (c DisplaySettings) GetScreenHeight() int {
+	if c.ScreenHeight == 0 {
+		return DefaultScreenHeight
+	}
+	return int(c.ScreenHeight)
 }
diff --git a/internal/templates/layout.go b/internal/templates/layout.go
@@ -0,0 +1,48 @@
+package templates
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/GoMudEngine/GoMud/internal/term"
+)
+
+// DynamicList takes a slice of NameDescription items and formats them into a string
+// NOTE: This is a first step to moving dynamic lists into a common function.
+func DynamicList(itmNames []NameDescription, colWidth, sw, numWidth, longestName int) string {
+	if len(itmNames) == 0 {
+		return `<ansi fg="202">No items to display.</ansi>`
+	}
+
+	strOut := ``
+	totalLen := 0
+	for idx, itm := range itmNames {
+
+		if totalLen+colWidth > sw {
+			strOut += term.CRLFStr
+			totalLen = 0
+		}
+
+		numStr := strconv.Itoa(idx + 1)
+
+		strOut += ` `
+
+		if itm.Marked {
+			strOut += `<ansi fg="white-bold" bg="059">`
+		}
+
+		strOut += strings.Repeat(` `, numWidth-len(numStr)) + fmt.Sprintf(`<ansi fg="red-bold">%s</ansi>`, strconv.Itoa(idx+1)) + `. ` +
+			fmt.Sprintf(`<ansi fg="yellow-bold">%s</ansi>`, itm.Name) + strings.Repeat(` `, longestName-len(itm.Name))
+
+		if itm.Marked {
+			strOut += `</ansi>`
+		}
+
+		strOut += ` `
+
+		totalLen += colWidth
+
+	}
+	return strOut
+}
diff --git a/internal/templates/layout_test.go b/internal/templates/layout_test.go
@@ -0,0 +1,62 @@
+package templates_test
+
+import (
+	"testing"
+
+	"github.com/GoMudEngine/GoMud/internal/templates"
+	"github.com/GoMudEngine/GoMud/internal/term"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestDynamicList(t *testing.T) {
+	tests := []struct {
+		name           string
+		itmNames       []templates.NameDescription
+		colWidth       int
+		sw             int
+		numWidth       int
+		longestName    int
+		expectedOutput string
+	}{
+		{
+			name:           "Empty list",
+			itmNames:       []templates.NameDescription{},
+			colWidth:       20,
+			sw:             80,
+			numWidth:       2,
+			longestName:    10,
+			expectedOutput: `<ansi fg="202">No items to display.</ansi>`,
+		},
+		{
+			name: "Single item",
+			itmNames: []templates.NameDescription{
+				{Name: "Item1", Marked: false},
+			},
+			colWidth:       20,
+			sw:             80,
+			numWidth:       2,
+			longestName:    10,
+			expectedOutput: `  <ansi fg="red-bold">1</ansi>. <ansi fg="yellow-bold">Item1</ansi>      `,
+		},
+		{
+			name: "Multiple items with wrapping",
+			itmNames: []templates.NameDescription{
+				{Name: "Item1", Marked: false},
+				{Name: "Item2", Marked: true},
+				{Name: "Item3", Marked: false},
+			},
+			colWidth:       20,
+			sw:             40,
+			numWidth:       2,
+			longestName:    10,
+			expectedOutput: `  <ansi fg="red-bold">1</ansi>. <ansi fg="yellow-bold">Item1</ansi>       <ansi fg="white-bold" bg="059"> <ansi fg="red-bold">2</ansi>. <ansi fg="yellow-bold">Item2</ansi>     </ansi> ` + term.CRLFStr + `  <ansi fg="red-bold">3</ansi>. <ansi fg="yellow-bold">Item3</ansi>      `,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			output := templates.DynamicList(tt.itmNames, tt.colWidth, tt.sw, tt.numWidth, tt.longestName)
+			assert.Equal(t, tt.expectedOutput, output, "DynamicList() output mismatch")
+		})
+	}
+}
diff --git a/internal/usercommands/admin.item.go b/internal/usercommands/admin.item.go
@@ -69,87 +69,51 @@ func Item(rest string, user *users.UserRecord, room *rooms.Room, flags events.Ev
 	return true, nil
 }
 
-func item_List(rest string, user *users.UserRecord, room *rooms.Room, flags events.EventFlag) (bool, error) {
+func item_List(rest string, user *users.UserRecord, _ *rooms.Room, _ events.EventFlag) (bool, error) {
 
 	itmNames := []templates.NameDescription{}
-
 	longestName := 0
-	for _, itm := range items.GetAllItemNames() {
+
+	for _, itm := range items.GetAllItemSpecs() {
 
 		entry := templates.NameDescription{
-			Name: itm,
+			Id:   itm.ItemId,
+			Name: itm.Name,
 		}
 
 		// If searching for matches
 		if len(rest) > 0 {
 			if !strings.Contains(rest, `*`) {
 				rest += `*`
 			}
-			if util.StringWildcardMatch(strings.ToLower(itm), rest) {
-				entry.Marked = true
+			if !util.StringWildcardMatch(strings.ToLower(entry.Name), rest) {
+				continue
 			}
 		}
 
-		if len(itm) > longestName {
-			longestName = len(itm)
+		if len(entry.Name) > longestName {
+			longestName = len(entry.Name)
 		}
 
 		itmNames = append(itmNames, entry)
 	}
 
 	sort.SliceStable(itmNames, func(i, j int) bool {
-		return itmNames[i].Name < itmNames[j].Name
+		return strings.ToLower(itmNames[i].Name) < strings.ToLower(itmNames[j].Name)
 	})
 
 	numWidth := len(strconv.Itoa(len(itmNames)))
-	colWidth := 1 + numWidth + 2 +
-		longestName + 1
-	sw := 80
-	if user.ClientSettings().Display.ScreenWidth > 0 {
-		sw = int(user.ClientSettings().Display.ScreenWidth)
-	}
-
-	//cols := int(math.Floor(float64(sw) / float64(colWidth)))
+	colWidth := 1 + numWidth + 2 + longestName + 1
 
 	user.SendText(``)
-	strOut := ``
-	totalLen := 0
-	for idx, itm := range itmNames {
-
-		if totalLen+colWidth > sw {
-			strOut += term.CRLFStr
-			totalLen = 0
-		}
-
-		numStr := strconv.Itoa(idx + 1)
-
-		strOut += ` `
-
-		if itm.Marked {
-			strOut += `<ansi fg="white-bold" bg="059">`
-		}
-
-		strOut += strings.Repeat(` `, numWidth-len(numStr)) + fmt.Sprintf(`<ansi fg="red-bold">%s</ansi>`, strconv.Itoa(idx+1)) + `. ` +
-			fmt.Sprintf(`<ansi fg="yellow-bold">%s</ansi>`, itm.Name) + strings.Repeat(` `, longestName-len(itm.Name))
-
-		if itm.Marked {
-			strOut += `</ansi>`
-		}
-
-		strOut += ` `
-
-		totalLen += colWidth
-
-	}
-
+	sw := user.ClientSettings().Display.GetScreenWidth()
+	strOut := templates.DynamicList(itmNames, colWidth, sw, numWidth, longestName)
 	user.SendText(strOut)
 	user.SendText(``)
 
 	return true, nil
 }
 
-//  107. wooden shield                      108. worn boots
-
 func item_Spawn(rest string, user *users.UserRecord, room *rooms.Room, flags events.EventFlag) (bool, error) {
 
 	itemId := items.FindItem(rest)
diff --git a/internal/usercommands/admin.mob.go b/internal/usercommands/admin.mob.go
@@ -71,34 +71,47 @@ func Mob(rest string, user *users.UserRecord, room *rooms.Room, flags events.Eve
 	return true, nil
 }
 
-func mob_List(rest string, user *users.UserRecord, room *rooms.Room, flags events.EventFlag) (bool, error) {
+func mob_List(rest string, user *users.UserRecord, _ *rooms.Room, _ events.EventFlag) (bool, error) {
 
-	mobNames := []templates.NameDescription{}
+	mobList := []templates.NameDescription{}
+	longestName := 0
 
-	for _, nm := range mobs.GetAllMobNames() {
+	for _, mob := range mobs.GetAllMobInfo() {
+
+		entry := templates.NameDescription{
+			Id:   mob.MobId,
+			Name: mob.Character.Name,
+		}
 
 		// If searching for matches
 		if len(rest) > 0 {
 			if !strings.Contains(rest, `*`) {
 				rest += `*`
 			}
-
-			if !util.StringWildcardMatch(strings.ToLower(nm), rest) {
+			if !util.StringWildcardMatch(strings.ToLower(entry.Name), rest) {
 				continue
 			}
 		}
 
-		mobNames = append(mobNames, templates.NameDescription{
-			Name: nm,
-		})
+		if len(entry.Name) > longestName {
+			longestName = len(entry.Name)
+		}
+
+		mobList = append(mobList, entry)
 	}
 
-	sort.SliceStable(mobNames, func(i, j int) bool {
-		return mobNames[i].Name < mobNames[j].Name
+	sort.SliceStable(mobList, func(i, j int) bool {
+		return strings.ToLower(mobList[i].Name) < strings.ToLower(mobList[j].Name)
 	})
 
-	tplTxt, _ := templates.Process("tables/numbered-list-doubled", mobNames, user.UserId)
-	user.SendText(tplTxt)
+	numWidth := len(strconv.Itoa(len(mobList)))
+	colWidth := 1 + numWidth + 2 + longestName + 1
+
+	user.SendText(``)
+	sw := user.ClientSettings().Display.GetScreenWidth()
+	strOut := templates.DynamicList(mobList, colWidth, sw, numWidth, longestName)
+	user.SendText(strOut)
+	user.SendText(``)
 
 	return true, nil
 }
