radiant 0.8.0 → 0.8.1

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of radiant might be problematic. Click here for more details.

Files changed (513) hide show
  1. data/CHANGELOG +33 -1
  2. data/CONTRIBUTORS +15 -2
  3. data/INSTALL +9 -7
  4. data/README +11 -7
  5. data/app/controllers/admin/layouts_controller.rb +5 -2
  6. data/app/controllers/admin/pages_controller.rb +8 -5
  7. data/app/controllers/admin/snippets_controller.rb +5 -2
  8. data/app/controllers/application_controller.rb +7 -0
  9. data/app/helpers/admin/node_helper.rb +2 -2
  10. data/app/helpers/application_helper.rb +2 -2
  11. data/app/models/radiant/config.rb +36 -4
  12. data/app/models/standard_tags.rb +1 -1
  13. data/app/views/admin/layouts/index.html.haml +15 -12
  14. data/app/views/admin/page_parts/_page_part.html.haml +2 -2
  15. data/app/views/admin/pages/index.html.haml +1 -1
  16. data/app/views/admin/snippets/_form.html.haml +1 -1
  17. data/app/views/admin/snippets/index.html.haml +14 -10
  18. data/config/database.db2.yml +20 -0
  19. data/config/environment.rb +4 -4
  20. data/config/environments/test.rb +1 -2
  21. data/features/support/env.rb +2 -1
  22. data/lib/generators/extension/extension_generator.rb +5 -0
  23. data/lib/generators/extension/templates/RSpecRakefile +11 -8
  24. data/lib/generators/extension/templates/cucumber.yml +1 -0
  25. data/lib/generators/extension/templates/cucumber_env.rb +16 -0
  26. data/lib/generators/extension/templates/cucumber_paths.rb +14 -0
  27. data/lib/generators/extension/templates/extension.rb +1 -1
  28. data/lib/generators/instance/instance_generator.rb +1 -1
  29. data/lib/generators/instance/templates/databases/db2.yml +40 -0
  30. data/lib/generators/instance/templates/instance_environment.rb +6 -6
  31. data/lib/local_time.rb +3 -9
  32. data/lib/radiant.rb +1 -1
  33. data/lib/radiant/cache.rb +10 -8
  34. data/lib/radiant/extension.rb +36 -0
  35. data/lib/radiant/extension/script.rb +1 -1
  36. data/lib/radiant/extension_loader.rb +5 -1
  37. data/lib/radiant/initializer.rb +52 -4
  38. data/lib/task_support.rb +33 -0
  39. data/lib/tasks/cucumber.rake +5 -1
  40. data/lib/tasks/radiant_config.rake +18 -0
  41. data/lib/tasks/release.rake +1 -0
  42. data/public/javascripts/admin/admin.js +1 -1
  43. data/spec/controllers/admin/layouts_controller_spec.rb +18 -12
  44. data/spec/controllers/admin/pages_controller_spec.rb +35 -29
  45. data/spec/controllers/admin/snippets_controller_spec.rb +11 -5
  46. data/spec/controllers/admin/welcome_controller_spec.rb +1 -1
  47. data/spec/controllers/application_controller_spec.rb +18 -0
  48. data/spec/fixtures/radiant_config.yml +10 -0
  49. data/spec/generators/extension_generator_spec.rb +12 -0
  50. data/spec/helpers/admin/node_helper_spec.rb +6 -0
  51. data/spec/helpers/application_helper_spec.rb +1 -1
  52. data/spec/lib/radiant/extension_loader_spec.rb +17 -0
  53. data/spec/lib/radiant/extension_spec.rb +28 -0
  54. data/spec/lib/radiant/initializer_spec.rb +34 -0
  55. data/spec/lib/task_support_spec.rb +42 -0
  56. data/spec/models/page_spec.rb +6 -2
  57. data/spec/models/radiant/config_spec.rb +42 -1
  58. data/spec/models/standard_tags_spec.rb +2 -2
  59. data/test/fixtures/extensions/01_basic/app/metal/basic_metal.rb +9 -0
  60. data/test/fixtures/extensions/02_overriding/app/metal/basic_metal.rb +9 -0
  61. data/vendor/extensions/textile_filter/textile.html +2 -2
  62. data/vendor/plugins/dataset/CHANGELOG +2 -1
  63. data/vendor/plugins/dataset/Rakefile +3 -0
  64. data/vendor/plugins/dataset/VERSION.yml +2 -2
  65. data/vendor/plugins/dataset/dataset.gemspec +9 -3
  66. data/vendor/plugins/dataset/lib/dataset.rb +3 -0
  67. data/vendor/radius/lib/radius.rb +5 -0
  68. data/vendor/radius/test/radius_test.rb +6 -0
  69. data/vendor/rails/actionmailer/CHANGELOG +8 -0
  70. data/vendor/rails/actionmailer/Rakefile +3 -2
  71. data/vendor/rails/actionmailer/lib/action_mailer/base.rb +2 -1
  72. data/vendor/rails/actionmailer/lib/action_mailer/version.rb +1 -1
  73. data/vendor/rails/actionmailer/test/abstract_unit.rb +0 -3
  74. data/vendor/rails/actionmailer/test/mail_service_test.rb +3 -2
  75. data/vendor/rails/actionpack/CHANGELOG +16 -0
  76. data/vendor/rails/actionpack/Rakefile +5 -3
  77. data/vendor/rails/actionpack/lib/action_controller.rb +2 -7
  78. data/vendor/rails/actionpack/lib/action_controller/assertions/response_assertions.rb +13 -3
  79. data/vendor/rails/actionpack/lib/action_controller/base.rb +12 -3
  80. data/vendor/rails/actionpack/lib/action_controller/caching.rb +1 -1
  81. data/vendor/rails/actionpack/lib/action_controller/caching/actions.rb +9 -1
  82. data/vendor/rails/actionpack/lib/action_controller/caching/sweeper.rb +45 -0
  83. data/vendor/rails/actionpack/lib/action_controller/caching/sweeping.rb +0 -42
  84. data/vendor/rails/actionpack/lib/action_controller/cookies.rb +1 -1
  85. data/vendor/rails/actionpack/lib/action_controller/dispatcher.rb +21 -6
  86. data/vendor/rails/actionpack/lib/action_controller/failsafe.rb +40 -6
  87. data/vendor/rails/actionpack/lib/action_controller/flash.rb +11 -3
  88. data/vendor/rails/actionpack/lib/action_controller/http_authentication.rb +7 -3
  89. data/vendor/rails/actionpack/lib/action_controller/integration.rb +5 -12
  90. data/vendor/rails/actionpack/lib/action_controller/middlewares.rb +0 -1
  91. data/vendor/rails/actionpack/lib/action_controller/params_parser.rb +6 -0
  92. data/vendor/rails/actionpack/lib/action_controller/reloader.rb +47 -7
  93. data/vendor/rails/actionpack/lib/action_controller/request.rb +6 -2
  94. data/vendor/rails/actionpack/lib/action_controller/request_forgery_protection.rb +2 -1
  95. data/vendor/rails/actionpack/lib/action_controller/resources.rb +17 -13
  96. data/vendor/rails/actionpack/lib/action_controller/response.rb +8 -2
  97. data/vendor/rails/actionpack/lib/action_controller/routing.rb +3 -0
  98. data/vendor/rails/actionpack/lib/action_controller/routing/route_set.rb +20 -6
  99. data/vendor/rails/actionpack/lib/action_controller/streaming.rb +4 -2
  100. data/vendor/rails/actionpack/lib/action_controller/test_process.rb +9 -1
  101. data/vendor/rails/actionpack/lib/action_controller/url_rewriter.rb +1 -1
  102. data/vendor/rails/actionpack/lib/action_pack/version.rb +1 -1
  103. data/vendor/rails/actionpack/lib/action_view/helpers.rb +1 -1
  104. data/vendor/rails/actionpack/lib/action_view/helpers/asset_tag_helper.rb +21 -9
  105. data/vendor/rails/actionpack/lib/action_view/helpers/atom_feed_helper.rb +1 -1
  106. data/vendor/rails/actionpack/lib/action_view/helpers/date_helper.rb +2 -2
  107. data/vendor/rails/actionpack/lib/action_view/helpers/form_helper.rb +26 -12
  108. data/vendor/rails/actionpack/lib/action_view/helpers/form_options_helper.rb +71 -1
  109. data/vendor/rails/actionpack/lib/action_view/helpers/form_tag_helper.rb +10 -4
  110. data/vendor/rails/actionpack/lib/action_view/helpers/number_helper.rb +1 -1
  111. data/vendor/rails/actionpack/lib/action_view/helpers/prototype_helper.rb +7 -7
  112. data/vendor/rails/actionpack/lib/action_view/helpers/scriptaculous_helper.rb +5 -5
  113. data/vendor/rails/actionpack/lib/action_view/helpers/tag_helper.rb +1 -1
  114. data/vendor/rails/actionpack/lib/action_view/helpers/text_helper.rb +23 -14
  115. data/vendor/rails/actionpack/lib/action_view/helpers/url_helper.rb +2 -2
  116. data/vendor/rails/actionpack/lib/action_view/locale/en.yml +4 -0
  117. data/vendor/rails/actionpack/lib/action_view/paths.rb +1 -1
  118. data/vendor/rails/actionpack/lib/action_view/template.rb +22 -33
  119. data/vendor/rails/actionpack/test/abstract_unit.rb +17 -1
  120. data/vendor/rails/actionpack/test/activerecord/active_record_store_test.rb +3 -3
  121. data/vendor/rails/actionpack/test/controller/action_pack_assertions_test.rb +27 -0
  122. data/vendor/rails/actionpack/test/controller/caching_test.rb +40 -1
  123. data/vendor/rails/actionpack/test/controller/cookie_test.rb +16 -0
  124. data/vendor/rails/actionpack/test/controller/dispatcher_test.rb +59 -18
  125. data/vendor/rails/actionpack/test/controller/failsafe_test.rb +60 -0
  126. data/vendor/rails/actionpack/test/controller/filter_params_test.rb +3 -1
  127. data/vendor/rails/actionpack/test/controller/flash_test.rb +6 -1
  128. data/vendor/rails/actionpack/test/controller/http_basic_authentication_test.rb +25 -0
  129. data/vendor/rails/actionpack/test/controller/http_digest_authentication_test.rb +63 -9
  130. data/vendor/rails/actionpack/test/controller/integration_test.rb +31 -3
  131. data/vendor/rails/actionpack/test/controller/rack_test.rb +18 -1
  132. data/vendor/rails/actionpack/test/controller/redirect_test.rb +4 -1
  133. data/vendor/rails/actionpack/test/controller/reloader_test.rb +124 -0
  134. data/vendor/rails/actionpack/test/controller/render_test.rb +19 -9
  135. data/vendor/rails/actionpack/test/controller/request/json_params_parsing_test.rb +24 -4
  136. data/vendor/rails/actionpack/test/controller/request/multipart_params_parsing_test.rb +1 -62
  137. data/vendor/rails/actionpack/test/controller/request/test_request_test.rb +35 -0
  138. data/vendor/rails/actionpack/test/controller/request/url_encoded_params_parsing_test.rb +0 -38
  139. data/vendor/rails/actionpack/test/controller/request/xml_params_parsing_test.rb +15 -0
  140. data/vendor/rails/actionpack/test/controller/request_forgery_protection_test.rb +6 -5
  141. data/vendor/rails/actionpack/test/controller/request_test.rb +218 -230
  142. data/vendor/rails/actionpack/test/controller/resources_test.rb +52 -0
  143. data/vendor/rails/actionpack/test/controller/routing_test.rb +28 -2
  144. data/vendor/rails/actionpack/test/controller/send_file_test.rb +12 -2
  145. data/vendor/rails/actionpack/test/controller/session/cookie_store_test.rb +9 -32
  146. data/vendor/rails/actionpack/test/controller/test_test.rb +8 -0
  147. data/vendor/rails/actionpack/test/controller/url_rewriter_test.rb +29 -3
  148. data/vendor/rails/actionpack/test/fixtures/failsafe/500.html +1 -0
  149. data/vendor/rails/actionpack/test/fixtures/public/absolute/test.css +23 -0
  150. data/vendor/rails/actionpack/test/fixtures/public/absolute/test.js +63 -0
  151. data/vendor/rails/actionpack/test/template/active_record_helper_test.rb +1 -1
  152. data/vendor/rails/actionpack/test/template/asset_tag_helper_test.rb +46 -0
  153. data/vendor/rails/actionpack/test/template/atom_feed_helper_test.rb +29 -0
  154. data/vendor/rails/actionpack/test/template/form_helper_test.rb +143 -6
  155. data/vendor/rails/actionpack/test/template/form_options_helper_i18n_test.rb +27 -0
  156. data/vendor/rails/actionpack/test/template/form_options_helper_test.rb +56 -0
  157. data/vendor/rails/actionpack/test/template/form_tag_helper_test.rb +23 -6
  158. data/vendor/rails/actionpack/test/template/prototype_helper_test.rb +11 -11
  159. data/vendor/rails/actionpack/test/template/template_test.rb +32 -0
  160. data/vendor/rails/actionpack/test/template/text_helper_test.rb +23 -0
  161. data/vendor/rails/actionpack/test/template/url_helper_test.rb +8 -0
  162. data/vendor/rails/activerecord/CHANGELOG +18 -0
  163. data/vendor/rails/activerecord/Rakefile +26 -9
  164. data/vendor/rails/activerecord/examples/performance.rb +162 -0
  165. data/vendor/rails/activerecord/lib/active_record/associations.rb +104 -35
  166. data/vendor/rails/activerecord/lib/active_record/associations/association_collection.rb +10 -5
  167. data/vendor/rails/activerecord/lib/active_record/associations/association_proxy.rb +2 -2
  168. data/vendor/rails/activerecord/lib/active_record/associations/belongs_to_association.rb +22 -4
  169. data/vendor/rails/activerecord/lib/active_record/associations/belongs_to_polymorphic_association.rb +5 -1
  170. data/vendor/rails/activerecord/lib/active_record/associations/has_and_belongs_to_many_association.rb +16 -0
  171. data/vendor/rails/activerecord/lib/active_record/associations/has_many_association.rb +1 -0
  172. data/vendor/rails/activerecord/lib/active_record/associations/has_many_through_association.rb +13 -3
  173. data/vendor/rails/activerecord/lib/active_record/associations/has_one_through_association.rb +15 -9
  174. data/vendor/rails/activerecord/lib/active_record/autosave_association.rb +15 -9
  175. data/vendor/rails/activerecord/lib/active_record/base.rb +34 -31
  176. data/vendor/rails/activerecord/lib/active_record/batches.rb +23 -15
  177. data/vendor/rails/activerecord/lib/active_record/calculations.rb +7 -13
  178. data/vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_definitions.rb +16 -2
  179. data/vendor/rails/activerecord/lib/active_record/connection_adapters/abstract/schema_statements.rb +2 -2
  180. data/vendor/rails/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb +7 -0
  181. data/vendor/rails/activerecord/lib/active_record/connection_adapters/mysql_adapter.rb +17 -8
  182. data/vendor/rails/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb +98 -35
  183. data/vendor/rails/activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb +15 -0
  184. data/vendor/rails/activerecord/lib/active_record/dirty.rb +1 -1
  185. data/vendor/rails/activerecord/lib/active_record/fixtures.rb +14 -11
  186. data/vendor/rails/activerecord/lib/active_record/i18n_interpolation_deprecation.rb +1 -1
  187. data/vendor/rails/activerecord/lib/active_record/locale/en.yml +4 -0
  188. data/vendor/rails/activerecord/lib/active_record/named_scope.rb +3 -8
  189. data/vendor/rails/activerecord/lib/active_record/reflection.rb +1 -1
  190. data/vendor/rails/activerecord/lib/active_record/schema_dumper.rb +6 -3
  191. data/vendor/rails/activerecord/lib/active_record/serialization.rb +3 -2
  192. data/vendor/rails/activerecord/lib/active_record/serializers/json_serializer.rb +10 -18
  193. data/vendor/rails/activerecord/lib/active_record/serializers/xml_serializer.rb +6 -2
  194. data/vendor/rails/activerecord/lib/active_record/session_store.rb +9 -1
  195. data/vendor/rails/activerecord/lib/active_record/timestamp.rb +39 -9
  196. data/vendor/rails/activerecord/lib/active_record/validations.rb +149 -80
  197. data/vendor/rails/activerecord/lib/active_record/version.rb +1 -1
  198. data/vendor/rails/activerecord/test/cases/adapter_test.rb +12 -0
  199. data/vendor/rails/activerecord/test/cases/associations/belongs_to_associations_test.rb +102 -22
  200. data/vendor/rails/activerecord/test/cases/associations/eager_load_nested_include_test.rb +5 -5
  201. data/vendor/rails/activerecord/test/cases/associations/eager_test.rb +12 -0
  202. data/vendor/rails/activerecord/test/cases/associations/habtm_join_table_test.rb +56 -0
  203. data/vendor/rails/activerecord/test/cases/associations/has_many_associations_test.rb +62 -2
  204. data/vendor/rails/activerecord/test/cases/associations/has_many_through_associations_test.rb +46 -1
  205. data/vendor/rails/activerecord/test/cases/associations/has_one_through_associations_test.rb +18 -1
  206. data/vendor/rails/activerecord/test/cases/associations/inner_join_association_test.rb +5 -0
  207. data/vendor/rails/activerecord/test/cases/associations/join_model_test.rb +4 -4
  208. data/vendor/rails/activerecord/test/cases/autosave_association_test.rb +22 -0
  209. data/vendor/rails/activerecord/test/cases/base_test.rb +51 -6
  210. data/vendor/rails/activerecord/test/cases/calculations_test.rb +14 -14
  211. data/vendor/rails/activerecord/test/cases/column_definition_test.rb +34 -0
  212. data/vendor/rails/activerecord/test/cases/copy_table_test_sqlite.rb +5 -5
  213. data/vendor/rails/activerecord/test/cases/dirty_test.rb +10 -0
  214. data/vendor/rails/activerecord/test/cases/finder_test.rb +21 -50
  215. data/vendor/rails/activerecord/test/cases/fixtures_test.rb +6 -1
  216. data/vendor/rails/activerecord/test/cases/helper.rb +1 -2
  217. data/vendor/rails/activerecord/test/cases/i18n_test.rb +5 -0
  218. data/vendor/rails/activerecord/test/cases/json_serialization_test.rb +57 -57
  219. data/vendor/rails/activerecord/test/cases/method_scoping_test.rb +14 -4
  220. data/vendor/rails/activerecord/test/cases/migration_test.rb +39 -11
  221. data/vendor/rails/activerecord/test/cases/modules_test.rb +42 -0
  222. data/vendor/rails/activerecord/test/cases/named_scope_test.rb +6 -4
  223. data/vendor/rails/activerecord/test/cases/pk_test.rb +18 -0
  224. data/vendor/rails/activerecord/test/cases/reflection_test.rb +7 -7
  225. data/vendor/rails/activerecord/test/cases/schema_dumper_test.rb +35 -7
  226. data/vendor/rails/activerecord/test/cases/schema_test_postgresql.rb +76 -0
  227. data/vendor/rails/activerecord/test/cases/timestamp_test.rb +75 -0
  228. data/vendor/rails/activerecord/test/cases/validations_i18n_test.rb +656 -624
  229. data/vendor/rails/activerecord/test/cases/validations_test.rb +12 -2
  230. data/vendor/rails/activerecord/test/cases/xml_serialization_test.rb +20 -0
  231. data/vendor/rails/activerecord/test/fixtures/fixture_database.sqlite +0 -0
  232. data/vendor/rails/activerecord/test/fixtures/fixture_database.sqlite3 +0 -0
  233. data/vendor/rails/activerecord/test/fixtures/fixture_database_2.sqlite +0 -0
  234. data/vendor/rails/activerecord/test/fixtures/fixture_database_2.sqlite3 +0 -0
  235. data/vendor/rails/activerecord/test/fixtures/posts.yml +3 -0
  236. data/vendor/rails/activerecord/test/models/author.rb +5 -0
  237. data/vendor/rails/activerecord/test/models/comment.rb +5 -1
  238. data/vendor/rails/activerecord/test/models/company.rb +9 -7
  239. data/vendor/rails/activerecord/test/models/company_in_module.rb +1 -1
  240. data/vendor/rails/activerecord/test/models/contract.rb +5 -0
  241. data/vendor/rails/activerecord/test/models/developer.rb +10 -0
  242. data/vendor/rails/activerecord/test/models/essay.rb +3 -0
  243. data/vendor/rails/activerecord/test/models/organization.rb +2 -0
  244. data/vendor/rails/activerecord/test/models/pet.rb +1 -1
  245. data/vendor/rails/activerecord/test/models/project.rb +1 -1
  246. data/vendor/rails/activerecord/test/models/reply.rb +2 -1
  247. data/vendor/rails/activerecord/test/models/topic.rb +1 -2
  248. data/vendor/rails/activerecord/test/models/toy.rb +2 -0
  249. data/vendor/rails/activerecord/test/schema/postgresql_specific_schema.rb +13 -2
  250. data/vendor/rails/activerecord/test/schema/schema.rb +19 -0
  251. data/vendor/rails/activeresource/CHANGELOG +16 -0
  252. data/vendor/rails/activeresource/Rakefile +3 -2
  253. data/vendor/rails/activeresource/lib/active_resource/base.rb +89 -9
  254. data/vendor/rails/activeresource/lib/active_resource/connection.rb +73 -8
  255. data/vendor/rails/activeresource/lib/active_resource/exceptions.rb +66 -0
  256. data/vendor/rails/activeresource/lib/active_resource/formats/json_format.rb +2 -2
  257. data/vendor/rails/activeresource/lib/active_resource/validations.rb +20 -4
  258. data/vendor/rails/activeresource/lib/active_resource/version.rb +1 -1
  259. data/vendor/rails/activeresource/test/abstract_unit.rb +1 -3
  260. data/vendor/rails/activeresource/test/base/load_test.rb +16 -1
  261. data/vendor/rails/activeresource/test/base_errors_test.rb +56 -19
  262. data/vendor/rails/activeresource/test/base_test.rb +147 -0
  263. data/vendor/rails/activeresource/test/connection_test.rb +42 -0
  264. data/vendor/rails/activeresource/test/debug.log +7974 -0
  265. data/vendor/rails/activeresource/test/fixtures/proxy.rb +4 -0
  266. data/vendor/rails/activesupport/CHANGELOG +13 -0
  267. data/vendor/rails/activesupport/lib/active_support/all.rb +8 -0
  268. data/vendor/rails/activesupport/lib/active_support/cache.rb +14 -1
  269. data/vendor/rails/activesupport/lib/active_support/cache/mem_cache_store.rb +16 -10
  270. data/vendor/rails/activesupport/lib/active_support/cache/strategy/local_cache.rb +1 -1
  271. data/vendor/rails/activesupport/lib/active_support/core_ext/array/conversions.rb +1 -0
  272. data/vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb +2 -1
  273. data/vendor/rails/activesupport/lib/active_support/core_ext/enumerable.rb +2 -4
  274. data/vendor/rails/activesupport/lib/active_support/core_ext/hash/conversions.rb +14 -4
  275. data/vendor/rails/activesupport/lib/active_support/core_ext/kernel/debugger.rb +4 -2
  276. data/vendor/rails/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb +2 -0
  277. data/vendor/rails/activesupport/lib/active_support/core_ext/module/delegation.rb +19 -5
  278. data/vendor/rails/activesupport/lib/active_support/core_ext/module/model_naming.rb +8 -6
  279. data/vendor/rails/activesupport/lib/active_support/core_ext/numeric/bytes.rb +15 -9
  280. data/vendor/rails/activesupport/lib/active_support/core_ext/string.rb +1 -0
  281. data/vendor/rails/activesupport/lib/active_support/core_ext/string/access.rb +29 -5
  282. data/vendor/rails/activesupport/lib/active_support/core_ext/string/bytesize.rb +5 -0
  283. data/vendor/rails/activesupport/lib/active_support/core_ext/time/calculations.rb +7 -7
  284. data/vendor/rails/activesupport/lib/active_support/deprecation.rb +9 -9
  285. data/vendor/rails/activesupport/lib/active_support/duration.rb +4 -2
  286. data/vendor/rails/activesupport/lib/active_support/json.rb +1 -22
  287. data/vendor/rails/activesupport/lib/active_support/json/backends/jsongem.rb +38 -0
  288. data/vendor/rails/activesupport/lib/active_support/json/backends/yaml.rb +88 -0
  289. data/vendor/rails/activesupport/lib/active_support/json/decoding.rb +23 -72
  290. data/vendor/rails/activesupport/lib/active_support/json/encoders/date.rb +9 -8
  291. data/vendor/rails/activesupport/lib/active_support/json/encoders/date_time.rb +9 -8
  292. data/vendor/rails/activesupport/lib/active_support/json/encoders/enumerable.rb +14 -9
  293. data/vendor/rails/activesupport/lib/active_support/json/encoders/false_class.rb +4 -2
  294. data/vendor/rails/activesupport/lib/active_support/json/encoders/hash.rb +21 -11
  295. data/vendor/rails/activesupport/lib/active_support/json/encoders/nil_class.rb +4 -2
  296. data/vendor/rails/activesupport/lib/active_support/json/encoders/numeric.rb +16 -0
  297. data/vendor/rails/activesupport/lib/active_support/json/encoders/object.rb +6 -2
  298. data/vendor/rails/activesupport/lib/active_support/json/encoders/regexp.rb +4 -0
  299. data/vendor/rails/activesupport/lib/active_support/json/encoders/string.rb +5 -32
  300. data/vendor/rails/activesupport/lib/active_support/json/encoders/symbol.rb +2 -2
  301. data/vendor/rails/activesupport/lib/active_support/json/encoders/time.rb +9 -8
  302. data/vendor/rails/activesupport/lib/active_support/json/encoders/true_class.rb +4 -2
  303. data/vendor/rails/activesupport/lib/active_support/json/encoding.rb +80 -9
  304. data/vendor/rails/activesupport/lib/active_support/memoizable.rb +1 -1
  305. data/vendor/rails/activesupport/lib/active_support/message_verifier.rb +16 -3
  306. data/vendor/rails/activesupport/lib/active_support/multibyte.rb +30 -6
  307. data/vendor/rails/activesupport/lib/active_support/multibyte/chars.rb +23 -17
  308. data/vendor/rails/activesupport/lib/active_support/multibyte/utils.rb +61 -0
  309. data/vendor/rails/activesupport/lib/active_support/ordered_hash.rb +28 -0
  310. data/vendor/rails/activesupport/lib/active_support/test_case.rb +9 -8
  311. data/vendor/rails/activesupport/lib/active_support/testing/deprecation.rb +2 -0
  312. data/vendor/rails/activesupport/lib/active_support/time_with_zone.rb +9 -8
  313. data/vendor/rails/activesupport/lib/active_support/vendor.rb +6 -7
  314. data/vendor/rails/activesupport/lib/active_support/vendor/i18n-0.1.3/test/i18n_exceptions_test.rb +0 -1
  315. data/vendor/rails/activesupport/lib/active_support/vendor/i18n-0.1.3/test/i18n_test.rb +0 -1
  316. data/vendor/rails/activesupport/lib/active_support/vendor/i18n-0.1.3/test/simple_backend_test.rb +0 -1
  317. data/vendor/rails/activesupport/lib/active_support/vendor/{memcache-client-1.6.5 → memcache-client-1.7.4}/memcache.rb +242 -70
  318. data/vendor/rails/activesupport/lib/active_support/version.rb +1 -1
  319. data/vendor/rails/activesupport/lib/active_support/xml_mini/jdom.rb +162 -0
  320. data/vendor/rails/railties/CHANGELOG +10 -0
  321. data/vendor/rails/railties/Rakefile +13 -9
  322. data/vendor/rails/railties/bin/about +2 -2
  323. data/vendor/rails/railties/bin/console +1 -1
  324. data/vendor/rails/railties/bin/dbconsole +1 -1
  325. data/vendor/rails/railties/bin/destroy +1 -1
  326. data/vendor/rails/railties/bin/generate +1 -1
  327. data/vendor/rails/railties/bin/performance/benchmarker +1 -1
  328. data/vendor/rails/railties/bin/performance/profiler +1 -1
  329. data/vendor/rails/railties/bin/plugin +1 -1
  330. data/vendor/rails/railties/bin/runner +1 -1
  331. data/vendor/rails/railties/bin/server +1 -1
  332. data/vendor/rails/railties/builtin/rails_info/rails/info.rb +4 -2
  333. data/vendor/rails/railties/configs/initializers/new_rails_defaults.rb +2 -0
  334. data/vendor/rails/railties/configs/routes.rb +1 -1
  335. data/vendor/rails/railties/configs/seeds.rb +7 -0
  336. data/vendor/rails/railties/environments/boot.rb +1 -1
  337. data/vendor/rails/railties/guides/files/javascripts/code_highlighter.js +188 -0
  338. data/vendor/rails/railties/guides/files/javascripts/guides.js +8 -0
  339. data/vendor/rails/railties/guides/files/javascripts/highlighters.js +90 -0
  340. data/vendor/rails/railties/guides/files/stylesheets/main.css +441 -0
  341. data/vendor/rails/railties/guides/files/stylesheets/print.css +52 -0
  342. data/vendor/rails/railties/guides/files/stylesheets/reset.css +43 -0
  343. data/vendor/rails/railties/guides/files/stylesheets/style.css +13 -0
  344. data/vendor/rails/railties/guides/files/stylesheets/syntax.css +31 -0
  345. data/vendor/rails/railties/guides/images/belongs_to.png +0 -0
  346. data/vendor/rails/railties/guides/images/book_icon.gif +0 -0
  347. data/vendor/rails/railties/guides/images/bullet.gif +0 -0
  348. data/vendor/rails/railties/guides/images/chapters_icon.gif +0 -0
  349. data/vendor/rails/railties/guides/images/check_bullet.gif +0 -0
  350. data/vendor/rails/railties/guides/images/credits_pic_blank.gif +0 -0
  351. data/vendor/rails/railties/guides/images/csrf.png +0 -0
  352. data/vendor/rails/railties/guides/images/customized_error_messages.png +0 -0
  353. data/vendor/rails/railties/guides/images/error_messages.png +0 -0
  354. data/vendor/rails/railties/guides/images/feature_tile.gif +0 -0
  355. data/vendor/rails/railties/guides/images/footer_tile.gif +0 -0
  356. data/vendor/rails/railties/guides/images/fxn.jpg +0 -0
  357. data/vendor/rails/railties/guides/images/grey_bullet.gif +0 -0
  358. data/vendor/rails/railties/guides/images/habtm.png +0 -0
  359. data/vendor/rails/railties/guides/images/has_many.png +0 -0
  360. data/vendor/rails/railties/guides/images/has_many_through.png +0 -0
  361. data/vendor/rails/railties/guides/images/has_one.png +0 -0
  362. data/vendor/rails/railties/guides/images/has_one_through.png +0 -0
  363. data/vendor/rails/railties/guides/images/header_backdrop.png +0 -0
  364. data/vendor/rails/railties/guides/images/header_tile.gif +0 -0
  365. data/vendor/rails/railties/guides/images/i18n/demo_localized_pirate.png +0 -0
  366. data/vendor/rails/railties/guides/images/i18n/demo_translated_en.png +0 -0
  367. data/vendor/rails/railties/guides/images/i18n/demo_translated_pirate.png +0 -0
  368. data/vendor/rails/railties/guides/images/i18n/demo_translation_missing.png +0 -0
  369. data/vendor/rails/railties/guides/images/i18n/demo_untranslated.png +0 -0
  370. data/vendor/rails/railties/guides/images/icons/README +5 -0
  371. data/vendor/rails/railties/guides/images/icons/callouts/1.png +0 -0
  372. data/vendor/rails/railties/guides/images/icons/callouts/10.png +0 -0
  373. data/vendor/rails/railties/guides/images/icons/callouts/11.png +0 -0
  374. data/vendor/rails/railties/guides/images/icons/callouts/12.png +0 -0
  375. data/vendor/rails/railties/guides/images/icons/callouts/13.png +0 -0
  376. data/vendor/rails/railties/guides/images/icons/callouts/14.png +0 -0
  377. data/vendor/rails/railties/guides/images/icons/callouts/15.png +0 -0
  378. data/vendor/rails/railties/guides/images/icons/callouts/2.png +0 -0
  379. data/vendor/rails/railties/guides/images/icons/callouts/3.png +0 -0
  380. data/vendor/rails/railties/guides/images/icons/callouts/4.png +0 -0
  381. data/vendor/rails/railties/guides/images/icons/callouts/5.png +0 -0
  382. data/vendor/rails/railties/guides/images/icons/callouts/6.png +0 -0
  383. data/vendor/rails/railties/guides/images/icons/callouts/7.png +0 -0
  384. data/vendor/rails/railties/guides/images/icons/callouts/8.png +0 -0
  385. data/vendor/rails/railties/guides/images/icons/callouts/9.png +0 -0
  386. data/vendor/rails/railties/guides/images/icons/caution.png +0 -0
  387. data/vendor/rails/railties/guides/images/icons/example.png +0 -0
  388. data/vendor/rails/railties/guides/images/icons/home.png +0 -0
  389. data/vendor/rails/railties/guides/images/icons/important.png +0 -0
  390. data/vendor/rails/railties/guides/images/icons/next.png +0 -0
  391. data/vendor/rails/railties/guides/images/icons/note.png +0 -0
  392. data/vendor/rails/railties/guides/images/icons/prev.png +0 -0
  393. data/vendor/rails/railties/guides/images/icons/tip.png +0 -0
  394. data/vendor/rails/railties/guides/images/icons/up.png +0 -0
  395. data/vendor/rails/railties/guides/images/icons/warning.png +0 -0
  396. data/vendor/rails/railties/guides/images/nav_arrow.gif +0 -0
  397. data/vendor/rails/railties/guides/images/polymorphic.png +0 -0
  398. data/vendor/rails/railties/guides/images/posts_index.png +0 -0
  399. data/vendor/rails/railties/guides/images/rails_guides_logo.gif +0 -0
  400. data/vendor/rails/railties/guides/images/rails_logo_remix.gif +0 -0
  401. data/vendor/rails/railties/guides/images/rails_welcome.png +0 -0
  402. data/vendor/rails/railties/guides/images/session_fixation.png +0 -0
  403. data/vendor/rails/railties/guides/images/tab_grey.gif +0 -0
  404. data/vendor/rails/railties/guides/images/tab_info.gif +0 -0
  405. data/vendor/rails/railties/guides/images/tab_note.gif +0 -0
  406. data/vendor/rails/railties/guides/images/tab_red.gif +0 -0
  407. data/vendor/rails/railties/guides/images/tab_yellow.gif +0 -0
  408. data/vendor/rails/railties/guides/images/tab_yellow.png +0 -0
  409. data/vendor/rails/railties/guides/images/validation_error_messages.png +0 -0
  410. data/vendor/rails/railties/guides/rails_guides.rb +42 -0
  411. data/vendor/rails/railties/guides/rails_guides/generator.rb +138 -0
  412. data/vendor/rails/railties/guides/rails_guides/helpers.rb +34 -0
  413. data/vendor/rails/railties/guides/rails_guides/indexer.rb +55 -0
  414. data/vendor/rails/railties/guides/rails_guides/textile_extensions.rb +41 -0
  415. data/vendor/rails/railties/guides/source/2_2_release_notes.textile +422 -0
  416. data/vendor/rails/railties/guides/source/2_3_release_notes.textile +610 -0
  417. data/vendor/rails/railties/guides/source/action_controller_overview.textile +776 -0
  418. data/vendor/rails/railties/guides/source/action_mailer_basics.textile +424 -0
  419. data/vendor/rails/railties/guides/source/active_record_basics.textile +135 -0
  420. data/vendor/rails/railties/guides/source/active_record_querying.textile +969 -0
  421. data/vendor/rails/railties/guides/source/activerecord_validations_callbacks.textile +1086 -0
  422. data/vendor/rails/railties/guides/source/association_basics.textile +1781 -0
  423. data/vendor/rails/railties/guides/source/caching_with_rails.textile +524 -0
  424. data/vendor/rails/railties/guides/source/command_line.textile +589 -0
  425. data/vendor/rails/railties/guides/source/configuring.textile +234 -0
  426. data/vendor/rails/railties/guides/source/contribute.textile +71 -0
  427. data/vendor/rails/railties/guides/source/contributing_to_rails.textile +239 -0
  428. data/vendor/rails/railties/guides/source/credits.erb.textile +52 -0
  429. data/vendor/rails/railties/guides/source/debugging_rails_applications.textile +709 -0
  430. data/vendor/rails/railties/guides/source/form_helpers.textile +766 -0
  431. data/vendor/rails/railties/guides/source/getting_started.textile +1297 -0
  432. data/vendor/rails/railties/guides/source/i18n.textile +912 -0
  433. data/vendor/rails/railties/guides/source/index.erb.textile +124 -0
  434. data/vendor/rails/railties/guides/source/layout.html.erb +103 -0
  435. data/vendor/rails/railties/guides/source/layouts_and_rendering.textile +979 -0
  436. data/vendor/rails/railties/guides/source/migrations.textile +591 -0
  437. data/vendor/rails/railties/guides/source/nested_model_forms.textile +222 -0
  438. data/vendor/rails/railties/guides/source/performance_testing.textile +531 -0
  439. data/vendor/rails/railties/guides/source/plugins.textile +1512 -0
  440. data/vendor/rails/railties/guides/source/rails_on_rack.textile +309 -0
  441. data/vendor/rails/railties/guides/source/routing.textile +903 -0
  442. data/vendor/rails/railties/guides/source/security.textile +986 -0
  443. data/vendor/rails/railties/guides/source/testing.textile +951 -0
  444. data/vendor/rails/railties/lib/commands/dbconsole.rb +8 -4
  445. data/vendor/rails/railties/lib/commands/performance/profiler.rb +1 -1
  446. data/vendor/rails/railties/lib/initializer.rb +27 -4
  447. data/vendor/rails/railties/lib/rails/gem_dependency.rb +35 -6
  448. data/vendor/rails/railties/lib/rails/plugin.rb +12 -0
  449. data/vendor/rails/railties/lib/rails/plugin/loader.rb +7 -0
  450. data/vendor/rails/railties/lib/rails/rack/metal.rb +1 -1
  451. data/vendor/rails/railties/lib/rails/version.rb +1 -1
  452. data/vendor/rails/railties/lib/rails_generator/base.rb +1 -1
  453. data/vendor/rails/railties/lib/rails_generator/generators/applications/app/app_generator.rb +5 -0
  454. data/vendor/rails/railties/lib/rails_generator/generators/applications/app/template_runner.rb +1 -1
  455. data/vendor/rails/railties/lib/rails_generator/generators/components/model/model_generator.rb +9 -2
  456. data/vendor/rails/railties/lib/rails_generator/generators/components/scaffold/scaffold_generator.rb +1 -0
  457. data/vendor/rails/railties/lib/tasks/databases.rake +17 -4
  458. data/vendor/rails/railties/lib/tasks/gems.rake +19 -6
  459. data/vendor/rails/railties/lib/tasks/routes.rake +4 -3
  460. data/vendor/rails/railties/lib/test_help.rb +4 -1
  461. metadata +158 -58
  462. data/spec/lib/local_time_spec.rb +0 -40
  463. data/vendor/rails/actionpack/lib/action_controller/rewindable_input.rb +0 -28
  464. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack.rb +0 -89
  465. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/adapter/camping.rb +0 -22
  466. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/auth/abstract/handler.rb +0 -37
  467. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/auth/abstract/request.rb +0 -37
  468. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/auth/basic.rb +0 -58
  469. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/auth/digest/md5.rb +0 -124
  470. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/auth/digest/nonce.rb +0 -51
  471. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/auth/digest/params.rb +0 -55
  472. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/auth/digest/request.rb +0 -40
  473. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/auth/openid.rb +0 -480
  474. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/builder.rb +0 -63
  475. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/cascade.rb +0 -36
  476. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/chunked.rb +0 -49
  477. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/commonlogger.rb +0 -61
  478. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/conditionalget.rb +0 -45
  479. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/content_length.rb +0 -29
  480. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/content_type.rb +0 -23
  481. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/deflater.rb +0 -85
  482. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/directory.rb +0 -153
  483. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/file.rb +0 -88
  484. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/handler.rb +0 -48
  485. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/handler/cgi.rb +0 -61
  486. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/handler/evented_mongrel.rb +0 -8
  487. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/handler/fastcgi.rb +0 -89
  488. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/handler/lsws.rb +0 -55
  489. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/handler/mongrel.rb +0 -84
  490. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/handler/scgi.rb +0 -59
  491. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/handler/swiftiplied_mongrel.rb +0 -8
  492. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/handler/thin.rb +0 -18
  493. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/handler/webrick.rb +0 -67
  494. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/head.rb +0 -19
  495. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/lint.rb +0 -462
  496. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/lobster.rb +0 -65
  497. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/lock.rb +0 -16
  498. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/methodoverride.rb +0 -27
  499. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/mime.rb +0 -204
  500. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/mock.rb +0 -160
  501. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/recursive.rb +0 -57
  502. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/reloader.rb +0 -64
  503. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/request.rb +0 -241
  504. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/response.rb +0 -179
  505. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/session/abstract/id.rb +0 -142
  506. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/session/cookie.rb +0 -91
  507. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/session/memcache.rb +0 -109
  508. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/session/pool.rb +0 -100
  509. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/showexceptions.rb +0 -349
  510. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/showstatus.rb +0 -106
  511. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/static.rb +0 -38
  512. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/urlmap.rb +0 -55
  513. data/vendor/rails/actionpack/lib/action_controller/vendor/rack-1.0/rack/utils.rb +0 -392
