各ダイスボットにゲームシステム名の読みがなを設定できるようにする

[ochaochaocha3]

各ダイスボットにゲームシステム名の読みがなを設定できるようにします。この変更の目的は、ダイスボットを自然な順序で並び替えられるようにすることです。

方法

ゲームシステム名の定義および取得

以下に示すように、ダイスボットのクラスに SORT_KEY という定数を作り、ゲームシステム名の読みがなを定義します。

class KariDice < DiceBot
  # ...

  # ゲームシステム名の読みがな
  SORT_KEY = 'かりたいす'

  # ...
end

定義した読みがなは、DiceBot#sort_key メソッドで取得できるようにします。また、DiceBot#info で返される基本情報にキー "sortKey" を新設し、読みがなを格納します。

以上に合わせて、説明文書も更新します。既存の文書については、「ダイスボットのつくりかた」（docs/how_to_make_dicebot.md）の該当箇所を更新します。また、読みがなの設定方法について説明する文書「ゲームシステム名の読みがなの設定方法」（docs/dicebot_sort_key.md）を追加します。

ダイスボットの基本情報の定義・取得方法の変更

さらに、今回の変更では、v3移行作業のひとつである、ダイスボットの基本情報（ゲームシステムの識別子、ゲームシステム名、ダイスボットの使い方の説明文）を定義、取得するためのインターフェースの変更を同時に行います。目的は、今後必要となる、読みがなの周辺にある基本情報の定義部分の変更の手間を削減することです。ダイスボットの基本情報の項目が変更される今回の改修がちょうどよい機会ではないかと判断しました。

以下をクラス定数として定義します：

• ゲームシステムの識別子：ID（DiceBot#id で取得可能）
• ゲームシステム名：NAME（DiceBot#name で取得可能）
• ダイスボットの使い方の説明文：HELP_MESSAGE（DiceBot#help_message で取得可能）

参考資料：https://gist.github.com/ysakasin/1464a15828f4beeb2988b61f924bacb9

確認・調整が必要なこと

• ゲームシステム名の読みがなを含む、ダイスボットの基本情報の定義・取得インターフェースが妥当か。
• DiceBotLoader.collectDiceBots でダイスボットの一覧を返すときに、ゲームシステム名の読みがなを基準としてソートするか。
  • ソートするようにすると、BCDice APIや各オンセツールにおいてソートが不要になる可能性があります。
• 今回の変更をどのタイミングで導入するか。
  • BCDice外部に公開している部分（DiceBot#info）について、改名や削除は行われないため、インターフェースの変更としては軽微です。
  • BCDice全体への変更ではあるため、個人的にはマイナーバージョンアップ（X.Y.ZのYが増加）が適当と考えました。

[ysakasin]

Nice Work!

ゲームシステム名の読みがなを含む、ダイスボットの基本情報の定義・取得インターフェースが妥当か。

妥当だと思います。システム一覧表示のときに、頭文字で分類したいときに便利です

DiceBotLoader.collectDiceBots でダイスボットの一覧を返すときに、ゲームシステム名の読みがなを基準としてソートするか。
ソートするようにすると、BCDice APIや各オンセツールにおいてソートが不要になる可能性があります。

ソートして良いと思います。エンドユーザーの不利益にはならないと思います。

今回の変更をどのタイミングで導入するか。
BCDice外部に公開している部分（DiceBot#info）について、改名や削除は行われないため、インターフェースの変更としては軽微です。

時期が時期なので、どどんとふ離れを促すためにも入れてしまっていいと思っています。
ただ、これを入れてしまうと各ダイスボットの変更を個人鯖のどどんとふに取り入れようとしたときに、適切な知識が必要という問題は

BCDice全体への変更ではあるため、個人的にはマイナーバージョンアップ（X.Y.ZのYが増加）が適当と考えました。

どどんとふ2系はそもそもSem. Verを採用できていないので、これはどちらでもいい気がします

[ysakasin]

ただ、せっかくなのでダイスボットの命名ルールを統一してから採用したいなと思っています。

[codecov-io]

Codecov Report

Merging #128 into master will increase coverage by 0.53%.
The diff coverage is 99.19%.

@@            Coverage Diff             @@
##           master     #128      +/-   ##
==========================================
+ Coverage   86.30%   86.84%   +0.53%     
==========================================
  Files         192      193       +1     
  Lines       22266    21889     -377     
==========================================
- Hits        19217    19009     -208     
+ Misses       3049     2880     -169     

Impacted Files	Coverage Δ
src/diceBot/DiceBotLoaderList.rb	100.00% <ø> (ø)
src/bcdiceCore.rb	71.46% <50.00%> (ø)
src/test/testDiceBotPrefixesCompatibility.rb	88.23% <75.00%> (ø)
src/diceBot/DiceBot.rb	93.52% <78.78%> (-1.20%)	⬇️
src/diceBot/AFF2e.rb	98.38% <100.00%> (+1.51%)	⬆️
src/diceBot/AceKillerGene.rb	100.00% <100.00%> (+5.00%)	⬆️
src/diceBot/Airgetlamh.rb	100.00% <100.00%> (+2.04%)	⬆️
src/diceBot/Alsetto.rb	100.00% <100.00%> (+1.88%)	⬆️
src/diceBot/Alshard.rb	100.00% <100.00%> (ø)
src/diceBot/Alter_raise.rb	100.00% <100.00%> (+0.90%)	⬆️
... and 170 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0de2911...e48e9b6. Read the comment docs.

[ochaochaocha3]

1c81f7a: DiceBotLoader#collectDiceBots の結果が読みがなでソートされるようにしました。以下は、オンセツールでのゲームシステム一覧を想定した実行例です。

[ysakasin]

元の表で間違っていた表記を修正して欲しいです

[ochaochaocha3]

5つのダイスボットの読みがなを修正しました。

[ysakasin]

コンフリクトの解消と、ADVANCED FIGHTING FANTASY 2nd Edition の取り込みが終わり次第、マージしようと思います。

[ochaochaocha3]

以下を行いました：

• 72978ca: コンフリクトの解消
• 6ce7fbb: ADVANCED FIGHTING FANTASY 2nd Editionの基本情報の定数化
• e48e9b6: 「ダイスボットのつくりかた」に読みがなの設定方法の説明へのリンクを追加

[ysakasin]

LGTM!