rails 4.1.4 → 5.2.7

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 (284) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +33 -19
  3. metadata +65 -311
  4. data/guides/CHANGELOG.md +0 -41
  5. data/guides/Rakefile +0 -77
  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 -53
  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 -710
  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 -53
  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/code/getting_started/Gemfile +0 -40
  148. data/guides/code/getting_started/Gemfile.lock +0 -125
  149. data/guides/code/getting_started/README.rdoc +0 -28
  150. data/guides/code/getting_started/Rakefile +0 -6
  151. data/guides/code/getting_started/app/assets/javascripts/application.js +0 -15
  152. data/guides/code/getting_started/app/assets/javascripts/comments.js.coffee +0 -3
  153. data/guides/code/getting_started/app/assets/javascripts/posts.js.coffee +0 -3
  154. data/guides/code/getting_started/app/assets/javascripts/welcome.js.coffee +0 -3
  155. data/guides/code/getting_started/app/assets/stylesheets/application.css +0 -13
  156. data/guides/code/getting_started/app/assets/stylesheets/comments.css.scss +0 -3
  157. data/guides/code/getting_started/app/assets/stylesheets/posts.css.scss +0 -3
  158. data/guides/code/getting_started/app/assets/stylesheets/welcome.css.scss +0 -3
  159. data/guides/code/getting_started/app/controllers/application_controller.rb +0 -5
  160. data/guides/code/getting_started/app/controllers/comments_controller.rb +0 -23
  161. data/guides/code/getting_started/app/controllers/posts_controller.rb +0 -53
  162. data/guides/code/getting_started/app/controllers/welcome_controller.rb +0 -4
  163. data/guides/code/getting_started/app/helpers/application_helper.rb +0 -2
  164. data/guides/code/getting_started/app/helpers/comments_helper.rb +0 -2
  165. data/guides/code/getting_started/app/helpers/posts_helper.rb +0 -2
  166. data/guides/code/getting_started/app/helpers/welcome_helper.rb +0 -2
  167. data/guides/code/getting_started/app/models/comment.rb +0 -3
  168. data/guides/code/getting_started/app/models/post.rb +0 -7
  169. data/guides/code/getting_started/app/views/comments/_comment.html.erb +0 -15
  170. data/guides/code/getting_started/app/views/comments/_form.html.erb +0 -13
  171. data/guides/code/getting_started/app/views/layouts/application.html.erb +0 -14
  172. data/guides/code/getting_started/app/views/posts/_form.html.erb +0 -27
  173. data/guides/code/getting_started/app/views/posts/edit.html.erb +0 -5
  174. data/guides/code/getting_started/app/views/posts/index.html.erb +0 -21
  175. data/guides/code/getting_started/app/views/posts/new.html.erb +0 -5
  176. data/guides/code/getting_started/app/views/posts/show.html.erb +0 -18
  177. data/guides/code/getting_started/app/views/welcome/index.html.erb +0 -4
  178. data/guides/code/getting_started/bin/bundle +0 -4
  179. data/guides/code/getting_started/bin/rails +0 -4
  180. data/guides/code/getting_started/bin/rake +0 -4
  181. data/guides/code/getting_started/config/application.rb +0 -18
  182. data/guides/code/getting_started/config/boot.rb +0 -4
  183. data/guides/code/getting_started/config/database.yml +0 -25
  184. data/guides/code/getting_started/config/environment.rb +0 -5
  185. data/guides/code/getting_started/config/environments/development.rb +0 -30
  186. data/guides/code/getting_started/config/environments/production.rb +0 -80
  187. data/guides/code/getting_started/config/environments/test.rb +0 -36
  188. data/guides/code/getting_started/config/initializers/backtrace_silencers.rb +0 -7
  189. data/guides/code/getting_started/config/initializers/filter_parameter_logging.rb +0 -4
  190. data/guides/code/getting_started/config/initializers/inflections.rb +0 -16
  191. data/guides/code/getting_started/config/initializers/locale.rb +0 -9
  192. data/guides/code/getting_started/config/initializers/mime_types.rb +0 -5
  193. data/guides/code/getting_started/config/initializers/secret_token.rb +0 -12
  194. data/guides/code/getting_started/config/initializers/session_store.rb +0 -3
  195. data/guides/code/getting_started/config/initializers/wrap_parameters.rb +0 -14
  196. data/guides/code/getting_started/config/locales/en.yml +0 -23
  197. data/guides/code/getting_started/config/routes.rb +0 -7
  198. data/guides/code/getting_started/config.ru +0 -4
  199. data/guides/code/getting_started/db/migrate/20130122042648_create_posts.rb +0 -10
  200. data/guides/code/getting_started/db/migrate/20130122045842_create_comments.rb +0 -11
  201. data/guides/code/getting_started/db/schema.rb +0 -33
  202. data/guides/code/getting_started/db/seeds.rb +0 -7
  203. data/guides/code/getting_started/public/404.html +0 -60
  204. data/guides/code/getting_started/public/422.html +0 -60
  205. data/guides/code/getting_started/public/500.html +0 -59
  206. data/guides/code/getting_started/public/favicon.ico +0 -0
  207. data/guides/code/getting_started/public/robots.txt +0 -5
  208. data/guides/code/getting_started/test/controllers/comments_controller_test.rb +0 -7
  209. data/guides/code/getting_started/test/controllers/posts_controller_test.rb +0 -7
  210. data/guides/code/getting_started/test/controllers/welcome_controller_test.rb +0 -9
  211. data/guides/code/getting_started/test/fixtures/comments.yml +0 -11
  212. data/guides/code/getting_started/test/fixtures/posts.yml +0 -9
  213. data/guides/code/getting_started/test/helpers/comments_helper_test.rb +0 -4
  214. data/guides/code/getting_started/test/helpers/posts_helper_test.rb +0 -4
  215. data/guides/code/getting_started/test/helpers/welcome_helper_test.rb +0 -4
  216. data/guides/code/getting_started/test/models/comment_test.rb +0 -7
  217. data/guides/code/getting_started/test/models/post_test.rb +0 -7
  218. data/guides/code/getting_started/test/test_helper.rb +0 -12
  219. data/guides/rails_guides/generator.rb +0 -248
  220. data/guides/rails_guides/helpers.rb +0 -53
  221. data/guides/rails_guides/indexer.rb +0 -68
  222. data/guides/rails_guides/kindle.rb +0 -119
  223. data/guides/rails_guides/levenshtein.rb +0 -31
  224. data/guides/rails_guides/markdown/renderer.rb +0 -82
  225. data/guides/rails_guides/markdown.rb +0 -163
  226. data/guides/rails_guides.rb +0 -63
  227. data/guides/source/2_2_release_notes.md +0 -435
  228. data/guides/source/2_3_release_notes.md +0 -621
  229. data/guides/source/3_0_release_notes.md +0 -611
  230. data/guides/source/3_1_release_notes.md +0 -556
  231. data/guides/source/3_2_release_notes.md +0 -565
  232. data/guides/source/4_0_release_notes.md +0 -276
  233. data/guides/source/4_1_release_notes.md +0 -731
  234. data/guides/source/_license.html.erb +0 -2
  235. data/guides/source/_welcome.html.erb +0 -25
  236. data/guides/source/action_controller_overview.md +0 -1175
  237. data/guides/source/action_mailer_basics.md +0 -689
  238. data/guides/source/action_view_overview.md +0 -1610
  239. data/guides/source/active_model_basics.md +0 -200
  240. data/guides/source/active_record_basics.md +0 -373
  241. data/guides/source/active_record_callbacks.md +0 -410
  242. data/guides/source/active_record_querying.md +0 -1773
  243. data/guides/source/active_record_validations.md +0 -1169
  244. data/guides/source/active_support_core_extensions.md +0 -3864
  245. data/guides/source/active_support_instrumentation.md +0 -496
  246. data/guides/source/api_documentation_guidelines.md +0 -315
  247. data/guides/source/asset_pipeline.md +0 -1163
  248. data/guides/source/association_basics.md +0 -2229
  249. data/guides/source/caching_with_rails.md +0 -354
  250. data/guides/source/command_line.md +0 -603
  251. data/guides/source/configuring.md +0 -942
  252. data/guides/source/contributing_to_ruby_on_rails.md +0 -544
  253. data/guides/source/credits.html.erb +0 -80
  254. data/guides/source/debugging_rails_applications.md +0 -707
  255. data/guides/source/development_dependencies_install.md +0 -278
  256. data/guides/source/documents.yaml +0 -193
  257. data/guides/source/engines.md +0 -1391
  258. data/guides/source/form_helpers.md +0 -1001
  259. data/guides/source/generators.md +0 -663
  260. data/guides/source/getting_started.md +0 -1947
  261. data/guides/source/i18n.md +0 -1043
  262. data/guides/source/index.html.erb +0 -27
  263. data/guides/source/initialization.md +0 -657
  264. data/guides/source/kindle/copyright.html.erb +0 -1
  265. data/guides/source/kindle/layout.html.erb +0 -27
  266. data/guides/source/kindle/rails_guides.opf.erb +0 -52
  267. data/guides/source/kindle/toc.html.erb +0 -24
  268. data/guides/source/kindle/toc.ncx.erb +0 -64
  269. data/guides/source/kindle/welcome.html.erb +0 -5
  270. data/guides/source/layout.html.erb +0 -146
  271. data/guides/source/layouts_and_rendering.md +0 -1226
  272. data/guides/source/maintenance_policy.md +0 -56
  273. data/guides/source/migrations.md +0 -1109
  274. data/guides/source/nested_model_forms.md +0 -225
  275. data/guides/source/plugins.md +0 -444
  276. data/guides/source/rails_application_templates.md +0 -248
  277. data/guides/source/rails_on_rack.md +0 -333
  278. data/guides/source/routing.md +0 -1115
  279. data/guides/source/ruby_on_rails_guides_guidelines.md +0 -128
  280. data/guides/source/security.md +0 -1018
  281. data/guides/source/testing.md +0 -1052
  282. data/guides/source/upgrading_ruby_on_rails.md +0 -899
  283. data/guides/source/working_with_javascript_in_rails.md +0 -405
  284. data/guides/w3c_validator.rb +0 -95
