Annotate Rails classes with schema and routes info
Add a comment summarizing the current schema to the top or bottom of each of your...
routes.rbfile (for Rails projects)
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,
srid, when using
# == Schema Info # # Table name: trips # # local :geometry point, 4326 # path :geometry line_string, 4326
Also, if you pass the
-roption, it'll annotate
routes.rbwith the output of
In versions 2.7.X the annotate gem defaulted to annotating models if no arguments were passed in. The annotate gem by default would not allow for routes and models to be annotated together. A change was added in #647. You can read more here.
There are a few ways of fixing this:
rails g annotate:installwill overwrite your defaults with the annotating
modelsoption set to
Annotate.set_defaults( ... 'models' => 'true', ...
Into Gemfile from rubygems.org:
group :development do gem 'annotate' end
Into Gemfile from Github:
group :development do gem 'annotate', git: 'https://github.com/ctran/annotate_models.git' end
Into environment gems from rubygems.org:
gem install annotate
Into environment gems from Github checkout:
git clone https://github.com/ctran/annotate_models.git annotate_models cd annotate_models rake gem gem install dist/annotate-*.gem
(If you used the Gemfile install, prefix the below commands with
To annotate all your models, tests, fixtures, and factories:
cd /path/to/app annotate
To annotate just your models, tests, and factories:
annotate --models --exclude fixtures
To annotate just your models:
To annotate routes.rb:
To remove model/test/fixture/factory/serializer annotations:
To remove routes.rb annotations:
annotate --routes --delete
To automatically annotate every time you run
db:migrate, either run
rails g annotate:installor add
See the configuration in Rails section for more info.
Everything above applies, except that
--routesis not meaningful, and you will probably need to explicitly set one or more
--requireoption(s), and/or one or more
--model-diroptions to inform
annotateabout the structure of your project and help it bootstrap and load the relevant code.
If you want to always skip annotations on a particular model, add this string anywhere in the file:
# -*- SkipSchemaAnnotations
To generate a configuration file (in the form of a
.rakefile), to set default options:
rails g annotate:install
Edit this file to control things like output format, where annotations are added (top or bottom of file), and in which artifacts.
The generated rakefile
Annotate.load_tasks. This adds a few rake tasks which duplicate command-line functionality:
rake annotate_models # Add schema information (as comments) to model and fixture files rake annotate_routes # Adds the route map to routes.rb rake remove_annotation # Remove schema information from model and fixture files
By default, once you've generated a configuration file, annotate will be executed whenever you run
rake db:migrate(but only in development mode). If you want to disable this behavior permanently, edit the
.rakefile and change:
'skip_on_db_migrate' => 'false',
'skip_on_db_migrate' => 'true',
If you want to run
rake db:migrateas a one-off without running annotate, you can do so with a simple environment variable, instead of editing the
ANNOTATE_SKIP_ON_DB_MIGRATE=1 rake db:migrate
Usage: annotate [options] [model_file]* --additional-file-patterns Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`) -d, --delete Remove annotations from all model files or the routes.rb file -p [before|top|after|bottom], Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s) --position --pc, --position-in-class [before|top|after|bottom] Place the annotations at the top (before) or the bottom (after) of the model file --pf, --position-in-factory [before|top|after|bottom] Place the annotations at the top (before) or the bottom (after) of any factory files --px, --position-in-fixture [before|top|after|bottom] Place the annotations at the top (before) or the bottom (after) of any fixture files --pt, --position-in-test [before|top|after|bottom] Place the annotations at the top (before) or the bottom (after) of any test files --pr, --position-in-routes [before|top|after|bottom] Place the annotations at the top (before) or the bottom (after) of the routes.rb file --ps, --position-in-serializer [before|top|after|bottom] Place the annotations at the top (before) or the bottom (after) of the serializer files --w, --wrapper STR Wrap annotation with the text passed as parameter. If --w option is used, the same text will be used as opening and closing --wo, --wrapper-open STR Annotation wrapper opening. --wc, --wrapper-close STR Annotation wrapper closing -r, --routes Annotate routes.rb with the output of 'rake routes' --models Annotate ActiveRecord models -a, --active-admin Annotate active_admin models -v, --version Show the current version of this gem -m, --show-migration Include the migration version number in the annotation -k, --show-foreign-keys List the table's foreign key constraints in the annotation --ck, --complete-foreign-keys Complete foreign key names 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, separate multiple dirs with commas --root-dir dir Annotate files stored within root dir projects, separate multiple dirs with commas --ignore-model-subdirects Ignore subdirectories of the models directory --sort Sort columns alphabetically, rather than in creation order --classified-sort Sort columns alphabetically, but first goes id, then the rest columns, then the timestamp columns and then the association columns -R, --require path Additional file to require before loading models, may be used multiple times -e [tests,fixtures,factories,serializers], --exclude Do not annotate fixtures, test files, factories, and/or serializers -f [bare|rdoc|yard|markdown], Render Schema Infomation as plain/RDoc/YARD/Markdown --format --force Force new annotations even if there are no changes. --frozen Do not allow to change annotations. Exits non-zero if there are going to be changes to files. --timestamp Include timestamp in (routes) annotation --trace If unable to annotate a file, print the full stack trace, not just the exception message. -I, --ignore-columns REGEX don't annotate columns that match a given REGEX (e.g. `annotate -I '^(id|updated_at|created_at)'`) --ignore-routes REGEX don't annotate routes that match a given REGEX (e.g. `annotate -I '(mobile|resque|pghero)'`)_ --hide-limit-column-types VALUES don't show limit for given column types, separated by commas (e.g. `integer,boolean,text`) --hide-default-column-types VALUES don't show default for given column types, separated by commas (e.g. `json,jsonb,hstore`) --ignore-unknown-models don't display warnings for bad model files --with-comment include database comments in model annotations
Provide additional paths for the gem to annotate. These paths can include globs. It is recommended to use absolute paths. Here are some examples:
The appropriate model will be inferred using the
%*%syntax, annotating any matching files. It works with existing filename resolutions (options for which can be found in the
When using in a Rails config, you can use the following:
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
The format produced is actually MultiMarkdown, making use of the syntax extension for tables. It's recommended you use
kramdownas your parser if you want to use this format. If you're using
yardto generate documentation, specify a format of markdown with
kramdownas the provider by adding this to your
--markup markdown --markup-provider kramdown
Be sure to add this to your
gem 'kramdown', groups => [:development], require => false
Don't add text after an automatically-created comment block. This tool will blow away the initial/final comment block in your models if it looks like it was previously added by this gem.
Be sure to check the changes that this tool makes! If you are using Git, you may simply check your project's status after running
$ git status
If you are not using a VCS (like Git, Subversion or similar), please tread extra carefully, and consider using one.
Released under the same license as Ruby. No Support. No Warranty.