pager-resource_controller 1.0.20080513

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.
Files changed (201) hide show
  1. data/LICENSE +22 -0
  2. data/README +276 -0
  3. data/Rakefile +55 -0
  4. data/TODO +1 -0
  5. data/generators/scaffold_resource/USAGE +29 -0
  6. data/generators/scaffold_resource/scaffold_resource_generator.rb +101 -0
  7. data/generators/scaffold_resource/templates/controller.rb +2 -0
  8. data/generators/scaffold_resource/templates/fixtures.yml +10 -0
  9. data/generators/scaffold_resource/templates/functional_test.rb +57 -0
  10. data/generators/scaffold_resource/templates/helper.rb +2 -0
  11. data/generators/scaffold_resource/templates/migration.rb +15 -0
  12. data/generators/scaffold_resource/templates/model.rb +2 -0
  13. data/generators/scaffold_resource/templates/old_migration.rb +13 -0
  14. data/generators/scaffold_resource/templates/shoulda_functional_test.rb +19 -0
  15. data/generators/scaffold_resource/templates/unit_test.rb +7 -0
  16. data/generators/scaffold_resource/templates/view__form.erb +6 -0
  17. data/generators/scaffold_resource/templates/view__form.haml +5 -0
  18. data/generators/scaffold_resource/templates/view_edit.erb +16 -0
  19. data/generators/scaffold_resource/templates/view_edit.haml +11 -0
  20. data/generators/scaffold_resource/templates/view_index.erb +22 -0
  21. data/generators/scaffold_resource/templates/view_index.haml +19 -0
  22. data/generators/scaffold_resource/templates/view_new.erb +12 -0
  23. data/generators/scaffold_resource/templates/view_new.haml +9 -0
  24. data/generators/scaffold_resource/templates/view_show.erb +9 -0
  25. data/generators/scaffold_resource/templates/view_show.haml +9 -0
  26. data/init.rb +6 -0
  27. data/install.rb +1 -0
  28. data/lib/resource_controller.rb +11 -0
  29. data/lib/resource_controller/accessors.rb +76 -0
  30. data/lib/resource_controller/action_options.rb +28 -0
  31. data/lib/resource_controller/actions.rb +75 -0
  32. data/lib/resource_controller/base.rb +15 -0
  33. data/lib/resource_controller/class_methods.rb +22 -0
  34. data/lib/resource_controller/controller.rb +63 -0
  35. data/lib/resource_controller/failable_action_options.rb +17 -0
  36. data/lib/resource_controller/helpers.rb +28 -0
  37. data/lib/resource_controller/helpers/current_objects.rb +69 -0
  38. data/lib/resource_controller/helpers/internal.rb +59 -0
  39. data/lib/resource_controller/helpers/nested.rb +45 -0
  40. data/lib/resource_controller/helpers/urls.rb +124 -0
  41. data/lib/resource_controller/response_collector.rb +21 -0
  42. data/lib/urligence.rb +50 -0
  43. data/rails/init.rb +1 -0
  44. data/test/Rakefile +10 -0
  45. data/test/app/controllers/application.rb +7 -0
  46. data/test/app/controllers/cms/options_controller.rb +3 -0
  47. data/test/app/controllers/cms/products_controller.rb +2 -0
  48. data/test/app/controllers/comments_controller.rb +3 -0
  49. data/test/app/controllers/people_controller.rb +9 -0
  50. data/test/app/controllers/photos_controller.rb +10 -0
  51. data/test/app/controllers/posts_controller.rb +10 -0
  52. data/test/app/controllers/projects_controller.rb +3 -0
  53. data/test/app/controllers/somethings_controller.rb +3 -0
  54. data/test/app/controllers/tags_controller.rb +13 -0
  55. data/test/app/controllers/users_controller.rb +12 -0
  56. data/test/app/helpers/application_helper.rb +3 -0
  57. data/test/app/helpers/cms/products_helper.rb +2 -0
  58. data/test/app/helpers/comments_helper.rb +2 -0
  59. data/test/app/helpers/options_helper.rb +2 -0
  60. data/test/app/helpers/people_helper.rb +2 -0
  61. data/test/app/helpers/photos_helper.rb +2 -0
  62. data/test/app/helpers/posts_helper.rb +2 -0
  63. data/test/app/helpers/projects_helper.rb +2 -0
  64. data/test/app/helpers/somethings_helper.rb +2 -0
  65. data/test/app/helpers/tags_helper.rb +2 -0
  66. data/test/app/helpers/users_helper.rb +2 -0
  67. data/test/app/models/account.rb +3 -0
  68. data/test/app/models/comment.rb +3 -0
  69. data/test/app/models/option.rb +3 -0
  70. data/test/app/models/photo.rb +4 -0
  71. data/test/app/models/post.rb +3 -0
  72. data/test/app/models/product.rb +3 -0
  73. data/test/app/models/project.rb +2 -0
  74. data/test/app/models/something.rb +2 -0
  75. data/test/app/models/tag.rb +3 -0
  76. data/test/app/views/cms/options/edit.rhtml +17 -0
  77. data/test/app/views/cms/options/index.rhtml +20 -0
  78. data/test/app/views/cms/options/new.rhtml +16 -0
  79. data/test/app/views/cms/options/show.rhtml +8 -0
  80. data/test/app/views/cms/products/edit.rhtml +17 -0
  81. data/test/app/views/cms/products/index.rhtml +20 -0
  82. data/test/app/views/cms/products/new.rhtml +16 -0
  83. data/test/app/views/cms/products/show.rhtml +8 -0
  84. data/test/app/views/comments/edit.rhtml +27 -0
  85. data/test/app/views/comments/index.rhtml +24 -0
  86. data/test/app/views/comments/new.rhtml +26 -0
  87. data/test/app/views/comments/show.rhtml +18 -0
  88. data/test/app/views/layouts/application.rhtml +17 -0
  89. data/test/app/views/layouts/comments.rhtml +17 -0
  90. data/test/app/views/layouts/options.rhtml +17 -0
  91. data/test/app/views/layouts/people.rhtml +17 -0
  92. data/test/app/views/layouts/photos.rhtml +17 -0
  93. data/test/app/views/layouts/projects.rhtml +17 -0
  94. data/test/app/views/layouts/somethings.rhtml +17 -0
  95. data/test/app/views/layouts/tags.rhtml +17 -0
  96. data/test/app/views/people/edit.rhtml +17 -0
  97. data/test/app/views/people/index.rhtml +20 -0
  98. data/test/app/views/people/new.rhtml +16 -0
  99. data/test/app/views/people/show.rhtml +8 -0
  100. data/test/app/views/photos/edit.rhtml +17 -0
  101. data/test/app/views/photos/index.rhtml +20 -0
  102. data/test/app/views/photos/new.rhtml +16 -0
  103. data/test/app/views/photos/show.rhtml +8 -0
  104. data/test/app/views/posts/edit.rhtml +22 -0
  105. data/test/app/views/posts/index.rhtml +22 -0
  106. data/test/app/views/posts/new.rhtml +21 -0
  107. data/test/app/views/posts/show.rhtml +13 -0
  108. data/test/app/views/projects/edit.rhtml +17 -0
  109. data/test/app/views/projects/index.rhtml +20 -0
  110. data/test/app/views/projects/new.rhtml +16 -0
  111. data/test/app/views/projects/show.rhtml +8 -0
  112. data/test/app/views/somethings/edit.rhtml +17 -0
  113. data/test/app/views/somethings/index.rhtml +20 -0
  114. data/test/app/views/somethings/new.rhtml +16 -0
  115. data/test/app/views/somethings/show.rhtml +8 -0
  116. data/test/app/views/tags/edit.rhtml +17 -0
  117. data/test/app/views/tags/index.rhtml +20 -0
  118. data/test/app/views/tags/index.rjs +0 -0
  119. data/test/app/views/tags/new.rhtml +16 -0
  120. data/test/app/views/tags/show.rhtml +8 -0
  121. data/test/app/views/users/edit.rhtml +17 -0
  122. data/test/app/views/users/index.rhtml +20 -0
  123. data/test/app/views/users/new.rhtml +16 -0
  124. data/test/app/views/users/show.rhtml +8 -0
  125. data/test/config/boot.rb +45 -0
  126. data/test/config/database.yml +16 -0
  127. data/test/config/environment.rb +64 -0
  128. data/test/config/environments/development.rb +21 -0
  129. data/test/config/environments/test.rb +19 -0
  130. data/test/config/routes.rb +51 -0
  131. data/test/db/migrate/001_create_posts.rb +12 -0
  132. data/test/db/migrate/002_create_products.rb +11 -0
  133. data/test/db/migrate/003_create_comments.rb +13 -0
  134. data/test/db/migrate/004_create_options.rb +12 -0
  135. data/test/db/migrate/005_create_photos.rb +11 -0
  136. data/test/db/migrate/006_create_tags.rb +17 -0
  137. data/test/db/migrate/007_create_somethings.rb +11 -0
  138. data/test/db/migrate/008_create_accounts.rb +11 -0
  139. data/test/db/migrate/009_add_account_id_to_photos.rb +9 -0
  140. data/test/db/migrate/010_create_projects.rb +11 -0
  141. data/test/db/schema.rb +65 -0
  142. data/test/script/console +3 -0
  143. data/test/script/destroy +3 -0
  144. data/test/script/generate +3 -0
  145. data/test/script/server +3 -0
  146. data/test/test/fixtures/accounts.yml +7 -0
  147. data/test/test/fixtures/comments.yml +11 -0
  148. data/test/test/fixtures/options.yml +9 -0
  149. data/test/test/fixtures/photos.yml +9 -0
  150. data/test/test/fixtures/photos_tags.yml +3 -0
  151. data/test/test/fixtures/posts.yml +9 -0
  152. data/test/test/fixtures/products.yml +7 -0
  153. data/test/test/fixtures/projects.yml +7 -0
  154. data/test/test/fixtures/somethings.yml +7 -0
  155. data/test/test/fixtures/tags.yml +7 -0
  156. data/test/test/functional/cms/options_controller_test.rb +20 -0
  157. data/test/test/functional/cms/products_controller_test.rb +18 -0
  158. data/test/test/functional/comments_controller_test.rb +26 -0
  159. data/test/test/functional/people_controller_test.rb +34 -0
  160. data/test/test/functional/photos_controller_test.rb +128 -0
  161. data/test/test/functional/posts_controller_test.rb +34 -0
  162. data/test/test/functional/projects_controller_test.rb +18 -0
  163. data/test/test/functional/somethings_controller_test.rb +28 -0
  164. data/test/test/functional/tags_controller_test.rb +64 -0
  165. data/test/test/functional/users_controller_test.rb +24 -0
  166. data/test/test/test_helper.rb +12 -0
  167. data/test/test/unit/accessors_test.rb +91 -0
  168. data/test/test/unit/account_test.rb +7 -0
  169. data/test/test/unit/action_options_test.rb +66 -0
  170. data/test/test/unit/base_test.rb +11 -0
  171. data/test/test/unit/comment_test.rb +10 -0
  172. data/test/test/unit/failable_action_options_test.rb +50 -0
  173. data/test/test/unit/helpers/current_objects_test.rb +127 -0
  174. data/test/test/unit/helpers/internal_test.rb +88 -0
  175. data/test/test/unit/helpers/nested_test.rb +82 -0
  176. data/test/test/unit/helpers/urls_test.rb +71 -0
  177. data/test/test/unit/helpers_test.rb +25 -0
  178. data/test/test/unit/option_test.rb +10 -0
  179. data/test/test/unit/photo_test.rb +10 -0
  180. data/test/test/unit/post_test.rb +10 -0
  181. data/test/test/unit/project_test.rb +10 -0
  182. data/test/test/unit/response_collector_test.rb +31 -0
  183. data/test/test/unit/something_test.rb +10 -0
  184. data/test/test/unit/tag_test.rb +10 -0
  185. data/test/test/unit/urligence_test.rb +203 -0
  186. data/test/vendor/plugins/shoulda/README +123 -0
  187. data/test/vendor/plugins/shoulda/Rakefile +29 -0
  188. data/test/vendor/plugins/shoulda/bin/convert_to_should_syntax +40 -0
  189. data/test/vendor/plugins/shoulda/init.rb +3 -0
  190. data/test/vendor/plugins/shoulda/lib/shoulda.rb +47 -0
  191. data/test/vendor/plugins/shoulda/lib/shoulda/active_record_helpers.rb +338 -0
  192. data/test/vendor/plugins/shoulda/lib/shoulda/color.rb +77 -0
  193. data/test/vendor/plugins/shoulda/lib/shoulda/context.rb +143 -0
  194. data/test/vendor/plugins/shoulda/lib/shoulda/controller_tests/controller_tests.rb +470 -0
  195. data/test/vendor/plugins/shoulda/lib/shoulda/controller_tests/formats/html.rb +192 -0
  196. data/test/vendor/plugins/shoulda/lib/shoulda/controller_tests/formats/xml.rb +162 -0
  197. data/test/vendor/plugins/shoulda/lib/shoulda/general.rb +119 -0
  198. data/test/vendor/plugins/shoulda/lib/shoulda/private_helpers.rb +17 -0
  199. data/test/vendor/plugins/shoulda/tasks/list_tests.rake +40 -0
  200. data/uninstall.rb +1 -0
  201. metadata +410 -0
