Merge pull request #141 from digitalghost-dev/1.2.3

1.2.3

Author: digitalghost-dev

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ on:
       - main
 
 env:
-  VERSION_NUMBER: 'v1.2.2'
+  VERSION_NUMBER: 'v1.2.3'
   DOCKERHUB_REGISTRY_NAME: 'digitalghostdev/poke-cli'
   AWS_REGION: 'us-west-2'
 

.goreleaser.yaml

@@ -14,7 +14,7 @@ builds:
       - windows
       - darwin
     ldflags:
-      - -s -w -X main.version=v1.2.2
+      - -s -w -X main.version=v1.2.3
 
 archives:
   - format: tar.gz

Dockerfile

@@ -1,5 +1,5 @@
 # build 1
-FROM golang:1.24.1-alpine3.21 AS build
+FROM golang:1.24.2-alpine3.21 AS build
 
 WORKDIR /app
 
@@ -8,7 +8,7 @@ RUN go mod download
 
 COPY . .
 
-RUN go build -ldflags "-X main.version=v1.2.2" -o poke-cli .
+RUN go build -ldflags "-X main.version=v1.2.3" -o poke-cli .
 
 # build 2
 FROM --platform=$BUILDPLATFORM alpine:latest

README.md

@@ -2,7 +2,7 @@
     <img height="250" width="350" src="pokemon.svg" alt="pokemon-logo"/>
     <h1>Pokémon CLI</h1>
     <img src="https://img.shields.io/github/v/release/digitalghost-dev/poke-cli?style=flat-square&logo=git&logoColor=FFCC00&label=Release%20Version&labelColor=EEE&color=FFCC00" alt="version-label">
-    <img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v1.2.2?arch=arm64&style=flat-square&logo=docker&logoColor=FFCC00&labelColor=EEE&color=FFCC00" alt="docker-image-size">
+    <img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v1.2.3?arch=arm64&style=flat-square&logo=docker&logoColor=FFCC00&labelColor=EEE&color=FFCC00" alt="docker-image-size">
     <img src="https://img.shields.io/github/actions/workflow/status/digitalghost-dev/poke-cli/ci.yml?branch=main&style=flat-square&logo=github&logoColor=FFCC00&label=CI&labelColor=EEE&color=FFCC00" alt="ci-status-badge">
 </div>
 <div align="center">
