add name command closes hackebrot#8

Author: Scuilion

README.md

@@ -60,6 +60,40 @@ Char: 🐢
 Category: "animals_and_nature"
 Keywords: ["animal" "slow" "nature" "tortoise"]
 ```
+### Name
+
+Use ``Name()`` to find the name of an emojis.
+
+```go
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/hackebrot/turtle"
+)
+
+func main() {
+	n := "👺"
+	emoji := turtle.Name(n)
+
+	if emoji == nil {
+		fmt.Fprintf(os.Stderr, "no name found for search: %v\n", n)
+		os.Exit(1)
+	}
+
+	fmt.Printf("Name: %q\n", emoji.Name)
+	fmt.Printf("Char: %s\n", emoji.Char)
+	fmt.Printf("Category: %q\n", emoji.Category)
+	fmt.Printf("Keywords: %q\n", emoji.Keywords)
+}
+```
+
+```text
+japanese_goblin
+```
+
 
 ### Search
 

cmd/turtle/README.md

@@ -19,6 +19,7 @@ Available Commands:
   category    Print all emojis of the category
   help        Help about any command
   keyword     Print all emojis with the keyword
+  name        Print the name of an emoji
   list        Print a list of values from the turtle library
   search      Print emojis with a name that contains the search string
   version     Print the version number of turtle
@@ -137,6 +138,16 @@ $ turtle -i "  " category travel_and_places
 ]
 ```
 
+### Name
+
+```bash
+$ turtle name 👚
+```
+
+```
+womans_clothes
+```
+
 ### Keyword
 
 ```bash

cmd/turtle/name.go

@@ -0,0 +1,42 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/hackebrot/turtle"
+	"github.com/spf13/cobra"
+)
+
+var (
+	cmdName = &cobra.Command{
+		Use:   "name",
+		Short: "Print the name of an emoji",
+		Long:  "Print the name of an emoji",
+		RunE:  runName,
+		Args: func(cmd *cobra.Command, args []string) error {
+			if len(args) != 1 {
+				return fmt.Errorf("require one name")
+			}
+			return nil
+		},
+	}
+)
+
+func runName(cmd *cobra.Command, args []string) error {
+	k := args[0]
+
+	emoji := turtle.Name(k)
+
+	if emoji == nil {
+		return fmt.Errorf("cannot find emoji name for %q", k)
+	}
+
+	j, err := NewJSONWriter(os.Stdout, WithIndent(prefix, indent))
+
+	if err != nil {
+		return fmt.Errorf("error creating JSONWriter: %v", err)
+	}
+
+	return j.Write(emoji.Name)
+}

cmd/turtle/name_test.go

@@ -0,0 +1,32 @@
+package main
+
+import (
+	"testing"
+)
+
+func Test_runName(t *testing.T) {
+	tests := []struct {
+		name    string
+		args    []string
+		wantErr bool
+	}{
+		{
+			name:    "error",
+			args:    []string{"nopeasdasdasdsd"},
+			wantErr: true,
+		},
+		{
+			name:    "no error",
+			args:    []string{"dog"},
+			wantErr: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if err := runKeyword(nil, tt.args); (err != nil) != tt.wantErr {
+				t.Errorf("runKeyword() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}

cmd/turtle/turtle.go

@@ -29,6 +29,7 @@ var (
 func init() {
 	cmdTurtle.AddCommand(cmdCategory)
 	cmdTurtle.AddCommand(cmdKeyword)
+	cmdTurtle.AddCommand(cmdName)
 	cmdTurtle.AddCommand(cmdSearch)
 	cmdTurtle.AddCommand(cmdVersion)
 	cmdTurtle.AddCommand(cmdList)

filters.go

@@ -20,6 +20,17 @@ func category(emojis []*Emoji, c string) []*Emoji {
 	})
 }
 
+// name returns the name based on emoji
+func name(emojis []*Emoji, n string) *Emoji {
+	results := filter(emojis, func(e *Emoji) bool {
+		return e.Char == n
+	})
+	if len(results) > 0 {
+		return results[0]
+	}
+	return nil
+}
+
 // keyword filters a slice of Emoji by Keywords
 func keyword(emojis []*Emoji, k string) []*Emoji {
 	return filter(emojis, func(e *Emoji) bool {

turtle.go

@@ -1,7 +1,7 @@
 package turtle
 
 // Version of the turtle library
-const Version = "v0.1.0"
+const Version = "v0.1.1"
 
 // Emojis maps a name to an Emoji
 var Emojis = make(map[string]*Emoji)
@@ -17,6 +17,11 @@ func Search(s string) []*Emoji {
 	return search(emojis, s)
 }
 
+// Name retuns the emoji for a given name
+func Name(n string) *Emoji {
+	return name(emojis, n)
+}
+
 // Keyword filters the emojis by a keyword
 func Keyword(k string) []*Emoji {
 	return keyword(emojis, k)

turtle_test.go

@@ -74,6 +74,37 @@ func Test_category(t *testing.T) {
 	}
 }
 
+func Test_name(t *testing.T) {
+	tests := []struct {
+		name string
+		char string
+		want *Emoji
+	}{
+		{
+			name: "no matches",
+			char: "",
+			want: nil,
+		},
+		{
+			name: "single match",
+			char: "☕",
+			want: &Emoji{
+					Name:     "coffee",
+					Category: "food_and_drink",
+					Char:     "☕",
+					Keywords: []string{"beverage", "caffeine", "latte", "espresso"},
+				},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := name(testEmojis, tt.char); !cmp.Equal(got, tt.want) {
+				t.Errorf("name() = %v, want %v", repr.Repr(got), repr.Repr(tt.want))
+			}
+		})
+	}
+}
+
 func Test_keyword(t *testing.T) {
 	tests := []struct {
 		name string