public
Fork of ctran/annotate_models
Description: Annotate ActiveRecord models as a gem
Homepage: http://agilewebdevelopment.com/plugins/annotate_models
Clone URL: git://github.com/timcharper/annotate_models.git
commit  b81806401f9b0896d2a28fd3664d4017f1bc6a31
tree    681bc79efe8864b7a58cfb6254bd2f6b892504d9
parent  753091c5623cdce5a58daf97e5448dec8acbdb2a
name age message
file .gitignore Fri Feb 29 11:44:40 -0800 2008 Add .gitignore [ctran]
file History.txt Fri May 02 21:25:35 -0700 2008 Push a new version 1.0.3 out to rubyforge [ctran]
file License.txt Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
file Manifest.txt Mon Mar 10 00:18:31 -0700 2008 Merge changes from JackDanger [ctran]
file README.txt Fri May 02 21:15:12 -0700 2008 Show 'Nothing to annotate!' instead of 'Annotat... [henrik]
file Rakefile Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
directory bin/ Sat Mar 22 20:02:15 -0700 2008 Merge changes from http://github.com/bumi/annot... [ctran]
directory config/ Fri Feb 29 11:40:21 -0800 2008 change the gem name to annotate-models so rubyf... [ctran]
directory doc/ Sat Mar 22 20:02:15 -0700 2008 Merge changes from http://github.com/bumi/annot... [ctran]
directory lib/ Sat May 17 07:39:53 -0700 2008 output as binary files to enforce "unix co... [timcharper]
directory log/ Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
directory script/ Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
file setup.rb Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
directory tasks/ Fri Feb 29 07:52:46 -0800 2008 Add a script so don't need to rely on Sake anymore [ctran]
directory test/ Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
directory website/ Fri May 02 21:25:35 -0700 2008 Push a new version 1.0.3 out to rubyforge [ctran]
README.txt
== AnnotateModels

Add a comment summarizing the current schema to the top of each ActiveRecord model source file.

  # == Schema Information
  #
  #  id                  :integer(11)   not null
  #  quantity            :integer(11)   
  #  product_id          :integer(11)   
  #  unit_price          :float         
  #  order_id            :integer(11)   
  #

  class LineItem < ActiveRecord::Base 
    belongs_to :product
  
   end
  
Note that this code will blow away the initial 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.

== Install

  sudo gem install annotate-models
  
== Usage

  cd [your project]
  annotate
  annotate -d
  annotate -p [before|after]
  annotate -h

== Source

  http://github.com/ctran/annotate_models
  
== Author
   Dave Thomas
   Pragmatic Programmers, LLC

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

== Modifications
 - alex@pivotallabs.com
 - Cuong Tran - http://github.com/ctran
 - Jack Danger - http://github.com/JackDanger
 - Michael Bumann - http://github.com/bumi
 - Henrik Nyh - http://github.com/henrik