rails 3.2.22.5 → 4.2.11.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (218) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +85 -0
  3. data/guides/CHANGELOG.md +103 -0
  4. data/guides/Rakefile +92 -0
  5. data/guides/assets/images/akshaysurve.jpg +0 -0
  6. data/guides/assets/images/belongs_to.png +0 -0
  7. data/guides/assets/images/book_icon.gif +0 -0
  8. data/guides/assets/images/bullet.gif +0 -0
  9. data/guides/assets/images/chapters_icon.gif +0 -0
  10. data/guides/assets/images/check_bullet.gif +0 -0
  11. data/guides/assets/images/credits_pic_blank.gif +0 -0
  12. data/guides/assets/images/csrf.png +0 -0
  13. data/guides/assets/images/edge_badge.png +0 -0
  14. data/guides/assets/images/favicon.ico +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/getting_started/article_with_comments.png +0 -0
  19. data/guides/assets/images/getting_started/challenge.png +0 -0
  20. data/guides/assets/images/getting_started/confirm_dialog.png +0 -0
  21. data/guides/assets/images/getting_started/forbidden_attributes_for_new_article.png +0 -0
  22. data/guides/assets/images/getting_started/form_with_errors.png +0 -0
  23. data/guides/assets/images/getting_started/index_action_with_edit_link.png +0 -0
  24. data/guides/assets/images/getting_started/new_article.png +0 -0
  25. data/guides/assets/images/getting_started/rails_welcome.png +0 -0
  26. data/guides/assets/images/getting_started/routing_error_no_controller.png +0 -0
  27. data/guides/assets/images/getting_started/routing_error_no_route_matches.png +0 -0
  28. data/guides/assets/images/getting_started/show_action_for_articles.png +0 -0
  29. data/guides/assets/images/getting_started/template_is_missing_articles_new.png +0 -0
  30. data/guides/assets/images/getting_started/unknown_action_create_for_articles.png +0 -0
  31. data/guides/assets/images/getting_started/unknown_action_new_for_articles.png +0 -0
  32. data/guides/assets/images/grey_bullet.gif +0 -0
  33. data/guides/assets/images/habtm.png +0 -0
  34. data/guides/assets/images/has_many.png +0 -0
  35. data/guides/assets/images/has_many_through.png +0 -0
  36. data/guides/assets/images/has_one.png +0 -0
  37. data/guides/assets/images/has_one_through.png +0 -0
  38. data/guides/assets/images/header_backdrop.png +0 -0
  39. data/guides/assets/images/header_tile.gif +0 -0
  40. data/guides/assets/images/i18n/demo_html_safe.png +0 -0
  41. data/guides/assets/images/i18n/demo_localized_pirate.png +0 -0
  42. data/guides/assets/images/i18n/demo_translated_en.png +0 -0
  43. data/guides/assets/images/i18n/demo_translated_pirate.png +0 -0
  44. data/guides/assets/images/i18n/demo_translation_missing.png +0 -0
  45. data/guides/assets/images/i18n/demo_untranslated.png +0 -0
  46. data/guides/assets/images/icons/README +5 -0
  47. data/guides/assets/images/icons/callouts/1.png +0 -0
  48. data/guides/assets/images/icons/callouts/10.png +0 -0
  49. data/guides/assets/images/icons/callouts/11.png +0 -0
  50. data/guides/assets/images/icons/callouts/12.png +0 -0
  51. data/guides/assets/images/icons/callouts/13.png +0 -0
  52. data/guides/assets/images/icons/callouts/14.png +0 -0
  53. data/guides/assets/images/icons/callouts/15.png +0 -0
  54. data/guides/assets/images/icons/callouts/2.png +0 -0
  55. data/guides/assets/images/icons/callouts/3.png +0 -0
  56. data/guides/assets/images/icons/callouts/4.png +0 -0
  57. data/guides/assets/images/icons/callouts/5.png +0 -0
  58. data/guides/assets/images/icons/callouts/6.png +0 -0
  59. data/guides/assets/images/icons/callouts/7.png +0 -0
  60. data/guides/assets/images/icons/callouts/8.png +0 -0
  61. data/guides/assets/images/icons/callouts/9.png +0 -0
  62. data/guides/assets/images/icons/caution.png +0 -0
  63. data/guides/assets/images/icons/example.png +0 -0
  64. data/guides/assets/images/icons/home.png +0 -0
  65. data/guides/assets/images/icons/important.png +0 -0
  66. data/guides/assets/images/icons/next.png +0 -0
  67. data/guides/assets/images/icons/note.png +0 -0
  68. data/guides/assets/images/icons/prev.png +0 -0
  69. data/guides/assets/images/icons/tip.png +0 -0
  70. data/guides/assets/images/icons/up.png +0 -0
  71. data/guides/assets/images/icons/warning.png +0 -0
  72. data/guides/assets/images/nav_arrow.gif +0 -0
  73. data/guides/assets/images/oscardelben.jpg +0 -0
  74. data/guides/assets/images/polymorphic.png +0 -0
  75. data/guides/assets/images/radar.png +0 -0
  76. data/guides/assets/images/rails4_features.png +0 -0
  77. data/guides/assets/images/rails_guides_kindle_cover.jpg +0 -0
  78. data/guides/assets/images/rails_guides_logo.gif +0 -0
  79. data/guides/assets/images/rails_logo_remix.gif +0 -0
  80. data/guides/assets/images/session_fixation.png +0 -0
  81. data/guides/assets/images/tab_grey.gif +0 -0
  82. data/guides/assets/images/tab_info.gif +0 -0
  83. data/guides/assets/images/tab_note.gif +0 -0
  84. data/guides/assets/images/tab_red.gif +0 -0
  85. data/guides/assets/images/tab_yellow.gif +0 -0
  86. data/guides/assets/images/tab_yellow.png +0 -0
  87. data/guides/assets/images/vijaydev.jpg +0 -0
  88. data/guides/assets/javascripts/guides.js +59 -0
  89. data/guides/assets/javascripts/jquery.min.js +4 -0
  90. data/guides/assets/javascripts/responsive-tables.js +43 -0
  91. data/guides/assets/javascripts/syntaxhighlighter/shBrushAS3.js +59 -0
  92. data/guides/assets/javascripts/syntaxhighlighter/shBrushAppleScript.js +75 -0
  93. data/guides/assets/javascripts/syntaxhighlighter/shBrushBash.js +59 -0
  94. data/guides/assets/javascripts/syntaxhighlighter/shBrushCSharp.js +65 -0
  95. data/guides/assets/javascripts/syntaxhighlighter/shBrushColdFusion.js +100 -0
  96. data/guides/assets/javascripts/syntaxhighlighter/shBrushCpp.js +97 -0
  97. data/guides/assets/javascripts/syntaxhighlighter/shBrushCss.js +91 -0
  98. data/guides/assets/javascripts/syntaxhighlighter/shBrushDelphi.js +55 -0
  99. data/guides/assets/javascripts/syntaxhighlighter/shBrushDiff.js +41 -0
  100. data/guides/assets/javascripts/syntaxhighlighter/shBrushErlang.js +52 -0
  101. data/guides/assets/javascripts/syntaxhighlighter/shBrushGroovy.js +67 -0
  102. data/guides/assets/javascripts/syntaxhighlighter/shBrushJScript.js +52 -0
  103. data/guides/assets/javascripts/syntaxhighlighter/shBrushJava.js +57 -0
  104. data/guides/assets/javascripts/syntaxhighlighter/shBrushJavaFX.js +58 -0
  105. data/guides/assets/javascripts/syntaxhighlighter/shBrushPerl.js +72 -0
  106. data/guides/assets/javascripts/syntaxhighlighter/shBrushPhp.js +88 -0
  107. data/guides/assets/javascripts/syntaxhighlighter/shBrushPlain.js +33 -0
  108. data/guides/assets/javascripts/syntaxhighlighter/shBrushPowerShell.js +74 -0
  109. data/guides/assets/javascripts/syntaxhighlighter/shBrushPython.js +64 -0
  110. data/guides/assets/javascripts/syntaxhighlighter/shBrushRuby.js +55 -0
  111. data/guides/assets/javascripts/syntaxhighlighter/shBrushSass.js +94 -0
  112. data/guides/assets/javascripts/syntaxhighlighter/shBrushScala.js +51 -0
  113. data/guides/assets/javascripts/syntaxhighlighter/shBrushSql.js +66 -0
  114. data/guides/assets/javascripts/syntaxhighlighter/shBrushVb.js +56 -0
  115. data/guides/assets/javascripts/syntaxhighlighter/shBrushXml.js +69 -0
  116. data/guides/assets/javascripts/syntaxhighlighter/shCore.js +17 -0
  117. data/guides/assets/stylesheets/fixes.css +16 -0
  118. data/guides/assets/stylesheets/kindle.css +11 -0
  119. data/guides/assets/stylesheets/main.css +713 -0
  120. data/guides/assets/stylesheets/print.css +52 -0
  121. data/guides/assets/stylesheets/reset.css +43 -0
  122. data/guides/assets/stylesheets/responsive-tables.css +50 -0
  123. data/guides/assets/stylesheets/style.css +13 -0
  124. data/guides/assets/stylesheets/syntaxhighlighter/shCore.css +226 -0
  125. data/guides/assets/stylesheets/syntaxhighlighter/shCoreDefault.css +328 -0
  126. data/guides/assets/stylesheets/syntaxhighlighter/shCoreDjango.css +331 -0
  127. data/guides/assets/stylesheets/syntaxhighlighter/shCoreEclipse.css +339 -0
  128. data/guides/assets/stylesheets/syntaxhighlighter/shCoreEmacs.css +324 -0
  129. data/guides/assets/stylesheets/syntaxhighlighter/shCoreFadeToGrey.css +328 -0
  130. data/guides/assets/stylesheets/syntaxhighlighter/shCoreMDUltra.css +324 -0
  131. data/guides/assets/stylesheets/syntaxhighlighter/shCoreMidnight.css +324 -0
  132. data/guides/assets/stylesheets/syntaxhighlighter/shCoreRDark.css +324 -0
  133. data/guides/assets/stylesheets/syntaxhighlighter/shThemeDefault.css +117 -0
  134. data/guides/assets/stylesheets/syntaxhighlighter/shThemeDjango.css +120 -0
  135. data/guides/assets/stylesheets/syntaxhighlighter/shThemeEclipse.css +128 -0
  136. data/guides/assets/stylesheets/syntaxhighlighter/shThemeEmacs.css +113 -0
  137. data/guides/assets/stylesheets/syntaxhighlighter/shThemeFadeToGrey.css +117 -0
  138. data/guides/assets/stylesheets/syntaxhighlighter/shThemeMDUltra.css +113 -0
  139. data/guides/assets/stylesheets/syntaxhighlighter/shThemeMidnight.css +113 -0
  140. data/guides/assets/stylesheets/syntaxhighlighter/shThemeRDark.css +113 -0
  141. data/guides/assets/stylesheets/syntaxhighlighter/shThemeRailsGuides.css +116 -0
  142. data/guides/bug_report_templates/action_controller_gem.rb +47 -0
  143. data/guides/bug_report_templates/action_controller_master.rb +54 -0
  144. data/guides/bug_report_templates/active_record_gem.rb +40 -0
  145. data/guides/bug_report_templates/active_record_master.rb +49 -0
  146. data/guides/bug_report_templates/generic_gem.rb +15 -0
  147. data/guides/bug_report_templates/generic_master.rb +26 -0
  148. data/guides/rails_guides.rb +63 -0
  149. data/guides/rails_guides/generator.rb +248 -0
  150. data/guides/rails_guides/helpers.rb +53 -0
  151. data/guides/rails_guides/indexer.rb +68 -0
  152. data/guides/rails_guides/kindle.rb +119 -0
  153. data/guides/rails_guides/levenshtein.rb +37 -0
  154. data/guides/rails_guides/markdown.rb +167 -0
  155. data/guides/rails_guides/markdown/renderer.rb +82 -0
  156. data/guides/source/2_2_release_notes.md +435 -0
  157. data/guides/source/2_3_release_notes.md +621 -0
  158. data/guides/source/3_0_release_notes.md +611 -0
  159. data/guides/source/3_1_release_notes.md +559 -0
  160. data/guides/source/3_2_release_notes.md +568 -0
  161. data/guides/source/4_0_release_notes.md +279 -0
  162. data/guides/source/4_1_release_notes.md +730 -0
  163. data/guides/source/4_2_release_notes.md +877 -0
  164. data/guides/source/_license.html.erb +2 -0
  165. data/guides/source/_welcome.html.erb +23 -0
  166. data/guides/source/action_controller_overview.md +1192 -0
  167. data/guides/source/action_mailer_basics.md +757 -0
  168. data/guides/source/action_view_overview.md +1561 -0
  169. data/guides/source/active_job_basics.md +339 -0
  170. data/guides/source/active_model_basics.md +554 -0
  171. data/guides/source/active_record_basics.md +374 -0
  172. data/guides/source/active_record_callbacks.md +413 -0
  173. data/guides/source/active_record_migrations.md +1018 -0
  174. data/guides/source/active_record_postgresql.md +433 -0
  175. data/guides/source/active_record_querying.md +1781 -0
  176. data/guides/source/active_record_validations.md +1179 -0
  177. data/guides/source/active_support_core_extensions.md +3856 -0
  178. data/guides/source/active_support_instrumentation.md +488 -0
  179. data/guides/source/api_documentation_guidelines.md +361 -0
  180. data/guides/source/asset_pipeline.md +1304 -0
  181. data/guides/source/association_basics.md +2245 -0
  182. data/guides/source/autoloading_and_reloading_constants.md +1311 -0
  183. data/guides/source/caching_with_rails.md +379 -0
  184. data/guides/source/command_line.md +625 -0
  185. data/guides/source/configuring.md +1070 -0
  186. data/guides/source/contributing_to_ruby_on_rails.md +628 -0
  187. data/guides/source/credits.html.erb +80 -0
  188. data/guides/source/debugging_rails_applications.md +861 -0
  189. data/guides/source/development_dependencies_install.md +289 -0
  190. data/guides/source/documents.yaml +205 -0
  191. data/guides/source/engines.md +1412 -0
  192. data/guides/source/form_helpers.md +1024 -0
  193. data/guides/source/generators.md +676 -0
  194. data/guides/source/getting_started.md +2086 -0
  195. data/guides/source/i18n.md +1087 -0
  196. data/guides/source/index.html.erb +28 -0
  197. data/guides/source/initialization.md +704 -0
  198. data/guides/source/kindle/copyright.html.erb +1 -0
  199. data/guides/source/kindle/layout.html.erb +27 -0
  200. data/guides/source/kindle/rails_guides.opf.erb +52 -0
  201. data/guides/source/kindle/toc.html.erb +24 -0
  202. data/guides/source/kindle/toc.ncx.erb +64 -0
  203. data/guides/source/kindle/welcome.html.erb +5 -0
  204. data/guides/source/layout.html.erb +140 -0
  205. data/guides/source/layouts_and_rendering.md +1226 -0
  206. data/guides/source/maintenance_policy.md +78 -0
  207. data/guides/source/nested_model_forms.md +228 -0
  208. data/guides/source/plugins.md +444 -0
  209. data/guides/source/rails_application_templates.md +266 -0
  210. data/guides/source/rails_on_rack.md +335 -0
  211. data/guides/source/routing.md +1155 -0
  212. data/guides/source/ruby_on_rails_guides_guidelines.md +127 -0
  213. data/guides/source/security.md +1024 -0
  214. data/guides/source/testing.md +1132 -0
  215. data/guides/source/upgrading_ruby_on_rails.md +1186 -0
  216. data/guides/source/working_with_javascript_in_rails.md +407 -0
  217. data/guides/w3c_validator.rb +97 -0
  218. metadata +288 -26
