peterhoeg-railroad 0.5.4

Sign up to get free protection for your applications and to get access to all the features.
data/.document ADDED
@@ -0,0 +1,7 @@
1
+ README.rdoc
2
+ CHANGELOG.rdoc
3
+ AUTHORS.rdoc
4
+ lib/**/*.rb
5
+ bin/*
6
+ features/**/*.feature
7
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,7 @@
1
+ *.sw?
2
+ .DS_Store
3
+ coverage
4
+ rdoc
5
+ pkg
6
+ *.gem
7
+ nbproject
data/AUTHORS.rdoc ADDED
@@ -0,0 +1,13 @@
1
+ = Author
2
+ Javier Smaldone - (javier |at| smaldone |dot| com |dot| ar)
3
+
4
+ = Project site
5
+ http://railroad.rubyforge.org
6
+
7
+ = Contributors (in order of appearance)
8
+ * Elliot Smith
9
+ * Juan Ignacio Pumarino
10
+ * Hajime Baba
11
+ * Ana Nelson
12
+ * Peter Hoeg
13
+ * and many testers...
data/CHANGELOG.rdoc ADDED
@@ -0,0 +1,93 @@
1
+ = Changes
2
+
3
+ == Version 0.5.4 (may 15 2009)
4
+ - Transitioned to using Jeweler for gem management
5
+ - Shuffled some file locations around
6
+ - NOTE: there are NO tests passing yet, but this gem was developed without 'em
7
+
8
+ == Version 0.5.3 (may 15 2009)
9
+ - Fixed broken gemspec
10
+
11
+ == Version 0.5.2 (may 15 2009)
12
+ - Added ChangeLog entries
13
+ - Added AUTHORS entry
14
+ - Updated railroad version entry
15
+
16
+ == Version 0.5.1 (may 15 2009)
17
+ - Support rails v2.3
18
+ - Support namespaced models/controllers
19
+
20
+ == Version 0.5.0 (may 10 2008)
21
+ - Changed model relationships representation (feature request #10898)
22
+ - Added support for plugins models (-p) (feature request #12742 by
23
+ Chris Richards). Thanks to Elliot Smith.
24
+ - Added support for irregular inflexions (from patch #12384). Thanks
25
+ to Juan Ignacio Pumarino.
26
+ - Added hidding of magic fields (--hide-magic) (from patch #13351)
27
+ Thanks to Hajime Baba.
28
+ - Added -r option to set the application root path (request #12801).
29
+ - The -e flag now requires full path to excluded files.
30
+ - Added support for state machine diagram ("acts as state machine" plugin).
31
+ Thanks to Ana Nelson (she did all the work!).
32
+
33
+ == Version 0.4.1 (may 9 2008)
34
+ - Fix bug #17852 (class name treated as String).
35
+
36
+ == Version 0.4.0 (apr 25 2007)
37
+ - Draw inheritance edges in reverse way
38
+ (from superclass to subclass, with an arrow in the tail)
39
+ This improves how 'dot' renders the graph
40
+ - By default, don't draw transitive inherited associations
41
+ - Added --transitive flag to draw transitive inherited associations
42
+ - Added --exclude flag for ommiting classes (this may help to produce
43
+ diagrams for applications with broken classes)
44
+
45
+ == Version 0.3.4 (apr 12 2007)
46
+ - Add support for model abstract classes.
47
+ (don't try to get content columns, bug #10033)
48
+ - Add verbose mode
49
+ - More code cleanup.
50
+ - Using an internal representation and then
51
+ generating the DOT output. This will allow to
52
+ add more output formats in the future.
53
+
54
+ == Version 0.3.3 (apr 10 2007)
55
+ - Code cleanup
56
+
57
+ == Version 0.3.2 (apr 9 2007)
58
+ - Disable STDOUT when loading applications classes, avoiding
59
+ messing up the DOT output.
60
+ (Thanks to Sebastien Auvray, http://tnlessone.wordpress.com/)
61
+
62
+ == Version 0.3.1 (apr 9 2007)
63
+ - Release again for fix an error in .gem file
64
+
65
+ == Version 0.3.0 (apr 9 2007)
66
+ - Major code rewrite
67
+ (More OO style)
68
+ - Using Ruby's optparse to parse commandline options
69
+ - Added flags for including (excluding) controllers methods
70
+ based on visibility
71
+ - Added -o flag for file output.
72
+ - Minor cosmetic changes.
73
+
74
+ == Version 0.2.0 (apr 8 2007)
75
+ - Differentiate classes from modules
76
+ - Added "-m" flag for considering modules
77
+ - Draw double-headed arrows for habtm and has_many, :through associations
78
+ - Fix inheritance support for non ActiveRecord::Base classes on model
79
+ diagrams
80
+
81
+ == Version 0.1.2 (apr 7 2007)
82
+ - Documentation moved from script header to README
83
+
84
+ == Version 0.1.1 (apr 5 2007)
85
+ - Changed default graph label fontsize to 14.
86
+ - Better error handling.
87
+ - Minor cosmetic changes.
88
+ - New way to load classes, supporting subdirectories traversal.
89
+ (Inspired in RAV, http://rav.rubyforge.org/)
90
+ - RailRoad version included in diagrams' label.
91
+
92
+ == Version 0.1.0 (apr 2 2007)
93
+ - Initial release.
data/LICENSE ADDED
@@ -0,0 +1,340 @@
1
+ =GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ ==Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Library General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ =GNU GENERAL PUBLIC LICENSE
60
+ ==TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0) This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1) You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2) You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3) You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4) You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5) You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6) Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7) If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8) If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9) The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10) If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ ==NO WARRANTY
259
+
260
+ 11) BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12) IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ ==END OF TERMS AND CONDITIONS
281
+
282
+ =How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) year name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.
data/README.rdoc ADDED
@@ -0,0 +1,166 @@
1
+ = RailRoad
2
+
3
+ RailRoad generates models and controllers diagrams in DOT language for a
4
+ Rails application.
5
+
6
+ This is a patched version based on the original v0.5.0.
7
+
8
+ I (Peter Hoeg) am not trying to hijack Javier's project, but since he hasn't released any
9
+ new versions since May '08, I figured I'd better put one out in order to make
10
+ railroad work with rails v2.3.
11
+
12
+ = Usage
13
+
14
+ Run RailRoad on the Rails application's root directory. You can redirect its
15
+ output to a .dot file or pipe it to the dot or neato utilities to produce a
16
+ graphic. Model diagrams are intended to be processed using dot and
17
+ controller diagrams are best processed using neato.
18
+
19
+ railroad [options] command
20
+
21
+ == Options
22
+
23
+ Common options:
24
+ -b, --brief Generate compact diagram
25
+ (no attributes nor methods)
26
+ -e, --exclude file1[,fileN] Exclude given files
27
+ -i, --inheritance Include inheritance relations
28
+ -l, --label Add a label with diagram information
29
+ (type, date, migration, version)
30
+ -o, --output FILE Write diagram to file FILE
31
+ -v, --verbose Enable verbose output
32
+ (produce messages to STDOUT)
33
+
34
+ Models diagram options:
35
+ -a, --all Include all models
36
+ (not only ActiveRecord::Base derived)
37
+ --hide-magic Hide magic field names
38
+ --hide-types Hide attributes type
39
+ -j, --join Concentrate edges
40
+ -m, --modules Include modules
41
+ -p, --plugins-models Include plugins models
42
+ -t, --transitive Include transitive associations
43
+ (through inheritance)
44
+
45
+ Controllers diagram options:
46
+ --hide-public Hide public methods
47
+ --hide-protected Hide protected methods
48
+ --hide-private Hide private methods
49
+
50
+ Other options:
51
+ -h, --help Show this message
52
+ --version Show version and copyright
53
+
54
+ == Commands
55
+
56
+ -M, --models Generate models diagram
57
+ -C, --controllers Generate controllers diagram
58
+ -A, --aasm Generate "acts as state machine" diagram
59
+
60
+
61
+ == Examples
62
+
63
+ railroad -o models.dot -M
64
+ Produces a models diagram to the file 'models.dot'
65
+ railroad -a -i -o full_models.dot -M
66
+ Models diagram with all classes showing inheritance relations
67
+ railroad -M | dot -Tsvg > models.svg
68
+ Model diagram in SVG format
69
+ railroad -C | neato -Tpng > controllers.png
70
+ Controller diagram in PNG format
71
+ railroad -h
72
+ Shows usage help
73
+
74
+
75
+ = Processing DOT files
76
+
77
+ To produce a PNG image from model diagram generated by RailRoad you can
78
+ issue the following command:
79
+
80
+ dot -Tpng models.dot > models.png
81
+
82
+ If you want to do the same with a controller diagram, use neato instead of
83
+ dot:
84
+
85
+ neato -Tpng controllers.dot > controllers.png
86
+
87
+ If you want to produce SVG (vectorial, scalable, editable) files, you can do
88
+ the following:
89
+
90
+ dot -Tsvg models.dot > models.svg
91
+ neato -Tsvg controllers.dot > controllers.svg
92
+
93
+ Important: There is a bug in Graphviz tools when generating SVG files that
94
+ cause a text overflow. You can solve this problem editing (with a text
95
+ editor, not a graphical SVG editor) the file and replacing around line 12
96
+ "font-size:14.00;" by "font-size:11.00;", or by issuing the following command
97
+ (see "man sed"):
98
+
99
+ sed -i 's/font-size:14.00/font-size:11.00/g' file.svg
100
+
101
+ Note: For viewing and editing SVG there is an excellent opensource tool
102
+ called Inkscape (similar to Adobe Illustrator. For DOT processing you can
103
+ also use Omnigraffle (on Mac OS X).
104
+
105
+ = RailRoad as a rake task
106
+
107
+ (Thanks to Thomas Ritz, http://www.galaxy-ritz.de ,for the code.)
108
+
109
+ In your Rails application, put the following rake tasks into 'lib/task/diagrams.rake':
110
+
111
+ namespace :doc do
112
+ namespace :diagram do
113
+ task :models do
114
+ sh "railroad -i -l -a -m -M | dot -Tsvg | sed 's/font-size:14.00/font-size:11.00/g' > doc/models.svg"
115
+ end
116
+
117
+ task :controllers do
118
+ sh "railroad -i -l -C | neato -Tsvg | sed 's/font-size:14.00/font-size:11.00/g' > doc/controllers.svg"
119
+ end
120
+ end
121
+
122
+ task :diagrams => %w(diagram:models diagram:controllers)
123
+ end
124
+
125
+ Then, 'rake doc:diagrams' produces 'doc/models.svg' and 'doc/controllers.svg'.
126
+
127
+ = Requirements
128
+
129
+ RailRoad has been tested with the following Ruby and Rails versions
130
+
131
+ == Ruby
132
+ * 1.8.5
133
+ * 1.8.7
134
+
135
+ == Rails
136
+ * 1.1.6 to 1.2.3
137
+ * 2.3.2
138
+
139
+ There are no additional requirements (nevertheless, all your Rails application
140
+ requirements must be installed).
141
+
142
+ In order to view/export the DOT diagrams, you'll need the processing tools
143
+ from Graphviz.
144
+
145
+ = Website and Project Home
146
+
147
+ http://railroad.rubyforge.org
148
+
149
+ = License
150
+
151
+ RailRoad is distributed under the terms of the GNU General Public License
152
+ as published by the Free Software Foundation; either version 2 of the
153
+ License, or (at your option) any later version.
154
+
155
+ See LICENSE for details.
156
+
157
+ == Copyright
158
+
159
+ Copyright (c) 2007-2008 Javier Smaldone
160
+ Copyright (c) 2009 Peter Hoeg
161
+
162
+ See LICENSE for details.
163
+
164
+ == Authors
165
+
166
+ See AUTHORS for details.
data/Rakefile ADDED
@@ -0,0 +1,48 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "railroad"
8
+ gem.email = ['peter@hoeg.com', 'p.hoeg@northwind.sg', 'javier@smaldone.com.ar']
9
+ gem.homepage = "http://github.com/peterhoeg/RailRoad"
10
+ gem.authors = ["Peter Hoeg", "Javier Smaldone"]
11
+ gem.summary = "A DOT diagram generator for Ruby on Rail applications"
12
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
13
+ end
14
+
15
+ rescue LoadError
16
+ puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
17
+ end
18
+
19
+ require 'spec/rake/spectask'
20
+ Spec::Rake::SpecTask.new(:spec) do |spec|
21
+ spec.libs << 'lib' << 'spec'
22
+ spec.spec_files = FileList['spec/**/*_spec.rb']
23
+ end
24
+
25
+ Spec::Rake::SpecTask.new(:rcov) do |spec|
26
+ spec.libs << 'lib' << 'spec'
27
+ spec.pattern = 'spec/**/*_spec.rb'
28
+ spec.rcov = true
29
+ end
30
+
31
+ task :default => :spec
32
+
33
+ require 'rake/rdoctask'
34
+ Rake::RDocTask.new do |rdoc|
35
+ if File.exist?('VERSION.yml')
36
+ config = YAML.load(File.read('VERSION.yml'))
37
+ version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
38
+ else
39
+ version = ""
40
+ end
41
+
42
+ rdoc.rdoc_dir = 'rdoc'
43
+ rdoc.title = "railroad #{version}"
44
+ rdoc.rdoc_files.include('README*')
45
+ rdoc.rdoc_files.include('CHANGELOG*')
46
+ rdoc.rdoc_files.include('AUTHORS*')
47
+ rdoc.rdoc_files.include('lib/**/*.rb')
48
+ end
data/VERSION.yml ADDED
@@ -0,0 +1,4 @@
1
+ ---
2
+ :major: 0
3
+ :minor: 5
4
+ :patch: 4