rails 4.2.6.rc1 → 5.2.8.1

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

Potentially problematic release.


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

Files changed (218) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +24 -12
  3. metadata +54 -248
  4. data/guides/CHANGELOG.md +0 -73
  5. data/guides/Rakefile +0 -79
  6. data/guides/assets/images/akshaysurve.jpg +0 -0
  7. data/guides/assets/images/belongs_to.png +0 -0
  8. data/guides/assets/images/book_icon.gif +0 -0
  9. data/guides/assets/images/bullet.gif +0 -0
  10. data/guides/assets/images/chapters_icon.gif +0 -0
  11. data/guides/assets/images/check_bullet.gif +0 -0
  12. data/guides/assets/images/credits_pic_blank.gif +0 -0
  13. data/guides/assets/images/csrf.png +0 -0
  14. data/guides/assets/images/edge_badge.png +0 -0
  15. data/guides/assets/images/favicon.ico +0 -0
  16. data/guides/assets/images/feature_tile.gif +0 -0
  17. data/guides/assets/images/footer_tile.gif +0 -0
  18. data/guides/assets/images/fxn.png +0 -0
  19. data/guides/assets/images/getting_started/article_with_comments.png +0 -0
  20. data/guides/assets/images/getting_started/challenge.png +0 -0
  21. data/guides/assets/images/getting_started/confirm_dialog.png +0 -0
  22. data/guides/assets/images/getting_started/forbidden_attributes_for_new_article.png +0 -0
  23. data/guides/assets/images/getting_started/form_with_errors.png +0 -0
  24. data/guides/assets/images/getting_started/index_action_with_edit_link.png +0 -0
  25. data/guides/assets/images/getting_started/new_article.png +0 -0
  26. data/guides/assets/images/getting_started/rails_welcome.png +0 -0
  27. data/guides/assets/images/getting_started/routing_error_no_controller.png +0 -0
  28. data/guides/assets/images/getting_started/routing_error_no_route_matches.png +0 -0
  29. data/guides/assets/images/getting_started/show_action_for_articles.png +0 -0
  30. data/guides/assets/images/getting_started/template_is_missing_articles_new.png +0 -0
  31. data/guides/assets/images/getting_started/unknown_action_create_for_articles.png +0 -0
  32. data/guides/assets/images/getting_started/unknown_action_new_for_articles.png +0 -0
  33. data/guides/assets/images/grey_bullet.gif +0 -0
  34. data/guides/assets/images/habtm.png +0 -0
  35. data/guides/assets/images/has_many.png +0 -0
  36. data/guides/assets/images/has_many_through.png +0 -0
  37. data/guides/assets/images/has_one.png +0 -0
  38. data/guides/assets/images/has_one_through.png +0 -0
  39. data/guides/assets/images/header_backdrop.png +0 -0
  40. data/guides/assets/images/header_tile.gif +0 -0
  41. data/guides/assets/images/i18n/demo_html_safe.png +0 -0
  42. data/guides/assets/images/i18n/demo_localized_pirate.png +0 -0
  43. data/guides/assets/images/i18n/demo_translated_en.png +0 -0
  44. data/guides/assets/images/i18n/demo_translated_pirate.png +0 -0
  45. data/guides/assets/images/i18n/demo_translation_missing.png +0 -0
  46. data/guides/assets/images/i18n/demo_untranslated.png +0 -0
  47. data/guides/assets/images/icons/README +0 -5
  48. data/guides/assets/images/icons/callouts/1.png +0 -0
  49. data/guides/assets/images/icons/callouts/10.png +0 -0
  50. data/guides/assets/images/icons/callouts/11.png +0 -0
  51. data/guides/assets/images/icons/callouts/12.png +0 -0
  52. data/guides/assets/images/icons/callouts/13.png +0 -0
  53. data/guides/assets/images/icons/callouts/14.png +0 -0
  54. data/guides/assets/images/icons/callouts/15.png +0 -0
  55. data/guides/assets/images/icons/callouts/2.png +0 -0
  56. data/guides/assets/images/icons/callouts/3.png +0 -0
  57. data/guides/assets/images/icons/callouts/4.png +0 -0
  58. data/guides/assets/images/icons/callouts/5.png +0 -0
  59. data/guides/assets/images/icons/callouts/6.png +0 -0
  60. data/guides/assets/images/icons/callouts/7.png +0 -0
  61. data/guides/assets/images/icons/callouts/8.png +0 -0
  62. data/guides/assets/images/icons/callouts/9.png +0 -0
  63. data/guides/assets/images/icons/caution.png +0 -0
  64. data/guides/assets/images/icons/example.png +0 -0
  65. data/guides/assets/images/icons/home.png +0 -0
  66. data/guides/assets/images/icons/important.png +0 -0
  67. data/guides/assets/images/icons/next.png +0 -0
  68. data/guides/assets/images/icons/note.png +0 -0
  69. data/guides/assets/images/icons/prev.png +0 -0
  70. data/guides/assets/images/icons/tip.png +0 -0
  71. data/guides/assets/images/icons/up.png +0 -0
  72. data/guides/assets/images/icons/warning.png +0 -0
  73. data/guides/assets/images/nav_arrow.gif +0 -0
  74. data/guides/assets/images/oscardelben.jpg +0 -0
  75. data/guides/assets/images/polymorphic.png +0 -0
  76. data/guides/assets/images/radar.png +0 -0
  77. data/guides/assets/images/rails4_features.png +0 -0
  78. data/guides/assets/images/rails_guides_kindle_cover.jpg +0 -0
  79. data/guides/assets/images/rails_guides_logo.gif +0 -0
  80. data/guides/assets/images/rails_logo_remix.gif +0 -0
  81. data/guides/assets/images/session_fixation.png +0 -0
  82. data/guides/assets/images/tab_grey.gif +0 -0
  83. data/guides/assets/images/tab_info.gif +0 -0
  84. data/guides/assets/images/tab_note.gif +0 -0
  85. data/guides/assets/images/tab_red.gif +0 -0
  86. data/guides/assets/images/tab_yellow.gif +0 -0
  87. data/guides/assets/images/tab_yellow.png +0 -0
  88. data/guides/assets/images/vijaydev.jpg +0 -0
  89. data/guides/assets/javascripts/guides.js +0 -59
  90. data/guides/assets/javascripts/jquery.min.js +0 -4
  91. data/guides/assets/javascripts/responsive-tables.js +0 -43
  92. data/guides/assets/javascripts/syntaxhighlighter/shBrushAS3.js +0 -59
  93. data/guides/assets/javascripts/syntaxhighlighter/shBrushAppleScript.js +0 -75
  94. data/guides/assets/javascripts/syntaxhighlighter/shBrushBash.js +0 -59
  95. data/guides/assets/javascripts/syntaxhighlighter/shBrushCSharp.js +0 -65
  96. data/guides/assets/javascripts/syntaxhighlighter/shBrushColdFusion.js +0 -100
  97. data/guides/assets/javascripts/syntaxhighlighter/shBrushCpp.js +0 -97
  98. data/guides/assets/javascripts/syntaxhighlighter/shBrushCss.js +0 -91
  99. data/guides/assets/javascripts/syntaxhighlighter/shBrushDelphi.js +0 -55
  100. data/guides/assets/javascripts/syntaxhighlighter/shBrushDiff.js +0 -41
  101. data/guides/assets/javascripts/syntaxhighlighter/shBrushErlang.js +0 -52
  102. data/guides/assets/javascripts/syntaxhighlighter/shBrushGroovy.js +0 -67
  103. data/guides/assets/javascripts/syntaxhighlighter/shBrushJScript.js +0 -52
  104. data/guides/assets/javascripts/syntaxhighlighter/shBrushJava.js +0 -57
  105. data/guides/assets/javascripts/syntaxhighlighter/shBrushJavaFX.js +0 -58
  106. data/guides/assets/javascripts/syntaxhighlighter/shBrushPerl.js +0 -72
  107. data/guides/assets/javascripts/syntaxhighlighter/shBrushPhp.js +0 -88
  108. data/guides/assets/javascripts/syntaxhighlighter/shBrushPlain.js +0 -33
  109. data/guides/assets/javascripts/syntaxhighlighter/shBrushPowerShell.js +0 -74
  110. data/guides/assets/javascripts/syntaxhighlighter/shBrushPython.js +0 -64
  111. data/guides/assets/javascripts/syntaxhighlighter/shBrushRuby.js +0 -55
  112. data/guides/assets/javascripts/syntaxhighlighter/shBrushSass.js +0 -94
  113. data/guides/assets/javascripts/syntaxhighlighter/shBrushScala.js +0 -51
  114. data/guides/assets/javascripts/syntaxhighlighter/shBrushSql.js +0 -66
  115. data/guides/assets/javascripts/syntaxhighlighter/shBrushVb.js +0 -56
  116. data/guides/assets/javascripts/syntaxhighlighter/shBrushXml.js +0 -69
  117. data/guides/assets/javascripts/syntaxhighlighter/shCore.js +0 -17
  118. data/guides/assets/stylesheets/fixes.css +0 -16
  119. data/guides/assets/stylesheets/kindle.css +0 -11
  120. data/guides/assets/stylesheets/main.css +0 -713
  121. data/guides/assets/stylesheets/print.css +0 -52
  122. data/guides/assets/stylesheets/reset.css +0 -43
  123. data/guides/assets/stylesheets/responsive-tables.css +0 -50
  124. data/guides/assets/stylesheets/style.css +0 -13
  125. data/guides/assets/stylesheets/syntaxhighlighter/shCore.css +0 -226
  126. data/guides/assets/stylesheets/syntaxhighlighter/shCoreDefault.css +0 -328
  127. data/guides/assets/stylesheets/syntaxhighlighter/shCoreDjango.css +0 -331
  128. data/guides/assets/stylesheets/syntaxhighlighter/shCoreEclipse.css +0 -339
  129. data/guides/assets/stylesheets/syntaxhighlighter/shCoreEmacs.css +0 -324
  130. data/guides/assets/stylesheets/syntaxhighlighter/shCoreFadeToGrey.css +0 -328
  131. data/guides/assets/stylesheets/syntaxhighlighter/shCoreMDUltra.css +0 -324
  132. data/guides/assets/stylesheets/syntaxhighlighter/shCoreMidnight.css +0 -324
  133. data/guides/assets/stylesheets/syntaxhighlighter/shCoreRDark.css +0 -324
  134. data/guides/assets/stylesheets/syntaxhighlighter/shThemeDefault.css +0 -117
  135. data/guides/assets/stylesheets/syntaxhighlighter/shThemeDjango.css +0 -120
  136. data/guides/assets/stylesheets/syntaxhighlighter/shThemeEclipse.css +0 -128
  137. data/guides/assets/stylesheets/syntaxhighlighter/shThemeEmacs.css +0 -113
  138. data/guides/assets/stylesheets/syntaxhighlighter/shThemeFadeToGrey.css +0 -117
  139. data/guides/assets/stylesheets/syntaxhighlighter/shThemeMDUltra.css +0 -113
  140. data/guides/assets/stylesheets/syntaxhighlighter/shThemeMidnight.css +0 -113
  141. data/guides/assets/stylesheets/syntaxhighlighter/shThemeRDark.css +0 -113
  142. data/guides/assets/stylesheets/syntaxhighlighter/shThemeRailsGuides.css +0 -116
  143. data/guides/bug_report_templates/action_controller_gem.rb +0 -47
  144. data/guides/bug_report_templates/action_controller_master.rb +0 -54
  145. data/guides/bug_report_templates/active_record_gem.rb +0 -40
  146. data/guides/bug_report_templates/active_record_master.rb +0 -49
  147. data/guides/bug_report_templates/generic_gem.rb +0 -15
  148. data/guides/bug_report_templates/generic_master.rb +0 -26
  149. data/guides/rails_guides/generator.rb +0 -248
  150. data/guides/rails_guides/helpers.rb +0 -53
  151. data/guides/rails_guides/indexer.rb +0 -68
  152. data/guides/rails_guides/kindle.rb +0 -119
  153. data/guides/rails_guides/levenshtein.rb +0 -37
  154. data/guides/rails_guides/markdown/renderer.rb +0 -82
  155. data/guides/rails_guides/markdown.rb +0 -167
  156. data/guides/rails_guides.rb +0 -63
  157. data/guides/source/2_2_release_notes.md +0 -435
  158. data/guides/source/2_3_release_notes.md +0 -621
  159. data/guides/source/3_0_release_notes.md +0 -611
  160. data/guides/source/3_1_release_notes.md +0 -559
  161. data/guides/source/3_2_release_notes.md +0 -568
  162. data/guides/source/4_0_release_notes.md +0 -279
  163. data/guides/source/4_1_release_notes.md +0 -730
  164. data/guides/source/4_2_release_notes.md +0 -877
  165. data/guides/source/_license.html.erb +0 -2
  166. data/guides/source/_welcome.html.erb +0 -23
  167. data/guides/source/action_controller_overview.md +0 -1192
  168. data/guides/source/action_mailer_basics.md +0 -757
  169. data/guides/source/action_view_overview.md +0 -1561
  170. data/guides/source/active_job_basics.md +0 -339
  171. data/guides/source/active_model_basics.md +0 -554
  172. data/guides/source/active_record_basics.md +0 -374
  173. data/guides/source/active_record_callbacks.md +0 -413
  174. data/guides/source/active_record_migrations.md +0 -1018
  175. data/guides/source/active_record_postgresql.md +0 -433
  176. data/guides/source/active_record_querying.md +0 -1781
  177. data/guides/source/active_record_validations.md +0 -1179
  178. data/guides/source/active_support_core_extensions.md +0 -3857
  179. data/guides/source/active_support_instrumentation.md +0 -488
  180. data/guides/source/api_documentation_guidelines.md +0 -361
  181. data/guides/source/asset_pipeline.md +0 -1304
  182. data/guides/source/association_basics.md +0 -2245
  183. data/guides/source/autoloading_and_reloading_constants.md +0 -1311
  184. data/guides/source/caching_with_rails.md +0 -379
  185. data/guides/source/command_line.md +0 -625
  186. data/guides/source/configuring.md +0 -1072
  187. data/guides/source/contributing_to_ruby_on_rails.md +0 -628
  188. data/guides/source/credits.html.erb +0 -80
  189. data/guides/source/debugging_rails_applications.md +0 -861
  190. data/guides/source/development_dependencies_install.md +0 -289
  191. data/guides/source/documents.yaml +0 -205
  192. data/guides/source/engines.md +0 -1412
  193. data/guides/source/form_helpers.md +0 -1024
  194. data/guides/source/generators.md +0 -676
  195. data/guides/source/getting_started.md +0 -2086
  196. data/guides/source/i18n.md +0 -1087
  197. data/guides/source/index.html.erb +0 -28
  198. data/guides/source/initialization.md +0 -704
  199. data/guides/source/kindle/copyright.html.erb +0 -1
  200. data/guides/source/kindle/layout.html.erb +0 -27
  201. data/guides/source/kindle/rails_guides.opf.erb +0 -52
  202. data/guides/source/kindle/toc.html.erb +0 -24
  203. data/guides/source/kindle/toc.ncx.erb +0 -64
  204. data/guides/source/kindle/welcome.html.erb +0 -5
  205. data/guides/source/layout.html.erb +0 -140
  206. data/guides/source/layouts_and_rendering.md +0 -1227
  207. data/guides/source/maintenance_policy.md +0 -78
  208. data/guides/source/nested_model_forms.md +0 -228
  209. data/guides/source/plugins.md +0 -444
  210. data/guides/source/rails_application_templates.md +0 -266
  211. data/guides/source/rails_on_rack.md +0 -336
  212. data/guides/source/routing.md +0 -1155
  213. data/guides/source/ruby_on_rails_guides_guidelines.md +0 -127
  214. data/guides/source/security.md +0 -1024
  215. data/guides/source/testing.md +0 -1132
  216. data/guides/source/upgrading_ruby_on_rails.md +0 -1186
  217. data/guides/source/working_with_javascript_in_rails.md +0 -407
  218. data/guides/w3c_validator.rb +0 -97
