public
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)
Fri May 02 21:25:35 -0700 2008
commit  753091c5623cdce5a58daf97e5448dec8acbdb2a
tree    a16d4acad3c049e19755618500b3618759c2740d
parent  8c8c3c58055c8659da55f5cc130552204f469dfd
annotate_models / README.txt
100644 51 lines (36 sloc) 1.204 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
== 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