@@ -0,0 +1,78 @@
1
+ Maintenance Policy for Ruby on Rails
2
+ ====================================
3
+
4
+ Support of the Rails framework is divided into four groups: New features, bug
5
+ fixes, security issues, and severe security issues. They are handled as
6
+ follows, all versions in `X.Y.Z` format.
7
+
8
+ --------------------------------------------------------------------------------
9
+
10
+ Rails follows a shifted version of [semver](http://semver.org/):
11
+
12
+ **Patch `Z`**
13
+
14
+ Only bug fixes, no API changes, no new features.
15
+ Except as necessary for security fixes.
16
+
17
+ **Minor `Y`**
18
+
19
+ New features, may contain API changes (Serve as major versions of Semver).
20
+ Breaking changes are paired with deprecation notices in the previous minor
21
+ or major release.
22
+
23
+ **Major `X`**
24
+
25
+ New features, will likely contain API changes. The difference between Rails'
26
+ minor and major releases is the magnitude of breaking changes, and usually
27
+ reserved for special occasions.
28
+
29
+ New Features
30
+ ------------
31
+
32
+ New features are only added to the master branch and will not be made available
33
+ in point releases.
34
+
35
+ Bug Fixes
36
+ ---------
37
+
38
+ Only the latest release series will receive bug fixes. When enough bugs are
39
+ fixed and its deemed worthy to release a new gem, this is the branch it happens
40
+ from.
41
+
42
+ In special situations, where someone from the Core Team agrees to support more series,
43
+ they are included in the list of supported series.
44
+
45
+ **Currently included series:** `4.2.Z`, `4.1.Z` (Supported by Rafael França).
46
+
47
+ Security Issues
48
+ ---------------
49
+
50
+ The current release series and the next most recent one will receive patches
51
+ and new versions in case of a security issue.
52
+
53
+ These releases are created by taking the last released version, applying the
54
+ security patches, and releasing. Those patches are then applied to the end of
55
+ the x-y-stable branch. For example, a theoretical 1.2.3 security release would
56
+ be built from 1.2.2, and then added to the end of 1-2-stable. This means that
57
+ security releases are easy to upgrade to if you're running the latest version
58
+ of Rails.
59
+
60
+ **Currently included series:** `4.2.Z`, `4.1.Z`.
61
+
62
+ Severe Security Issues
63
+ ----------------------
64
+
65
+ For severe security issues we will provide new versions as above, and also the
66
+ last major release series will receive patches and new versions. The
67
+ classification of the security issue is judged by the core team.
68
+
69
+ **Currently included series:** `4.2.Z`, `4.1.Z`, `3.2.Z`.
70
+
71
+ Unsupported Release Series
72
+ --------------------------
73
+
74
+ When a release series is no longer supported, it's your own responsibility to
75
+ deal with bugs and security issues. We may provide backports of the fixes and
76
+ publish them to git, however there will be no new versions released. If you are
77
+ not comfortable maintaining your own versions, you should upgrade to a
78
+ supported version.
@@ -0,0 +1,228 @@
1
+ Rails Nested Model Forms
2
+ ========================
3
+
4
+ Creating a form for a model _and_ its associations can become quite tedious. Therefore Rails provides helpers to assist in dealing with the complexities of generating these forms _and_ the required CRUD operations to create, update, and destroy associations.
5
+
6
+ After reading this guide, you will know:
7
+
8
+ * do stuff.
9
+
10
+ --------------------------------------------------------------------------------
11
+
12
+ NOTE: This guide assumes the user knows how to use the [Rails form helpers](form_helpers.html) in general. Also, it's **not** an API reference. For a complete reference please visit [the Rails API documentation](http://api.rubyonrails.org/).
13
+
14
+
15
+ Model setup
16
+ -----------
17
+
18
+ To be able to use the nested model functionality in your forms, the model will need to support some basic operations.
19
+
20
+ First of all, it needs to define a writer method for the attribute that corresponds to the association you are building a nested model form for. The `fields_for` form helper will look for this method to decide whether or not a nested model form should be built.
21
+
22
+ If the associated object is an array, a form builder will be yielded for each object, else only a single form builder will be yielded.
23
+
24
+ Consider a Person model with an associated Address. When asked to yield a nested FormBuilder for the `:address` attribute, the `fields_for` form helper will look for a method on the Person instance named `address_attributes=`.
25
+
26
+ ### ActiveRecord::Base model
27
+
28
+ For an ActiveRecord::Base model and association this writer method is commonly defined with the `accepts_nested_attributes_for` class method:
29
+
30
+ #### has_one
31
+
32
+ ```ruby
33
+ class Person < ActiveRecord::Base
34
+ has_one :address
35
+ accepts_nested_attributes_for :address
36
+ end
37
+ ```
38
+
39
+ #### belongs_to
40
+
41
+ ```ruby
42
+ class Person < ActiveRecord::Base
43
+ belongs_to :firm
44
+ accepts_nested_attributes_for :firm
45
+ end
46
+ ```
47
+
48
+ #### has_many / has_and_belongs_to_many
49
+
50
+ ```ruby
51
+ class Person < ActiveRecord::Base
52
+ has_many :projects
53
+ accepts_nested_attributes_for :projects
54
+ end
55
+ ```
56
+
57
+ NOTE: For greater detail on associations see [Active Record Associations](association_basics.html).
58
+ For a complete reference on associations please visit the API documentation for [ActiveRecord::Associations::ClassMethods](http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html).
59
+
60
+ ### Custom model
61
+
62
+ As you might have inflected from this explanation, you _don't_ necessarily need an ActiveRecord::Base model to use this functionality. The following examples are sufficient to enable the nested model form behavior:
63
+
64
+ #### Single associated object
65
+
66
+ ```ruby
67
+ class Person
68
+ def address
69
+ Address.new
70
+ end
71
+
72
+ def address_attributes=(attributes)
73
+ # ...
74
+ end
75
+ end
76
+ ```
77
+
78
+ #### Association collection
79
+
80
+ ```ruby
81
+ class Person
82
+ def projects
83
+ [Project.new, Project.new]
84
+ end
85
+
86
+ def projects_attributes=(attributes)
87
+ # ...
88
+ end
89
+ end
90
+ ```
91
+
92
+ NOTE: See (TODO) in the advanced section for more information on how to deal with the CRUD operations in your custom model.
93
+
94
+ Views
95
+ -----
96
+
97
+ ### Controller code
98
+
99
+ A nested model form will _only_ be built if the associated object(s) exist. This means that for a new model instance you would probably want to build the associated object(s) first.
100
+
101
+ Consider the following typical RESTful controller which will prepare a new Person instance and its `address` and `projects` associations before rendering the `new` template:
102
+
103
+ ```ruby
104
+ class PeopleController < ApplicationController
105
+ def new
106
+ @person = Person.new
107
+ @person.built_address
108
+ 2.times { @person.projects.build }
109
+ end
110
+
111
+ def create
112
+ @person = Person.new(params[:person])
113
+ if @person.save
114
+ # ...
115
+ end
116
+ end
117
+ end
118
+ ```
119
+
120
+ NOTE: Obviously the instantiation of the associated object(s) can become tedious and not DRY, so you might want to move that into the model itself. ActiveRecord::Base provides an `after_initialize` callback which is a good way to refactor this.
121
+
122
+ ### Form code
123
+
124
+ Now that you have a model instance, with the appropriate methods and associated object(s), you can start building the nested model form.
125
+
126
+ #### Standard form
127
+
128
+ Start out with a regular RESTful form:
129
+
130
+ ```erb
131
+ <%= form_for @person do |f| %>
132
+ <%= f.text_field :name %>
133
+ <% end %>
134
+ ```
135
+
136
+ This will generate the following html:
137
+
138
+ ```html
139
+ <form action="/people" class="new_person" id="new_person" method="post">
140
+ <input id="person_name" name="person[name]" type="text" />
141
+ </form>
142
+ ```
143
+
144
+ #### Nested form for a single associated object
145
+
146
+ Now add a nested form for the `address` association:
147
+
148
+ ```erb
149
+ <%= form_for @person do |f| %>
150
+ <%= f.text_field :name %>
151
+
152
+ <%= f.fields_for :address do |af| %>
153
+ <%= af.text_field :street %>
154
+ <% end %>
155
+ <% end %>
156
+ ```
157
+
158
+ This generates:
159
+
160
+ ```html
161
+ <form action="/people" class="new_person" id="new_person" method="post">
162
+ <input id="person_name" name="person[name]" type="text" />
163
+
164
+ <input id="person_address_attributes_street" name="person[address_attributes][street]" type="text" />
165
+ </form>
166
+ ```
167
+
168
+ Notice that `fields_for` recognized the `address` as an association for which a nested model form should be built by the way it has namespaced the `name` attribute.
169
+
170
+ When this form is posted the Rails parameter parser will construct a hash like the following:
171
+
172
+ ```ruby
173
+ {
174
+ "person" => {
175
+ "name" => "Eloy Duran",
176
+ "address_attributes" => {
177
+ "street" => "Nieuwe Prinsengracht"
178
+ }
179
+ }
180
+ }
181
+ ```
182
+
183
+ That's it. The controller will simply pass this hash on to the model from the `create` action. The model will then handle building the `address` association for you and automatically save it when the parent (`person`) is saved.
184
+
185
+ #### Nested form for a collection of associated objects
186
+
187
+ The form code for an association collection is pretty similar to that of a single associated object:
188
+
189
+ ```erb
190
+ <%= form_for @person do |f| %>
191
+ <%= f.text_field :name %>
192
+
193
+ <%= f.fields_for :projects do |pf| %>
194
+ <%= pf.text_field :name %>
195
+ <% end %>
196
+ <% end %>
197
+ ```
198
+
199
+ Which generates:
200
+
201
+ ```html
202
+ <form action="/people" class="new_person" id="new_person" method="post">
203
+ <input id="person_name" name="person[name]" type="text" />
204
+
205
+ <input id="person_projects_attributes_0_name" name="person[projects_attributes][0][name]" type="text" />
206
+ <input id="person_projects_attributes_1_name" name="person[projects_attributes][1][name]" type="text" />
207
+ </form>
208
+ ```
209
+
210
+ As you can see it has generated 2 `project name` inputs, one for each new `project` that was built in the controller's `new` action. Only this time the `name` attribute of the input contains a digit as an extra namespace. This will be parsed by the Rails parameter parser as:
211
+
212
+ ```ruby
213
+ {
214
+ "person" => {
215
+ "name" => "Eloy Duran",
216
+ "projects_attributes" => {
217
+ "0" => { "name" => "Project 1" },
218
+ "1" => { "name" => "Project 2" }
219
+ }
220
+ }
221
+ }
222
+ ```
223
+
224
+ You can basically see the `projects_attributes` hash as an array of attribute hashes, one for each model instance.
225
+
226
+ NOTE: The reason that `fields_for` constructed a hash instead of an array is that it won't work for any form nested deeper than one level deep.
227
+
228
+ TIP: You _can_ however pass an array to the writer method generated by `accepts_nested_attributes_for` if you're using plain Ruby or some other API access. See (TODO) for more info and example.
@@ -0,0 +1,444 @@
1
+ The Basics of Creating Rails Plugins
2
+ ====================================
3
+
4
+ A Rails plugin is either an extension or a modification of the core framework. Plugins provide:
5
+
6
+ * A way for developers to share bleeding-edge ideas without hurting the stable code base.
7
+ * A segmented architecture so that units of code can be fixed or updated on their own release schedule.
8
+ * An outlet for the core developers so that they don't have to include every cool new feature under the sun.
9
+
10
+ After reading this guide, you will know:
11
+
12
+ * How to create a plugin from scratch.
13
+ * How to write and run tests for the plugin.
14
+
15
+ This guide describes how to build a test-driven plugin that will:
16
+
17
+ * Extend core Ruby classes like Hash and String.
18
+ * Add methods to `ActiveRecord::Base` in the tradition of the `acts_as` plugins.
19
+ * Give you information about where to put generators in your plugin.
20
+
21
+ For the purpose of this guide pretend for a moment that you are an avid bird watcher.
22
+ Your favorite bird is the Yaffle, and you want to create a plugin that allows other developers to share in the Yaffle
23
+ goodness.
24
+
25
+ --------------------------------------------------------------------------------
26
+
27
+ Setup
28
+ -----
29
+
30
+ Currently, Rails plugins are built as gems, _gemified plugins_. They can be shared across
31
+ different rails applications using RubyGems and Bundler if desired.
32
+
33
+ ### Generate a gemified plugin.
34
+
35
+
36
+ Rails ships with a `rails plugin new` command which creates a
37
+ skeleton for developing any kind of Rails extension with the ability
38
+ to run integration tests using a dummy Rails application. Create your
39
+ plugin with the command:
40
+
41
+ ```bash
42
+ $ rails plugin new yaffle
43
+ ```
44
+
45
+ See usage and options by asking for help:
46
+
47
+ ```bash
48
+ $ rails plugin new --help
49
+ ```
50
+
51
+ Testing Your Newly Generated Plugin
52
+ -----------------------------------
53
+
54
+ You can navigate to the directory that contains the plugin, run the `bundle install` command
55
+ and run the one generated test using the `rake` command.
56
+
57
+ You should see:
58
+
59
+ ```bash
60
+ 1 runs, 1 assertions, 0 failures, 0 errors, 0 skips
61
+ ```
62
+
63
+ This will tell you that everything got generated properly and you are ready to start adding functionality.
64
+
65
+ Extending Core Classes
66
+ ----------------------
67
+
68
+ This section will explain how to add a method to String that will be available anywhere in your rails application.
69
+
70
+ In this example you will add a method to String named `to_squawk`. To begin, create a new test file with a few assertions:
71
+
72
+ ```ruby
73
+ # yaffle/test/core_ext_test.rb
74
+
75
+ require 'test_helper'
76
+
77
+ class CoreExtTest < ActiveSupport::TestCase
78
+ def test_to_squawk_prepends_the_word_squawk
79
+ assert_equal "squawk! Hello World", "Hello World".to_squawk
80
+ end
81
+ end
82
+ ```
83
+
84
+ Run `rake` to run the test. This test should fail because we haven't implemented the `to_squawk` method:
85
+
86
+ ```bash
87
+ 1) Error:
88
+ CoreExtTest#test_to_squawk_prepends_the_word_squawk:
89
+ NoMethodError: undefined method `to_squawk' for "Hello World":String
90
+ /path/to/yaffle/test/core_ext_test.rb:5:in `test_to_squawk_prepends_the_word_squawk'
91
+ ```
92
+
93
+ Great - now you are ready to start development.
94
+
95
+ In `lib/yaffle.rb`, add `require 'yaffle/core_ext'`:
96
+
97
+ ```ruby
98
+ # yaffle/lib/yaffle.rb
99
+
100
+ require 'yaffle/core_ext'
101
+
102
+ module Yaffle
103
+ end
104
+ ```
105
+
106
+ Finally, create the `core_ext.rb` file and add the `to_squawk` method:
107
+
108
+ ```ruby
109
+ # yaffle/lib/yaffle/core_ext.rb
110
+
111
+ String.class_eval do
112
+ def to_squawk
113
+ "squawk! #{self}".strip
114
+ end
115
+ end
116
+ ```
117
+
118
+ To test that your method does what it says it does, run the unit tests with `rake` from your plugin directory.
119
+
120
+ ```bash
121
+ 2 runs, 2 assertions, 0 failures, 0 errors, 0 skips
122
+ ```
123
+
124
+ To see this in action, change to the test/dummy directory, fire up a console and start squawking:
125
+
126
+ ```bash
127
+ $ bin/rails console
128
+ >> "Hello World".to_squawk
129
+ => "squawk! Hello World"
130
+ ```
131
+
132
+ Add an "acts_as" Method to Active Record
133
+ ----------------------------------------
134
+
135
+ A common pattern in plugins is to add a method called `acts_as_something` to models. In this case, you
136
+ want to write a method called `acts_as_yaffle` that adds a `squawk` method to your Active Record models.
137
+
138
+ To begin, set up your files so that you have:
139
+
140
+ ```ruby
141
+ # yaffle/test/acts_as_yaffle_test.rb
142
+
143
+ require 'test_helper'
144
+
145
+ class ActsAsYaffleTest < ActiveSupport::TestCase
146
+ end
147
+ ```
148
+
149
+ ```ruby
150
+ # yaffle/lib/yaffle.rb
151
+
152
+ require 'yaffle/core_ext'
153
+ require 'yaffle/acts_as_yaffle'
154
+
155
+ module Yaffle
156
+ end
157
+ ```
158
+
159
+ ```ruby
160
+ # yaffle/lib/yaffle/acts_as_yaffle.rb
161
+
162
+ module Yaffle
163
+ module ActsAsYaffle
164
+ # your code will go here
165
+ end
166
+ end
167
+ ```
168
+
169
+ ### Add a Class Method
170
+
171
+ This plugin will expect that you've added a method to your model named `last_squawk`. However, the
172
+ plugin users might have already defined a method on their model named `last_squawk` that they use
173
+ for something else. This plugin will allow the name to be changed by adding a class method called `yaffle_text_field`.
174
+
175
+ To start out, write a failing test that shows the behavior you'd like:
176
+
177
+ ```ruby
178
+ # yaffle/test/acts_as_yaffle_test.rb
179
+
180
+ require 'test_helper'
181
+
182
+ class ActsAsYaffleTest < ActiveSupport::TestCase
183
+
184
+ def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
185
+ assert_equal "last_squawk", Hickwall.yaffle_text_field
186
+ end
187
+
188
+ def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
189
+ assert_equal "last_tweet", Wickwall.yaffle_text_field
190
+ end
191
+
192
+ end
193
+ ```
194
+
195
+ When you run `rake`, you should see the following:
196
+
197
+ ```
198
+ 1) Error:
199
+ ActsAsYaffleTest#test_a_hickwalls_yaffle_text_field_should_be_last_squawk:
200
+ NameError: uninitialized constant ActsAsYaffleTest::Hickwall
201
+ /path/to/yaffle/test/acts_as_yaffle_test.rb:6:in `test_a_hickwalls_yaffle_text_field_should_be_last_squawk'
202
+
203
+ 2) Error:
204
+ ActsAsYaffleTest#test_a_wickwalls_yaffle_text_field_should_be_last_tweet:
205
+ NameError: uninitialized constant ActsAsYaffleTest::Wickwall
206
+ /path/to/yaffle/test/acts_as_yaffle_test.rb:10:in `test_a_wickwalls_yaffle_text_field_should_be_last_tweet'
207
+
208
+ 4 runs, 2 assertions, 0 failures, 2 errors, 0 skips
209
+ ```
210
+
211
+ This tells us that we don't have the necessary models (Hickwall and Wickwall) that we are trying to test.
212
+ We can easily generate these models in our "dummy" Rails application by running the following commands from the
213
+ test/dummy directory:
214
+
215
+ ```bash
216
+ $ cd test/dummy
217
+ $ bin/rails generate model Hickwall last_squawk:string
218
+ $ bin/rails generate model Wickwall last_squawk:string last_tweet:string
219
+ ```
220
+
221
+ Now you can create the necessary database tables in your testing database by navigating to your dummy app
222
+ and migrating the database. First, run:
223
+
224
+ ```bash
225
+ $ cd test/dummy
226
+ $ bin/rake db:migrate
227
+ ```
228
+
229
+ While you are here, change the Hickwall and Wickwall models so that they know that they are supposed to act
230
+ like yaffles.
231
+
232
+ ```ruby
233
+ # test/dummy/app/models/hickwall.rb
234
+
235
+ class Hickwall < ActiveRecord::Base
236
+ acts_as_yaffle
237
+ end
238
+
239
+ # test/dummy/app/models/wickwall.rb
240
+
241
+ class Wickwall < ActiveRecord::Base
242
+ acts_as_yaffle yaffle_text_field: :last_tweet
243
+ end
244
+
245
+ ```
246
+
247
+ We will also add code to define the `acts_as_yaffle` method.
248
+
249
+ ```ruby
250
+ # yaffle/lib/yaffle/acts_as_yaffle.rb
251
+ module Yaffle
252
+ module ActsAsYaffle
253
+ extend ActiveSupport::Concern
254
+
255
+ included do
256
+ end
257
+
258
+ module ClassMethods
259
+ def acts_as_yaffle(options = {})
260
+ # your code will go here
261
+ end
262
+ end
263
+ end
264
+ end
265
+
266
+ ActiveRecord::Base.send :include, Yaffle::ActsAsYaffle
267
+ ```
268
+
269
+ You can then return to the root directory (`cd ../..`) of your plugin and rerun the tests using `rake`.
270
+
271
+ ```
272
+ 1) Error:
273
+ ActsAsYaffleTest#test_a_hickwalls_yaffle_text_field_should_be_last_squawk:
274
+ NoMethodError: undefined method `yaffle_text_field' for #<Class:0x007fd105e3b218>
275
+ activerecord (4.1.5) lib/active_record/dynamic_matchers.rb:26:in `method_missing'
276
+ /path/to/yaffle/test/acts_as_yaffle_test.rb:6:in `test_a_hickwalls_yaffle_text_field_should_be_last_squawk'
277
+
278
+ 2) Error:
279
+ ActsAsYaffleTest#test_a_wickwalls_yaffle_text_field_should_be_last_tweet:
280
+ NoMethodError: undefined method `yaffle_text_field' for #<Class:0x007fd105e409c0>
281
+ activerecord (4.1.5) lib/active_record/dynamic_matchers.rb:26:in `method_missing'
282
+ /path/to/yaffle/test/acts_as_yaffle_test.rb:10:in `test_a_wickwalls_yaffle_text_field_should_be_last_tweet'
283
+
284
+ 4 runs, 2 assertions, 0 failures, 2 errors, 0 skips
285
+
286
+ ```
287
+
288
+ Getting closer... Now we will implement the code of the `acts_as_yaffle` method to make the tests pass.
289
+
290
+ ```ruby
291
+ # yaffle/lib/yaffle/acts_as_yaffle.rb
292
+
293
+ module Yaffle
294
+ module ActsAsYaffle
295
+ extend ActiveSupport::Concern
296
+
297
+ included do
298
+ end
299
+
300
+ module ClassMethods
301
+ def acts_as_yaffle(options = {})
302
+ cattr_accessor :yaffle_text_field
303
+ self.yaffle_text_field = (options[:yaffle_text_field] || :last_squawk).to_s
304
+ end
305
+ end
306
+ end
307
+ end
308
+
309
+ ActiveRecord::Base.send :include, Yaffle::ActsAsYaffle
310
+ ```
311
+
312
+ When you run `rake`, you should see the tests all pass:
313
+
314
+ ```bash
315
+ 4 runs, 4 assertions, 0 failures, 0 errors, 0 skips
316
+ ```
317
+
318
+ ### Add an Instance Method
319
+
320
+ This plugin will add a method named 'squawk' to any Active Record object that calls 'acts_as_yaffle'. The 'squawk'
321
+ method will simply set the value of one of the fields in the database.
322
+
323
+ To start out, write a failing test that shows the behavior you'd like:
324
+
325
+ ```ruby
326
+ # yaffle/test/acts_as_yaffle_test.rb
327
+ require 'test_helper'
328
+
329
+ class ActsAsYaffleTest < ActiveSupport::TestCase
330
+
331
+ def test_a_hickwalls_yaffle_text_field_should_be_last_squawk
332
+ assert_equal "last_squawk", Hickwall.yaffle_text_field
333
+ end
334
+
335
+ def test_a_wickwalls_yaffle_text_field_should_be_last_tweet
336
+ assert_equal "last_tweet", Wickwall.yaffle_text_field
337
+ end
338
+
339
+ def test_hickwalls_squawk_should_populate_last_squawk
340
+ hickwall = Hickwall.new
341
+ hickwall.squawk("Hello World")
342
+ assert_equal "squawk! Hello World", hickwall.last_squawk
343
+ end
344
+
345
+ def test_wickwalls_squawk_should_populate_last_tweet
346
+ wickwall = Wickwall.new
347
+ wickwall.squawk("Hello World")
348
+ assert_equal "squawk! Hello World", wickwall.last_tweet
349
+ end
350
+ end
351
+ ```
352
+
353
+ Run the test to make sure the last two tests fail with an error that contains "NoMethodError: undefined method `squawk'",
354
+ then update 'acts_as_yaffle.rb' to look like this:
355
+
356
+ ```ruby
357
+ # yaffle/lib/yaffle/acts_as_yaffle.rb
358
+
359
+ module Yaffle
360
+ module ActsAsYaffle
361
+ extend ActiveSupport::Concern
362
+
363
+ included do
364
+ end
365
+
366
+ module ClassMethods
367
+ def acts_as_yaffle(options = {})
368
+ cattr_accessor :yaffle_text_field
369
+ self.yaffle_text_field = (options[:yaffle_text_field] || :last_squawk).to_s
370
+
371
+ include Yaffle::ActsAsYaffle::LocalInstanceMethods
372
+ end
373
+ end
374
+
375
+ module LocalInstanceMethods
376
+ def squawk(string)
377
+ write_attribute(self.class.yaffle_text_field, string.to_squawk)
378
+ end
379
+ end
380
+ end
381
+ end
382
+
383
+ ActiveRecord::Base.send :include, Yaffle::ActsAsYaffle
384
+ ```
385
+
386
+ Run `rake` one final time and you should see:
387
+
388
+ ```
389
+ 6 runs, 6 assertions, 0 failures, 0 errors, 0 skips
390
+ ```
391
+
392
+ NOTE: The use of `write_attribute` to write to the field in model is just one example of how a plugin can interact with the model, and will not always be the right method to use. For example, you could also use:
393
+
394
+ ```ruby
395
+ send("#{self.class.yaffle_text_field}=", string.to_squawk)
396
+ ```
397
+
398
+ Generators
399
+ ----------
400
+
401
+ Generators can be included in your gem simply by creating them in a lib/generators directory of your plugin. More information about
402
+ the creation of generators can be found in the [Generators Guide](generators.html)
403
+
404
+ Publishing Your Gem
405
+ -------------------
406
+
407
+ Gem plugins currently in development can easily be shared from any Git repository. To share the Yaffle gem with others, simply
408
+ commit the code to a Git repository (like GitHub) and add a line to the Gemfile of the application in question:
409
+
410
+ ```ruby
411
+ gem 'yaffle', git: 'git://github.com/yaffle_watcher/yaffle.git'
412
+ ```
413
+
414
+ After running `bundle install`, your gem functionality will be available to the application.
415
+
416
+ When the gem is ready to be shared as a formal release, it can be published to [RubyGems](http://www.rubygems.org).
417
+ For more information about publishing gems to RubyGems, see: [Creating and Publishing Your First Ruby Gem](http://blog.thepete.net/2010/11/creating-and-publishing-your-first-ruby.html).
418
+
419
+ RDoc Documentation
420
+ ------------------
421
+
422
+ Once your plugin is stable and you are ready to deploy, do everyone else a favor and document it! Luckily, writing documentation for your plugin is easy.
423
+
424
+ The first step is to update the README file with detailed information about how to use your plugin. A few key things to include are:
425
+
426
+ * Your name
427
+ * How to install
428
+ * How to add the functionality to the app (several examples of common use cases)
429
+ * Warnings, gotchas or tips that might help users and save them time
430
+
431
+ Once your README is solid, go through and add rdoc comments to all of the methods that developers will use. It's also customary to add '#:nodoc:' comments to those parts of the code that are not included in the public API.
432
+
433
+ Once your comments are good to go, navigate to your plugin directory and run:
434
+
435
+ ```bash
436
+ $ bin/rake rdoc
437
+ ```
438
+
439
+ ### References
440
+
441
+ * [Developing a RubyGem using Bundler](https://github.com/radar/guides/blob/master/gem-development.md)
442
+ * [Using .gemspecs as Intended](http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/)
443
+ * [Gemspec Reference](http://guides.rubygems.org/specification-reference/)
444
+ * [GemPlugins: A Brief Introduction to the Future of Rails Plugins](http://www.intridea.com/blog/2008/6/11/gemplugins-a-brief-introduction-to-the-future-of-rails-plugins)