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
JackDanger (author)
Sun Mar 09 12:51:40 -0700 2008
commit  6713e92384f0f9e5175a8f840baa31668d745789
tree    a0cc440e700aa0ee87fd1c8ab4dbf30d6caa94ab
parent  cb016d5c8417651f272ca49fd0aa115b8618a803
annotate_models / README.txt
100644 47 lines (30 sloc) 1.05 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
== 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
  
== 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