rails 4.2.6.rc1 → 5.2.8.1

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

Potentially problematic release.


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

Files changed (218) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +24 -12
  3. metadata +54 -248
  4. data/guides/CHANGELOG.md +0 -73
  5. data/guides/Rakefile +0 -79
  6. data/guides/assets/images/akshaysurve.jpg +0 -0
  7. data/guides/assets/images/belongs_to.png +0 -0
  8. data/guides/assets/images/book_icon.gif +0 -0
  9. data/guides/assets/images/bullet.gif +0 -0
  10. data/guides/assets/images/chapters_icon.gif +0 -0
  11. data/guides/assets/images/check_bullet.gif +0 -0
  12. data/guides/assets/images/credits_pic_blank.gif +0 -0
  13. data/guides/assets/images/csrf.png +0 -0
  14. data/guides/assets/images/edge_badge.png +0 -0
  15. data/guides/assets/images/favicon.ico +0 -0
  16. data/guides/assets/images/feature_tile.gif +0 -0
  17. data/guides/assets/images/footer_tile.gif +0 -0
  18. data/guides/assets/images/fxn.png +0 -0
  19. data/guides/assets/images/getting_started/article_with_comments.png +0 -0
  20. data/guides/assets/images/getting_started/challenge.png +0 -0
  21. data/guides/assets/images/getting_started/confirm_dialog.png +0 -0
  22. data/guides/assets/images/getting_started/forbidden_attributes_for_new_article.png +0 -0
  23. data/guides/assets/images/getting_started/form_with_errors.png +0 -0
  24. data/guides/assets/images/getting_started/index_action_with_edit_link.png +0 -0
  25. data/guides/assets/images/getting_started/new_article.png +0 -0
  26. data/guides/assets/images/getting_started/rails_welcome.png +0 -0
  27. data/guides/assets/images/getting_started/routing_error_no_controller.png +0 -0
  28. data/guides/assets/images/getting_started/routing_error_no_route_matches.png +0 -0
  29. data/guides/assets/images/getting_started/show_action_for_articles.png +0 -0
  30. data/guides/assets/images/getting_started/template_is_missing_articles_new.png +0 -0
  31. data/guides/assets/images/getting_started/unknown_action_create_for_articles.png +0 -0
  32. data/guides/assets/images/getting_started/unknown_action_new_for_articles.png +0 -0
  33. data/guides/assets/images/grey_bullet.gif +0 -0
  34. data/guides/assets/images/habtm.png +0 -0
  35. data/guides/assets/images/has_many.png +0 -0
  36. data/guides/assets/images/has_many_through.png +0 -0
  37. data/guides/assets/images/has_one.png +0 -0
  38. data/guides/assets/images/has_one_through.png +0 -0
  39. data/guides/assets/images/header_backdrop.png +0 -0
  40. data/guides/assets/images/header_tile.gif +0 -0
  41. data/guides/assets/images/i18n/demo_html_safe.png +0 -0
  42. data/guides/assets/images/i18n/demo_localized_pirate.png +0 -0
  43. data/guides/assets/images/i18n/demo_translated_en.png +0 -0
  44. data/guides/assets/images/i18n/demo_translated_pirate.png +0 -0
  45. data/guides/assets/images/i18n/demo_translation_missing.png +0 -0
  46. data/guides/assets/images/i18n/demo_untranslated.png +0 -0
  47. data/guides/assets/images/icons/README +0 -5
  48. data/guides/assets/images/icons/callouts/1.png +0 -0
  49. data/guides/assets/images/icons/callouts/10.png +0 -0
  50. data/guides/assets/images/icons/callouts/11.png +0 -0
  51. data/guides/assets/images/icons/callouts/12.png +0 -0
  52. data/guides/assets/images/icons/callouts/13.png +0 -0
  53. data/guides/assets/images/icons/callouts/14.png +0 -0
  54. data/guides/assets/images/icons/callouts/15.png +0 -0
  55. data/guides/assets/images/icons/callouts/2.png +0 -0
  56. data/guides/assets/images/icons/callouts/3.png +0 -0
  57. data/guides/assets/images/icons/callouts/4.png +0 -0
  58. data/guides/assets/images/icons/callouts/5.png +0 -0
  59. data/guides/assets/images/icons/callouts/6.png +0 -0
  60. data/guides/assets/images/icons/callouts/7.png +0 -0
  61. data/guides/assets/images/icons/callouts/8.png +0 -0
  62. data/guides/assets/images/icons/callouts/9.png +0 -0
  63. data/guides/assets/images/icons/caution.png +0 -0
  64. data/guides/assets/images/icons/example.png +0 -0
  65. data/guides/assets/images/icons/home.png +0 -0
  66. data/guides/assets/images/icons/important.png +0 -0
  67. data/guides/assets/images/icons/next.png +0 -0
  68. data/guides/assets/images/icons/note.png +0 -0
  69. data/guides/assets/images/icons/prev.png +0 -0
  70. data/guides/assets/images/icons/tip.png +0 -0
  71. data/guides/assets/images/icons/up.png +0 -0
  72. data/guides/assets/images/icons/warning.png +0 -0
  73. data/guides/assets/images/nav_arrow.gif +0 -0
  74. data/guides/assets/images/oscardelben.jpg +0 -0
  75. data/guides/assets/images/polymorphic.png +0 -0
  76. data/guides/assets/images/radar.png +0 -0
  77. data/guides/assets/images/rails4_features.png +0 -0
  78. data/guides/assets/images/rails_guides_kindle_cover.jpg +0 -0
  79. data/guides/assets/images/rails_guides_logo.gif +0 -0
  80. data/guides/assets/images/rails_logo_remix.gif +0 -0
  81. data/guides/assets/images/session_fixation.png +0 -0
  82. data/guides/assets/images/tab_grey.gif +0 -0
  83. data/guides/assets/images/tab_info.gif +0 -0
  84. data/guides/assets/images/tab_note.gif +0 -0
  85. data/guides/assets/images/tab_red.gif +0 -0
  86. data/guides/assets/images/tab_yellow.gif +0 -0
  87. data/guides/assets/images/tab_yellow.png +0 -0
  88. data/guides/assets/images/vijaydev.jpg +0 -0
  89. data/guides/assets/javascripts/guides.js +0 -59
  90. data/guides/assets/javascripts/jquery.min.js +0 -4
  91. data/guides/assets/javascripts/responsive-tables.js +0 -43
  92. data/guides/assets/javascripts/syntaxhighlighter/shBrushAS3.js +0 -59
  93. data/guides/assets/javascripts/syntaxhighlighter/shBrushAppleScript.js +0 -75
  94. data/guides/assets/javascripts/syntaxhighlighter/shBrushBash.js +0 -59
  95. data/guides/assets/javascripts/syntaxhighlighter/shBrushCSharp.js +0 -65
  96. data/guides/assets/javascripts/syntaxhighlighter/shBrushColdFusion.js +0 -100
  97. data/guides/assets/javascripts/syntaxhighlighter/shBrushCpp.js +0 -97
  98. data/guides/assets/javascripts/syntaxhighlighter/shBrushCss.js +0 -91
  99. data/guides/assets/javascripts/syntaxhighlighter/shBrushDelphi.js +0 -55
  100. data/guides/assets/javascripts/syntaxhighlighter/shBrushDiff.js +0 -41
  101. data/guides/assets/javascripts/syntaxhighlighter/shBrushErlang.js +0 -52
  102. data/guides/assets/javascripts/syntaxhighlighter/shBrushGroovy.js +0 -67
  103. data/guides/assets/javascripts/syntaxhighlighter/shBrushJScript.js +0 -52
  104. data/guides/assets/javascripts/syntaxhighlighter/shBrushJava.js +0 -57
  105. data/guides/assets/javascripts/syntaxhighlighter/shBrushJavaFX.js +0 -58
  106. data/guides/assets/javascripts/syntaxhighlighter/shBrushPerl.js +0 -72
  107. data/guides/assets/javascripts/syntaxhighlighter/shBrushPhp.js +0 -88
  108. data/guides/assets/javascripts/syntaxhighlighter/shBrushPlain.js +0 -33
  109. data/guides/assets/javascripts/syntaxhighlighter/shBrushPowerShell.js +0 -74
  110. data/guides/assets/javascripts/syntaxhighlighter/shBrushPython.js +0 -64
  111. data/guides/assets/javascripts/syntaxhighlighter/shBrushRuby.js +0 -55
  112. data/guides/assets/javascripts/syntaxhighlighter/shBrushSass.js +0 -94
  113. data/guides/assets/javascripts/syntaxhighlighter/shBrushScala.js +0 -51
  114. data/guides/assets/javascripts/syntaxhighlighter/shBrushSql.js +0 -66
  115. data/guides/assets/javascripts/syntaxhighlighter/shBrushVb.js +0 -56
  116. data/guides/assets/javascripts/syntaxhighlighter/shBrushXml.js +0 -69
  117. data/guides/assets/javascripts/syntaxhighlighter/shCore.js +0 -17
  118. data/guides/assets/stylesheets/fixes.css +0 -16
  119. data/guides/assets/stylesheets/kindle.css +0 -11
  120. data/guides/assets/stylesheets/main.css +0 -713
  121. data/guides/assets/stylesheets/print.css +0 -52
  122. data/guides/assets/stylesheets/reset.css +0 -43
  123. data/guides/assets/stylesheets/responsive-tables.css +0 -50
  124. data/guides/assets/stylesheets/style.css +0 -13
  125. data/guides/assets/stylesheets/syntaxhighlighter/shCore.css +0 -226
  126. data/guides/assets/stylesheets/syntaxhighlighter/shCoreDefault.css +0 -328
  127. data/guides/assets/stylesheets/syntaxhighlighter/shCoreDjango.css +0 -331
  128. data/guides/assets/stylesheets/syntaxhighlighter/shCoreEclipse.css +0 -339
  129. data/guides/assets/stylesheets/syntaxhighlighter/shCoreEmacs.css +0 -324
  130. data/guides/assets/stylesheets/syntaxhighlighter/shCoreFadeToGrey.css +0 -328
  131. data/guides/assets/stylesheets/syntaxhighlighter/shCoreMDUltra.css +0 -324
  132. data/guides/assets/stylesheets/syntaxhighlighter/shCoreMidnight.css +0 -324
  133. data/guides/assets/stylesheets/syntaxhighlighter/shCoreRDark.css +0 -324
  134. data/guides/assets/stylesheets/syntaxhighlighter/shThemeDefault.css +0 -117
  135. data/guides/assets/stylesheets/syntaxhighlighter/shThemeDjango.css +0 -120
  136. data/guides/assets/stylesheets/syntaxhighlighter/shThemeEclipse.css +0 -128
  137. data/guides/assets/stylesheets/syntaxhighlighter/shThemeEmacs.css +0 -113
  138. data/guides/assets/stylesheets/syntaxhighlighter/shThemeFadeToGrey.css +0 -117
  139. data/guides/assets/stylesheets/syntaxhighlighter/shThemeMDUltra.css +0 -113
  140. data/guides/assets/stylesheets/syntaxhighlighter/shThemeMidnight.css +0 -113
  141. data/guides/assets/stylesheets/syntaxhighlighter/shThemeRDark.css +0 -113
  142. data/guides/assets/stylesheets/syntaxhighlighter/shThemeRailsGuides.css +0 -116
  143. data/guides/bug_report_templates/action_controller_gem.rb +0 -47
  144. data/guides/bug_report_templates/action_controller_master.rb +0 -54
  145. data/guides/bug_report_templates/active_record_gem.rb +0 -40
  146. data/guides/bug_report_templates/active_record_master.rb +0 -49
  147. data/guides/bug_report_templates/generic_gem.rb +0 -15
  148. data/guides/bug_report_templates/generic_master.rb +0 -26
  149. data/guides/rails_guides/generator.rb +0 -248
  150. data/guides/rails_guides/helpers.rb +0 -53
  151. data/guides/rails_guides/indexer.rb +0 -68
  152. data/guides/rails_guides/kindle.rb +0 -119
  153. data/guides/rails_guides/levenshtein.rb +0 -37
  154. data/guides/rails_guides/markdown/renderer.rb +0 -82
  155. data/guides/rails_guides/markdown.rb +0 -167
  156. data/guides/rails_guides.rb +0 -63
  157. data/guides/source/2_2_release_notes.md +0 -435
  158. data/guides/source/2_3_release_notes.md +0 -621
  159. data/guides/source/3_0_release_notes.md +0 -611
  160. data/guides/source/3_1_release_notes.md +0 -559
  161. data/guides/source/3_2_release_notes.md +0 -568
  162. data/guides/source/4_0_release_notes.md +0 -279
  163. data/guides/source/4_1_release_notes.md +0 -730
  164. data/guides/source/4_2_release_notes.md +0 -877
  165. data/guides/source/_license.html.erb +0 -2
  166. data/guides/source/_welcome.html.erb +0 -23
  167. data/guides/source/action_controller_overview.md +0 -1192
  168. data/guides/source/action_mailer_basics.md +0 -757
  169. data/guides/source/action_view_overview.md +0 -1561
  170. data/guides/source/active_job_basics.md +0 -339
  171. data/guides/source/active_model_basics.md +0 -554
  172. data/guides/source/active_record_basics.md +0 -374
  173. data/guides/source/active_record_callbacks.md +0 -413
  174. data/guides/source/active_record_migrations.md +0 -1018
  175. data/guides/source/active_record_postgresql.md +0 -433
  176. data/guides/source/active_record_querying.md +0 -1781
  177. data/guides/source/active_record_validations.md +0 -1179
  178. data/guides/source/active_support_core_extensions.md +0 -3857
  179. data/guides/source/active_support_instrumentation.md +0 -488
  180. data/guides/source/api_documentation_guidelines.md +0 -361
  181. data/guides/source/asset_pipeline.md +0 -1304
  182. data/guides/source/association_basics.md +0 -2245
  183. data/guides/source/autoloading_and_reloading_constants.md +0 -1311
  184. data/guides/source/caching_with_rails.md +0 -379
  185. data/guides/source/command_line.md +0 -625
  186. data/guides/source/configuring.md +0 -1072
  187. data/guides/source/contributing_to_ruby_on_rails.md +0 -628
  188. data/guides/source/credits.html.erb +0 -80
  189. data/guides/source/debugging_rails_applications.md +0 -861
  190. data/guides/source/development_dependencies_install.md +0 -289
  191. data/guides/source/documents.yaml +0 -205
  192. data/guides/source/engines.md +0 -1412
  193. data/guides/source/form_helpers.md +0 -1024
  194. data/guides/source/generators.md +0 -676
  195. data/guides/source/getting_started.md +0 -2086
  196. data/guides/source/i18n.md +0 -1087
  197. data/guides/source/index.html.erb +0 -28
  198. data/guides/source/initialization.md +0 -704
  199. data/guides/source/kindle/copyright.html.erb +0 -1
  200. data/guides/source/kindle/layout.html.erb +0 -27
  201. data/guides/source/kindle/rails_guides.opf.erb +0 -52
  202. data/guides/source/kindle/toc.html.erb +0 -24
  203. data/guides/source/kindle/toc.ncx.erb +0 -64
  204. data/guides/source/kindle/welcome.html.erb +0 -5
  205. data/guides/source/layout.html.erb +0 -140
  206. data/guides/source/layouts_and_rendering.md +0 -1227
  207. data/guides/source/maintenance_policy.md +0 -78
  208. data/guides/source/nested_model_forms.md +0 -228
  209. data/guides/source/plugins.md +0 -444
  210. data/guides/source/rails_application_templates.md +0 -266
  211. data/guides/source/rails_on_rack.md +0 -336
  212. data/guides/source/routing.md +0 -1155
  213. data/guides/source/ruby_on_rails_guides_guidelines.md +0 -127
  214. data/guides/source/security.md +0 -1024
  215. data/guides/source/testing.md +0 -1132
  216. data/guides/source/upgrading_ruby_on_rails.md +0 -1186
  217. data/guides/source/working_with_javascript_in_rails.md +0 -407
  218. data/guides/w3c_validator.rb +0 -97
