thechrisoshow / what_column

Description:	A Rails plugin that adds comments to your active record objects listing the columns edit
Homepage:	edit
Public Clone URL:	git://github.com/thechrisoshow/what_column.git Give this clone URL to anyone. `git clone git://github.com/thechrisoshow/what_column.git`
Your Clone URL:	git@github.com:thechrisoshow/what_column.git Use this clone URL yourself. `git clone git@github.com:thechrisoshow/what_column.git`

Removed the need for a specific Rails gem

thechrisoshow (author)

Wed Nov 11 02:13:14 -0800 2009

commit 13abea5a3eb574b5470d626d3b3ad40546b574c7
tree 18db082e24c61c414cdbc3c22066b6969f197e5d
parent aecb0619298ae15bdbc951ce1f2a643f40b58f42

what_column /

name	age	history message
.gitignore	Wed Apr 01 13:02:59 -0700 2009	Setup git ignore properly [thechrisoshow]
MIT-LICENSE	Wed Apr 01 14:47:43 -0700 2009	Yet more documentation - niiice one [thechrisoshow]
README.markdown	Tue Apr 07 13:17:13 -0700 2009	Adjusted README [thechrisoshow]
Rakefile	Tue Mar 31 00:35:29 -0700 2009	first commit' [thechrisoshow]
init.rb	Sun Apr 05 06:14:23 -0700 2009	Now column details are added to models after ev... [thechrisoshow]
install.rb	Tue Apr 07 09:49:39 -0700 2009	Changed README to be markdown formatted for git... [thechrisoshow]
lib/	Mon Nov 02 16:04:39 -0800 2009	Fix bug that would occur when classes contained... [topfunky]
tasks/	Tue Apr 07 09:23:31 -0700 2009	Some refactoring [thechrisoshow]
test/	Wed Nov 11 02:13:14 -0800 2009	Removed the need for a specific Rails gem [thechrisoshow]
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