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

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”.

INSTALL¶ ↑

Into Gemfile from Github:

gem 'annotate', :git => 'git://github.com/ctran/annotate_models.git'

Into environment gems From Rubygems.org:

sudo gem install annotate

Into environment gems from Github checkout:

git clone git://github.com/ctran/annotate_models.git annotate
cd annotate
rake build
sudo gem install pkg/annotate-*.gem

USAGE¶ ↑

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

To annotate all your models, tests, fixtures, etc.:

cd /path/to/app
annotate_models

To annotate your models and tests:

annotate_models --exclude fixtures

To annotate just your models:

annotate_models --exclude tests,fixtures

To annotate routes.rb:

annotate_models -r

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.

OPTIONS¶ ↑

Usage: annotate_models [options] [model_file]*
    -d, --delete                     Remove annotations from all model files
    -p, --position [before|after]    Place the annotations at the top (before) or the bottom (after) of the model 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
    -R, --require path               Additional files to require before loading models
    -e [tests,fixtures,factories]    Do not annotate fixtures, test files, and/or factories
        --exclude

WARNING¶ ↑

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

* * Back up your model files before using... * *

LINKS¶ ↑

• Factory Girl => github.com/thoughtbot/factory_girl

• Object Daddy => github.com/flogic/object_daddy

• Machinist => github.com/notahat/machinist

• Fabrication => github.com/paulelliott/fabrication

• SpatialAdapter => github.com/pdeffendol/spatial_adapter

• PostgisAdapter => github.com/nofxx/postgis_adapter

LICENSE:¶ ↑

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

AUTHOR:¶ ↑

Original code by: Dave Thomas – Pragmatic Programmers, LLC Overhauled by: Alex Chaffee Gemmed by: Cuong Tran Maintained by: Alex Chaffee and Cuong Tran Integration by: Jon Frisby

Modifications by:

- Alex Chaffee - http://github.com/alexch - alex@pivotallabs.com
- Cuong Tran - http://github.com/ctran - ctran@pragmaquest.com
- Jack Danger - http://github.com/JackDanger
- Michael Bumann - http://github.com/bumi
- Henrik Nyh - http://github.com/henrik
- Marcos Piccinini - http://github.com/nofxx
- Neal Clark - http://github.com/nclark
- Jacqui Maher - http://github.com/jacqui
- Nick Plante - http://github.com/zapnap - http://blog.zerosum.org
- Pedro Visintin - http://github.com/peterpunk - http://www.pedrovisintin.com
- Bob Potter - http://github.com/bpot
- Gavin Montague - http://github.com/govan/
- Alexander Semyonov - http://github.com/rotuka/
- Nathan Brazil - http://github.com/bitaxis/
- Ian Duggan http://github.com/ijcd/
- Jon Frisby http://github.com/mrjoy/

and many others that I may have missed to add.