Ruby
Rails
Gem
annotate

rails c、rails routesコマンド不要 gem annotate

ずっと抱えていた次の悩みを解消してくれるgemを知ったので、まとめました。

・このモデルどういうカラムもってたっけ?、どういう型だったっけ?と思っとき、rails cする。

・ルーティングを確認したいとき、rails routesコマンドをたたく。

gem annotateを使うと、これらの作業が不要になります。

gem annotateの概要

・schema情報をモデルの上部もしくは下部にコメントとして表示
・ルーティング情報をroutes.rbの上部もしくは下部にコメントとして表示

実行環境

ruby 2.3.0
Rails 5.1.5

手順(schema情報の追加)

Gemfile
gem 'annotate'
ターミナル
bundle install
ターミナル
bundle exec annotate

モデルを確認すると、以下のように、ファイルの上部にコメントが追加されている。
スクリーンショット 2018-03-11 23.16.37.png

同時に、fixtures、test、spec、factoryの各ファイルにもコメントが表示される。

参考
rake db:migrateを実行すると自動的にannotateさせたい場合は、次のコマンドをたたく。

ターミナル
rails g annotate:install

rake db:migrateを実行すると同時にannotateさせたくない場合は、rails g annotate:installは実行せず、rake db:migrateの都度、bundle exec annotateを実行する。

手順(routes.rbにルーティング表示)

ターミナルで次のコマンドを実行

ターミナル
annotate --routes

rails routesをたたいたときの実行結果がコメントとして表示される。
スクリーンショット 2018-03-11 23.28.29.png

参考にしたサイト

github:annotate_models