bravo-generators 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/.rvmrc +1 -0
- data/Gemfile +4 -0
- data/LICENSE +22 -0
- data/README.md +23 -0
- data/Rakefile +2 -0
- data/bravo-generators.gemspec +17 -0
- data/lib/generators/bravo.rb +28 -0
- data/lib/generators/bravo/config/USAGE +23 -0
- data/lib/generators/bravo/config/config_generator.rb +24 -0
- data/lib/generators/bravo/config/templates/config.yml +8 -0
- data/lib/generators/bravo/config/templates/load_config.rb +2 -0
- data/lib/generators/bravo/layout/USAGE +25 -0
- data/lib/generators/bravo/layout/layout_generator.rb +29 -0
- data/lib/generators/bravo/layout/templates/error_messages_helper.rb +23 -0
- data/lib/generators/bravo/layout/templates/layout.html.erb +19 -0
- data/lib/generators/bravo/layout/templates/layout.html.haml +21 -0
- data/lib/generators/bravo/layout/templates/layout_helper.rb +22 -0
- data/lib/generators/bravo/layout/templates/stylesheet.css +83 -0
- data/lib/generators/bravo/layout/templates/stylesheet.sass +73 -0
- data/lib/generators/bravo/scaffold/USAGE +51 -0
- data/lib/generators/bravo/scaffold/scaffold_generator.rb +318 -0
- data/lib/generators/bravo/scaffold/templates/actions/create.rb +8 -0
- data/lib/generators/bravo/scaffold/templates/actions/destroy.rb +5 -0
- data/lib/generators/bravo/scaffold/templates/actions/edit.rb +3 -0
- data/lib/generators/bravo/scaffold/templates/actions/index.rb +3 -0
- data/lib/generators/bravo/scaffold/templates/actions/new.rb +3 -0
- data/lib/generators/bravo/scaffold/templates/actions/show.rb +3 -0
- data/lib/generators/bravo/scaffold/templates/actions/update.rb +8 -0
- data/lib/generators/bravo/scaffold/templates/controller.rb +3 -0
- data/lib/generators/bravo/scaffold/templates/fixtures.yml +9 -0
- data/lib/generators/bravo/scaffold/templates/helper.rb +2 -0
- data/lib/generators/bravo/scaffold/templates/migration.rb +16 -0
- data/lib/generators/bravo/scaffold/templates/model.rb +4 -0
- data/lib/generators/bravo/scaffold/templates/tests/rspec/actions/create.rb +11 -0
- data/lib/generators/bravo/scaffold/templates/tests/rspec/actions/destroy.rb +6 -0
- data/lib/generators/bravo/scaffold/templates/tests/rspec/actions/edit.rb +4 -0
- data/lib/generators/bravo/scaffold/templates/tests/rspec/actions/index.rb +4 -0
- data/lib/generators/bravo/scaffold/templates/tests/rspec/actions/new.rb +4 -0
- data/lib/generators/bravo/scaffold/templates/tests/rspec/actions/show.rb +4 -0
- data/lib/generators/bravo/scaffold/templates/tests/rspec/actions/update.rb +11 -0
- data/lib/generators/bravo/scaffold/templates/tests/rspec/controller.rb +8 -0
- data/lib/generators/bravo/scaffold/templates/tests/rspec/model.rb +7 -0
- data/lib/generators/bravo/scaffold/templates/tests/shoulda/actions/create.rb +13 -0
- data/lib/generators/bravo/scaffold/templates/tests/shoulda/actions/destroy.rb +8 -0
- data/lib/generators/bravo/scaffold/templates/tests/shoulda/actions/edit.rb +6 -0
- data/lib/generators/bravo/scaffold/templates/tests/shoulda/actions/index.rb +6 -0
- data/lib/generators/bravo/scaffold/templates/tests/shoulda/actions/new.rb +6 -0
- data/lib/generators/bravo/scaffold/templates/tests/shoulda/actions/show.rb +6 -0
- data/lib/generators/bravo/scaffold/templates/tests/shoulda/actions/update.rb +13 -0
- data/lib/generators/bravo/scaffold/templates/tests/shoulda/controller.rb +5 -0
- data/lib/generators/bravo/scaffold/templates/tests/shoulda/model.rb +7 -0
- data/lib/generators/bravo/scaffold/templates/tests/testunit/actions/create.rb +11 -0
- data/lib/generators/bravo/scaffold/templates/tests/testunit/actions/destroy.rb +6 -0
- data/lib/generators/bravo/scaffold/templates/tests/testunit/actions/edit.rb +4 -0
- data/lib/generators/bravo/scaffold/templates/tests/testunit/actions/index.rb +4 -0
- data/lib/generators/bravo/scaffold/templates/tests/testunit/actions/new.rb +4 -0
- data/lib/generators/bravo/scaffold/templates/tests/testunit/actions/show.rb +4 -0
- data/lib/generators/bravo/scaffold/templates/tests/testunit/actions/update.rb +11 -0
- data/lib/generators/bravo/scaffold/templates/tests/testunit/controller.rb +5 -0
- data/lib/generators/bravo/scaffold/templates/tests/testunit/model.rb +7 -0
- data/lib/generators/bravo/scaffold/templates/views/erb/_form.html.erb +10 -0
- data/lib/generators/bravo/scaffold/templates/views/erb/edit.html.erb +14 -0
- data/lib/generators/bravo/scaffold/templates/views/erb/index.html.erb +29 -0
- data/lib/generators/bravo/scaffold/templates/views/erb/new.html.erb +7 -0
- data/lib/generators/bravo/scaffold/templates/views/erb/show.html.erb +20 -0
- data/lib/generators/bravo/scaffold/templates/views/haml/_form.html.haml +9 -0
- data/lib/generators/bravo/scaffold/templates/views/haml/edit.html.haml +14 -0
- data/lib/generators/bravo/scaffold/templates/views/haml/index.html.haml +25 -0
- data/lib/generators/bravo/scaffold/templates/views/haml/new.html.haml +7 -0
- data/lib/generators/bravo/scaffold/templates/views/haml/show.html.haml +20 -0
- metadata +128 -0
@@ -0,0 +1,51 @@
|
|
1
|
+
Description:
|
2
|
+
Scaffolds an entire resource, from model and migration to controller and
|
3
|
+
views. The resource is ready to use as a starting point for your restful,
|
4
|
+
resource-oriented application. Tests or specs are also generated depending
|
5
|
+
on if you have a "spec" directory or not.
|
6
|
+
|
7
|
+
IMPORTANT: This generator uses the "title" helper method which is generated
|
8
|
+
by the bravo_layout generator. You may want to run that generator first.
|
9
|
+
|
10
|
+
Usage:
|
11
|
+
Pass the name of the model, either CamelCased or under_scored, as the first
|
12
|
+
argument along with an optional list of attribute pairs and controller actions.
|
13
|
+
|
14
|
+
If no controller actions are specified, they will default to index, show,
|
15
|
+
new, create, edit, update, and destroy.
|
16
|
+
|
17
|
+
IMPORTANT: If no attribute pairs are specified, no model will be generated.
|
18
|
+
It will try to determine the attributes from an existing model.
|
19
|
+
|
20
|
+
Attribute pairs are column_name:sql_type arguments specifying the
|
21
|
+
model's attributes. Timestamps are added by default, so you don't have to
|
22
|
+
specify them by hand as 'created_at:datetime updated_at:datetime'.
|
23
|
+
|
24
|
+
For example, `bravo:scaffold post name:string content:text hidden:boolean`
|
25
|
+
gives you a model with those three attributes, a controller that handles
|
26
|
+
the create/show/update/destroy, forms to create and edit your posts, and
|
27
|
+
an index that lists them all, as well as a map.resources :posts
|
28
|
+
declaration in config/routes.rb.
|
29
|
+
|
30
|
+
Adding an "!" in the mix of arguments will invert the passed controller
|
31
|
+
actions. This will include all 7 controller actitons except the ones
|
32
|
+
mentioned. This option doesn't affect model attributes.
|
33
|
+
|
34
|
+
Examples:
|
35
|
+
rails generate bravo:scaffold post
|
36
|
+
|
37
|
+
Will create a controller called "posts" it will contain all seven
|
38
|
+
CRUD actions along with the views. A model will NOT be created,
|
39
|
+
instead it will look for an existing model and use those attributes.
|
40
|
+
|
41
|
+
rails generate bravo:scaffold post name:string content:text index new edit
|
42
|
+
|
43
|
+
Will create a Post model and migration file with the name and content
|
44
|
+
attributes. It will also create a controller with index, new, create,
|
45
|
+
edit, and update actions. Notice the create and update actions are
|
46
|
+
added automatically with new and edit.
|
47
|
+
|
48
|
+
rails generate bravo:scaffold post ! show new
|
49
|
+
|
50
|
+
Creates a posts controller (no model) with index, edit, update, and
|
51
|
+
destroy actions.
|
@@ -0,0 +1,318 @@
|
|
1
|
+
require 'generators/bravo'
|
2
|
+
require 'rails/generators/migration'
|
3
|
+
require 'rails/generators/generated_attribute'
|
4
|
+
|
5
|
+
module Bravo
|
6
|
+
module Generators
|
7
|
+
class ScaffoldGenerator < Base
|
8
|
+
include Rails::Generators::Migration
|
9
|
+
no_tasks { attr_accessor :scaffold_name, :model_attributes, :controller_actions }
|
10
|
+
|
11
|
+
argument :scaffold_name, :type => :string, :required => true, :banner => 'ModelName'
|
12
|
+
argument :args_for_c_m, :type => :array, :default => [], :banner => 'controller_actions and model:attributes'
|
13
|
+
|
14
|
+
class_option :skip_model, :desc => 'Don\'t generate a model or migration file.', :type => :boolean
|
15
|
+
class_option :skip_migration, :desc => 'Don\'t generate migration file for model.', :type => :boolean
|
16
|
+
class_option :skip_timestamps, :desc => 'Don\'t add timestamps to migration file.', :type => :boolean
|
17
|
+
class_option :skip_controller, :desc => 'Don\'t generate controller, helper, or views.', :type => :boolean
|
18
|
+
class_option :invert, :desc => 'Generate all controller actions except these mentioned.', :type => :boolean
|
19
|
+
class_option :namespace_model, :desc => 'If the resource is namespaced, include the model in the namespace.', :type => :boolean
|
20
|
+
class_option :haml, :desc => 'Generate HAML views instead of ERB.', :type => :boolean
|
21
|
+
|
22
|
+
class_option :testunit, :desc => 'Use test/unit for test files.', :group => 'Test framework', :type => :boolean
|
23
|
+
class_option :rspec, :desc => 'Use RSpec for test files.', :group => 'Test framework', :type => :boolean
|
24
|
+
class_option :shoulda, :desc => 'Use shoulda for test files.', :group => 'Test framework', :type => :boolean
|
25
|
+
|
26
|
+
def initialize(*args, &block)
|
27
|
+
super
|
28
|
+
|
29
|
+
print_usage unless scaffold_name.underscore =~ /^[a-z][a-z0-9_\/]+$/
|
30
|
+
|
31
|
+
@controller_actions = []
|
32
|
+
@model_attributes = []
|
33
|
+
@skip_model = options.skip_model?
|
34
|
+
@namespace_model = options.namespace_model?
|
35
|
+
@invert_actions = options.invert?
|
36
|
+
|
37
|
+
args_for_c_m.each do |arg|
|
38
|
+
if arg == '!'
|
39
|
+
@invert_actions = true
|
40
|
+
elsif arg.include?(':')
|
41
|
+
@model_attributes << Rails::Generators::GeneratedAttribute.new(*arg.split(':'))
|
42
|
+
else
|
43
|
+
@controller_actions << arg
|
44
|
+
@controller_actions << 'create' if arg == 'new'
|
45
|
+
@controller_actions << 'update' if arg == 'edit'
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
@controller_actions.uniq!
|
50
|
+
@model_attributes.uniq!
|
51
|
+
|
52
|
+
if @invert_actions || @controller_actions.empty?
|
53
|
+
@controller_actions = all_actions - @controller_actions
|
54
|
+
end
|
55
|
+
|
56
|
+
if @model_attributes.empty?
|
57
|
+
@skip_model = true # skip model if no attributes
|
58
|
+
if model_exists?
|
59
|
+
model_columns_for_attributes.each do |column|
|
60
|
+
@model_attributes << Rails::Generators::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
|
61
|
+
end
|
62
|
+
else
|
63
|
+
@model_attributes << Rails::Generators::GeneratedAttribute.new('name', 'string')
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
def add_gems
|
69
|
+
add_gem "mocha", :group => :test
|
70
|
+
end
|
71
|
+
|
72
|
+
def create_model
|
73
|
+
unless @skip_model
|
74
|
+
template 'model.rb', "app/models/#{model_path}.rb"
|
75
|
+
if test_framework == :rspec
|
76
|
+
template "tests/rspec/model.rb", "spec/models/#{model_path}_spec.rb"
|
77
|
+
template 'fixtures.yml', "spec/fixtures/#{model_path.pluralize}.yml"
|
78
|
+
else
|
79
|
+
template "tests/#{test_framework}/model.rb", "test/unit/#{model_path}_test.rb"
|
80
|
+
template 'fixtures.yml', "test/fixtures/#{model_path.pluralize}.yml"
|
81
|
+
end
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
85
|
+
def create_migration
|
86
|
+
unless @skip_model || options.skip_migration?
|
87
|
+
migration_template 'migration.rb', "db/migrate/create_#{model_path.pluralize.gsub('/', '_')}.rb"
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
def create_controller
|
92
|
+
unless options.skip_controller?
|
93
|
+
template 'controller.rb', "app/controllers/#{plural_name}_controller.rb"
|
94
|
+
|
95
|
+
template 'helper.rb', "app/helpers/#{plural_name}_helper.rb"
|
96
|
+
|
97
|
+
controller_actions.each do |action|
|
98
|
+
if %w[index show new edit].include?(action) # Actions with templates
|
99
|
+
template "views/#{view_language}/#{action}.html.#{view_language}", "app/views/#{plural_name}/#{action}.html.#{view_language}"
|
100
|
+
end
|
101
|
+
end
|
102
|
+
|
103
|
+
if form_partial?
|
104
|
+
template "views/#{view_language}/_form.html.#{view_language}", "app/views/#{plural_name}/_form.html.#{view_language}"
|
105
|
+
end
|
106
|
+
|
107
|
+
namespaces = plural_name.split('/')
|
108
|
+
resource = namespaces.pop
|
109
|
+
route namespaces.reverse.inject("resources :#{resource}") { |acc, namespace|
|
110
|
+
"namespace(:#{namespace}){ #{acc} }"
|
111
|
+
}
|
112
|
+
|
113
|
+
if test_framework == :rspec
|
114
|
+
template "tests/#{test_framework}/controller.rb", "spec/controllers/#{plural_name}_controller_spec.rb"
|
115
|
+
else
|
116
|
+
template "tests/#{test_framework}/controller.rb", "test/functional/#{plural_name}_controller_test.rb"
|
117
|
+
end
|
118
|
+
end
|
119
|
+
end
|
120
|
+
|
121
|
+
private
|
122
|
+
|
123
|
+
def form_partial?
|
124
|
+
actions? :new, :edit
|
125
|
+
end
|
126
|
+
|
127
|
+
def all_actions
|
128
|
+
%w[index show new create edit update destroy]
|
129
|
+
end
|
130
|
+
|
131
|
+
def action?(name)
|
132
|
+
controller_actions.include? name.to_s
|
133
|
+
end
|
134
|
+
|
135
|
+
def actions?(*names)
|
136
|
+
names.all? { |name| action? name }
|
137
|
+
end
|
138
|
+
|
139
|
+
def singular_name
|
140
|
+
scaffold_name.underscore
|
141
|
+
end
|
142
|
+
|
143
|
+
def plural_name
|
144
|
+
scaffold_name.underscore.pluralize
|
145
|
+
end
|
146
|
+
|
147
|
+
def table_name
|
148
|
+
if scaffold_name.include?('::') && @namespace_model
|
149
|
+
plural_name.gsub('/', '_')
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
153
|
+
def class_name
|
154
|
+
if @namespace_model
|
155
|
+
scaffold_name.camelize
|
156
|
+
else
|
157
|
+
scaffold_name.split('::').last.camelize
|
158
|
+
end
|
159
|
+
end
|
160
|
+
|
161
|
+
def model_path
|
162
|
+
class_name.underscore
|
163
|
+
end
|
164
|
+
|
165
|
+
def plural_class_name
|
166
|
+
plural_name.camelize
|
167
|
+
end
|
168
|
+
|
169
|
+
def instance_name
|
170
|
+
if @namespace_model
|
171
|
+
singular_name.gsub('/','_')
|
172
|
+
else
|
173
|
+
singular_name.split('/').last
|
174
|
+
end
|
175
|
+
end
|
176
|
+
|
177
|
+
def instances_name
|
178
|
+
instance_name.pluralize
|
179
|
+
end
|
180
|
+
|
181
|
+
def controller_methods(dir_name)
|
182
|
+
controller_actions.map do |action|
|
183
|
+
read_template("#{dir_name}/#{action}.rb")
|
184
|
+
end.join("\n").strip
|
185
|
+
end
|
186
|
+
|
187
|
+
def render_form
|
188
|
+
if form_partial?
|
189
|
+
if options.haml?
|
190
|
+
"= render \"form\""
|
191
|
+
else
|
192
|
+
"<%= render \"form\" %>"
|
193
|
+
end
|
194
|
+
else
|
195
|
+
read_template("views/#{view_language}/_form.html.#{view_language}")
|
196
|
+
end
|
197
|
+
end
|
198
|
+
|
199
|
+
def item_resource
|
200
|
+
scaffold_name.underscore.gsub('/','_')
|
201
|
+
end
|
202
|
+
|
203
|
+
def items_path
|
204
|
+
if action? :index
|
205
|
+
"#{item_resource.pluralize}_path"
|
206
|
+
else
|
207
|
+
"root_path"
|
208
|
+
end
|
209
|
+
end
|
210
|
+
|
211
|
+
def item_path(options = {})
|
212
|
+
name = options[:instance_variable] ? "@#{instance_name}" : instance_name
|
213
|
+
suffix = options[:full_url] ? "url" : "path"
|
214
|
+
if options[:action].to_s == "new"
|
215
|
+
"new_#{item_resource}_#{suffix}"
|
216
|
+
elsif options[:action].to_s == "edit"
|
217
|
+
"edit_#{item_resource}_#{suffix}(#{name})"
|
218
|
+
else
|
219
|
+
if scaffold_name.include?('::') && !@namespace_model
|
220
|
+
namespace = singular_name.split('/')[0..-2]
|
221
|
+
"[:#{namespace.join(', :')}, #{name}]"
|
222
|
+
else
|
223
|
+
name
|
224
|
+
end
|
225
|
+
end
|
226
|
+
end
|
227
|
+
|
228
|
+
def item_url
|
229
|
+
if action? :show
|
230
|
+
item_path(:full_url => true, :instance_variable => true)
|
231
|
+
else
|
232
|
+
items_url
|
233
|
+
end
|
234
|
+
end
|
235
|
+
|
236
|
+
def items_url
|
237
|
+
if action? :index
|
238
|
+
item_resource.pluralize + '_url'
|
239
|
+
else
|
240
|
+
"root_url"
|
241
|
+
end
|
242
|
+
end
|
243
|
+
|
244
|
+
def item_path_for_spec(suffix = 'path')
|
245
|
+
if action? :show
|
246
|
+
"#{item_resource}_#{suffix}(assigns[:#{instance_name}])"
|
247
|
+
else
|
248
|
+
if suffix == 'path'
|
249
|
+
items_path
|
250
|
+
else
|
251
|
+
items_url
|
252
|
+
end
|
253
|
+
end
|
254
|
+
end
|
255
|
+
|
256
|
+
def item_path_for_test(suffix = 'path')
|
257
|
+
if action? :show
|
258
|
+
"#{item_resource}_#{suffix}(assigns(:#{instance_name}))"
|
259
|
+
else
|
260
|
+
if suffix == 'path'
|
261
|
+
items_path
|
262
|
+
else
|
263
|
+
items_url
|
264
|
+
end
|
265
|
+
end
|
266
|
+
end
|
267
|
+
|
268
|
+
def model_columns_for_attributes
|
269
|
+
class_name.constantize.columns.reject do |column|
|
270
|
+
column.name.to_s =~ /^(id|created_at|updated_at)$/
|
271
|
+
end
|
272
|
+
end
|
273
|
+
|
274
|
+
def view_language
|
275
|
+
options.haml? ? 'haml' : 'erb'
|
276
|
+
end
|
277
|
+
|
278
|
+
def test_framework
|
279
|
+
return @test_framework if defined?(@test_framework)
|
280
|
+
if options.testunit?
|
281
|
+
return @test_framework = :testunit
|
282
|
+
elsif options.rspec?
|
283
|
+
return @test_framework = :rspec
|
284
|
+
elsif options.shoulda?
|
285
|
+
return @test_framework = :shoulda
|
286
|
+
else
|
287
|
+
return @test_framework = default_test_framework
|
288
|
+
end
|
289
|
+
end
|
290
|
+
|
291
|
+
def default_test_framework
|
292
|
+
File.exist?(destination_path("spec")) ? :rspec : :testunit
|
293
|
+
end
|
294
|
+
|
295
|
+
def model_exists?
|
296
|
+
File.exist? destination_path("app/models/#{singular_name}.rb")
|
297
|
+
end
|
298
|
+
|
299
|
+
def read_template(relative_path)
|
300
|
+
ERB.new(File.read(find_in_source_paths(relative_path)), nil, '-').result(binding)
|
301
|
+
end
|
302
|
+
|
303
|
+
def destination_path(path)
|
304
|
+
File.join(destination_root, path)
|
305
|
+
end
|
306
|
+
|
307
|
+
# FIXME: Should be proxied to ActiveRecord::Generators::Base
|
308
|
+
# Implement the required interface for Rails::Generators::Migration.
|
309
|
+
def self.next_migration_number(dirname) #:nodoc:
|
310
|
+
if ActiveRecord::Base.timestamped_migrations
|
311
|
+
Time.now.utc.strftime("%Y%m%d%H%M%S")
|
312
|
+
else
|
313
|
+
"%.3d" % (current_migration_number(dirname) + 1)
|
314
|
+
end
|
315
|
+
end
|
316
|
+
end
|
317
|
+
end
|
318
|
+
end
|
@@ -0,0 +1,8 @@
|
|
1
|
+
def create
|
2
|
+
@<%= instance_name %> = <%= class_name %>.new(params[:<%= instance_name %>])
|
3
|
+
if @<%= instance_name %>.save
|
4
|
+
redirect_to <%= item_url %>, :notice => "Successfully created <%= class_name.underscore.humanize.downcase %>."
|
5
|
+
else
|
6
|
+
render :new
|
7
|
+
end
|
8
|
+
end
|
@@ -0,0 +1,8 @@
|
|
1
|
+
def update
|
2
|
+
@<%= instance_name %> = <%= class_name %>.find(params[:id])
|
3
|
+
if @<%= instance_name %>.update_attributes(params[:<%= instance_name %>])
|
4
|
+
redirect_to <%= item_url %>, :notice => "Successfully updated <%= class_name.underscore.humanize.downcase %>."
|
5
|
+
else
|
6
|
+
render :edit
|
7
|
+
end
|
8
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
class Create<%= class_name.pluralize.delete('::') %> < ActiveRecord::Migration
|
2
|
+
def self.up
|
3
|
+
create_table :<%= table_name || plural_name.split('/').last %> do |t|
|
4
|
+
<%- for attribute in model_attributes -%>
|
5
|
+
t.<%= attribute.type %> :<%= attribute.name %>
|
6
|
+
<%- end -%>
|
7
|
+
<%- unless options[:skip_timestamps] -%>
|
8
|
+
t.timestamps
|
9
|
+
<%- end -%>
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
def self.down
|
14
|
+
drop_table :<%= table_name || plural_name.split('/').last %>
|
15
|
+
end
|
16
|
+
end
|