@@ -76,11 +76,11 @@ View future plans in the [Roadmap](#roadmap) section.
 3. Choose how to interact with the container:
    * Run a single command and exit:
     ```bash
-    docker run --rm -it digitalghostdev/poke-cli:v1.2.2 <command> [subcommand] flag]
+    docker run --rm -it digitalghostdev/poke-cli:v1.2.3 <command> [subcommand] flag]
     ```
    * Enter the container and use its shell:
     ```bash
-    docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.2.2 -c "cd /app && exec sh"
+    docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.2.3 -c "cd /app && exec sh"
    # placed into the /app directory, run the program with './poke-cli'
    # example: ./poke-cli ability swift-swim
     ```

cli.go

@@ -4,7 +4,9 @@ import (
 	"flag"
 	"fmt"
 	"github.com/digitalghost-dev/poke-cli/cmd"
+	"github.com/digitalghost-dev/poke-cli/cmd/ability"
 	"github.com/digitalghost-dev/poke-cli/cmd/move"
+	"github.com/digitalghost-dev/poke-cli/cmd/natures"
 	"github.com/digitalghost-dev/poke-cli/cmd/search"
 	"github.com/digitalghost-dev/poke-cli/cmd/types"
 	"github.com/digitalghost-dev/poke-cli/flags"
@@ -22,7 +24,7 @@ func currentVersion() {
 		return
 	}
 
-	// Fallback to build info when version is not set
+	// Fallback to build info when the version is not set
 	buildInfo, ok := debug.ReadBuildInfo()
 	if !ok {
 		fmt.Println("Version: unknown (unable to read build info)")
@@ -36,6 +38,12 @@ func currentVersion() {
 	}
 }
 
+func printWrapper(f func() string) func() {
+	return func() {
+		fmt.Println(f())
+	}
+}
+
 func runCLI(args []string) int {
 	mainFlagSet := flag.NewFlagSet("poke-cli", flag.ContinueOnError)
 
@@ -89,11 +97,11 @@ func runCLI(args []string) int {
 	}
 
 	commands := map[string]func(){
-		"ability": cmd.AbilityCommand,
-		"move":    move.MoveCommand,
-		"natures": cmd.NaturesCommand,
+		"ability": printWrapper(ability.AbilityCommand),
+		"move":    printWrapper(move.MoveCommand),
+		"natures": printWrapper(natures.NaturesCommand),
 		"pokemon": cmd.PokemonCommand,
-		"types":   types.TypesCommand,
+		"types":   printWrapper(types.TypesCommand),
 		"search":  search.SearchCommand,
 	}
 

cmd/ability.go cmd/ability/ability.gocmd/ability.go renamed to cmd/ability/ability.go

@@ -1,8 +1,9 @@
-package cmd
+package ability
 
 import (
 	"flag"
 	"fmt"
+	"github.com/digitalghost-dev/poke-cli/cmd/utils"
 	"github.com/digitalghost-dev/poke-cli/connections"
 	"github.com/digitalghost-dev/poke-cli/flags"
 	"github.com/digitalghost-dev/poke-cli/styling"
@@ -12,7 +13,9 @@ import (
 	"strings"
 )
 
-func AbilityCommand() {
+func AbilityCommand() string {
+	var output strings.Builder
+
 	flag.Usage = func() {
 		helpMessage := styling.HelpBorder.Render(
 			"Get details about a specific ability.\n\n",
@@ -24,7 +27,7 @@ func AbilityCommand() {
 			fmt.Sprintf("\n\t%-30s %s", "-p, --pokemon", "Prints Pokémon that learn this ability."),
 			fmt.Sprintf("\n\t%-30s %s", "-h, --help", "Prints the help menu."),
 		)
-		fmt.Println(helpMessage)
+		output.WriteString(helpMessage)
 	}
 
 	abilityFlags, pokemonFlag, shortPokemonFlag := flags.SetupAbilityFlagSet()
@@ -35,33 +38,33 @@ func AbilityCommand() {
 
 	if len(os.Args) == 3 && (os.Args[2] == "-h" || os.Args[2] == "--help") {
 		flag.Usage()
-		return
+		return output.String()
 	}
 
-	if err := ValidateAbilityArgs(args); err != nil {
-		fmt.Println(err.Error())
-		if os.Getenv("GO_TESTING") != "1" {
-			os.Exit(1)
-		}
+	if err := utils.ValidateAbilityArgs(args); err != nil {
+		output.WriteString(err.Error())
+		return output.String()
 	}
 
 	endpoint := strings.ToLower(args[1])
 	abilityName := strings.ToLower(args[2])
 
 	if err := abilityFlags.Parse(args[3:]); err != nil {
-		fmt.Printf("error parsing flags: %v\n", err)
+		output.WriteString(fmt.Sprintf("error parsing flags: %v\n", err))
 		abilityFlags.Usage()
 		if os.Getenv("GO_TESTING") != "1" {
 			os.Exit(1)
 		}
+		return output.String()
 	}
 
 	abilitiesStruct, abilityName, err := connections.AbilityApiCall(endpoint, abilityName, connections.APIURL)
 	if err != nil {
-		fmt.Println(err)
 		if os.Getenv("GO_TESTING") != "1" {
+			fmt.Fprintln(os.Stderr, err)
 			os.Exit(1)
 		}
+		return err.Error()
 	}
 
 	// Extract English short_effect
@@ -83,29 +86,33 @@ func AbilityCommand() {
 	}
 
 	capitalizedAbility := cases.Title(language.English).String(strings.ReplaceAll(abilityName, "-", " "))
-	fmt.Println(styling.StyleBold.Render(capitalizedAbility))
+	output.WriteString(styling.StyleBold.Render(capitalizedAbility) + "\n")
 
 	// API is missing some data for the short_effect for abilities from Generation 9.
 	// If short_effect is empty, fallback to the move's flavor_text_entry.
 	if englishShortEffect == "" {
-		fmt.Println("Effect:", englishFlavorEntry)
+		output.WriteString("Effect: " + englishFlavorEntry + "\n")
 	} else {
-		fmt.Println("Effect:", englishShortEffect)
+		output.WriteString("Effect: " + englishShortEffect + "\n")
 	}
 
 	// Print the generation where the move was first introduced.
 	generationParts := strings.Split(abilitiesStruct.Generation.Name, "-")
 	if len(generationParts) > 1 {
 		generationUpper := strings.ToUpper(generationParts[1])
-		fmt.Println("Generation:", generationUpper)
+		output.WriteString("Generation: " + generationUpper + "\n")
 	} else {
-		fmt.Println("Generation: Unknown")
+		output.WriteString("Generation: Unknown\n")
 	}
 
 	if *pokemonFlag || *shortPokemonFlag {
-		if err := flags.PokemonAbilitiesFlag(endpoint, abilityName); err != nil {
-			fmt.Printf("error parsing flags: %v\n", err)
-			os.Exit(1)
+		if err := flags.PokemonAbilitiesFlag(&output, endpoint, abilityName); err != nil {
+			output.WriteString(fmt.Sprintf("error parsing flags: %v\n", err))
+			if os.Getenv("GO_TESTING") != "1" {
+				os.Exit(1)
+			}
 		}
 	}
+
+	return output.String()
 }

cmd/ability/ability_test.go

@@ -0,0 +1,60 @@
+package ability
+
+import (
+	"github.com/digitalghost-dev/poke-cli/cmd/utils"
+	"github.com/digitalghost-dev/poke-cli/styling"
+	"github.com/stretchr/testify/assert"
+	"os"
+	"testing"
+)
+
+func TestAbilityCommand(t *testing.T) {
+	err := os.Setenv("GO_TESTING", "1")
+	if err != nil {
+		t.Fatalf("Failed to set GO_TESTING env var: %v", err)
+	}
+
+	defer func() {
+		err := os.Unsetenv("GO_TESTING")
+		if err != nil {
+			t.Logf("Warning: failed to unset GO_TESTING: %v", err)
+		}
+	}()
+
+	tests := []struct {
+		name           string
+		args           []string
+		expectedOutput string
+		wantError      bool
+	}{
+		{
+			name:           "Ability help flag",
+			args:           []string{"ability", "--help"},
+			expectedOutput: utils.LoadGolden(t, "ability_help.golden"),
+		},
+		{
+			name:           "Ability command: clear-body",
+			args:           []string{"ability", "clear-body"},
+			expectedOutput: utils.LoadGolden(t, "ability.golden"),
+		},
+		{
+			name:           "Misspelled ability name",
+			args:           []string{"ability", "bulletproff"},
+			expectedOutput: utils.LoadGolden(t, "ability_misspelled.golden"),
+			wantError:      true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			originalArgs := os.Args
+			os.Args = append([]string{"poke-cli"}, tt.args...)
+			defer func() { os.Args = originalArgs }()
+
+			output := AbilityCommand()
+			cleanOutput := styling.StripANSI(output)
+
+			assert.Equal(t, tt.expectedOutput, cleanOutput, "Output should match expected")
+		})
+	}
+}