railroady 0.11.0 → 0.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.rdoc +12 -30
- data/VERSION.yml +1 -1
- metadata +2 -2
data/README.rdoc
CHANGED
|
@@ -31,7 +31,7 @@ This should generate four doc/*.svg files that can be opened in (most) web brows
|
|
|
31
31
|
|
|
32
32
|
Alternatively, you may run the 'railroady' command-line program at the Rails application's root directory. You can redirect its output to a .dot file or pipe it to the dot or neato utilities to produce a graphic. Model diagrams are intended to be processed using dot and controller diagrams are best processed using neato.
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
railroady [options] command
|
|
35
35
|
|
|
36
36
|
== Options
|
|
37
37
|
|
|
@@ -78,15 +78,15 @@ Other options:
|
|
|
78
78
|
|
|
79
79
|
== Examples
|
|
80
80
|
|
|
81
|
-
|
|
81
|
+
railroady -o models.dot -M
|
|
82
82
|
Produces a models diagram to the file 'models.dot'
|
|
83
|
-
|
|
83
|
+
railroady -a -i -o full_models.dot -M
|
|
84
84
|
Models diagram with all classes showing inheritance relations
|
|
85
|
-
|
|
85
|
+
railroady -M | dot -Tsvg > models.svg
|
|
86
86
|
Model diagram in SVG format
|
|
87
|
-
|
|
87
|
+
railroady -C | neato -Tpng > controllers.png
|
|
88
88
|
Controller diagram in PNG format
|
|
89
|
-
|
|
89
|
+
railroady -h
|
|
90
90
|
Shows usage help
|
|
91
91
|
|
|
92
92
|
|
|
@@ -120,39 +120,20 @@ Note: For viewing and editing SVG there is an excellent opensource tool
|
|
|
120
120
|
called Inkscape (similar to Adobe Illustrator. For DOT processing you can
|
|
121
121
|
also use Omnigraffle (on Mac OS X).
|
|
122
122
|
|
|
123
|
-
=
|
|
123
|
+
= Rake Tasks
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
As of Preston Lee's Rails 3 modifications, including RailRoady as a project development dependency will automatically add a set of rake tasks to your project. Sweet! (Run `rake -T` to check them out.)
|
|
126
126
|
|
|
127
|
-
In your Rails application, put the following rake tasks into 'lib/task/diagrams.rake':
|
|
128
|
-
|
|
129
|
-
namespace :doc do
|
|
130
|
-
namespace :diagram do
|
|
131
|
-
task :models do
|
|
132
|
-
sh "railroad -i -l -a -m -M | dot -Tsvg | sed 's/font-size:14.00/font-size:11.00/g' > doc/models.svg"
|
|
133
|
-
end
|
|
134
|
-
|
|
135
|
-
task :controllers do
|
|
136
|
-
sh "railroad -i -l -C | neato -Tsvg | sed 's/font-size:14.00/font-size:11.00/g' > doc/controllers.svg"
|
|
137
|
-
end
|
|
138
|
-
end
|
|
139
|
-
|
|
140
|
-
task :diagrams => %w(diagram:models diagram:controllers)
|
|
141
|
-
end
|
|
142
|
-
|
|
143
|
-
Then, 'rake doc:diagrams' produces 'doc/models.svg' and 'doc/controllers.svg'.
|
|
144
127
|
|
|
145
128
|
= Requirements
|
|
146
129
|
|
|
147
130
|
RailRoady has been tested with the following Ruby and Rails versions
|
|
148
131
|
|
|
149
132
|
== Ruby
|
|
150
|
-
* 1.
|
|
151
|
-
* 1.8.7
|
|
133
|
+
* 1.9.2
|
|
152
134
|
|
|
153
135
|
== Rails
|
|
154
|
-
*
|
|
155
|
-
* 2.3.2 to 2.3.5
|
|
136
|
+
* 3.0.3
|
|
156
137
|
|
|
157
138
|
There are no additional requirements (nevertheless, all your Rails application
|
|
158
139
|
requirements must be installed).
|
|
@@ -162,7 +143,7 @@ from Graphviz.
|
|
|
162
143
|
|
|
163
144
|
= Website and Project Home
|
|
164
145
|
|
|
165
|
-
http://
|
|
146
|
+
http://github.com/preston/railroady
|
|
166
147
|
|
|
167
148
|
= License
|
|
168
149
|
|
|
@@ -176,6 +157,7 @@ See LICENSE for details.
|
|
|
176
157
|
|
|
177
158
|
Copyright (c) 2007-2008 Javier Smaldone
|
|
178
159
|
Copyright (c) 2009 Peter Hoeg
|
|
160
|
+
Copyright (c) 2010 Preston Lee
|
|
179
161
|
|
|
180
162
|
See LICENSE for details.
|
|
181
163
|
|
data/VERSION.yml
CHANGED