public
Fork of ctran/annotate_models
Description: Annotate ActiveRecord models
Homepage: http://agilewebdevelopment.com/plugins/annotate_models
Clone URL: git://github.com/JackDanger/annotate_models.git
Search Repo:
Jack Danger Canty (author)
Wed Mar 12 08:40:44 -0700 2008
commit  c395e3a820e94550453f002babd7ea233f2c0eef
tree    304b91d0dd5f0d6a0c697713f544d3bc685b2293
parent  a2c807b9c18bbbb5f2b0f7c22194947e891d45f2 parent  12b7893be9eabfb6b8bdce87265dbcd781f7c60d
name age message
folder .gitignore Fri Feb 29 11:44:40 -0800 2008 Add .gitignore [ctran]
folder History.txt Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
folder License.txt Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
folder Manifest.txt Mon Mar 10 00:18:31 -0700 2008 Merge changes from JackDanger [ctran]
folder README.txt Tue Mar 11 14:18:29 -0700 2008 Modify credits section and upload new docs. [ctran]
folder Rakefile Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
folder bin/ Fri Feb 29 11:20:26 -0800 2008 Refactor how rake tasks are loaded [ctran]
folder config/ Fri Feb 29 11:40:21 -0800 2008 change the gem name to annotate-models so rubyf... [ctran]
folder doc/ Tue Mar 11 14:18:29 -0700 2008 Modify credits section and upload new docs. [ctran]
folder lib/ Tue Mar 11 06:33:19 -0700 2008 don't include schema version in annotations as ... [Joshua Vickery]
folder log/ Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
folder script/ Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
folder setup.rb Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
folder tasks/ Fri Feb 29 07:52:46 -0800 2008 Add a script so don't need to rely on Sake anymore [ctran]
folder test/ Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
folder website/ Tue Mar 11 14:18:29 -0700 2008 Modify credits section and upload new docs. [ctran]
README.txt
== AnnotateModels

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

  # Schema as of Sun Feb 26 21:58:32 CST 2006 (schema version 7)
  #
  #  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

== 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
 - ctran@pragmaquest.com
 - Jack Danger at http://6brand.com/