IT技術にまつわる実験ノート

「長編を書くより、短編を数多く完成させてください。それが上達への近道です」 by 手塚治虫

Rails で annotate を使ってみる

 

ざっくりとアプリを作成する。

  • rails new annotate_sample
  • cd annotate_sample

 

scaffold して、モデルを作成しておく。

  • bin/rails g scaffold User name:string age:integer
  • bin/rails db:migrate

  

Gemfile を編集する。annotate は development 環境のみで使用する。

f:id:matt-note:20190421194908p:plain

 

annotate をインストールする。

  • bundle

 

annotate を実行してみる。

  • bundle exec annotate

f:id:matt-note:20190415015741p:plain

-> スキーマ情報について、アノテーションを出力できた。

 

annotate の設定をする。

  • bin/rails g annotate:install

f:id:matt-note:20190415020354p:plain

-> これで lib/tasks/auto_annotate_models.rake ファイルが作成され、自動でアノテーションされるようにできた。

 

Article モデルを作成する。

  • bin/rails g scaffold Article user:references title:string content:text
  • bin/rails db:migrate

f:id:matt-note:20190415020537p:plain

-> マイグレーションを実行すると、自動的にアノテーションを書き込むことができた。

 

discourse の設定をコピペしてみる。

 

これまでの設定を削除しておく。

  • bundle exec annotate --delete

 

annotate を実行する。

  • bundle exec annotate

f:id:matt-note:20190415021107p:plain

-> アノテーションをファイルの末尾に書き込むことができた。