/v1/names の実装

Author: raa0121

cmd/GoBCDiceAPI/controllers/router.go

@@ -20,4 +20,6 @@ func setupV1(g *echo.Group) {
 	version.Setup()
 	systems := v1.NewSystemsController(g)
 	systems.Setup()
+	names := v1.NewNamesController(g)
+	names.Setup()
 }

cmd/GoBCDiceAPI/controllers/v1/names.go

@@ -0,0 +1,29 @@
+package v1
+
+import (
+	"github.com/labstack/echo"
+	"github.com/raa0121/GoBCDice/cmd/GoBCDiceAPI/helpers"
+	"github.com/raa0121/GoBCDice/cmd/GoBCDiceAPI/models"
+)
+
+type NamesController struct {
+	Group *echo.Group
+}
+
+func NewNamesController(g *echo.Group) *NamesController {
+	return &NamesController{
+		Group: g,
+	}
+}
+
+func (controller *NamesController) getNames(c echo.Context) error {
+	names := models.NewNames()
+
+	return helpers.JSONResponseObject(c, 200, names)
+}
+
+// Setup はコントローラの初期設定を行う。
+func (controller *NamesController) Setup() {
+	controller.Group.Add("GET", "/names", controller.getNames)
+}
+

cmd/GoBCDiceAPI/models/names.go

@@ -0,0 +1,23 @@
+package models
+
+import (
+	"github.com/raa0121/GoBCDice/cmd/GoBCDiceAPI/helpers"
+	"github.com/raa0121/GoBCDice/pkg/dicebot/list"
+)
+
+type Names struct {
+	list.Names
+}
+
+func NewNames() *Names {
+	names := Names{
+		Names: list.AvailableGameInfos(true),
+	}
+	return &names
+}
+
+func (s *Names) ToResponseMap() helpers.ResponseMap {
+	return helpers.ResponseMap{
+		"names": s.Names.Name,
+	}
+}

go.mod

@@ -1,5 +1,7 @@
 module github.com/raa0121/GoBCDice
 
+go 1.14
+
 require (
 	github.com/andlabs/ui v0.0.0-20180902183112-867a9e5a498d
 	github.com/chzyer/logex v1.1.10 // indirect

pkg/dicebot/dicebot.go

@@ -21,6 +21,8 @@ type DiceBot interface {
 	GameName() string
 	// Usage はダイスボットの使用法の説明を返す。
 	Usage() string
+	// SortKey は並べ替え順のよみがなを返す。
+	SortKey() string
 	// ExecuteCommand は指定されたコマンドを実行する。
 	ExecuteCommand(command string, ev *evaluator.Evaluator) (*command.Result, error)
 }
@@ -33,6 +35,8 @@ type DiceBotBasicInfo struct {
 	GameName string
 	// Usage はダイスボットの使用法の説明。
 	Usage string
+	// SortKey は並べ替え順のよみがな。
+	SortKey string
 }
 
 // DiceBotImpl はダイスボットの実装のベースとなる構造体。
@@ -59,6 +63,10 @@ func (d *DiceBotImpl) Usage() string {
 	return d.BasicInfo.Usage
 }
 
+// SortKey は並べ替え順のよみがなを返す。
+func (d *DiceBotImpl)SortKey() string {
+	return d.BasicInfo.SortKey
+}
 // ExecuteCommand は指定されたコマンドを実行する。
 //
 // 基本のダイスボットには特別なコマンドが存在しないため、必ずエラーを返す。

pkg/dicebot/gamesystem/basic/basic.go

@@ -28,6 +28,7 @@ var basicInfo = dicebot.DiceBotBasicInfo{
 　S3d6 ： 各コマンドの先頭に「S」を付けると他人結果の見えないシークレットロール
 　3d6/2 ： ダイス出目を割り算（切り捨て）。切り上げは /2U、四捨五入は /2R。
 　D66 ： D66ダイス。順序はゲームに依存。D66N：そのまま、D66S：昇順。`,
+	SortKey: "*たいすほつと",
 }
 
 // BasicInfo はダイスボットの基本情報を返す。

pkg/dicebot/list/list.go

@@ -12,6 +12,16 @@ import (
 	"sort"
 )
 
+type Names struct {
+	Name []SystemInfo
+}
+
+type SystemInfo struct {
+	System  string `json:"system"`
+	Name    string `json:"name"`
+	SortKey string `json:"sort_key"`
+}
+
 // Find は指定された識別子を持つゲームシステムのダイスボットのコンストラクタを返す。
 // ゲームシステムが見つからなかった場合はエラーを返す。
 func Find(gameID string) (dicebot.DiceBotConstructor, error) {
@@ -48,5 +58,32 @@ func AvailableGameIDs(includeBasicDiceBot bool) []string {
 	return gameIDsWithBasicDiceBot
 }
 
+// AvailableGameInfos は利用可能なゲームシステムの情報のスライスを返す。
+func AvailableGameInfos(includeBasicDiceBot bool) Names {
+	games := make([]SystemInfo, 0, len(gameIDToDiceBotConstructor))
+	for _, k := range gameIDToDiceBotConstructor {
+		info := SystemInfo{
+			System: k().GameID(),
+			Name: k().GameName(),
+			SortKey: k().SortKey(),
+		}
+		games = append(games, info)
+	}
+	sort.Slice(games, func (i, j int) bool { return games[i].SortKey < games[j].SortKey })
+
+	if !includeBasicDiceBot {
+		return Names{Name: games}
+	}
+	gamesWithBasicDiceBot := make([]SystemInfo, 1, len(games)+1)
+	info := SystemInfo{
+		System: basic.BasicInfo().GameID,
+		Name: basic.BasicInfo().GameName,
+		SortKey: basic.BasicInfo().SortKey,
+	}
+	gamesWithBasicDiceBot[0] = info
+	gamesWithBasicDiceBot = append(gamesWithBasicDiceBot, games...)
+	return Names{Name: gamesWithBasicDiceBot}
+}
+
 // ゲーム識別子とダイスボットのコンストラクタとの対応
 var gameIDToDiceBotConstructor = map[string]dicebot.DiceBotConstructor{}