openskies 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (494) hide show
  1. data/CHANGELOG.md +87 -0
  2. data/README.rdoc +35 -0
  3. data/bin/openskies +9 -0
  4. data/guides/assets/images/belongs_to.png +0 -0
  5. data/guides/assets/images/book_icon.gif +0 -0
  6. data/guides/assets/images/bullet.gif +0 -0
  7. data/guides/assets/images/challenge.png +0 -0
  8. data/guides/assets/images/chapters_icon.gif +0 -0
  9. data/guides/assets/images/check_bullet.gif +0 -0
  10. data/guides/assets/images/credits_pic_blank.gif +0 -0
  11. data/guides/assets/images/csrf.png +0 -0
  12. data/guides/assets/images/customized_error_messages.png +0 -0
  13. data/guides/assets/images/edge_badge.png +0 -0
  14. data/guides/assets/images/error_messages.png +0 -0
  15. data/guides/assets/images/feature_tile.gif +0 -0
  16. data/guides/assets/images/footer_tile.gif +0 -0
  17. data/guides/assets/images/fxn.png +0 -0
  18. data/guides/assets/images/grey_bullet.gif +0 -0
  19. data/guides/assets/images/habtm.png +0 -0
  20. data/guides/assets/images/has_many.png +0 -0
  21. data/guides/assets/images/has_many_through.png +0 -0
  22. data/guides/assets/images/has_one.png +0 -0
  23. data/guides/assets/images/has_one_through.png +0 -0
  24. data/guides/assets/images/header_backdrop.png +0 -0
  25. data/guides/assets/images/header_tile.gif +0 -0
  26. data/guides/assets/images/i18n/demo_html_safe.png +0 -0
  27. data/guides/assets/images/i18n/demo_localized_pirate.png +0 -0
  28. data/guides/assets/images/i18n/demo_translated_en.png +0 -0
  29. data/guides/assets/images/i18n/demo_translated_pirate.png +0 -0
  30. data/guides/assets/images/i18n/demo_translation_missing.png +0 -0
  31. data/guides/assets/images/i18n/demo_untranslated.png +0 -0
  32. data/guides/assets/images/icons/README +5 -0
  33. data/guides/assets/images/icons/callouts/1.png +0 -0
  34. data/guides/assets/images/icons/callouts/10.png +0 -0
  35. data/guides/assets/images/icons/callouts/11.png +0 -0
  36. data/guides/assets/images/icons/callouts/12.png +0 -0
  37. data/guides/assets/images/icons/callouts/13.png +0 -0
  38. data/guides/assets/images/icons/callouts/14.png +0 -0
  39. data/guides/assets/images/icons/callouts/15.png +0 -0
  40. data/guides/assets/images/icons/callouts/2.png +0 -0
  41. data/guides/assets/images/icons/callouts/3.png +0 -0
  42. data/guides/assets/images/icons/callouts/4.png +0 -0
  43. data/guides/assets/images/icons/callouts/5.png +0 -0
  44. data/guides/assets/images/icons/callouts/6.png +0 -0
  45. data/guides/assets/images/icons/callouts/7.png +0 -0
  46. data/guides/assets/images/icons/callouts/8.png +0 -0
  47. data/guides/assets/images/icons/callouts/9.png +0 -0
  48. data/guides/assets/images/icons/caution.png +0 -0
  49. data/guides/assets/images/icons/example.png +0 -0
  50. data/guides/assets/images/icons/home.png +0 -0
  51. data/guides/assets/images/icons/important.png +0 -0
  52. data/guides/assets/images/icons/next.png +0 -0
  53. data/guides/assets/images/icons/note.png +0 -0
  54. data/guides/assets/images/icons/prev.png +0 -0
  55. data/guides/assets/images/icons/tip.png +0 -0
  56. data/guides/assets/images/icons/up.png +0 -0
  57. data/guides/assets/images/icons/warning.png +0 -0
  58. data/guides/assets/images/jaimeiniesta.jpg +0 -0
  59. data/guides/assets/images/nav_arrow.gif +0 -0
  60. data/guides/assets/images/polymorphic.png +0 -0
  61. data/guides/assets/images/posts_index.png +0 -0
  62. data/guides/assets/images/radar.png +0 -0
  63. data/guides/assets/images/rails_guides_kindle_cover.jpg +0 -0
  64. data/guides/assets/images/rails_guides_logo.gif +0 -0
  65. data/guides/assets/images/rails_logo_remix.gif +0 -0
  66. data/guides/assets/images/rails_welcome.png +0 -0
  67. data/guides/assets/images/session_fixation.png +0 -0
  68. data/guides/assets/images/tab_grey.gif +0 -0
  69. data/guides/assets/images/tab_info.gif +0 -0
  70. data/guides/assets/images/tab_note.gif +0 -0
  71. data/guides/assets/images/tab_red.gif +0 -0
  72. data/guides/assets/images/tab_yellow.gif +0 -0
  73. data/guides/assets/images/tab_yellow.png +0 -0
  74. data/guides/assets/images/validation_error_messages.png +0 -0
  75. data/guides/assets/images/vijaydev.jpg +0 -0
  76. data/guides/assets/javascripts/guides.js +7 -0
  77. data/guides/assets/javascripts/syntaxhighlighter/shBrushAS3.js +59 -0
  78. data/guides/assets/javascripts/syntaxhighlighter/shBrushAppleScript.js +75 -0
  79. data/guides/assets/javascripts/syntaxhighlighter/shBrushBash.js +59 -0
  80. data/guides/assets/javascripts/syntaxhighlighter/shBrushCSharp.js +65 -0
  81. data/guides/assets/javascripts/syntaxhighlighter/shBrushColdFusion.js +100 -0
  82. data/guides/assets/javascripts/syntaxhighlighter/shBrushCpp.js +97 -0
  83. data/guides/assets/javascripts/syntaxhighlighter/shBrushCss.js +91 -0
  84. data/guides/assets/javascripts/syntaxhighlighter/shBrushDelphi.js +55 -0
  85. data/guides/assets/javascripts/syntaxhighlighter/shBrushDiff.js +41 -0
  86. data/guides/assets/javascripts/syntaxhighlighter/shBrushErlang.js +52 -0
  87. data/guides/assets/javascripts/syntaxhighlighter/shBrushGroovy.js +67 -0
  88. data/guides/assets/javascripts/syntaxhighlighter/shBrushJScript.js +52 -0
  89. data/guides/assets/javascripts/syntaxhighlighter/shBrushJava.js +57 -0
  90. data/guides/assets/javascripts/syntaxhighlighter/shBrushJavaFX.js +58 -0
  91. data/guides/assets/javascripts/syntaxhighlighter/shBrushPerl.js +72 -0
  92. data/guides/assets/javascripts/syntaxhighlighter/shBrushPhp.js +88 -0
  93. data/guides/assets/javascripts/syntaxhighlighter/shBrushPlain.js +33 -0
  94. data/guides/assets/javascripts/syntaxhighlighter/shBrushPowerShell.js +74 -0
  95. data/guides/assets/javascripts/syntaxhighlighter/shBrushPython.js +64 -0
  96. data/guides/assets/javascripts/syntaxhighlighter/shBrushRuby.js +55 -0
  97. data/guides/assets/javascripts/syntaxhighlighter/shBrushSass.js +94 -0
  98. data/guides/assets/javascripts/syntaxhighlighter/shBrushScala.js +51 -0
  99. data/guides/assets/javascripts/syntaxhighlighter/shBrushSql.js +66 -0
  100. data/guides/assets/javascripts/syntaxhighlighter/shBrushVb.js +56 -0
  101. data/guides/assets/javascripts/syntaxhighlighter/shBrushXml.js +69 -0
  102. data/guides/assets/javascripts/syntaxhighlighter/shCore.js +17 -0
  103. data/guides/assets/stylesheets/fixes.css +16 -0
  104. data/guides/assets/stylesheets/kindle.css +11 -0
  105. data/guides/assets/stylesheets/main.css +453 -0
  106. data/guides/assets/stylesheets/print.css +52 -0
  107. data/guides/assets/stylesheets/reset.css +43 -0
  108. data/guides/assets/stylesheets/style.css +13 -0
  109. data/guides/assets/stylesheets/syntaxhighlighter/shCore.css +226 -0
  110. data/guides/assets/stylesheets/syntaxhighlighter/shCoreDefault.css +328 -0
  111. data/guides/assets/stylesheets/syntaxhighlighter/shCoreDjango.css +331 -0
  112. data/guides/assets/stylesheets/syntaxhighlighter/shCoreEclipse.css +339 -0
  113. data/guides/assets/stylesheets/syntaxhighlighter/shCoreEmacs.css +324 -0
  114. data/guides/assets/stylesheets/syntaxhighlighter/shCoreFadeToGrey.css +328 -0
  115. data/guides/assets/stylesheets/syntaxhighlighter/shCoreMDUltra.css +324 -0
  116. data/guides/assets/stylesheets/syntaxhighlighter/shCoreMidnight.css +324 -0
  117. data/guides/assets/stylesheets/syntaxhighlighter/shCoreRDark.css +324 -0
  118. data/guides/assets/stylesheets/syntaxhighlighter/shThemeDefault.css +117 -0
  119. data/guides/assets/stylesheets/syntaxhighlighter/shThemeDjango.css +120 -0
  120. data/guides/assets/stylesheets/syntaxhighlighter/shThemeEclipse.css +128 -0
  121. data/guides/assets/stylesheets/syntaxhighlighter/shThemeEmacs.css +113 -0
  122. data/guides/assets/stylesheets/syntaxhighlighter/shThemeFadeToGrey.css +117 -0
  123. data/guides/assets/stylesheets/syntaxhighlighter/shThemeMDUltra.css +113 -0
  124. data/guides/assets/stylesheets/syntaxhighlighter/shThemeMidnight.css +113 -0
  125. data/guides/assets/stylesheets/syntaxhighlighter/shThemeRDark.css +113 -0
  126. data/guides/assets/stylesheets/syntaxhighlighter/shThemeRailsGuides.css +116 -0
  127. data/guides/code/getting_started/Gemfile +38 -0
  128. data/guides/code/getting_started/README.rdoc +261 -0
  129. data/guides/code/getting_started/Rakefile +7 -0
  130. data/guides/code/getting_started/app/assets/images/rails.png +0 -0
  131. data/guides/code/getting_started/app/assets/javascripts/application.js +15 -0
  132. data/guides/code/getting_started/app/assets/javascripts/comments.js.coffee +3 -0
  133. data/guides/code/getting_started/app/assets/javascripts/home.js.coffee +3 -0
  134. data/guides/code/getting_started/app/assets/javascripts/posts.js.coffee +3 -0
  135. data/guides/code/getting_started/app/assets/stylesheets/application.css +13 -0
  136. data/guides/code/getting_started/app/assets/stylesheets/comments.css.scss +3 -0
  137. data/guides/code/getting_started/app/assets/stylesheets/home.css.scss +3 -0
  138. data/guides/code/getting_started/app/assets/stylesheets/posts.css.scss +3 -0
  139. data/guides/code/getting_started/app/assets/stylesheets/scaffolds.css.scss +56 -0
  140. data/guides/code/getting_started/app/controllers/application_controller.rb +3 -0
  141. data/guides/code/getting_started/app/controllers/comments_controller.rb +16 -0
  142. data/guides/code/getting_started/app/controllers/home_controller.rb +5 -0
  143. data/guides/code/getting_started/app/controllers/posts_controller.rb +84 -0
  144. data/guides/code/getting_started/app/helpers/application_helper.rb +2 -0
  145. data/guides/code/getting_started/app/helpers/comments_helper.rb +2 -0
  146. data/guides/code/getting_started/app/helpers/home_helper.rb +2 -0
  147. data/guides/code/getting_started/app/helpers/posts_helper.rb +5 -0
  148. data/guides/code/getting_started/app/models/comment.rb +3 -0
  149. data/guides/code/getting_started/app/models/post.rb +11 -0
  150. data/guides/code/getting_started/app/models/tag.rb +3 -0
  151. data/guides/code/getting_started/app/views/comments/_comment.html.erb +15 -0
  152. data/guides/code/getting_started/app/views/comments/_form.html.erb +13 -0
  153. data/guides/code/getting_started/app/views/home/index.html.erb +2 -0
  154. data/guides/code/getting_started/app/views/layouts/application.html.erb +14 -0
  155. data/guides/code/getting_started/app/views/posts/_form.html.erb +32 -0
  156. data/guides/code/getting_started/app/views/posts/edit.html.erb +6 -0
  157. data/guides/code/getting_started/app/views/posts/index.html.erb +27 -0
  158. data/guides/code/getting_started/app/views/posts/new.html.erb +5 -0
  159. data/guides/code/getting_started/app/views/posts/show.html.erb +31 -0
  160. data/guides/code/getting_started/app/views/tags/_form.html.erb +12 -0
  161. data/guides/code/getting_started/config/application.rb +59 -0
  162. data/guides/code/getting_started/config/boot.rb +6 -0
  163. data/guides/code/getting_started/config/database.yml +25 -0
  164. data/guides/code/getting_started/config/environment.rb +5 -0
  165. data/guides/code/getting_started/config/environments/development.rb +37 -0
  166. data/guides/code/getting_started/config/environments/production.rb +67 -0
  167. data/guides/code/getting_started/config/environments/test.rb +37 -0
  168. data/guides/code/getting_started/config/initializers/backtrace_silencers.rb +7 -0
  169. data/guides/code/getting_started/config/initializers/inflections.rb +15 -0
  170. data/guides/code/getting_started/config/initializers/mime_types.rb +5 -0
  171. data/guides/code/getting_started/config/initializers/secret_token.rb +7 -0
  172. data/guides/code/getting_started/config/initializers/session_store.rb +8 -0
  173. data/guides/code/getting_started/config/initializers/wrap_parameters.rb +14 -0
  174. data/guides/code/getting_started/config/locales/en.yml +5 -0
  175. data/guides/code/getting_started/config/routes.rb +64 -0
  176. data/guides/code/getting_started/config.ru +4 -0
  177. data/guides/code/getting_started/db/migrate/20110901012504_create_posts.rb +11 -0
  178. data/guides/code/getting_started/db/migrate/20110901012815_create_comments.rb +12 -0
  179. data/guides/code/getting_started/db/migrate/20110901013701_create_tags.rb +11 -0
  180. data/guides/code/getting_started/db/schema.rb +43 -0
  181. data/guides/code/getting_started/db/seeds.rb +7 -0
  182. data/guides/code/getting_started/doc/README_FOR_APP +2 -0
  183. data/guides/code/getting_started/public/404.html +26 -0
  184. data/guides/code/getting_started/public/422.html +26 -0
  185. data/guides/code/getting_started/public/500.html +25 -0
  186. data/guides/code/getting_started/public/favicon.ico +0 -0
  187. data/guides/code/getting_started/public/robots.txt +5 -0
  188. data/guides/code/getting_started/script/rails +6 -0
  189. data/guides/code/getting_started/test/fixtures/comments.yml +11 -0
  190. data/guides/code/getting_started/test/fixtures/posts.yml +11 -0
  191. data/guides/code/getting_started/test/fixtures/tags.yml +9 -0
  192. data/guides/code/getting_started/test/functional/comments_controller_test.rb +7 -0
  193. data/guides/code/getting_started/test/functional/home_controller_test.rb +9 -0
  194. data/guides/code/getting_started/test/functional/posts_controller_test.rb +49 -0
  195. data/guides/code/getting_started/test/performance/browsing_test.rb +12 -0
  196. data/guides/code/getting_started/test/test_helper.rb +13 -0
  197. data/guides/code/getting_started/test/unit/comment_test.rb +7 -0
  198. data/guides/code/getting_started/test/unit/helpers/comments_helper_test.rb +4 -0
  199. data/guides/code/getting_started/test/unit/helpers/home_helper_test.rb +4 -0
  200. data/guides/code/getting_started/test/unit/helpers/posts_helper_test.rb +4 -0
  201. data/guides/code/getting_started/test/unit/post_test.rb +7 -0
  202. data/guides/code/getting_started/test/unit/tag_test.rb +7 -0
  203. data/guides/rails_guides/generator.rb +310 -0
  204. data/guides/rails_guides/helpers.rb +45 -0
  205. data/guides/rails_guides/indexer.rb +69 -0
  206. data/guides/rails_guides/levenshtein.rb +31 -0
  207. data/guides/rails_guides/textile_extensions.rb +63 -0
  208. data/guides/rails_guides.rb +50 -0
  209. data/guides/source/2_2_release_notes.textile +422 -0
  210. data/guides/source/2_3_release_notes.textile +610 -0
  211. data/guides/source/3_0_release_notes.textile +595 -0
  212. data/guides/source/3_1_release_notes.textile +553 -0
  213. data/guides/source/3_2_release_notes.textile +540 -0
  214. data/guides/source/_license.html.erb +2 -0
  215. data/guides/source/_welcome.html.erb +19 -0
  216. data/guides/source/action_controller_overview.textile +820 -0
  217. data/guides/source/action_mailer_basics.textile +516 -0
  218. data/guides/source/action_view_overview.textile +1497 -0
  219. data/guides/source/active_model_basics.textile +205 -0
  220. data/guides/source/active_record_basics.textile +218 -0
  221. data/guides/source/active_record_querying.textile +1433 -0
  222. data/guides/source/active_record_validations_callbacks.textile +1283 -0
  223. data/guides/source/active_resource_basics.textile +120 -0
  224. data/guides/source/active_support_core_extensions.textile +3713 -0
  225. data/guides/source/ajax_on_rails.textile +267 -0
  226. data/guides/source/api_documentation_guidelines.textile +185 -0
  227. data/guides/source/asset_pipeline.textile +707 -0
  228. data/guides/source/association_basics.textile +1959 -0
  229. data/guides/source/caching_with_rails.textile +437 -0
  230. data/guides/source/command_line.textile +574 -0
  231. data/guides/source/configuring.textile +641 -0
  232. data/guides/source/contributing_to_ruby_on_rails.textile +448 -0
  233. data/guides/source/credits.html.erb +72 -0
  234. data/guides/source/debugging_rails_applications.textile +714 -0
  235. data/guides/source/documents.yaml +157 -0
  236. data/guides/source/engines.textile +618 -0
  237. data/guides/source/form_helpers.textile +798 -0
  238. data/guides/source/generators.textile +621 -0
  239. data/guides/source/getting_started.textile +1929 -0
  240. data/guides/source/i18n.textile +931 -0
  241. data/guides/source/index.html.erb +30 -0
  242. data/guides/source/initialization.textile +1116 -0
  243. data/guides/source/kindle/KINDLE.md +26 -0
  244. data/guides/source/kindle/copyright.html.erb +1 -0
  245. data/guides/source/kindle/layout.html.erb +27 -0
  246. data/guides/source/kindle/rails_guides.opf.erb +52 -0
  247. data/guides/source/kindle/toc.html.erb +24 -0
  248. data/guides/source/kindle/toc.ncx.erb +64 -0
  249. data/guides/source/kindle/welcome.html.erb +5 -0
  250. data/guides/source/layout.html.erb +124 -0
  251. data/guides/source/layouts_and_rendering.textile +1237 -0
  252. data/guides/source/migrations.textile +900 -0
  253. data/guides/source/nested_model_forms.textile +222 -0
  254. data/guides/source/performance_testing.textile +597 -0
  255. data/guides/source/plugins.textile +464 -0
  256. data/guides/source/rails_application_templates.textile +240 -0
  257. data/guides/source/rails_on_rack.textile +236 -0
  258. data/guides/source/routing.textile +885 -0
  259. data/guides/source/ruby_on_rails_guides_guidelines.textile +79 -0
  260. data/guides/source/security.textile +1004 -0
  261. data/guides/source/testing.textile +947 -0
  262. data/guides/w3c_validator.rb +91 -0
  263. data/lib/rails/all.rb +15 -0
  264. data/lib/rails/application/bootstrap.rb +73 -0
  265. data/lib/rails/application/configuration.rb +151 -0
  266. data/lib/rails/application/finisher.rb +98 -0
  267. data/lib/rails/application/railties.rb +13 -0
  268. data/lib/rails/application/route_inspector.rb +84 -0
  269. data/lib/rails/application/routes_reloader.rb +56 -0
  270. data/lib/rails/application.rb +320 -0
  271. data/lib/rails/backtrace_cleaner.rb +42 -0
  272. data/lib/rails/cli.rb +16 -0
  273. data/lib/rails/code_statistics.rb +118 -0
  274. data/lib/rails/commands/application.rb +38 -0
  275. data/lib/rails/commands/benchmarker.rb +34 -0
  276. data/lib/rails/commands/console.rb +55 -0
  277. data/lib/rails/commands/dbconsole.rb +123 -0
  278. data/lib/rails/commands/destroy.rb +10 -0
  279. data/lib/rails/commands/generate.rb +12 -0
  280. data/lib/rails/commands/plugin.rb +544 -0
  281. data/lib/rails/commands/plugin_new.rb +11 -0
  282. data/lib/rails/commands/profiler.rb +32 -0
  283. data/lib/rails/commands/runner.rb +54 -0
  284. data/lib/rails/commands/server.rb +100 -0
  285. data/lib/rails/commands/update.rb +9 -0
  286. data/lib/rails/commands.rb +104 -0
  287. data/lib/rails/configuration.rb +89 -0
  288. data/lib/rails/console/app.rb +36 -0
  289. data/lib/rails/console/helpers.rb +11 -0
  290. data/lib/rails/engine/commands.rb +43 -0
  291. data/lib/rails/engine/configuration.rb +84 -0
  292. data/lib/rails/engine/railties.rb +33 -0
  293. data/lib/rails/engine.rb +657 -0
  294. data/lib/rails/generators/actions.rb +325 -0
  295. data/lib/rails/generators/active_model.rb +78 -0
  296. data/lib/rails/generators/app_base.rb +281 -0
  297. data/lib/rails/generators/base.rb +390 -0
  298. data/lib/rails/generators/css/assets/assets_generator.rb +13 -0
  299. data/lib/rails/generators/css/assets/templates/stylesheet.css +4 -0
  300. data/lib/rails/generators/css/scaffold/scaffold_generator.rb +16 -0
  301. data/lib/rails/generators/erb/controller/controller_generator.rb +20 -0
  302. data/lib/rails/generators/erb/controller/templates/view.html.erb +2 -0
  303. data/lib/rails/generators/erb/mailer/mailer_generator.rb +13 -0
  304. data/lib/rails/generators/erb/mailer/templates/view.text.erb +3 -0
  305. data/lib/rails/generators/erb/scaffold/scaffold_generator.rb +29 -0
  306. data/lib/rails/generators/erb/scaffold/templates/_form.html.erb +23 -0
  307. data/lib/rails/generators/erb/scaffold/templates/edit.html.erb +6 -0
  308. data/lib/rails/generators/erb/scaffold/templates/index.html.erb +27 -0
  309. data/lib/rails/generators/erb/scaffold/templates/new.html.erb +5 -0
  310. data/lib/rails/generators/erb/scaffold/templates/show.html.erb +12 -0
  311. data/lib/rails/generators/erb.rb +21 -0
  312. data/lib/rails/generators/generated_attribute.rb +107 -0
  313. data/lib/rails/generators/js/assets/assets_generator.rb +13 -0
  314. data/lib/rails/generators/js/assets/templates/javascript.js +2 -0
  315. data/lib/rails/generators/migration.rb +68 -0
  316. data/lib/rails/generators/named_base.rb +202 -0
  317. data/lib/rails/generators/rails/app/USAGE +15 -0
  318. data/lib/rails/generators/rails/app/app_generator.rb +303 -0
  319. data/lib/rails/generators/rails/app/templates/Gemfile +26 -0
  320. data/lib/rails/generators/rails/app/templates/README +261 -0
  321. data/lib/rails/generators/rails/app/templates/Rakefile +7 -0
  322. data/lib/rails/generators/rails/app/templates/app/assets/images/rails.png +0 -0
  323. data/lib/rails/generators/rails/app/templates/app/assets/javascripts/application.js.tt +17 -0
  324. data/lib/rails/generators/rails/app/templates/app/assets/stylesheets/application.css +13 -0
  325. data/lib/rails/generators/rails/app/templates/app/controllers/application_controller.rb +3 -0
  326. data/lib/rails/generators/rails/app/templates/app/helpers/application_helper.rb +2 -0
  327. data/lib/rails/generators/rails/app/templates/app/mailers/.empty_directory +0 -0
  328. data/lib/rails/generators/rails/app/templates/app/models/.empty_directory +0 -0
  329. data/lib/rails/generators/rails/app/templates/app/views/layouts/application.html.erb.tt +14 -0
  330. data/lib/rails/generators/rails/app/templates/config/application.rb +74 -0
  331. data/lib/rails/generators/rails/app/templates/config/boot.rb +6 -0
  332. data/lib/rails/generators/rails/app/templates/config/databases/frontbase.yml +31 -0
  333. data/lib/rails/generators/rails/app/templates/config/databases/ibm_db.yml +86 -0
  334. data/lib/rails/generators/rails/app/templates/config/databases/jdbc.yml +62 -0
  335. data/lib/rails/generators/rails/app/templates/config/databases/jdbcmysql.yml +33 -0
  336. data/lib/rails/generators/rails/app/templates/config/databases/jdbcpostgresql.yml +43 -0
  337. data/lib/rails/generators/rails/app/templates/config/databases/jdbcsqlite3.yml +20 -0
  338. data/lib/rails/generators/rails/app/templates/config/databases/mysql.yml +54 -0
  339. data/lib/rails/generators/rails/app/templates/config/databases/oracle.yml +39 -0
  340. data/lib/rails/generators/rails/app/templates/config/databases/postgresql.yml +55 -0
  341. data/lib/rails/generators/rails/app/templates/config/databases/sqlite3.yml +25 -0
  342. data/lib/rails/generators/rails/app/templates/config/environment.rb +5 -0
  343. data/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt +41 -0
  344. data/lib/rails/generators/rails/app/templates/config/environments/production.rb.tt +73 -0
  345. data/lib/rails/generators/rails/app/templates/config/environments/test.rb.tt +39 -0
  346. data/lib/rails/generators/rails/app/templates/config/initializers/backtrace_silencers.rb +7 -0
  347. data/lib/rails/generators/rails/app/templates/config/initializers/inflections.rb +15 -0
  348. data/lib/rails/generators/rails/app/templates/config/initializers/mime_types.rb +5 -0
  349. data/lib/rails/generators/rails/app/templates/config/initializers/secret_token.rb.tt +7 -0
  350. data/lib/rails/generators/rails/app/templates/config/initializers/session_store.rb.tt +8 -0
  351. data/lib/rails/generators/rails/app/templates/config/initializers/wrap_parameters.rb.tt +16 -0
  352. data/lib/rails/generators/rails/app/templates/config/locales/en.yml +5 -0
  353. data/lib/rails/generators/rails/app/templates/config/routes.rb +58 -0
  354. data/lib/rails/generators/rails/app/templates/config.ru +4 -0
  355. data/lib/rails/generators/rails/app/templates/db/seeds.rb.tt +7 -0
  356. data/lib/rails/generators/rails/app/templates/doc/README_FOR_APP +2 -0
  357. data/lib/rails/generators/rails/app/templates/gitignore +15 -0
  358. data/lib/rails/generators/rails/app/templates/public/404.html +26 -0
  359. data/lib/rails/generators/rails/app/templates/public/422.html +26 -0
  360. data/lib/rails/generators/rails/app/templates/public/500.html +25 -0
  361. data/lib/rails/generators/rails/app/templates/public/favicon.ico +0 -0
  362. data/lib/rails/generators/rails/app/templates/public/index.html +241 -0
  363. data/lib/rails/generators/rails/app/templates/public/robots.txt +5 -0
  364. data/lib/rails/generators/rails/app/templates/public/stylesheets/.empty_directory +0 -0
  365. data/lib/rails/generators/rails/app/templates/script/rails +5 -0
  366. data/lib/rails/generators/rails/app/templates/test/fixtures/.empty_directory +0 -0
  367. data/lib/rails/generators/rails/app/templates/test/functional/.empty_directory +0 -0
  368. data/lib/rails/generators/rails/app/templates/test/integration/.empty_directory +0 -0
  369. data/lib/rails/generators/rails/app/templates/test/performance/browsing_test.rb +12 -0
  370. data/lib/rails/generators/rails/app/templates/test/test_helper.rb +15 -0
  371. data/lib/rails/generators/rails/app/templates/test/unit/.empty_directory +0 -0
  372. data/lib/rails/generators/rails/assets/USAGE +20 -0
  373. data/lib/rails/generators/rails/assets/assets_generator.rb +25 -0
  374. data/lib/rails/generators/rails/assets/templates/javascript.js +2 -0
  375. data/lib/rails/generators/rails/assets/templates/stylesheet.css +4 -0
  376. data/lib/rails/generators/rails/controller/USAGE +18 -0
  377. data/lib/rails/generators/rails/controller/controller_generator.rb +20 -0
  378. data/lib/rails/generators/rails/controller/templates/controller.rb +13 -0
  379. data/lib/rails/generators/rails/generator/USAGE +12 -0
  380. data/lib/rails/generators/rails/generator/generator_generator.rb +25 -0
  381. data/lib/rails/generators/rails/generator/templates/%file_name%_generator.rb.tt +3 -0
  382. data/lib/rails/generators/rails/generator/templates/USAGE.tt +8 -0
  383. data/lib/rails/generators/rails/generator/templates/templates/.empty_directory +0 -0
  384. data/lib/rails/generators/rails/helper/USAGE +17 -0
  385. data/lib/rails/generators/rails/helper/helper_generator.rb +13 -0
  386. data/lib/rails/generators/rails/helper/templates/helper.rb +4 -0
  387. data/lib/rails/generators/rails/integration_test/USAGE +10 -0
  388. data/lib/rails/generators/rails/integration_test/integration_test_generator.rb +7 -0
  389. data/lib/rails/generators/rails/migration/USAGE +29 -0
  390. data/lib/rails/generators/rails/migration/migration_generator.rb +8 -0
  391. data/lib/rails/generators/rails/model/USAGE +45 -0
  392. data/lib/rails/generators/rails/model/model_generator.rb +8 -0
  393. data/lib/rails/generators/rails/observer/USAGE +12 -0
  394. data/lib/rails/generators/rails/observer/observer_generator.rb +7 -0
  395. data/lib/rails/generators/rails/performance_test/USAGE +10 -0
  396. data/lib/rails/generators/rails/performance_test/performance_test_generator.rb +7 -0
  397. data/lib/rails/generators/rails/plugin_new/USAGE +10 -0
  398. data/lib/rails/generators/rails/plugin_new/plugin_new_generator.rb +318 -0
  399. data/lib/rails/generators/rails/plugin_new/templates/%name%.gemspec +29 -0
  400. data/lib/rails/generators/rails/plugin_new/templates/Gemfile +23 -0
  401. data/lib/rails/generators/rails/plugin_new/templates/MIT-LICENSE +20 -0
  402. data/lib/rails/generators/rails/plugin_new/templates/README.rdoc +3 -0
  403. data/lib/rails/generators/rails/plugin_new/templates/Rakefile +31 -0
  404. data/lib/rails/generators/rails/plugin_new/templates/app/controllers/%name%/application_controller.rb.tt +4 -0
  405. data/lib/rails/generators/rails/plugin_new/templates/app/helpers/%name%/application_helper.rb.tt +4 -0
  406. data/lib/rails/generators/rails/plugin_new/templates/app/mailers/.empty_directory +0 -0
  407. data/lib/rails/generators/rails/plugin_new/templates/app/models/.empty_directory +0 -0
  408. data/lib/rails/generators/rails/plugin_new/templates/app/views/layouts/%name%/application.html.erb.tt +14 -0
  409. data/lib/rails/generators/rails/plugin_new/templates/config/routes.rb +6 -0
  410. data/lib/rails/generators/rails/plugin_new/templates/gitignore +7 -0
  411. data/lib/rails/generators/rails/plugin_new/templates/lib/%name%/engine.rb +7 -0
  412. data/lib/rails/generators/rails/plugin_new/templates/lib/%name%/version.rb +3 -0
  413. data/lib/rails/generators/rails/plugin_new/templates/lib/%name%.rb +6 -0
  414. data/lib/rails/generators/rails/plugin_new/templates/lib/tasks/%name%_tasks.rake +4 -0
  415. data/lib/rails/generators/rails/plugin_new/templates/rails/application.rb +18 -0
  416. data/lib/rails/generators/rails/plugin_new/templates/rails/boot.rb +10 -0
  417. data/lib/rails/generators/rails/plugin_new/templates/rails/routes.rb +4 -0
  418. data/lib/rails/generators/rails/plugin_new/templates/script/rails.tt +7 -0
  419. data/lib/rails/generators/rails/plugin_new/templates/test/%name%_test.rb +7 -0
  420. data/lib/rails/generators/rails/plugin_new/templates/test/integration/navigation_test.rb +12 -0
  421. data/lib/rails/generators/rails/plugin_new/templates/test/test_helper.rb +15 -0
  422. data/lib/rails/generators/rails/resource/USAGE +23 -0
  423. data/lib/rails/generators/rails/resource/resource_generator.rb +20 -0
  424. data/lib/rails/generators/rails/resource_route/resource_route_generator.rb +50 -0
  425. data/lib/rails/generators/rails/scaffold/USAGE +35 -0
  426. data/lib/rails/generators/rails/scaffold/scaffold_generator.rb +23 -0
  427. data/lib/rails/generators/rails/scaffold/templates/scaffold.css +56 -0
  428. data/lib/rails/generators/rails/scaffold_controller/USAGE +19 -0
  429. data/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb +25 -0
  430. data/lib/rails/generators/rails/scaffold_controller/templates/controller.rb +89 -0
  431. data/lib/rails/generators/rails/session_migration/USAGE +8 -0
  432. data/lib/rails/generators/rails/session_migration/session_migration_generator.rb +8 -0
  433. data/lib/rails/generators/rails/task/USAGE +9 -0
  434. data/lib/rails/generators/rails/task/task_generator.rb +12 -0
  435. data/lib/rails/generators/rails/task/templates/task.rb +8 -0
  436. data/lib/rails/generators/resource_helpers.rb +80 -0
  437. data/lib/rails/generators/test_case.rb +247 -0
  438. data/lib/rails/generators/test_unit/controller/controller_generator.rb +15 -0
  439. data/lib/rails/generators/test_unit/controller/templates/functional_test.rb +19 -0
  440. data/lib/rails/generators/test_unit/helper/helper_generator.rb +13 -0
  441. data/lib/rails/generators/test_unit/helper/templates/helper_test.rb +6 -0
  442. data/lib/rails/generators/test_unit/integration/integration_generator.rb +13 -0
  443. data/lib/rails/generators/test_unit/integration/templates/integration_test.rb +7 -0
  444. data/lib/rails/generators/test_unit/mailer/mailer_generator.rb +14 -0
  445. data/lib/rails/generators/test_unit/mailer/templates/functional_test.rb +21 -0
  446. data/lib/rails/generators/test_unit/model/model_generator.rb +24 -0
  447. data/lib/rails/generators/test_unit/model/templates/fixtures.yml +23 -0
  448. data/lib/rails/generators/test_unit/model/templates/unit_test.rb +9 -0
  449. data/lib/rails/generators/test_unit/observer/observer_generator.rb +13 -0
  450. data/lib/rails/generators/test_unit/observer/templates/unit_test.rb +9 -0
  451. data/lib/rails/generators/test_unit/performance/performance_generator.rb +13 -0
  452. data/lib/rails/generators/test_unit/performance/templates/performance_test.rb +12 -0
  453. data/lib/rails/generators/test_unit/plugin/plugin_generator.rb +13 -0
  454. data/lib/rails/generators/test_unit/plugin/templates/%file_name%_test.rb.tt +7 -0
  455. data/lib/rails/generators/test_unit/plugin/templates/test_helper.rb +3 -0
  456. data/lib/rails/generators/test_unit/scaffold/scaffold_generator.rb +38 -0
  457. data/lib/rails/generators/test_unit/scaffold/templates/functional_test.rb +51 -0
  458. data/lib/rails/generators/test_unit.rb +8 -0
  459. data/lib/rails/generators.rb +339 -0
  460. data/lib/rails/info.rb +116 -0
  461. data/lib/rails/info_controller.rb +15 -0
  462. data/lib/rails/initializable.rb +89 -0
  463. data/lib/rails/paths.rb +211 -0
  464. data/lib/rails/performance_test_help.rb +3 -0
  465. data/lib/rails/plugin.rb +92 -0
  466. data/lib/rails/rack/debugger.rb +24 -0
  467. data/lib/rails/rack/log_tailer.rb +34 -0
  468. data/lib/rails/rack/logger.rb +60 -0
  469. data/lib/rails/rack.rb +7 -0
  470. data/lib/rails/railtie/configurable.rb +35 -0
  471. data/lib/rails/railtie/configuration.rb +90 -0
  472. data/lib/rails/railtie.rb +202 -0
  473. data/lib/rails/ruby_version_check.rb +23 -0
  474. data/lib/rails/rubyprof_ext.rb +35 -0
  475. data/lib/rails/script_rails_loader.rb +29 -0
  476. data/lib/rails/source_annotation_extractor.rb +104 -0
  477. data/lib/rails/tasks/annotations.rake +20 -0
  478. data/lib/rails/tasks/documentation.rake +155 -0
  479. data/lib/rails/tasks/engine.rake +72 -0
  480. data/lib/rails/tasks/framework.rake +76 -0
  481. data/lib/rails/tasks/log.rake +9 -0
  482. data/lib/rails/tasks/middleware.rake +7 -0
  483. data/lib/rails/tasks/misc.rake +67 -0
  484. data/lib/rails/tasks/routes.rake +9 -0
  485. data/lib/rails/tasks/statistics.rake +16 -0
  486. data/lib/rails/tasks/tmp.rake +37 -0
  487. data/lib/rails/tasks.rb +16 -0
  488. data/lib/rails/test_help.rb +56 -0
  489. data/lib/rails/test_unit/railtie.rb +15 -0
  490. data/lib/rails/test_unit/sub_test_task.rb +8 -0
  491. data/lib/rails/test_unit/testing.rake +146 -0
  492. data/lib/rails/version.rb +10 -0
  493. data/lib/rails.rb +126 -0
  494. metadata +609 -0
