public
Rubygem
Description: Annotate ActiveRecord models as a gem
Homepage: http://agilewebdevelopment.com/plugins/annotate_models
Clone URL: git://github.com/ctran/annotate_models.git
ctran (author)
Thu Feb 28 14:41:04 -0800 2008
commit  4bf03485a4bf161bb463dda3b3b848f68400d508
tree    25f89d27e3e6936ff61b37e73c81ef50cb7169dd
parent  00bbf2ed7db7d780d12aa2d0e11ff928930f68ca
name age message
file .gitignore Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
file History.txt Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
file License.txt Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
file Manifest.txt Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
file README.txt Thu Feb 28 14:41:04 -0800 2008 fix the install instructions [ctran]
file Rakefile Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
directory config/ Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
directory lib/ Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
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/ Thu Feb 28 14:33:52 -0800 2008 First usable release [ctran]
directory test/ Wed Feb 27 10:06:49 -0800 2008 first import from http://repo.pragprog.com/svn/... [ctran]
directory website/ Thu Feb 28 14:41:04 -0800 2008 fix the install instructions [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 sake annotate_models
  sake -i http://github.com/ctran/annotate_models/tree/master/tasks/annotate.rake?raw=true
  
Usage
=====

  sake annotate_models

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 by:
 - alex@pivotallabs.com
 - ctran@pragmaquest.com