@@ -1,676 +0,0 @@
1
- Creating and Customizing Rails Generators & Templates
2
- =====================================================
3
-
4
- Rails generators are an essential tool if you plan to improve your workflow. With this guide you will learn how to create generators and customize existing ones.
5
-
6
- After reading this guide, you will know:
7
-
8
- * How to see which generators are available in your application.
9
- * How to create a generator using templates.
10
- * How Rails searches for generators before invoking them.
11
- * How Rails internally generates Rails code from the templates.
12
- * How to customize your scaffold by creating new generators.
13
- * How to customize your scaffold by changing generator templates.
14
- * How to use fallbacks to avoid overwriting a huge set of generators.
15
- * How to create an application template.
16
-
17
- --------------------------------------------------------------------------------
18
-
19
- First Contact
20
- -------------
21
-
22
- When you create an application using the `rails` command, you are in fact using a Rails generator. After that, you can get a list of all available generators by just invoking `rails generate`:
23
-
24
- ```bash
25
- $ rails new myapp
26
- $ cd myapp
27
- $ bin/rails generate
28
- ```
29
-
30
- You will get a list of all generators that comes with Rails. If you need a detailed description of the helper generator, for example, you can simply do:
31
-
32
- ```bash
33
- $ bin/rails generate helper --help
34
- ```
35
-
36
- Creating Your First Generator
37
- -----------------------------
38
-
39
- Since Rails 3.0, generators are built on top of [Thor](https://github.com/erikhuda/thor). Thor provides powerful options for parsing and a great API for manipulating files. For instance, let's build a generator that creates an initializer file named `initializer.rb` inside `config/initializers`.
40
-
41
- The first step is to create a file at `lib/generators/initializer_generator.rb` with the following content:
42
-
43
- ```ruby
44
- class InitializerGenerator < Rails::Generators::Base
45
- def create_initializer_file
46
- create_file "config/initializers/initializer.rb", "# Add initialization content here"
47
- end
48
- end
49
- ```
50
-
51
- NOTE: `create_file` is a method provided by `Thor::Actions`. Documentation for `create_file` and other Thor methods can be found in [Thor's documentation](http://rdoc.info/github/erikhuda/thor/master/Thor/Actions.html)
52
-
53
- Our new generator is quite simple: it inherits from `Rails::Generators::Base` and has one method definition. When a generator is invoked, each public method in the generator is executed sequentially in the order that it is defined. Finally, we invoke the `create_file` method that will create a file at the given destination with the given content. If you are familiar with the Rails Application Templates API, you'll feel right at home with the new generators API.
54
-
55
- To invoke our new generator, we just need to do:
56
-
57
- ```bash
58
- $ bin/rails generate initializer
59
- ```
60
-
61
- Before we go on, let's see our brand new generator description:
62
-
63
- ```bash
64
- $ bin/rails generate initializer --help
65
- ```
66
-
67
- Rails is usually able to generate good descriptions if a generator is namespaced, as `ActiveRecord::Generators::ModelGenerator`, but not in this particular case. We can solve this problem in two ways. The first one is calling `desc` inside our generator:
68
-
69
- ```ruby
70
- class InitializerGenerator < Rails::Generators::Base
71
- desc "This generator creates an initializer file at config/initializers"
72
- def create_initializer_file
73
- create_file "config/initializers/initializer.rb", "# Add initialization content here"
74
- end
75
- end
76
- ```
77
-
78
- Now we can see the new description by invoking `--help` on the new generator. The second way to add a description is by creating a file named `USAGE` in the same directory as our generator. We are going to do that in the next step.
79
-
80
- Creating Generators with Generators
81
- -----------------------------------
82
-
83
- Generators themselves have a generator:
84
-
85
- ```bash
86
- $ bin/rails generate generator initializer
87
- create lib/generators/initializer
88
- create lib/generators/initializer/initializer_generator.rb
89
- create lib/generators/initializer/USAGE
90
- create lib/generators/initializer/templates
91
- ```
92
-
93
- This is the generator just created:
94
-
95
- ```ruby
96
- class InitializerGenerator < Rails::Generators::NamedBase
97
- source_root File.expand_path("../templates", __FILE__)
98
- end
99
- ```
100
-
101
- First, notice that we are inheriting from `Rails::Generators::NamedBase` instead of `Rails::Generators::Base`. This means that our generator expects at least one argument, which will be the name of the initializer, and will be available in our code in the variable `name`.
102
-
103
- We can see that by invoking the description of this new generator (don't forget to delete the old generator file):
104
-
105
- ```bash
106
- $ bin/rails generate initializer --help
107
- Usage:
108
- rails generate initializer NAME [options]
109
- ```
110
-
111
- We can also see that our new generator has a class method called `source_root`. This method points to where our generator templates will be placed, if any, and by default it points to the created directory `lib/generators/initializer/templates`.
112
-
113
- In order to understand what a generator template means, let's create the file `lib/generators/initializer/templates/initializer.rb` with the following content:
114
-
115
- ```ruby
116
- # Add initialization content here
117
- ```
118
-
119
- And now let's change the generator to copy this template when invoked:
120
-
121
- ```ruby
122
- class InitializerGenerator < Rails::Generators::NamedBase
123
- source_root File.expand_path("../templates", __FILE__)
124
-
125
- def copy_initializer_file
126
- copy_file "initializer.rb", "config/initializers/#{file_name}.rb"
127
- end
128
- end
129
- ```
130
-
131
- And let's execute our generator:
132
-
133
- ```bash
134
- $ bin/rails generate initializer core_extensions
135
- ```
136
-
137
- We can see that now an initializer named core_extensions was created at `config/initializers/core_extensions.rb` with the contents of our template. That means that `copy_file` copied a file in our source root to the destination path we gave. The method `file_name` is automatically created when we inherit from `Rails::Generators::NamedBase`.
138
-
139
- The methods that are available for generators are covered in the [final section](#generator-methods) of this guide.
140
-
141
- Generators Lookup
142
- -----------------
143
-
144
- When you run `rails generate initializer core_extensions` Rails requires these files in turn until one is found:
145
-
146
- ```bash
147
- rails/generators/initializer/initializer_generator.rb
148
- generators/initializer/initializer_generator.rb
149
- rails/generators/initializer_generator.rb
150
- generators/initializer_generator.rb
151
- ```
152
-
153
- If none is found you get an error message.
154
-
155
- INFO: The examples above put files under the application's `lib` because said directory belongs to `$LOAD_PATH`.
156
-
157
- Customizing Your Workflow
158
- -------------------------
159
-
160
- Rails own generators are flexible enough to let you customize scaffolding. They can be configured in `config/application.rb`, these are some defaults:
161
-
162
- ```ruby
163
- config.generators do |g|
164
- g.orm :active_record
165
- g.template_engine :erb
166
- g.test_framework :test_unit, fixture: true
167
- end
168
- ```
169
-
170
- Before we customize our workflow, let's first see what our scaffold looks like:
171
-
172
- ```bash
173
- $ bin/rails generate scaffold User name:string
174
- invoke active_record
175
- create db/migrate/20130924151154_create_users.rb
176
- create app/models/user.rb
177
- invoke test_unit
178
- create test/models/user_test.rb
179
- create test/fixtures/users.yml
180
- invoke resource_route
181
- route resources :users
182
- invoke scaffold_controller
183
- create app/controllers/users_controller.rb
184
- invoke erb
185
- create app/views/users
186
- create app/views/users/index.html.erb
187
- create app/views/users/edit.html.erb
188
- create app/views/users/show.html.erb
189
- create app/views/users/new.html.erb
190
- create app/views/users/_form.html.erb
191
- invoke test_unit
192
- create test/controllers/users_controller_test.rb
193
- invoke helper
194
- create app/helpers/users_helper.rb
195
- invoke jbuilder
196
- create app/views/users/index.json.jbuilder
197
- create app/views/users/show.json.jbuilder
198
- invoke assets
199
- invoke coffee
200
- create app/assets/javascripts/users.js.coffee
201
- invoke scss
202
- create app/assets/stylesheets/users.css.scss
203
- invoke scss
204
- create app/assets/stylesheets/scaffolds.css.scss
205
- ```
206
-
207
- Looking at this output, it's easy to understand how generators work in Rails 3.0 and above. The scaffold generator doesn't actually generate anything, it just invokes others to do the work. This allows us to add/replace/remove any of those invocations. For instance, the scaffold generator invokes the scaffold_controller generator, which invokes erb, test_unit and helper generators. Since each generator has a single responsibility, they are easy to reuse, avoiding code duplication.
208
-
209
- Our first customization on the workflow will be to stop generating stylesheet, JavaScript and test fixture files for scaffolds. We can achieve that by changing our configuration to the following:
210
-
211
- ```ruby
212
- config.generators do |g|
213
- g.orm :active_record
214
- g.template_engine :erb
215
- g.test_framework :test_unit, fixture: false
216
- g.stylesheets false
217
- g.javascripts false
218
- end
219
- ```
220
-
221
- If we generate another resource with the scaffold generator, we can see that stylesheet, JavaScript and fixture files are not created anymore. If you want to customize it further, for example to use DataMapper and RSpec instead of Active Record and TestUnit, it's just a matter of adding their gems to your application and configuring your generators.
222
-
223
- To demonstrate this, we are going to create a new helper generator that simply adds some instance variable readers. First, we create a generator within the rails namespace, as this is where rails searches for generators used as hooks:
224
-
225
- ```bash
226
- $ bin/rails generate generator rails/my_helper
227
- create lib/generators/rails/my_helper
228
- create lib/generators/rails/my_helper/my_helper_generator.rb
229
- create lib/generators/rails/my_helper/USAGE
230
- create lib/generators/rails/my_helper/templates
231
- ```
232
-
233
- After that, we can delete both the `templates` directory and the `source_root`
234
- class method call from our new generator, because we are not going to need them.
235
- Add the method below, so our generator looks like the following:
236
-
237
- ```ruby
238
- # lib/generators/rails/my_helper/my_helper_generator.rb
239
- class Rails::MyHelperGenerator < Rails::Generators::NamedBase
240
- def create_helper_file
241
- create_file "app/helpers/#{file_name}_helper.rb", <<-FILE
242
- module #{class_name}Helper
243
- attr_reader :#{plural_name}, :#{plural_name.singularize}
244
- end
245
- FILE
246
- end
247
- end
248
- ```
249
-
250
- We can try out our new generator by creating a helper for products:
251
-
252
- ```bash
253
- $ bin/rails generate my_helper products
254
- create app/helpers/products_helper.rb
255
- ```
256
-
257
- And it will generate the following helper file in `app/helpers`:
258
-
259
- ```ruby
260
- module ProductsHelper
261
- attr_reader :products, :product
262
- end
263
- ```
264
-
265
- Which is what we expected. We can now tell scaffold to use our new helper generator by editing `config/application.rb` once again:
266
-
267
- ```ruby
268
- config.generators do |g|
269
- g.orm :active_record
270
- g.template_engine :erb
271
- g.test_framework :test_unit, fixture: false
272
- g.stylesheets false
273
- g.javascripts false
274
- g.helper :my_helper
275
- end
276
- ```
277
-
278
- and see it in action when invoking the generator:
279
-
280
- ```bash
281
- $ bin/rails generate scaffold Article body:text
282
- [...]
283
- invoke my_helper
284
- create app/helpers/articles_helper.rb
285
- ```
286
-
287
- We can notice on the output that our new helper was invoked instead of the Rails default. However one thing is missing, which is tests for our new generator and to do that, we are going to reuse old helpers test generators.
288
-
289
- Since Rails 3.0, this is easy to do due to the hooks concept. Our new helper does not need to be focused in one specific test framework, it can simply provide a hook and a test framework just needs to implement this hook in order to be compatible.
290
-
291
- To do that, we can change the generator this way:
292
-
293
- ```ruby
294
- # lib/generators/rails/my_helper/my_helper_generator.rb
295
- class Rails::MyHelperGenerator < Rails::Generators::NamedBase
296
- def create_helper_file
297
- create_file "app/helpers/#{file_name}_helper.rb", <<-FILE
298
- module #{class_name}Helper
299
- attr_reader :#{plural_name}, :#{plural_name.singularize}
300
- end
301
- FILE
302
- end
303
-
304
- hook_for :test_framework
305
- end
306
- ```
307
-
308
- Now, when the helper generator is invoked and TestUnit is configured as the test framework, it will try to invoke both `Rails::TestUnitGenerator` and `TestUnit::MyHelperGenerator`. Since none of those are defined, we can tell our generator to invoke `TestUnit::Generators::HelperGenerator` instead, which is defined since it's a Rails generator. To do that, we just need to add:
309
-
310
- ```ruby
311
- # Search for :helper instead of :my_helper
312
- hook_for :test_framework, as: :helper
313
- ```
314
-
315
- And now you can re-run scaffold for another resource and see it generating tests as well!
316
-
317
- Customizing Your Workflow by Changing Generators Templates
318
- ----------------------------------------------------------
319
-
320
- In the step above we simply wanted to add a line to the generated helper, without adding any extra functionality. There is a simpler way to do that, and it's by replacing the templates of already existing generators, in that case `Rails::Generators::HelperGenerator`.
321
-
322
- In Rails 3.0 and above, generators don't just look in the source root for templates, they also search for templates in other paths. And one of them is `lib/templates`. Since we want to customize `Rails::Generators::HelperGenerator`, we can do that by simply making a template copy inside `lib/templates/rails/helper` with the name `helper.rb`. So let's create that file with the following content:
323
-
324
- ```erb
325
- module <%= class_name %>Helper
326
- attr_reader :<%= plural_name %>, :<%= plural_name.singularize %>
327
- end
328
- ```
329
-
330
- and revert the last change in `config/application.rb`:
331
-
332
- ```ruby
333
- config.generators do |g|
334
- g.orm :active_record
335
- g.template_engine :erb
336
- g.test_framework :test_unit, fixture: false
337
- g.stylesheets false
338
- g.javascripts false
339
- end
340
- ```
341
-
342
- If you generate another resource, you can see that we get exactly the same result! This is useful if you want to customize your scaffold templates and/or layout by just creating `edit.html.erb`, `index.html.erb` and so on inside `lib/templates/erb/scaffold`.
343
-
344
- Scaffold templates in Rails frequently use ERB tags; these tags need to be
345
- escaped so that the generated output is valid ERB code.
346
-
347
- For example, the following escaped ERB tag would be needed in the template
348
- (note the extra `%`)...
349
-
350
- ```ruby
351
- <%%= stylesheet_include_tag :application %>
352
- ```
353
-
354
- ...to generate the following output:
355
-
356
- ```ruby
357
- <%= stylesheet_include_tag :application %>
358
- ```
359
-
360
- Adding Generators Fallbacks
361
- ---------------------------
362
-
363
- One last feature about generators which is quite useful for plugin generators is fallbacks. For example, imagine that you want to add a feature on top of TestUnit like [shoulda](https://github.com/thoughtbot/shoulda) does. Since TestUnit already implements all generators required by Rails and shoulda just wants to overwrite part of it, there is no need for shoulda to reimplement some generators again, it can simply tell Rails to use a `TestUnit` generator if none was found under the `Shoulda` namespace.
364
-
365
- We can easily simulate this behavior by changing our `config/application.rb` once again:
366
-
367
- ```ruby
368
- config.generators do |g|
369
- g.orm :active_record
370
- g.template_engine :erb
371
- g.test_framework :shoulda, fixture: false
372
- g.stylesheets false
373
- g.javascripts false
374
-
375
- # Add a fallback!
376
- g.fallbacks[:shoulda] = :test_unit
377
- end
378
- ```
379
-
380
- Now, if you create a Comment scaffold, you will see that the shoulda generators are being invoked, and at the end, they are just falling back to TestUnit generators:
381
-
382
- ```bash
383
- $ bin/rails generate scaffold Comment body:text
384
- invoke active_record
385
- create db/migrate/20130924143118_create_comments.rb
386
- create app/models/comment.rb
387
- invoke shoulda
388
- create test/models/comment_test.rb
389
- create test/fixtures/comments.yml
390
- invoke resource_route
391
- route resources :comments
392
- invoke scaffold_controller
393
- create app/controllers/comments_controller.rb
394
- invoke erb
395
- create app/views/comments
396
- create app/views/comments/index.html.erb
397
- create app/views/comments/edit.html.erb
398
- create app/views/comments/show.html.erb
399
- create app/views/comments/new.html.erb
400
- create app/views/comments/_form.html.erb
401
- invoke shoulda
402
- create test/controllers/comments_controller_test.rb
403
- invoke my_helper
404
- create app/helpers/comments_helper.rb
405
- invoke jbuilder
406
- create app/views/comments/index.json.jbuilder
407
- create app/views/comments/show.json.jbuilder
408
- invoke assets
409
- invoke coffee
410
- create app/assets/javascripts/comments.js.coffee
411
- invoke scss
412
- ```
413
-
414
- Fallbacks allow your generators to have a single responsibility, increasing code reuse and reducing the amount of duplication.
415
-
416
- Application Templates
417
- ---------------------
418
-
419
- Now that you've seen how generators can be used _inside_ an application, did you know they can also be used to _generate_ applications too? This kind of generator is referred as a "template". This is a brief overview of the Templates API. For detailed documentation see the [Rails Application Templates guide](rails_application_templates.html).
420
-
421
- ```ruby
422
- gem "rspec-rails", group: "test"
423
- gem "cucumber-rails", group: "test"
424
-
425
- if yes?("Would you like to install Devise?")
426
- gem "devise"
427
- generate "devise:install"
428
- model_name = ask("What would you like the user model to be called? [user]")
429
- model_name = "user" if model_name.blank?
430
- generate "devise", model_name
431
- end
432
- ```
433
-
434
- In the above template we specify that the application relies on the `rspec-rails` and `cucumber-rails` gem so these two will be added to the `test` group in the `Gemfile`. Then we pose a question to the user about whether or not they would like to install Devise. If the user replies "y" or "yes" to this question, then the template will add Devise to the `Gemfile` outside of any group and then runs the `devise:install` generator. This template then takes the users input and runs the `devise` generator, with the user's answer from the last question being passed to this generator.
435
-
436
- Imagine that this template was in a file called `template.rb`. We can use it to modify the outcome of the `rails new` command by using the `-m` option and passing in the filename:
437
-
438
- ```bash
439
- $ rails new thud -m template.rb
440
- ```
441
-
442
- This command will generate the `Thud` application, and then apply the template to the generated output.
443
-
444
- Templates don't have to be stored on the local system, the `-m` option also supports online templates:
445
-
446
- ```bash
447
- $ rails new thud -m https://gist.github.com/radar/722911/raw/
448
- ```
449
-
450
- Whilst the final section of this guide doesn't cover how to generate the most awesome template known to man, it will take you through the methods available at your disposal so that you can develop it yourself. These same methods are also available for generators.
451
-
452
- Generator methods
453
- -----------------
454
-
455
- The following are methods available for both generators and templates for Rails.
456
-
457
- NOTE: Methods provided by Thor are not covered this guide and can be found in [Thor's documentation](http://rdoc.info/github/erikhuda/thor/master/Thor/Actions.html)
458
-
459
- ### `gem`
460
-
461
- Specifies a gem dependency of the application.
462
-
463
- ```ruby
464
- gem "rspec", group: "test", version: "2.1.0"
465
- gem "devise", "1.1.5"
466
- ```
467
-
468
- Available options are:
469
-
470
- * `:group` - The group in the `Gemfile` where this gem should go.
471
- * `:version` - The version string of the gem you want to use. Can also be specified as the second argument to the method.
472
- * `:git` - The URL to the git repository for this gem.
473
-
474
- Any additional options passed to this method are put on the end of the line:
475
-
476
- ```ruby
477
- gem "devise", git: "git://github.com/plataformatec/devise", branch: "master"
478
- ```
479
-
480
- The above code will put the following line into `Gemfile`:
481
-
482
- ```ruby
483
- gem "devise", git: "git://github.com/plataformatec/devise", branch: "master"
484
- ```
485
-
486
- ### `gem_group`
487
-
488
- Wraps gem entries inside a group:
489
-
490
- ```ruby
491
- gem_group :development, :test do
492
- gem "rspec-rails"
493
- end
494
- ```
495
-
496
- ### `add_source`
497
-
498
- Adds a specified source to `Gemfile`:
499
-
500
- ```ruby
501
- add_source "http://gems.github.com"
502
- ```
503
-
504
- ### `inject_into_file`
505
-
506
- Injects a block of code into a defined position in your file.
507
-
508
- ```ruby
509
- inject_into_file 'name_of_file.rb', after: "#The code goes below this line. Don't forget the Line break at the end\n" do <<-'RUBY'
510
- puts "Hello World"
511
- RUBY
512
- end
513
- ```
514
-
515
- ### `gsub_file`
516
-
517
- Replaces text inside a file.
518
-
519
- ```ruby
520
- gsub_file 'name_of_file.rb', 'method.to_be_replaced', 'method.the_replacing_code'
521
- ```
522
-
523
- Regular Expressions can be used to make this method more precise. You can also use `append_file` and `prepend_file` in the same way to place code at the beginning and end of a file respectively.
524
-
525
- ### `application`
526
-
527
- Adds a line to `config/application.rb` directly after the application class definition.
528
-
529
- ```ruby
530
- application "config.asset_host = 'http://example.com'"
531
- ```
532
-
533
- This method can also take a block:
534
-
535
- ```ruby
536
- application do
537
- "config.asset_host = 'http://example.com'"
538
- end
539
- ```
540
-
541
- Available options are:
542
-
543
- * `:env` - Specify an environment for this configuration option. If you wish to use this option with the block syntax the recommended syntax is as follows:
544
-
545
- ```ruby
546
- application(nil, env: "development") do
547
- "config.asset_host = 'http://localhost:3000'"
548
- end
549
- ```
550
-
551
- ### `git`
552
-
553
- Runs the specified git command:
554
-
555
- ```ruby
556
- git :init
557
- git add: "."
558
- git commit: "-m First commit!"
559
- git add: "onefile.rb", rm: "badfile.cxx"
560
- ```
561
-
562
- The values of the hash here being the arguments or options passed to the specific git command. As per the final example shown here, multiple git commands can be specified at a time, but the order of their running is not guaranteed to be the same as the order that they were specified in.
563
-
564
- ### `vendor`
565
-
566
- Places a file into `vendor` which contains the specified code.
567
-
568
- ```ruby
569
- vendor "sekrit.rb", '#top secret stuff'
570
- ```
571
-
572
- This method also takes a block:
573
-
574
- ```ruby
575
- vendor "seeds.rb" do
576
- "puts 'in your app, seeding your database'"
577
- end
578
- ```
579
-
580
- ### `lib`
581
-
582
- Places a file into `lib` which contains the specified code.
583
-
584
- ```ruby
585
- lib "special.rb", "p Rails.root"
586
- ```
587
-
588
- This method also takes a block:
589
-
590
- ```ruby
591
- lib "super_special.rb" do
592
- puts "Super special!"
593
- end
594
- ```
595
-
596
- ### `rakefile`
597
-
598
- Creates a Rake file in the `lib/tasks` directory of the application.
599
-
600
- ```ruby
601
- rakefile "test.rake", "hello there"
602
- ```
603
-
604
- This method also takes a block:
605
-
606
- ```ruby
607
- rakefile "test.rake" do
608
- %Q{
609
- task rock: :environment do
610
- puts "Rockin'"
611
- end
612
- }
613
- end
614
- ```
615
-
616
- ### `initializer`
617
-
618
- Creates an initializer in the `config/initializers` directory of the application:
619
-
620
- ```ruby
621
- initializer "begin.rb", "puts 'this is the beginning'"
622
- ```
623
-
624
- This method also takes a block, expected to return a string:
625
-
626
- ```ruby
627
- initializer "begin.rb" do
628
- "puts 'this is the beginning'"
629
- end
630
- ```
631
-
632
- ### `generate`
633
-
634
- Runs the specified generator where the first argument is the generator name and the remaining arguments are passed directly to the generator.
635
-
636
- ```ruby
637
- generate "scaffold", "forums title:string description:text"
638
- ```
639
-
640
-
641
- ### `rake`
642
-
643
- Runs the specified Rake task.
644
-
645
- ```ruby
646
- rake "db:migrate"
647
- ```
648
-
649
- Available options are:
650
-
651
- * `:env` - Specifies the environment in which to run this rake task.
652
- * `:sudo` - Whether or not to run this task using `sudo`. Defaults to `false`.
653
-
654
- ### `capify!`
655
-
656
- Runs the `capify` command from Capistrano at the root of the application which generates Capistrano configuration.
657
-
658
- ```ruby
659
- capify!
660
- ```
661
-
662
- ### `route`
663
-
664
- Adds text to the `config/routes.rb` file:
665
-
666
- ```ruby
667
- route "resources :people"
668
- ```
669
-
670
- ### `readme`
671
-
672
- Output the contents of a file in the template's `source_path`, usually a README.
673
-
674
- ```ruby
675
- readme "README"
676
- ```