Merge pull request #152 from digitalghost-dev/1.3.1

1.3.1

Author: digitalghost-dev

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ on:
       - main
 
 env:
-  VERSION_NUMBER: 'v1.3.0'
+  VERSION_NUMBER: 'v1.3.1'
   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.3.0
+      - -s -w -X main.version=v1.3.1
 
 archives:
   - format: tar.gz

Dockerfile

@@ -1,5 +1,5 @@
 # build 1
-FROM golang:1.24.2-alpine3.21 AS build
+FROM golang:1.24.4-alpine3.21 AS build
 
 WORKDIR /app
 
@@ -8,7 +8,7 @@ RUN go mod download
 
 COPY . .
 
-RUN go build -ldflags "-X main.version=v1.3.0" -o poke-cli .
+RUN go build -ldflags "-X main.version=v1.3.1" -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.3.0?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.3.1?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.3.0 <command> [subcommand] flag]
+    docker run --rm -it digitalghostdev/poke-cli:v1.3.1 <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.3.0 -c "cd /app && exec sh"
+    docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.3.1 -c "cd /app && exec sh"
    # placed into the /app directory, run the program with './poke-cli'
    # example: ./poke-cli ability swift-swim
     ```

cli.go

@@ -94,23 +94,28 @@ func runCLI(args []string) int {
 		return 2
 	}
 
-	commands := map[string]func(){
+	remainingArgs := mainFlagSet.Args()
+
+	commands := map[string]func() int{
 		"ability": utils.HandleCommandOutput(ability.AbilityCommand),
 		"move":    utils.HandleCommandOutput(move.MoveCommand),
 		"natures": utils.HandleCommandOutput(natures.NaturesCommand),
 		"pokemon": utils.HandleCommandOutput(pokemon.PokemonCommand),
 		"types":   utils.HandleCommandOutput(types.TypesCommand),
-		"search":  search.SearchCommand,
+		"search": func() int {
+			search.SearchCommand()
+			return 0
+		},
 	}
 
 	cmdArg := ""
-	if len(os.Args) >= 2 {
-		cmdArg = os.Args[1]
+	if len(remainingArgs) >= 1 {
+		cmdArg = remainingArgs[0]
 	}
 	cmdFunc, exists := commands[cmdArg]
 
 	switch {
-	case len(os.Args) < 2:
+	case len(remainingArgs) == 0 && !*latestFlag && !*shortLatestFlag && !*currentVersionFlag && !*shortCurrentVersionFlag:
 		mainFlagSet.Usage()
 		return 1
 	case *latestFlag || *shortLatestFlag:
@@ -120,13 +125,11 @@ func runCLI(args []string) int {
 		currentVersion()
 		return 0
 	case exists:
-		cmdFunc()
-		return 0
+		return cmdFunc()
 	default:
-		command := os.Args[1]
 		errMessage := styling.ErrorBorder.Render(
 			styling.ErrorColor.Render("Error!"),
-			fmt.Sprintf("\n\t%-15s", fmt.Sprintf("'%s' is not a valid command.\n", command)),
+			fmt.Sprintf("\n\t%-15s", fmt.Sprintf("'%s' is not a valid command.\n", cmdArg)),
 			styling.StyleBold.Render("\nCommands:"),
 			fmt.Sprintf("\n\t%-15s %s", "ability", "Get details about an ability"),
 			fmt.Sprintf("\n\t%-15s %s", "move", "Get details about a move"),
@@ -138,7 +141,6 @@ func runCLI(args []string) int {
 		)
 		output.WriteString(errMessage)
 
-		// This would typically be returned in a function or passed to something else
 		fmt.Println(output.String())
 
 		return 1

cli_test.go

@@ -122,6 +122,32 @@ func TestRunCLI(t *testing.T) {
 	}
 }
 
+// TODO: finish testing different commands?
+func TestRunCLI_VariousCommands(t *testing.T) {
+	tests := []struct {
+		name     string
+		args     []string
+		expected int
+	}{
+		//{"Invalid command", []string{"foobar"}, 1},
+		{"Latest flag long", []string{"--latest"}, 0},
+		{"Latest flag short", []string{"-l"}, 0},
+		{"Version flag long", []string{"--version"}, 0},
+		{"Version flag short", []string{"-v"}, 0},
+		//{"Missing Pokémon name", []string{"pokemon"}, 1},
+		//{"Another invalid command", []string{"invalid"}, 1},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			exitCode := runCLI(tt.args)
+			if exitCode != tt.expected {
+				t.Errorf("expected %d, got %d for args %v", tt.expected, exitCode, tt.args)
+			}
+		})
+	}
+}
+
 func TestMainFunction(t *testing.T) {
 	originalExit := exit
 	defer func() { exit = originalExit }() // Restore original exit after test

cmd/move/move.go

@@ -44,7 +44,11 @@ func MoveCommand() (string, error) {
 	endpoint := strings.ToLower(args[0])
 	moveName := strings.ToLower(args[1])
 
-	moveStruct, moveName, _ := connections.MoveApiCall(endpoint, moveName, connections.APIURL)
+	moveStruct, moveName, err := connections.MoveApiCall(endpoint, moveName, connections.APIURL)
+	if err != nil {
+		output.WriteString(err.Error())
+		return output.String(), err
+	}
 
 	moveInfoContainer(&output, moveStruct, moveName)
 	moveEffectContainer(&output, moveStruct)

cmd/pokemon/pokemon.go

@@ -65,19 +65,19 @@ func PokemonCommand() (string, error) {
 		os.Exit(1)
 	}
 
-	_, pokemonName, pokemonID, pokemonWeight, pokemonHeight, err := connections.PokemonApiCall(endpoint, pokemonName, connections.APIURL)
+	pokemonStruct, pokemonName, err := connections.PokemonApiCall(endpoint, pokemonName, connections.APIURL)
 	if err != nil {
-		fmt.Println(err)
-		os.Exit(1)
+		output.WriteString(err.Error())
+		return output.String(), err
 	}
 	capitalizedString := cases.Title(language.English).String(strings.ReplaceAll(pokemonName, "-", " "))
 
 	// Weight calculation
-	weightKilograms := float64(pokemonWeight) / 10
+	weightKilograms := float64(pokemonStruct.Weight) / 10
 	weightPounds := float64(weightKilograms) * 2.20462
 
 	// Height calculation
-	heightMeters := float64(pokemonHeight) / 10
+	heightMeters := float64(pokemonStruct.Height) / 10
 	heightFeet := heightMeters * 3.28084
 	feet := int(heightFeet)
 	inches := int(math.Round((heightFeet - float64(feet)) * 12)) // Use math.Round to avoid truncation
@@ -90,7 +90,7 @@ func PokemonCommand() (string, error) {
 
 	output.WriteString(fmt.Sprintf(
 		"Your selected Pokémon: %s\n%s National Pokédex #: %d\n%s Weight: %.1fkg (%.1f lbs)\n%s Height: %.1fm (%d′%02d″)\n",
-		capitalizedString, styling.ColoredBullet, pokemonID,
+		capitalizedString, styling.ColoredBullet, pokemonStruct.ID,
 		styling.ColoredBullet, weightKilograms, weightPounds,
 		styling.ColoredBullet, heightFeet, feet, inches,
 	))

cmd/utils/output.go

@@ -5,15 +5,17 @@ import (
 	"os"
 )
 
-// HandleCommandOutput wraps a function that returns (string, error) into a no-arg function
-// that prints the output to stdout or stderr depending on whether an error occurred.
-func HandleCommandOutput(fn func() (string, error)) func() {
-	return func() {
+// HandleCommandOutput takes a function that returns (string, error) and wraps it in a no-argument
+// function that writes the returned string to stdout if there's no error, or to stderr if there is.
+// It returns an exit code: 0 on success, 1 on error.
+func HandleCommandOutput(fn func() (string, error)) func() int {
+	return func() int {
 		output, err := fn()
 		if err != nil {
 			fmt.Fprintln(os.Stderr, output)
-			return
+			return 1
 		}
 		fmt.Println(output)
+		return 0
 	}
 }

cmd/utils/output_test.go

@@ -31,7 +31,9 @@ func TestHandleCommandOutput_Success(t *testing.T) {
 		return "it worked", nil
 	}
 
-	output := captureOutput(&os.Stdout, HandleCommandOutput(fn))
+	output := captureOutput(&os.Stdout, func() {
+		HandleCommandOutput(fn)()
+	})
 
 	if output != "it worked\n" {
 		t.Errorf("expected 'it worked\\n', got %q", output)
@@ -43,7 +45,9 @@ func TestHandleCommandOutput_Error(t *testing.T) {
 		return "something failed", errors.New("error")
 	}
 
-	output := captureOutput(&os.Stderr, HandleCommandOutput(fn))
+	output := captureOutput(&os.Stderr, func() {
+		HandleCommandOutput(fn)()
+	})
 
 	if output != "something failed\n" {
 		t.Errorf("expected 'something failed\\n', got %q", output)