Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Annotate ActiveRecord models as a gem
Ruby Shell

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.


Annotate (aka AnnotateModels)

Add a comment summarizing the current schema to the top or bottom of each of your…

  • ActiveRecord models

  • Fixture files

  • Tests and Specs

  • Object Daddy exemplars

  • Machinist blueprints

  • Fabrication fabricators

  • Thoughtbot's factory_girl factories, i.e. the (spec|test)/factories/<model>_factory.rb files

  • routes.rb file

The schema comment looks like this:

# == Schema Info
# Table name: line_items
#  id                  :integer(11)    not null, primary key
#  quantity            :integer(11)    not null
#  product_id          :integer(11)    not null
#  unit_price          :float
#  order_id            :integer(11)

 class LineItem < ActiveRecord::Base
   belongs_to :product
  . . .

It also annotates geometrical columns, geom type and srid, when using SpatialAdapter or PostgisAdapter:

# == Schema Info
# Table name: trips
#  local           :geometry        point, 4326
#  path            :geometry        line_string, 4326

Also, if you pass the -r option, it'll annotate routes.rb with the output of “rake routes”.


Into Gemfile from

gem 'annotate', ">=2.5.0"

Into Gemfile from Github:

gem 'annotate', :git => 'git://'

Into environment gems from

gem install annotate

Into environment gems from Github checkout:

git clone git:// annotate_models
cd annotate_models
rake build
gem install pkg/annotate-*.gem


(If you used the Gemfile install, prefix the below commands with `bundle exec`.)

To annotate all your models, tests, fixtures, and factories:

cd /path/to/app

To annotate your models, tests, and factories:

annotate --exclude fixtures

To annotate just your models:

annotate --exclude tests,fixtures,factories

To annotate routes.rb:

annotate -r

To remove model/test/fixture/factory annotations:

annotate -d

To remove routes.rb annotations:

annotate -r -d

To automatically annotate after running 'rake db:migrate', ensure you've added annotate_models to your Rails project's Gemfile, and run this:

rails g annotate_models:install

This will produce a .rake file that will ensure annotation happens after migration (but only in development mode), and provide configuration options you can use to tailor the output.

If you want to always skip annotations on a particular model, add this string anywhere in the file:

# -*- SkipSchemaAnnotations


Usage: annotate [options] [model_file]*
    -d, --delete                     Remove annotations from all model files or the routes.rb file
    -p, --position [before|after]    Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory file(s)
        --pc, --position-in-class [before|after]
                                     Place the annotations at the top (before) or the bottom (after) of the model file
        --pf, --position-in-factory [before|after]
                                     Place the annotations at the top (before) or the bottom (after) of any factory files
        --px, --position-in-fixture [before|after]
                                     Place the annotations at the top (before) or the bottom (after) of any fixture files
        --pt, --position-in-test [before|after]
                                     Place the annotations at the top (before) or the bottom (after) of any test files
        --pr, --position-in-routes [before|after]
                                     Place the annotations at the top (before) or the bottom (after) of the routes.rb file
    -r, --routes                     Annotate routes.rb with the output of 'rake routes'
    -v, --version                    Show the current version of this gem
    -m, --show-migration             Include the migration version number in the annotation
    -i, --show-indexes               List the table's database indexes in the annotation
    -s, --simple-indexes             Concat the column's related indexes in the annotation
        --model-dir dir              Annotate model files stored in dir rather than app/models
        --ignore-model-subdirects    Ignore subdirectories of the models directory
        --sort                       Sort columns alphabetically, rather than in creation order
    -R, --require path               Additional file to require before loading models, may be used multiple times
    -e [tests,fixtures,factories],   Do not annotate fixtures, test files, and/or factories
    -f [bare|rdoc|markdown],         Render Schema Infomation as plain/RDoc/Markdown
        --force                      Force new annotations even if there are no changes.
        --trace                      If unable to annotate a file, print the full stack trace, not just the exception message.


By default, columns will be sorted in database order (i.e. the order in which migrations were run).

If you prefer to sort alphabetically so that the results of annotation are consistent regardless of what order migrations are executed in, use –sort.


Note that this code will blow away the initial/final comment block in your models if it looks like it was previously added by this gem, so you don't want to add additional text to an automatically created comment block.




Released under the same license as Ruby. No Support. No Warranty.


With help from:

and many others that I may have missed to add.

Something went wrong with that request. Please try again.