@@ -1,3864 +0,0 @@
1
- Active Support Core Extensions
2
- ==============================
3
-
4
- Active Support is the Ruby on Rails component responsible for providing Ruby language extensions, utilities, and other transversal stuff.
5
-
6
- It offers a richer bottom-line at the language level, targeted both at the development of Rails applications, and at the development of Ruby on Rails itself.
7
-
8
- After reading this guide, you will know:
9
-
10
- * What Core Extensions are.
11
- * How to load all extensions.
12
- * How to cherry-pick just the extensions you want.
13
- * What extensions Active Support provides.
14
-
15
- --------------------------------------------------------------------------------
16
-
17
- How to Load Core Extensions
18
- ---------------------------
19
-
20
- ### Stand-Alone Active Support
21
-
22
- In order to have a near-zero default footprint, Active Support does not load anything by default. It is broken in small pieces so that you can load just what you need, and also has some convenience entry points to load related extensions in one shot, even everything.
23
-
24
- Thus, after a simple require like:
25
-
26
- ```ruby
27
- require 'active_support'
28
- ```
29
-
30
- objects do not even respond to `blank?`. Let's see how to load its definition.
31
-
32
- #### Cherry-picking a Definition
33
-
34
- The most lightweight way to get `blank?` is to cherry-pick the file that defines it.
35
-
36
- For every single method defined as a core extension this guide has a note that says where such a method is defined. In the case of `blank?` the note reads:
37
-
38
- NOTE: Defined in `active_support/core_ext/object/blank.rb`.
39
-
40
- That means that you can require it like this:
41
-
42
- ```ruby
43
- require 'active_support'
44
- require 'active_support/core_ext/object/blank'
45
- ```
46
-
47
- Active Support has been carefully revised so that cherry-picking a file loads only strictly needed dependencies, if any.
48
-
49
- #### Loading Grouped Core Extensions
50
-
51
- The next level is to simply load all extensions to `Object`. As a rule of thumb, extensions to `SomeClass` are available in one shot by loading `active_support/core_ext/some_class`.
52
-
53
- Thus, to load all extensions to `Object` (including `blank?`):
54
-
55
- ```ruby
56
- require 'active_support'
57
- require 'active_support/core_ext/object'
58
- ```
59
-
60
- #### Loading All Core Extensions
61
-
62
- You may prefer just to load all core extensions, there is a file for that:
63
-
64
- ```ruby
65
- require 'active_support'
66
- require 'active_support/core_ext'
67
- ```
68
-
69
- #### Loading All Active Support
70
-
71
- And finally, if you want to have all Active Support available just issue:
72
-
73
- ```ruby
74
- require 'active_support/all'
75
- ```
76
-
77
- That does not even put the entire Active Support in memory upfront indeed, some stuff is configured via `autoload`, so it is only loaded if used.
78
-
79
- ### Active Support Within a Ruby on Rails Application
80
-
81
- A Ruby on Rails application loads all Active Support unless `config.active_support.bare` is true. In that case, the application will only load what the framework itself cherry-picks for its own needs, and can still cherry-pick itself at any granularity level, as explained in the previous section.
82
-
83
- Extensions to All Objects
84
- -------------------------
85
-
86
- ### `blank?` and `present?`
87
-
88
- The following values are considered to be blank in a Rails application:
89
-
90
- * `nil` and `false`,
91
-
92
- * strings composed only of whitespace (see note below),
93
-
94
- * empty arrays and hashes, and
95
-
96
- * any other object that responds to `empty?` and is empty.
97
-
98
- INFO: The predicate for strings uses the Unicode-aware character class `[:space:]`, so for example U+2029 (paragraph separator) is considered to be whitespace.
99
-
100
- WARNING: Note that numbers are not mentioned. In particular, 0 and 0.0 are **not** blank.
101
-
102
- For example, this method from `ActionController::HttpAuthentication::Token::ControllerMethods` uses `blank?` for checking whether a token is present:
103
-
104
- ```ruby
105
- def authenticate(controller, &login_procedure)
106
- token, options = token_and_options(controller.request)
107
- unless token.blank?
108
- login_procedure.call(token, options)
109
- end
110
- end
111
- ```
112
-
113
- The method `present?` is equivalent to `!blank?`. This example is taken from `ActionDispatch::Http::Cache::Response`:
114
-
115
- ```ruby
116
- def set_conditional_cache_control!
117
- return if self["Cache-Control"].present?
118
- ...
119
- end
120
- ```
121
-
122
- NOTE: Defined in `active_support/core_ext/object/blank.rb`.
123
-
124
- ### `presence`
125
-
126
- The `presence` method returns its receiver if `present?`, and `nil` otherwise. It is useful for idioms like this:
127
-
128
- ```ruby
129
- host = config[:host].presence || 'localhost'
130
- ```
131
-
132
- NOTE: Defined in `active_support/core_ext/object/blank.rb`.
133
-
134
- ### `duplicable?`
135
-
136
- A few fundamental objects in Ruby are singletons. For example, in the whole life of a program the integer 1 refers always to the same instance:
137
-
138
- ```ruby
139
- 1.object_id # => 3
140
- Math.cos(0).to_i.object_id # => 3
141
- ```
142
-
143
- Hence, there's no way these objects can be duplicated through `dup` or `clone`:
144
-
145
- ```ruby
146
- true.dup # => TypeError: can't dup TrueClass
147
- ```
148
-
149
- Some numbers which are not singletons are not duplicable either:
150
-
151
- ```ruby
152
- 0.0.clone # => allocator undefined for Float
153
- (2**1024).clone # => allocator undefined for Bignum
154
- ```
155
-
156
- Active Support provides `duplicable?` to programmatically query an object about this property:
157
-
158
- ```ruby
159
- "foo".duplicable? # => true
160
- "".duplicable? # => true
161
- 0.0.duplicable? # => false
162
- false.duplicable? # => false
163
- ```
164
-
165
- By definition all objects are `duplicable?` except `nil`, `false`, `true`, symbols, numbers, class, and module objects.
166
-
167
- WARNING: Any class can disallow duplication by removing `dup` and `clone` or raising exceptions from them. Thus only `rescue` can tell whether a given arbitrary object is duplicable. `duplicable?` depends on the hard-coded list above, but it is much faster than `rescue`. Use it only if you know the hard-coded list is enough in your use case.
168
-
169
- NOTE: Defined in `active_support/core_ext/object/duplicable.rb`.
170
-
171
- ### `deep_dup`
172
-
173
- The `deep_dup` method returns deep copy of a given object. Normally, when you `dup` an object that contains other objects, Ruby does not `dup` them, so it creates a shallow copy of the object. If you have an array with a string, for example, it will look like this:
174
-
175
- ```ruby
176
- array = ['string']
177
- duplicate = array.dup
178
-
179
- duplicate.push 'another-string'
180
-
181
- # the object was duplicated, so the element was added only to the duplicate
182
- array # => ['string']
183
- duplicate # => ['string', 'another-string']
184
-
185
- duplicate.first.gsub!('string', 'foo')
186
-
187
- # first element was not duplicated, it will be changed in both arrays
188
- array # => ['foo']
189
- duplicate # => ['foo', 'another-string']
190
- ```
191
-
192
- As you can see, after duplicating the `Array` instance, we got another object, therefore we can modify it and the original object will stay unchanged. This is not true for array's elements, however. Since `dup` does not make deep copy, the string inside the array is still the same object.
193
-
194
- If you need a deep copy of an object, you should use `deep_dup`. Here is an example:
195
-
196
- ```ruby
197
- array = ['string']
198
- duplicate = array.deep_dup
199
-
200
- duplicate.first.gsub!('string', 'foo')
201
-
202
- array # => ['string']
203
- duplicate # => ['foo']
204
- ```
205
-
206
- If the object is not duplicable, `deep_dup` will just return it:
207
-
208
- ```ruby
209
- number = 1
210
- duplicate = number.deep_dup
211
- number.object_id == duplicate.object_id # => true
212
- ```
213
-
214
- NOTE: Defined in `active_support/core_ext/object/deep_dup.rb`.
215
-
216
- ### `try`
217
-
218
- When you want to call a method on an object only if it is not `nil`, the simplest way to achieve it is with conditional statements, adding unnecessary clutter. The alternative is to use `try`. `try` is like `Object#send` except that it returns `nil` if sent to `nil`.
219
-
220
- Here is an example:
221
-
222
- ```ruby
223
- # without try
224
- unless @number.nil?
225
- @number.next
226
- end
227
-
228
- # with try
229
- @number.try(:next)
230
- ```
231
-
232
- Another example is this code from `ActiveRecord::ConnectionAdapters::AbstractAdapter` where `@logger` could be `nil`. You can see that the code uses `try` and avoids an unnecessary check.
233
-
234
- ```ruby
235
- def log_info(sql, name, ms)
236
- if @logger.try(:debug?)
237
- name = '%s (%.1fms)' % [name || 'SQL', ms]
238
- @logger.debug(format_log_entry(name, sql.squeeze(' ')))
239
- end
240
- end
241
- ```
242
-
243
- `try` can also be called without arguments but a block, which will only be executed if the object is not nil:
244
-
245
- ```ruby
246
- @person.try { |p| "#{p.first_name} #{p.last_name}" }
247
- ```
248
-
249
- NOTE: Defined in `active_support/core_ext/object/try.rb`.
250
-
251
- ### `class_eval(*args, &block)`
252
-
253
- You can evaluate code in the context of any object's singleton class using `class_eval`:
254
-
255
- ```ruby
256
- class Proc
257
- def bind(object)
258
- block, time = self, Time.current
259
- object.class_eval do
260
- method_name = "__bind_#{time.to_i}_#{time.usec}"
261
- define_method(method_name, &block)
262
- method = instance_method(method_name)
263
- remove_method(method_name)
264
- method
265
- end.bind(object)
266
- end
267
- end
268
- ```
269
-
270
- NOTE: Defined in `active_support/core_ext/kernel/singleton_class.rb`.
271
-
272
- ### `acts_like?(duck)`
273
-
274
- The method `acts_like?` provides a way to check whether some class acts like some other class based on a simple convention: a class that provides the same interface as `String` defines
275
-
276
- ```ruby
277
- def acts_like_string?
278
- end
279
- ```
280
-
281
- which is only a marker, its body or return value are irrelevant. Then, client code can query for duck-type-safeness this way:
282
-
283
- ```ruby
284
- some_klass.acts_like?(:string)
285
- ```
286
-
287
- Rails has classes that act like `Date` or `Time` and follow this contract.
288
-
289
- NOTE: Defined in `active_support/core_ext/object/acts_like.rb`.
290
-
291
- ### `to_param`
292
-
293
- All objects in Rails respond to the method `to_param`, which is meant to return something that represents them as values in a query string, or as URL fragments.
294
-
295
- By default `to_param` just calls `to_s`:
296
-
297
- ```ruby
298
- 7.to_param # => "7"
299
- ```
300
-
301
- The return value of `to_param` should **not** be escaped:
302
-
303
- ```ruby
304
- "Tom & Jerry".to_param # => "Tom & Jerry"
305
- ```
306
-
307
- Several classes in Rails overwrite this method.
308
-
309
- For example `nil`, `true`, and `false` return themselves. `Array#to_param` calls `to_param` on the elements and joins the result with "/":
310
-
311
- ```ruby
312
- [0, true, String].to_param # => "0/true/String"
313
- ```
314
-
315
- Notably, the Rails routing system calls `to_param` on models to get a value for the `:id` placeholder. `ActiveRecord::Base#to_param` returns the `id` of a model, but you can redefine that method in your models. For example, given
316
-
317
- ```ruby
318
- class User
319
- def to_param
320
- "#{id}-#{name.parameterize}"
321
- end
322
- end
323
- ```
324
-
325
- we get:
326
-
327
- ```ruby
328
- user_path(@user) # => "/users/357-john-smith"
329
- ```
330
-
331
- WARNING. Controllers need to be aware of any redefinition of `to_param` because when a request like that comes in "357-john-smith" is the value of `params[:id]`.
332
-
333
- NOTE: Defined in `active_support/core_ext/object/to_param.rb`.
334
-
335
- ### `to_query`
336
-
337
- Except for hashes, given an unescaped `key` this method constructs the part of a query string that would map such key to what `to_param` returns. For example, given
338
-
339
- ```ruby
340
- class User
341
- def to_param
342
- "#{id}-#{name.parameterize}"
343
- end
344
- end
345
- ```
346
-
347
- we get:
348
-
349
- ```ruby
350
- current_user.to_query('user') # => user=357-john-smith
351
- ```
352
-
353
- This method escapes whatever is needed, both for the key and the value:
354
-
355
- ```ruby
356
- account.to_query('company[name]')
357
- # => "company%5Bname%5D=Johnson+%26+Johnson"
358
- ```
359
-
360
- so its output is ready to be used in a query string.
361
-
362
- Arrays return the result of applying `to_query` to each element with `_key_[]` as key, and join the result with "&":
363
-
364
- ```ruby
365
- [3.4, -45.6].to_query('sample')
366
- # => "sample%5B%5D=3.4&sample%5B%5D=-45.6"
367
- ```
368
-
369
- Hashes also respond to `to_query` but with a different signature. If no argument is passed a call generates a sorted series of key/value assignments calling `to_query(key)` on its values. Then it joins the result with "&":
370
-
371
- ```ruby
372
- {c: 3, b: 2, a: 1}.to_query # => "a=1&b=2&c=3"
373
- ```
374
-
375
- The method `Hash#to_query` accepts an optional namespace for the keys:
376
-
377
- ```ruby
378
- {id: 89, name: "John Smith"}.to_query('user')
379
- # => "user%5Bid%5D=89&user%5Bname%5D=John+Smith"
380
- ```
381
-
382
- NOTE: Defined in `active_support/core_ext/object/to_query.rb`.
383
-
384
- ### `with_options`
385
-
386
- The method `with_options` provides a way to factor out common options in a series of method calls.
387
-
388
- Given a default options hash, `with_options` yields a proxy object to a block. Within the block, methods called on the proxy are forwarded to the receiver with their options merged. For example, you get rid of the duplication in:
389
-
390
- ```ruby
391
- class Account < ActiveRecord::Base
392
- has_many :customers, dependent: :destroy
393
- has_many :products, dependent: :destroy
394
- has_many :invoices, dependent: :destroy
395
- has_many :expenses, dependent: :destroy
396
- end
397
- ```
398
-
399
- this way:
400
-
401
- ```ruby
402
- class Account < ActiveRecord::Base
403
- with_options dependent: :destroy do |assoc|
404
- assoc.has_many :customers
405
- assoc.has_many :products
406
- assoc.has_many :invoices
407
- assoc.has_many :expenses
408
- end
409
- end
410
- ```
411
-
412
- That idiom may convey _grouping_ to the reader as well. For example, say you want to send a newsletter whose language depends on the user. Somewhere in the mailer you could group locale-dependent bits like this:
413
-
414
- ```ruby
415
- I18n.with_options locale: user.locale, scope: "newsletter" do |i18n|
416
- subject i18n.t :subject
417
- body i18n.t :body, user_name: user.name
418
- end
419
- ```
420
-
421
- TIP: Since `with_options` forwards calls to its receiver they can be nested. Each nesting level will merge inherited defaults in addition to their own.
422
-
423
- NOTE: Defined in `active_support/core_ext/object/with_options.rb`.
424
-
425
- ### JSON support
426
-
427
- Active Support provides a better implementation of `to_json` than the `json` gem ordinarily provides for Ruby objects. This is because some classes, like `Hash`, `OrderedHash` and `Process::Status` need special handling in order to provide a proper JSON representation.
428
-
429
- NOTE: Defined in `active_support/core_ext/object/json.rb`.
430
-
431
- ### Instance Variables
432
-
433
- Active Support provides several methods to ease access to instance variables.
434
-
435
- #### `instance_values`
436
-
437
- The method `instance_values` returns a hash that maps instance variable names without "@" to their
438
- corresponding values. Keys are strings:
439
-
440
- ```ruby
441
- class C
442
- def initialize(x, y)
443
- @x, @y = x, y
444
- end
445
- end
446
-
447
- C.new(0, 1).instance_values # => {"x" => 0, "y" => 1}
448
- ```
449
-
450
- NOTE: Defined in `active_support/core_ext/object/instance_variables.rb`.
451
-
452
- #### `instance_variable_names`
453
-
454
- The method `instance_variable_names` returns an array. Each name includes the "@" sign.
455
-
456
- ```ruby
457
- class C
458
- def initialize(x, y)
459
- @x, @y = x, y
460
- end
461
- end
462
-
463
- C.new(0, 1).instance_variable_names # => ["@x", "@y"]
464
- ```
465
-
466
- NOTE: Defined in `active_support/core_ext/object/instance_variables.rb`.
467
-
468
- ### Silencing Warnings, Streams, and Exceptions
469
-
470
- The methods `silence_warnings` and `enable_warnings` change the value of `$VERBOSE` accordingly for the duration of their block, and reset it afterwards:
471
-
472
- ```ruby
473
- silence_warnings { Object.const_set "RAILS_DEFAULT_LOGGER", logger }
474
- ```
475
-
476
- You can silence any stream while a block runs with `silence_stream`:
477
-
478
- ```ruby
479
- silence_stream(STDOUT) do
480
- # STDOUT is silent here
481
- end
482
- ```
483
-
484
- The `quietly` method addresses the common use case where you want to silence STDOUT and STDERR, even in subprocesses:
485
-
486
- ```ruby
487
- quietly { system 'bundle install' }
488
- ```
489
-
490
- For example, the railties test suite uses that one in a few places to prevent command messages from being echoed intermixed with the progress status.
491
-
492
- Silencing exceptions is also possible with `suppress`. This method receives an arbitrary number of exception classes. If an exception is raised during the execution of the block and is `kind_of?` any of the arguments, `suppress` captures it and returns silently. Otherwise the exception is reraised:
493
-
494
- ```ruby
495
- # If the user is locked the increment is lost, no big deal.
496
- suppress(ActiveRecord::StaleObjectError) do
497
- current_user.increment! :visits
498
- end
499
- ```
500
-
501
- NOTE: Defined in `active_support/core_ext/kernel/reporting.rb`.
502
-
503
- ### `in?`
504
-
505
- The predicate `in?` tests if an object is included in another object. An `ArgumentError` exception will be raised if the argument passed does not respond to `include?`.
506
-
507
- Examples of `in?`:
508
-
509
- ```ruby
510
- 1.in?([1,2]) # => true
511
- "lo".in?("hello") # => true
512
- 25.in?(30..50) # => false
513
- 1.in?(1) # => ArgumentError
514
- ```
515
-
516
- NOTE: Defined in `active_support/core_ext/object/inclusion.rb`.
517
-
518
- Extensions to `Module`
519
- ----------------------
520
-
521
- ### `alias_method_chain`
522
-
523
- Using plain Ruby you can wrap methods with other methods, that's called _alias chaining_.
524
-
525
- For example, let's say you'd like params to be strings in functional tests, as they are in real requests, but still want the convenience of assigning integers and other kind of values. To accomplish that you could wrap `ActionController::TestCase#process` this way in `test/test_helper.rb`:
526
-
527
- ```ruby
528
- ActionController::TestCase.class_eval do
529
- # save a reference to the original process method
530
- alias_method :original_process, :process
531
-
532
- # now redefine process and delegate to original_process
533
- def process(action, params=nil, session=nil, flash=nil, http_method='GET')
534
- params = Hash[*params.map {|k, v| [k, v.to_s]}.flatten]
535
- original_process(action, params, session, flash, http_method)
536
- end
537
- end
538
- ```
539
-
540
- That's the method `get`, `post`, etc., delegate the work to.
541
-
542
- That technique has a risk, it could be the case that `:original_process` was taken. To try to avoid collisions people choose some label that characterizes what the chaining is about:
543
-
544
- ```ruby
545
- ActionController::TestCase.class_eval do
546
- def process_with_stringified_params(...)
547
- params = Hash[*params.map {|k, v| [k, v.to_s]}.flatten]
548
- process_without_stringified_params(action, params, session, flash, http_method)
549
- end
550
- alias_method :process_without_stringified_params, :process
551
- alias_method :process, :process_with_stringified_params
552
- end
553
- ```
554
-
555
- The method `alias_method_chain` provides a shortcut for that pattern:
556
-
557
- ```ruby
558
- ActionController::TestCase.class_eval do
559
- def process_with_stringified_params(...)
560
- params = Hash[*params.map {|k, v| [k, v.to_s]}.flatten]
561
- process_without_stringified_params(action, params, session, flash, http_method)
562
- end
563
- alias_method_chain :process, :stringified_params
564
- end
565
- ```
566
-
567
- Rails uses `alias_method_chain` all over the code base. For example validations are added to `ActiveRecord::Base#save` by wrapping the method that way in a separate module specialized in validations.
568
-
569
- NOTE: Defined in `active_support/core_ext/module/aliasing.rb`.
570
-
571
- ### Attributes
572
-
573
- #### `alias_attribute`
574
-
575
- Model attributes have a reader, a writer, and a predicate. You can alias a model attribute having the corresponding three methods defined for you in one shot. As in other aliasing methods, the new name is the first argument, and the old name is the second (my mnemonic is they go in the same order as if you did an assignment):
576
-
577
- ```ruby
578
- class User < ActiveRecord::Base
579
- # let me refer to the email column as "login",
580
- # possibly meaningful for authentication code
581
- alias_attribute :login, :email
582
- end
583
- ```
584
-
585
- NOTE: Defined in `active_support/core_ext/module/aliasing.rb`.
586
-
587
- #### Internal Attributes
588
-
589
- When you are defining an attribute in a class that is meant to be subclassed, name collisions are a risk. That's remarkably important for libraries.
590
-
591
- Active Support defines the macros `attr_internal_reader`, `attr_internal_writer`, and `attr_internal_accessor`. They behave like their Ruby built-in `attr_*` counterparts, except they name the underlying instance variable in a way that makes collisions less likely.
592
-
593
- The macro `attr_internal` is a synonym for `attr_internal_accessor`:
594
-
595
- ```ruby
596
- # library
597
- class ThirdPartyLibrary::Crawler
598
- attr_internal :log_level
599
- end
600
-
601
- # client code
602
- class MyCrawler < ThirdPartyLibrary::Crawler
603
- attr_accessor :log_level
604
- end
605
- ```
606
-
607
- In the previous example it could be the case that `:log_level` does not belong to the public interface of the library and it is only used for development. The client code, unaware of the potential conflict, subclasses and defines its own `:log_level`. Thanks to `attr_internal` there's no collision.
608
-
609
- By default the internal instance variable is named with a leading underscore, `@_log_level` in the example above. That's configurable via `Module.attr_internal_naming_format` though, you can pass any `sprintf`-like format string with a leading `@` and a `%s` somewhere, which is where the name will be placed. The default is `"@_%s"`.
610
-
611
- Rails uses internal attributes in a few spots, for examples for views:
612
-
613
- ```ruby
614
- module ActionView
615
- class Base
616
- attr_internal :captures
617
- attr_internal :request, :layout
618
- attr_internal :controller, :template
619
- end
620
- end
621
- ```
622
-
623
- NOTE: Defined in `active_support/core_ext/module/attr_internal.rb`.
624
-
625
- #### Module Attributes
626
-
627
- The macros `mattr_reader`, `mattr_writer`, and `mattr_accessor` are the same as the `cattr_*` macros defined for class. In fact, the `cattr_*` macros are just aliases for the `mattr_*` macros. Check [Class Attributes](#class-attributes).
628
-
629
- For example, the dependencies mechanism uses them:
630
-
631
- ```ruby
632
- module ActiveSupport
633
- module Dependencies
634
- mattr_accessor :warnings_on_first_load
635
- mattr_accessor :history
636
- mattr_accessor :loaded
637
- mattr_accessor :mechanism
638
- mattr_accessor :load_paths
639
- mattr_accessor :load_once_paths
640
- mattr_accessor :autoloaded_constants
641
- mattr_accessor :explicitly_unloadable_constants
642
- mattr_accessor :logger
643
- mattr_accessor :log_activity
644
- mattr_accessor :constant_watch_stack
645
- mattr_accessor :constant_watch_stack_mutex
646
- end
647
- end
648
- ```
649
-
650
- NOTE: Defined in `active_support/core_ext/module/attribute_accessors.rb`.
651
-
652
- ### Parents
653
-
654
- #### `parent`
655
-
656
- The `parent` method on a nested named module returns the module that contains its corresponding constant:
657
-
658
- ```ruby
659
- module X
660
- module Y
661
- module Z
662
- end
663
- end
664
- end
665
- M = X::Y::Z
666
-
667
- X::Y::Z.parent # => X::Y
668
- M.parent # => X::Y
669
- ```
670
-
671
- If the module is anonymous or belongs to the top-level, `parent` returns `Object`.
672
-
673
- WARNING: Note that in that case `parent_name` returns `nil`.
674
-
675
- NOTE: Defined in `active_support/core_ext/module/introspection.rb`.
676
-
677
- #### `parent_name`
678
-
679
- The `parent_name` method on a nested named module returns the fully-qualified name of the module that contains its corresponding constant:
680
-
681
- ```ruby
682
- module X
683
- module Y
684
- module Z
685
- end
686
- end
687
- end
688
- M = X::Y::Z
689
-
690
- X::Y::Z.parent_name # => "X::Y"
691
- M.parent_name # => "X::Y"
692
- ```
693
-
694
- For top-level or anonymous modules `parent_name` returns `nil`.
695
-
696
- WARNING: Note that in that case `parent` returns `Object`.
697
-
698
- NOTE: Defined in `active_support/core_ext/module/introspection.rb`.
699
-
700
- #### `parents`
701
-
702
- The method `parents` calls `parent` on the receiver and upwards until `Object` is reached. The chain is returned in an array, from bottom to top:
703
-
704
- ```ruby
705
- module X
706
- module Y
707
- module Z
708
- end
709
- end
710
- end
711
- M = X::Y::Z
712
-
713
- X::Y::Z.parents # => [X::Y, X, Object]
714
- M.parents # => [X::Y, X, Object]
715
- ```
716
-
717
- NOTE: Defined in `active_support/core_ext/module/introspection.rb`.
718
-
719
- ### Constants
720
-
721
- The method `local_constants` returns the names of the constants that have been
722
- defined in the receiver module:
723
-
724
- ```ruby
725
- module X
726
- X1 = 1
727
- X2 = 2
728
- module Y
729
- Y1 = :y1
730
- X1 = :overrides_X1_above
731
- end
732
- end
733
-
734
- X.local_constants # => [:X1, :X2, :Y]
735
- X::Y.local_constants # => [:Y1, :X1]
736
- ```
737
-
738
- The names are returned as symbols.
739
-
740
- NOTE: Defined in `active_support/core_ext/module/introspection.rb`.
741
-
742
- #### Qualified Constant Names
743
-
744
- The standard methods `const_defined?`, `const_get` , and `const_set` accept
745
- bare constant names. Active Support extends this API to be able to pass
746
- relative qualified constant names.
747
-
748
- The new methods are `qualified_const_defined?`, `qualified_const_get`, and
749
- `qualified_const_set`. Their arguments are assumed to be qualified constant
750
- names relative to their receiver:
751
-
752
- ```ruby
753
- Object.qualified_const_defined?("Math::PI") # => true
754
- Object.qualified_const_get("Math::PI") # => 3.141592653589793
755
- Object.qualified_const_set("Math::Phi", 1.618034) # => 1.618034
756
- ```
757
-
758
- Arguments may be bare constant names:
759
-
760
- ```ruby
761
- Math.qualified_const_get("E") # => 2.718281828459045
762
- ```
763
-
764
- These methods are analogous to their builtin counterparts. In particular,
765
- `qualified_constant_defined?` accepts an optional second argument to be
766
- able to say whether you want the predicate to look in the ancestors.
767
- This flag is taken into account for each constant in the expression while
768
- walking down the path.
769
-
770
- For example, given
771
-
772
- ```ruby
773
- module M
774
- X = 1
775
- end
776
-
777
- module N
778
- class C
779
- include M
780
- end
781
- end
782
- ```
783
-
784
- `qualified_const_defined?` behaves this way:
785
-
786
- ```ruby
787
- N.qualified_const_defined?("C::X", false) # => false
788
- N.qualified_const_defined?("C::X", true) # => true
789
- N.qualified_const_defined?("C::X") # => true
790
- ```
791
-
792
- As the last example implies, the second argument defaults to true,
793
- as in `const_defined?`.
794
-
795
- For coherence with the builtin methods only relative paths are accepted.
796
- Absolute qualified constant names like `::Math::PI` raise `NameError`.
797
-
798
- NOTE: Defined in `active_support/core_ext/module/qualified_const.rb`.
799
-
800
- ### Reachable
801
-
802
- A named module is reachable if it is stored in its corresponding constant. It means you can reach the module object via the constant.
803
-
804
- That is what ordinarily happens, if a module is called "M", the `M` constant exists and holds it:
805
-
806
- ```ruby
807
- module M
808
- end
809
-
810
- M.reachable? # => true
811
- ```
812
-
813
- But since constants and modules are indeed kind of decoupled, module objects can become unreachable:
814
-
815
- ```ruby
816
- module M
817
- end
818
-
819
- orphan = Object.send(:remove_const, :M)
820
-
821
- # The module object is orphan now but it still has a name.
822
- orphan.name # => "M"
823
-
824
- # You cannot reach it via the constant M because it does not even exist.
825
- orphan.reachable? # => false
826
-
827
- # Let's define a module called "M" again.
828
- module M
829
- end
830
-
831
- # The constant M exists now again, and it stores a module
832
- # object called "M", but it is a new instance.
833
- orphan.reachable? # => false
834
- ```
835
-
836
- NOTE: Defined in `active_support/core_ext/module/reachable.rb`.
837
-
838
- ### Anonymous
839
-
840
- A module may or may not have a name:
841
-
842
- ```ruby
843
- module M
844
- end
845
- M.name # => "M"
846
-
847
- N = Module.new
848
- N.name # => "N"
849
-
850
- Module.new.name # => nil
851
- ```
852
-
853
- You can check whether a module has a name with the predicate `anonymous?`:
854
-
855
- ```ruby
856
- module M
857
- end
858
- M.anonymous? # => false
859
-
860
- Module.new.anonymous? # => true
861
- ```
862
-
863
- Note that being unreachable does not imply being anonymous:
864
-
865
- ```ruby
866
- module M
867
- end
868
-
869
- m = Object.send(:remove_const, :M)
870
-
871
- m.reachable? # => false
872
- m.anonymous? # => false
873
- ```
874
-
875
- though an anonymous module is unreachable by definition.
876
-
877
- NOTE: Defined in `active_support/core_ext/module/anonymous.rb`.
878
-
879
- ### Method Delegation
880
-
881
- The macro `delegate` offers an easy way to forward methods.
882
-
883
- Let's imagine that users in some application have login information in the `User` model but name and other data in a separate `Profile` model:
884
-
885
- ```ruby
886
- class User < ActiveRecord::Base
887
- has_one :profile
888
- end
889
- ```
890
-
891
- With that configuration you get a user's name via their profile, `user.profile.name`, but it could be handy to still be able to access such attribute directly:
892
-
893
- ```ruby
894
- class User < ActiveRecord::Base
895
- has_one :profile
896
-
897
- def name
898
- profile.name
899
- end
900
- end
901
- ```
902
-
903
- That is what `delegate` does for you:
904
-
905
- ```ruby
906
- class User < ActiveRecord::Base
907
- has_one :profile
908
-
909
- delegate :name, to: :profile
910
- end
911
- ```
912
-
913
- It is shorter, and the intention more obvious.
914
-
915
- The method must be public in the target.
916
-
917
- The `delegate` macro accepts several methods:
918
-
919
- ```ruby
920
- delegate :name, :age, :address, :twitter, to: :profile
921
- ```
922
-
923
- When interpolated into a string, the `:to` option should become an expression that evaluates to the object the method is delegated to. Typically a string or symbol. Such an expression is evaluated in the context of the receiver:
924
-
925
- ```ruby
926
- # delegates to the Rails constant
927
- delegate :logger, to: :Rails
928
-
929
- # delegates to the receiver's class
930
- delegate :table_name, to: :class
931
- ```
932
-
933
- WARNING: If the `:prefix` option is `true` this is less generic, see below.
934
-
935
- By default, if the delegation raises `NoMethodError` and the target is `nil` the exception is propagated. You can ask that `nil` is returned instead with the `:allow_nil` option:
936
-
937
- ```ruby
938
- delegate :name, to: :profile, allow_nil: true
939
- ```
940
-
941
- With `:allow_nil` the call `user.name` returns `nil` if the user has no profile.
942
-
943
- The option `:prefix` adds a prefix to the name of the generated method. This may be handy for example to get a better name:
944
-
945
- ```ruby
946
- delegate :street, to: :address, prefix: true
947
- ```
948
-
949
- The previous example generates `address_street` rather than `street`.
950
-
951
- WARNING: Since in this case the name of the generated method is composed of the target object and target method names, the `:to` option must be a method name.
952
-
953
- A custom prefix may also be configured:
954
-
955
- ```ruby
956
- delegate :size, to: :attachment, prefix: :avatar
957
- ```
958
-
959
- In the previous example the macro generates `avatar_size` rather than `size`.
960
-
961
- NOTE: Defined in `active_support/core_ext/module/delegation.rb`
962
-
963
- ### Redefining Methods
964
-
965
- There are cases where you need to define a method with `define_method`, but don't know whether a method with that name already exists. If it does, a warning is issued if they are enabled. No big deal, but not clean either.
966
-
967
- The method `redefine_method` prevents such a potential warning, removing the existing method before if needed. Rails uses it in a few places, for instance when it generates an association's API:
968
-
969
- ```ruby
970
- redefine_method("#{reflection.name}=") do |new_value|
971
- association = association_instance_get(reflection.name)
972
-
973
- if association.nil? || association.target != new_value
974
- association = association_proxy_class.new(self, reflection)
975
- end
976
-
977
- association.replace(new_value)
978
- association_instance_set(reflection.name, new_value.nil? ? nil : association)
979
- end
980
- ```
981
-
982
- NOTE: Defined in `active_support/core_ext/module/remove_method.rb`
983
-
984
- Extensions to `Class`
985
- ---------------------
986
-
987
- ### Class Attributes
988
-
989
- #### `class_attribute`
990
-
991
- The method `class_attribute` declares one or more inheritable class attributes that can be overridden at any level down the hierarchy.
992
-
993
- ```ruby
994
- class A
995
- class_attribute :x
996
- end
997
-
998
- class B < A; end
999
-
1000
- class C < B; end
1001
-
1002
- A.x = :a
1003
- B.x # => :a
1004
- C.x # => :a
1005
-
1006
- B.x = :b
1007
- A.x # => :a
1008
- C.x # => :b
1009
-
1010
- C.x = :c
1011
- A.x # => :a
1012
- B.x # => :b
1013
- ```
1014
-
1015
- For example `ActionMailer::Base` defines:
1016
-
1017
- ```ruby
1018
- class_attribute :default_params
1019
- self.default_params = {
1020
- mime_version: "1.0",
1021
- charset: "UTF-8",
1022
- content_type: "text/plain",
1023
- parts_order: [ "text/plain", "text/enriched", "text/html" ]
1024
- }.freeze
1025
- ```
1026
-
1027
- They can be also accessed and overridden at the instance level.
1028
-
1029
- ```ruby
1030
- A.x = 1
1031
-
1032
- a1 = A.new
1033
- a2 = A.new
1034
- a2.x = 2
1035
-
1036
- a1.x # => 1, comes from A
1037
- a2.x # => 2, overridden in a2
1038
- ```
1039
-
1040
- The generation of the writer instance method can be prevented by setting the option `:instance_writer` to `false`.
1041
-
1042
- ```ruby
1043
- module ActiveRecord
1044
- class Base
1045
- class_attribute :table_name_prefix, instance_writer: false
1046
- self.table_name_prefix = ""
1047
- end
1048
- end
1049
- ```
1050
-
1051
- A model may find that option useful as a way to prevent mass-assignment from setting the attribute.
1052
-
1053
- The generation of the reader instance method can be prevented by setting the option `:instance_reader` to `false`.
1054
-
1055
- ```ruby
1056
- class A
1057
- class_attribute :x, instance_reader: false
1058
- end
1059
-
1060
- A.new.x = 1 # NoMethodError
1061
- ```
1062
-
1063
- For convenience `class_attribute` also defines an instance predicate which is the double negation of what the instance reader returns. In the examples above it would be called `x?`.
1064
-
1065
- When `:instance_reader` is `false`, the instance predicate returns a `NoMethodError` just like the reader method.
1066
-
1067
- If you do not want the instance predicate, pass `instance_predicate: false` and it will not be defined.
1068
-
1069
- NOTE: Defined in `active_support/core_ext/class/attribute.rb`
1070
-
1071
- #### `cattr_reader`, `cattr_writer`, and `cattr_accessor`
1072
-
1073
- The macros `cattr_reader`, `cattr_writer`, and `cattr_accessor` are analogous to their `attr_*` counterparts but for classes. They initialize a class variable to `nil` unless it already exists, and generate the corresponding class methods to access it:
1074
-
1075
- ```ruby
1076
- class MysqlAdapter < AbstractAdapter
1077
- # Generates class methods to access @@emulate_booleans.
1078
- cattr_accessor :emulate_booleans
1079
- self.emulate_booleans = true
1080
- end
1081
- ```
1082
-
1083
- Instance methods are created as well for convenience, they are just proxies to the class attribute. So, instances can change the class attribute, but cannot override it as it happens with `class_attribute` (see above). For example given
1084
-
1085
- ```ruby
1086
- module ActionView
1087
- class Base
1088
- cattr_accessor :field_error_proc
1089
- @@field_error_proc = Proc.new{ ... }
1090
- end
1091
- end
1092
- ```
1093
-
1094
- we can access `field_error_proc` in views.
1095
-
1096
- Also, you can pass a block to `cattr_*` to set up the attribute with a default value:
1097
-
1098
- ```ruby
1099
- class MysqlAdapter < AbstractAdapter
1100
- # Generates class methods to access @@emulate_booleans with default value of true.
1101
- cattr_accessor(:emulate_booleans) { true }
1102
- end
1103
- ```
1104
-
1105
- The generation of the reader instance method can be prevented by setting `:instance_reader` to `false` and the generation of the writer instance method can be prevented by setting `:instance_writer` to `false`. Generation of both methods can be prevented by setting `:instance_accessor` to `false`. In all cases, the value must be exactly `false` and not any false value.
1106
-
1107
- ```ruby
1108
- module A
1109
- class B
1110
- # No first_name instance reader is generated.
1111
- cattr_accessor :first_name, instance_reader: false
1112
- # No last_name= instance writer is generated.
1113
- cattr_accessor :last_name, instance_writer: false
1114
- # No surname instance reader or surname= writer is generated.
1115
- cattr_accessor :surname, instance_accessor: false
1116
- end
1117
- end
1118
- ```
1119
-
1120
- A model may find it useful to set `:instance_accessor` to `false` as a way to prevent mass-assignment from setting the attribute.
1121
-
1122
- NOTE: Defined in `active_support/core_ext/module/attribute_accessors.rb`.
1123
-
1124
- ### Subclasses & Descendants
1125
-
1126
- #### `subclasses`
1127
-
1128
- The `subclasses` method returns the subclasses of the receiver:
1129
-
1130
- ```ruby
1131
- class C; end
1132
- C.subclasses # => []
1133
-
1134
- class B < C; end
1135
- C.subclasses # => [B]
1136
-
1137
- class A < B; end
1138
- C.subclasses # => [B]
1139
-
1140
- class D < C; end
1141
- C.subclasses # => [B, D]
1142
- ```
1143
-
1144
- The order in which these classes are returned is unspecified.
1145
-
1146
- NOTE: Defined in `active_support/core_ext/class/subclasses.rb`.
1147
-
1148
- #### `descendants`
1149
-
1150
- The `descendants` method returns all classes that are `<` than its receiver:
1151
-
1152
- ```ruby
1153
- class C; end
1154
- C.descendants # => []
1155
-
1156
- class B < C; end
1157
- C.descendants # => [B]
1158
-
1159
- class A < B; end
1160
- C.descendants # => [B, A]
1161
-
1162
- class D < C; end
1163
- C.descendants # => [B, A, D]
1164
- ```
1165
-
1166
- The order in which these classes are returned is unspecified.
1167
-
1168
- NOTE: Defined in `active_support/core_ext/class/subclasses.rb`.
1169
-
1170
- Extensions to `String`
1171
- ----------------------
1172
-
1173
- ### Output Safety
1174
-
1175
- #### Motivation
1176
-
1177
- Inserting data into HTML templates needs extra care. For example, you can't just interpolate `@review.title` verbatim into an HTML page. For one thing, if the review title is "Flanagan & Matz rules!" the output won't be well-formed because an ampersand has to be escaped as "&amp;amp;". What's more, depending on the application, that may be a big security hole because users can inject malicious HTML setting a hand-crafted review title. Check out the section about cross-site scripting in the [Security guide](security.html#cross-site-scripting-xss) for further information about the risks.
1178
-
1179
- #### Safe Strings
1180
-
1181
- Active Support has the concept of <i>(html) safe</i> strings. A safe string is one that is marked as being insertable into HTML as is. It is trusted, no matter whether it has been escaped or not.
1182
-
1183
- Strings are considered to be <i>unsafe</i> by default:
1184
-
1185
- ```ruby
1186
- "".html_safe? # => false
1187
- ```
1188
-
1189
- You can obtain a safe string from a given one with the `html_safe` method:
1190
-
1191
- ```ruby
1192
- s = "".html_safe
1193
- s.html_safe? # => true
1194
- ```
1195
-
1196
- It is important to understand that `html_safe` performs no escaping whatsoever, it is just an assertion:
1197
-
1198
- ```ruby
1199
- s = "<script>...</script>".html_safe
1200
- s.html_safe? # => true
1201
- s # => "<script>...</script>"
1202
- ```
1203
-
1204
- It is your responsibility to ensure calling `html_safe` on a particular string is fine.
1205
-
1206
- If you append onto a safe string, either in-place with `concat`/`<<`, or with `+`, the result is a safe string. Unsafe arguments are escaped:
1207
-
1208
- ```ruby
1209
- "".html_safe + "<" # => "&lt;"
1210
- ```
1211
-
1212
- Safe arguments are directly appended:
1213
-
1214
- ```ruby
1215
- "".html_safe + "<".html_safe # => "<"
1216
- ```
1217
-
1218
- These methods should not be used in ordinary views. Unsafe values are automatically escaped:
1219
-
1220
- ```erb
1221
- <%= @review.title %> <%# fine, escaped if needed %>
1222
- ```
1223
-
1224
- To insert something verbatim use the `raw` helper rather than calling `html_safe`:
1225
-
1226
- ```erb
1227
- <%= raw @cms.current_template %> <%# inserts @cms.current_template as is %>
1228
- ```
1229
-
1230
- or, equivalently, use `<%==`:
1231
-
1232
- ```erb
1233
- <%== @cms.current_template %> <%# inserts @cms.current_template as is %>
1234
- ```
1235
-
1236
- The `raw` helper calls `html_safe` for you:
1237
-
1238
- ```ruby
1239
- def raw(stringish)
1240
- stringish.to_s.html_safe
1241
- end
1242
- ```
1243
-
1244
- NOTE: Defined in `active_support/core_ext/string/output_safety.rb`.
1245
-
1246
- #### Transformation
1247
-
1248
- As a rule of thumb, except perhaps for concatenation as explained above, any method that may change a string gives you an unsafe string. These are `downcase`, `gsub`, `strip`, `chomp`, `underscore`, etc.
1249
-
1250
- In the case of in-place transformations like `gsub!` the receiver itself becomes unsafe.
1251
-
1252
- INFO: The safety bit is lost always, no matter whether the transformation actually changed something.
1253
-
1254
- #### Conversion and Coercion
1255
-
1256
- Calling `to_s` on a safe string returns a safe string, but coercion with `to_str` returns an unsafe string.
1257
-
1258
- #### Copying
1259
-
1260
- Calling `dup` or `clone` on safe strings yields safe strings.
1261
-
1262
- ### `remove`
1263
-
1264
- The method `remove` will remove all occurrences of the pattern:
1265
-
1266
- ```ruby
1267
- "Hello World".remove(/Hello /) => "World"
1268
- ```
1269
-
1270
- There's also the destructive version `String#remove!`.
1271
-
1272
- NOTE: Defined in `active_support/core_ext/string/filters.rb`.
1273
-
1274
- ### `squish`
1275
-
1276
- The method `squish` strips leading and trailing whitespace, and substitutes runs of whitespace with a single space each:
1277
-
1278
- ```ruby
1279
- " \n foo\n\r \t bar \n".squish # => "foo bar"
1280
- ```
1281
-
1282
- There's also the destructive version `String#squish!`.
1283
-
1284
- Note that it handles both ASCII and Unicode whitespace like mongolian vowel separator (U+180E).
1285
-
1286
- NOTE: Defined in `active_support/core_ext/string/filters.rb`.
1287
-
1288
- ### `truncate`
1289
-
1290
- The method `truncate` returns a copy of its receiver truncated after a given `length`:
1291
-
1292
- ```ruby
1293
- "Oh dear! Oh dear! I shall be late!".truncate(20)
1294
- # => "Oh dear! Oh dear!..."
1295
- ```
1296
-
1297
- Ellipsis can be customized with the `:omission` option:
1298
-
1299
- ```ruby
1300
- "Oh dear! Oh dear! I shall be late!".truncate(20, omission: '&hellip;')
1301
- # => "Oh dear! Oh &hellip;"
1302
- ```
1303
-
1304
- Note in particular that truncation takes into account the length of the omission string.
1305
-
1306
- Pass a `:separator` to truncate the string at a natural break:
1307
-
1308
- ```ruby
1309
- "Oh dear! Oh dear! I shall be late!".truncate(18)
1310
- # => "Oh dear! Oh dea..."
1311
- "Oh dear! Oh dear! I shall be late!".truncate(18, separator: ' ')
1312
- # => "Oh dear! Oh..."
1313
- ```
1314
-
1315
- The option `:separator` can be a regexp:
1316
-
1317
- ```ruby
1318
- "Oh dear! Oh dear! I shall be late!".truncate(18, separator: /\s/)
1319
- # => "Oh dear! Oh..."
1320
- ```
1321
-
1322
- In above examples "dear" gets cut first, but then `:separator` prevents it.
1323
-
1324
- NOTE: Defined in `active_support/core_ext/string/filters.rb`.
1325
-
1326
- ### `inquiry`
1327
-
1328
- The `inquiry` method converts a string into a `StringInquirer` object making equality checks prettier.
1329
-
1330
- ```ruby
1331
- "production".inquiry.production? # => true
1332
- "active".inquiry.inactive? # => false
1333
- ```
1334
-
1335
- ### `starts_with?` and `ends_with?`
1336
-
1337
- Active Support defines 3rd person aliases of `String#start_with?` and `String#end_with?`:
1338
-
1339
- ```ruby
1340
- "foo".starts_with?("f") # => true
1341
- "foo".ends_with?("o") # => true
1342
- ```
1343
-
1344
- NOTE: Defined in `active_support/core_ext/string/starts_ends_with.rb`.
1345
-
1346
- ### `strip_heredoc`
1347
-
1348
- The method `strip_heredoc` strips indentation in heredocs.
1349
-
1350
- For example in
1351
-
1352
- ```ruby
1353
- if options[:usage]
1354
- puts <<-USAGE.strip_heredoc
1355
- This command does such and such.
1356
-
1357
- Supported options are:
1358
- -h This message
1359
- ...
1360
- USAGE
1361
- end
1362
- ```
1363
-
1364
- the user would see the usage message aligned against the left margin.
1365
-
1366
- Technically, it looks for the least indented line in the whole string, and removes
1367
- that amount of leading whitespace.
1368
-
1369
- NOTE: Defined in `active_support/core_ext/string/strip.rb`.
1370
-
1371
- ### `indent`
1372
-
1373
- Indents the lines in the receiver:
1374
-
1375
- ```ruby
1376
- <<EOS.indent(2)
1377
- def some_method
1378
- some_code
1379
- end
1380
- EOS
1381
- # =>
1382
- def some_method
1383
- some_code
1384
- end
1385
- ```
1386
-
1387
- The second argument, `indent_string`, specifies which indent string to use. The default is `nil`, which tells the method to make an educated guess peeking at the first indented line, and fallback to a space if there is none.
1388
-
1389
- ```ruby
1390
- " foo".indent(2) # => " foo"
1391
- "foo\n\t\tbar".indent(2) # => "\t\tfoo\n\t\t\t\tbar"
1392
- "foo".indent(2, "\t") # => "\t\tfoo"
1393
- ```
1394
-
1395
- While `indent_string` is typically one space or tab, it may be any string.
1396
-
1397
- The third argument, `indent_empty_lines`, is a flag that says whether empty lines should be indented. Default is false.
1398
-
1399
- ```ruby
1400
- "foo\n\nbar".indent(2) # => " foo\n\n bar"
1401
- "foo\n\nbar".indent(2, nil, true) # => " foo\n \n bar"
1402
- ```
1403
-
1404
- The `indent!` method performs indentation in-place.
1405
-
1406
- NOTE: Defined in `active_support/core_ext/string/indent.rb`.
1407
-
1408
- ### Access
1409
-
1410
- #### `at(position)`
1411
-
1412
- Returns the character of the string at position `position`:
1413
-
1414
- ```ruby
1415
- "hello".at(0) # => "h"
1416
- "hello".at(4) # => "o"
1417
- "hello".at(-1) # => "o"
1418
- "hello".at(10) # => nil
1419
- ```
1420
-
1421
- NOTE: Defined in `active_support/core_ext/string/access.rb`.
1422
-
1423
- #### `from(position)`
1424
-
1425
- Returns the substring of the string starting at position `position`:
1426
-
1427
- ```ruby
1428
- "hello".from(0) # => "hello"
1429
- "hello".from(2) # => "llo"
1430
- "hello".from(-2) # => "lo"
1431
- "hello".from(10) # => "" if < 1.9, nil in 1.9
1432
- ```
1433
-
1434
- NOTE: Defined in `active_support/core_ext/string/access.rb`.
1435
-
1436
- #### `to(position)`
1437
-
1438
- Returns the substring of the string up to position `position`:
1439
-
1440
- ```ruby
1441
- "hello".to(0) # => "h"
1442
- "hello".to(2) # => "hel"
1443
- "hello".to(-2) # => "hell"
1444
- "hello".to(10) # => "hello"
1445
- ```
1446
-
1447
- NOTE: Defined in `active_support/core_ext/string/access.rb`.
1448
-
1449
- #### `first(limit = 1)`
1450
-
1451
- The call `str.first(n)` is equivalent to `str.to(n-1)` if `n` > 0, and returns an empty string for `n` == 0.
1452
-
1453
- NOTE: Defined in `active_support/core_ext/string/access.rb`.
1454
-
1455
- #### `last(limit = 1)`
1456
-
1457
- The call `str.last(n)` is equivalent to `str.from(-n)` if `n` > 0, and returns an empty string for `n` == 0.
1458
-
1459
- NOTE: Defined in `active_support/core_ext/string/access.rb`.
1460
-
1461
- ### Inflections
1462
-
1463
- #### `pluralize`
1464
-
1465
- The method `pluralize` returns the plural of its receiver:
1466
-
1467
- ```ruby
1468
- "table".pluralize # => "tables"
1469
- "ruby".pluralize # => "rubies"
1470
- "equipment".pluralize # => "equipment"
1471
- ```
1472
-
1473
- As the previous example shows, Active Support knows some irregular plurals and uncountable nouns. Built-in rules can be extended in `config/initializers/inflections.rb`. That file is generated by the `rails` command and has instructions in comments.
1474
-
1475
- `pluralize` can also take an optional `count` parameter. If `count == 1` the singular form will be returned. For any other value of `count` the plural form will be returned:
1476
-
1477
- ```ruby
1478
- "dude".pluralize(0) # => "dudes"
1479
- "dude".pluralize(1) # => "dude"
1480
- "dude".pluralize(2) # => "dudes"
1481
- ```
1482
-
1483
- Active Record uses this method to compute the default table name that corresponds to a model:
1484
-
1485
- ```ruby
1486
- # active_record/model_schema.rb
1487
- def undecorated_table_name(class_name = base_class.name)
1488
- table_name = class_name.to_s.demodulize.underscore
1489
- pluralize_table_names ? table_name.pluralize : table_name
1490
- end
1491
- ```
1492
-
1493
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1494
-
1495
- #### `singularize`
1496
-
1497
- The inverse of `pluralize`:
1498
-
1499
- ```ruby
1500
- "tables".singularize # => "table"
1501
- "rubies".singularize # => "ruby"
1502
- "equipment".singularize # => "equipment"
1503
- ```
1504
-
1505
- Associations compute the name of the corresponding default associated class using this method:
1506
-
1507
- ```ruby
1508
- # active_record/reflection.rb
1509
- def derive_class_name
1510
- class_name = name.to_s.camelize
1511
- class_name = class_name.singularize if collection?
1512
- class_name
1513
- end
1514
- ```
1515
-
1516
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1517
-
1518
- #### `camelize`
1519
-
1520
- The method `camelize` returns its receiver in camel case:
1521
-
1522
- ```ruby
1523
- "product".camelize # => "Product"
1524
- "admin_user".camelize # => "AdminUser"
1525
- ```
1526
-
1527
- As a rule of thumb you can think of this method as the one that transforms paths into Ruby class or module names, where slashes separate namespaces:
1528
-
1529
- ```ruby
1530
- "backoffice/session".camelize # => "Backoffice::Session"
1531
- ```
1532
-
1533
- For example, Action Pack uses this method to load the class that provides a certain session store:
1534
-
1535
- ```ruby
1536
- # action_controller/metal/session_management.rb
1537
- def session_store=(store)
1538
- @@session_store = store.is_a?(Symbol) ?
1539
- ActionDispatch::Session.const_get(store.to_s.camelize) :
1540
- store
1541
- end
1542
- ```
1543
-
1544
- `camelize` accepts an optional argument, it can be `:upper` (default), or `:lower`. With the latter the first letter becomes lowercase:
1545
-
1546
- ```ruby
1547
- "visual_effect".camelize(:lower) # => "visualEffect"
1548
- ```
1549
-
1550
- That may be handy to compute method names in a language that follows that convention, for example JavaScript.
1551
-
1552
- INFO: As a rule of thumb you can think of `camelize` as the inverse of `underscore`, though there are cases where that does not hold: `"SSLError".underscore.camelize` gives back `"SslError"`. To support cases such as this, Active Support allows you to specify acronyms in `config/initializers/inflections.rb`:
1553
-
1554
- ```ruby
1555
- ActiveSupport::Inflector.inflections do |inflect|
1556
- inflect.acronym 'SSL'
1557
- end
1558
-
1559
- "SSLError".underscore.camelize # => "SSLError"
1560
- ```
1561
-
1562
- `camelize` is aliased to `camelcase`.
1563
-
1564
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1565
-
1566
- #### `underscore`
1567
-
1568
- The method `underscore` goes the other way around, from camel case to paths:
1569
-
1570
- ```ruby
1571
- "Product".underscore # => "product"
1572
- "AdminUser".underscore # => "admin_user"
1573
- ```
1574
-
1575
- Also converts "::" back to "/":
1576
-
1577
- ```ruby
1578
- "Backoffice::Session".underscore # => "backoffice/session"
1579
- ```
1580
-
1581
- and understands strings that start with lowercase:
1582
-
1583
- ```ruby
1584
- "visualEffect".underscore # => "visual_effect"
1585
- ```
1586
-
1587
- `underscore` accepts no argument though.
1588
-
1589
- Rails class and module autoloading uses `underscore` to infer the relative path without extension of a file that would define a given missing constant:
1590
-
1591
- ```ruby
1592
- # active_support/dependencies.rb
1593
- def load_missing_constant(from_mod, const_name)
1594
- ...
1595
- qualified_name = qualified_name_for from_mod, const_name
1596
- path_suffix = qualified_name.underscore
1597
- ...
1598
- end
1599
- ```
1600
-
1601
- INFO: As a rule of thumb you can think of `underscore` as the inverse of `camelize`, though there are cases where that does not hold. For example, `"SSLError".underscore.camelize` gives back `"SslError"`.
1602
-
1603
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1604
-
1605
- #### `titleize`
1606
-
1607
- The method `titleize` capitalizes the words in the receiver:
1608
-
1609
- ```ruby
1610
- "alice in wonderland".titleize # => "Alice In Wonderland"
1611
- "fermat's enigma".titleize # => "Fermat's Enigma"
1612
- ```
1613
-
1614
- `titleize` is aliased to `titlecase`.
1615
-
1616
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1617
-
1618
- #### `dasherize`
1619
-
1620
- The method `dasherize` replaces the underscores in the receiver with dashes:
1621
-
1622
- ```ruby
1623
- "name".dasherize # => "name"
1624
- "contact_data".dasherize # => "contact-data"
1625
- ```
1626
-
1627
- The XML serializer of models uses this method to dasherize node names:
1628
-
1629
- ```ruby
1630
- # active_model/serializers/xml.rb
1631
- def reformat_name(name)
1632
- name = name.camelize if camelize?
1633
- dasherize? ? name.dasherize : name
1634
- end
1635
- ```
1636
-
1637
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1638
-
1639
- #### `demodulize`
1640
-
1641
- Given a string with a qualified constant name, `demodulize` returns the very constant name, that is, the rightmost part of it:
1642
-
1643
- ```ruby
1644
- "Product".demodulize # => "Product"
1645
- "Backoffice::UsersController".demodulize # => "UsersController"
1646
- "Admin::Hotel::ReservationUtils".demodulize # => "ReservationUtils"
1647
- ```
1648
-
1649
- Active Record for example uses this method to compute the name of a counter cache column:
1650
-
1651
- ```ruby
1652
- # active_record/reflection.rb
1653
- def counter_cache_column
1654
- if options[:counter_cache] == true
1655
- "#{active_record.name.demodulize.underscore.pluralize}_count"
1656
- elsif options[:counter_cache]
1657
- options[:counter_cache]
1658
- end
1659
- end
1660
- ```
1661
-
1662
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1663
-
1664
- #### `deconstantize`
1665
-
1666
- Given a string with a qualified constant reference expression, `deconstantize` removes the rightmost segment, generally leaving the name of the constant's container:
1667
-
1668
- ```ruby
1669
- "Product".deconstantize # => ""
1670
- "Backoffice::UsersController".deconstantize # => "Backoffice"
1671
- "Admin::Hotel::ReservationUtils".deconstantize # => "Admin::Hotel"
1672
- ```
1673
-
1674
- Active Support for example uses this method in `Module#qualified_const_set`:
1675
-
1676
- ```ruby
1677
- def qualified_const_set(path, value)
1678
- QualifiedConstUtils.raise_if_absolute(path)
1679
-
1680
- const_name = path.demodulize
1681
- mod_name = path.deconstantize
1682
- mod = mod_name.empty? ? self : qualified_const_get(mod_name)
1683
- mod.const_set(const_name, value)
1684
- end
1685
- ```
1686
-
1687
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1688
-
1689
- #### `parameterize`
1690
-
1691
- The method `parameterize` normalizes its receiver in a way that can be used in pretty URLs.
1692
-
1693
- ```ruby
1694
- "John Smith".parameterize # => "john-smith"
1695
- "Kurt Gödel".parameterize # => "kurt-godel"
1696
- ```
1697
-
1698
- In fact, the result string is wrapped in an instance of `ActiveSupport::Multibyte::Chars`.
1699
-
1700
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1701
-
1702
- #### `tableize`
1703
-
1704
- The method `tableize` is `underscore` followed by `pluralize`.
1705
-
1706
- ```ruby
1707
- "Person".tableize # => "people"
1708
- "Invoice".tableize # => "invoices"
1709
- "InvoiceLine".tableize # => "invoice_lines"
1710
- ```
1711
-
1712
- As a rule of thumb, `tableize` returns the table name that corresponds to a given model for simple cases. The actual implementation in Active Record is not straight `tableize` indeed, because it also demodulizes the class name and checks a few options that may affect the returned string.
1713
-
1714
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1715
-
1716
- #### `classify`
1717
-
1718
- The method `classify` is the inverse of `tableize`. It gives you the class name corresponding to a table name:
1719
-
1720
- ```ruby
1721
- "people".classify # => "Person"
1722
- "invoices".classify # => "Invoice"
1723
- "invoice_lines".classify # => "InvoiceLine"
1724
- ```
1725
-
1726
- The method understands qualified table names:
1727
-
1728
- ```ruby
1729
- "highrise_production.companies".classify # => "Company"
1730
- ```
1731
-
1732
- Note that `classify` returns a class name as a string. You can get the actual class object invoking `constantize` on it, explained next.
1733
-
1734
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1735
-
1736
- #### `constantize`
1737
-
1738
- The method `constantize` resolves the constant reference expression in its receiver:
1739
-
1740
- ```ruby
1741
- "Fixnum".constantize # => Fixnum
1742
-
1743
- module M
1744
- X = 1
1745
- end
1746
- "M::X".constantize # => 1
1747
- ```
1748
-
1749
- If the string evaluates to no known constant, or its content is not even a valid constant name, `constantize` raises `NameError`.
1750
-
1751
- Constant name resolution by `constantize` starts always at the top-level `Object` even if there is no leading "::".
1752
-
1753
- ```ruby
1754
- X = :in_Object
1755
- module M
1756
- X = :in_M
1757
-
1758
- X # => :in_M
1759
- "::X".constantize # => :in_Object
1760
- "X".constantize # => :in_Object (!)
1761
- end
1762
- ```
1763
-
1764
- So, it is in general not equivalent to what Ruby would do in the same spot, had a real constant be evaluated.
1765
-
1766
- Mailer test cases obtain the mailer being tested from the name of the test class using `constantize`:
1767
-
1768
- ```ruby
1769
- # action_mailer/test_case.rb
1770
- def determine_default_mailer(name)
1771
- name.sub(/Test$/, '').constantize
1772
- rescue NameError => e
1773
- raise NonInferrableMailerError.new(name)
1774
- end
1775
- ```
1776
-
1777
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1778
-
1779
- #### `humanize`
1780
-
1781
- The method `humanize` gives you a sensible name for display out of an attribute name. To do so it replaces underscores with spaces, removes any "_id" suffix, and capitalizes the first word:
1782
-
1783
- ```ruby
1784
- "name".humanize # => "Name"
1785
- "author_id".humanize # => "Author"
1786
- "comments_count".humanize # => "Comments count"
1787
- ```
1788
-
1789
- The capitalization of the first word can be turned off by setting the optional parameter `capitalize` to false:
1790
-
1791
- ```ruby
1792
- "author_id".humanize(capitalize: false) # => "author"
1793
- ```
1794
-
1795
- The helper method `full_messages` uses `humanize` as a fallback to include attribute names:
1796
-
1797
- ```ruby
1798
- def full_messages
1799
- full_messages = []
1800
-
1801
- each do |attribute, messages|
1802
- ...
1803
- attr_name = attribute.to_s.gsub('.', '_').humanize
1804
- attr_name = @base.class.human_attribute_name(attribute, default: attr_name)
1805
- ...
1806
- end
1807
-
1808
- full_messages
1809
- end
1810
- ```
1811
-
1812
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1813
-
1814
- #### `foreign_key`
1815
-
1816
- The method `foreign_key` gives a foreign key column name from a class name. To do so it demodulizes, underscores, and adds "_id":
1817
-
1818
- ```ruby
1819
- "User".foreign_key # => "user_id"
1820
- "InvoiceLine".foreign_key # => "invoice_line_id"
1821
- "Admin::Session".foreign_key # => "session_id"
1822
- ```
1823
-
1824
- Pass a false argument if you do not want the underscore in "_id":
1825
-
1826
- ```ruby
1827
- "User".foreign_key(false) # => "userid"
1828
- ```
1829
-
1830
- Associations use this method to infer foreign keys, for example `has_one` and `has_many` do this:
1831
-
1832
- ```ruby
1833
- # active_record/associations.rb
1834
- foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
1835
- ```
1836
-
1837
- NOTE: Defined in `active_support/core_ext/string/inflections.rb`.
1838
-
1839
- ### Conversions
1840
-
1841
- #### `to_date`, `to_time`, `to_datetime`
1842
-
1843
- The methods `to_date`, `to_time`, and `to_datetime` are basically convenience wrappers around `Date._parse`:
1844
-
1845
- ```ruby
1846
- "2010-07-27".to_date # => Tue, 27 Jul 2010
1847
- "2010-07-27 23:37:00".to_time # => Tue Jul 27 23:37:00 UTC 2010
1848
- "2010-07-27 23:37:00".to_datetime # => Tue, 27 Jul 2010 23:37:00 +0000
1849
- ```
1850
-
1851
- `to_time` receives an optional argument `:utc` or `:local`, to indicate which time zone you want the time in:
1852
-
1853
- ```ruby
1854
- "2010-07-27 23:42:00".to_time(:utc) # => Tue Jul 27 23:42:00 UTC 2010
1855
- "2010-07-27 23:42:00".to_time(:local) # => Tue Jul 27 23:42:00 +0200 2010
1856
- ```
1857
-
1858
- Default is `:utc`.
1859
-
1860
- Please refer to the documentation of `Date._parse` for further details.
1861
-
1862
- INFO: The three of them return `nil` for blank receivers.
1863
-
1864
- NOTE: Defined in `active_support/core_ext/string/conversions.rb`.
1865
-
1866
- Extensions to `Numeric`
1867
- -----------------------
1868
-
1869
- ### Bytes
1870
-
1871
- All numbers respond to these methods:
1872
-
1873
- ```ruby
1874
- bytes
1875
- kilobytes
1876
- megabytes
1877
- gigabytes
1878
- terabytes
1879
- petabytes
1880
- exabytes
1881
- ```
1882
-
1883
- They return the corresponding amount of bytes, using a conversion factor of 1024:
1884
-
1885
- ```ruby
1886
- 2.kilobytes # => 2048
1887
- 3.megabytes # => 3145728
1888
- 3.5.gigabytes # => 3758096384
1889
- -4.exabytes # => -4611686018427387904
1890
- ```
1891
-
1892
- Singular forms are aliased so you are able to say:
1893
-
1894
- ```ruby
1895
- 1.megabyte # => 1048576
1896
- ```
1897
-
1898
- NOTE: Defined in `active_support/core_ext/numeric/bytes.rb`.
1899
-
1900
- ### Time
1901
-
1902
- Enables the use of time calculations and declarations, like `45.minutes + 2.hours + 4.years`.
1903
-
1904
- These methods use Time#advance for precise date calculations when using from_now, ago, etc.
1905
- as well as adding or subtracting their results from a Time object. For example:
1906
-
1907
- ```ruby
1908
- # equivalent to Time.current.advance(months: 1)
1909
- 1.month.from_now
1910
-
1911
- # equivalent to Time.current.advance(years: 2)
1912
- 2.years.from_now
1913
-
1914
- # equivalent to Time.current.advance(months: 4, years: 5)
1915
- (4.months + 5.years).from_now
1916
- ```
1917
-
1918
- While these methods provide precise calculation when used as in the examples above, care
1919
- should be taken to note that this is not true if the result of `months', `years', etc is
1920
- converted before use:
1921
-
1922
- ```ruby
1923
- # equivalent to 30.days.to_i.from_now
1924
- 1.month.to_i.from_now
1925
-
1926
- # equivalent to 365.25.days.to_f.from_now
1927
- 1.year.to_f.from_now
1928
- ```
1929
-
1930
- In such cases, Ruby's core [Date](http://ruby-doc.org/stdlib/libdoc/date/rdoc/Date.html) and
1931
- [Time](http://ruby-doc.org/stdlib/libdoc/time/rdoc/Time.html) should be used for precision
1932
- date and time arithmetic.
1933
-
1934
- NOTE: Defined in `active_support/core_ext/numeric/time.rb`.
1935
-
1936
- ### Formatting
1937
-
1938
- Enables the formatting of numbers in a variety of ways.
1939
-
1940
- Produce a string representation of a number as a telephone number:
1941
-
1942
- ```ruby
1943
- 5551234.to_s(:phone)
1944
- # => 555-1234
1945
- 1235551234.to_s(:phone)
1946
- # => 123-555-1234
1947
- 1235551234.to_s(:phone, area_code: true)
1948
- # => (123) 555-1234
1949
- 1235551234.to_s(:phone, delimiter: " ")
1950
- # => 123 555 1234
1951
- 1235551234.to_s(:phone, area_code: true, extension: 555)
1952
- # => (123) 555-1234 x 555
1953
- 1235551234.to_s(:phone, country_code: 1)
1954
- # => +1-123-555-1234
1955
- ```
1956
-
1957
- Produce a string representation of a number as currency:
1958
-
1959
- ```ruby
1960
- 1234567890.50.to_s(:currency) # => $1,234,567,890.50
1961
- 1234567890.506.to_s(:currency) # => $1,234,567,890.51
1962
- 1234567890.506.to_s(:currency, precision: 3) # => $1,234,567,890.506
1963
- ```
1964
-
1965
- Produce a string representation of a number as a percentage:
1966
-
1967
- ```ruby
1968
- 100.to_s(:percentage)
1969
- # => 100.000%
1970
- 100.to_s(:percentage, precision: 0)
1971
- # => 100%
1972
- 1000.to_s(:percentage, delimiter: '.', separator: ',')
1973
- # => 1.000,000%
1974
- 302.24398923423.to_s(:percentage, precision: 5)
1975
- # => 302.24399%
1976
- ```
1977
-
1978
- Produce a string representation of a number in delimited form:
1979
-
1980
- ```ruby
1981
- 12345678.to_s(:delimited) # => 12,345,678
1982
- 12345678.05.to_s(:delimited) # => 12,345,678.05
1983
- 12345678.to_s(:delimited, delimiter: ".") # => 12.345.678
1984
- 12345678.to_s(:delimited, delimiter: ",") # => 12,345,678
1985
- 12345678.05.to_s(:delimited, separator: " ") # => 12,345,678 05
1986
- ```
1987
-
1988
- Produce a string representation of a number rounded to a precision:
1989
-
1990
- ```ruby
1991
- 111.2345.to_s(:rounded) # => 111.235
1992
- 111.2345.to_s(:rounded, precision: 2) # => 111.23
1993
- 13.to_s(:rounded, precision: 5) # => 13.00000
1994
- 389.32314.to_s(:rounded, precision: 0) # => 389
1995
- 111.2345.to_s(:rounded, significant: true) # => 111
1996
- ```
1997
-
1998
- Produce a string representation of a number as a human-readable number of bytes:
1999
-
2000
- ```ruby
2001
- 123.to_s(:human_size) # => 123 Bytes
2002
- 1234.to_s(:human_size) # => 1.21 KB
2003
- 12345.to_s(:human_size) # => 12.1 KB
2004
- 1234567.to_s(:human_size) # => 1.18 MB
2005
- 1234567890.to_s(:human_size) # => 1.15 GB
2006
- 1234567890123.to_s(:human_size) # => 1.12 TB
2007
- ```
2008
-
2009
- Produce a string representation of a number in human-readable words:
2010
-
2011
- ```ruby
2012
- 123.to_s(:human) # => "123"
2013
- 1234.to_s(:human) # => "1.23 Thousand"
2014
- 12345.to_s(:human) # => "12.3 Thousand"
2015
- 1234567.to_s(:human) # => "1.23 Million"
2016
- 1234567890.to_s(:human) # => "1.23 Billion"
2017
- 1234567890123.to_s(:human) # => "1.23 Trillion"
2018
- 1234567890123456.to_s(:human) # => "1.23 Quadrillion"
2019
- ```
2020
-
2021
- NOTE: Defined in `active_support/core_ext/numeric/conversions.rb`.
2022
-
2023
- Extensions to `Integer`
2024
- -----------------------
2025
-
2026
- ### `multiple_of?`
2027
-
2028
- The method `multiple_of?` tests whether an integer is multiple of the argument:
2029
-
2030
- ```ruby
2031
- 2.multiple_of?(1) # => true
2032
- 1.multiple_of?(2) # => false
2033
- ```
2034
-
2035
- NOTE: Defined in `active_support/core_ext/integer/multiple.rb`.
2036
-
2037
- ### `ordinal`
2038
-
2039
- The method `ordinal` returns the ordinal suffix string corresponding to the receiver integer:
2040
-
2041
- ```ruby
2042
- 1.ordinal # => "st"
2043
- 2.ordinal # => "nd"
2044
- 53.ordinal # => "rd"
2045
- 2009.ordinal # => "th"
2046
- -21.ordinal # => "st"
2047
- -134.ordinal # => "th"
2048
- ```
2049
-
2050
- NOTE: Defined in `active_support/core_ext/integer/inflections.rb`.
2051
-
2052
- ### `ordinalize`
2053
-
2054
- The method `ordinalize` returns the ordinal string corresponding to the receiver integer. In comparison, note that the `ordinal` method returns **only** the suffix string.
2055
-
2056
- ```ruby
2057
- 1.ordinalize # => "1st"
2058
- 2.ordinalize # => "2nd"
2059
- 53.ordinalize # => "53rd"
2060
- 2009.ordinalize # => "2009th"
2061
- -21.ordinalize # => "-21st"
2062
- -134.ordinalize # => "-134th"
2063
- ```
2064
-
2065
- NOTE: Defined in `active_support/core_ext/integer/inflections.rb`.
2066
-
2067
- Extensions to `BigDecimal`
2068
- --------------------------
2069
- ### `to_s`
2070
-
2071
- The method `to_s` is aliased to `to_formatted_s`. This provides a convenient way to display a BigDecimal value in floating-point notation:
2072
-
2073
- ```ruby
2074
- BigDecimal.new(5.00, 6).to_s # => "5.0"
2075
- ```
2076
-
2077
- ### `to_formatted_s`
2078
-
2079
- Te method `to_formatted_s` provides a default specifier of "F". This means that a simple call to `to_formatted_s` or `to_s` will result in floating point representation instead of engineering notation:
2080
-
2081
- ```ruby
2082
- BigDecimal.new(5.00, 6).to_formatted_s # => "5.0"
2083
- ```
2084
-
2085
- and that symbol specifiers are also supported:
2086
-
2087
- ```ruby
2088
- BigDecimal.new(5.00, 6).to_formatted_s(:db) # => "5.0"
2089
- ```
2090
-
2091
- Engineering notation is still supported:
2092
-
2093
- ```ruby
2094
- BigDecimal.new(5.00, 6).to_formatted_s("e") # => "0.5E1"
2095
- ```
2096
-
2097
- Extensions to `Enumerable`
2098
- --------------------------
2099
-
2100
- ### `sum`
2101
-
2102
- The method `sum` adds the elements of an enumerable:
2103
-
2104
- ```ruby
2105
- [1, 2, 3].sum # => 6
2106
- (1..100).sum # => 5050
2107
- ```
2108
-
2109
- Addition only assumes the elements respond to `+`:
2110
-
2111
- ```ruby
2112
- [[1, 2], [2, 3], [3, 4]].sum # => [1, 2, 2, 3, 3, 4]
2113
- %w(foo bar baz).sum # => "foobarbaz"
2114
- {a: 1, b: 2, c: 3}.sum # => [:b, 2, :c, 3, :a, 1]
2115
- ```
2116
-
2117
- The sum of an empty collection is zero by default, but this is customizable:
2118
-
2119
- ```ruby
2120
- [].sum # => 0
2121
- [].sum(1) # => 1
2122
- ```
2123
-
2124
- If a block is given, `sum` becomes an iterator that yields the elements of the collection and sums the returned values:
2125
-
2126
- ```ruby
2127
- (1..5).sum {|n| n * 2 } # => 30
2128
- [2, 4, 6, 8, 10].sum # => 30
2129
- ```
2130
-
2131
- The sum of an empty receiver can be customized in this form as well:
2132
-
2133
- ```ruby
2134
- [].sum(1) {|n| n**3} # => 1
2135
- ```
2136
-
2137
- NOTE: Defined in `active_support/core_ext/enumerable.rb`.
2138
-
2139
- ### `index_by`
2140
-
2141
- The method `index_by` generates a hash with the elements of an enumerable indexed by some key.
2142
-
2143
- It iterates through the collection and passes each element to a block. The element will be keyed by the value returned by the block:
2144
-
2145
- ```ruby
2146
- invoices.index_by(&:number)
2147
- # => {'2009-032' => <Invoice ...>, '2009-008' => <Invoice ...>, ...}
2148
- ```
2149
-
2150
- WARNING. Keys should normally be unique. If the block returns the same value for different elements no collection is built for that key. The last item will win.
2151
-
2152
- NOTE: Defined in `active_support/core_ext/enumerable.rb`.
2153
-
2154
- ### `many?`
2155
-
2156
- The method `many?` is shorthand for `collection.size > 1`:
2157
-
2158
- ```erb
2159
- <% if pages.many? %>
2160
- <%= pagination_links %>
2161
- <% end %>
2162
- ```
2163
-
2164
- If an optional block is given, `many?` only takes into account those elements that return true:
2165
-
2166
- ```ruby
2167
- @see_more = videos.many? {|video| video.category == params[:category]}
2168
- ```
2169
-
2170
- NOTE: Defined in `active_support/core_ext/enumerable.rb`.
2171
-
2172
- ### `exclude?`
2173
-
2174
- The predicate `exclude?` tests whether a given object does **not** belong to the collection. It is the negation of the built-in `include?`:
2175
-
2176
- ```ruby
2177
- to_visit << node if visited.exclude?(node)
2178
- ```
2179
-
2180
- NOTE: Defined in `active_support/core_ext/enumerable.rb`.
2181
-
2182
- Extensions to `Array`
2183
- ---------------------
2184
-
2185
- ### Accessing
2186
-
2187
- Active Support augments the API of arrays to ease certain ways of accessing them. For example, `to` returns the subarray of elements up to the one at the passed index:
2188
-
2189
- ```ruby
2190
- %w(a b c d).to(2) # => %w(a b c)
2191
- [].to(7) # => []
2192
- ```
2193
-
2194
- Similarly, `from` returns the tail from the element at the passed index to the end. If the index is greater than the length of the array, it returns an empty array.
2195
-
2196
- ```ruby
2197
- %w(a b c d).from(2) # => %w(c d)
2198
- %w(a b c d).from(10) # => []
2199
- [].from(0) # => []
2200
- ```
2201
-
2202
- The methods `second`, `third`, `fourth`, and `fifth` return the corresponding element (`first` is built-in). Thanks to social wisdom and positive constructiveness all around, `forty_two` is also available.
2203
-
2204
- ```ruby
2205
- %w(a b c d).third # => c
2206
- %w(a b c d).fifth # => nil
2207
- ```
2208
-
2209
- NOTE: Defined in `active_support/core_ext/array/access.rb`.
2210
-
2211
- ### Adding Elements
2212
-
2213
- #### `prepend`
2214
-
2215
- This method is an alias of `Array#unshift`.
2216
-
2217
- ```ruby
2218
- %w(a b c d).prepend('e') # => %w(e a b c d)
2219
- [].prepend(10) # => [10]
2220
- ```
2221
-
2222
- NOTE: Defined in `active_support/core_ext/array/prepend_and_append.rb`.
2223
-
2224
- #### `append`
2225
-
2226
- This method is an alias of `Array#<<`.
2227
-
2228
- ```ruby
2229
- %w(a b c d).append('e') # => %w(a b c d e)
2230
- [].append([1,2]) # => [[1,2]]
2231
- ```
2232
-
2233
- NOTE: Defined in `active_support/core_ext/array/prepend_and_append.rb`.
2234
-
2235
- ### Options Extraction
2236
-
2237
- When the last argument in a method call is a hash, except perhaps for a `&block` argument, Ruby allows you to omit the brackets:
2238
-
2239
- ```ruby
2240
- User.exists?(email: params[:email])
2241
- ```
2242
-
2243
- That syntactic sugar is used a lot in Rails to avoid positional arguments where there would be too many, offering instead interfaces that emulate named parameters. In particular it is very idiomatic to use a trailing hash for options.
2244
-
2245
- If a method expects a variable number of arguments and uses `*` in its declaration, however, such an options hash ends up being an item of the array of arguments, where it loses its role.
2246
-
2247
- In those cases, you may give an options hash a distinguished treatment with `extract_options!`. This method checks the type of the last item of an array. If it is a hash it pops it and returns it, otherwise it returns an empty hash.
2248
-
2249
- Let's see for example the definition of the `caches_action` controller macro:
2250
-
2251
- ```ruby
2252
- def caches_action(*actions)
2253
- return unless cache_configured?
2254
- options = actions.extract_options!
2255
- ...
2256
- end
2257
- ```
2258
-
2259
- This method receives an arbitrary number of action names, and an optional hash of options as last argument. With the call to `extract_options!` you obtain the options hash and remove it from `actions` in a simple and explicit way.
2260
-
2261
- NOTE: Defined in `active_support/core_ext/array/extract_options.rb`.
2262
-
2263
- ### Conversions
2264
-
2265
- #### `to_sentence`
2266
-
2267
- The method `to_sentence` turns an array into a string containing a sentence that enumerates its items:
2268
-
2269
- ```ruby
2270
- %w().to_sentence # => ""
2271
- %w(Earth).to_sentence # => "Earth"
2272
- %w(Earth Wind).to_sentence # => "Earth and Wind"
2273
- %w(Earth Wind Fire).to_sentence # => "Earth, Wind, and Fire"
2274
- ```
2275
-
2276
- This method accepts three options:
2277
-
2278
- * `:two_words_connector`: What is used for arrays of length 2. Default is " and ".
2279
- * `:words_connector`: What is used to join the elements of arrays with 3 or more elements, except for the last two. Default is ", ".
2280
- * `:last_word_connector`: What is used to join the last items of an array with 3 or more elements. Default is ", and ".
2281
-
2282
- The defaults for these options can be localized, their keys are:
2283
-
2284
- | Option | I18n key |
2285
- | ---------------------- | ----------------------------------- |
2286
- | `:two_words_connector` | `support.array.two_words_connector` |
2287
- | `:words_connector` | `support.array.words_connector` |
2288
- | `:last_word_connector` | `support.array.last_word_connector` |
2289
-
2290
- NOTE: Defined in `active_support/core_ext/array/conversions.rb`.
2291
-
2292
- #### `to_formatted_s`
2293
-
2294
- The method `to_formatted_s` acts like `to_s` by default.
2295
-
2296
- If the array contains items that respond to `id`, however, the symbol
2297
- `:db` may be passed as argument. That's typically used with
2298
- collections of Active Record objects. Returned strings are:
2299
-
2300
- ```ruby
2301
- [].to_formatted_s(:db) # => "null"
2302
- [user].to_formatted_s(:db) # => "8456"
2303
- invoice.lines.to_formatted_s(:db) # => "23,567,556,12"
2304
- ```
2305
-
2306
- Integers in the example above are supposed to come from the respective calls to `id`.
2307
-
2308
- NOTE: Defined in `active_support/core_ext/array/conversions.rb`.
2309
-
2310
- #### `to_xml`
2311
-
2312
- The method `to_xml` returns a string containing an XML representation of its receiver:
2313
-
2314
- ```ruby
2315
- Contributor.limit(2).order(:rank).to_xml
2316
- # =>
2317
- # <?xml version="1.0" encoding="UTF-8"?>
2318
- # <contributors type="array">
2319
- # <contributor>
2320
- # <id type="integer">4356</id>
2321
- # <name>Jeremy Kemper</name>
2322
- # <rank type="integer">1</rank>
2323
- # <url-id>jeremy-kemper</url-id>
2324
- # </contributor>
2325
- # <contributor>
2326
- # <id type="integer">4404</id>
2327
- # <name>David Heinemeier Hansson</name>
2328
- # <rank type="integer">2</rank>
2329
- # <url-id>david-heinemeier-hansson</url-id>
2330
- # </contributor>
2331
- # </contributors>
2332
- ```
2333
-
2334
- To do so it sends `to_xml` to every item in turn, and collects the results under a root node. All items must respond to `to_xml`, an exception is raised otherwise.
2335
-
2336
- By default, the name of the root element is the underscorized and dasherized plural of the name of the class of the first item, provided the rest of elements belong to that type (checked with `is_a?`) and they are not hashes. In the example above that's "contributors".
2337
-
2338
- If there's any element that does not belong to the type of the first one the root node becomes "objects":
2339
-
2340
- ```ruby
2341
- [Contributor.first, Commit.first].to_xml
2342
- # =>
2343
- # <?xml version="1.0" encoding="UTF-8"?>
2344
- # <objects type="array">
2345
- # <object>
2346
- # <id type="integer">4583</id>
2347
- # <name>Aaron Batalion</name>
2348
- # <rank type="integer">53</rank>
2349
- # <url-id>aaron-batalion</url-id>
2350
- # </object>
2351
- # <object>
2352
- # <author>Joshua Peek</author>
2353
- # <authored-timestamp type="datetime">2009-09-02T16:44:36Z</authored-timestamp>
2354
- # <branch>origin/master</branch>
2355
- # <committed-timestamp type="datetime">2009-09-02T16:44:36Z</committed-timestamp>
2356
- # <committer>Joshua Peek</committer>
2357
- # <git-show nil="true"></git-show>
2358
- # <id type="integer">190316</id>
2359
- # <imported-from-svn type="boolean">false</imported-from-svn>
2360
- # <message>Kill AMo observing wrap_with_notifications since ARes was only using it</message>
2361
- # <sha1>723a47bfb3708f968821bc969a9a3fc873a3ed58</sha1>
2362
- # </object>
2363
- # </objects>
2364
- ```
2365
-
2366
- If the receiver is an array of hashes the root element is by default also "objects":
2367
-
2368
- ```ruby
2369
- [{a: 1, b: 2}, {c: 3}].to_xml
2370
- # =>
2371
- # <?xml version="1.0" encoding="UTF-8"?>
2372
- # <objects type="array">
2373
- # <object>
2374
- # <b type="integer">2</b>
2375
- # <a type="integer">1</a>
2376
- # </object>
2377
- # <object>
2378
- # <c type="integer">3</c>
2379
- # </object>
2380
- # </objects>
2381
- ```
2382
-
2383
- WARNING. If the collection is empty the root element is by default "nil-classes". That's a gotcha, for example the root element of the list of contributors above would not be "contributors" if the collection was empty, but "nil-classes". You may use the `:root` option to ensure a consistent root element.
2384
-
2385
- The name of children nodes is by default the name of the root node singularized. In the examples above we've seen "contributor" and "object". The option `:children` allows you to set these node names.
2386
-
2387
- The default XML builder is a fresh instance of `Builder::XmlMarkup`. You can configure your own builder via the `:builder` option. The method also accepts options like `:dasherize` and friends, they are forwarded to the builder:
2388
-
2389
- ```ruby
2390
- Contributor.limit(2).order(:rank).to_xml(skip_types: true)
2391
- # =>
2392
- # <?xml version="1.0" encoding="UTF-8"?>
2393
- # <contributors>
2394
- # <contributor>
2395
- # <id>4356</id>
2396
- # <name>Jeremy Kemper</name>
2397
- # <rank>1</rank>
2398
- # <url-id>jeremy-kemper</url-id>
2399
- # </contributor>
2400
- # <contributor>
2401
- # <id>4404</id>
2402
- # <name>David Heinemeier Hansson</name>
2403
- # <rank>2</rank>
2404
- # <url-id>david-heinemeier-hansson</url-id>
2405
- # </contributor>
2406
- # </contributors>
2407
- ```
2408
-
2409
- NOTE: Defined in `active_support/core_ext/array/conversions.rb`.
2410
-
2411
- ### Wrapping
2412
-
2413
- The method `Array.wrap` wraps its argument in an array unless it is already an array (or array-like).
2414
-
2415
- Specifically:
2416
-
2417
- * If the argument is `nil` an empty list is returned.
2418
- * Otherwise, if the argument responds to `to_ary` it is invoked, and if the value of `to_ary` is not `nil`, it is returned.
2419
- * Otherwise, an array with the argument as its single element is returned.
2420
-
2421
- ```ruby
2422
- Array.wrap(nil) # => []
2423
- Array.wrap([1, 2, 3]) # => [1, 2, 3]
2424
- Array.wrap(0) # => [0]
2425
- ```
2426
-
2427
- This method is similar in purpose to `Kernel#Array`, but there are some differences:
2428
-
2429
- * If the argument responds to `to_ary` the method is invoked. `Kernel#Array` moves on to try `to_a` if the returned value is `nil`, but `Array.wrap` returns `nil` right away.
2430
- * If the returned value from `to_ary` is neither `nil` nor an `Array` object, `Kernel#Array` raises an exception, while `Array.wrap` does not, it just returns the value.
2431
- * It does not call `to_a` on the argument, though special-cases `nil` to return an empty array.
2432
-
2433
- The last point is particularly worth comparing for some enumerables:
2434
-
2435
- ```ruby
2436
- Array.wrap(foo: :bar) # => [{:foo=>:bar}]
2437
- Array(foo: :bar) # => [[:foo, :bar]]
2438
- ```
2439
-
2440
- There's also a related idiom that uses the splat operator:
2441
-
2442
- ```ruby
2443
- [*object]
2444
- ```
2445
-
2446
- which in Ruby 1.8 returns `[nil]` for `nil`, and calls to `Array(object)` otherwise. (Please if you know the exact behavior in 1.9 contact fxn.)
2447
-
2448
- Thus, in this case the behavior is different for `nil`, and the differences with `Kernel#Array` explained above apply to the rest of `object`s.
2449
-
2450
- NOTE: Defined in `active_support/core_ext/array/wrap.rb`.
2451
-
2452
- ### Duplicating
2453
-
2454
- The method `Array.deep_dup` duplicates itself and all objects inside
2455
- recursively with Active Support method `Object#deep_dup`. It works like `Array#map` with sending `deep_dup` method to each object inside.
2456
-
2457
- ```ruby
2458
- array = [1, [2, 3]]
2459
- dup = array.deep_dup
2460
- dup[1][2] = 4
2461
- array[1][2] == nil # => true
2462
- ```
2463
-
2464
- NOTE: Defined in `active_support/core_ext/object/deep_dup.rb`.
2465
-
2466
- ### Grouping
2467
-
2468
- #### `in_groups_of(number, fill_with = nil)`
2469
-
2470
- The method `in_groups_of` splits an array into consecutive groups of a certain size. It returns an array with the groups:
2471
-
2472
- ```ruby
2473
- [1, 2, 3].in_groups_of(2) # => [[1, 2], [3, nil]]
2474
- ```
2475
-
2476
- or yields them in turn if a block is passed:
2477
-
2478
- ```html+erb
2479
- <% sample.in_groups_of(3) do |a, b, c| %>
2480
- <tr>
2481
- <td><%= a %></td>
2482
- <td><%= b %></td>
2483
- <td><%= c %></td>
2484
- </tr>
2485
- <% end %>
2486
- ```
2487
-
2488
- The first example shows `in_groups_of` fills the last group with as many `nil` elements as needed to have the requested size. You can change this padding value using the second optional argument:
2489
-
2490
- ```ruby
2491
- [1, 2, 3].in_groups_of(2, 0) # => [[1, 2], [3, 0]]
2492
- ```
2493
-
2494
- And you can tell the method not to fill the last group passing `false`:
2495
-
2496
- ```ruby
2497
- [1, 2, 3].in_groups_of(2, false) # => [[1, 2], [3]]
2498
- ```
2499
-
2500
- As a consequence `false` can't be a used as a padding value.
2501
-
2502
- NOTE: Defined in `active_support/core_ext/array/grouping.rb`.
2503
-
2504
- #### `in_groups(number, fill_with = nil)`
2505
-
2506
- The method `in_groups` splits an array into a certain number of groups. The method returns an array with the groups:
2507
-
2508
- ```ruby
2509
- %w(1 2 3 4 5 6 7).in_groups(3)
2510
- # => [["1", "2", "3"], ["4", "5", nil], ["6", "7", nil]]
2511
- ```
2512
-
2513
- or yields them in turn if a block is passed:
2514
-
2515
- ```ruby
2516
- %w(1 2 3 4 5 6 7).in_groups(3) {|group| p group}
2517
- ["1", "2", "3"]
2518
- ["4", "5", nil]
2519
- ["6", "7", nil]
2520
- ```
2521
-
2522
- The examples above show that `in_groups` fills some groups with a trailing `nil` element as needed. A group can get at most one of these extra elements, the rightmost one if any. And the groups that have them are always the last ones.
2523
-
2524
- You can change this padding value using the second optional argument:
2525
-
2526
- ```ruby
2527
- %w(1 2 3 4 5 6 7).in_groups(3, "0")
2528
- # => [["1", "2", "3"], ["4", "5", "0"], ["6", "7", "0"]]
2529
- ```
2530
-
2531
- And you can tell the method not to fill the smaller groups passing `false`:
2532
-
2533
- ```ruby
2534
- %w(1 2 3 4 5 6 7).in_groups(3, false)
2535
- # => [["1", "2", "3"], ["4", "5"], ["6", "7"]]
2536
- ```
2537
-
2538
- As a consequence `false` can't be a used as a padding value.
2539
-
2540
- NOTE: Defined in `active_support/core_ext/array/grouping.rb`.
2541
-
2542
- #### `split(value = nil)`
2543
-
2544
- The method `split` divides an array by a separator and returns the resulting chunks.
2545
-
2546
- If a block is passed the separators are those elements of the array for which the block returns true:
2547
-
2548
- ```ruby
2549
- (-5..5).to_a.split { |i| i.multiple_of?(4) }
2550
- # => [[-5], [-3, -2, -1], [1, 2, 3], [5]]
2551
- ```
2552
-
2553
- Otherwise, the value received as argument, which defaults to `nil`, is the separator:
2554
-
2555
- ```ruby
2556
- [0, 1, -5, 1, 1, "foo", "bar"].split(1)
2557
- # => [[0], [-5], [], ["foo", "bar"]]
2558
- ```
2559
-
2560
- TIP: Observe in the previous example that consecutive separators result in empty arrays.
2561
-
2562
- NOTE: Defined in `active_support/core_ext/array/grouping.rb`.
2563
-
2564
- Extensions to `Hash`
2565
- --------------------
2566
-
2567
- ### Conversions
2568
-
2569
- #### `to_xml`
2570
-
2571
- The method `to_xml` returns a string containing an XML representation of its receiver:
2572
-
2573
- ```ruby
2574
- {"foo" => 1, "bar" => 2}.to_xml
2575
- # =>
2576
- # <?xml version="1.0" encoding="UTF-8"?>
2577
- # <hash>
2578
- # <foo type="integer">1</foo>
2579
- # <bar type="integer">2</bar>
2580
- # </hash>
2581
- ```
2582
-
2583
- To do so, the method loops over the pairs and builds nodes that depend on the _values_. Given a pair `key`, `value`:
2584
-
2585
- * If `value` is a hash there's a recursive call with `key` as `:root`.
2586
-
2587
- * If `value` is an array there's a recursive call with `key` as `:root`, and `key` singularized as `:children`.
2588
-
2589
- * If `value` is a callable object it must expect one or two arguments. Depending on the arity, the callable is invoked with the `options` hash as first argument with `key` as `:root`, and `key` singularized as second argument. Its return value becomes a new node.
2590
-
2591
- * If `value` responds to `to_xml` the method is invoked with `key` as `:root`.
2592
-
2593
- * Otherwise, a node with `key` as tag is created with a string representation of `value` as text node. If `value` is `nil` an attribute "nil" set to "true" is added. Unless the option `:skip_types` exists and is true, an attribute "type" is added as well according to the following mapping:
2594
-
2595
- ```ruby
2596
- XML_TYPE_NAMES = {
2597
- "Symbol" => "symbol",
2598
- "Fixnum" => "integer",
2599
- "Bignum" => "integer",
2600
- "BigDecimal" => "decimal",
2601
- "Float" => "float",
2602
- "TrueClass" => "boolean",
2603
- "FalseClass" => "boolean",
2604
- "Date" => "date",
2605
- "DateTime" => "datetime",
2606
- "Time" => "datetime"
2607
- }
2608
- ```
2609
-
2610
- By default the root node is "hash", but that's configurable via the `:root` option.
2611
-
2612
- The default XML builder is a fresh instance of `Builder::XmlMarkup`. You can configure your own builder with the `:builder` option. The method also accepts options like `:dasherize` and friends, they are forwarded to the builder.
2613
-
2614
- NOTE: Defined in `active_support/core_ext/hash/conversions.rb`.
2615
-
2616
- ### Merging
2617
-
2618
- Ruby has a built-in method `Hash#merge` that merges two hashes:
2619
-
2620
- ```ruby
2621
- {a: 1, b: 1}.merge(a: 0, c: 2)
2622
- # => {:a=>0, :b=>1, :c=>2}
2623
- ```
2624
-
2625
- Active Support defines a few more ways of merging hashes that may be convenient.
2626
-
2627
- #### `reverse_merge` and `reverse_merge!`
2628
-
2629
- In case of collision the key in the hash of the argument wins in `merge`. You can support option hashes with default values in a compact way with this idiom:
2630
-
2631
- ```ruby
2632
- options = {length: 30, omission: "..."}.merge(options)
2633
- ```
2634
-
2635
- Active Support defines `reverse_merge` in case you prefer this alternative notation:
2636
-
2637
- ```ruby
2638
- options = options.reverse_merge(length: 30, omission: "...")
2639
- ```
2640
-
2641
- And a bang version `reverse_merge!` that performs the merge in place:
2642
-
2643
- ```ruby
2644
- options.reverse_merge!(length: 30, omission: "...")
2645
- ```
2646
-
2647
- WARNING. Take into account that `reverse_merge!` may change the hash in the caller, which may or may not be a good idea.
2648
-
2649
- NOTE: Defined in `active_support/core_ext/hash/reverse_merge.rb`.
2650
-
2651
- #### `reverse_update`
2652
-
2653
- The method `reverse_update` is an alias for `reverse_merge!`, explained above.
2654
-
2655
- WARNING. Note that `reverse_update` has no bang.
2656
-
2657
- NOTE: Defined in `active_support/core_ext/hash/reverse_merge.rb`.
2658
-
2659
- #### `deep_merge` and `deep_merge!`
2660
-
2661
- As you can see in the previous example if a key is found in both hashes the value in the one in the argument wins.
2662
-
2663
- Active Support defines `Hash#deep_merge`. In a deep merge, if a key is found in both hashes and their values are hashes in turn, then their _merge_ becomes the value in the resulting hash:
2664
-
2665
- ```ruby
2666
- {a: {b: 1}}.deep_merge(a: {c: 2})
2667
- # => {:a=>{:b=>1, :c=>2}}
2668
- ```
2669
-
2670
- The method `deep_merge!` performs a deep merge in place.
2671
-
2672
- NOTE: Defined in `active_support/core_ext/hash/deep_merge.rb`.
2673
-
2674
- ### Deep duplicating
2675
-
2676
- The method `Hash.deep_dup` duplicates itself and all keys and values
2677
- inside recursively with Active Support method `Object#deep_dup`. It works like `Enumerator#each_with_object` with sending `deep_dup` method to each pair inside.
2678
-
2679
- ```ruby
2680
- hash = { a: 1, b: { c: 2, d: [3, 4] } }
2681
-
2682
- dup = hash.deep_dup
2683
- dup[:b][:e] = 5
2684
- dup[:b][:d] << 5
2685
-
2686
- hash[:b][:e] == nil # => true
2687
- hash[:b][:d] == [3, 4] # => true
2688
- ```
2689
-
2690
- NOTE: Defined in `active_support/core_ext/object/deep_dup.rb`.
2691
-
2692
- ### Working with Keys
2693
-
2694
- #### `except` and `except!`
2695
-
2696
- The method `except` returns a hash with the keys in the argument list removed, if present:
2697
-
2698
- ```ruby
2699
- {a: 1, b: 2}.except(:a) # => {:b=>2}
2700
- ```
2701
-
2702
- If the receiver responds to `convert_key`, the method is called on each of the arguments. This allows `except` to play nice with hashes with indifferent access for instance:
2703
-
2704
- ```ruby
2705
- {a: 1}.with_indifferent_access.except(:a) # => {}
2706
- {a: 1}.with_indifferent_access.except("a") # => {}
2707
- ```
2708
-
2709
- There's also the bang variant `except!` that removes keys in the very receiver.
2710
-
2711
- NOTE: Defined in `active_support/core_ext/hash/except.rb`.
2712
-
2713
- #### `transform_keys` and `transform_keys!`
2714
-
2715
- The method `transform_keys` accepts a block and returns a hash that has applied the block operations to each of the keys in the receiver:
2716
-
2717
- ```ruby
2718
- {nil => nil, 1 => 1, a: :a}.transform_keys { |key| key.to_s.upcase }
2719
- # => {"" => nil, "A" => :a, "1" => 1}
2720
- ```
2721
-
2722
- The result in case of collision is undefined:
2723
-
2724
- ```ruby
2725
- {"a" => 1, a: 2}.transform_keys { |key| key.to_s.upcase }
2726
- # => {"A" => 2}, in my test, can't rely on this result though
2727
- ```
2728
-
2729
- This method may be useful for example to build specialized conversions. For instance `stringify_keys` and `symbolize_keys` use `transform_keys` to perform their key conversions:
2730
-
2731
- ```ruby
2732
- def stringify_keys
2733
- transform_keys { |key| key.to_s }
2734
- end
2735
- ...
2736
- def symbolize_keys
2737
- transform_keys { |key| key.to_sym rescue key }
2738
- end
2739
- ```
2740
-
2741
- There's also the bang variant `transform_keys!` that applies the block operations to keys in the very receiver.
2742
-
2743
- Besides that, one can use `deep_transform_keys` and `deep_transform_keys!` to perform the block operation on all the keys in the given hash and all the hashes nested into it. An example of the result is:
2744
-
2745
- ```ruby
2746
- {nil => nil, 1 => 1, nested: {a: 3, 5 => 5}}.deep_transform_keys { |key| key.to_s.upcase }
2747
- # => {""=>nil, "1"=>1, "NESTED"=>{"A"=>3, "5"=>5}}
2748
- ```
2749
-
2750
- NOTE: Defined in `active_support/core_ext/hash/keys.rb`.
2751
-
2752
- #### `stringify_keys` and `stringify_keys!`
2753
-
2754
- The method `stringify_keys` returns a hash that has a stringified version of the keys in the receiver. It does so by sending `to_s` to them:
2755
-
2756
- ```ruby
2757
- {nil => nil, 1 => 1, a: :a}.stringify_keys
2758
- # => {"" => nil, "a" => :a, "1" => 1}
2759
- ```
2760
-
2761
- The result in case of collision is undefined:
2762
-
2763
- ```ruby
2764
- {"a" => 1, a: 2}.stringify_keys
2765
- # => {"a" => 2}, in my test, can't rely on this result though
2766
- ```
2767
-
2768
- This method may be useful for example to easily accept both symbols and strings as options. For instance `ActionView::Helpers::FormHelper` defines:
2769
-
2770
- ```ruby
2771
- def to_check_box_tag(options = {}, checked_value = "1", unchecked_value = "0")
2772
- options = options.stringify_keys
2773
- options["type"] = "checkbox"
2774
- ...
2775
- end
2776
- ```
2777
-
2778
- The second line can safely access the "type" key, and let the user to pass either `:type` or "type".
2779
-
2780
- There's also the bang variant `stringify_keys!` that stringifies keys in the very receiver.
2781
-
2782
- Besides that, one can use `deep_stringify_keys` and `deep_stringify_keys!` to stringify all the keys in the given hash and all the hashes nested into it. An example of the result is:
2783
-
2784
- ```ruby
2785
- {nil => nil, 1 => 1, nested: {a: 3, 5 => 5}}.deep_stringify_keys
2786
- # => {""=>nil, "1"=>1, "nested"=>{"a"=>3, "5"=>5}}
2787
- ```
2788
-
2789
- NOTE: Defined in `active_support/core_ext/hash/keys.rb`.
2790
-
2791
- #### `symbolize_keys` and `symbolize_keys!`
2792
-
2793
- The method `symbolize_keys` returns a hash that has a symbolized version of the keys in the receiver, where possible. It does so by sending `to_sym` to them:
2794
-
2795
- ```ruby
2796
- {nil => nil, 1 => 1, "a" => "a"}.symbolize_keys
2797
- # => {1=>1, nil=>nil, :a=>"a"}
2798
- ```
2799
-
2800
- WARNING. Note in the previous example only one key was symbolized.
2801
-
2802
- The result in case of collision is undefined:
2803
-
2804
- ```ruby
2805
- {"a" => 1, a: 2}.symbolize_keys
2806
- # => {:a=>2}, in my test, can't rely on this result though
2807
- ```
2808
-
2809
- This method may be useful for example to easily accept both symbols and strings as options. For instance `ActionController::UrlRewriter` defines
2810
-
2811
- ```ruby
2812
- def rewrite_path(options)
2813
- options = options.symbolize_keys
2814
- options.update(options[:params].symbolize_keys) if options[:params]
2815
- ...
2816
- end
2817
- ```
2818
-
2819
- The second line can safely access the `:params` key, and let the user to pass either `:params` or "params".
2820
-
2821
- There's also the bang variant `symbolize_keys!` that symbolizes keys in the very receiver.
2822
-
2823
- Besides that, one can use `deep_symbolize_keys` and `deep_symbolize_keys!` to symbolize all the keys in the given hash and all the hashes nested into it. An example of the result is:
2824
-
2825
- ```ruby
2826
- {nil => nil, 1 => 1, "nested" => {"a" => 3, 5 => 5}}.deep_symbolize_keys
2827
- # => {nil=>nil, 1=>1, nested:{a:3, 5=>5}}
2828
- ```
2829
-
2830
- NOTE: Defined in `active_support/core_ext/hash/keys.rb`.
2831
-
2832
- #### `to_options` and `to_options!`
2833
-
2834
- The methods `to_options` and `to_options!` are respectively aliases of `symbolize_keys` and `symbolize_keys!`.
2835
-
2836
- NOTE: Defined in `active_support/core_ext/hash/keys.rb`.
2837
-
2838
- #### `assert_valid_keys`
2839
-
2840
- The method `assert_valid_keys` receives an arbitrary number of arguments, and checks whether the receiver has any key outside that white list. If it does `ArgumentError` is raised.
2841
-
2842
- ```ruby
2843
- {a: 1}.assert_valid_keys(:a) # passes
2844
- {a: 1}.assert_valid_keys("a") # ArgumentError
2845
- ```
2846
-
2847
- Active Record does not accept unknown options when building associations, for example. It implements that control via `assert_valid_keys`.
2848
-
2849
- NOTE: Defined in `active_support/core_ext/hash/keys.rb`.
2850
-
2851
- ### Slicing
2852
-
2853
- Ruby has built-in support for taking slices out of strings and arrays. Active Support extends slicing to hashes:
2854
-
2855
- ```ruby
2856
- {a: 1, b: 2, c: 3}.slice(:a, :c)
2857
- # => {:c=>3, :a=>1}
2858
-
2859
- {a: 1, b: 2, c: 3}.slice(:b, :X)
2860
- # => {:b=>2} # non-existing keys are ignored
2861
- ```
2862
-
2863
- If the receiver responds to `convert_key` keys are normalized:
2864
-
2865
- ```ruby
2866
- {a: 1, b: 2}.with_indifferent_access.slice("a")
2867
- # => {:a=>1}
2868
- ```
2869
-
2870
- NOTE. Slicing may come in handy for sanitizing option hashes with a white list of keys.
2871
-
2872
- There's also `slice!` which in addition to perform a slice in place returns what's removed:
2873
-
2874
- ```ruby
2875
- hash = {a: 1, b: 2}
2876
- rest = hash.slice!(:a) # => {:b=>2}
2877
- hash # => {:a=>1}
2878
- ```
2879
-
2880
- NOTE: Defined in `active_support/core_ext/hash/slice.rb`.
2881
-
2882
- ### Extracting
2883
-
2884
- The method `extract!` removes and returns the key/value pairs matching the given keys.
2885
-
2886
- ```ruby
2887
- hash = {a: 1, b: 2}
2888
- rest = hash.extract!(:a) # => {:a=>1}
2889
- hash # => {:b=>2}
2890
- ```
2891
-
2892
- The method `extract!` returns the same subclass of Hash, that the receiver is.
2893
-
2894
- ```ruby
2895
- hash = {a: 1, b: 2}.with_indifferent_access
2896
- rest = hash.extract!(:a).class
2897
- # => ActiveSupport::HashWithIndifferentAccess
2898
- ```
2899
-
2900
- NOTE: Defined in `active_support/core_ext/hash/slice.rb`.
2901
-
2902
- ### Indifferent Access
2903
-
2904
- The method `with_indifferent_access` returns an `ActiveSupport::HashWithIndifferentAccess` out of its receiver:
2905
-
2906
- ```ruby
2907
- {a: 1}.with_indifferent_access["a"] # => 1
2908
- ```
2909
-
2910
- NOTE: Defined in `active_support/core_ext/hash/indifferent_access.rb`.
2911
-
2912
- ### Compacting
2913
-
2914
- The methods `compact` and `compact!` return a Hash without items with `nil` value.
2915
-
2916
- ```ruby
2917
- {a: 1, b: 2, c: nil}.compact # => {a: 1, b: 2}
2918
- ```
2919
-
2920
- NOTE: Defined in `active_support/core_ext/hash/compact.rb`.
2921
-
2922
- Extensions to `Regexp`
2923
- ----------------------
2924
-
2925
- ### `multiline?`
2926
-
2927
- The method `multiline?` says whether a regexp has the `/m` flag set, that is, whether the dot matches newlines.
2928
-
2929
- ```ruby
2930
- %r{.}.multiline? # => false
2931
- %r{.}m.multiline? # => true
2932
-
2933
- Regexp.new('.').multiline? # => false
2934
- Regexp.new('.', Regexp::MULTILINE).multiline? # => true
2935
- ```
2936
-
2937
- Rails uses this method in a single place, also in the routing code. Multiline regexps are disallowed for route requirements and this flag eases enforcing that constraint.
2938
-
2939
- ```ruby
2940
- def assign_route_options(segments, defaults, requirements)
2941
- ...
2942
- if requirement.multiline?
2943
- raise ArgumentError, "Regexp multiline option not allowed in routing requirements: #{requirement.inspect}"
2944
- end
2945
- ...
2946
- end
2947
- ```
2948
-
2949
- NOTE: Defined in `active_support/core_ext/regexp.rb`.
2950
-
2951
- Extensions to `Range`
2952
- ---------------------
2953
-
2954
- ### `to_s`
2955
-
2956
- Active Support extends the method `Range#to_s` so that it understands an optional format argument. As of this writing the only supported non-default format is `:db`:
2957
-
2958
- ```ruby
2959
- (Date.today..Date.tomorrow).to_s
2960
- # => "2009-10-25..2009-10-26"
2961
-
2962
- (Date.today..Date.tomorrow).to_s(:db)
2963
- # => "BETWEEN '2009-10-25' AND '2009-10-26'"
2964
- ```
2965
-
2966
- As the example depicts, the `:db` format generates a `BETWEEN` SQL clause. That is used by Active Record in its support for range values in conditions.
2967
-
2968
- NOTE: Defined in `active_support/core_ext/range/conversions.rb`.
2969
-
2970
- ### `include?`
2971
-
2972
- The methods `Range#include?` and `Range#===` say whether some value falls between the ends of a given instance:
2973
-
2974
- ```ruby
2975
- (2..3).include?(Math::E) # => true
2976
- ```
2977
-
2978
- Active Support extends these methods so that the argument may be another range in turn. In that case we test whether the ends of the argument range belong to the receiver themselves:
2979
-
2980
- ```ruby
2981
- (1..10).include?(3..7) # => true
2982
- (1..10).include?(0..7) # => false
2983
- (1..10).include?(3..11) # => false
2984
- (1...9).include?(3..9) # => false
2985
-
2986
- (1..10) === (3..7) # => true
2987
- (1..10) === (0..7) # => false
2988
- (1..10) === (3..11) # => false
2989
- (1...9) === (3..9) # => false
2990
- ```
2991
-
2992
- NOTE: Defined in `active_support/core_ext/range/include_range.rb`.
2993
-
2994
- ### `overlaps?`
2995
-
2996
- The method `Range#overlaps?` says whether any two given ranges have non-void intersection:
2997
-
2998
- ```ruby
2999
- (1..10).overlaps?(7..11) # => true
3000
- (1..10).overlaps?(0..7) # => true
3001
- (1..10).overlaps?(11..27) # => false
3002
- ```
3003
-
3004
- NOTE: Defined in `active_support/core_ext/range/overlaps.rb`.
3005
-
3006
- Extensions to `Proc`
3007
- --------------------
3008
-
3009
- ### `bind`
3010
-
3011
- As you surely know Ruby has an `UnboundMethod` class whose instances are methods that belong to the limbo of methods without a self. The method `Module#instance_method` returns an unbound method for example:
3012
-
3013
- ```ruby
3014
- Hash.instance_method(:delete) # => #<UnboundMethod: Hash#delete>
3015
- ```
3016
-
3017
- An unbound method is not callable as is, you need to bind it first to an object with `bind`:
3018
-
3019
- ```ruby
3020
- clear = Hash.instance_method(:clear)
3021
- clear.bind({a: 1}).call # => {}
3022
- ```
3023
-
3024
- Active Support defines `Proc#bind` with an analogous purpose:
3025
-
3026
- ```ruby
3027
- Proc.new { size }.bind([]).call # => 0
3028
- ```
3029
-
3030
- As you see that's callable and bound to the argument, the return value is indeed a `Method`.
3031
-
3032
- NOTE: To do so `Proc#bind` actually creates a method under the hood. If you ever see a method with a weird name like `__bind_1256598120_237302` in a stack trace you know now where it comes from.
3033
-
3034
- Action Pack uses this trick in `rescue_from` for example, which accepts the name of a method and also a proc as callbacks for a given rescued exception. It has to call them in either case, so a bound method is returned by `handler_for_rescue`, thus simplifying the code in the caller:
3035
-
3036
- ```ruby
3037
- def handler_for_rescue(exception)
3038
- _, rescuer = Array(rescue_handlers).reverse.detect do |klass_name, handler|
3039
- ...
3040
- end
3041
-
3042
- case rescuer
3043
- when Symbol
3044
- method(rescuer)
3045
- when Proc
3046
- rescuer.bind(self)
3047
- end
3048
- end
3049
- ```
3050
-
3051
- NOTE: Defined in `active_support/core_ext/proc.rb`.
3052
-
3053
- Extensions to `Date`
3054
- --------------------
3055
-
3056
- ### Calculations
3057
-
3058
- NOTE: All the following methods are defined in `active_support/core_ext/date/calculations.rb`.
3059
-
3060
- INFO: The following calculation methods have edge cases in October 1582, since days 5..14 just do not exist. This guide does not document their behavior around those days for brevity, but it is enough to say that they do what you would expect. That is, `Date.new(1582, 10, 4).tomorrow` returns `Date.new(1582, 10, 15)` and so on. Please check `test/core_ext/date_ext_test.rb` in the Active Support test suite for expected behavior.
3061
-
3062
- #### `Date.current`
3063
-
3064
- Active Support defines `Date.current` to be today in the current time zone. That's like `Date.today`, except that it honors the user time zone, if defined. It also defines `Date.yesterday` and `Date.tomorrow`, and the instance predicates `past?`, `today?`, and `future?`, all of them relative to `Date.current`.
3065
-
3066
- When making Date comparisons using methods which honor the user time zone, make sure to use `Date.current` and not `Date.today`. There are cases where the user time zone might be in the future compared to the system time zone, which `Date.today` uses by default. This means `Date.today` may equal `Date.yesterday`.
3067
-
3068
- #### Named dates
3069
-
3070
- ##### `prev_year`, `next_year`
3071
-
3072
- In Ruby 1.9 `prev_year` and `next_year` return a date with the same day/month in the last or next year:
3073
-
3074
- ```ruby
3075
- d = Date.new(2010, 5, 8) # => Sat, 08 May 2010
3076
- d.prev_year # => Fri, 08 May 2009
3077
- d.next_year # => Sun, 08 May 2011
3078
- ```
3079
-
3080
- If date is the 29th of February of a leap year, you obtain the 28th:
3081
-
3082
- ```ruby
3083
- d = Date.new(2000, 2, 29) # => Tue, 29 Feb 2000
3084
- d.prev_year # => Sun, 28 Feb 1999
3085
- d.next_year # => Wed, 28 Feb 2001
3086
- ```
3087
-
3088
- `prev_year` is aliased to `last_year`.
3089
-
3090
- ##### `prev_month`, `next_month`
3091
-
3092
- In Ruby 1.9 `prev_month` and `next_month` return the date with the same day in the last or next month:
3093
-
3094
- ```ruby
3095
- d = Date.new(2010, 5, 8) # => Sat, 08 May 2010
3096
- d.prev_month # => Thu, 08 Apr 2010
3097
- d.next_month # => Tue, 08 Jun 2010
3098
- ```
3099
-
3100
- If such a day does not exist, the last day of the corresponding month is returned:
3101
-
3102
- ```ruby
3103
- Date.new(2000, 5, 31).prev_month # => Sun, 30 Apr 2000
3104
- Date.new(2000, 3, 31).prev_month # => Tue, 29 Feb 2000
3105
- Date.new(2000, 5, 31).next_month # => Fri, 30 Jun 2000
3106
- Date.new(2000, 1, 31).next_month # => Tue, 29 Feb 2000
3107
- ```
3108
-
3109
- `prev_month` is aliased to `last_month`.
3110
-
3111
- ##### `prev_quarter`, `next_quarter`
3112
-
3113
- Same as `prev_month` and `next_month`. It returns the date with the same day in the previous or next quarter:
3114
-
3115
- ```ruby
3116
- t = Time.local(2010, 5, 8) # => Sat, 08 May 2010
3117
- t.prev_quarter # => Mon, 08 Feb 2010
3118
- t.next_quarter # => Sun, 08 Aug 2010
3119
- ```
3120
-
3121
- If such a day does not exist, the last day of the corresponding month is returned:
3122
-
3123
- ```ruby
3124
- Time.local(2000, 7, 31).prev_quarter # => Sun, 30 Apr 2000
3125
- Time.local(2000, 5, 31).prev_quarter # => Tue, 29 Feb 2000
3126
- Time.local(2000, 10, 31).prev_quarter # => Mon, 30 Oct 2000
3127
- Time.local(2000, 11, 31).next_quarter # => Wed, 28 Feb 2001
3128
- ```
3129
-
3130
- `prev_quarter` is aliased to `last_quarter`.
3131
-
3132
- ##### `beginning_of_week`, `end_of_week`
3133
-
3134
- The methods `beginning_of_week` and `end_of_week` return the dates for the
3135
- beginning and end of the week, respectively. Weeks are assumed to start on
3136
- Monday, but that can be changed passing an argument, setting thread local
3137
- `Date.beginning_of_week` or `config.beginning_of_week`.
3138
-
3139
- ```ruby
3140
- d = Date.new(2010, 5, 8) # => Sat, 08 May 2010
3141
- d.beginning_of_week # => Mon, 03 May 2010
3142
- d.beginning_of_week(:sunday) # => Sun, 02 May 2010
3143
- d.end_of_week # => Sun, 09 May 2010
3144
- d.end_of_week(:sunday) # => Sat, 08 May 2010
3145
- ```
3146
-
3147
- `beginning_of_week` is aliased to `at_beginning_of_week` and `end_of_week` is aliased to `at_end_of_week`.
3148
-
3149
- ##### `monday`, `sunday`
3150
-
3151
- The methods `monday` and `sunday` return the dates for the previous Monday and
3152
- next Sunday, respectively.
3153
-
3154
- ```ruby
3155
- d = Date.new(2010, 5, 8) # => Sat, 08 May 2010
3156
- d.monday # => Mon, 03 May 2010
3157
- d.sunday # => Sun, 09 May 2010
3158
-
3159
- d = Date.new(2012, 9, 10) # => Mon, 10 Sep 2012
3160
- d.monday # => Mon, 10 Sep 2012
3161
-
3162
- d = Date.new(2012, 9, 16) # => Sun, 16 Sep 2012
3163
- d.sunday # => Sun, 16 Sep 2012
3164
- ```
3165
-
3166
- ##### `prev_week`, `next_week`
3167
-
3168
- The method `next_week` receives a symbol with a day name in English (default is the thread local `Date.beginning_of_week`, or `config.beginning_of_week`, or `:monday`) and it returns the date corresponding to that day.
3169
-
3170
- ```ruby
3171
- d = Date.new(2010, 5, 9) # => Sun, 09 May 2010
3172
- d.next_week # => Mon, 10 May 2010
3173
- d.next_week(:saturday) # => Sat, 15 May 2010
3174
- ```
3175
-
3176
- The method `prev_week` is analogous:
3177
-
3178
- ```ruby
3179
- d.prev_week # => Mon, 26 Apr 2010
3180
- d.prev_week(:saturday) # => Sat, 01 May 2010
3181
- d.prev_week(:friday) # => Fri, 30 Apr 2010
3182
- ```
3183
-
3184
- `prev_week` is aliased to `last_week`.
3185
-
3186
- Both `next_week` and `prev_week` work as expected when `Date.beginning_of_week` or `config.beginning_of_week` are set.
3187
-
3188
- ##### `beginning_of_month`, `end_of_month`
3189
-
3190
- The methods `beginning_of_month` and `end_of_month` return the dates for the beginning and end of the month:
3191
-
3192
- ```ruby
3193
- d = Date.new(2010, 5, 9) # => Sun, 09 May 2010
3194
- d.beginning_of_month # => Sat, 01 May 2010
3195
- d.end_of_month # => Mon, 31 May 2010
3196
- ```
3197
-
3198
- `beginning_of_month` is aliased to `at_beginning_of_month`, and `end_of_month` is aliased to `at_end_of_month`.
3199
-
3200
- ##### `beginning_of_quarter`, `end_of_quarter`
3201
-
3202
- The methods `beginning_of_quarter` and `end_of_quarter` return the dates for the beginning and end of the quarter of the receiver's calendar year:
3203
-
3204
- ```ruby
3205
- d = Date.new(2010, 5, 9) # => Sun, 09 May 2010
3206
- d.beginning_of_quarter # => Thu, 01 Apr 2010
3207
- d.end_of_quarter # => Wed, 30 Jun 2010
3208
- ```
3209
-
3210
- `beginning_of_quarter` is aliased to `at_beginning_of_quarter`, and `end_of_quarter` is aliased to `at_end_of_quarter`.
3211
-
3212
- ##### `beginning_of_year`, `end_of_year`
3213
-
3214
- The methods `beginning_of_year` and `end_of_year` return the dates for the beginning and end of the year:
3215
-
3216
- ```ruby
3217
- d = Date.new(2010, 5, 9) # => Sun, 09 May 2010
3218
- d.beginning_of_year # => Fri, 01 Jan 2010
3219
- d.end_of_year # => Fri, 31 Dec 2010
3220
- ```
3221
-
3222
- `beginning_of_year` is aliased to `at_beginning_of_year`, and `end_of_year` is aliased to `at_end_of_year`.
3223
-
3224
- #### Other Date Computations
3225
-
3226
- ##### `years_ago`, `years_since`
3227
-
3228
- The method `years_ago` receives a number of years and returns the same date those many years ago:
3229
-
3230
- ```ruby
3231
- date = Date.new(2010, 6, 7)
3232
- date.years_ago(10) # => Wed, 07 Jun 2000
3233
- ```
3234
-
3235
- `years_since` moves forward in time:
3236
-
3237
- ```ruby
3238
- date = Date.new(2010, 6, 7)
3239
- date.years_since(10) # => Sun, 07 Jun 2020
3240
- ```
3241
-
3242
- If such a day does not exist, the last day of the corresponding month is returned:
3243
-
3244
- ```ruby
3245
- Date.new(2012, 2, 29).years_ago(3) # => Sat, 28 Feb 2009
3246
- Date.new(2012, 2, 29).years_since(3) # => Sat, 28 Feb 2015
3247
- ```
3248
-
3249
- ##### `months_ago`, `months_since`
3250
-
3251
- The methods `months_ago` and `months_since` work analogously for months:
3252
-
3253
- ```ruby
3254
- Date.new(2010, 4, 30).months_ago(2) # => Sun, 28 Feb 2010
3255
- Date.new(2010, 4, 30).months_since(2) # => Wed, 30 Jun 2010
3256
- ```
3257
-
3258
- If such a day does not exist, the last day of the corresponding month is returned:
3259
-
3260
- ```ruby
3261
- Date.new(2010, 4, 30).months_ago(2) # => Sun, 28 Feb 2010
3262
- Date.new(2009, 12, 31).months_since(2) # => Sun, 28 Feb 2010
3263
- ```
3264
-
3265
- ##### `weeks_ago`
3266
-
3267
- The method `weeks_ago` works analogously for weeks:
3268
-
3269
- ```ruby
3270
- Date.new(2010, 5, 24).weeks_ago(1) # => Mon, 17 May 2010
3271
- Date.new(2010, 5, 24).weeks_ago(2) # => Mon, 10 May 2010
3272
- ```
3273
-
3274
- ##### `advance`
3275
-
3276
- The most generic way to jump to other days is `advance`. This method receives a hash with keys `:years`, `:months`, `:weeks`, `:days`, and returns a date advanced as much as the present keys indicate:
3277
-
3278
- ```ruby
3279
- date = Date.new(2010, 6, 6)
3280
- date.advance(years: 1, weeks: 2) # => Mon, 20 Jun 2011
3281
- date.advance(months: 2, days: -2) # => Wed, 04 Aug 2010
3282
- ```
3283
-
3284
- Note in the previous example that increments may be negative.
3285
-
3286
- To perform the computation the method first increments years, then months, then weeks, and finally days. This order is important towards the end of months. Say for example we are at the end of February of 2010, and we want to move one month and one day forward.
3287
-
3288
- The method `advance` advances first one month, and then one day, the result is:
3289
-
3290
- ```ruby
3291
- Date.new(2010, 2, 28).advance(months: 1, days: 1)
3292
- # => Sun, 29 Mar 2010
3293
- ```
3294
-
3295
- While if it did it the other way around the result would be different:
3296
-
3297
- ```ruby
3298
- Date.new(2010, 2, 28).advance(days: 1).advance(months: 1)
3299
- # => Thu, 01 Apr 2010
3300
- ```
3301
-
3302
- #### Changing Components
3303
-
3304
- The method `change` allows you to get a new date which is the same as the receiver except for the given year, month, or day:
3305
-
3306
- ```ruby
3307
- Date.new(2010, 12, 23).change(year: 2011, month: 11)
3308
- # => Wed, 23 Nov 2011
3309
- ```
3310
-
3311
- This method is not tolerant to non-existing dates, if the change is invalid `ArgumentError` is raised:
3312
-
3313
- ```ruby
3314
- Date.new(2010, 1, 31).change(month: 2)
3315
- # => ArgumentError: invalid date
3316
- ```
3317
-
3318
- #### Durations
3319
-
3320
- Durations can be added to and subtracted from dates:
3321
-
3322
- ```ruby
3323
- d = Date.current
3324
- # => Mon, 09 Aug 2010
3325
- d + 1.year
3326
- # => Tue, 09 Aug 2011
3327
- d - 3.hours
3328
- # => Sun, 08 Aug 2010 21:00:00 UTC +00:00
3329
- ```
3330
-
3331
- They translate to calls to `since` or `advance`. For example here we get the correct jump in the calendar reform:
3332
-
3333
- ```ruby
3334
- Date.new(1582, 10, 4) + 1.day
3335
- # => Fri, 15 Oct 1582
3336
- ```
3337
-
3338
- #### Timestamps
3339
-
3340
- INFO: The following methods return a `Time` object if possible, otherwise a `DateTime`. If set, they honor the user time zone.
3341
-
3342
- ##### `beginning_of_day`, `end_of_day`
3343
-
3344
- The method `beginning_of_day` returns a timestamp at the beginning of the day (00:00:00):
3345
-
3346
- ```ruby
3347
- date = Date.new(2010, 6, 7)
3348
- date.beginning_of_day # => Mon Jun 07 00:00:00 +0200 2010
3349
- ```
3350
-
3351
- The method `end_of_day` returns a timestamp at the end of the day (23:59:59):
3352
-
3353
- ```ruby
3354
- date = Date.new(2010, 6, 7)
3355
- date.end_of_day # => Mon Jun 07 23:59:59 +0200 2010
3356
- ```
3357
-
3358
- `beginning_of_day` is aliased to `at_beginning_of_day`, `midnight`, `at_midnight`.
3359
-
3360
- ##### `beginning_of_hour`, `end_of_hour`
3361
-
3362
- The method `beginning_of_hour` returns a timestamp at the beginning of the hour (hh:00:00):
3363
-
3364
- ```ruby
3365
- date = DateTime.new(2010, 6, 7, 19, 55, 25)
3366
- date.beginning_of_hour # => Mon Jun 07 19:00:00 +0200 2010
3367
- ```
3368
-
3369
- The method `end_of_hour` returns a timestamp at the end of the hour (hh:59:59):
3370
-
3371
- ```ruby
3372
- date = DateTime.new(2010, 6, 7, 19, 55, 25)
3373
- date.end_of_hour # => Mon Jun 07 19:59:59 +0200 2010
3374
- ```
3375
-
3376
- `beginning_of_hour` is aliased to `at_beginning_of_hour`.
3377
-
3378
- ##### `beginning_of_minute`, `end_of_minute`
3379
-
3380
- The method `beginning_of_minute` returns a timestamp at the beginning of the minute (hh:mm:00):
3381
-
3382
- ```ruby
3383
- date = DateTime.new(2010, 6, 7, 19, 55, 25)
3384
- date.beginning_of_minute # => Mon Jun 07 19:55:00 +0200 2010
3385
- ```
3386
-
3387
- The method `end_of_minute` returns a timestamp at the end of the minute (hh:mm:59):
3388
-
3389
- ```ruby
3390
- date = DateTime.new(2010, 6, 7, 19, 55, 25)
3391
- date.end_of_minute # => Mon Jun 07 19:55:59 +0200 2010
3392
- ```
3393
-
3394
- `beginning_of_minute` is aliased to `at_beginning_of_minute`.
3395
-
3396
- INFO: `beginning_of_hour`, `end_of_hour`, `beginning_of_minute` and `end_of_minute` are implemented for `Time` and `DateTime` but **not** `Date` as it does not make sense to request the beginning or end of an hour or minute on a `Date` instance.
3397
-
3398
- ##### `ago`, `since`
3399
-
3400
- The method `ago` receives a number of seconds as argument and returns a timestamp those many seconds ago from midnight:
3401
-
3402
- ```ruby
3403
- date = Date.current # => Fri, 11 Jun 2010
3404
- date.ago(1) # => Thu, 10 Jun 2010 23:59:59 EDT -04:00
3405
- ```
3406
-
3407
- Similarly, `since` moves forward:
3408
-
3409
- ```ruby
3410
- date = Date.current # => Fri, 11 Jun 2010
3411
- date.since(1) # => Fri, 11 Jun 2010 00:00:01 EDT -04:00
3412
- ```
3413
-
3414
- #### Other Time Computations
3415
-
3416
- ### Conversions
3417
-
3418
- Extensions to `DateTime`
3419
- ------------------------
3420
-
3421
- WARNING: `DateTime` is not aware of DST rules and so some of these methods have edge cases when a DST change is going on. For example `seconds_since_midnight` might not return the real amount in such a day.
3422
-
3423
- ### Calculations
3424
-
3425
- NOTE: All the following methods are defined in `active_support/core_ext/date_time/calculations.rb`.
3426
-
3427
- The class `DateTime` is a subclass of `Date` so by loading `active_support/core_ext/date/calculations.rb` you inherit these methods and their aliases, except that they will always return datetimes:
3428
-
3429
- ```ruby
3430
- yesterday
3431
- tomorrow
3432
- beginning_of_week (at_beginning_of_week)
3433
- end_of_week (at_end_of_week)
3434
- monday
3435
- sunday
3436
- weeks_ago
3437
- prev_week (last_week)
3438
- next_week
3439
- months_ago
3440
- months_since
3441
- beginning_of_month (at_beginning_of_month)
3442
- end_of_month (at_end_of_month)
3443
- prev_month (last_month)
3444
- next_month
3445
- beginning_of_quarter (at_beginning_of_quarter)
3446
- end_of_quarter (at_end_of_quarter)
3447
- beginning_of_year (at_beginning_of_year)
3448
- end_of_year (at_end_of_year)
3449
- years_ago
3450
- years_since
3451
- prev_year (last_year)
3452
- next_year
3453
- ```
3454
-
3455
- The following methods are reimplemented so you do **not** need to load `active_support/core_ext/date/calculations.rb` for these ones:
3456
-
3457
- ```ruby
3458
- beginning_of_day (midnight, at_midnight, at_beginning_of_day)
3459
- end_of_day
3460
- ago
3461
- since (in)
3462
- ```
3463
-
3464
- On the other hand, `advance` and `change` are also defined and support more options, they are documented below.
3465
-
3466
- The following methods are only implemented in `active_support/core_ext/date_time/calculations.rb` as they only make sense when used with a `DateTime` instance:
3467
-
3468
- ```ruby
3469
- beginning_of_hour (at_beginning_of_hour)
3470
- end_of_hour
3471
- ```
3472
-
3473
- #### Named Datetimes
3474
-
3475
- ##### `DateTime.current`
3476
-
3477
- Active Support defines `DateTime.current` to be like `Time.now.to_datetime`, except that it honors the user time zone, if defined. It also defines `DateTime.yesterday` and `DateTime.tomorrow`, and the instance predicates `past?`, and `future?` relative to `DateTime.current`.
3478
-
3479
- #### Other Extensions
3480
-
3481
- ##### `seconds_since_midnight`
3482
-
3483
- The method `seconds_since_midnight` returns the number of seconds since midnight:
3484
-
3485
- ```ruby
3486
- now = DateTime.current # => Mon, 07 Jun 2010 20:26:36 +0000
3487
- now.seconds_since_midnight # => 73596
3488
- ```
3489
-
3490
- ##### `utc`
3491
-
3492
- The method `utc` gives you the same datetime in the receiver expressed in UTC.
3493
-
3494
- ```ruby
3495
- now = DateTime.current # => Mon, 07 Jun 2010 19:27:52 -0400
3496
- now.utc # => Mon, 07 Jun 2010 23:27:52 +0000
3497
- ```
3498
-
3499
- This method is also aliased as `getutc`.
3500
-
3501
- ##### `utc?`
3502
-
3503
- The predicate `utc?` says whether the receiver has UTC as its time zone:
3504
-
3505
- ```ruby
3506
- now = DateTime.now # => Mon, 07 Jun 2010 19:30:47 -0400
3507
- now.utc? # => false
3508
- now.utc.utc? # => true
3509
- ```
3510
-
3511
- ##### `advance`
3512
-
3513
- The most generic way to jump to another datetime is `advance`. This method receives a hash with keys `:years`, `:months`, `:weeks`, `:days`, `:hours`, `:minutes`, and `:seconds`, and returns a datetime advanced as much as the present keys indicate.
3514
-
3515
- ```ruby
3516
- d = DateTime.current
3517
- # => Thu, 05 Aug 2010 11:33:31 +0000
3518
- d.advance(years: 1, months: 1, days: 1, hours: 1, minutes: 1, seconds: 1)
3519
- # => Tue, 06 Sep 2011 12:34:32 +0000
3520
- ```
3521
-
3522
- This method first computes the destination date passing `:years`, `:months`, `:weeks`, and `:days` to `Date#advance` documented above. After that, it adjusts the time calling `since` with the number of seconds to advance. This order is relevant, a different ordering would give different datetimes in some edge-cases. The example in `Date#advance` applies, and we can extend it to show order relevance related to the time bits.
3523
-
3524
- If we first move the date bits (that have also a relative order of processing, as documented before), and then the time bits we get for example the following computation:
3525
-
3526
- ```ruby
3527
- d = DateTime.new(2010, 2, 28, 23, 59, 59)
3528
- # => Sun, 28 Feb 2010 23:59:59 +0000
3529
- d.advance(months: 1, seconds: 1)
3530
- # => Mon, 29 Mar 2010 00:00:00 +0000
3531
- ```
3532
-
3533
- but if we computed them the other way around, the result would be different:
3534
-
3535
- ```ruby
3536
- d.advance(seconds: 1).advance(months: 1)
3537
- # => Thu, 01 Apr 2010 00:00:00 +0000
3538
- ```
3539
-
3540
- WARNING: Since `DateTime` is not DST-aware you can end up in a non-existing point in time with no warning or error telling you so.
3541
-
3542
- #### Changing Components
3543
-
3544
- The method `change` allows you to get a new datetime which is the same as the receiver except for the given options, which may include `:year`, `:month`, `:day`, `:hour`, `:min`, `:sec`, `:offset`, `:start`:
3545
-
3546
- ```ruby
3547
- now = DateTime.current
3548
- # => Tue, 08 Jun 2010 01:56:22 +0000
3549
- now.change(year: 2011, offset: Rational(-6, 24))
3550
- # => Wed, 08 Jun 2011 01:56:22 -0600
3551
- ```
3552
-
3553
- If hours are zeroed, then minutes and seconds are too (unless they have given values):
3554
-
3555
- ```ruby
3556
- now.change(hour: 0)
3557
- # => Tue, 08 Jun 2010 00:00:00 +0000
3558
- ```
3559
-
3560
- Similarly, if minutes are zeroed, then seconds are too (unless it has given a value):
3561
-
3562
- ```ruby
3563
- now.change(min: 0)
3564
- # => Tue, 08 Jun 2010 01:00:00 +0000
3565
- ```
3566
-
3567
- This method is not tolerant to non-existing dates, if the change is invalid `ArgumentError` is raised:
3568
-
3569
- ```ruby
3570
- DateTime.current.change(month: 2, day: 30)
3571
- # => ArgumentError: invalid date
3572
- ```
3573
-
3574
- #### Durations
3575
-
3576
- Durations can be added to and subtracted from datetimes:
3577
-
3578
- ```ruby
3579
- now = DateTime.current
3580
- # => Mon, 09 Aug 2010 23:15:17 +0000
3581
- now + 1.year
3582
- # => Tue, 09 Aug 2011 23:15:17 +0000
3583
- now - 1.week
3584
- # => Mon, 02 Aug 2010 23:15:17 +0000
3585
- ```
3586
-
3587
- They translate to calls to `since` or `advance`. For example here we get the correct jump in the calendar reform:
3588
-
3589
- ```ruby
3590
- DateTime.new(1582, 10, 4, 23) + 1.hour
3591
- # => Fri, 15 Oct 1582 00:00:00 +0000
3592
- ```
3593
-
3594
- Extensions to `Time`
3595
- --------------------
3596
-
3597
- ### Calculations
3598
-
3599
- NOTE: All the following methods are defined in `active_support/core_ext/time/calculations.rb`.
3600
-
3601
- Active Support adds to `Time` many of the methods available for `DateTime`:
3602
-
3603
- ```ruby
3604
- past?
3605
- today?
3606
- future?
3607
- yesterday
3608
- tomorrow
3609
- seconds_since_midnight
3610
- change
3611
- advance
3612
- ago
3613
- since (in)
3614
- beginning_of_day (midnight, at_midnight, at_beginning_of_day)
3615
- end_of_day
3616
- beginning_of_hour (at_beginning_of_hour)
3617
- end_of_hour
3618
- beginning_of_week (at_beginning_of_week)
3619
- end_of_week (at_end_of_week)
3620
- monday
3621
- sunday
3622
- weeks_ago
3623
- prev_week (last_week)
3624
- next_week
3625
- months_ago
3626
- months_since
3627
- beginning_of_month (at_beginning_of_month)
3628
- end_of_month (at_end_of_month)
3629
- prev_month (last_month)
3630
- next_month
3631
- beginning_of_quarter (at_beginning_of_quarter)
3632
- end_of_quarter (at_end_of_quarter)
3633
- beginning_of_year (at_beginning_of_year)
3634
- end_of_year (at_end_of_year)
3635
- years_ago
3636
- years_since
3637
- prev_year (last_year)
3638
- next_year
3639
- ```
3640
-
3641
- They are analogous. Please refer to their documentation above and take into account the following differences:
3642
-
3643
- * `change` accepts an additional `:usec` option.
3644
- * `Time` understands DST, so you get correct DST calculations as in
3645
-
3646
- ```ruby
3647
- Time.zone_default
3648
- # => #<ActiveSupport::TimeZone:0x7f73654d4f38 @utc_offset=nil, @name="Madrid", ...>
3649
-
3650
- # In Barcelona, 2010/03/28 02:00 +0100 becomes 2010/03/28 03:00 +0200 due to DST.
3651
- t = Time.local(2010, 3, 28, 1, 59, 59)
3652
- # => Sun Mar 28 01:59:59 +0100 2010
3653
- t.advance(seconds: 1)
3654
- # => Sun Mar 28 03:00:00 +0200 2010
3655
- ```
3656
-
3657
- * If `since` or `ago` jump to a time that can't be expressed with `Time` a `DateTime` object is returned instead.
3658
-
3659
- #### `Time.current`
3660
-
3661
- Active Support defines `Time.current` to be today in the current time zone. That's like `Time.now`, except that it honors the user time zone, if defined. It also defines `Time.yesterday` and `Time.tomorrow`, and the instance predicates `past?`, `today?`, and `future?`, all of them relative to `Time.current`.
3662
-
3663
- When making Time comparisons using methods which honor the user time zone, make sure to use `Time.current` and not `Time.now`. There are cases where the user time zone might be in the future compared to the system time zone, which `Time.today` uses by default. This means `Time.now` may equal `Time.yesterday`.
3664
-
3665
- #### `all_day`, `all_week`, `all_month`, `all_quarter` and `all_year`
3666
-
3667
- The method `all_day` returns a range representing the whole day of the current time.
3668
-
3669
- ```ruby
3670
- now = Time.current
3671
- # => Mon, 09 Aug 2010 23:20:05 UTC +00:00
3672
- now.all_day
3673
- # => Mon, 09 Aug 2010 00:00:00 UTC +00:00..Mon, 09 Aug 2010 23:59:59 UTC +00:00
3674
- ```
3675
-
3676
- Analogously, `all_week`, `all_month`, `all_quarter` and `all_year` all serve the purpose of generating time ranges.
3677
-
3678
- ```ruby
3679
- now = Time.current
3680
- # => Mon, 09 Aug 2010 23:20:05 UTC +00:00
3681
- now.all_week
3682
- # => Mon, 09 Aug 2010 00:00:00 UTC +00:00..Sun, 15 Aug 2010 23:59:59 UTC +00:00
3683
- now.all_week(:sunday)
3684
- # => Sun, 16 Sep 2012 00:00:00 UTC +00:00..Sat, 22 Sep 2012 23:59:59 UTC +00:00
3685
- now.all_month
3686
- # => Sat, 01 Aug 2010 00:00:00 UTC +00:00..Tue, 31 Aug 2010 23:59:59 UTC +00:00
3687
- now.all_quarter
3688
- # => Thu, 01 Jul 2010 00:00:00 UTC +00:00..Thu, 30 Sep 2010 23:59:59 UTC +00:00
3689
- now.all_year
3690
- # => Fri, 01 Jan 2010 00:00:00 UTC +00:00..Fri, 31 Dec 2010 23:59:59 UTC +00:00
3691
- ```
3692
-
3693
- ### Time Constructors
3694
-
3695
- Active Support defines `Time.current` to be `Time.zone.now` if there's a user time zone defined, with fallback to `Time.now`:
3696
-
3697
- ```ruby
3698
- Time.zone_default
3699
- # => #<ActiveSupport::TimeZone:0x7f73654d4f38 @utc_offset=nil, @name="Madrid", ...>
3700
- Time.current
3701
- # => Fri, 06 Aug 2010 17:11:58 CEST +02:00
3702
- ```
3703
-
3704
- Analogously to `DateTime`, the predicates `past?`, and `future?` are relative to `Time.current`.
3705
-
3706
- If the time to be constructed lies beyond the range supported by `Time` in the runtime platform, usecs are discarded and a `DateTime` object is returned instead.
3707
-
3708
- #### Durations
3709
-
3710
- Durations can be added to and subtracted from time objects:
3711
-
3712
- ```ruby
3713
- now = Time.current
3714
- # => Mon, 09 Aug 2010 23:20:05 UTC +00:00
3715
- now + 1.year
3716
- # => Tue, 09 Aug 2011 23:21:11 UTC +00:00
3717
- now - 1.week
3718
- # => Mon, 02 Aug 2010 23:21:11 UTC +00:00
3719
- ```
3720
-
3721
- They translate to calls to `since` or `advance`. For example here we get the correct jump in the calendar reform:
3722
-
3723
- ```ruby
3724
- Time.utc(1582, 10, 3) + 5.days
3725
- # => Mon Oct 18 00:00:00 UTC 1582
3726
- ```
3727
-
3728
- Extensions to `File`
3729
- --------------------
3730
-
3731
- ### `atomic_write`
3732
-
3733
- With the class method `File.atomic_write` you can write to a file in a way that will prevent any reader from seeing half-written content.
3734
-
3735
- The name of the file is passed as an argument, and the method yields a file handle opened for writing. Once the block is done `atomic_write` closes the file handle and completes its job.
3736
-
3737
- For example, Action Pack uses this method to write asset cache files like `all.css`:
3738
-
3739
- ```ruby
3740
- File.atomic_write(joined_asset_path) do |cache|
3741
- cache.write(join_asset_file_contents(asset_paths))
3742
- end
3743
- ```
3744
-
3745
- To accomplish this `atomic_write` creates a temporary file. That's the file the code in the block actually writes to. On completion, the temporary file is renamed, which is an atomic operation on POSIX systems. If the target file exists `atomic_write` overwrites it and keeps owners and permissions. However there are a few cases where `atomic_write` cannot change the file ownership or permissions, this error is caught and skipped over trusting in the user/filesystem to ensure the file is accessible to the processes that need it.
3746
-
3747
- NOTE. Due to the chmod operation `atomic_write` performs, if the target file has an ACL set on it this ACL will be recalculated/modified.
3748
-
3749
- WARNING. Note you can't append with `atomic_write`.
3750
-
3751
- The auxiliary file is written in a standard directory for temporary files, but you can pass a directory of your choice as second argument.
3752
-
3753
- NOTE: Defined in `active_support/core_ext/file/atomic.rb`.
3754
-
3755
- Extensions to `Marshal`
3756
- -----------------------
3757
-
3758
- ### `load`
3759
-
3760
- Active Support adds constant autoloading support to `load`.
3761
-
3762
- For example, the file cache store deserializes this way:
3763
-
3764
- ```ruby
3765
- File.open(file_name) { |f| Marshal.load(f) }
3766
- ```
3767
-
3768
- If the cached data refers to a constant that is unknown at that point, the autoloading mechanism is triggered and if it succeeds the deserialization is retried transparently.
3769
-
3770
- WARNING. If the argument is an `IO` it needs to respond to `rewind` to be able to retry. Regular files respond to `rewind`.
3771
-
3772
- NOTE: Defined in `active_support/core_ext/marshal.rb`.
3773
-
3774
- Extensions to `Logger`
3775
- ----------------------
3776
-
3777
- ### `around_[level]`
3778
-
3779
- Takes two arguments, a `before_message` and `after_message` and calls the current level method on the `Logger` instance, passing in the `before_message`, then the specified message, then the `after_message`:
3780
-
3781
- ```ruby
3782
- logger = Logger.new("log/development.log")
3783
- logger.around_info("before", "after") { |logger| logger.info("during") }
3784
- ```
3785
-
3786
- ### `silence`
3787
-
3788
- Silences every log level lesser to the specified one for the duration of the given block. Log level orders are: debug, info, error and fatal.
3789
-
3790
- ```ruby
3791
- logger = Logger.new("log/development.log")
3792
- logger.silence(Logger::INFO) do
3793
- logger.debug("In space, no one can hear you scream.")
3794
- logger.info("Scream all you want, small mailman!")
3795
- end
3796
- ```
3797
-
3798
- ### `datetime_format=`
3799
-
3800
- Modifies the datetime format output by the formatter class associated with this logger. If the formatter class does not have a `datetime_format` method then this is ignored.
3801
-
3802
- ```ruby
3803
- class Logger::FormatWithTime < Logger::Formatter
3804
- cattr_accessor(:datetime_format) { "%Y%m%d%H%m%S" }
3805
-
3806
- def self.call(severity, timestamp, progname, msg)
3807
- "#{timestamp.strftime(datetime_format)} -- #{String === msg ? msg : msg.inspect}\n"
3808
- end
3809
- end
3810
-
3811
- logger = Logger.new("log/development.log")
3812
- logger.formatter = Logger::FormatWithTime
3813
- logger.info("<- is the current time")
3814
- ```
3815
-
3816
- NOTE: Defined in `active_support/core_ext/logger.rb`.
3817
-
3818
- Extensions to `NameError`
3819
- -------------------------
3820
-
3821
- Active Support adds `missing_name?` to `NameError`, which tests whether the exception was raised because of the name passed as argument.
3822
-
3823
- The name may be given as a symbol or string. A symbol is tested against the bare constant name, a string is against the fully-qualified constant name.
3824
-
3825
- TIP: A symbol can represent a fully-qualified constant name as in `:"ActiveRecord::Base"`, so the behavior for symbols is defined for convenience, not because it has to be that way technically.
3826
-
3827
- For example, when an action of `PostsController` is called Rails tries optimistically to use `PostsHelper`. It is OK that the helper module does not exist, so if an exception for that constant name is raised it should be silenced. But it could be the case that `posts_helper.rb` raises a `NameError` due to an actual unknown constant. That should be reraised. The method `missing_name?` provides a way to distinguish both cases:
3828
-
3829
- ```ruby
3830
- def default_helper_module!
3831
- module_name = name.sub(/Controller$/, '')
3832
- module_path = module_name.underscore
3833
- helper module_path
3834
- rescue MissingSourceFile => e
3835
- raise e unless e.is_missing? "helpers/#{module_path}_helper"
3836
- rescue NameError => e
3837
- raise e unless e.missing_name? "#{module_name}Helper"
3838
- end
3839
- ```
3840
-
3841
- NOTE: Defined in `actionpack/lib/abstract_controller/helpers.rb`.
3842
-
3843
- Extensions to `LoadError`
3844
- -------------------------
3845
-
3846
- Active Support adds `is_missing?` to `LoadError`, and also assigns that class to the constant `MissingSourceFile` for backwards compatibility.
3847
-
3848
- Given a path name `is_missing?` tests whether the exception was raised due to that particular file (except perhaps for the ".rb" extension).
3849
-
3850
- For example, when an action of `PostsController` is called Rails tries to load `posts_helper.rb`, but that file may not exist. That's fine, the helper module is not mandatory so Rails silences a load error. But it could be the case that the helper module does exist and in turn requires another library that is missing. In that case Rails must reraise the exception. The method `is_missing?` provides a way to distinguish both cases:
3851
-
3852
- ```ruby
3853
- def default_helper_module!
3854
- module_name = name.sub(/Controller$/, '')
3855
- module_path = module_name.underscore
3856
- helper module_path
3857
- rescue MissingSourceFile => e
3858
- raise e unless e.is_missing? "helpers/#{module_path}_helper"
3859
- rescue NameError => e
3860
- raise e unless e.missing_name? "#{module_name}Helper"
3861
- end
3862
- ```
3863
-
3864
- NOTE: Defined in `actionpack/lib/abstract_controller/helpers.rb`.