data/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2008 James Golick
2
+
3
+ Permission is hereby granted, free of charge, to any person
4
+ obtaining a copy of this software and associated documentation
5
+ files (the "Software"), to deal in the Software without
6
+ restriction, including without limitation the rights to use,
7
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ copies of the Software, and to permit persons to whom the
9
+ Software is furnished to do so, subject to the following
10
+ conditions:
11
+
12
+ The above copyright notice and this permission notice shall be
13
+ included in all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22
+ OTHER DEALINGS IN THE SOFTWARE.
data/README ADDED
@@ -0,0 +1,276 @@
1
+ = Resource Controller
2
+
3
+ resource_controller makes RESTful controllers easier, more maintainable, and super readable. With the RESTful controller pattern hidden away, you can focus on what makes your controller special.
4
+
5
+ == Get It
6
+
7
+ svn export http://svn.jamesgolick.com/resource_controller/tags/stable vendor/plugins/resource_controller
8
+
9
+ SVN (stable): {http://svn.jamesgolick.com/resource_controller/tags/stable}[http://svn.jamesgolick.com/resource_controller/tags/stable]
10
+
11
+ SVN (ongoing): {http://svn.jamesgolick.com/resource_controller/trunk}[http://svn.jamesgolick.com/resource_controller/trunk]
12
+
13
+ = Usage
14
+
15
+ Creating a basic RESTful controller is as easy as...
16
+
17
+ class PostsController < ResourceController::Base
18
+ end
19
+
20
+ ...or if you prefer, you can use the method-call syntax. If you need to inherit from some other class, this syntax is definitely for you:
21
+
22
+ class PostsController < ApplicationController
23
+ resource_controller
24
+ end
25
+
26
+ Both syntaxes are identical in their behavior. Just make sure you call resource_controller before you use any other r_c functionality in your controller.
27
+
28
+
29
+ Nobody just uses the default RESTful controller, though. resource_controller provides a simple API for customizations.
30
+
31
+ == Action Lifecycle
32
+
33
+ It's really easy to make changes to the lifecycle of your actions.
34
+
35
+ Note: We had to call the new accessor "new_action", since new is somewhat reserved in ruby.
36
+
37
+ === Before and After
38
+
39
+ class ProjectsController < ResourceController::Base
40
+
41
+ new_action.before do
42
+ 3.times { object.tasks.build }
43
+ end
44
+
45
+ create.after do
46
+ object.creator = current_user
47
+ end
48
+
49
+ end
50
+
51
+ === Flash
52
+
53
+ class ProjectsController < ResourceController::Base
54
+ create.flash "Can you believe how easy it is to use resource_controller? Neither could I!"
55
+ end
56
+
57
+ === respond_to
58
+
59
+ You can add to what's already there...
60
+
61
+ class ProjectsController < ResourceController::Base
62
+ create.wants.js { render :template => "show.rjs" }
63
+ end
64
+
65
+ Or you can create a whole new block. This syntax destroys everything that's there, and starts again...
66
+
67
+ class ProjectsController < ResourceController::Base
68
+ create.response do |wants|
69
+ wants.html
70
+ wants.js { render :template => "show.rjs" }
71
+ end
72
+ end
73
+
74
+ === Scoping
75
+
76
+ Because sometimes you want to make a bunch of customizations at once, most of the helpers accept blocks that make grouping calls really easy. Is it a DSL? Maybe; maybe not. But, it's definitely awesome.
77
+
78
+ With actions that can fail, the scoping defaults to success. That means that create.flash == create.success.flash.
79
+
80
+ class ProjectsController < ResourceController::Base
81
+
82
+ create do
83
+ flash "Object successfully created!"
84
+ wants.js { render :template => "show.rjs" }
85
+
86
+ failure.wants.js { render :template => "display_errors.rjs" }
87
+ end
88
+
89
+ destroy do
90
+ flash "You destroyed your project. Good work."
91
+
92
+ failure do
93
+ flash "You cannot destroy that project. Stop trying!"
94
+ wants.js { render :template => "display_errors.rjs" }
95
+ end
96
+ end
97
+
98
+ end
99
+
100
+ == Helpers (ResourceController::Helpers)
101
+
102
+ === Loading objects
103
+
104
+ You want to add something like pagination to your controller...
105
+
106
+ class PostsController < ResourceController::Base
107
+ private
108
+ def collection
109
+ @collection ||= end_of_association_chain.find(:all, :page => {:size => 10, :current => params[:page]})
110
+ end
111
+ end
112
+
113
+ Or maybe you used a permalink...
114
+
115
+ class PostsController < ResourceController::Base
116
+ private
117
+ def object
118
+ @object ||= end_of_association_chain.find_by_permalink(param)
119
+ end
120
+ end
121
+
122
+ === Building objects
123
+
124
+ Maybe you have some alternative way of building objects...
125
+
126
+ class PostsController < ResourceController::Base
127
+ private
128
+ def build_object
129
+ @object ||= end_of_association_chain.build_my_object_some_funky_way object_params
130
+ end
131
+ end
132
+
133
+ ...and there are tons more helpers in the ResourceController::Helpers
134
+
135
+ == Nested Resources
136
+
137
+ Nested controllers can be a pain, especially if routing is such that you may or may not have a parent. Not so with Resource Controller.
138
+
139
+ class CommentsController < ResourceController::Base
140
+ belongs_to :post
141
+ end
142
+
143
+ All of the finding, and creation, and everything will be done at the scope of the post automatically.
144
+
145
+ == Namespaced Resources
146
+
147
+ ...are handled automatically, and any namespaces are always available, symbolized, in array form @ ResourceController::Helpers#namespaces
148
+
149
+ == Polymorphic Resources
150
+
151
+ Everything, including url generation is handled completely automatically. Take this example...
152
+
153
+ ## comment.rb
154
+ class Comment
155
+ belongs_to :commentable, :polymorphic => true
156
+ end
157
+
158
+ ## comments_controller.rb
159
+ class CommentsController < ResourceController::Base
160
+ belongs_to :post, :product, :user
161
+ end
162
+ *Note:* Your model doesn't have to be polymorphic in the ActiveRecord sense. It can be associated in whichever way you want.
163
+
164
+ ## routes.rb
165
+ map.resources :posts, :has_many => :comments
166
+ map.resources :products, :has_many => :comments
167
+ map.resources :users, :has_many => :comments
168
+
169
+ All you have to do is that, and r_c will infer whichever relationship is present, and perform all the actions at the scope of the parent object.
170
+
171
+ === Parent Helpers
172
+
173
+ You also get some helpers for reflecting on your parent.
174
+
175
+ parent? # => true/false is there a parent present?
176
+ parent_type # => :post
177
+ parent_model # => Post
178
+ parent_object # => @post
179
+
180
+ === Non-standard resource names
181
+
182
+ resource_controller supports overrides for every non-standard configuration of resources.
183
+
184
+ The most common example is where the resource has a different name than the associated model. Simply overriding the model_name helper will get resource_controller working with your model.
185
+
186
+ map.resources :tags
187
+ ...
188
+ class PhotoTag < ActiveRecord::Base
189
+ ...
190
+ class TagsController < ResourceController::Base
191
+ private
192
+ def model_name
193
+ 'photo_tag'
194
+ end
195
+ end
196
+
197
+ In the above example, the variable, and params will be set to @tag, @tags, and params[:tag]. If you'd like to change that, override object_name.
198
+
199
+ def object_name
200
+ 'photo_tag'
201
+ end
202
+
203
+ If you're using a non-standard controller name, but everything else is standard, overriding resource_name will propagate through all of the other helpers.
204
+
205
+ map.resources :tags, :controller => "somethings"
206
+ ...
207
+ class Tag < ActiveRecord::Base
208
+ ...
209
+ class SomethingsController < ResourceController::Base
210
+ private
211
+ def resource_name
212
+ 'tag'
213
+ end
214
+ end
215
+
216
+ Finally, the route_name helper is used by Urligence to determine which url helper to call, so if you have non-standard route names, override it.
217
+
218
+ map.resources :tags, :controller => "taggings"
219
+ ...
220
+ class Taggings < ActiveRecord::Base
221
+ ...
222
+ class TaggingsController < ResourceController::Base
223
+ private
224
+ def route_name
225
+ 'tag'
226
+ end
227
+ end
228
+
229
+ == Url Helpers
230
+
231
+ Thanks to Urligence, you also get some free url helpers.
232
+
233
+ No matter what your controller looks like...
234
+
235
+ [edit_|new_]object_url # is the equivalent of saying [edit_|new_]post_url(@post)
236
+ [edit_|new_]object_url(some_other_object) # allows you to specify an object, but still maintain any paths or namespaces that are present
237
+
238
+ collection_url # is like saying posts_url
239
+
240
+ Url helpers are especially useful when working with polymorphic controllers.
241
+
242
+ # /posts/1/comments
243
+ object_url # => /posts/1/comments/#{@comment.to_param}
244
+ object_url(comment) # => /posts/1/comments/#{comment.to_param}
245
+ edit_object_url # => /posts/1/comments/#{@comment.to_param}/edit
246
+ collection_url # => /posts/1/comments
247
+
248
+ # /products/1/comments
249
+ object_url # => /products/1/comments/#{@comment.to_param}
250
+ object_url(comment) # => /products/1/comments/#{comment.to_param}
251
+ edit_object_url # => /products/1/comments/#{@comment.to_param}/edit
252
+ collection_url # => /products/1/comments
253
+
254
+ # /comments
255
+ object_url # => /comments/#{@comment.to_param}
256
+ object_url(comment) # => /comments/#{comment.to_param}
257
+ edit_object_url # => /comments/#{@comment.to_param}/edit
258
+ collection_url # => /comments
259
+
260
+ Or with namespaced, nested controllers...
261
+
262
+ # /admin/products/1/options
263
+ object_url # => /admin/products/1/options/#{@option.to_param}
264
+ object_url(option) # => /admin/products/1/options/#{option.to_param}
265
+ edit_object_url # => /admin/products/1/options/#{@option.to_param}/edit
266
+ collection_url # => /admin/products/1/options
267
+
268
+ You get the idea. Everything is automagical! All parameters are inferred.
269
+
270
+ == Credits
271
+
272
+ resource_controller was created, and is maintained by {James Golick}[http://jamesgolick.com].
273
+
274
+ == License
275
+
276
+ resource_controller is available under the {MIT License}[http://en.wikipedia.org/wiki/MIT_License]
@@ -0,0 +1,55 @@
1
+ require 'rake'
2
+ require 'rake/testtask'
3
+ require 'rake/rdoctask'
4
+
5
+ desc 'Default: run unit tests.'
6
+ task :default => :test
7
+
8
+ desc 'Test the ResourceController plugin.'
9
+ Rake::TestTask.new(:test) do |t|
10
+ t.libs << 'lib'
11
+ t.pattern = 'test/test/**/*_test.rb'
12
+ t.verbose = true
13
+ end
14
+
15
+ desc 'Generate documentation for the ResourceController plugin.'
16
+ Rake::RDocTask.new(:rdoc) do |rdoc|
17
+ rdoc.rdoc_dir = 'rdoc'
18
+ rdoc.title = 'ResourceController'
19
+ rdoc.options << '--line-numbers' << '--inline-source'
20
+ rdoc.rdoc_files.include('README')
21
+ rdoc.rdoc_files.include('lib/**/*.rb')
22
+ end
23
+
24
+ desc "Do all necessary tagging for a release"
25
+ task :release => [:tag_release, :upload_docs]
26
+
27
+ task :tag_release do
28
+ unless ENV.include?('human') && ENV.include?('tag')
29
+ raise "Usage: rake release human=0.something tag=rel_2.0"
30
+ end
31
+
32
+ tag_name = ENV['tag']
33
+ human_name = ENV['human']
34
+ repo_root = "http://svn.jamesgolick.com/resource_controller"
35
+
36
+ puts "tagging #{human_name}"
37
+ `svn copy #{repo_root}/trunk #{repo_root}/tags/#{tag_name} -m"tagging #{human_name}"`
38
+
39
+ puts "deleting previous stable tags"
40
+ `svn rm #{repo_root}/tags/stable -m"deleting previous stable tags"`
41
+
42
+ puts "tag stable release"
43
+ `svn copy #{repo_root}/tags/#{tag_name} #{repo_root}/tags/stable -m"tag stable release"`
44
+ end
45
+
46
+ task :upload_docs => :rdoc do
47
+ puts 'Deleting previous rdoc'
48
+ `ssh jamesgolick.com 'rm -Rf /home/apps/jamesgolick.com/public/resource_controller/rdoc'`
49
+
50
+ puts "Uploading current rdoc"
51
+ `scp -r rdoc jamesgolick.com:/home/apps/jamesgolick.com/public/resource_controller`
52
+
53
+ puts "Deleting rdoc"
54
+ `rm -Rf rdoc`
55
+ end
data/TODO ADDED
@@ -0,0 +1 @@
1
+ Add helper methods for deep_nesting.
@@ -0,0 +1,29 @@
1
+ Description:
2
+ The scaffold resource generator creates a model, a controller, and a set of templates that's ready to use as the
3
+ starting point for your REST-like, resource-oriented application. This basically means that it follows a set of
4
+ conventions to exploit the full set of HTTP verbs (GET/POST/PUT/DELETE) and is prepared for multi-client access
5
+ (like one view for HTML, one for an XML API, one for ATOM, etc). Everything comes with sample unit and functional
6
+ tests as well.
7
+
8
+ The generator takes the name of the model as its first argument. This model name is then pluralized to get the
9
+ controller name. So "scaffold_resource post" will generate a Post model and a PostsController and will be intended
10
+ for URLs like /posts and /posts/45.
11
+
12
+ As additional parameters, the generator will take attribute pairs described by name and type. These attributes will
13
+ be used to prepopulate the migration to create the table for the model and to give you a set of templates for the
14
+ view. For example, "scaffold_resource post title:string created_on:date body:text published:boolean" will give
15
+ you a model with those four attributes, forms to create and edit those models from, and an index that'll list them
16
+ all.
17
+
18
+ You don't have to think up all attributes up front, but it's a good idea of adding just the baseline of what's
19
+ needed to start really working with the resource.
20
+
21
+ Once the generator has run, you'll need to add a declaration to your config/routes.rb file to hook up the rules
22
+ that'll point URLs to this new resource. If you create a resource like "scaffold_resource post", you'll need to
23
+ add "map.resources :posts" (notice the plural form) in the routes file. Then your new resource is accessible from
24
+ /posts.
25
+
26
+ Examples:
27
+ ./script/generate scaffold_resource post # no attributes, view will be anemic
28
+ ./script/generate scaffold_resource post title:string created_on:date body:text published:boolean
29
+ ./script/generate scaffold_resource purchase order_id:integer created_at:datetime amount:decimal
@@ -0,0 +1,101 @@
1
+ class ScaffoldResourceGenerator < Rails::Generator::NamedBase
2
+ attr_reader :controller_name,
3
+ :controller_class_path,
4
+ :controller_file_path,
5
+ :controller_class_nesting,
6
+ :controller_class_nesting_depth,
7
+ :controller_class_name,
8
+ :controller_singular_name,
9
+ :controller_plural_name
10
+ alias_method :controller_file_name, :controller_singular_name
11
+ alias_method :controller_table_name, :controller_plural_name
12
+
13
+ def initialize(runtime_args, runtime_options = {})
14
+ super
15
+
16
+ @controller_name = @name.pluralize
17
+
18
+ base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
19
+ @controller_class_name_without_nesting, @controller_singular_name, @controller_plural_name = inflect_names(base_name)
20
+
21
+ if @controller_class_nesting.empty?
22
+ @controller_class_name = @controller_class_name_without_nesting
23
+ else
24
+ @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
25
+ end
26
+ end
27
+
28
+ def manifest
29
+ record do |m|
30
+ # Check for class naming collisions.
31
+ m.class_collisions(controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}Helper")
32
+ m.class_collisions(class_path, "#{class_name}")
33
+
34
+ # Controller, helper, views, and test directories.
35
+ m.directory(File.join('app/models', class_path))
36
+ m.directory(File.join('app/controllers', controller_class_path))
37
+ m.directory(File.join('app/helpers', controller_class_path))
38
+ m.directory(File.join('app/views', controller_class_path, controller_file_name))
39
+ m.directory(File.join('test/functional', controller_class_path))
40
+ m.directory(File.join('test/unit', class_path))
41
+
42
+ generator_template_ext = (defined? Haml )? "haml" : "erb"
43
+
44
+ # we want to call erb templates .rhtml or .haml if this is rails 1
45
+ if RAILS_GEM_VERSION.to_i == 1
46
+ template_ext = generator_template_ext == 'erb' ? 'rhtml' : generator_template_ext
47
+ else
48
+ template_ext = "html.#{generator_template_ext}"
49
+ end
50
+
51
+ scaffold_views.each do |action|
52
+ m.template(
53
+ "view_#{action}.#{generator_template_ext}",
54
+ File.join('app/views', controller_class_path, controller_file_name, "#{action}.#{template_ext}")
55
+ )
56
+ end
57
+
58
+ m.template('model.rb', File.join('app/models', class_path, "#{file_name}.rb"))
59
+
60
+ m.template(
61
+ 'controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb")
62
+ )
63
+
64
+ functional_test = (defined? ThoughtBot::Shoulda) ? "shoulda_functional_test.rb" : "functional_test.rb"
65
+
66
+ m.template("#{functional_test}", File.join('test/functional', controller_class_path, "#{controller_file_name}_controller_test.rb"))
67
+ m.template('helper.rb', File.join('app/helpers', controller_class_path, "#{controller_file_name}_helper.rb"))
68
+ m.template('unit_test.rb', File.join('test/unit', class_path, "#{file_name}_test.rb"))
69
+ m.template('fixtures.yml', File.join('test/fixtures', "#{table_name}.yml"))
70
+
71
+ unless options[:skip_migration]
72
+ migration_template = RAILS_GEM_VERSION.to_i == 1 ? 'old_migration.rb' : 'migration.rb'
73
+
74
+ m.migration_template(
75
+ migration_template, 'db/migrate',
76
+ :assigns => {
77
+ :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}",
78
+ :attributes => attributes
79
+ },
80
+ :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
81
+ )
82
+ end
83
+
84
+ m.route_resources controller_file_name
85
+ end
86
+ end
87
+
88
+ protected
89
+ # Override with your own usage banner.
90
+ def banner
91
+ "Usage: #{$0} scaffold_resource ModelName [field:type, field:type]"
92
+ end
93
+
94
+ def scaffold_views
95
+ %w[ index show new edit _form ]
96
+ end
97
+
98
+ def model_name
99
+ class_name.demodulize
100
+ end
101
+ end