ずっと抱えていた次の悩みを解消してくれるgemを知ったので、まとめました。
・このモデルどういうカラムもってたっけ?、どういう型だったっけ?と思っとき、rails c
する。
・ルーティングを確認したいとき、rails routes
コマンドをたたく。
gem annotateを使うと、これらの作業が不要になります。
gem annotateの概要
・schema情報をモデルの上部もしくは下部にコメントとして表示
・ルーティング情報をroutes.rbの上部もしくは下部にコメントとして表示
実行環境
ruby 2.3.0
Rails 5.1.5
手順(schema情報の追加)
gem 'annotate'
bundle install
bundle exec annotate
モデルを確認すると、以下のように、ファイルの上部にコメントが追加されている。
同時に、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をたたいたときの実行結果がコメントとして表示される。