ctran / annotate_models fork watch download tarball
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
annotate_models / website / index.txt
100644 42 lines (22 sloc) 1.062 kb
raw blame history 
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

h1. annotate_models
 
h1. → 'annotate_models'
 
 
h2. What
 
 
h2. Installing
 
<pre syntax="ruby">
  sudo gem install annotate_models
  sake -i http://github.com/ctran/annotate_models/tree/master/tasks/annotate.rake?raw=true
</pre>
 
h2. The basics
Add a comment summarizing the current schema to the top of each ActiveRecord model source file.
 
This was created by Dave Thomas as a Rails plugin.  
This is now a gem that can be used together with "Sake":http://errtheblog.com/posts/60-sake-bomb
 
h2. Demonstration of usage
 
Go to your RAILS_ROOT dir, then run <code>sake annotate_models</code>
 
h2. How to submit patches
 
See "Using Git within a project":http://drnicwilliams.com/2008/02/03/using-git-within-a-team/
 
The trunk repository is <code>http://github.com/ctran/annotate_models</code>.
 
A svn mirror is on rubyforge <code>svn://rubyforge.org/var/svn/annotate-models/trunk</code>
 
h2. License
 
This code is free to use under the terms of the MIT license. 
 
h2. Contact
 
Comments are welcome. Send an email to "Cuong Tran":mailto:ctran@pragmaquest.com