読者です 読者をやめる 読者になる 読者になる

Codaybook

サーバサイドエンジニアが必死に作成した!発見した!を綴るブログ



Modelファイルにスキーマ情報を簡単記述「annotate」

業務でruby on railsに触れて半年目。いろいろな便利なgemに触れてきました。 ということで今回、あったら便利だなぁというgemを紹介いたします。
今回紹介するgemはannotateです。

github.com

導入の仕方はGemfileに以下1文を記述して$ bundle installいます。

gem "annotate"

annotateをインストールした後に以下コマンドを入力します。

$ bundle exec annotate

そうすると、Annotated (1): Playerみたいな文言がmodelの分出力され、 app/models/以下にあるmodelのファイルにスキーマ情報が以下のようにコメントとして追記されます。

# == Schema Information
#
# Table name: cards
#
#  id                :integer          not null, primary key
#  character_id      :integer          not null
#  name              :string(255)      not null

いちいちテーブルの情報を見なくても、このmodelにはこういうカラムが存在しているんだなぁというのが 一目瞭然になります。非常に便利なgemですので是非入れてみてください。