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
dustin (author)
Fri May 02 13:23:47 -0700 2008
ctran (committer)
Fri May 02 21:15:12 -0700 2008
commit  4f3e1394f392dda02b3c0b42640fc2dfab85e8ca
tree    0dfd83314dd77415e162af65b9352fff381ab07e
parent  16224621f63794b80caf64fa857cc2b486379611
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