public
Description: A Rails plugin that adds comments to your active record objects listing the columns
Homepage:
Clone URL: git://github.com/thechrisoshow/what_column.git
name age message
file .gitignore Loading commit data...
file MIT-LICENSE Wed Apr 01 14:47:43 -0700 2009 Yet more documentation - niiice one [thechrisoshow]
file README.markdown
file Rakefile Tue Mar 31 00:35:29 -0700 2009 first commit' [thechrisoshow]
file init.rb
file install.rb
directory lib/
directory tasks/
directory test/
file uninstall.rb Tue Mar 31 00:35:29 -0700 2009 first commit' [thechrisoshow]
README.markdown

What Column?!?

A Rails plugin that details columns in ActiveRecord models.

Tired of having to look at schema.rb to figure out what columns belong to a model?
Well no more!

With the what_column plugin a comment appears at the top of your models displaying the column details.

INSTALLATION

Go into your Rails folder and type:

script/plugin install git://github.com/thechrisoshow/what_column.git

USAGE

Everytime you run migrations in development mode your models will be updated with a comment block detailing comment information:

class User < ActiveRecord::Base

  # === List of columns ===
  #   id         : integer 
  #   name       : string 
  #   created_at : datetime 
  #   updated_at : datetime 
  # =======================

end

It only works for those models under app/models. And as it writes directly to your model files make sure that you use source control!

Should you wish to run the commands manually there are rake commands. Check 'em out:

rake what_column:add #=> Adds column details to models

rake what_column:remove #=> Removes column details from models

Copyright (c) 2009 Chris O'Sullivan, released under the MIT license