@@ -0,0 +1,1512 @@
1
+ h2. The Basics of Creating Rails Plugins
2
+
3
+ A Rails plugin is either an extension or a modification of the core framework. Plugins provide:
4
+
5
+ * a way for developers to share bleeding-edge ideas without hurting the stable code base
6
+ * a segmented architecture so that units of code can be fixed or updated on their own release schedule
7
+ * an outlet for the core developers so that they don’t have to include every cool new feature under the sun
8
+
9
+ After reading this guide you should be familiar with:
10
+
11
+ * Creating a plugin from scratch
12
+ * Writing and running tests for the plugin
13
+ * Storing models, views, controllers, helpers and even other plugins in your plugins
14
+ * Writing generators
15
+ * Writing custom Rake tasks in your plugin
16
+ * Generating RDoc documentation for your plugin
17
+ * Avoiding common pitfalls with 'init.rb'
18
+
19
+ This guide describes how to build a test-driven plugin that will:
20
+
21
+ * Extend core ruby classes like Hash and String
22
+ * Add methods to ActiveRecord::Base in the tradition of the 'acts_as' plugins
23
+ * Add a view helper that can be used in erb templates
24
+ * Add a new generator that will generate a migration
25
+ * Add a custom generator command
26
+ * A custom route method that can be used in routes.rb
27
+
28
+ For the purpose of this guide pretend for a moment that you are an avid bird watcher. Your favorite bird is the Yaffle, and you want to create a plugin that allows other developers to share in the Yaffle goodness. First, you need to get setup for development.
29
+
30
+ endprologue.
31
+
32
+ h3. Setup
33
+
34
+ h4. Create the Basic Application
35
+
36
+ The examples in this guide require that you have a working rails application. To create a simple rails app execute:
37
+
38
+ <pre>
39
+ gem install rails
40
+ rails yaffle_guide
41
+ cd yaffle_guide
42
+ script/generate scaffold bird name:string
43
+ rake db:migrate
44
+ script/server
45
+ </pre>
46
+
47
+ Then navigate to http://localhost:3000/birds. Make sure you have a functioning rails app before continuing.
48
+
49
+ NOTE: The aforementioned instructions will work for sqlite3. For more detailed instructions on how to create a rails app for other databases see the API docs.
50
+
51
+
52
+ h4. Generate the Plugin Skeleton
53
+
54
+ Rails ships with a plugin generator which creates a basic plugin skeleton. Pass the plugin name, either 'CamelCased' or 'under_scored', as an argument. Pass +--with-generator+ to add an example generator also.
55
+
56
+ This creates a plugin in 'vendor/plugins' including an 'init.rb' and 'README' as well as standard 'lib', 'task', and 'test' directories.
57
+
58
+ Examples:
59
+ <pre>
60
+ ./script/generate plugin yaffle
61
+ ./script/generate plugin yaffle --with-generator
62
+ </pre>
63
+
64
+ To get more detailed help on the plugin generator, type +./script/generate plugin+.
65
+
66
+ Later on this guide will describe how to work with generators, so go ahead and generate your plugin with the +--with-generator+ option now:
67
+
68
+ <pre>
69
+ ./script/generate plugin yaffle --with-generator
70
+ </pre>
71
+
72
+ You should see the following output:
73
+
74
+ <pre>
75
+ create vendor/plugins/yaffle/lib
76
+ create vendor/plugins/yaffle/tasks
77
+ create vendor/plugins/yaffle/test
78
+ create vendor/plugins/yaffle/README
79
+ create vendor/plugins/yaffle/MIT-LICENSE
80
+ create vendor/plugins/yaffle/Rakefile
81
+ create vendor/plugins/yaffle/init.rb
82
+ create vendor/plugins/yaffle/install.rb
83
+ create vendor/plugins/yaffle/uninstall.rb
84
+ create vendor/plugins/yaffle/lib/yaffle.rb
85
+ create vendor/plugins/yaffle/tasks/yaffle_tasks.rake
86
+ create vendor/plugins/yaffle/test/core_ext_test.rb
87
+ create vendor/plugins/yaffle/generators
88
+ create vendor/plugins/yaffle/generators/yaffle
89
+ create vendor/plugins/yaffle/generators/yaffle/templates
90
+ create vendor/plugins/yaffle/generators/yaffle/yaffle_generator.rb
91
+ create vendor/plugins/yaffle/generators/yaffle/USAGE
92
+ </pre>
93
+
94
+ h4. Organize Your Files
95
+
96
+ To make it easy to organize your files and to make the plugin more compatible with GemPlugins, start out by altering your file system to look like this:
97
+
98
+ <pre>
99
+ |-- lib
100
+ | |-- yaffle
101
+ | `-- yaffle.rb
102
+ `-- rails
103
+ |
104
+ `-- init.rb
105
+ </pre>
106
+
107
+ *vendor/plugins/yaffle/rails/init.rb*
108
+
109
+ <ruby>
110
+ require 'yaffle'
111
+ </ruby>
112
+
113
+ Now you can add any 'require' statements to 'lib/yaffle.rb' and keep 'init.rb' clean.
114
+
115
+ h3. Tests
116
+
117
+ In this guide you will learn how to test your plugin against multiple different database adapters using Active Record. To setup your plugin to allow for easy testing you'll need to add 3 files:
118
+
119
+ * A 'database.yml' file with all of your connection strings
120
+ * A 'schema.rb' file with your table definitions
121
+ * A test helper method that sets up the database
122
+
123
+ h4. Test Setup
124
+
125
+ *vendor/plugins/yaffle/test/database.yml:*
126
+
127
+ <pre>
128
+ sqlite:
129
+ :adapter: sqlite
130
+ :dbfile: vendor/plugins/yaffle/test/yaffle_plugin.sqlite.db
131
+
132
+ sqlite3:
133
+ :adapter: sqlite3
134
+ :dbfile: vendor/plugins/yaffle/test/yaffle_plugin.sqlite3.db
135
+
136
+ postgresql:
137
+ :adapter: postgresql
138
+ :username: postgres
139
+ :password: postgres
140
+ :database: yaffle_plugin_test
141
+ :min_messages: ERROR
142
+
143
+ mysql:
144
+ :adapter: mysql
145
+ :host: localhost
146
+ :username: root
147
+ :password: password
148
+ :database: yaffle_plugin_test
149
+ </pre>
150
+
151
+ For this guide you'll need 2 tables/models, Hickwalls and Wickwalls, so add the following:
152
+
153
+ *vendor/plugins/yaffle/test/schema.rb:*
154
+
155
+ <ruby>
156
+ ActiveRecord::Schema.define(:version => 0) do
157
+ create_table :hickwalls, :force => true do |t|
158
+ t.string :name
159
+ t.string :last_squawk
160
+ t.datetime :last_squawked_at
161
+ end
162
+ create_table :wickwalls, :force => true do |t|
163
+ t.string :name
164
+ t.string :last_tweet
165
+ t.datetime :last_tweeted_at
166
+ end
167
+ create_table :woodpeckers, :force => true do |t|
168
+ t.string :name
169
+ end
170
+ end
171
+ </ruby>
172
+
173
+ *vendor/plugins/yaffle/test/test_helper.rb:*
174
+
175
+ <ruby>
176
+ ENV['RAILS_ENV'] = 'test'
177
+ ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
178
+
179
+ require 'test/unit'
180
+ require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
181
+
182
+ def load_schema
183
+ config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
184
+ ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
185
+
186
+ db_adapter = ENV['DB']
187
+
188
+ # no db passed, try one of these fine config-free DBs before bombing.
189
+ db_adapter ||=
190
+ begin
191
+ require 'rubygems'
192
+ require 'sqlite'
193
+ 'sqlite'
194
+ rescue MissingSourceFile
195
+ begin
196
+ require 'sqlite3'
197
+ 'sqlite3'
198
+ rescue MissingSourceFile
199
+ end
200
+ end
201
+
202
+ if db_adapter.nil?
203
+ raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
204
+ end
205
+
206
+ ActiveRecord::Base.establish_connection(config[db_adapter])
207
+ load(File.dirname(__FILE__) + "/schema.rb")
208
+ require File.dirname(__FILE__) + '/../rails/init.rb'
209
+ end
210
+ </ruby>
211
+
212
+ Now whenever you write a test that requires the database, you can call 'load_schema'.
213
+
214
+ h4. Run the Plugin Tests
215
+
216
+ Once you have these files in place, you can write your first test to ensure that your plugin-testing setup is correct. By default rails generates a file in 'vendor/plugins/yaffle/test/yaffle_test.rb' with a sample test. Replace the contents of that file with:
217
+
218
+ *vendor/plugins/yaffle/test/yaffle_test.rb:*
219
+
220
+ <ruby>
221
+ require File.dirname(__FILE__) + '/test_helper.rb'
222
+
223
+ class YaffleTest < Test::Unit::TestCase
224
+ load_schema
225
+
226
+ class Hickwall < ActiveRecord::Base
227
+ end
228
+
229
+ class Wickwall < ActiveRecord::Base
230
+ end
231
+
232
+ def test_schema_has_loaded_correctly
233
+ assert_equal [], Hickwall.all
234
+ assert_equal [], Wickwall.all
235
+ end
236
+
237
+ end
238
+ </ruby>
239
+
240
+ To run this, go to the plugin directory and run +rake+:
241
+
242
+ <pre>
243
+ cd vendor/plugins/yaffle
244
+ rake
245
+ </pre>
246
+
247
+ You should see output like:
248
+
249
+ <shell>
250
+ /opt/local/bin/ruby -Ilib:lib "/opt/local/lib/ruby/gems/1.8/gems/rake-0.8.3/lib/rake/rake_test_loader.rb" "test/yaffle_test.rb"
251
+ create_table(:hickwalls, {:force=>true})
252
+ -> 0.0220s
253
+ -- create_table(:wickwalls, {:force=>true})
254
+ -> 0.0077s
255
+ -- initialize_schema_migrations_table()
256
+ -> 0.0007s
257
+ -- assume_migrated_upto_version(0)
258
+ -> 0.0007s
259
+ Loaded suite /opt/local/lib/ruby/gems/1.8/gems/rake-0.8.3/lib/rake/rake_test_loader
260
+ Started
261
+ .
262
+ Finished in 0.002236 seconds.
263
+
264
+ 1 test, 1 assertion, 0 failures, 0 errors
265
+ </shell>
266
+
267
+ By default the setup above runs your tests with sqlite or sqlite3. To run tests with one of the other connection strings specified in database.yml, pass the DB environment variable to rake:
268
+
269
+ <shell>
270
+ rake DB=sqlite
271
+ rake DB=sqlite3
272
+ rake DB=mysql
273
+ rake DB=postgresql
274
+ </shell>
275
+
276
+ Now you are ready to test-drive your plugin!
277
+
278
+ h3. Extending Core Classes
279
+
280
+ This section will explain how to add a method to String that will be available anywhere in your rails app.
281
+
282
+ In this example you will add a method to String named +to_squawk+. To begin, create a new test file with a few assertions:
283
+
284
+ * *vendor/plugins/yaffle/test/core_ext_test.rb*
285
+
286
+ <ruby>
287
+ require File.dirname(__FILE__) + '/test_helper.rb'
288
+
289
+ class CoreExtTest < Test::Unit::TestCase
290
+ def test_to_squawk_prepends_the_word_squawk
291
+ assert_equal "squawk! Hello World", "Hello World".to_squawk
292
+ end
293
+ end
294
+ </ruby>
295
+
296
+ Navigate to your plugin directory and run +rake test+:
297
+
298
+ <shell>
299
+ cd vendor/plugins/yaffle
300
+ rake test
301
+ </shell>
302
+
303
+ The test above should fail with the message:
304
+
305
+ <shell>
306
+ 1) Error:
307
+ test_to_squawk_prepends_the_word_squawk(CoreExtTest):
308
+ NoMethodError: undefined method `to_squawk' for "Hello World":String
309
+ ./test/core_ext_test.rb:5:in `test_to_squawk_prepends_the_word_squawk'
310
+ </shell>
311
+
312
+ Great - now you are ready to start development.
313
+
314
+ Then in 'lib/yaffle.rb' require 'lib/core_ext.rb':
315
+
316
+ * *vendor/plugins/yaffle/lib/yaffle.rb*
317
+
318
+ <ruby>
319
+ require "yaffle/core_ext"
320
+ </ruby>
321
+
322
+ Finally, create the 'core_ext.rb' file and add the 'to_squawk' method:
323
+
324
+ * *vendor/plugins/yaffle/lib/yaffle/core_ext.rb*
325
+
326
+ <ruby>
327
+ String.class_eval do
328
+ def to_squawk
329
+ "squawk! #{self}".strip
330
+ end
331
+ end
332
+ </ruby>
333
+
334
+ To test that your method does what it says it does, run the unit tests with +rake+ from your plugin directory. To see this in action, fire up a console and start squawking:
335
+
336
+ <shell>
337
+ $ ./script/console
338
+ >> "Hello World".to_squawk
339
+ => "squawk! Hello World"
340
+ </shell>
341
+
342
+ h4. Working with +init.rb+
343
+
344
+ When rails loads plugins it looks for the file named 'init.rb' or 'rails/init.rb'. However, when the plugin is initialized, 'init.rb' is invoked via +eval+ (not +require+) so it has slightly different behavior.
345
+
346
+ Under certain circumstances if you reopen classes or modules in 'init.rb' you may inadvertently create a new class, rather than reopening an existing class. A better alternative is to reopen the class in a different file, and require that file from +init.rb+, as shown above.
347
+
348
+ If you must reopen a class in +init.rb+ you can use +module_eval+ or +class_eval+ to avoid any issues:
349
+
350
+ * *vendor/plugins/yaffle/rails/init.rb*
351
+
352
+ <ruby>
353
+ Hash.class_eval do
354
+ def is_a_special_hash?
355
+ true
356
+ end
357
+ end
358
+ </ruby>
359
+
360
+ Another way is to explicitly define the top-level module space for all modules and classes, like +::Hash+:
361
+
362
+ * *vendor/plugins/yaffle/rails/init.rb*
363
+
364
+ <ruby>
365
+ class ::Hash
366
+ def is_a_special_hash?
367
+ true
368
+ end
369
+ end
370
+ </ruby>
371
+
372
+ h3. Add an "acts_as" Method to Active Record
373
+
374
+ A common pattern in plugins is to add a method called 'acts_as_something' to models. In this case, you want to write a method called 'acts_as_yaffle' that adds a 'squawk' method to your models.
375
+
376
+ To begin, set up your files so that you have:
377
+
378
+ * *vendor/plugins/yaffle/test/acts_as_yaffle_test.rb*
379
+
380
+ <ruby>
381
+ require File.dirname(__FILE__) + '/test_helper.rb'
382
+
383
+ class ActsAsYaffleTest < Test::Unit::TestCase
384
+ end
385
+ </ruby>
386
+
387
+ * *vendor/plugins/yaffle/lib/yaffle.rb*
388
+
389
+ <ruby>
390
+ require 'yaffle/acts_as_yaffle'
391
+ </ruby>
392
+
393
+ * *vendor/plugins/yaffle/lib/yaffle/acts_as_yaffle.rb*
394
+
395
+ <ruby>
396
+ module Yaffle
397
+ # your code will go here
398
+ end
399
+ </ruby>
400
+
401
+ Note that after requiring 'acts_as_yaffle' you also have to include it into ActiveRecord::Base so that your plugin methods will be available to the rails models.
402
+
403
+ One of the most common plugin patterns for 'acts_as_yaffle' plugins is to structure your file like so:
404
+
405
+ * *vendor/plugins/yaffle/lib/yaffle/acts_as_yaffle.rb*
406
+
407
+ <ruby>
408
+ module Yaffle
409
+ def self.included(base)
410
+ base.send :extend, ClassMethods
411
+ end
412
+
413
+ module ClassMethods
414
+ # any method placed here will apply to classes, like Hickwall
415
+ def acts_as_something
416
+ send :include, InstanceMethods
417
+ end
418
+ end
419
+
420
+ module InstanceMethods
421
+ # any method placed here will apply to instaces, like @hickwall
422
+ end
423
+ end
424
+ </ruby>
425
+
426
+ With structure you can easily separate the methods that will be used for the class (like +Hickwall.some_method+) and the instance (like +@hickwell.some_method+).
427
+
428
+ h4. Add a Class Method
429
+
430
+ This plugin will expect that you've added a method to your model named 'last_squawk'. However, the plugin users might have already defined a method on their model named 'last_squawk' that they use for something else. This plugin will allow the name to be changed by adding a class method called 'yaffle_text_field'.
431
+
432
+ To start out, write a failing test that shows the behavior you'd like:
433
+
434
+ * *vendor/plugins/yaffle/test/acts_as_yaffle_test.rb*
435
+
436
+ <ruby>
437
+ require File.dirname(__FILE__) + '/test_helper.rb'
438
+
439
+ class Hickwall < ActiveRecord::Base
440
+ acts_as_yaffle
441
+ end
442
+
443
+ class Wickwall < ActiveRecord::Base
444
+ acts_as_yaffle :yaffle_text_field => :last_tweet
445
+ end
446
+
447
+ class ActsAsYaffleTest < Test::Unit::TestCase
448
+ load_schema
449
+
450
+ def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
451
+ assert_equal "last_squawk", Hickwall.yaffle_text_field
452
+ end
453
+
454
+ def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
455
+ assert_equal "last_tweet", Wickwall.yaffle_text_field
456
+ end
457
+ end
458
+ </ruby>
459
+
460
+ To make these tests pass, you could modify your +acts_as_yaffle+ file like so:
461
+
462
+ * *vendor/plugins/yaffle/lib/yaffle/acts_as_yaffle.rb*
463
+
464
+ <ruby>
465
+ module Yaffle
466
+ def self.included(base)
467
+ base.send :extend, ClassMethods
468
+ end
469
+
470
+ module ClassMethods
471
+ def acts_as_yaffle(options = {})
472
+ cattr_accessor :yaffle_text_field
473
+ self.yaffle_text_field = (options[:yaffle_text_field] || :last_squawk).to_s
474
+ end
475
+ end
476
+ end
477
+
478
+ ActiveRecord::Base.send :include, Yaffle
479
+ </ruby>
480
+
481
+ h4. Add an Instance Method
482
+
483
+ This plugin will add a method named 'squawk' to any Active Record objects that call 'acts_as_yaffle'. The 'squawk' method will simply set the value of one of the fields in the database.
484
+
485
+ To start out, write a failing test that shows the behavior you'd like:
486
+
487
+ * *vendor/plugins/yaffle/test/acts_as_yaffle_test.rb*
488
+
489
+ <ruby>
490
+ require File.dirname(__FILE__) + '/test_helper.rb'
491
+
492
+ class Hickwall < ActiveRecord::Base
493
+ acts_as_yaffle
494
+ end
495
+
496
+ class Wickwall < ActiveRecord::Base
497
+ acts_as_yaffle :yaffle_text_field => :last_tweet
498
+ end
499
+
500
+ class ActsAsYaffleTest < Test::Unit::TestCase
501
+ load_schema
502
+
503
+ def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
504
+ assert_equal "last_squawk", Hickwall.yaffle_text_field
505
+ end
506
+
507
+ def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
508
+ assert_equal "last_tweet", Wickwall.yaffle_text_field
509
+ end
510
+
511
+ def test_hickwalls_squawk_should_populate_last_squawk
512
+ hickwall = Hickwall.new
513
+ hickwall.squawk("Hello World")
514
+ assert_equal "squawk! Hello World", hickwall.last_squawk
515
+ end
516
+
517
+ def test_wickwalls_squawk_should_populate_last_tweeted_at
518
+ wickwall = Wickwall.new
519
+ wickwall.squawk("Hello World")
520
+ assert_equal "squawk! Hello World", wickwall.last_tweet
521
+ end
522
+ end
523
+ </ruby>
524
+
525
+ Run this test to make sure the last two tests fail, then update 'acts_as_yaffle.rb' to look like this:
526
+
527
+ * *vendor/plugins/yaffle/lib/yaffle/acts_as_yaffle.rb*
528
+
529
+ <ruby>
530
+ module Yaffle
531
+ def self.included(base)
532
+ base.send :extend, ClassMethods
533
+ end
534
+
535
+ module ClassMethods
536
+ def acts_as_yaffle(options = {})
537
+ cattr_accessor :yaffle_text_field
538
+ self.yaffle_text_field = (options[:yaffle_text_field] || :last_squawk).to_s
539
+ send :include, InstanceMethods
540
+ end
541
+ end
542
+
543
+ module InstanceMethods
544
+ def squawk(string)
545
+ write_attribute(self.class.yaffle_text_field, string.to_squawk)
546
+ end
547
+ end
548
+ end
549
+
550
+ ActiveRecord::Base.send :include, Yaffle
551
+ </ruby>
552
+
553
+ NOTE: The use of +write_attribute+ to write to the field in model is just one example of how a plugin can interact with the model, and will not always be the right method to use. For example, you could also use +send("#{self.class.yaffle_text_field}=", string.to_squawk)+.
554
+
555
+ h3. Models
556
+
557
+ This section describes how to add a model named 'Woodpecker' to your plugin that will behave the same as a model in your main app. When storing models, controllers, views and helpers in your plugin, it's customary to keep them in directories that match the rails directories. For this example, create a file structure like this:
558
+
559
+ <shell>
560
+ vendor/plugins/yaffle/
561
+ |-- lib
562
+ | |-- app
563
+ | | |-- controllers
564
+ | | |-- helpers
565
+ | | |-- models
566
+ | | | `-- woodpecker.rb
567
+ | | `-- views
568
+ | |-- yaffle
569
+ | | |-- acts_as_yaffle.rb
570
+ | | |-- commands.rb
571
+ | | `-- core_ext.rb
572
+ | `-- yaffle.rb
573
+ </shell>
574
+
575
+ As always, start with a test:
576
+
577
+ * *vendor/plugins/yaffle/test/woodpecker_test.rb:*
578
+
579
+ <ruby>
580
+ require File.dirname(__FILE__) + '/test_helper.rb'
581
+
582
+ class WoodpeckerTest < Test::Unit::TestCase
583
+ load_schema
584
+
585
+ def test_woodpecker
586
+ assert_kind_of Woodpecker, Woodpecker.new
587
+ end
588
+ end
589
+ </ruby>
590
+
591
+ This is just a simple test to make sure the class is being loaded correctly. After watching it fail with +rake+, you can make it pass like so:
592
+
593
+ * *vendor/plugins/yaffle/lib/yaffle.rb:*
594
+
595
+ <ruby>
596
+ %w{ models }.each do |dir|
597
+ path = File.join(File.dirname(__FILE__), 'app', dir)
598
+ $LOAD_PATH << path
599
+ ActiveSupport::Dependencies.load_paths << path
600
+ ActiveSupport::Dependencies.load_once_paths.delete(path)
601
+ end
602
+ </ruby>
603
+
604
+ Adding directories to the load path makes them appear just like files in the the main app directory - except that they are only loaded once, so you have to restart the web server to see the changes in the browser. Removing directories from the 'load_once_paths' allow those changes to picked up as soon as you save the file - without having to restart the web server. This is particularly useful as you develop the plugin.
605
+
606
+ * *vendor/plugins/yaffle/lib/app/models/woodpecker.rb:*
607
+
608
+ <ruby>
609
+ class Woodpecker < ActiveRecord::Base
610
+ end
611
+ </ruby>
612
+
613
+ Finally, add the following to your plugin's 'schema.rb':
614
+
615
+ * *vendor/plugins/yaffle/test/schema.rb:*
616
+
617
+ <ruby>
618
+ create_table :woodpeckers, :force => true do |t|
619
+ t.string :name
620
+ end
621
+ </ruby>
622
+
623
+ Now your test should be passing, and you should be able to use the Woodpecker model from within your rails app, and any changes made to it are reflected immediately when running in development mode.
624
+
625
+ h3. Controllers
626
+
627
+ This section describes how to add a controller named 'woodpeckers' to your plugin that will behave the same as a controller in your main app. This is very similar to adding a model.
628
+
629
+ You can test your plugin's controller as you would test any other controller:
630
+
631
+ * *vendor/plugins/yaffle/test/woodpeckers_controller_test.rb:*
632
+
633
+ <ruby>
634
+ require File.dirname(__FILE__) + '/test_helper.rb'
635
+ require 'woodpeckers_controller'
636
+ require 'action_controller/test_process'
637
+
638
+ class WoodpeckersController; def rescue_action(e) raise e end; end
639
+
640
+ class WoodpeckersControllerTest < Test::Unit::TestCase
641
+ def setup
642
+ @controller = WoodpeckersController.new
643
+ @request = ActionController::TestRequest.new
644
+ @response = ActionController::TestResponse.new
645
+
646
+ ActionController::Routing::Routes.draw do |map|
647
+ map.resources :woodpeckers
648
+ end
649
+ end
650
+
651
+ def test_index
652
+ get :index
653
+ assert_response :success
654
+ end
655
+ end
656
+ </ruby>
657
+
658
+ This is just a simple test to make sure the controller is being loaded correctly. After watching it fail with +rake+, you can make it pass like so:
659
+
660
+ * *vendor/plugins/yaffle/lib/yaffle.rb:*
661
+
662
+ <ruby>
663
+ %w{ models controllers }.each do |dir|
664
+ path = File.join(File.dirname(__FILE__), 'app', dir)
665
+ $LOAD_PATH << path
666
+ ActiveSupport::Dependencies.load_paths << path
667
+ ActiveSupport::Dependencies.load_once_paths.delete(path)
668
+ end
669
+ </ruby>
670
+
671
+ * *vendor/plugins/yaffle/lib/app/controllers/woodpeckers_controller.rb:*
672
+
673
+ <ruby>
674
+ class WoodpeckersController < ActionController::Base
675
+
676
+ def index
677
+ render :text => "Squawk!"
678
+ end
679
+
680
+ end
681
+ </ruby>
682
+
683
+ Now your test should be passing, and you should be able to use the Woodpeckers controller in your app. If you add a route for the woodpeckers controller you can start up your server and go to http://localhost:3000/woodpeckers to see your controller in action.
684
+
685
+ h3. Helpers
686
+
687
+ This section describes how to add a helper named 'WoodpeckersHelper' to your plugin that will behave the same as a helper in your main app. This is very similar to adding a model and a controller.
688
+
689
+ You can test your plugin's helper as you would test any other helper:
690
+
691
+ * *vendor/plugins/yaffle/test/woodpeckers_helper_test.rb*
692
+
693
+ <ruby>
694
+ require File.dirname(__FILE__) + '/test_helper.rb'
695
+ include WoodpeckersHelper
696
+
697
+ class WoodpeckersHelperTest < Test::Unit::TestCase
698
+ def test_tweet
699
+ assert_equal "Tweet! Hello", tweet("Hello")
700
+ end
701
+ end
702
+ </ruby>
703
+
704
+ This is just a simple test to make sure the helper is being loaded correctly. After watching it fail with +rake+, you can make it pass like so:
705
+
706
+ * *vendor/plugins/yaffle/lib/yaffle.rb:*
707
+
708
+ <ruby>
709
+ %w{ models controllers helpers }.each do |dir|
710
+ path = File.join(File.dirname(__FILE__), 'app', dir)
711
+ $LOAD_PATH << path
712
+ ActiveSupport::Dependencies.load_paths << path
713
+ ActiveSupport::Dependencies.load_once_paths.delete(path)
714
+ end
715
+ </ruby>
716
+
717
+ * *vendor/plugins/yaffle/lib/app/helpers/woodpeckers_helper.rb:*
718
+
719
+ <ruby>
720
+ module WoodpeckersHelper
721
+
722
+ def tweet(text)
723
+ "Tweet! #{text}"
724
+ end
725
+
726
+ end
727
+ </ruby>
728
+
729
+ Now your test should be passing, and you should be able to use the Woodpeckers helper in your app.
730
+
731
+ h3. Routes
732
+
733
+ In a standard 'routes.rb' file you use routes like 'map.connect' or 'map.resources'. You can add your own custom routes from a plugin. This section will describe how to add a custom method called that can be called with 'map.yaffles'.
734
+
735
+ Testing routes from plugins is slightly different from testing routes in a standard rails app. To begin, add a test like this:
736
+
737
+ * *vendor/plugins/yaffle/test/routing_test.rb*
738
+
739
+ <ruby>
740
+ require "#{File.dirname(__FILE__)}/test_helper"
741
+
742
+ class RoutingTest < Test::Unit::TestCase
743
+
744
+ def setup
745
+ ActionController::Routing::Routes.draw do |map|
746
+ map.yaffles
747
+ end
748
+ end
749
+
750
+ def test_yaffles_route
751
+ assert_recognition :get, "/yaffles", :controller => "yaffles_controller", :action => "index"
752
+ end
753
+
754
+ private
755
+
756
+ def assert_recognition(method, path, options)
757
+ result = ActionController::Routing::Routes.recognize_path(path, :method => method)
758
+ assert_equal options, result
759
+ end
760
+ end
761
+ </ruby>
762
+
763
+ Once you see the tests fail by running 'rake', you can make them pass with:
764
+
765
+ * *vendor/plugins/yaffle/lib/yaffle.rb*
766
+
767
+ <ruby>
768
+ require "yaffle/routing"
769
+ </ruby>
770
+
771
+ * *vendor/plugins/yaffle/lib/yaffle/routing.rb*
772
+
773
+ <ruby>
774
+ module Yaffle #:nodoc:
775
+ module Routing #:nodoc:
776
+ module MapperExtensions
777
+ def yaffles
778
+ @set.add_route("/yaffles", {:controller => "yaffles_controller", :action => "index"})
779
+ end
780
+ end
781
+ end
782
+ end
783
+
784
+ ActionController::Routing::RouteSet::Mapper.send :include, Yaffle::Routing::MapperExtensions
785
+ </ruby>
786
+
787
+ * *config/routes.rb*
788
+
789
+ <ruby>
790
+ ActionController::Routing::Routes.draw do |map|
791
+ map.yaffles
792
+ end
793
+ </ruby>
794
+
795
+ You can also see if your routes work by running +rake routes+ from your app directory.
796
+
797
+ h3. Generators
798
+
799
+ Many plugins ship with generators. When you created the plugin above, you specified the +--with-generator+ option, so you already have the generator stubs in 'vendor/plugins/yaffle/generators/yaffle'.
800
+
801
+ Building generators is a complex topic unto itself and this section will cover one small aspect of generators: generating a simple text file.
802
+
803
+ h4. Testing Generators
804
+
805
+ Many rails plugin authors do not test their generators, however testing generators is quite simple. A typical generator test does the following:
806
+
807
+ * Creates a new fake rails root directory that will serve as destination
808
+ * Runs the generator
809
+ * Asserts that the correct files were generated
810
+ * Removes the fake rails root
811
+
812
+ This section will describe how to create a simple generator that adds a file. For the generator in this section, the test could look something like this:
813
+
814
+ * *vendor/plugins/yaffle/test/definition_generator_test.rb*
815
+
816
+ <ruby>
817
+ require File.dirname(__FILE__) + '/test_helper.rb'
818
+ require 'rails_generator'
819
+ require 'rails_generator/scripts/generate'
820
+
821
+ class DefinitionGeneratorTest < Test::Unit::TestCase
822
+
823
+ def setup
824
+ FileUtils.mkdir_p(fake_rails_root)
825
+ @original_files = file_list
826
+ end
827
+
828
+ def teardown
829
+ FileUtils.rm_r(fake_rails_root)
830
+ end
831
+
832
+ def test_generates_correct_file_name
833
+ Rails::Generator::Scripts::Generate.new.run(["yaffle_definition"], :destination => fake_rails_root)
834
+ new_file = (file_list - @original_files).first
835
+ assert_equal "definition.txt", File.basename(new_file)
836
+ end
837
+
838
+ private
839
+
840
+ def fake_rails_root
841
+ File.join(File.dirname(__FILE__), 'rails_root')
842
+ end
843
+
844
+ def file_list
845
+ Dir.glob(File.join(fake_rails_root, "*"))
846
+ end
847
+
848
+ end
849
+ </ruby>
850
+
851
+ You can run 'rake' from the plugin directory to see this fail. Unless you are doing more advanced generator commands it typically suffices to just test the Generate script, and trust that rails will handle the Destroy and Update commands for you.
852
+
853
+ To make it pass, create the generator:
854
+
855
+ * *vendor/plugins/yaffle/generators/yaffle_definition/yaffle_definition_generator.rb*
856
+
857
+ <ruby>
858
+ class YaffleDefinitionGenerator < Rails::Generator::Base
859
+ def manifest
860
+ record do |m|
861
+ m.file "definition.txt", "definition.txt"
862
+ end
863
+ end
864
+ end
865
+ </ruby>
866
+
867
+ h4. The +USAGE+ File
868
+
869
+ If you plan to distribute your plugin, developers will expect at least a minimum of documentation. You can add simple documentation to the generator by updating the USAGE file.
870
+
871
+ Rails ships with several built-in generators. You can see all of the generators available to you by typing the following at the command line:
872
+
873
+ <shell>
874
+ ./script/generate
875
+ </shell>
876
+
877
+ You should see something like this:
878
+
879
+ <shell>
880
+ Installed Generators
881
+ Plugins (vendor/plugins): yaffle_definition
882
+ Builtin: controller, integration_test, mailer, migration, model, observer, plugin, resource, scaffold, session_migration
883
+ </shell>
884
+
885
+ When you run +script/generate yaffle_definition -h+ you should see the contents of your 'vendor/plugins/yaffle/generators/yaffle_definition/USAGE'.
886
+
887
+ For this plugin, update the USAGE file could look like this:
888
+
889
+ <shell>
890
+ Description:
891
+ Adds a file with the definition of a Yaffle to the app's main directory
892
+ </shell>
893
+
894
+ h3. Add a Custom Generator Command
895
+
896
+ You may have noticed above that you can used one of the built-in rails migration commands +migration_template+. If your plugin needs to add and remove lines of text from existing files you will need to write your own generator methods.
897
+
898
+ This section describes how you you can create your own commands to add and remove a line of text from 'routes.rb'. This example creates a very simple method that adds or removes a text file.
899
+
900
+ To start, add the following test method:
901
+
902
+ * *vendor/plugins/yaffle/test/generator_test.rb*
903
+
904
+ <ruby>
905
+ def test_generates_definition
906
+ Rails::Generator::Scripts::Generate.new.run(["yaffle", "bird"], :destination => fake_rails_root)
907
+ definition = File.read(File.join(fake_rails_root, "definition.txt"))
908
+ assert_match /Yaffle\:/, definition
909
+ end
910
+ </ruby>
911
+
912
+ Run +rake+ to watch the test fail, then make the test pass add the following:
913
+
914
+ * *vendor/plugins/yaffle/generators/yaffle/templates/definition.txt*
915
+
916
+ <shell>
917
+ Yaffle: A bird
918
+ </shell>
919
+
920
+ * *vendor/plugins/yaffle/lib/yaffle.rb*
921
+
922
+ <ruby>
923
+ require "yaffle/commands"
924
+ </ruby>
925
+
926
+ * *vendor/plugins/yaffle/lib/commands.rb*
927
+
928
+ <ruby>
929
+ require 'rails_generator'
930
+ require 'rails_generator/commands'
931
+
932
+ module Yaffle #:nodoc:
933
+ module Generator #:nodoc:
934
+ module Commands #:nodoc:
935
+ module Create
936
+ def yaffle_definition
937
+ file("definition.txt", "definition.txt")
938
+ end
939
+ end
940
+
941
+ module Destroy
942
+ def yaffle_definition
943
+ file("definition.txt", "definition.txt")
944
+ end
945
+ end
946
+
947
+ module List
948
+ def yaffle_definition
949
+ file("definition.txt", "definition.txt")
950
+ end
951
+ end
952
+
953
+ module Update
954
+ def yaffle_definition
955
+ file("definition.txt", "definition.txt")
956
+ end
957
+ end
958
+ end
959
+ end
960
+ end
961
+
962
+ Rails::Generator::Commands::Create.send :include, Yaffle::Generator::Commands::Create
963
+ Rails::Generator::Commands::Destroy.send :include, Yaffle::Generator::Commands::Destroy
964
+ Rails::Generator::Commands::List.send :include, Yaffle::Generator::Commands::List
965
+ Rails::Generator::Commands::Update.send :include, Yaffle::Generator::Commands::Update
966
+ </ruby>
967
+
968
+ Finally, call your new method in the manifest:
969
+
970
+ * *vendor/plugins/yaffle/generators/yaffle/yaffle_generator.rb*
971
+
972
+ <ruby>
973
+ class YaffleGenerator < Rails::Generator::NamedBase
974
+ def manifest
975
+ m.yaffle_definition
976
+ end
977
+ end
978
+ </ruby>
979
+
980
+ h3. Generator Commands
981
+
982
+ You may have noticed above that you can used one of the built-in rails migration commands +migration_template+. If your plugin needs to add and remove lines of text from existing files you will need to write your own generator methods.
983
+
984
+ This section describes how you you can create your own commands to add and remove a line of text from 'config/routes.rb'.
985
+
986
+ To start, add the following test method:
987
+
988
+ * *vendor/plugins/yaffle/test/route_generator_test.rb*
989
+
990
+ <ruby>
991
+ require File.dirname(__FILE__) + '/test_helper.rb'
992
+ require 'rails_generator'
993
+ require 'rails_generator/scripts/generate'
994
+ require 'rails_generator/scripts/destroy'
995
+
996
+ class RouteGeneratorTest < Test::Unit::TestCase
997
+
998
+ def setup
999
+ FileUtils.mkdir_p(File.join(fake_rails_root, "config"))
1000
+ end
1001
+
1002
+ def teardown
1003
+ FileUtils.rm_r(fake_rails_root)
1004
+ end
1005
+
1006
+ def test_generates_route
1007
+ content = <<-END
1008
+ ActionController::Routing::Routes.draw do |map|
1009
+ map.connect ':controller/:action/:id'
1010
+ map.connect ':controller/:action/:id.:format'
1011
+ end
1012
+ END
1013
+ File.open(routes_path, 'wb') {|f| f.write(content) }
1014
+
1015
+ Rails::Generator::Scripts::Generate.new.run(["yaffle_route"], :destination => fake_rails_root)
1016
+ assert_match /map\.yaffles/, File.read(routes_path)
1017
+ end
1018
+
1019
+ def test_destroys_route
1020
+ content = <<-END
1021
+ ActionController::Routing::Routes.draw do |map|
1022
+ map.yaffles
1023
+ map.connect ':controller/:action/:id'
1024
+ map.connect ':controller/:action/:id.:format'
1025
+ end
1026
+ END
1027
+ File.open(routes_path, 'wb') {|f| f.write(content) }
1028
+
1029
+ Rails::Generator::Scripts::Destroy.new.run(["yaffle_route"], :destination => fake_rails_root)
1030
+ assert_no_match /map\.yaffles/, File.read(routes_path)
1031
+ end
1032
+
1033
+ private
1034
+
1035
+ def fake_rails_root
1036
+ File.join(File.dirname(__FILE__), "rails_root")
1037
+ end
1038
+
1039
+ def routes_path
1040
+ File.join(fake_rails_root, "config", "routes.rb")
1041
+ end
1042
+
1043
+ end
1044
+ </ruby>
1045
+
1046
+ Run +rake+ to watch the test fail, then make the test pass add the following:
1047
+
1048
+ * *vendor/plugins/yaffle/lib/yaffle.rb*
1049
+
1050
+ <ruby>
1051
+ require "yaffle/commands"
1052
+ </ruby>
1053
+
1054
+ * *vendor/plugins/yaffle/lib/yaffle/commands.rb*
1055
+
1056
+ <ruby>
1057
+ require 'rails_generator'
1058
+ require 'rails_generator/commands'
1059
+
1060
+ module Yaffle #:nodoc:
1061
+ module Generator #:nodoc:
1062
+ module Commands #:nodoc:
1063
+ module Create
1064
+ def yaffle_route
1065
+ logger.route "map.yaffle"
1066
+ look_for = 'ActionController::Routing::Routes.draw do |map|'
1067
+ unless options[:pretend]
1068
+ gsub_file('config/routes.rb', /(#{Regexp.escape(look_for)})/mi){|match| "#{match}\n map.yaffles\n"}
1069
+ end
1070
+ end
1071
+ end
1072
+
1073
+ module Destroy
1074
+ def yaffle_route
1075
+ logger.route "map.yaffle"
1076
+ gsub_file 'config/routes.rb', /\n.+?map\.yaffles/mi, ''
1077
+ end
1078
+ end
1079
+
1080
+ module List
1081
+ def yaffle_route
1082
+ end
1083
+ end
1084
+
1085
+ module Update
1086
+ def yaffle_route
1087
+ end
1088
+ end
1089
+ end
1090
+ end
1091
+ end
1092
+
1093
+ Rails::Generator::Commands::Create.send :include, Yaffle::Generator::Commands::Create
1094
+ Rails::Generator::Commands::Destroy.send :include, Yaffle::Generator::Commands::Destroy
1095
+ Rails::Generator::Commands::List.send :include, Yaffle::Generator::Commands::List
1096
+ Rails::Generator::Commands::Update.send :include, Yaffle::Generator::Commands::Update
1097
+ </ruby>
1098
+
1099
+ * *vendor/plugins/yaffle/generators/yaffle_route/yaffle_route_generator.rb*
1100
+
1101
+ <ruby>
1102
+ class YaffleRouteGenerator < Rails::Generator::Base
1103
+ def manifest
1104
+ record do |m|
1105
+ m.yaffle_route
1106
+ end
1107
+ end
1108
+ end
1109
+ </ruby>
1110
+
1111
+ To see this work, type:
1112
+
1113
+ <shell>
1114
+ ./script/generate yaffle_route
1115
+ ./script/destroy yaffle_route
1116
+ </shell>
1117
+
1118
+ NOTE: If you haven't set up the custom route from above, 'script/destroy' will fail and you'll have to remove it manually.
1119
+
1120
+ h3. Migrations
1121
+
1122
+ If your plugin requires changes to the app's database you will likely want to somehow add migrations. Rails does not include any built-in support for calling migrations from plugins, but you can still make it easy for developers to call migrations from plugins.
1123
+
1124
+ If you have a very simple needs, like creating a table that will always have the same name and columns, then you can use a more simple solution, like creating a custom rake task or method. If your migration needs user input to supply table names or other options, you probably want to opt for generating a migration.
1125
+
1126
+ Let's say you have the following migration in your plugin:
1127
+
1128
+ * *vendor/plugins/yaffle/lib/db/migrate/20081116181115_create_birdhouses.rb:*
1129
+
1130
+ <ruby>
1131
+ class CreateBirdhouses < ActiveRecord::Migration
1132
+ def self.up
1133
+ create_table :birdhouses, :force => true do |t|
1134
+ t.string :name
1135
+ t.timestamps
1136
+ end
1137
+ end
1138
+
1139
+ def self.down
1140
+ drop_table :birdhouses
1141
+ end
1142
+ end
1143
+ </ruby>
1144
+
1145
+ Here are a few possibilities for how to allow developers to use your plugin migrations:
1146
+
1147
+ h4. Create a Custom Rake Task
1148
+
1149
+ * *vendor/plugins/yaffle/tasks/yaffle_tasks.rake:*
1150
+
1151
+ <ruby>
1152
+ namespace :db do
1153
+ namespace :migrate do
1154
+ description = "Migrate the database through scripts in vendor/plugins/yaffle/lib/db/migrate"
1155
+ description << "and update db/schema.rb by invoking db:schema:dump."
1156
+ description << "Target specific version with VERSION=x. Turn off output with VERBOSE=false."
1157
+
1158
+ desc description
1159
+ task :yaffle => :environment do
1160
+ ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
1161
+ ActiveRecord::Migrator.migrate("vendor/plugins/yaffle/lib/db/migrate/", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
1162
+ Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
1163
+ end
1164
+ end
1165
+ end
1166
+ </ruby>
1167
+
1168
+ h4. Call Migrations Directly
1169
+
1170
+ * *vendor/plugins/yaffle/lib/yaffle.rb:*
1171
+
1172
+ <ruby>
1173
+ Dir.glob(File.join(File.dirname(__FILE__), "db", "migrate", "*")).each do |file|
1174
+ require file
1175
+ end
1176
+ </ruby>
1177
+
1178
+ * *db/migrate/20081116181115_create_birdhouses.rb:*
1179
+
1180
+ <ruby>
1181
+ class CreateBirdhouses < ActiveRecord::Migration
1182
+ def self.up
1183
+ Yaffle::CreateBirdhouses.up
1184
+ end
1185
+
1186
+ def self.down
1187
+ Yaffle::CreateBirdhouses.down
1188
+ end
1189
+ end
1190
+ </ruby>
1191
+
1192
+ NOTE: several plugin frameworks such as Desert and Engines provide more advanced plugin functionality.
1193
+
1194
+ h4. Generate Migrations
1195
+
1196
+ Generating migrations has several advantages over other methods. Namely, you can allow other developers to more easily customize the migration. The flow looks like this:
1197
+
1198
+ * call your script/generate script and pass in whatever options they need
1199
+ * examine the generated migration, adding/removing columns or other options as necessary
1200
+
1201
+ This example will demonstrate how to use one of the built-in generator methods named 'migration_template' to create a migration file. Extending the rails migration generator requires a somewhat intimate knowledge of the migration generator internals, so it's best to write a test first:
1202
+
1203
+ * *vendor/plugins/yaffle/test/yaffle_migration_generator_test.rb*
1204
+
1205
+ <ruby>
1206
+ require File.dirname(__FILE__) + '/test_helper.rb'
1207
+ require 'rails_generator'
1208
+ require 'rails_generator/scripts/generate'
1209
+
1210
+ class MigrationGeneratorTest < Test::Unit::TestCase
1211
+
1212
+ def setup
1213
+ FileUtils.mkdir_p(fake_rails_root)
1214
+ @original_files = file_list
1215
+ end
1216
+
1217
+ def teardown
1218
+ ActiveRecord::Base.pluralize_table_names = true
1219
+ FileUtils.rm_r(fake_rails_root)
1220
+ end
1221
+
1222
+ def test_generates_correct_file_name
1223
+ Rails::Generator::Scripts::Generate.new.run(["yaffle_migration", "some_name_nobody_is_likely_to_ever_use_in_a_real_migration"],
1224
+ :destination => fake_rails_root)
1225
+ new_file = (file_list - @original_files).first
1226
+ assert_match /add_yaffle_fields_to_some_name_nobody_is_likely_to_ever_use_in_a_real_migrations/, new_file
1227
+ assert_match /add_column :some_name_nobody_is_likely_to_ever_use_in_a_real_migrations do |t|/, File.read(new_file)
1228
+ end
1229
+
1230
+ def test_pluralizes_properly
1231
+ ActiveRecord::Base.pluralize_table_names = false
1232
+ Rails::Generator::Scripts::Generate.new.run(["yaffle_migration", "some_name_nobody_is_likely_to_ever_use_in_a_real_migration"],
1233
+ :destination => fake_rails_root)
1234
+ new_file = (file_list - @original_files).first
1235
+ assert_match /add_yaffle_fields_to_some_name_nobody_is_likely_to_ever_use_in_a_real_migration/, new_file
1236
+ assert_match /add_column :some_name_nobody_is_likely_to_ever_use_in_a_real_migration do |t|/, File.read(new_file)
1237
+ end
1238
+
1239
+ private
1240
+ def fake_rails_root
1241
+ File.join(File.dirname(__FILE__), 'rails_root')
1242
+ end
1243
+
1244
+ def file_list
1245
+ Dir.glob(File.join(fake_rails_root, "db", "migrate", "*"))
1246
+ end
1247
+
1248
+ end
1249
+ </ruby>
1250
+
1251
+ NOTE: the migration generator checks to see if a migation already exists, and it's hard-coded to check the 'db/migrate' directory. As a result, if your test tries to generate a migration that already exists in the app, it will fail. The easy workaround is to make sure that the name you generate in your test is very unlikely to actually appear in the app.
1252
+
1253
+ After running the test with 'rake' you can make it pass with:
1254
+
1255
+ * *vendor/plugins/yaffle/generators/yaffle_migration/yaffle_migration_generator.rb*
1256
+
1257
+ <ruby>
1258
+ class YaffleMigrationGenerator < Rails::Generator::NamedBase
1259
+ def manifest
1260
+ record do |m|
1261
+ m.migration_template 'migration:migration.rb', "db/migrate", {:assigns => yaffle_local_assigns,
1262
+ :migration_file_name => "add_yaffle_fields_to_#{custom_file_name}"
1263
+ }
1264
+ end
1265
+ end
1266
+
1267
+ private
1268
+ def custom_file_name
1269
+ custom_name = class_name.underscore.downcase
1270
+ custom_name = custom_name.pluralize if ActiveRecord::Base.pluralize_table_names
1271
+ custom_name
1272
+ end
1273
+
1274
+ def yaffle_local_assigns
1275
+ returning(assigns = {}) do
1276
+ assigns[:migration_action] = "add"
1277
+ assigns[:class_name] = "add_yaffle_fields_to_#{custom_file_name}"
1278
+ assigns[:table_name] = custom_file_name
1279
+ assigns[:attributes] = [Rails::Generator::GeneratedAttribute.new("last_squawk", "string")]
1280
+ end
1281
+ end
1282
+ end
1283
+ </ruby>
1284
+
1285
+ The generator creates a new file in 'db/migrate' with a timestamp and an 'add_column' statement. It reuses the built in rails +migration_template+ method, and reuses the built-in rails migration template.
1286
+
1287
+ It's courteous to check to see if table names are being pluralized whenever you create a generator that needs to be aware of table names. This way people using your generator won't have to manually change the generated files if they've turned pluralization off.
1288
+
1289
+ To run the generator, type the following at the command line:
1290
+
1291
+ <shell>
1292
+ ./script/generate yaffle_migration bird
1293
+ </shell>
1294
+
1295
+ and you will see a new file:
1296
+
1297
+ * *db/migrate/20080529225649_add_yaffle_fields_to_birds.rb*
1298
+
1299
+ <ruby>
1300
+ class AddYaffleFieldsToBirds < ActiveRecord::Migration
1301
+ def self.up
1302
+ add_column :birds, :last_squawk, :string
1303
+ end
1304
+
1305
+ def self.down
1306
+ remove_column :birds, :last_squawk
1307
+ end
1308
+ end
1309
+ </ruby>
1310
+
1311
+ h3. Rake tasks
1312
+
1313
+ When you created the plugin with the built-in rails generator, it generated a rake file for you in 'vendor/plugins/yaffle/tasks/yaffle_tasks.rake'. Any rake task you add here will be available to the app.
1314
+
1315
+ Many plugin authors put all of their rake tasks into a common namespace that is the same as the plugin, like so:
1316
+
1317
+ * *vendor/plugins/yaffle/tasks/yaffle_tasks.rake*
1318
+
1319
+ <ruby>
1320
+ namespace :yaffle do
1321
+ desc "Prints out the word 'Yaffle'"
1322
+ task :squawk => :environment do
1323
+ puts "squawk!"
1324
+ end
1325
+ end
1326
+ </ruby>
1327
+
1328
+ When you run +rake -T+ from your plugin you will see:
1329
+
1330
+ <shell>
1331
+ yaffle:squawk # Prints out the word 'Yaffle'
1332
+ </shell>
1333
+
1334
+ You can add as many files as you want in the tasks directory, and if they end in .rake Rails will pick them up.
1335
+
1336
+ Note that tasks from 'vendor/plugins/yaffle/Rakefile' are not available to the main app.
1337
+
1338
+ h3. PluginGems
1339
+
1340
+ Turning your rails plugin into a gem is a simple and straightforward task. This section will cover how to turn your plugin into a gem. It will not cover how to distribute that gem.
1341
+
1342
+ Historically rails plugins loaded the plugin's 'init.rb' file. In fact some plugins contain all of their code in that one file. To be compatible with plugins, 'init.rb' was moved to 'rails/init.rb'.
1343
+
1344
+ It's common practice to put any developer-centric rake tasks (such as tests, rdoc and gem package tasks) in 'Rakefile'. A rake task that packages the gem might look like this:
1345
+
1346
+ * *vendor/plugins/yaffle/Rakefile:*
1347
+
1348
+ <ruby>
1349
+ PKG_FILES = FileList[
1350
+ '[a-zA-Z]*',
1351
+ 'generators/**/*',
1352
+ 'lib/**/*',
1353
+ 'rails/**/*',
1354
+ 'tasks/**/*',
1355
+ 'test/**/*'
1356
+ ]
1357
+
1358
+ spec = Gem::Specification.new do |s|
1359
+ s.name = "yaffle"
1360
+ s.version = "0.0.1"
1361
+ s.author = "Gleeful Yaffler"
1362
+ s.email = "yaffle@example.com"
1363
+ s.homepage = "http://yafflers.example.com/"
1364
+ s.platform = Gem::Platform::RUBY
1365
+ s.summary = "Sharing Yaffle Goodness"
1366
+ s.files = PKG_FILES.to_a
1367
+ s.require_path = "lib"
1368
+ s.has_rdoc = false
1369
+ s.extra_rdoc_files = ["README"]
1370
+ end
1371
+
1372
+ desc 'Turn this plugin into a gem.'
1373
+ Rake::GemPackageTask.new(spec) do |pkg|
1374
+ pkg.gem_spec = spec
1375
+ end
1376
+ </ruby>
1377
+
1378
+ To build and install the gem locally, run the following commands:
1379
+
1380
+ <shell>
1381
+ cd vendor/plugins/yaffle
1382
+ rake gem
1383
+ sudo gem install pkg/yaffle-0.0.1.gem
1384
+ </shell>
1385
+
1386
+ To test this, create a new rails app, add 'config.gem "yaffle"' to environment.rb and all of your plugin's functionality will be available to you.
1387
+
1388
+ h3. RDoc Documentation
1389
+
1390
+ Once your plugin is stable and you are ready to deploy do everyone else a favor and document it! Luckily, writing documentation for your plugin is easy.
1391
+
1392
+ The first step is to update the README file with detailed information about how to use your plugin. A few key things to include are:
1393
+
1394
+ * Your name
1395
+ * How to install
1396
+ * How to add the functionality to the app (several examples of common use cases)
1397
+ * Warning, gotchas or tips that might help save users time
1398
+
1399
+ Once your README is solid, go through and add rdoc comments to all of the methods that developers will use. It's also customary to add '#:nodoc:' comments to those parts of the code that are not part of the public api.
1400
+
1401
+ Once your comments are good to go, navigate to your plugin directory and run:
1402
+
1403
+ <shell>
1404
+ rake rdoc
1405
+ </shell>
1406
+
1407
+ h3. Appendix
1408
+
1409
+ If you prefer to use RSpec instead of Test::Unit, you may be interested in the "RSpec Plugin Generator":http://github.com/pat-maddox/rspec-plugin-generator/tree/master.
1410
+
1411
+ h4. References
1412
+
1413
+ * http://nubyonrails.com/articles/the-complete-guide-to-rails-plugins-part-i
1414
+ * http://nubyonrails.com/articles/the-complete-guide-to-rails-plugins-part-ii
1415
+ * http://github.com/technoweenie/attachment_fu/tree/master
1416
+ * http://daddy.platte.name/2007/05/rails-plugins-keep-initrb-thin.html
1417
+ * http://www.mbleigh.com/2008/6/11/gemplugins-a-brief-introduction-to-the-future-of-rails-plugins
1418
+ * http://weblog.jamisbuck.org/2006/10/26/monkey-patching-rails-extending-routes-2.
1419
+
1420
+ h4. Contents of +lib/yaffle.rb+
1421
+
1422
+ * *vendor/plugins/yaffle/lib/yaffle.rb:*
1423
+
1424
+ <ruby>
1425
+ require "yaffle/core_ext"
1426
+ require "yaffle/acts_as_yaffle"
1427
+ require "yaffle/commands"
1428
+ require "yaffle/routing"
1429
+
1430
+ %w{ models controllers helpers }.each do |dir|
1431
+ path = File.join(File.dirname(__FILE__), 'app', dir)
1432
+ $LOAD_PATH << path
1433
+ ActiveSupport::Dependencies.load_paths << path
1434
+ ActiveSupport::Dependencies.load_once_paths.delete(path)
1435
+ end
1436
+
1437
+ # optionally:
1438
+ # Dir.glob(File.join(File.dirname(__FILE__), "db", "migrate", "*")).each do |file|
1439
+ # require file
1440
+ # end
1441
+ </ruby>
1442
+
1443
+ h4. Final Plugin Directory Structure
1444
+
1445
+ The final plugin should have a directory structure that looks something like this:
1446
+
1447
+ <shell>
1448
+ |-- MIT-LICENSE
1449
+ |-- README
1450
+ |-- Rakefile
1451
+ |-- generators
1452
+ | |-- yaffle_definition
1453
+ | | |-- USAGE
1454
+ | | |-- templates
1455
+ | | | `-- definition.txt
1456
+ | | `-- yaffle_definition_generator.rb
1457
+ | |-- yaffle_migration
1458
+ | | |-- USAGE
1459
+ | | |-- templates
1460
+ | | `-- yaffle_migration_generator.rb
1461
+ | `-- yaffle_route
1462
+ | |-- USAGE
1463
+ | |-- templates
1464
+ | `-- yaffle_route_generator.rb
1465
+ |-- install.rb
1466
+ |-- lib
1467
+ | |-- app
1468
+ | | |-- controllers
1469
+ | | | `-- woodpeckers_controller.rb
1470
+ | | |-- helpers
1471
+ | | | `-- woodpeckers_helper.rb
1472
+ | | `-- models
1473
+ | | `-- woodpecker.rb
1474
+ | |-- db
1475
+ | | `-- migrate
1476
+ | | `-- 20081116181115_create_birdhouses.rb
1477
+ | |-- yaffle
1478
+ | | |-- acts_as_yaffle.rb
1479
+ | | |-- commands.rb
1480
+ | | |-- core_ext.rb
1481
+ | | `-- routing.rb
1482
+ | `-- yaffle.rb
1483
+ |-- pkg
1484
+ | `-- yaffle-0.0.1.gem
1485
+ |-- rails
1486
+ | `-- init.rb
1487
+ |-- tasks
1488
+ | `-- yaffle_tasks.rake
1489
+ |-- test
1490
+ | |-- acts_as_yaffle_test.rb
1491
+ | |-- core_ext_test.rb
1492
+ | |-- database.yml
1493
+ | |-- debug.log
1494
+ | |-- definition_generator_test.rb
1495
+ | |-- migration_generator_test.rb
1496
+ | |-- route_generator_test.rb
1497
+ | |-- routes_test.rb
1498
+ | |-- schema.rb
1499
+ | |-- test_helper.rb
1500
+ | |-- woodpecker_test.rb
1501
+ | |-- woodpeckers_controller_test.rb
1502
+ | |-- wookpeckers_helper_test.rb
1503
+ | |-- yaffle_plugin.sqlite3.db
1504
+ | `-- yaffle_test.rb
1505
+ `-- uninstall.rb
1506
+ </shell>
1507
+
1508
+ h3. Changelog
1509
+
1510
+ "Lighthouse ticket":http://rails.lighthouseapp.com/projects/16213/tickets/32-update-plugins-guide
1511
+
1512
+ * November 17, 2008: Major revision by Jeff Dean