[Rails]annotate

概要

DBのテーブル定義をmodel、specファイルの上部にコメントで一覧として書き出してくれるgem

導入手順

(前提: ver.3.1.1.を導入したときの話)
gem「rspec」, 「factory_bot」を導入済み

# 1. Gemfileにannotateを記述
# 2. bundle installを実行
# 3. rails g annotate:installを実行
=>lib/tasks/auto_annotate_models.rakeが作成される

利用手順

# 対象ファイルすべてにコメントを付与
bundle exec annotate
=>以下ファイルすべてにmodelのテーブル定義がコメントとして付与される
- app/models/<model>.rb
- spec/models/<model>_spec.rb
- spec/factories/<models>.rb

参考