@@ -1,1186 +0,0 @@
1
- A Guide for Upgrading Ruby on Rails
2
- ===================================
3
-
4
- This guide provides steps to be followed when you upgrade your applications to a newer version of Ruby on Rails. These steps are also available in individual release guides.
5
-
6
- --------------------------------------------------------------------------------
7
-
8
- General Advice
9
- --------------
10
-
11
- Before attempting to upgrade an existing application, you should be sure you have a good reason to upgrade. You need to balance several factors: the need for new features, the increasing difficulty of finding support for old code, and your available time and skills, to name a few.
12
-
13
- ### Test Coverage
14
-
15
- The best way to be sure that your application still works after upgrading is to have good test coverage before you start the process. If you don't have automated tests that exercise the bulk of your application, you'll need to spend time manually exercising all the parts that have changed. In the case of a Rails upgrade, that will mean every single piece of functionality in the application. Do yourself a favor and make sure your test coverage is good _before_ you start an upgrade.
16
-
17
- ### Ruby Versions
18
-
19
- Rails generally stays close to the latest released Ruby version when it's released:
20
-
21
- * Rails 3 and above require Ruby 1.8.7 or higher. Support for all of the previous Ruby versions has been dropped officially. You should upgrade as early as possible.
22
- * Rails 3.2.x is the last branch to support Ruby 1.8.7.
23
- * Rails 4 prefers Ruby 2.0 and requires 1.9.3 or newer.
24
-
25
- TIP: Ruby 1.8.7 p248 and p249 have marshaling bugs that crash Rails. Ruby Enterprise Edition has these fixed since the release of 1.8.7-2010.02. On the 1.9 front, Ruby 1.9.1 is not usable because it outright segfaults, so if you want to use 1.9.x, jump straight to 1.9.3 for smooth sailing.
26
-
27
- ### The Rake Task
28
-
29
- Rails provides the `rails:update` rake task. After updating the Rails version
30
- in the Gemfile, run this rake task.
31
- This will help you with the creation of new files and changes of old files in an
32
- interactive session.
33
-
34
- ```bash
35
- $ rake rails:update
36
- identical config/boot.rb
37
- exist config
38
- conflict config/routes.rb
39
- Overwrite /myapp/config/routes.rb? (enter "h" for help) [Ynaqdh]
40
- force config/routes.rb
41
- conflict config/application.rb
42
- Overwrite /myapp/config/application.rb? (enter "h" for help) [Ynaqdh]
43
- force config/application.rb
44
- conflict config/environment.rb
45
- ...
46
- ```
47
-
48
- Don't forget to review the difference, to see if there were any unexpected changes.
49
-
50
- Upgrading from Rails 4.1 to Rails 4.2
51
- -------------------------------------
52
-
53
- ### Web Console
54
-
55
- First, add `gem 'web-console', '~> 2.0'` to the `:development` group in your Gemfile and run `bundle install` (it won't have been included when you upgraded Rails). Once it's been installed, you can simply drop a reference to the console helper (i.e., `<%= console %>`) into any view you want to enable it for. A console will also be provided on any error page you view in your development environment.
56
-
57
- ### Responders
58
-
59
- `respond_with` and the class-level `respond_to` methods have been extracted to the `responders` gem. To use them, simply add `gem 'responders', '~> 2.0'` to your Gemfile. Calls to `respond_with` and `respond_to` (again, at the class level) will no longer work without having included the `responders` gem in your dependencies:
60
-
61
- ```ruby
62
- # app/controllers/users_controller.rb
63
-
64
- class UsersController < ApplicationController
65
- respond_to :html, :json
66
-
67
- def show
68
- @user = User.find(params[:id])
69
- respond_with @user
70
- end
71
- end
72
- ```
73
-
74
- Instance-level `respond_to` is unaffected and does not require the additional gem:
75
-
76
- ```ruby
77
- # app/controllers/users_controller.rb
78
-
79
- class UsersController < ApplicationController
80
- def show
81
- @user = User.find(params[:id])
82
- respond_to do |format|
83
- format.html
84
- format.json { render json: @user }
85
- end
86
- end
87
- end
88
- ```
89
-
90
- See [#16526](https://github.com/rails/rails/pull/16526) for more details.
91
-
92
- ### Error handling in transaction callbacks
93
-
94
- Currently, Active Record suppresses errors raised
95
- within `after_rollback` or `after_commit` callbacks and only prints them to
96
- the logs. In the next version, these errors will no longer be suppressed.
97
- Instead, the errors will propagate normally just like in other Active
98
- Record callbacks.
99
-
100
- When you define a `after_rollback` or `after_commit` callback, you
101
- will receive a deprecation warning about this upcoming change. When
102
- you are ready, you can opt into the new behavior and remove the
103
- deprecation warning by adding following configuration to your
104
- `config/application.rb`:
105
-
106
- config.active_record.raise_in_transactional_callbacks = true
107
-
108
- See [#14488](https://github.com/rails/rails/pull/14488) and
109
- [#16537](https://github.com/rails/rails/pull/16537) for more details.
110
-
111
- ### Ordering of test cases
112
-
113
- In Rails 5.0, test cases will be executed in random order by default. In
114
- anticipation of this change, Rails 4.2 introduced a new configuration option
115
- `active_support.test_order` for explicitly specifying the test ordering. This
116
- allows you to either lock down the current behavior by setting the option to
117
- `:sorted`, or opt into the future behavior by setting the option to `:random`.
118
-
119
- If you do not specify a value for this option, a deprecation warning will be
120
- emitted. To avoid this, add the following line to your test environment:
121
-
122
- ```ruby
123
- # config/environments/test.rb
124
- Rails.application.configure do
125
- config.active_support.test_order = :sorted # or `:random` if you prefer
126
- end
127
- ```
128
-
129
- ### Serialized attributes
130
-
131
- When using a custom coder (e.g. `serialize :metadata, JSON`),
132
- assigning `nil` to a serialized attribute will save it to the database
133
- as `NULL` instead of passing the `nil` value through the coder (e.g. `"null"`
134
- when using the `JSON` coder).
135
-
136
- ### Production log level
137
-
138
- In Rails 5, the default log level for the production environment will be changed
139
- to `:debug` (from `:info`). To preserve the current default, add the following
140
- line to your `production.rb`:
141
-
142
- ```ruby
143
- # Set to `:info` to match the current default, or set to `:debug` to opt-into
144
- # the future default.
145
- config.log_level = :info
146
- ```
147
-
148
- ### `after_bundle` in Rails templates
149
-
150
- If you have a Rails template that adds all the files in version control, it
151
- fails to add the generated binstubs because it gets executed before Bundler:
152
-
153
- ```ruby
154
- # template.rb
155
- generate(:scaffold, "person name:string")
156
- route "root to: 'people#index'"
157
- rake("db:migrate")
158
-
159
- git :init
160
- git add: "."
161
- git commit: %Q{ -m 'Initial commit' }
162
- ```
163
-
164
- You can now wrap the `git` calls in an `after_bundle` block. It will be run
165
- after the binstubs have been generated.
166
-
167
- ```ruby
168
- # template.rb
169
- generate(:scaffold, "person name:string")
170
- route "root to: 'people#index'"
171
- rake("db:migrate")
172
-
173
- after_bundle do
174
- git :init
175
- git add: "."
176
- git commit: %Q{ -m 'Initial commit' }
177
- end
178
- ```
179
-
180
- ### Rails HTML Sanitizer
181
-
182
- There's a new choice for sanitizing HTML fragments in your applications. The
183
- venerable html-scanner approach is now officially being deprecated in favor of
184
- [`Rails HTML Sanitizer`](https://github.com/rails/rails-html-sanitizer).
185
-
186
- This means the methods `sanitize`, `sanitize_css`, `strip_tags` and
187
- `strip_links` are backed by a new implementation.
188
-
189
- This new sanitizer uses [Loofah](https://github.com/flavorjones/loofah) internally. Loofah in turn uses Nokogiri, which
190
- wraps XML parsers written in both C and Java, so sanitization should be faster
191
- no matter which Ruby version you run.
192
-
193
- The new version updates `sanitize`, so it can take a `Loofah::Scrubber` for
194
- powerful scrubbing.
195
- [See some examples of scrubbers here](https://github.com/flavorjones/loofah#loofahscrubber).
196
-
197
- Two new scrubbers have also been added: `PermitScrubber` and `TargetScrubber`.
198
- Read the [gem's readme](https://github.com/rails/rails-html-sanitizer) for more information.
199
-
200
- The documentation for `PermitScrubber` and `TargetScrubber` explains how you
201
- can gain complete control over when and how elements should be stripped.
202
-
203
- If your application needs to use the old sanitizer implementation, include `rails-deprecated_sanitizer` in your Gemfile:
204
-
205
- ```ruby
206
- gem 'rails-deprecated_sanitizer'
207
- ```
208
-
209
- ### Rails DOM Testing
210
-
211
- The [`TagAssertions` module](http://api.rubyonrails.org/classes/ActionDispatch/Assertions/TagAssertions.html) (containing methods such as `assert_tag`), [has been deprecated](https://github.com/rails/rails/blob/6061472b8c310158a2a2e8e9a6b81a1aef6b60fe/actionpack/lib/action_dispatch/testing/assertions/dom.rb) in favor of the `assert_select` methods from the `SelectorAssertions` module, which has been extracted into the [rails-dom-testing gem](https://github.com/rails/rails-dom-testing).
212
-
213
-
214
- ### Masked Authenticity Tokens
215
-
216
- In order to mitigate SSL attacks, `form_authenticity_token` is now masked so that it varies with each request. Thus, tokens are validated by unmasking and then decrypting. As a result, any strategies for verifying requests from non-rails forms that relied on a static session CSRF token have to take this into account.
217
-
218
- ### Action Mailer
219
-
220
- Previously, calling a mailer method on a mailer class will result in the
221
- corresponding instance method being executed directly. With the introduction of
222
- Active Job and `#deliver_later`, this is no longer true. In Rails 4.2, the
223
- invocation of the instance methods are deferred until either `deliver_now` or
224
- `deliver_later` is called. For example:
225
-
226
- ```ruby
227
- class Notifier < ActionMailer::Base
228
- def notify(user, ...)
229
- puts "Called"
230
- mail(to: user.email, ...)
231
- end
232
- end
233
-
234
- mail = Notifier.notify(user, ...) # Notifier#welcome is not yet called at this point
235
- mail = mail.deliver_now # Prints "Called"
236
- ```
237
-
238
- This should not result in any noticible differnces for most applications.
239
- However, if you need some non-mailer methods to be exectuted synchronously, and
240
- you were previously relying on the synchronous proxying behavior, you should
241
- define them as class methods on the mailer class directly:
242
-
243
- ```ruby
244
- class Notifier < ActionMailer::Base
245
- def self.broadcast_notifications(users, ...)
246
- users.each { |user| Notifier.notify(user, ...) }
247
- end
248
- end
249
- ```
250
-
251
- ### Foreign Key Support
252
-
253
- The migration DSL has been expanded to support foreign key definitions. If
254
- you've been using the Foreigner gem, you might want to consider removing it.
255
- Note that the foreign key support of Rails is a subset of Foreigner. This means
256
- that not every Foreigner definition can be fully replaced by it's Rails
257
- migration DSL counterpart.
258
-
259
- The migration procedure is as follows:
260
-
261
- 1. remove `gem "foreigner"` from the Gemfile.
262
- 2. run `bundle install`.
263
- 3. run `bin/rake db:schema:dump`.
264
- 4. make sure that `db/schema.rb` contains every foreign key definition with
265
- the necessary options.
266
-
267
- Upgrading from Rails 4.0 to Rails 4.1
268
- -------------------------------------
269
-
270
- ### CSRF protection from remote `<script>` tags
271
-
272
- Or, "whaaat my tests are failing!!!?"
273
-
274
- Cross-site request forgery (CSRF) protection now covers GET requests with
275
- JavaScript responses, too. This prevents a third-party site from referencing
276
- your JavaScript URL and attempting to run it to extract sensitive data.
277
-
278
- This means that your functional and integration tests that use
279
-
280
- ```ruby
281
- get :index, format: :js
282
- ```
283
-
284
- will now trigger CSRF protection. Switch to
285
-
286
- ```ruby
287
- xhr :get, :index, format: :js
288
- ```
289
-
290
- to explicitly test an `XmlHttpRequest`.
291
-
292
- If you really mean to load JavaScript from remote `<script>` tags, skip CSRF
293
- protection on that action.
294
-
295
- ### Spring
296
-
297
- If you want to use Spring as your application preloader you need to:
298
-
299
- 1. Add `gem 'spring', group: :development` to your `Gemfile`.
300
- 2. Install spring using `bundle install`.
301
- 3. Springify your binstubs with `bundle exec spring binstub --all`.
302
-
303
- NOTE: User defined rake tasks will run in the `development` environment by
304
- default. If you want them to run in other environments consult the
305
- [Spring README](https://github.com/rails/spring#rake).
306
-
307
- ### `config/secrets.yml`
308
-
309
- If you want to use the new `secrets.yml` convention to store your application's
310
- secrets, you need to:
311
-
312
- 1. Create a `secrets.yml` file in your `config` folder with the following content:
313
-
314
- ```yaml
315
- development:
316
- secret_key_base:
317
-
318
- test:
319
- secret_key_base:
320
-
321
- production:
322
- secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
323
- ```
324
-
325
- 2. Use your existing `secret_key_base` from the `secret_token.rb` initializer to
326
- set the SECRET_KEY_BASE environment variable for whichever users running the
327
- Rails application in production mode. Alternatively, you can simply copy the existing
328
- `secret_key_base` from the `secret_token.rb` initializer to `secrets.yml`
329
- under the `production` section, replacing '<%= ENV["SECRET_KEY_BASE"] %>'.
330
-
331
- 3. Remove the `secret_token.rb` initializer.
332
-
333
- 4. Use `rake secret` to generate new keys for the `development` and `test` sections.
334
-
335
- 5. Restart your server.
336
-
337
- ### Changes to test helper
338
-
339
- If your test helper contains a call to
340
- `ActiveRecord::Migration.check_pending!` this can be removed. The check
341
- is now done automatically when you `require 'rails/test_help'`, although
342
- leaving this line in your helper is not harmful in any way.
343
-
344
- ### Cookies serializer
345
-
346
- Applications created before Rails 4.1 uses `Marshal` to serialize cookie values into
347
- the signed and encrypted cookie jars. If you want to use the new `JSON`-based format
348
- in your application, you can add an initializer file with the following content:
349
-
350
- ```ruby
351
- Rails.application.config.action_dispatch.cookies_serializer = :hybrid
352
- ```
353
-
354
- This would transparently migrate your existing `Marshal`-serialized cookies into the
355
- new `JSON`-based format.
356
-
357
- When using the `:json` or `:hybrid` serializer, you should beware that not all
358
- Ruby objects can be serialized as JSON. For example, `Date` and `Time` objects
359
- will be serialized as strings, and `Hash`es will have their keys stringified.
360
-
361
- ```ruby
362
- class CookiesController < ApplicationController
363
- def set_cookie
364
- cookies.encrypted[:expiration_date] = Date.tomorrow # => Thu, 20 Mar 2014
365
- redirect_to action: 'read_cookie'
366
- end
367
-
368
- def read_cookie
369
- cookies.encrypted[:expiration_date] # => "2014-03-20"
370
- end
371
- end
372
- ```
373
-
374
- It's advisable that you only store simple data (strings and numbers) in cookies.
375
- If you have to store complex objects, you would need to handle the conversion
376
- manually when reading the values on subsequent requests.
377
-
378
- If you use the cookie session store, this would apply to the `session` and
379
- `flash` hash as well.
380
-
381
- ### Flash structure changes
382
-
383
- Flash message keys are
384
- [normalized to strings](https://github.com/rails/rails/commit/a668beffd64106a1e1fedb71cc25eaaa11baf0c1). They
385
- can still be accessed using either symbols or strings. Looping through the flash
386
- will always yield string keys:
387
-
388
- ```ruby
389
- flash["string"] = "a string"
390
- flash[:symbol] = "a symbol"
391
-
392
- # Rails < 4.1
393
- flash.keys # => ["string", :symbol]
394
-
395
- # Rails >= 4.1
396
- flash.keys # => ["string", "symbol"]
397
- ```
398
-
399
- Make sure you are comparing Flash message keys against strings.
400
-
401
- ### Changes in JSON handling
402
-
403
- There are a few major changes related to JSON handling in Rails 4.1.
404
-
405
- #### MultiJSON removal
406
-
407
- MultiJSON has reached its [end-of-life](https://github.com/rails/rails/pull/10576)
408
- and has been removed from Rails.
409
-
410
- If your application currently depend on MultiJSON directly, you have a few options:
411
-
412
- 1. Add 'multi_json' to your Gemfile. Note that this might cease to work in the future
413
-
414
- 2. Migrate away from MultiJSON by using `obj.to_json`, and `JSON.parse(str)` instead.
415
-
416
- WARNING: Do not simply replace `MultiJson.dump` and `MultiJson.load` with
417
- `JSON.dump` and `JSON.load`. These JSON gem APIs are meant for serializing and
418
- deserializing arbitrary Ruby objects and are generally [unsafe](http://www.ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-load).
419
-
420
- #### JSON gem compatibility
421
-
422
- Historically, Rails had some compatibility issues with the JSON gem. Using
423
- `JSON.generate` and `JSON.dump` inside a Rails application could produce
424
- unexpected errors.
425
-
426
- Rails 4.1 fixed these issues by isolating its own encoder from the JSON gem. The
427
- JSON gem APIs will function as normal, but they will not have access to any
428
- Rails-specific features. For example:
429
-
430
- ```ruby
431
- class FooBar
432
- def as_json(options = nil)
433
- { foo: 'bar' }
434
- end
435
- end
436
-
437
- >> FooBar.new.to_json # => "{\"foo\":\"bar\"}"
438
- >> JSON.generate(FooBar.new, quirks_mode: true) # => "\"#<FooBar:0x007fa80a481610>\""
439
- ```
440
-
441
- #### New JSON encoder
442
-
443
- The JSON encoder in Rails 4.1 has been rewritten to take advantage of the JSON
444
- gem. For most applications, this should be a transparent change. However, as
445
- part of the rewrite, the following features have been removed from the encoder:
446
-
447
- 1. Circular data structure detection
448
- 2. Support for the `encode_json` hook
449
- 3. Option to encode `BigDecimal` objects as numbers instead of strings
450
-
451
- If your application depends on one of these features, you can get them back by
452
- adding the [`activesupport-json_encoder`](https://github.com/rails/activesupport-json_encoder)
453
- gem to your Gemfile.
454
-
455
- #### JSON representation of Time objects
456
-
457
- `#as_json` for objects with time component (`Time`, `DateTime`, `ActiveSupport::TimeWithZone`)
458
- now returns millisecond precision by default. If you need to keep old behavior with no millisecond
459
- precision, set the following in an initializer:
460
-
461
- ```
462
- ActiveSupport::JSON::Encoding.time_precision = 0
463
- ```
464
-
465
- ### Usage of `return` within inline callback blocks
466
-
467
- Previously, Rails allowed inline callback blocks to use `return` this way:
468
-
469
- ```ruby
470
- class ReadOnlyModel < ActiveRecord::Base
471
- before_save { return false } # BAD
472
- end
473
- ```
474
-
475
- This behavior was never intentionally supported. Due to a change in the internals
476
- of `ActiveSupport::Callbacks`, this is no longer allowed in Rails 4.1. Using a
477
- `return` statement in an inline callback block causes a `LocalJumpError` to
478
- be raised when the callback is executed.
479
-
480
- Inline callback blocks using `return` can be refactored to evaluate to the
481
- returned value:
482
-
483
- ```ruby
484
- class ReadOnlyModel < ActiveRecord::Base
485
- before_save { false } # GOOD
486
- end
487
- ```
488
-
489
- Alternatively, if `return` is preferred it is recommended to explicitly define
490
- a method:
491
-
492
- ```ruby
493
- class ReadOnlyModel < ActiveRecord::Base
494
- before_save :before_save_callback # GOOD
495
-
496
- private
497
- def before_save_callback
498
- return false
499
- end
500
- end
501
- ```
502
-
503
- This change applies to most places in Rails where callbacks are used, including
504
- Active Record and Active Model callbacks, as well as filters in Action
505
- Controller (e.g. `before_action`).
506
-
507
- See [this pull request](https://github.com/rails/rails/pull/13271) for more
508
- details.
509
-
510
- ### Methods defined in Active Record fixtures
511
-
512
- Rails 4.1 evaluates each fixture's ERB in a separate context, so helper methods
513
- defined in a fixture will not be available in other fixtures.
514
-
515
- Helper methods that are used in multiple fixtures should be defined on modules
516
- included in the newly introduced `ActiveRecord::FixtureSet.context_class`, in
517
- `test_helper.rb`.
518
-
519
- ```ruby
520
- module FixtureFileHelpers
521
- def file_sha(path)
522
- Digest::SHA2.hexdigest(File.read(Rails.root.join('test/fixtures', path)))
523
- end
524
- end
525
- ActiveRecord::FixtureSet.context_class.send :include, FixtureFileHelpers
526
- ```
527
-
528
- ### I18n enforcing available locales
529
-
530
- Rails 4.1 now defaults the I18n option `enforce_available_locales` to `true`. This
531
- means that it will make sure that all locales passed to it must be declared in
532
- the `available_locales` list.
533
-
534
- To disable it (and allow I18n to accept *any* locale option) add the following
535
- configuration to your application:
536
-
537
- ```ruby
538
- config.i18n.enforce_available_locales = false
539
- ```
540
-
541
- Note that this option was added as a security measure, to ensure user input
542
- cannot be used as locale information unless it is previously known. Therefore,
543
- it's recommended not to disable this option unless you have a strong reason for
544
- doing so.
545
-
546
- ### Mutator methods called on Relation
547
-
548
- `Relation` no longer has mutator methods like `#map!` and `#delete_if`. Convert
549
- to an `Array` by calling `#to_a` before using these methods.
550
-
551
- It intends to prevent odd bugs and confusion in code that call mutator
552
- methods directly on the `Relation`.
553
-
554
- ```ruby
555
- # Instead of this
556
- Author.where(name: 'Hank Moody').compact!
557
-
558
- # Now you have to do this
559
- authors = Author.where(name: 'Hank Moody').to_a
560
- authors.compact!
561
- ```
562
-
563
- ### Changes on Default Scopes
564
-
565
- Default scopes are no longer overridden by chained conditions.
566
-
567
- In previous versions when you defined a `default_scope` in a model
568
- it was overridden by chained conditions in the same field. Now it
569
- is merged like any other scope.
570
-
571
- Before:
572
-
573
- ```ruby
574
- class User < ActiveRecord::Base
575
- default_scope { where state: 'pending' }
576
- scope :active, -> { where state: 'active' }
577
- scope :inactive, -> { where state: 'inactive' }
578
- end
579
-
580
- User.all
581
- # SELECT "users".* FROM "users" WHERE "users"."state" = 'pending'
582
-
583
- User.active
584
- # SELECT "users".* FROM "users" WHERE "users"."state" = 'active'
585
-
586
- User.where(state: 'inactive')
587
- # SELECT "users".* FROM "users" WHERE "users"."state" = 'inactive'
588
- ```
589
-
590
- After:
591
-
592
- ```ruby
593
- class User < ActiveRecord::Base
594
- default_scope { where state: 'pending' }
595
- scope :active, -> { where state: 'active' }
596
- scope :inactive, -> { where state: 'inactive' }
597
- end
598
-
599
- User.all
600
- # SELECT "users".* FROM "users" WHERE "users"."state" = 'pending'
601
-
602
- User.active
603
- # SELECT "users".* FROM "users" WHERE "users"."state" = 'pending' AND "users"."state" = 'active'
604
-
605
- User.where(state: 'inactive')
606
- # SELECT "users".* FROM "users" WHERE "users"."state" = 'pending' AND "users"."state" = 'inactive'
607
- ```
608
-
609
- To get the previous behavior it is needed to explicitly remove the
610
- `default_scope` condition using `unscoped`, `unscope`, `rewhere` or
611
- `except`.
612
-
613
- ```ruby
614
- class User < ActiveRecord::Base
615
- default_scope { where state: 'pending' }
616
- scope :active, -> { unscope(where: :state).where(state: 'active') }
617
- scope :inactive, -> { rewhere state: 'inactive' }
618
- end
619
-
620
- User.all
621
- # SELECT "users".* FROM "users" WHERE "users"."state" = 'pending'
622
-
623
- User.active
624
- # SELECT "users".* FROM "users" WHERE "users"."state" = 'active'
625
-
626
- User.inactive
627
- # SELECT "users".* FROM "users" WHERE "users"."state" = 'inactive'
628
- ```
629
-
630
- ### Rendering content from string
631
-
632
- Rails 4.1 introduces `:plain`, `:html`, and `:body` options to `render`. Those
633
- options are now the preferred way to render string-based content, as it allows
634
- you to specify which content type you want the response sent as.
635
-
636
- * `render :plain` will set the content type to `text/plain`
637
- * `render :html` will set the content type to `text/html`
638
- * `render :body` will *not* set the content type header.
639
-
640
- From the security standpoint, if you don't expect to have any markup in your
641
- response body, you should be using `render :plain` as most browsers will escape
642
- unsafe content in the response for you.
643
-
644
- We will be deprecating the use of `render :text` in a future version. So please
645
- start using the more precise `:plain`, `:html`, and `:body` options instead.
646
- Using `render :text` may pose a security risk, as the content is sent as
647
- `text/html`.
648
-
649
- ### PostgreSQL json and hstore datatypes
650
-
651
- Rails 4.1 will map `json` and `hstore` columns to a string-keyed Ruby `Hash`.
652
- In earlier versions, a `HashWithIndifferentAccess` was used. This means that
653
- symbol access is no longer supported. This is also the case for
654
- `store_accessors` based on top of `json` or `hstore` columns. Make sure to use
655
- string keys consistently.
656
-
657
- ### Explicit block use for `ActiveSupport::Callbacks`
658
-
659
- Rails 4.1 now expects an explicit block to be passed when calling
660
- `ActiveSupport::Callbacks.set_callback`. This change stems from
661
- `ActiveSupport::Callbacks` being largely rewritten for the 4.1 release.
662
-
663
- ```ruby
664
- # Previously in Rails 4.0
665
- set_callback :save, :around, ->(r, &block) { stuff; result = block.call; stuff }
666
-
667
- # Now in Rails 4.1
668
- set_callback :save, :around, ->(r, block) { stuff; result = block.call; stuff }
669
- ```
670
-
671
- Upgrading from Rails 3.2 to Rails 4.0
672
- -------------------------------------
673
-
674
- If your application is currently on any version of Rails older than 3.2.x, you should upgrade to Rails 3.2 before attempting one to Rails 4.0.
675
-
676
- The following changes are meant for upgrading your application to Rails 4.0.
677
-
678
- ### HTTP PATCH
679
-
680
- Rails 4 now uses `PATCH` as the primary HTTP verb for updates when a RESTful
681
- resource is declared in `config/routes.rb`. The `update` action is still used,
682
- and `PUT` requests will continue to be routed to the `update` action as well.
683
- So, if you're using only the standard RESTful routes, no changes need to be made:
684
-
685
- ```ruby
686
- resources :users
687
- ```
688
-
689
- ```erb
690
- <%= form_for @user do |f| %>
691
- ```
692
-
693
- ```ruby
694
- class UsersController < ApplicationController
695
- def update
696
- # No change needed; PATCH will be preferred, and PUT will still work.
697
- end
698
- end
699
- ```
700
-
701
- However, you will need to make a change if you are using `form_for` to update
702
- a resource in conjunction with a custom route using the `PUT` HTTP method:
703
-
704
- ```ruby
705
- resources :users, do
706
- put :update_name, on: :member
707
- end
708
- ```
709
-
710
- ```erb
711
- <%= form_for [ :update_name, @user ] do |f| %>
712
- ```
713
-
714
- ```ruby
715
- class UsersController < ApplicationController
716
- def update_name
717
- # Change needed; form_for will try to use a non-existent PATCH route.
718
- end
719
- end
720
- ```
721
-
722
- If the action is not being used in a public API and you are free to change the
723
- HTTP method, you can update your route to use `patch` instead of `put`:
724
-
725
- `PUT` requests to `/users/:id` in Rails 4 get routed to `update` as they are
726
- today. So, if you have an API that gets real PUT requests it is going to work.
727
- The router also routes `PATCH` requests to `/users/:id` to the `update` action.
728
-
729
- ```ruby
730
- resources :users do
731
- patch :update_name, on: :member
732
- end
733
- ```
734
-
735
- If the action is being used in a public API and you can't change to HTTP method
736
- being used, you can update your form to use the `PUT` method instead:
737
-
738
- ```erb
739
- <%= form_for [ :update_name, @user ], method: :put do |f| %>
740
- ```
741
-
742
- For more on PATCH and why this change was made, see [this post](http://weblog.rubyonrails.org/2012/2/26/edge-rails-patch-is-the-new-primary-http-method-for-updates/)
743
- on the Rails blog.
744
-
745
- #### A note about media types
746
-
747
- The errata for the `PATCH` verb [specifies that a 'diff' media type should be
748
- used with `PATCH`](http://www.rfc-editor.org/errata_search.php?rfc=5789). One
749
- such format is [JSON Patch](http://tools.ietf.org/html/rfc6902). While Rails
750
- does not support JSON Patch natively, it's easy enough to add support:
751
-
752
- ```
753
- # in your controller
754
- def update
755
- respond_to do |format|
756
- format.json do
757
- # perform a partial update
758
- @article.update params[:article]
759
- end
760
-
761
- format.json_patch do
762
- # perform sophisticated change
763
- end
764
- end
765
- end
766
-
767
- # In config/initializers/json_patch.rb:
768
- Mime::Type.register 'application/json-patch+json', :json_patch
769
- ```
770
-
771
- As JSON Patch was only recently made into an RFC, there aren't a lot of great
772
- Ruby libraries yet. Aaron Patterson's
773
- [hana](https://github.com/tenderlove/hana) is one such gem, but doesn't have
774
- full support for the last few changes in the specification.
775
-
776
- ### Gemfile
777
-
778
- Rails 4.0 removed the `assets` group from Gemfile. You'd need to remove that
779
- line from your Gemfile when upgrading. You should also update your application
780
- file (in `config/application.rb`):
781
-
782
- ```ruby
783
- # Require the gems listed in Gemfile, including any gems
784
- # you've limited to :test, :development, or :production.
785
- Bundler.require(*Rails.groups)
786
- ```
787
-
788
- ### vendor/plugins
789
-
790
- Rails 4.0 no longer supports loading plugins from `vendor/plugins`. You must replace any plugins by extracting them to gems and adding them to your Gemfile. If you choose not to make them gems, you can move them into, say, `lib/my_plugin/*` and add an appropriate initializer in `config/initializers/my_plugin.rb`.
791
-
792
- ### Active Record
793
-
794
- * Rails 4.0 has removed the identity map from Active Record, due to [some inconsistencies with associations](https://github.com/rails/rails/commit/302c912bf6bcd0fa200d964ec2dc4a44abe328a6). If you have manually enabled it in your application, you will have to remove the following config that has no effect anymore: `config.active_record.identity_map`.
795
-
796
- * The `delete` method in collection associations can now receive `Fixnum` or `String` arguments as record ids, besides records, pretty much like the `destroy` method does. Previously it raised `ActiveRecord::AssociationTypeMismatch` for such arguments. From Rails 4.0 on `delete` automatically tries to find the records matching the given ids before deleting them.
797
-
798
- * In Rails 4.0 when a column or a table is renamed the related indexes are also renamed. If you have migrations which rename the indexes, they are no longer needed.
799
-
800
- * Rails 4.0 has changed `serialized_attributes` and `attr_readonly` to class methods only. You shouldn't use instance methods since it's now deprecated. You should change them to use class methods, e.g. `self.serialized_attributes` to `self.class.serialized_attributes`.
801
-
802
- * When using the default coder, assigning `nil` to a serialized attribute will save it
803
- to the database as `NULL` instead of passing the `nil` value through YAML (`"--- \n...\n"`).
804
-
805
- * Rails 4.0 has removed `attr_accessible` and `attr_protected` feature in favor of Strong Parameters. You can use the [Protected Attributes gem](https://github.com/rails/protected_attributes) for a smooth upgrade path.
806
-
807
- * If you are not using Protected Attributes, you can remove any options related to
808
- this gem such as `whitelist_attributes` or `mass_assignment_sanitizer` options.
809
-
810
- * Rails 4.0 requires that scopes use a callable object such as a Proc or lambda:
811
-
812
- ```ruby
813
- scope :active, where(active: true)
814
-
815
- # becomes
816
- scope :active, -> { where active: true }
817
- ```
818
-
819
- * Rails 4.0 has deprecated `ActiveRecord::Fixtures` in favor of `ActiveRecord::FixtureSet`.
820
-
821
- * Rails 4.0 has deprecated `ActiveRecord::TestCase` in favor of `ActiveSupport::TestCase`.
822
-
823
- * Rails 4.0 has deprecated the old-style hash based finder API. This means that
824
- methods which previously accepted "finder options" no longer do. For example, `Book.find(:all, conditions: { name: '1984' })` has been deprecated in favor of `Book.where(name: '1984')`
825
-
826
- * All dynamic methods except for `find_by_...` and `find_by_...!` are deprecated.
827
- Here's how you can handle the changes:
828
-
829
- * `find_all_by_...` becomes `where(...)`.
830
- * `find_last_by_...` becomes `where(...).last`.
831
- * `scoped_by_...` becomes `where(...)`.
832
- * `find_or_initialize_by_...` becomes `find_or_initialize_by(...)`.
833
- * `find_or_create_by_...` becomes `find_or_create_by(...)`.
834
-
835
- * Note that `where(...)` returns a relation, not an array like the old finders. If you require an `Array`, use `where(...).to_a`.
836
-
837
- * These equivalent methods may not execute the same SQL as the previous implementation.
838
-
839
- * To re-enable the old finders, you can use the [activerecord-deprecated_finders gem](https://github.com/rails/activerecord-deprecated_finders).
840
-
841
- * Rails 4.0 has changed to default join table for `has_and_belongs_to_many` relations to strip the common prefix off the second table name. Any existing `has_and_belongs_to_many` relationship between models with a common prefix must be specified with the `join_table` option. For example:
842
-
843
- ```ruby
844
- CatalogCategory < ActiveRecord::Base
845
- has_and_belongs_to_many :catalog_products, join_table: 'catalog_categories_catalog_products'
846
- end
847
-
848
- CatalogProduct < ActiveRecord::Base
849
- has_and_belongs_to_many :catalog_categories, join_table: 'catalog_categories_catalog_products'
850
- end
851
- ```
852
-
853
- * Note that the the prefix takes scopes into account as well, so relations between `Catalog::Category` and `Catalog::Product` or `Catalog::Category` and `CatalogProduct` need to be updated similarly.
854
-
855
- ### Active Resource
856
-
857
- Rails 4.0 extracted Active Resource to its own gem. If you still need the feature you can add the [Active Resource gem](https://github.com/rails/activeresource) in your Gemfile.
858
-
859
- ### Active Model
860
-
861
- * Rails 4.0 has changed how errors attach with the `ActiveModel::Validations::ConfirmationValidator`. Now when confirmation validations fail, the error will be attached to `:#{attribute}_confirmation` instead of `attribute`.
862
-
863
- * Rails 4.0 has changed `ActiveModel::Serializers::JSON.include_root_in_json` default value to `false`. Now, Active Model Serializers and Active Record objects have the same default behavior. This means that you can comment or remove the following option in the `config/initializers/wrap_parameters.rb` file:
864
-
865
- ```ruby
866
- # Disable root element in JSON by default.
867
- # ActiveSupport.on_load(:active_record) do
868
- # self.include_root_in_json = false
869
- # end
870
- ```
871
-
872
- ### Action Pack
873
-
874
- * Rails 4.0 introduces `ActiveSupport::KeyGenerator` and uses this as a base from which to generate and verify signed cookies (among other things). Existing signed cookies generated with Rails 3.x will be transparently upgraded if you leave your existing `secret_token` in place and add the new `secret_key_base`.
875
-
876
- ```ruby
877
- # config/initializers/secret_token.rb
878
- Myapp::Application.config.secret_token = 'existing secret token'
879
- Myapp::Application.config.secret_key_base = 'new secret key base'
880
- ```
881
-
882
- Please note that you should wait to set `secret_key_base` until you have 100% of your userbase on Rails 4.x and are reasonably sure you will not need to rollback to Rails 3.x. This is because cookies signed based on the new `secret_key_base` in Rails 4.x are not backwards compatible with Rails 3.x. You are free to leave your existing `secret_token` in place, not set the new `secret_key_base`, and ignore the deprecation warnings until you are reasonably sure that your upgrade is otherwise complete.
883
-
884
- If you are relying on the ability for external applications or Javascript to be able to read your Rails app's signed session cookies (or signed cookies in general) you should not set `secret_key_base` until you have decoupled these concerns.
885
-
886
- * Rails 4.0 encrypts the contents of cookie-based sessions if `secret_key_base` has been set. Rails 3.x signed, but did not encrypt, the contents of cookie-based session. Signed cookies are "secure" in that they are verified to have been generated by your app and are tamper-proof. However, the contents can be viewed by end users, and encrypting the contents eliminates this caveat/concern without a significant performance penalty.
887
-
888
- Please read [Pull Request #9978](https://github.com/rails/rails/pull/9978) for details on the move to encrypted session cookies.
889
-
890
- * Rails 4.0 removed the `ActionController::Base.asset_path` option. Use the assets pipeline feature.
891
-
892
- * Rails 4.0 has deprecated `ActionController::Base.page_cache_extension` option. Use `ActionController::Base.default_static_extension` instead.
893
-
894
- * Rails 4.0 has removed Action and Page caching from Action Pack. You will need to add the `actionpack-action_caching` gem in order to use `caches_action` and the `actionpack-page_caching` to use `caches_pages` in your controllers.
895
-
896
- * Rails 4.0 has removed the XML parameters parser. You will need to add the `actionpack-xml_parser` gem if you require this feature.
897
-
898
- * Rails 4.0 changes the default `layout` lookup set using symbols or procs that return nil. To get the "no layout" behavior, return false instead of nil.
899
-
900
- * Rails 4.0 changes the default memcached client from `memcache-client` to `dalli`. To upgrade, simply add `gem 'dalli'` to your `Gemfile`.
901
-
902
- * Rails 4.0 deprecates the `dom_id` and `dom_class` methods in controllers (they are fine in views). You will need to include the `ActionView::RecordIdentifier` module in controllers requiring this feature.
903
-
904
- * Rails 4.0 deprecates the `:confirm` option for the `link_to` helper. You should
905
- instead rely on a data attribute (e.g. `data: { confirm: 'Are you sure?' }`).
906
- This deprecation also concerns the helpers based on this one (such as `link_to_if`
907
- or `link_to_unless`).
908
-
909
- * Rails 4.0 changed how `assert_generates`, `assert_recognizes`, and `assert_routing` work. Now all these assertions raise `Assertion` instead of `ActionController::RoutingError`.
910
-
911
- * Rails 4.0 raises an `ArgumentError` if clashing named routes are defined. This can be triggered by explicitly defined named routes or by the `resources` method. Here are two examples that clash with routes named `example_path`:
912
-
913
- ```ruby
914
- get 'one' => 'test#example', as: :example
915
- get 'two' => 'test#example', as: :example
916
- ```
917
-
918
- ```ruby
919
- resources :examples
920
- get 'clashing/:id' => 'test#example', as: :example
921
- ```
922
-
923
- In the first case, you can simply avoid using the same name for multiple
924
- routes. In the second, you can use the `only` or `except` options provided by
925
- the `resources` method to restrict the routes created as detailed in the
926
- [Routing Guide](routing.html#restricting-the-routes-created).
927
-
928
- * Rails 4.0 also changed the way unicode character routes are drawn. Now you can draw unicode character routes directly. If you already draw such routes, you must change them, for example:
929
-
930
- ```ruby
931
- get Rack::Utils.escape('こんにちは'), controller: 'welcome', action: 'index'
932
- ```
933
-
934
- becomes
935
-
936
- ```ruby
937
- get 'こんにちは', controller: 'welcome', action: 'index'
938
- ```
939
-
940
- * Rails 4.0 requires that routes using `match` must specify the request method. For example:
941
-
942
- ```ruby
943
- # Rails 3.x
944
- match '/' => 'root#index'
945
-
946
- # becomes
947
- match '/' => 'root#index', via: :get
948
-
949
- # or
950
- get '/' => 'root#index'
951
- ```
952
-
953
- * Rails 4.0 has removed `ActionDispatch::BestStandardsSupport` middleware, `<!DOCTYPE html>` already triggers standards mode per http://msdn.microsoft.com/en-us/library/jj676915(v=vs.85).aspx and ChromeFrame header has been moved to `config.action_dispatch.default_headers`.
954
-
955
- Remember you must also remove any references to the middleware from your application code, for example:
956
-
957
- ```ruby
958
- # Raise exception
959
- config.middleware.insert_before(Rack::Lock, ActionDispatch::BestStandardsSupport)
960
- ```
961
-
962
- Also check your environment settings for `config.action_dispatch.best_standards_support` and remove it if present.
963
-
964
- * In Rails 4.0, precompiling assets no longer automatically copies non-JS/CSS assets from `vendor/assets` and `lib/assets`. Rails application and engine developers should put these assets in `app/assets` or configure `config.assets.precompile`.
965
-
966
- * In Rails 4.0, `ActionController::UnknownFormat` is raised when the action doesn't handle the request format. By default, the exception is handled by responding with 406 Not Acceptable, but you can override that now. In Rails 3, 406 Not Acceptable was always returned. No overrides.
967
-
968
- * In Rails 4.0, a generic `ActionDispatch::ParamsParser::ParseError` exception is raised when `ParamsParser` fails to parse request params. You will want to rescue this exception instead of the low-level `MultiJson::DecodeError`, for example.
969
-
970
- * In Rails 4.0, `SCRIPT_NAME` is properly nested when engines are mounted on an app that's served from a URL prefix. You no longer have to set `default_url_options[:script_name]` to work around overwritten URL prefixes.
971
-
972
- * Rails 4.0 deprecated `ActionController::Integration` in favor of `ActionDispatch::Integration`.
973
- * Rails 4.0 deprecated `ActionController::IntegrationTest` in favor of `ActionDispatch::IntegrationTest`.
974
- * Rails 4.0 deprecated `ActionController::PerformanceTest` in favor of `ActionDispatch::PerformanceTest`.
975
- * Rails 4.0 deprecated `ActionController::AbstractRequest` in favor of `ActionDispatch::Request`.
976
- * Rails 4.0 deprecated `ActionController::Request` in favor of `ActionDispatch::Request`.
977
- * Rails 4.0 deprecated `ActionController::AbstractResponse` in favor of `ActionDispatch::Response`.
978
- * Rails 4.0 deprecated `ActionController::Response` in favor of `ActionDispatch::Response`.
979
- * Rails 4.0 deprecated `ActionController::Routing` in favor of `ActionDispatch::Routing`.
980
-
981
- ### Active Support
982
-
983
- Rails 4.0 removes the `j` alias for `ERB::Util#json_escape` since `j` is already used for `ActionView::Helpers::JavaScriptHelper#escape_javascript`.
984
-
985
- ### Helpers Loading Order
986
-
987
- The order in which helpers from more than one directory are loaded has changed in Rails 4.0. Previously, they were gathered and then sorted alphabetically. After upgrading to Rails 4.0, helpers will preserve the order of loaded directories and will be sorted alphabetically only within each directory. Unless you explicitly use the `helpers_path` parameter, this change will only impact the way of loading helpers from engines. If you rely on the ordering, you should check if correct methods are available after upgrade. If you would like to change the order in which engines are loaded, you can use `config.railties_order=` method.
988
-
989
- ### Active Record Observer and Action Controller Sweeper
990
-
991
- `ActiveRecord::Observer` and `ActionController::Caching::Sweeper` have been extracted to the `rails-observers` gem. You will need to add the `rails-observers` gem if you require these features.
992
-
993
- ### sprockets-rails
994
-
995
- * `assets:precompile:primary` and `assets:precompile:all` have been removed. Use `assets:precompile` instead.
996
- * The `config.assets.compress` option should be changed to `config.assets.js_compressor` like so for instance:
997
-
998
- ```ruby
999
- config.assets.js_compressor = :uglifier
1000
- ```
1001
-
1002
- ### sass-rails
1003
-
1004
- * `asset-url` with two arguments is deprecated. For example: `asset-url("rails.png", image)` becomes `asset-url("rails.png")`.
1005
-
1006
- Upgrading from Rails 3.1 to Rails 3.2
1007
- -------------------------------------
1008
-
1009
- If your application is currently on any version of Rails older than 3.1.x, you
1010
- should upgrade to Rails 3.1 before attempting an update to Rails 3.2.
1011
-
1012
- The following changes are meant for upgrading your application to the latest
1013
- 3.2.x version of Rails.
1014
-
1015
- ### Gemfile
1016
-
1017
- Make the following changes to your `Gemfile`.
1018
-
1019
- ```ruby
1020
- gem 'rails', '3.2.18'
1021
-
1022
- group :assets do
1023
- gem 'sass-rails', '~> 3.2.6'
1024
- gem 'coffee-rails', '~> 3.2.2'
1025
- gem 'uglifier', '>= 1.0.3'
1026
- end
1027
- ```
1028
-
1029
- ### config/environments/development.rb
1030
-
1031
- There are a couple of new configuration settings that you should add to your development environment:
1032
-
1033
- ```ruby
1034
- # Raise exception on mass assignment protection for Active Record models
1035
- config.active_record.mass_assignment_sanitizer = :strict
1036
-
1037
- # Log the query plan for queries taking more than this (works
1038
- # with SQLite, MySQL, and PostgreSQL)
1039
- config.active_record.auto_explain_threshold_in_seconds = 0.5
1040
- ```
1041
-
1042
- ### config/environments/test.rb
1043
-
1044
- The `mass_assignment_sanitizer` configuration setting should also be be added to `config/environments/test.rb`:
1045
-
1046
- ```ruby
1047
- # Raise exception on mass assignment protection for Active Record models
1048
- config.active_record.mass_assignment_sanitizer = :strict
1049
- ```
1050
-
1051
- ### vendor/plugins
1052
-
1053
- Rails 3.2 deprecates `vendor/plugins` and Rails 4.0 will remove them completely. While it's not strictly necessary as part of a Rails 3.2 upgrade, you can start replacing any plugins by extracting them to gems and adding them to your Gemfile. If you choose not to make them gems, you can move them into, say, `lib/my_plugin/*` and add an appropriate initializer in `config/initializers/my_plugin.rb`.
1054
-
1055
- ### Active Record
1056
-
1057
- Option `:dependent => :restrict` has been removed from `belongs_to`. If you want to prevent deleting the object if there are any associated objects, you can set `:dependent => :destroy` and return `false` after checking for existence of association from any of the associated object's destroy callbacks.
1058
-
1059
- Upgrading from Rails 3.0 to Rails 3.1
1060
- -------------------------------------
1061
-
1062
- If your application is currently on any version of Rails older than 3.0.x, you should upgrade to Rails 3.0 before attempting an update to Rails 3.1.
1063
-
1064
- The following changes are meant for upgrading your application to Rails 3.1.12, the last 3.1.x version of Rails.
1065
-
1066
- ### Gemfile
1067
-
1068
- Make the following changes to your `Gemfile`.
1069
-
1070
- ```ruby
1071
- gem 'rails', '3.1.12'
1072
- gem 'mysql2'
1073
-
1074
- # Needed for the new asset pipeline
1075
- group :assets do
1076
- gem 'sass-rails', '~> 3.1.7'
1077
- gem 'coffee-rails', '~> 3.1.1'
1078
- gem 'uglifier', '>= 1.0.3'
1079
- end
1080
-
1081
- # jQuery is the default JavaScript library in Rails 3.1
1082
- gem 'jquery-rails'
1083
- ```
1084
-
1085
- ### config/application.rb
1086
-
1087
- The asset pipeline requires the following additions:
1088
-
1089
- ```ruby
1090
- config.assets.enabled = true
1091
- config.assets.version = '1.0'
1092
- ```
1093
-
1094
- If your application is using an "/assets" route for a resource you may want change the prefix used for assets to avoid conflicts:
1095
-
1096
- ```ruby
1097
- # Defaults to '/assets'
1098
- config.assets.prefix = '/asset-files'
1099
- ```
1100
-
1101
- ### config/environments/development.rb
1102
-
1103
- Remove the RJS setting `config.action_view.debug_rjs = true`.
1104
-
1105
- Add these settings if you enable the asset pipeline:
1106
-
1107
- ```ruby
1108
- # Do not compress assets
1109
- config.assets.compress = false
1110
-
1111
- # Expands the lines which load the assets
1112
- config.assets.debug = true
1113
- ```
1114
-
1115
- ### config/environments/production.rb
1116
-
1117
- Again, most of the changes below are for the asset pipeline. You can read more about these in the [Asset Pipeline](asset_pipeline.html) guide.
1118
-
1119
- ```ruby
1120
- # Compress JavaScripts and CSS
1121
- config.assets.compress = true
1122
-
1123
- # Don't fallback to assets pipeline if a precompiled asset is missed
1124
- config.assets.compile = false
1125
-
1126
- # Generate digests for assets URLs
1127
- config.assets.digest = true
1128
-
1129
- # Defaults to Rails.root.join("public/assets")
1130
- # config.assets.manifest = YOUR_PATH
1131
-
1132
- # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
1133
- # config.assets.precompile += %w( search.js )
1134
-
1135
- # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
1136
- # config.force_ssl = true
1137
- ```
1138
-
1139
- ### config/environments/test.rb
1140
-
1141
- You can help test performance with these additions to your test environment:
1142
-
1143
- ```ruby
1144
- # Configure static asset server for tests with Cache-Control for performance
1145
- config.serve_static_files = true
1146
- config.static_cache_control = 'public, max-age=3600'
1147
- ```
1148
-
1149
- ### config/initializers/wrap_parameters.rb
1150
-
1151
- Add this file with the following contents, if you wish to wrap parameters into a nested hash. This is on by default in new applications.
1152
-
1153
- ```ruby
1154
- # Be sure to restart your server when you modify this file.
1155
- # This file contains settings for ActionController::ParamsWrapper which
1156
- # is enabled by default.
1157
-
1158
- # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
1159
- ActiveSupport.on_load(:action_controller) do
1160
- wrap_parameters format: [:json]
1161
- end
1162
-
1163
- # Disable root element in JSON by default.
1164
- ActiveSupport.on_load(:active_record) do
1165
- self.include_root_in_json = false
1166
- end
1167
- ```
1168
-
1169
- ### config/initializers/session_store.rb
1170
-
1171
- You need to change your session key to something new, or remove all sessions:
1172
-
1173
- ```ruby
1174
- # in config/initializers/session_store.rb
1175
- AppName::Application.config.session_store :cookie_store, key: 'SOMETHINGNEW'
1176
- ```
1177
-
1178
- or
1179
-
1180
- ```bash
1181
- $ bin/rake db:sessions:clear
1182
- ```
1183
-
1184
- ### Remove :cache and :concat options in asset helpers references in views
1185
-
1186
- * With the Asset Pipeline the :cache and :concat options aren't used anymore, delete these options from your views.