@@ -0,0 +1,1929 @@
1
+ h2. Getting Started with Rails
2
+
3
+ This guide covers getting up and running with Ruby on Rails. After reading it,
4
+ you should be familiar with:
5
+
6
+ * Installing Rails, creating a new Rails application, and connecting your application to a database
7
+ * The general layout of a Rails application
8
+ * The basic principles of MVC (Model, View Controller) and RESTful design
9
+ * How to quickly generate the starting pieces of a Rails application
10
+
11
+ endprologue.
12
+
13
+ WARNING. This Guide is based on Rails 3.2. Some of the code shown here will not
14
+ work in earlier versions of Rails.
15
+
16
+ h3. Guide Assumptions
17
+
18
+ This guide is designed for beginners who want to get started with a Rails
19
+ application from scratch. It does not assume that you have any prior experience
20
+ with Rails. However, to get the most out of it, you need to have some
21
+ prerequisites installed:
22
+
23
+ * The "Ruby":http://www.ruby-lang.org/en/downloads language version 1.8.7 or higher
24
+
25
+ TIP: Note that Ruby 1.8.7 p248 and p249 have marshaling bugs that crash Rails
26
+ 3.0 and above. Ruby Enterprise Edition have these fixed since release 1.8.7-2010.02
27
+ though. On the 1.9 front, Ruby 1.9.1 is not usable because it outright segfaults
28
+ on Rails 3.0 and above, so if you want to use Rails 3.0 or above with 1.9.x jump on 1.9.2 for smooth
29
+ sailing.
30
+
31
+ * The "RubyGems":http://rubyforge.org/frs/?group_id=126 packaging system
32
+ ** If you want to learn more about RubyGems, please read the "RubyGems User Guide":http://docs.rubygems.org/read/book/1
33
+ * A working installation of the "SQLite3 Database":http://www.sqlite.org
34
+
35
+ Rails is a web application framework running on the Ruby programming language.
36
+ If you have no prior experience with Ruby, you will find a very steep learning
37
+ curve diving straight into Rails. There are some good free resources on the
38
+ internet for learning Ruby, including:
39
+
40
+ * "Mr. Neighborly's Humble Little Ruby Book":http://www.humblelittlerubybook.com
41
+ * "Programming Ruby":http://www.ruby-doc.org/docs/ProgrammingRuby/
42
+ * "Why's (Poignant) Guide to Ruby":http://mislav.uniqpath.com/poignant-guide/
43
+
44
+ Also, the example code for this guide is available in the rails github:https://github.com/rails/rails repository
45
+ in rails/railties/guides/code/getting_started.
46
+
47
+ h3. What is Rails?
48
+
49
+ TIP: This section goes into the background and philosophy of the Rails framework
50
+ in detail. You can safely skip this section and come back to it at a later time.
51
+ Section 3 starts you on the path to creating your first Rails application.
52
+
53
+ Rails is a web application development framework written in the Ruby language.
54
+ It is designed to make programming web applications easier by making assumptions
55
+ about what every developer needs to get started. It allows you to write less
56
+ code while accomplishing more than many other languages and frameworks.
57
+ Experienced Rails developers also report that it makes web application
58
+ development more fun.
59
+
60
+ Rails is opinionated software. It makes the assumption that there is a "best"
61
+ way to do things, and it's designed to encourage that way - and in some cases to
62
+ discourage alternatives. If you learn "The Rails Way" you'll probably discover a
63
+ tremendous increase in productivity. If you persist in bringing old habits from
64
+ other languages to your Rails development, and trying to use patterns you
65
+ learned elsewhere, you may have a less happy experience.
66
+
67
+ The Rails philosophy includes several guiding principles:
68
+
69
+ * DRY - "Don't Repeat Yourself" - suggests that writing the same code over and over again is a bad thing.
70
+ * Convention Over Configuration - means that Rails makes assumptions about what you want to do and how you're going to
71
+ do it, rather than requiring you to specify every little thing through endless configuration files.
72
+ * REST is the best pattern for web applications - organizing your application around resources and standard HTTP verbs
73
+ is the fastest way to go.
74
+
75
+ h4. The MVC Architecture
76
+
77
+ At the core of Rails is the Model, View, Controller architecture, usually just
78
+ called MVC. MVC benefits include:
79
+
80
+ * Isolation of business logic from the user interface
81
+ * Ease of keeping code DRY
82
+ * Making it clear where different types of code belong for easier maintenance
83
+
84
+ h5. Models
85
+
86
+ A model represents the information (data) of the application and the rules to
87
+ manipulate that data. In the case of Rails, models are primarily used for
88
+ managing the rules of interaction with a corresponding database table. In most
89
+ cases, each table in your database will correspond to one model in your
90
+ application. The bulk of your application's business logic will be concentrated
91
+ in the models.
92
+
93
+ h5. Views
94
+
95
+ Views represent the user interface of your application. In Rails, views are
96
+ often HTML files with embedded Ruby code that perform tasks related solely to
97
+ the presentation of the data. Views handle the job of providing data to the web
98
+ browser or other tool that is used to make requests from your application.
99
+
100
+ h5. Controllers
101
+
102
+ Controllers provide the "glue" between models and views. In Rails, controllers
103
+ are responsible for processing the incoming requests from the web browser,
104
+ interrogating the models for data, and passing that data on to the views for
105
+ presentation.
106
+
107
+ h4. The Components of Rails
108
+
109
+ Rails ships as many individual components. Each of these components are briefly
110
+ explained below. If you are new to Rails, as you read this section, don't get
111
+ hung up on the details of each component, as they will be explained in further
112
+ detail later. For instance, we will bring up Rack applications, but you don't
113
+ need to know anything about them to continue with this guide.
114
+
115
+ * Action Pack
116
+ ** Action Controller
117
+ ** Action Dispatch
118
+ ** Action View
119
+ * Action Mailer
120
+ * Active Model
121
+ * Active Record
122
+ * Active Resource
123
+ * Active Support
124
+ * Railties
125
+
126
+ h5. Action Pack
127
+
128
+ Action Pack is a single gem that contains Action Controller, Action View and
129
+ Action Dispatch. The "VC" part of "MVC".
130
+
131
+ h6. Action Controller
132
+
133
+ Action Controller is the component that manages the controllers in a Rails
134
+ application. The Action Controller framework processes incoming requests to a
135
+ Rails application, extracts parameters, and dispatches them to the intended
136
+ action. Services provided by Action Controller include session management,
137
+ template rendering, and redirect management.
138
+
139
+ h6. Action View
140
+
141
+ Action View manages the views of your Rails application. It can create both HTML
142
+ and XML output by default. Action View manages rendering templates, including
143
+ nested and partial templates, and includes built-in AJAX support. View
144
+ templates are covered in more detail in another guide called "Layouts and
145
+ Rendering":layouts_and_rendering.html.
146
+
147
+ h6. Action Dispatch
148
+
149
+ Action Dispatch handles routing of web requests and dispatches them as you want,
150
+ either to your application or any other Rack application. Rack applications are
151
+ a more advanced topic and are covered in a separate guide called "Rails on
152
+ Rack":rails_on_rack.html.
153
+
154
+ h5. Action Mailer
155
+
156
+ Action Mailer is a framework for building e-mail services. You can use Action
157
+ Mailer to receive and process incoming email and send simple plain text or
158
+ complex multipart emails based on flexible templates.
159
+
160
+ h5. Active Model
161
+
162
+ Active Model provides a defined interface between the Action Pack gem services
163
+ and Object Relationship Mapping gems such as Active Record. Active Model allows
164
+ Rails to utilize other ORM frameworks in place of Active Record if your
165
+ application needs this.
166
+
167
+ h5. Active Record
168
+
169
+ Active Record is the base for the models in a Rails application. It provides
170
+ database independence, basic CRUD functionality, advanced finding capabilities,
171
+ and the ability to relate models to one another, among other services.
172
+
173
+ h5. Active Resource
174
+
175
+ Active Resource provides a framework for managing the connection between
176
+ business objects and RESTful web services. It implements a way to map web-based
177
+ resources to local objects with CRUD semantics.
178
+
179
+ h5. Active Support
180
+
181
+ Active Support is an extensive collection of utility classes and standard Ruby
182
+ library extensions that are used in Rails, both by the core code and by your
183
+ applications.
184
+
185
+ h5. Railties
186
+
187
+ Railties is the core Rails code that builds new Rails applications and glues the
188
+ various frameworks and plugins together in any Rails application.
189
+
190
+ h4. REST
191
+
192
+ Rest stands for Representational State Transfer and is the foundation of the
193
+ RESTful architecture. This is generally considered to be Roy Fielding's doctoral
194
+ thesis, "Architectural Styles and the Design of Network-based Software
195
+ Architectures":http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm. While
196
+ you can read through the thesis, REST in terms of Rails boils down to two main
197
+ principles:
198
+
199
+ * Using resource identifiers such as URLs to represent resources.
200
+ * Transferring representations of the state of that resource between system components.
201
+
202
+ For example, the following HTTP request:
203
+
204
+ <tt>DELETE /photos/17</tt>
205
+
206
+ would be understood to refer to a photo resource with the ID of 17, and to
207
+ indicate a desired action - deleting that resource. REST is a natural style for
208
+ the architecture of web applications, and Rails hooks into this shielding you
209
+ from many of the RESTful complexities and browser quirks.
210
+
211
+ If you'd like more details on REST as an architectural style, these resources
212
+ are more approachable than Fielding's thesis:
213
+
214
+ * "A Brief Introduction to REST":http://www.infoq.com/articles/rest-introduction by Stefan Tilkov
215
+ * "An Introduction to REST":http://bitworking.org/news/373/An-Introduction-to-REST (video tutorial) by Joe Gregorio
216
+ * "Representational State Transfer":http://en.wikipedia.org/wiki/Representational_State_Transfer article in Wikipedia
217
+ * "How to GET a Cup of Coffee":http://www.infoq.com/articles/webber-rest-workflow by Jim Webber, Savas Parastatidis &
218
+ Ian Robinson
219
+
220
+ h3. Creating a New Rails Project
221
+
222
+ The best way to use this guide is to follow each step as it happens, no code or
223
+ step needed to make this example application has been left out, so you can
224
+ literally follow along step by step. You can get the complete code "here":https://github.com/rails/rails/tree/3-2-stable/railties/guides/code/getting_started.
225
+
226
+ By following along with this guide, you'll create a Rails project called <tt>blog</tt>, a
227
+ (very) simple weblog. Before you can start building the application, you need to
228
+ make sure that you have Rails itself installed.
229
+
230
+ TIP: The examples below use # and $ to denote terminal prompts. If you are using Windows, your prompt will look something like c:\source_code>
231
+
232
+ h4. Installing Rails
233
+
234
+ In most cases, the easiest way to install Rails is to take advantage of RubyGems:
235
+
236
+ <shell>
237
+ Usually run this as the root user:
238
+ # gem install rails
239
+ </shell>
240
+
241
+ TIP. If you're working on Windows, you can quickly install Ruby and Rails with
242
+ "Rails Installer":http://railsinstaller.org.
243
+
244
+ To verify that you have everything installed correctly, you should be able to run
245
+ the following:
246
+
247
+ <shell>
248
+ $ rails --version
249
+ </shell>
250
+
251
+ If it says something like "Rails 3.2.3" you are ready to continue.
252
+
253
+ h4. Creating the Blog Application
254
+
255
+ To begin, open a terminal, navigate to a folder where you have rights to create
256
+ files, and type:
257
+
258
+ <shell>
259
+ $ rails new blog
260
+ </shell>
261
+
262
+ This will create a Rails application called Blog in a directory called blog.
263
+
264
+ TIP: You can see all of the switches that the Rails application builder accepts
265
+ by running
266
+ <tt>rails new -h</tt>.
267
+
268
+ After you create the blog application, switch to its folder to continue work
269
+ directly in that application:
270
+
271
+ <shell>
272
+ $ cd blog
273
+ </shell>
274
+
275
+ The 'rails new blog' command we ran above created a folder in your working directory
276
+ called <tt>blog</tt>. The <tt>blog</tt> folder has a number of auto-generated folders
277
+ that make up the structure of a Rails application. Most of the work in
278
+ this tutorial will happen in the <tt>app/</tt> folder, but here's a basic
279
+ rundown on the function of each of the files and folders that Rails created by default:
280
+
281
+ |_.File/Folder|_.Purpose|
282
+ |app/|Contains the controllers, models, views and assets for your application. You'll focus on this folder for the remainder of this guide.|
283
+ |config/|Configure your application's runtime rules, routes, database, and more. This is covered in more detail in "Configuring Rails Applications":configuring.html|
284
+ |config.ru|Rack configuration for Rack based servers used to start the application.|
285
+ |db/|Contains your current database schema, as well as the database migrations.|
286
+ |doc/|In-depth documentation for your application.|
287
+ |Gemfile<BR />Gemfile.lock|These files allow you to specify what gem dependencies are needed for your Rails application.|
288
+ |lib/|Extended modules for your application.|
289
+ |log/|Application log files.|
290
+ |public/|The only folder seen to the world as-is. Contains the static files and compiled assets.|
291
+ |Rakefile|This file locates and loads tasks that can be run from the command line. The task definitions are defined throughout the components of Rails. Rather than changing Rakefile, you should add your own tasks by adding files to the lib/tasks directory of your application.|
292
+ |README.rdoc|This is a brief instruction manual for your application. You should edit this file to tell others what your application does, how to set it up, and so on.|
293
+ |script/|Contains the rails script that starts your app and can contain other scripts you use to deploy or run your application.|
294
+ |test/|Unit tests, fixtures, and other test apparatus. These are covered in "Testing Rails Applications":testing.html|
295
+ |tmp/|Temporary files|
296
+ |vendor/|A place for all third-party code. In a typical Rails application, this includes Ruby Gems, the Rails source code (if you optionally install it into your project) and plugins containing additional prepackaged functionality.|
297
+
298
+ h4. Configuring a Database
299
+
300
+ Just about every Rails application will interact with a database. The database
301
+ to use is specified in a configuration file, +config/database.yml+. If you open
302
+ this file in a new Rails application, you'll see a default database
303
+ configured to use SQLite3. The file contains sections for three different
304
+ environments in which Rails can run by default:
305
+
306
+ * The +development+ environment is used on your development/local computer as you interact
307
+ manually with the application.
308
+ * The +test+ environment is used when running automated tests.
309
+ * The +production+ environment is used when you deploy your application for the world to use.
310
+
311
+ TIP: You don't have to update the database configurations manually. If you look at the
312
+ options of the application generator, you will see that one of the options
313
+ is named <tt>--database</tt>. This option allows you to choose an adapter from a
314
+ list of the most used relational databases. You can even run the generator
315
+ repeatedly: <tt>cd .. && rails new blog --database=mysql</tt>. When you confirm the overwriting
316
+ of the +config/database.yml+ file, your application will be configured for MySQL
317
+ instead of SQLite. Detailed examples of the common database connections are below.
318
+
319
+ h5. Configuring an SQLite3 Database
320
+
321
+ Rails comes with built-in support for "SQLite3":http://www.sqlite.org, which is
322
+ a lightweight serverless database application. While a busy production
323
+ environment may overload SQLite, it works well for development and testing.
324
+ Rails defaults to using an SQLite database when creating a new project, but you
325
+ can always change it later.
326
+
327
+ Here's the section of the default configuration file
328
+ (<tt>config/database.yml</tt>) with connection information for the development
329
+ environment:
330
+
331
+ <yaml>
332
+ development:
333
+ adapter: sqlite3
334
+ database: db/development.sqlite3
335
+ pool: 5
336
+ timeout: 5000
337
+ </yaml>
338
+
339
+ NOTE: In this guide we are using an SQLite3 database for data storage, because
340
+ it is a zero configuration database that just works. Rails also supports MySQL
341
+ and PostgreSQL "out of the box", and has plugins for many database systems. If
342
+ you are using a database in a production environment Rails most likely has an
343
+ adapter for it.
344
+
345
+ h5. Configuring a MySQL Database
346
+
347
+ If you choose to use MySQL instead of the shipped SQLite3 database, your
348
+ +config/database.yml+ will look a little different. Here's the development
349
+ section:
350
+
351
+ <yaml>
352
+ development:
353
+ adapter: mysql2
354
+ encoding: utf8
355
+ database: blog_development
356
+ pool: 5
357
+ username: root
358
+ password:
359
+ socket: /tmp/mysql.sock
360
+ </yaml>
361
+
362
+ If your development computer's MySQL installation includes a root user with an
363
+ empty password, this configuration should work for you. Otherwise, change the
364
+ username and password in the +development+ section as appropriate.
365
+
366
+ h5. Configuring a PostgreSQL Database
367
+
368
+ If you choose to use PostgreSQL, your +config/database.yml+ will be customized
369
+ to use PostgreSQL databases:
370
+
371
+ <yaml>
372
+ development:
373
+ adapter: postgresql
374
+ encoding: unicode
375
+ database: blog_development
376
+ pool: 5
377
+ username: blog
378
+ password:
379
+ </yaml>
380
+
381
+ h5. Configuring an SQLite3 Database for JRuby Platform
382
+
383
+ If you choose to use SQLite3 and are using JRuby, your +config/database.yml+ will
384
+ look a little different. Here's the development section:
385
+
386
+ <yaml>
387
+ development:
388
+ adapter: jdbcsqlite3
389
+ database: db/development.sqlite3
390
+ </yaml>
391
+
392
+ h5. Configuring a MySQL Database for JRuby Platform
393
+
394
+ If you choose to use MySQL and are using JRuby, your +config/database.yml+ will look
395
+ a little different. Here's the development section:
396
+
397
+ <yaml>
398
+ development:
399
+ adapter: jdbcmysql
400
+ database: blog_development
401
+ username: root
402
+ password:
403
+ </yaml>
404
+
405
+ h5. Configuring a PostgreSQL Database for JRuby Platform
406
+
407
+ Finally if you choose to use PostgreSQL and are using JRuby, your
408
+ +config/database.yml+ will look a little different. Here's the development
409
+ section:
410
+
411
+ <yaml>
412
+ development:
413
+ adapter: jdbcpostgresql
414
+ encoding: unicode
415
+ database: blog_development
416
+ username: blog
417
+ password:
418
+ </yaml>
419
+
420
+ Change the username and password in the +development+ section as appropriate.
421
+
422
+ h4. Creating the Database
423
+
424
+ Now that you have your database configured, it's time to have Rails create an
425
+ empty database for you. You can do this by running a rake command:
426
+
427
+ <shell>
428
+ $ rake db:create
429
+ </shell>
430
+
431
+ This will create your development and test SQLite3 databases inside the
432
+ <tt>db/</tt> folder.
433
+
434
+ TIP: Rake is a general-purpose command-runner that Rails uses for many things.
435
+ You can see the list of available rake commands in your application by running
436
+ +rake -T+.
437
+
438
+ h3. Hello, Rails!
439
+
440
+ One of the traditional places to start with a new language is by getting some
441
+ text up on screen quickly. To do this, you need to get your Rails application
442
+ server running.
443
+
444
+ h4. Starting up the Web Server
445
+
446
+ You actually have a functional Rails application already. To see it, you need to
447
+ start a web server on your development machine. You can do this by running:
448
+
449
+ <shell>
450
+ $ rails server
451
+ </shell>
452
+
453
+ TIP: Compiling CoffeeScript to JavaScript requires a JavaScript runtime and
454
+ the absence of a runtime will give you an +execjs+ error. Usually Mac OS X
455
+ and Windows come with a JavaScript runtime installed. Rails adds the +therubyracer+ gem
456
+ to Gemfile in a commented line for new apps and you can uncomment if you need it.
457
+ +therubyrhino+ is the recommended runtime for JRuby users and is added by default
458
+ to Gemfile in apps generated under JRuby. You can investigate about all the
459
+ supported runtimes at "ExecJS":https://github.com/sstephenson/execjs#readme.
460
+
461
+ This will fire up an instance of the WEBrick web server by default (Rails can
462
+ also use several other web servers). To see your application in action, open a
463
+ browser window and navigate to "http://localhost:3000":http://localhost:3000.
464
+ You should see Rails' default information page:
465
+
466
+ !images/rails_welcome.png(Welcome Aboard screenshot)!
467
+
468
+ TIP: To stop the web server, hit Ctrl+C in the terminal window where it's
469
+ running. In development mode, Rails does not generally require you to stop the
470
+ server; changes you make in files will be automatically picked up by the server.
471
+
472
+ The "Welcome Aboard" page is the _smoke test_ for a new Rails application: it
473
+ makes sure that you have your software configured correctly enough to serve a
474
+ page. You can also click on the _About your application’s environment_ link to
475
+ see a summary of your application's environment.
476
+
477
+ h4. Say "Hello", Rails
478
+
479
+ To get Rails saying "Hello", you need to create at minimum a controller and a
480
+ view. Fortunately, you can do that in a single command. Enter this command in
481
+ your terminal:
482
+
483
+ <shell>
484
+ $ rails generate controller home index
485
+ </shell>
486
+
487
+ TIP: If you get a command not found error when running this command, you
488
+ need to explicitly pass Rails +rails+ commands to Ruby: <tt>ruby
489
+ \path\to\your\application\script\rails generate controller home index</tt>.
490
+
491
+ Rails will create several files for you, including
492
+ +app/views/home/index.html.erb+. This is the template that will be used to
493
+ display the results of the +index+ action (method) in the +home+ controller.
494
+ Open this file in your text editor and edit it to contain a single line of code:
495
+
496
+ <code class="html">
497
+ <h1>Hello, Rails!</h1>
498
+ </code>
499
+
500
+ h4. Setting the Application Home Page
501
+
502
+ Now that we have made the controller and view, we need to tell Rails when we
503
+ want "Hello Rails!" to show up. In our case, we want it to show up when we
504
+ navigate to the root URL of our site,
505
+ "http://localhost:3000":http://localhost:3000, instead of the "Welcome Aboard"
506
+ smoke test.
507
+
508
+ The first step to doing this is to delete the default page from your
509
+ application:
510
+
511
+ <shell>
512
+ $ rm public/index.html
513
+ </shell>
514
+
515
+ We need to do this as Rails will deliver any static file in the +public+
516
+ directory in preference to any dynamic content we generate from the controllers.
517
+
518
+ Now, you have to tell Rails where your actual home page is located. Open the
519
+ file +config/routes.rb+ in your editor. This is your application's _routing
520
+ file_ which holds entries in a special DSL (domain-specific language) that tells
521
+ Rails how to connect incoming requests to controllers and actions. This file
522
+ contains many sample routes on commented lines, and one of them actually shows
523
+ you how to connect the root of your site to a specific controller and action.
524
+ Find the line beginning with +root :to+ and uncomment it. It should look something like the following:
525
+
526
+ <ruby>
527
+ Blog::Application.routes.draw do
528
+
529
+ #...
530
+ # You can have the root of your site routed with "root"
531
+ # just remember to delete public/index.html.
532
+ root :to => "home#index"
533
+ </ruby>
534
+
535
+ The +root :to => "home#index"+ tells Rails to map the root action to the home
536
+ controller's index action.
537
+
538
+ Now if you navigate to "http://localhost:3000":http://localhost:3000 in your
539
+ browser, you'll see +Hello, Rails!+.
540
+
541
+ NOTE. For more information about routing, refer to "Rails Routing from the
542
+ Outside In":routing.html.
543
+
544
+ h3. Getting Up and Running Quickly with Scaffolding
545
+
546
+ Rails _scaffolding_ is a quick way to generate some of the major pieces of an
547
+ application. If you want to create the models, views, and controllers for a new
548
+ resource in a single operation, scaffolding is the tool for the job.
549
+
550
+ h3. Creating a Resource
551
+
552
+ In the case of the blog application, you can start by generating a scaffold for the
553
+ Post resource: this will represent a single blog posting. To do this, enter this
554
+ command in your terminal:
555
+
556
+ <shell>
557
+ $ rails generate scaffold Post name:string title:string content:text
558
+ </shell>
559
+
560
+ The scaffold generator will build several files in your application, along with some
561
+ folders, and edit <tt>config/routes.rb</tt>. Here's a quick overview of what it creates:
562
+
563
+ |_.File |_.Purpose|
564
+ |db/migrate/20100207214725_create_posts.rb |Migration to create the posts table in your database (your name will include a different timestamp)|
565
+ |app/models/post.rb |The Post model|
566
+ |test/unit/post_test.rb |Unit testing harness for the posts model|
567
+ |test/fixtures/posts.yml |Sample posts for use in testing|
568
+ |config/routes.rb |Edited to include routing information for posts|
569
+ |app/controllers/posts_controller.rb |The Posts controller|
570
+ |app/views/posts/index.html.erb |A view to display an index of all posts |
571
+ |app/views/posts/edit.html.erb |A view to edit an existing post|
572
+ |app/views/posts/show.html.erb |A view to display a single post|
573
+ |app/views/posts/new.html.erb |A view to create a new post|
574
+ |app/views/posts/_form.html.erb |A partial to control the overall look and feel of the form used in edit and new views|
575
+ |test/functional/posts_controller_test.rb |Functional testing harness for the posts controller|
576
+ |app/helpers/posts_helper.rb |Helper functions to be used from the post views|
577
+ |test/unit/helpers/posts_helper_test.rb |Unit testing harness for the posts helper|
578
+ |app/assets/javascripts/posts.js.coffee |CoffeeScript for the posts controller|
579
+ |app/assets/stylesheets/posts.css.scss |Cascading style sheet for the posts controller|
580
+ |app/assets/stylesheets/scaffolds.css.scss |Cascading style sheet to make the scaffolded views look better|
581
+
582
+ NOTE. While scaffolding will get you up and running quickly, the code it
583
+ generates is unlikely to be a perfect fit for your application. You'll most
584
+ probably want to customize the generated code. Many experienced Rails developers
585
+ avoid scaffolding entirely, preferring to write all or most of their source code
586
+ from scratch. Rails, however, makes it really simple to customize templates for
587
+ generated models, controllers, views and other source files. You'll find more
588
+ information in the "Creating and Customizing Rails Generators &
589
+ Templates":generators.html guide.
590
+
591
+ h4. Running a Migration
592
+
593
+ One of the products of the +rails generate scaffold+ command is a _database
594
+ migration_. Migrations are Ruby classes that are designed to make it simple to
595
+ create and modify database tables. Rails uses rake commands to run migrations,
596
+ and it's possible to undo a migration after it's been applied to your database.
597
+ Migration filenames include a timestamp to ensure that they're processed in the
598
+ order that they were created.
599
+
600
+ If you look in the +db/migrate/20100207214725_create_posts.rb+ file (remember,
601
+ yours will have a slightly different name), here's what you'll find:
602
+
603
+ <ruby>
604
+ class CreatePosts < ActiveRecord::Migration
605
+ def change
606
+ create_table :posts do |t|
607
+ t.string :name
608
+ t.string :title
609
+ t.text :content
610
+
611
+ t.timestamps
612
+ end
613
+ end
614
+ end
615
+ </ruby>
616
+
617
+ The above migration creates a method named +change+ which will be called when you
618
+ run this migration. The action defined in this method is also reversible, which
619
+ means Rails knows how to reverse the change made by this migration, in case you
620
+ want to reverse it later. When you run this migration it will create a
621
+ +posts+ table with two string columns and a text column. It also creates two
622
+ timestamp fields to allow Rails to track post creation and update times. More
623
+ information about Rails migrations can be found in the "Rails Database
624
+ Migrations":migrations.html guide.
625
+
626
+ At this point, you can use a rake command to run the migration:
627
+
628
+ <shell>
629
+ $ rake db:migrate
630
+ </shell>
631
+
632
+ Rails will execute this migration command and tell you it created the Posts
633
+ table.
634
+
635
+ <shell>
636
+ == CreatePosts: migrating ====================================================
637
+ -- create_table(:posts)
638
+ -> 0.0019s
639
+ == CreatePosts: migrated (0.0020s) ===========================================
640
+ </shell>
641
+
642
+ NOTE. Because you're working in the development environment by default, this
643
+ command will apply to the database defined in the +development+ section of your
644
+ +config/database.yml+ file. If you would like to execute migrations in another
645
+ environment, for instance in production, you must explicitly pass it when
646
+ invoking the command: <tt>rake db:migrate RAILS_ENV=production</tt>.
647
+
648
+ h4. Adding a Link
649
+
650
+ To hook the posts up to the home page you've already created, you can add a link
651
+ to the home page. Open +app/views/home/index.html.erb+ and modify it as follows:
652
+
653
+ <ruby>
654
+ <h1>Hello, Rails!</h1>
655
+ <%= link_to "My Blog", posts_path %>
656
+ </ruby>
657
+
658
+ The +link_to+ method is one of Rails' built-in view helpers. It creates a
659
+ hyperlink based on text to display and where to go - in this case, to the path
660
+ for posts.
661
+
662
+ h4. Working with Posts in the Browser
663
+
664
+ Now you're ready to start working with posts. To do that, navigate to
665
+ "http://localhost:3000":http://localhost:3000/ and then click the "My Blog"
666
+ link:
667
+
668
+ !images/posts_index.png(Posts Index screenshot)!
669
+
670
+ This is the result of Rails rendering the +index+ view of your posts. There
671
+ aren't currently any posts in the database, but if you click the +New Post+ link
672
+ you can create one. After that, you'll find that you can edit posts, look at
673
+ their details, or destroy them. All of the logic and HTML to handle this was
674
+ built by the single +rails generate scaffold+ command.
675
+
676
+ TIP: In development mode (which is what you're working in by default), Rails
677
+ reloads your application with every browser request, so there's no need to stop
678
+ and restart the web server.
679
+
680
+ Congratulations, you're riding the rails! Now it's time to see how it all works.
681
+
682
+ h4. The Model
683
+
684
+ The model file, +app/models/post.rb+ is about as simple as it can get:
685
+
686
+ <ruby>
687
+ class Post < ActiveRecord::Base
688
+ attr_accessible :content, :name, :title
689
+ end
690
+ </ruby>
691
+
692
+ There isn't much to this file - but note that the +Post+ class inherits from
693
+ +ActiveRecord::Base+. Active Record supplies a great deal of functionality to
694
+ your Rails models for free, including basic database CRUD (Create, Read, Update,
695
+ Destroy) operations, data validation, as well as sophisticated search support
696
+ and the ability to relate multiple models to one another. Another important part
697
+ of this file is +attr_accessible+. It specifies a whitelist of attributes that are
698
+ allowed to be updated in bulk (via +update_attributes+ for instance).
699
+
700
+ h4. Adding Some Validation
701
+
702
+ Rails includes methods to help you validate the data that you send to models.
703
+ Open the +app/models/post.rb+ file and edit it:
704
+
705
+ <ruby>
706
+ class Post < ActiveRecord::Base
707
+ attr_accessible :content, :name, :title
708
+
709
+ validates :name, :presence => true
710
+ validates :title, :presence => true,
711
+ :length => { :minimum => 5 }
712
+ end
713
+ </ruby>
714
+
715
+ These changes will ensure that all posts have a name and a title, and that the
716
+ title is at least five characters long. Rails can validate a variety of
717
+ conditions in a model, including the presence or uniqueness of columns, their
718
+ format, and the existence of associated objects. Validations are covered in detail
719
+ in "Active Record Validations and Callbacks":active_record_validations_callbacks.html#validations-overview
720
+
721
+ h4. Using the Console
722
+
723
+ To see your validations in action, you can use the console. The console is a
724
+ command-line tool that lets you execute Ruby code in the context of your
725
+ application:
726
+
727
+ <shell>
728
+ $ rails console
729
+ </shell>
730
+
731
+ TIP: The default console will make changes to your database. You can instead
732
+ open a console that will roll back any changes you make by using <tt>rails console
733
+ --sandbox</tt>.
734
+
735
+ After the console loads, you can use it to work with your application's models:
736
+
737
+ <shell>
738
+ >> p = Post.new(:content => "A new post")
739
+ => #<Post id: nil, name: nil, title: nil,
740
+ content: "A new post", created_at: nil,
741
+ updated_at: nil>
742
+ >> p.save
743
+ => false
744
+ >> p.errors.full_messages
745
+ => ["Name can't be blank", "Title can't be blank", "Title is too short (minimum is 5 characters)"]
746
+ </shell>
747
+
748
+ This code shows creating a new +Post+ instance, attempting to save it and
749
+ getting +false+ for a return value (indicating that the save failed), and
750
+ inspecting the +errors+ of the post.
751
+
752
+ When you're finished, type +exit+ and hit +return+ to exit the console.
753
+
754
+ TIP: Unlike the development web server, the console does not automatically load
755
+ your code afresh for each line. If you make changes to your models (in your editor)
756
+ while the console is open, type +reload!+ at the console prompt to load them.
757
+
758
+ h4. Listing All Posts
759
+
760
+ Let's dive into the Rails code a little deeper to see how the application is
761
+ showing us the list of Posts. Open the file
762
+ +app/controllers/posts_controller.rb+ and look at the
763
+ +index+ action:
764
+
765
+ <ruby>
766
+ def index
767
+ @posts = Post.all
768
+
769
+ respond_to do |format|
770
+ format.html # index.html.erb
771
+ format.json { render :json => @posts }
772
+ end
773
+ end
774
+ </ruby>
775
+
776
+ +Post.all+ returns all of the posts currently in the database as an array
777
+ of +Post+ records that we store in an instance variable called +@posts+.
778
+
779
+ TIP: For more information on finding records with Active Record, see "Active
780
+ Record Query Interface":active_record_querying.html.
781
+
782
+ The +respond_to+ block handles both HTML and JSON calls to this action. If you
783
+ browse to "http://localhost:3000/posts.json":http://localhost:3000/posts.json,
784
+ you'll see a JSON containing all of the posts. The HTML format looks for a view
785
+ in +app/views/posts/+ with a name that corresponds to the action name. Rails
786
+ makes all of the instance variables from the action available to the view.
787
+ Here's +app/views/posts/index.html.erb+:
788
+
789
+ <erb>
790
+ <h1>Listing posts</h1>
791
+
792
+ <table>
793
+ <tr>
794
+ <th>Name</th>
795
+ <th>Title</th>
796
+ <th>Content</th>
797
+ <th></th>
798
+ <th></th>
799
+ <th></th>
800
+ </tr>
801
+
802
+ <% @posts.each do |post| %>
803
+ <tr>
804
+ <td><%= post.name %></td>
805
+ <td><%= post.title %></td>
806
+ <td><%= post.content %></td>
807
+ <td><%= link_to 'Show', post %></td>
808
+ <td><%= link_to 'Edit', edit_post_path(post) %></td>
809
+ <td><%= link_to 'Destroy', post, :confirm => 'Are you sure?',
810
+ :method => :delete %></td>
811
+ </tr>
812
+ <% end %>
813
+ </table>
814
+
815
+ <br />
816
+
817
+ <%= link_to 'New post', new_post_path %>
818
+ </erb>
819
+
820
+ This view iterates over the contents of the +@posts+ array to display content
821
+ and links. A few things to note in the view:
822
+
823
+ * +link_to+ builds a hyperlink to a particular destination
824
+ * +edit_post_path+ and +new_post_path+ are helpers that Rails provides as part of RESTful routing. You'll see a variety of these helpers for the different actions that the controller includes.
825
+
826
+ NOTE. In previous versions of Rails, you had to use +&lt;%=h post.name %&gt;+ so
827
+ that any HTML would be escaped before being inserted into the page. In Rails
828
+ 3 and above, this is now the default. To get unescaped HTML, you now use <tt>&lt;%= raw post.name %&gt;</tt>.
829
+
830
+ TIP: For more details on the rendering process, see "Layouts and Rendering in
831
+ Rails":layouts_and_rendering.html.
832
+
833
+ h4. Customizing the Layout
834
+
835
+ The view is only part of the story of how HTML is displayed in your web browser.
836
+ Rails also has the concept of +layouts+, which are containers for views. When
837
+ Rails renders a view to the browser, it does so by putting the view's HTML into
838
+ a layout's HTML. In previous versions of Rails, the +rails generate scaffold+
839
+ command would automatically create a controller specific layout, like
840
+ +app/views/layouts/posts.html.erb+, for the posts controller. However this has
841
+ been changed in Rails 3. An application specific +layout+ is used for all the
842
+ controllers and can be found in +app/views/layouts/application.html.erb+. Open
843
+ this layout in your editor and modify the +body+ tag to include the style directive
844
+ below:
845
+
846
+ <erb>
847
+ <!DOCTYPE html>
848
+ <html>
849
+ <head>
850
+ <title>Blog</title>
851
+ <%= stylesheet_link_tag "application" %>
852
+ <%= javascript_include_tag "application" %>
853
+ <%= csrf_meta_tags %>
854
+ </head>
855
+ <body style="background: #EEEEEE;">
856
+
857
+ <%= yield %>
858
+
859
+ </body>
860
+ </html>
861
+ </erb>
862
+
863
+ Now when you refresh the +/posts+ page, you'll see a gray background to the
864
+ page. This same gray background will be used throughout all the views for posts.
865
+
866
+ h4. Creating New Posts
867
+
868
+ Creating a new post involves two actions. The first is the +new+ action, which
869
+ instantiates an empty +Post+ object:
870
+
871
+ <ruby>
872
+ def new
873
+ @post = Post.new
874
+
875
+ respond_to do |format|
876
+ format.html # new.html.erb
877
+ format.json { render :json => @post }
878
+ end
879
+ end
880
+ </ruby>
881
+
882
+ The +new.html.erb+ view displays this empty Post to the user:
883
+
884
+ <erb>
885
+ <h1>New post</h1>
886
+
887
+ <%= render 'form' %>
888
+
889
+ <%= link_to 'Back', posts_path %>
890
+ </erb>
891
+
892
+ The +&lt;%= render 'form' %&gt;+ line is our first introduction to _partials_ in
893
+ Rails. A partial is a snippet of HTML and Ruby code that can be reused in
894
+ multiple locations. In this case, the form used to make a new post is basically
895
+ identical to the form used to edit a post, both having text fields for the name and
896
+ title, a text area for the content, and a button to create the new post or to update
897
+ the existing one.
898
+
899
+ If you take a look at +views/posts/_form.html.erb+ file, you will see the
900
+ following:
901
+
902
+ <erb>
903
+ <%= form_for(@post) do |f| %>
904
+ <% if @post.errors.any? %>
905
+ <div id="errorExplanation">
906
+ <h2><%= pluralize(@post.errors.count, "error") %> prohibited
907
+ this post from being saved:</h2>
908
+ <ul>
909
+ <% @post.errors.full_messages.each do |msg| %>
910
+ <li><%= msg %></li>
911
+ <% end %>
912
+ </ul>
913
+ </div>
914
+ <% end %>
915
+
916
+ <div class="field">
917
+ <%= f.label :name %><br />
918
+ <%= f.text_field :name %>
919
+ </div>
920
+ <div class="field">
921
+ <%= f.label :title %><br />
922
+ <%= f.text_field :title %>
923
+ </div>
924
+ <div class="field">
925
+ <%= f.label :content %><br />
926
+ <%= f.text_area :content %>
927
+ </div>
928
+ <div class="actions">
929
+ <%= f.submit %>
930
+ </div>
931
+ <% end %>
932
+ </erb>
933
+
934
+ This partial receives all the instance variables defined in the calling view
935
+ file. In this case, the controller assigned the new +Post+ object to +@post+,
936
+ which will thus be available in both the view and the partial as +@post+.
937
+
938
+ For more information on partials, refer to the "Layouts and Rendering in
939
+ Rails":layouts_and_rendering.html#using-partials guide.
940
+
941
+ The +form_for+ block is used to create an HTML form. Within this block, you have
942
+ access to methods to build various controls on the form. For example,
943
+ +f.text_field :name+ tells Rails to create a text input on the form and to hook
944
+ it up to the +name+ attribute of the instance being displayed. You can only use
945
+ these methods with attributes of the model that the form is based on (in this
946
+ case +name+, +title+, and +content+). Rails uses +form_for+ in preference to
947
+ having you write raw HTML because the code is more succinct, and because it
948
+ explicitly ties the form to a particular model instance.
949
+
950
+ The +form_for+ block is also smart enough to work out if you are doing a _New
951
+ Post_ or an _Edit Post_ action, and will set the form +action+ tags and submit
952
+ button names appropriately in the HTML output.
953
+
954
+ TIP: If you need to create an HTML form that displays arbitrary fields, not tied
955
+ to a model, you should use the +form_tag+ method, which provides shortcuts for
956
+ building forms that are not necessarily tied to a model instance.
957
+
958
+ When the user clicks the +Create Post+ button on this form, the browser will
959
+ send information back to the +create+ action of the controller (Rails knows to
960
+ call the +create+ action because the form is sent with an HTTP POST request;
961
+ that's one of the conventions that were mentioned earlier):
962
+
963
+ <ruby>
964
+ def create
965
+ @post = Post.new(params[:post])
966
+
967
+ respond_to do |format|
968
+ if @post.save
969
+ format.html { redirect_to(@post,
970
+ :notice => 'Post was successfully created.') }
971
+ format.json { render :json => @post,
972
+ :status => :created, :location => @post }
973
+ else
974
+ format.html { render :action => "new" }
975
+ format.json { render :json => @post.errors,
976
+ :status => :unprocessable_entity }
977
+ end
978
+ end
979
+ end
980
+ </ruby>
981
+
982
+ The +create+ action instantiates a new Post object from the data supplied by the
983
+ user on the form, which Rails makes available in the +params+ hash. After
984
+ successfully saving the new post, +create+ returns the appropriate format that
985
+ the user has requested (HTML in our case). It then redirects the user to the
986
+ resulting post +show+ action and sets a notice to the user that the Post was
987
+ successfully created.
988
+
989
+ If the post was not successfully saved, due to a validation error, then the
990
+ controller returns the user back to the +new+ action with any error messages so
991
+ that the user has the chance to fix the error and try again.
992
+
993
+ The "Post was successfully created." message is stored in the Rails
994
+ +flash+ hash (usually just called _the flash_), so that messages can be carried
995
+ over to another action, providing the user with useful information on the status
996
+ of their request. In the case of +create+, the user never actually sees any page
997
+ rendered during the post creation process, because it immediately redirects to
998
+ the new +Post+ as soon as Rails saves the record. The Flash carries over a message to
999
+ the next action, so that when the user is redirected back to the +show+ action,
1000
+ they are presented with a message saying "Post was successfully created."
1001
+
1002
+ h4. Showing an Individual Post
1003
+
1004
+ When you click the +show+ link for a post on the index page, it will bring you
1005
+ to a URL like +http://localhost:3000/posts/1+. Rails interprets this as a call
1006
+ to the +show+ action for the resource, and passes in +1+ as the +:id+ parameter.
1007
+ Here's the +show+ action:
1008
+
1009
+ <ruby>
1010
+ def show
1011
+ @post = Post.find(params[:id])
1012
+
1013
+ respond_to do |format|
1014
+ format.html # show.html.erb
1015
+ format.json { render :json => @post }
1016
+ end
1017
+ end
1018
+ </ruby>
1019
+
1020
+ The +show+ action uses +Post.find+ to search for a single record in the database
1021
+ by its id value. After finding the record, Rails displays it by using
1022
+ +app/views/posts/show.html.erb+:
1023
+
1024
+ <erb>
1025
+ <p id="notice"><%= notice %></p>
1026
+
1027
+ <p>
1028
+ <b>Name:</b>
1029
+ <%= @post.name %>
1030
+ </p>
1031
+
1032
+ <p>
1033
+ <b>Title:</b>
1034
+ <%= @post.title %>
1035
+ </p>
1036
+
1037
+ <p>
1038
+ <b>Content:</b>
1039
+ <%= @post.content %>
1040
+ </p>
1041
+
1042
+
1043
+ <%= link_to 'Edit', edit_post_path(@post) %> |
1044
+ <%= link_to 'Back', posts_path %>
1045
+ </erb>
1046
+
1047
+ h4. Editing Posts
1048
+
1049
+ Like creating a new post, editing a post is a two-part process. The first step
1050
+ is a request to +edit_post_path(@post)+ with a particular post. This calls the
1051
+ +edit+ action in the controller:
1052
+
1053
+ <ruby>
1054
+ def edit
1055
+ @post = Post.find(params[:id])
1056
+ end
1057
+ </ruby>
1058
+
1059
+ After finding the requested post, Rails uses the +edit.html.erb+ view to display
1060
+ it:
1061
+
1062
+ <erb>
1063
+ <h1>Editing post</h1>
1064
+
1065
+ <%= render 'form' %>
1066
+
1067
+ <%= link_to 'Show', @post %> |
1068
+ <%= link_to 'Back', posts_path %>
1069
+ </erb>
1070
+
1071
+ Again, as with the +new+ action, the +edit+ action is using the +form+ partial.
1072
+ This time, however, the form will do a PUT action to the +PostsController+ and the
1073
+ submit button will display "Update Post".
1074
+
1075
+ Submitting the form created by this view will invoke the +update+ action within
1076
+ the controller:
1077
+
1078
+ <ruby>
1079
+ def update
1080
+ @post = Post.find(params[:id])
1081
+
1082
+ respond_to do |format|
1083
+ if @post.update_attributes(params[:post])
1084
+ format.html { redirect_to(@post,
1085
+ :notice => 'Post was successfully updated.') }
1086
+ format.json { head :no_content }
1087
+ else
1088
+ format.html { render :action => "edit" }
1089
+ format.json { render :json => @post.errors,
1090
+ :status => :unprocessable_entity }
1091
+ end
1092
+ end
1093
+ end
1094
+ </ruby>
1095
+
1096
+ In the +update+ action, Rails first uses the +:id+ parameter passed back from
1097
+ the edit view to locate the database record that's being edited. The
1098
+ +update_attributes+ call then takes the +post+ parameter (a hash) from the request
1099
+ and applies it to this record. If all goes well, the user is redirected to the
1100
+ post's +show+ action. If there are any problems, it redirects back to the +edit+ action to
1101
+ correct them.
1102
+
1103
+ h4. Destroying a Post
1104
+
1105
+ Finally, clicking one of the +destroy+ links sends the associated id to the
1106
+ +destroy+ action:
1107
+
1108
+ <ruby>
1109
+ def destroy
1110
+ @post = Post.find(params[:id])
1111
+ @post.destroy
1112
+
1113
+ respond_to do |format|
1114
+ format.html { redirect_to posts_url }
1115
+ format.json { head :no_content }
1116
+ end
1117
+ end
1118
+ </ruby>
1119
+
1120
+ The +destroy+ method of an Active Record model instance removes the
1121
+ corresponding record from the database. After that's done, there isn't any
1122
+ record to display, so Rails redirects the user's browser to the index action of
1123
+ the controller.
1124
+
1125
+ h3. Adding a Second Model
1126
+
1127
+ Now that you've seen what a model built with scaffolding looks like, it's time to
1128
+ add a second model to the application. The second model will handle comments on
1129
+ blog posts.
1130
+
1131
+ h4. Generating a Model
1132
+
1133
+ Models in Rails use a singular name, and their corresponding database tables use
1134
+ a plural name. For the model to hold comments, the convention is to use the name
1135
+ +Comment+. Even if you don't want to use the entire apparatus set up by
1136
+ scaffolding, most Rails developers still use generators to make things like
1137
+ models and controllers. To create the new model, run this command in your
1138
+ terminal:
1139
+
1140
+ <shell>
1141
+ $ rails generate model Comment commenter:string body:text post:references
1142
+ </shell>
1143
+
1144
+ This command will generate four files:
1145
+
1146
+ |_.File |_.Purpose|
1147
+ |db/migrate/20100207235629_create_comments.rb | Migration to create the comments table in your database (your name will include a different timestamp) |
1148
+ | app/models/comment.rb | The Comment model |
1149
+ | test/unit/comment_test.rb | Unit testing harness for the comments model |
1150
+ | test/fixtures/comments.yml | Sample comments for use in testing |
1151
+
1152
+ First, take a look at +comment.rb+:
1153
+
1154
+ <ruby>
1155
+ class Comment < ActiveRecord::Base
1156
+ belongs_to :post
1157
+ end
1158
+ </ruby>
1159
+
1160
+ This is very similar to the +post.rb+ model that you saw earlier. The difference
1161
+ is the line +belongs_to :post+, which sets up an Active Record _association_.
1162
+ You'll learn a little about associations in the next section of this guide.
1163
+
1164
+ In addition to the model, Rails has also made a migration to create the
1165
+ corresponding database table:
1166
+
1167
+ <ruby>
1168
+ class CreateComments < ActiveRecord::Migration
1169
+ def change
1170
+ create_table :comments do |t|
1171
+ t.string :commenter
1172
+ t.text :body
1173
+ t.references :post
1174
+
1175
+ t.timestamps
1176
+ end
1177
+
1178
+ add_index :comments, :post_id
1179
+ end
1180
+ end
1181
+ </ruby>
1182
+
1183
+ The +t.references+ line sets up a foreign key column for the association between
1184
+ the two models. And the +add_index+ line sets up an index for this association
1185
+ column. Go ahead and run the migration:
1186
+
1187
+ <shell>
1188
+ $ rake db:migrate
1189
+ </shell>
1190
+
1191
+ Rails is smart enough to only execute the migrations that have not already been
1192
+ run against the current database, so in this case you will just see:
1193
+
1194
+ <shell>
1195
+ == CreateComments: migrating =================================================
1196
+ -- create_table(:comments)
1197
+ -> 0.0008s
1198
+ -- add_index(:comments, :post_id)
1199
+ -> 0.0003s
1200
+ == CreateComments: migrated (0.0012s) ========================================
1201
+ </shell>
1202
+
1203
+ h4. Associating Models
1204
+
1205
+ Active Record associations let you easily declare the relationship between two
1206
+ models. In the case of comments and posts, you could write out the relationships
1207
+ this way:
1208
+
1209
+ * Each comment belongs to one post.
1210
+ * One post can have many comments.
1211
+
1212
+ In fact, this is very close to the syntax that Rails uses to declare this
1213
+ association. You've already seen the line of code inside the Comment model that
1214
+ makes each comment belong to a Post:
1215
+
1216
+ <ruby>
1217
+ class Comment < ActiveRecord::Base
1218
+ belongs_to :post
1219
+ end
1220
+ </ruby>
1221
+
1222
+ You'll need to edit the +post.rb+ file to add the other side of the association:
1223
+
1224
+ <ruby>
1225
+ class Post < ActiveRecord::Base
1226
+ attr_accessible :content, :name, :title
1227
+
1228
+ validates :name, :presence => true
1229
+ validates :title, :presence => true,
1230
+ :length => { :minimum => 5 }
1231
+
1232
+ has_many :comments
1233
+ end
1234
+ </ruby>
1235
+
1236
+ These two declarations enable a good bit of automatic behavior. For example, if
1237
+ you have an instance variable +@post+ containing a post, you can retrieve all
1238
+ the comments belonging to that post as an array using +@post.comments+.
1239
+
1240
+ TIP: For more information on Active Record associations, see the "Active Record
1241
+ Associations":association_basics.html guide.
1242
+
1243
+ h4. Adding a Route for Comments
1244
+
1245
+ As with the +home+ controller, we will need to add a route so that Rails knows
1246
+ where we would like to navigate to see +comments+. Open up the
1247
+ +config/routes.rb+ file again. Near the top, you will see the entry for +posts+
1248
+ that was added automatically by the scaffold generator: <tt>resources
1249
+ :posts</tt>. Edit it as follows:
1250
+
1251
+ <ruby>
1252
+ resources :posts do
1253
+ resources :comments
1254
+ end
1255
+ </ruby>
1256
+
1257
+ This creates +comments+ as a _nested resource_ within +posts+. This is another
1258
+ part of capturing the hierarchical relationship that exists between posts and
1259
+ comments.
1260
+
1261
+ TIP: For more information on routing, see the "Rails Routing from the Outside
1262
+ In":routing.html guide.
1263
+
1264
+ h4. Generating a Controller
1265
+
1266
+ With the model in hand, you can turn your attention to creating a matching
1267
+ controller. Again, there's a generator for this:
1268
+
1269
+ <shell>
1270
+ $ rails generate controller Comments
1271
+ </shell>
1272
+
1273
+ This creates six files and one empty directory:
1274
+
1275
+ |_.File/Directory |_.Purpose |
1276
+ | app/controllers/comments_controller.rb | The Comments controller |
1277
+ | app/views/comments/ | Views of the controller are stored here |
1278
+ | test/functional/comments_controller_test.rb | The functional tests for the controller |
1279
+ | app/helpers/comments_helper.rb | A view helper file |
1280
+ | test/unit/helpers/comments_helper_test.rb | The unit tests for the helper |
1281
+ | app/assets/javascripts/comment.js.coffee | CoffeeScript for the controller |
1282
+ | app/assets/stylesheets/comment.css.scss | Cascading style sheet for the controller |
1283
+
1284
+ Like with any blog, our readers will create their comments directly after
1285
+ reading the post, and once they have added their comment, will be sent back to
1286
+ the post show page to see their comment now listed. Due to this, our
1287
+ +CommentsController+ is there to provide a method to create comments and delete
1288
+ spam comments when they arrive.
1289
+
1290
+ So first, we'll wire up the Post show template
1291
+ (+/app/views/posts/show.html.erb+) to let us make a new comment:
1292
+
1293
+ <erb>
1294
+ <p id="notice"><%= notice %></p>
1295
+
1296
+ <p>
1297
+ <b>Name:</b>
1298
+ <%= @post.name %>
1299
+ </p>
1300
+
1301
+ <p>
1302
+ <b>Title:</b>
1303
+ <%= @post.title %>
1304
+ </p>
1305
+
1306
+ <p>
1307
+ <b>Content:</b>
1308
+ <%= @post.content %>
1309
+ </p>
1310
+
1311
+ <h2>Add a comment:</h2>
1312
+ <%= form_for([@post, @post.comments.build]) do |f| %>
1313
+ <div class="field">
1314
+ <%= f.label :commenter %><br />
1315
+ <%= f.text_field :commenter %>
1316
+ </div>
1317
+ <div class="field">
1318
+ <%= f.label :body %><br />
1319
+ <%= f.text_area :body %>
1320
+ </div>
1321
+ <div class="actions">
1322
+ <%= f.submit %>
1323
+ </div>
1324
+ <% end %>
1325
+
1326
+ <%= link_to 'Edit Post', edit_post_path(@post) %> |
1327
+ <%= link_to 'Back to Posts', posts_path %> |
1328
+ </erb>
1329
+
1330
+ This adds a form on the +Post+ show page that creates a new comment by
1331
+ calling the +CommentsController+ +create+ action. Let's wire that up:
1332
+
1333
+ <ruby>
1334
+ class CommentsController < ApplicationController
1335
+ def create
1336
+ @post = Post.find(params[:post_id])
1337
+ @comment = @post.comments.create(params[:comment])
1338
+ redirect_to post_path(@post)
1339
+ end
1340
+ end
1341
+ </ruby>
1342
+
1343
+ You'll see a bit more complexity here than you did in the controller for posts.
1344
+ That's a side-effect of the nesting that you've set up. Each request for a
1345
+ comment has to keep track of the post to which the comment is attached, thus the
1346
+ initial call to the +find+ method of the +Post+ model to get the post in question.
1347
+
1348
+ In addition, the code takes advantage of some of the methods available for an
1349
+ association. We use the +create+ method on +@post.comments+ to create and save
1350
+ the comment. This will automatically link the comment so that it belongs to that
1351
+ particular post.
1352
+
1353
+ Once we have made the new comment, we send the user back to the original post
1354
+ using the +post_path(@post)+ helper. As we have already seen, this calls the
1355
+ +show+ action of the +PostsController+ which in turn renders the +show.html.erb+
1356
+ template. This is where we want the comment to show, so let's add that to the
1357
+ +app/views/posts/show.html.erb+.
1358
+
1359
+ <erb>
1360
+ <p id="notice"><%= notice %></p>
1361
+
1362
+ <p>
1363
+ <b>Name:</b>
1364
+ <%= @post.name %>
1365
+ </p>
1366
+
1367
+ <p>
1368
+ <b>Title:</b>
1369
+ <%= @post.title %>
1370
+ </p>
1371
+
1372
+ <p>
1373
+ <b>Content:</b>
1374
+ <%= @post.content %>
1375
+ </p>
1376
+
1377
+ <h2>Comments</h2>
1378
+ <% @post.comments.each do |comment| %>
1379
+ <p>
1380
+ <b>Commenter:</b>
1381
+ <%= comment.commenter %>
1382
+ </p>
1383
+
1384
+ <p>
1385
+ <b>Comment:</b>
1386
+ <%= comment.body %>
1387
+ </p>
1388
+ <% end %>
1389
+
1390
+ <h2>Add a comment:</h2>
1391
+ <%= form_for([@post, @post.comments.build]) do |f| %>
1392
+ <div class="field">
1393
+ <%= f.label :commenter %><br />
1394
+ <%= f.text_field :commenter %>
1395
+ </div>
1396
+ <div class="field">
1397
+ <%= f.label :body %><br />
1398
+ <%= f.text_area :body %>
1399
+ </div>
1400
+ <div class="actions">
1401
+ <%= f.submit %>
1402
+ </div>
1403
+ <% end %>
1404
+
1405
+ <br />
1406
+
1407
+ <%= link_to 'Edit Post', edit_post_path(@post) %> |
1408
+ <%= link_to 'Back to Posts', posts_path %> |
1409
+ </erb>
1410
+
1411
+ Now you can add posts and comments to your blog and have them show up in the
1412
+ right places.
1413
+
1414
+ h3. Refactoring
1415
+
1416
+ Now that we have posts and comments working, take a look at the
1417
+ +app/views/posts/show.html.erb+ template. It is getting long and awkward. We can
1418
+ use partials to clean it up.
1419
+
1420
+ h4. Rendering Partial Collections
1421
+
1422
+ First we will make a comment partial to extract showing all the comments for the
1423
+ post. Create the file +app/views/comments/_comment.html.erb+ and put the
1424
+ following into it:
1425
+
1426
+ <erb>
1427
+ <p>
1428
+ <b>Commenter:</b>
1429
+ <%= comment.commenter %>
1430
+ </p>
1431
+
1432
+ <p>
1433
+ <b>Comment:</b>
1434
+ <%= comment.body %>
1435
+ </p>
1436
+ </erb>
1437
+
1438
+ Then you can change +app/views/posts/show.html.erb+ to look like the
1439
+ following:
1440
+
1441
+ <erb>
1442
+ <p id="notice"><%= notice %></p>
1443
+
1444
+ <p>
1445
+ <b>Name:</b>
1446
+ <%= @post.name %>
1447
+ </p>
1448
+
1449
+ <p>
1450
+ <b>Title:</b>
1451
+ <%= @post.title %>
1452
+ </p>
1453
+
1454
+ <p>
1455
+ <b>Content:</b>
1456
+ <%= @post.content %>
1457
+ </p>
1458
+
1459
+ <h2>Comments</h2>
1460
+ <%= render @post.comments %>
1461
+
1462
+ <h2>Add a comment:</h2>
1463
+ <%= form_for([@post, @post.comments.build]) do |f| %>
1464
+ <div class="field">
1465
+ <%= f.label :commenter %><br />
1466
+ <%= f.text_field :commenter %>
1467
+ </div>
1468
+ <div class="field">
1469
+ <%= f.label :body %><br />
1470
+ <%= f.text_area :body %>
1471
+ </div>
1472
+ <div class="actions">
1473
+ <%= f.submit %>
1474
+ </div>
1475
+ <% end %>
1476
+
1477
+ <br />
1478
+
1479
+ <%= link_to 'Edit Post', edit_post_path(@post) %> |
1480
+ <%= link_to 'Back to Posts', posts_path %> |
1481
+ </erb>
1482
+
1483
+ This will now render the partial in +app/views/comments/_comment.html.erb+ once
1484
+ for each comment that is in the +@post.comments+ collection. As the +render+
1485
+ method iterates over the <tt>@post.comments</tt> collection, it assigns each
1486
+ comment to a local variable named the same as the partial, in this case
1487
+ +comment+ which is then available in the partial for us to show.
1488
+
1489
+ h4. Rendering a Partial Form
1490
+
1491
+ Let us also move that new comment section out to its own partial. Again, you
1492
+ create a file +app/views/comments/_form.html.erb+ containing:
1493
+
1494
+ <erb>
1495
+ <%= form_for([@post, @post.comments.build]) do |f| %>
1496
+ <div class="field">
1497
+ <%= f.label :commenter %><br />
1498
+ <%= f.text_field :commenter %>
1499
+ </div>
1500
+ <div class="field">
1501
+ <%= f.label :body %><br />
1502
+ <%= f.text_area :body %>
1503
+ </div>
1504
+ <div class="actions">
1505
+ <%= f.submit %>
1506
+ </div>
1507
+ <% end %>
1508
+ </erb>
1509
+
1510
+ Then you make the +app/views/posts/show.html.erb+ look like the following:
1511
+
1512
+ <erb>
1513
+ <p id="notice"><%= notice %></p>
1514
+
1515
+ <p>
1516
+ <b>Name:</b>
1517
+ <%= @post.name %>
1518
+ </p>
1519
+
1520
+ <p>
1521
+ <b>Title:</b>
1522
+ <%= @post.title %>
1523
+ </p>
1524
+
1525
+ <p>
1526
+ <b>Content:</b>
1527
+ <%= @post.content %>
1528
+ </p>
1529
+
1530
+ <h2>Comments</h2>
1531
+ <%= render @post.comments %>
1532
+
1533
+ <h2>Add a comment:</h2>
1534
+ <%= render "comments/form" %>
1535
+
1536
+ <br />
1537
+
1538
+ <%= link_to 'Edit Post', edit_post_path(@post) %> |
1539
+ <%= link_to 'Back to Posts', posts_path %> |
1540
+ </erb>
1541
+
1542
+ The second render just defines the partial template we want to render,
1543
+ <tt>comments/form</tt>. Rails is smart enough to spot the forward slash in that
1544
+ string and realize that you want to render the <tt>_form.html.erb</tt> file in
1545
+ the <tt>app/views/comments</tt> directory.
1546
+
1547
+ The +@post+ object is available to any partials rendered in the view because we
1548
+ defined it as an instance variable.
1549
+
1550
+ h3. Deleting Comments
1551
+
1552
+ Another important feature of a blog is being able to delete spam comments. To do
1553
+ this, we need to implement a link of some sort in the view and a +DELETE+ action
1554
+ in the +CommentsController+.
1555
+
1556
+ So first, let's add the delete link in the
1557
+ +app/views/comments/_comment.html.erb+ partial:
1558
+
1559
+ <erb>
1560
+ <p>
1561
+ <b>Commenter:</b>
1562
+ <%= comment.commenter %>
1563
+ </p>
1564
+
1565
+ <p>
1566
+ <b>Comment:</b>
1567
+ <%= comment.body %>
1568
+ </p>
1569
+
1570
+ <p>
1571
+ <%= link_to 'Destroy Comment', [comment.post, comment],
1572
+ :confirm => 'Are you sure?',
1573
+ :method => :delete %>
1574
+ </p>
1575
+ </erb>
1576
+
1577
+ Clicking this new "Destroy Comment" link will fire off a <tt>DELETE
1578
+ /posts/:id/comments/:id</tt> to our +CommentsController+, which can then use
1579
+ this to find the comment we want to delete, so let's add a destroy action to our
1580
+ controller:
1581
+
1582
+ <ruby>
1583
+ class CommentsController < ApplicationController
1584
+
1585
+ def create
1586
+ @post = Post.find(params[:post_id])
1587
+ @comment = @post.comments.create(params[:comment])
1588
+ redirect_to post_path(@post)
1589
+ end
1590
+
1591
+ def destroy
1592
+ @post = Post.find(params[:post_id])
1593
+ @comment = @post.comments.find(params[:id])
1594
+ @comment.destroy
1595
+ redirect_to post_path(@post)
1596
+ end
1597
+
1598
+ end
1599
+ </ruby>
1600
+
1601
+ The +destroy+ action will find the post we are looking at, locate the comment
1602
+ within the <tt>@post.comments</tt> collection, and then remove it from the
1603
+ database and send us back to the show action for the post.
1604
+
1605
+
1606
+ h4. Deleting Associated Objects
1607
+
1608
+ If you delete a post then its associated comments will also need to be deleted.
1609
+ Otherwise they would simply occupy space in the database. Rails allows you to
1610
+ use the +dependent+ option of an association to achieve this. Modify the Post
1611
+ model, +app/models/post.rb+, as follows:
1612
+
1613
+ <ruby>
1614
+ class Post < ActiveRecord::Base
1615
+ attr_accessible :content, :name, :title
1616
+
1617
+ validates :name, :presence => true
1618
+ validates :title, :presence => true,
1619
+ :length => { :minimum => 5 }
1620
+ has_many :comments, :dependent => :destroy
1621
+ end
1622
+ </ruby>
1623
+
1624
+ h3. Security
1625
+
1626
+ If you were to publish your blog online, anybody would be able to add, edit and
1627
+ delete posts or delete comments.
1628
+
1629
+ Rails provides a very simple HTTP authentication system that will work nicely in
1630
+ this situation.
1631
+
1632
+ In the +PostsController+ we need to have a way to block access to the various
1633
+ actions if the person is not authenticated, here we can use the Rails
1634
+ <tt>http_basic_authenticate_with</tt> method, allowing access to the requested
1635
+ action if that method allows it.
1636
+
1637
+ To use the authentication system, we specify it at the top of our
1638
+ +PostsController+, in this case, we want the user to be authenticated on every
1639
+ action, except for +index+ and +show+, so we write that:
1640
+
1641
+ <ruby>
1642
+ class PostsController < ApplicationController
1643
+
1644
+ http_basic_authenticate_with :name => "dhh", :password => "secret", :except => [:index, :show]
1645
+
1646
+ # GET /posts
1647
+ # GET /posts.json
1648
+ def index
1649
+ @posts = Post.all
1650
+ respond_to do |format|
1651
+ # snipped for brevity
1652
+ </ruby>
1653
+
1654
+ We also only want to allow authenticated users to delete comments, so in the
1655
+ +CommentsController+ we write:
1656
+
1657
+ <ruby>
1658
+ class CommentsController < ApplicationController
1659
+
1660
+ http_basic_authenticate_with :name => "dhh", :password => "secret", :only => :destroy
1661
+
1662
+ def create
1663
+ @post = Post.find(params[:post_id])
1664
+ # snipped for brevity
1665
+ </ruby>
1666
+
1667
+ Now if you try to create a new post, you will be greeted with a basic HTTP
1668
+ Authentication challenge
1669
+
1670
+ !images/challenge.png(Basic HTTP Authentication Challenge)!
1671
+
1672
+ h3. Building a Multi-Model Form
1673
+
1674
+ Another feature of your average blog is the ability to tag posts. To implement
1675
+ this feature your application needs to interact with more than one model on a
1676
+ single form. Rails offers support for nested forms.
1677
+
1678
+ To demonstrate this, we will add support for giving each post multiple tags,
1679
+ right in the form where you create the post. First, create a new model to hold
1680
+ the tags:
1681
+
1682
+ <shell>
1683
+ $ rails generate model tag name:string post:references
1684
+ </shell>
1685
+
1686
+ Again, run the migration to create the database table:
1687
+
1688
+ <shell>
1689
+ $ rake db:migrate
1690
+ </shell>
1691
+
1692
+ Next, edit the +post.rb+ file to create the other side of the association, and
1693
+ to tell Rails (via the +accepts_nested_attributes_for+ macro) that you intend to
1694
+ edit tags via posts:
1695
+
1696
+ <ruby>
1697
+ class Post < ActiveRecord::Base
1698
+ attr_accessible :content, :name, :title, :tags_attributes
1699
+
1700
+ validates :name, :presence => true
1701
+ validates :title, :presence => true,
1702
+ :length => { :minimum => 5 }
1703
+
1704
+ has_many :comments, :dependent => :destroy
1705
+ has_many :tags
1706
+
1707
+ accepts_nested_attributes_for :tags, :allow_destroy => :true,
1708
+ :reject_if => proc { |attrs| attrs.all? { |k, v| v.blank? } }
1709
+ end
1710
+ </ruby>
1711
+
1712
+ The +:allow_destroy+ option tells Rails to enable destroying tags through the
1713
+ nested attributes (you'll handle that by displaying a "remove" checkbox on the
1714
+ view that you'll build shortly). The +:reject_if+ option prevents saving new
1715
+ tags that do not have any attributes filled in.
1716
+
1717
+ Also note we had to add +:tags_attributes+ to the +attr_accessible+ list. If
1718
+ we didn't do this there would be a +MassAssignmentSecurity+ exception when we try to
1719
+ update tags through our posts model.
1720
+
1721
+ We will modify +views/posts/_form.html.erb+ to render a partial to make a tag:
1722
+
1723
+ <erb>
1724
+ <% @post.tags.build %>
1725
+ <%= form_for(@post) do |post_form| %>
1726
+ <% if @post.errors.any? %>
1727
+ <div id="errorExplanation">
1728
+ <h2><%= pluralize(@post.errors.count, "error") %> prohibited this post from being saved:</h2>
1729
+ <ul>
1730
+ <% @post.errors.full_messages.each do |msg| %>
1731
+ <li><%= msg %></li>
1732
+ <% end %>
1733
+ </ul>
1734
+ </div>
1735
+ <% end %>
1736
+
1737
+ <div class="field">
1738
+ <%= post_form.label :name %><br />
1739
+ <%= post_form.text_field :name %>
1740
+ </div>
1741
+ <div class="field">
1742
+ <%= post_form.label :title %><br />
1743
+ <%= post_form.text_field :title %>
1744
+ </div>
1745
+ <div class="field">
1746
+ <%= post_form.label :content %><br />
1747
+ <%= post_form.text_area :content %>
1748
+ </div>
1749
+ <h2>Tags</h2>
1750
+ <%= render :partial => 'tags/form',
1751
+ :locals => {:form => post_form} %>
1752
+ <div class="actions">
1753
+ <%= post_form.submit %>
1754
+ </div>
1755
+ <% end %>
1756
+ </erb>
1757
+
1758
+ Note that we have changed the +f+ in +form_for(@post) do |f|+ to +post_form+ to
1759
+ make it easier to understand what is going on.
1760
+
1761
+ This example shows another option of the render helper, being able to pass in
1762
+ local variables, in this case, we want the local variable +form+ in the partial
1763
+ to refer to the +post_form+ object.
1764
+
1765
+ We also add a <tt>@post.tags.build</tt> at the top of this form. This is to make
1766
+ sure there is a new tag ready to have its name filled in by the user. If you do
1767
+ not build the new tag, then the form will not appear as there is no new Tag
1768
+ object ready to create.
1769
+
1770
+ Now create the folder <tt>app/views/tags</tt> and make a file in there called
1771
+ <tt>_form.html.erb</tt> which contains the form for the tag:
1772
+
1773
+ <erb>
1774
+ <%= form.fields_for :tags do |tag_form| %>
1775
+ <div class="field">
1776
+ <%= tag_form.label :name, 'Tag:' %>
1777
+ <%= tag_form.text_field :name %>
1778
+ </div>
1779
+ <% unless tag_form.object.nil? || tag_form.object.new_record? %>
1780
+ <div class="field">
1781
+ <%= tag_form.label :_destroy, 'Remove:' %>
1782
+ <%= tag_form.check_box :_destroy %>
1783
+ </div>
1784
+ <% end %>
1785
+ <% end %>
1786
+ </erb>
1787
+
1788
+ Finally, we will edit the <tt>app/views/posts/show.html.erb</tt> template to
1789
+ show our tags.
1790
+
1791
+ <erb>
1792
+ <p id="notice"><%= notice %></p>
1793
+
1794
+ <p>
1795
+ <b>Name:</b>
1796
+ <%= @post.name %>
1797
+ </p>
1798
+
1799
+ <p>
1800
+ <b>Title:</b>
1801
+ <%= @post.title %>
1802
+ </p>
1803
+
1804
+ <p>
1805
+ <b>Content:</b>
1806
+ <%= @post.content %>
1807
+ </p>
1808
+
1809
+ <p>
1810
+ <b>Tags:</b>
1811
+ <%= @post.tags.map { |t| t.name }.join(", ") %>
1812
+ </p>
1813
+
1814
+ <h2>Comments</h2>
1815
+ <%= render @post.comments %>
1816
+
1817
+ <h2>Add a comment:</h2>
1818
+ <%= render "comments/form" %>
1819
+
1820
+
1821
+ <%= link_to 'Edit Post', edit_post_path(@post) %> |
1822
+ <%= link_to 'Back to Posts', posts_path %> |
1823
+ </erb>
1824
+
1825
+ With these changes in place, you'll find that you can edit a post and its tags
1826
+ directly on the same view.
1827
+
1828
+ However, that method call <tt>@post.tags.map { |t| t.name }.join(", ")</tt> is
1829
+ awkward, we could handle this by making a helper method.
1830
+
1831
+ h3. View Helpers
1832
+
1833
+ View Helpers live in <tt>app/helpers</tt> and provide small snippets of reusable
1834
+ code for views. In our case, we want a method that strings a bunch of objects
1835
+ together using their name attribute and joining them with a comma. As this is
1836
+ for the Post show template, we put it in the PostsHelper.
1837
+
1838
+ Open up <tt>app/helpers/posts_helper.rb</tt> and add the following:
1839
+
1840
+ <erb>
1841
+ module PostsHelper
1842
+ def join_tags(post)
1843
+ post.tags.map { |t| t.name }.join(", ")
1844
+ end
1845
+ end
1846
+ </erb>
1847
+
1848
+ Now you can edit the view in <tt>app/views/posts/show.html.erb</tt> to look like
1849
+ this:
1850
+
1851
+ <erb>
1852
+ <p id="notice"><%= notice %></p>
1853
+
1854
+ <p>
1855
+ <b>Name:</b>
1856
+ <%= @post.name %>
1857
+ </p>
1858
+
1859
+ <p>
1860
+ <b>Title:</b>
1861
+ <%= @post.title %>
1862
+ </p>
1863
+
1864
+ <p>
1865
+ <b>Content:</b>
1866
+ <%= @post.content %>
1867
+ </p>
1868
+
1869
+ <p>
1870
+ <b>Tags:</b>
1871
+ <%= join_tags(@post) %>
1872
+ </p>
1873
+
1874
+ <h2>Comments</h2>
1875
+ <%= render @post.comments %>
1876
+
1877
+ <h2>Add a comment:</h2>
1878
+ <%= render "comments/form" %>
1879
+
1880
+
1881
+ <%= link_to 'Edit Post', edit_post_path(@post) %> |
1882
+ <%= link_to 'Back to Posts', posts_path %> |
1883
+ </erb>
1884
+
1885
+ h3. What's Next?
1886
+
1887
+ Now that you've seen your first Rails application, you should feel free to
1888
+ update it and experiment on your own. But you don't have to do everything
1889
+ without help. As you need assistance getting up and running with Rails, feel
1890
+ free to consult these support resources:
1891
+
1892
+ * The "Ruby on Rails guides":index.html
1893
+ * The "Ruby on Rails Tutorial":http://railstutorial.org/book
1894
+ * The "Ruby on Rails mailing list":http://groups.google.com/group/rubyonrails-talk
1895
+ * The "#rubyonrails":irc://irc.freenode.net/#rubyonrails channel on irc.freenode.net
1896
+
1897
+ Rails also comes with built-in help that you can generate using the rake command-line utility:
1898
+
1899
+ * Running +rake doc:guides+ will put a full copy of the Rails Guides in the +doc/guides+ folder of your application. Open +doc/guides/index.html+ in your web browser to explore the Guides.
1900
+ * Running +rake doc:rails+ will put a full copy of the API documentation for Rails in the +doc/api+ folder of your application. Open +doc/api/index.html+ in your web browser to explore the API documentation.
1901
+
1902
+ h3. Configuration Gotchas
1903
+
1904
+ The easiest way to work with Rails is to store all external data as UTF-8. If
1905
+ you don't, Ruby libraries and Rails will often be able to convert your native
1906
+ data into UTF-8, but this doesn't always work reliably, so you're better off
1907
+ ensuring that all external data is UTF-8.
1908
+
1909
+ If you have made a mistake in this area, the most common symptom is a black
1910
+ diamond with a question mark inside appearing in the browser. Another common
1911
+ symptom is characters like "ü" appearing instead of "ü". Rails takes a number
1912
+ of internal steps to mitigate common causes of these problems that can be
1913
+ automatically detected and corrected. However, if you have external data that is
1914
+ not stored as UTF-8, it can occasionally result in these kinds of issues that
1915
+ cannot be automatically detected by Rails and corrected.
1916
+
1917
+ Two very common sources of data that are not UTF-8:
1918
+ * Your text editor: Most text editors (such as Textmate), default to saving files as
1919
+ UTF-8. If your text editor does not, this can result in special characters that you
1920
+ enter in your templates (such as é) to appear as a diamond with a question mark inside
1921
+ in the browser. This also applies to your I18N translation files.
1922
+ Most editors that do not already default to UTF-8 (such as some versions of
1923
+ Dreamweaver) offer a way to change the default to UTF-8. Do so.
1924
+ * Your database. Rails defaults to converting data from your database into UTF-8 at
1925
+ the boundary. However, if your database is not using UTF-8 internally, it may not
1926
+ be able to store all characters that your users enter. For instance, if your database
1927
+ is using Latin-1 internally, and your user enters a Russian, Hebrew, or Japanese
1928
+ character, the data will be lost forever once it enters the database. If possible,
1929
+ use UTF-8 as the internal storage of your database.