Skip to content
SAKATA Sinji edited this page Apr 29, 2020 · 6 revisions

1. Rubyのインストール

Rubyのインストール方法はOSによって大きく異なります。Ruby公式のインストールガイドを参照してください。

2. 開発に必要なパッケージのインストール

2.1 Bundler

依存関係の解決には、Rubyのパッケージ管理システムBundlerを用います。 Bundlerは下記コマンドでインストールします。場合によっては管理者権限が必要なので注意してください。

gem install bundler

以後の操作は全てBundlerを経由して行います。

2.2 その他Gem

BCDiceのディレクトリ下で以下を実行すると、 BCDice/Gemfile に書かれたGemがインストールされます。

bundle install

3. 開発

コードを書きましょう

4. テスト

4.1 コードの自動整形

bundle exec rubocop -a

コーディングはインデントの仕方をとっても様々な流派があり、プロジェクトの中で書き方が統一されていないと非常に見辛くなってしまいます。そこで、プロジェクトのルールを決め、ツールを使ってコード整形をするのが一般的です。

BCDiceではRuboCopを使ってコード整形をしています。上記コマンドを実行すると、RuboCopがルール違反を見つけ、直せる部分は自動で修正してくれます。

4.2 全体のテスト

bundle exec rake test

BCDiceでは、コードの修正によりダイスボットの挙動が変わっていないか確認するためにテストを用意しています。上記コマンドを実行すると、テストを通過するの確認が行われます。これに通過しない場合、何か意図しない変更をしたことになるので、コードの修正が必要になります。

5. 便利なコマンド集

特定のゲームシステムのテスト

bundle exec ruby src/test.rb GAME_ID

GAME_IDを適宜置き換えてください

Clone this wiki locally