rails 3.2.22.5 → 4.2.11.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (218) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +85 -0
  3. data/guides/CHANGELOG.md +103 -0
  4. data/guides/Rakefile +92 -0
  5. data/guides/assets/images/akshaysurve.jpg +0 -0
  6. data/guides/assets/images/belongs_to.png +0 -0
  7. data/guides/assets/images/book_icon.gif +0 -0
  8. data/guides/assets/images/bullet.gif +0 -0
  9. data/guides/assets/images/chapters_icon.gif +0 -0
  10. data/guides/assets/images/check_bullet.gif +0 -0
  11. data/guides/assets/images/credits_pic_blank.gif +0 -0
  12. data/guides/assets/images/csrf.png +0 -0
  13. data/guides/assets/images/edge_badge.png +0 -0
  14. data/guides/assets/images/favicon.ico +0 -0
  15. data/guides/assets/images/feature_tile.gif +0 -0
  16. data/guides/assets/images/footer_tile.gif +0 -0
  17. data/guides/assets/images/fxn.png +0 -0
  18. data/guides/assets/images/getting_started/article_with_comments.png +0 -0
  19. data/guides/assets/images/getting_started/challenge.png +0 -0
  20. data/guides/assets/images/getting_started/confirm_dialog.png +0 -0
  21. data/guides/assets/images/getting_started/forbidden_attributes_for_new_article.png +0 -0
  22. data/guides/assets/images/getting_started/form_with_errors.png +0 -0
  23. data/guides/assets/images/getting_started/index_action_with_edit_link.png +0 -0
  24. data/guides/assets/images/getting_started/new_article.png +0 -0
  25. data/guides/assets/images/getting_started/rails_welcome.png +0 -0
  26. data/guides/assets/images/getting_started/routing_error_no_controller.png +0 -0
  27. data/guides/assets/images/getting_started/routing_error_no_route_matches.png +0 -0
  28. data/guides/assets/images/getting_started/show_action_for_articles.png +0 -0
  29. data/guides/assets/images/getting_started/template_is_missing_articles_new.png +0 -0
  30. data/guides/assets/images/getting_started/unknown_action_create_for_articles.png +0 -0
  31. data/guides/assets/images/getting_started/unknown_action_new_for_articles.png +0 -0
  32. data/guides/assets/images/grey_bullet.gif +0 -0
  33. data/guides/assets/images/habtm.png +0 -0
  34. data/guides/assets/images/has_many.png +0 -0
  35. data/guides/assets/images/has_many_through.png +0 -0
  36. data/guides/assets/images/has_one.png +0 -0
  37. data/guides/assets/images/has_one_through.png +0 -0
  38. data/guides/assets/images/header_backdrop.png +0 -0
  39. data/guides/assets/images/header_tile.gif +0 -0
  40. data/guides/assets/images/i18n/demo_html_safe.png +0 -0
  41. data/guides/assets/images/i18n/demo_localized_pirate.png +0 -0
  42. data/guides/assets/images/i18n/demo_translated_en.png +0 -0
  43. data/guides/assets/images/i18n/demo_translated_pirate.png +0 -0
  44. data/guides/assets/images/i18n/demo_translation_missing.png +0 -0
  45. data/guides/assets/images/i18n/demo_untranslated.png +0 -0
  46. data/guides/assets/images/icons/README +5 -0
  47. data/guides/assets/images/icons/callouts/1.png +0 -0
  48. data/guides/assets/images/icons/callouts/10.png +0 -0
  49. data/guides/assets/images/icons/callouts/11.png +0 -0
  50. data/guides/assets/images/icons/callouts/12.png +0 -0
  51. data/guides/assets/images/icons/callouts/13.png +0 -0
  52. data/guides/assets/images/icons/callouts/14.png +0 -0
  53. data/guides/assets/images/icons/callouts/15.png +0 -0
  54. data/guides/assets/images/icons/callouts/2.png +0 -0
  55. data/guides/assets/images/icons/callouts/3.png +0 -0
  56. data/guides/assets/images/icons/callouts/4.png +0 -0
  57. data/guides/assets/images/icons/callouts/5.png +0 -0
  58. data/guides/assets/images/icons/callouts/6.png +0 -0
  59. data/guides/assets/images/icons/callouts/7.png +0 -0
  60. data/guides/assets/images/icons/callouts/8.png +0 -0
  61. data/guides/assets/images/icons/callouts/9.png +0 -0
  62. data/guides/assets/images/icons/caution.png +0 -0
  63. data/guides/assets/images/icons/example.png +0 -0
  64. data/guides/assets/images/icons/home.png +0 -0
  65. data/guides/assets/images/icons/important.png +0 -0
  66. data/guides/assets/images/icons/next.png +0 -0
  67. data/guides/assets/images/icons/note.png +0 -0
  68. data/guides/assets/images/icons/prev.png +0 -0
  69. data/guides/assets/images/icons/tip.png +0 -0
  70. data/guides/assets/images/icons/up.png +0 -0
  71. data/guides/assets/images/icons/warning.png +0 -0
  72. data/guides/assets/images/nav_arrow.gif +0 -0
  73. data/guides/assets/images/oscardelben.jpg +0 -0
  74. data/guides/assets/images/polymorphic.png +0 -0
  75. data/guides/assets/images/radar.png +0 -0
  76. data/guides/assets/images/rails4_features.png +0 -0
  77. data/guides/assets/images/rails_guides_kindle_cover.jpg +0 -0
  78. data/guides/assets/images/rails_guides_logo.gif +0 -0
  79. data/guides/assets/images/rails_logo_remix.gif +0 -0
  80. data/guides/assets/images/session_fixation.png +0 -0
  81. data/guides/assets/images/tab_grey.gif +0 -0
  82. data/guides/assets/images/tab_info.gif +0 -0
  83. data/guides/assets/images/tab_note.gif +0 -0
  84. data/guides/assets/images/tab_red.gif +0 -0
  85. data/guides/assets/images/tab_yellow.gif +0 -0
  86. data/guides/assets/images/tab_yellow.png +0 -0
  87. data/guides/assets/images/vijaydev.jpg +0 -0
  88. data/guides/assets/javascripts/guides.js +59 -0
  89. data/guides/assets/javascripts/jquery.min.js +4 -0
  90. data/guides/assets/javascripts/responsive-tables.js +43 -0
  91. data/guides/assets/javascripts/syntaxhighlighter/shBrushAS3.js +59 -0
  92. data/guides/assets/javascripts/syntaxhighlighter/shBrushAppleScript.js +75 -0
  93. data/guides/assets/javascripts/syntaxhighlighter/shBrushBash.js +59 -0
  94. data/guides/assets/javascripts/syntaxhighlighter/shBrushCSharp.js +65 -0
  95. data/guides/assets/javascripts/syntaxhighlighter/shBrushColdFusion.js +100 -0
  96. data/guides/assets/javascripts/syntaxhighlighter/shBrushCpp.js +97 -0
  97. data/guides/assets/javascripts/syntaxhighlighter/shBrushCss.js +91 -0
  98. data/guides/assets/javascripts/syntaxhighlighter/shBrushDelphi.js +55 -0
  99. data/guides/assets/javascripts/syntaxhighlighter/shBrushDiff.js +41 -0
  100. data/guides/assets/javascripts/syntaxhighlighter/shBrushErlang.js +52 -0
  101. data/guides/assets/javascripts/syntaxhighlighter/shBrushGroovy.js +67 -0
  102. data/guides/assets/javascripts/syntaxhighlighter/shBrushJScript.js +52 -0
  103. data/guides/assets/javascripts/syntaxhighlighter/shBrushJava.js +57 -0
  104. data/guides/assets/javascripts/syntaxhighlighter/shBrushJavaFX.js +58 -0
  105. data/guides/assets/javascripts/syntaxhighlighter/shBrushPerl.js +72 -0
  106. data/guides/assets/javascripts/syntaxhighlighter/shBrushPhp.js +88 -0
  107. data/guides/assets/javascripts/syntaxhighlighter/shBrushPlain.js +33 -0
  108. data/guides/assets/javascripts/syntaxhighlighter/shBrushPowerShell.js +74 -0
  109. data/guides/assets/javascripts/syntaxhighlighter/shBrushPython.js +64 -0
  110. data/guides/assets/javascripts/syntaxhighlighter/shBrushRuby.js +55 -0
  111. data/guides/assets/javascripts/syntaxhighlighter/shBrushSass.js +94 -0
  112. data/guides/assets/javascripts/syntaxhighlighter/shBrushScala.js +51 -0
  113. data/guides/assets/javascripts/syntaxhighlighter/shBrushSql.js +66 -0
  114. data/guides/assets/javascripts/syntaxhighlighter/shBrushVb.js +56 -0
  115. data/guides/assets/javascripts/syntaxhighlighter/shBrushXml.js +69 -0
  116. data/guides/assets/javascripts/syntaxhighlighter/shCore.js +17 -0
  117. data/guides/assets/stylesheets/fixes.css +16 -0
  118. data/guides/assets/stylesheets/kindle.css +11 -0
  119. data/guides/assets/stylesheets/main.css +713 -0
  120. data/guides/assets/stylesheets/print.css +52 -0
  121. data/guides/assets/stylesheets/reset.css +43 -0
  122. data/guides/assets/stylesheets/responsive-tables.css +50 -0
  123. data/guides/assets/stylesheets/style.css +13 -0
  124. data/guides/assets/stylesheets/syntaxhighlighter/shCore.css +226 -0
  125. data/guides/assets/stylesheets/syntaxhighlighter/shCoreDefault.css +328 -0
  126. data/guides/assets/stylesheets/syntaxhighlighter/shCoreDjango.css +331 -0
  127. data/guides/assets/stylesheets/syntaxhighlighter/shCoreEclipse.css +339 -0
  128. data/guides/assets/stylesheets/syntaxhighlighter/shCoreEmacs.css +324 -0
  129. data/guides/assets/stylesheets/syntaxhighlighter/shCoreFadeToGrey.css +328 -0
  130. data/guides/assets/stylesheets/syntaxhighlighter/shCoreMDUltra.css +324 -0
  131. data/guides/assets/stylesheets/syntaxhighlighter/shCoreMidnight.css +324 -0
  132. data/guides/assets/stylesheets/syntaxhighlighter/shCoreRDark.css +324 -0
  133. data/guides/assets/stylesheets/syntaxhighlighter/shThemeDefault.css +117 -0
  134. data/guides/assets/stylesheets/syntaxhighlighter/shThemeDjango.css +120 -0
  135. data/guides/assets/stylesheets/syntaxhighlighter/shThemeEclipse.css +128 -0
  136. data/guides/assets/stylesheets/syntaxhighlighter/shThemeEmacs.css +113 -0
  137. data/guides/assets/stylesheets/syntaxhighlighter/shThemeFadeToGrey.css +117 -0
  138. data/guides/assets/stylesheets/syntaxhighlighter/shThemeMDUltra.css +113 -0
  139. data/guides/assets/stylesheets/syntaxhighlighter/shThemeMidnight.css +113 -0
  140. data/guides/assets/stylesheets/syntaxhighlighter/shThemeRDark.css +113 -0
  141. data/guides/assets/stylesheets/syntaxhighlighter/shThemeRailsGuides.css +116 -0
  142. data/guides/bug_report_templates/action_controller_gem.rb +47 -0
  143. data/guides/bug_report_templates/action_controller_master.rb +54 -0
  144. data/guides/bug_report_templates/active_record_gem.rb +40 -0
  145. data/guides/bug_report_templates/active_record_master.rb +49 -0
  146. data/guides/bug_report_templates/generic_gem.rb +15 -0
  147. data/guides/bug_report_templates/generic_master.rb +26 -0
  148. data/guides/rails_guides.rb +63 -0
  149. data/guides/rails_guides/generator.rb +248 -0
  150. data/guides/rails_guides/helpers.rb +53 -0
  151. data/guides/rails_guides/indexer.rb +68 -0
  152. data/guides/rails_guides/kindle.rb +119 -0
  153. data/guides/rails_guides/levenshtein.rb +37 -0
  154. data/guides/rails_guides/markdown.rb +167 -0
  155. data/guides/rails_guides/markdown/renderer.rb +82 -0
  156. data/guides/source/2_2_release_notes.md +435 -0
  157. data/guides/source/2_3_release_notes.md +621 -0
  158. data/guides/source/3_0_release_notes.md +611 -0
  159. data/guides/source/3_1_release_notes.md +559 -0
  160. data/guides/source/3_2_release_notes.md +568 -0
  161. data/guides/source/4_0_release_notes.md +279 -0
  162. data/guides/source/4_1_release_notes.md +730 -0
  163. data/guides/source/4_2_release_notes.md +877 -0
  164. data/guides/source/_license.html.erb +2 -0
  165. data/guides/source/_welcome.html.erb +23 -0
  166. data/guides/source/action_controller_overview.md +1192 -0
  167. data/guides/source/action_mailer_basics.md +757 -0
  168. data/guides/source/action_view_overview.md +1561 -0
  169. data/guides/source/active_job_basics.md +339 -0
  170. data/guides/source/active_model_basics.md +554 -0
  171. data/guides/source/active_record_basics.md +374 -0
  172. data/guides/source/active_record_callbacks.md +413 -0
  173. data/guides/source/active_record_migrations.md +1018 -0
  174. data/guides/source/active_record_postgresql.md +433 -0
  175. data/guides/source/active_record_querying.md +1781 -0
  176. data/guides/source/active_record_validations.md +1179 -0
  177. data/guides/source/active_support_core_extensions.md +3856 -0
  178. data/guides/source/active_support_instrumentation.md +488 -0
  179. data/guides/source/api_documentation_guidelines.md +361 -0
  180. data/guides/source/asset_pipeline.md +1304 -0
  181. data/guides/source/association_basics.md +2245 -0
  182. data/guides/source/autoloading_and_reloading_constants.md +1311 -0
  183. data/guides/source/caching_with_rails.md +379 -0
  184. data/guides/source/command_line.md +625 -0
  185. data/guides/source/configuring.md +1070 -0
  186. data/guides/source/contributing_to_ruby_on_rails.md +628 -0
  187. data/guides/source/credits.html.erb +80 -0
  188. data/guides/source/debugging_rails_applications.md +861 -0
  189. data/guides/source/development_dependencies_install.md +289 -0
  190. data/guides/source/documents.yaml +205 -0
  191. data/guides/source/engines.md +1412 -0
  192. data/guides/source/form_helpers.md +1024 -0
  193. data/guides/source/generators.md +676 -0
  194. data/guides/source/getting_started.md +2086 -0
  195. data/guides/source/i18n.md +1087 -0
  196. data/guides/source/index.html.erb +28 -0
  197. data/guides/source/initialization.md +704 -0
  198. data/guides/source/kindle/copyright.html.erb +1 -0
  199. data/guides/source/kindle/layout.html.erb +27 -0
  200. data/guides/source/kindle/rails_guides.opf.erb +52 -0
  201. data/guides/source/kindle/toc.html.erb +24 -0
  202. data/guides/source/kindle/toc.ncx.erb +64 -0
  203. data/guides/source/kindle/welcome.html.erb +5 -0
  204. data/guides/source/layout.html.erb +140 -0
  205. data/guides/source/layouts_and_rendering.md +1226 -0
  206. data/guides/source/maintenance_policy.md +78 -0
  207. data/guides/source/nested_model_forms.md +228 -0
  208. data/guides/source/plugins.md +444 -0
  209. data/guides/source/rails_application_templates.md +266 -0
  210. data/guides/source/rails_on_rack.md +335 -0
  211. data/guides/source/routing.md +1155 -0
  212. data/guides/source/ruby_on_rails_guides_guidelines.md +127 -0
  213. data/guides/source/security.md +1024 -0
  214. data/guides/source/testing.md +1132 -0
  215. data/guides/source/upgrading_ruby_on_rails.md +1186 -0
  216. data/guides/source/working_with_javascript_in_rails.md +407 -0
  217. data/guides/w3c_validator.rb +97 -0
  218. metadata +288 -26
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 07c3999f8ee5cde9777ac3b5d515b34b8b7b5362
4
- data.tar.gz: af431136293619a11ca66d461b982d8defd08723
2
+ SHA256:
3
+ metadata.gz: 4102988547e646fdb3241e16210ae1facf8e3d894c36e2b1deff16131fc41e35
4
+ data.tar.gz: 15db282a7d3be7e7384a7c5adbea7f1e15c7f2ebc08e52dbcb98ebf68a9187ee
5
5
  SHA512:
6
- metadata.gz: 8761b6bfbbfa230b28933066254bfcfc02f0065e44ddef7b223aaaf6fd0131d817b3ffb27772a7ca1baa65e24233310bb6b99eba5c30634a0285ac90d6639f6e
7
- data.tar.gz: 6507775e0b57f844939ff14248a53d7279026f4dc8bedc83423ec9eb9ffd913ec5c54d907610bf30570cf6540854d9540d3b0bc132aaf231fde10a3b43a62989
6
+ metadata.gz: '03397d1bec513121e4b39de380eda105ca1a040c13cdede32a46b49fcc1c69a18b274429bec9ebd017513fa14f83b1bd9c4ff092baa7deb3874f6b779aec37f9'
7
+ data.tar.gz: bce9f9aec430af1a231ca61323b8893022c04a225a24b0564750c8387b67bdfc542892dde397bb641d0ee4e4ef6c9620b5e7af92e063f2e81463bbd7fd8401a8
@@ -0,0 +1,85 @@
1
+ ## Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to
4
+ create database-backed web applications according to the
5
+ [Model-View-Controller (MVC)](http://en.wikipedia.org/wiki/Model-view-controller)
6
+ pattern.
7
+
8
+ Understanding the MVC pattern is key to understanding Rails. MVC divides your
9
+ application into three layers, each with a specific responsibility.
10
+
11
+ The _Model layer_ represents your domain model (such as Account, Product,
12
+ Person, Post, etc.) and encapsulates the business logic that is specific to
13
+ your application. In Rails, database-backed model classes are derived from
14
+ `ActiveRecord::Base`. Active Record allows you to present the data from
15
+ database rows as objects and embellish these data objects with business logic
16
+ methods. You can read more about Active Record in its [README](activerecord/README.rdoc).
17
+ Although most Rails models are backed by a database, models can also be ordinary
18
+ Ruby classes, or Ruby classes that implement a set of interfaces as provided by
19
+ the Active Model module. You can read more about Active Model in its [README](activemodel/README.rdoc).
20
+
21
+ The _Controller layer_ is responsible for handling incoming HTTP requests and
22
+ providing a suitable response. Usually this means returning HTML, but Rails controllers
23
+ can also generate XML, JSON, PDFs, mobile-specific views, and more. Controllers load and
24
+ manipulate models, and render view templates in order to generate the appropriate HTTP response.
25
+ In Rails, incoming requests are routed by Action Dispatch to an appropriate controller, and
26
+ controller classes are derived from `ActionController::Base`. Action Dispatch and Action Controller
27
+ are bundled together in Action Pack. You can read more about Action Pack in its
28
+ [README](actionpack/README.rdoc).
29
+
30
+ The _View layer_ is composed of "templates" that are responsible for providing
31
+ appropriate representations of your application's resources. Templates can
32
+ come in a variety of formats, but most view templates are HTML with embedded
33
+ Ruby code (ERB files). Views are typically rendered to generate a controller response,
34
+ or to generate the body of an email. In Rails, View generation is handled by Action View.
35
+ You can read more about Action View in its [README](actionview/README.rdoc).
36
+
37
+ Active Record, Action Pack, and Action View can each be used independently outside Rails.
38
+ In addition to them, Rails also comes with Action Mailer ([README](actionmailer/README.rdoc)), a library
39
+ to generate and send emails; Active Job ([README](activejob/README.md)), a
40
+ framework for declaring jobs and making them run on a variety of queueing
41
+ backends; and Active Support ([README](activesupport/README.rdoc)), a collection
42
+ of utility classes and standard library extensions that are useful for Rails,
43
+ and may also be used independently outside Rails.
44
+
45
+ ## Getting Started
46
+
47
+ 1. Install Rails at the command prompt if you haven't yet:
48
+
49
+ gem install rails
50
+
51
+ 2. At the command prompt, create a new Rails application:
52
+
53
+ rails new myapp
54
+
55
+ where "myapp" is the application name.
56
+
57
+ 3. Change directory to `myapp` and start the web server:
58
+
59
+ cd myapp
60
+ rails server
61
+
62
+ Run with `--help` or `-h` for options.
63
+
64
+ 4. Using a browser, go to `http://localhost:3000` and you'll see:
65
+ "Welcome aboard: You're riding Ruby on Rails!"
66
+
67
+ 5. Follow the guidelines to start developing your application. You may find
68
+ the following resources handy:
69
+ * [Getting Started with Rails](http://guides.rubyonrails.org/getting_started.html)
70
+ * [Ruby on Rails Guides](http://guides.rubyonrails.org)
71
+ * [The API Documentation](http://api.rubyonrails.org)
72
+ * [Ruby on Rails Tutorial](http://www.railstutorial.org/book)
73
+
74
+ ## Contributing
75
+
76
+ We encourage you to contribute to Ruby on Rails! Please check out the
77
+ [Contributing to Ruby on Rails guide](http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html) for guidelines about how to proceed. [Join us!](http://contributors.rubyonrails.org)
78
+
79
+ ## Code Status
80
+
81
+ * [![Build Status](https://travis-ci.org/rails/rails.svg?branch=4-2-stable)](https://travis-ci.org/rails/rails)
82
+
83
+ ## License
84
+
85
+ Ruby on Rails is released under the [MIT License](http://www.opensource.org/licenses/MIT).
@@ -0,0 +1,103 @@
1
+ ## Rails 4.2.11.1 (March 11, 2019) ##
2
+
3
+ * No changes.
4
+
5
+
6
+ ## Rails 4.2.11 (November 27, 2018) ##
7
+
8
+ * No changes.
9
+
10
+
11
+ ## Rails 4.2.10 (September 27, 2017) ##
12
+
13
+ * No changes.
14
+
15
+
16
+ ## Rails 4.2.9 (June 26, 2017) ##
17
+
18
+ * No changes.
19
+
20
+
21
+ ## Rails 4.2.8 (February 21, 2017) ##
22
+
23
+ * No changes.
24
+
25
+
26
+ ## Rails 4.2.7 (July 12, 2016) ##
27
+
28
+ * No changes.
29
+
30
+
31
+ ## Rails 4.2.6 (March 07, 2016) ##
32
+
33
+ * No changes.
34
+
35
+
36
+ ## Rails 4.2.5.2 (February 26, 2016) ##
37
+
38
+ * No changes.
39
+
40
+
41
+ ## Rails 4.2.5.1 (January 25, 2016) ##
42
+
43
+ * No changes.
44
+
45
+
46
+ ## Rails 4.2.5 (November 12, 2015) ##
47
+
48
+ * No changes.
49
+
50
+
51
+ ## Rails 4.2.4 (August 24, 2015) ##
52
+
53
+ * No Changes *
54
+
55
+
56
+ ## Rails 4.2.3 (June 25, 2015) ##
57
+
58
+ * No Changes *
59
+
60
+
61
+ ## Rails 4.2.2 (June 16, 2015) ##
62
+
63
+ * No Changes *
64
+
65
+
66
+ ## Rails 4.2.1 (March 19, 2015) ##
67
+
68
+ * No changes.
69
+
70
+
71
+ ## Rails 4.2.0 (December 20, 2014) ##
72
+
73
+ * New guide about constant autoloading and reloading.
74
+
75
+ *Xavier Noria*
76
+
77
+ * Change Posts to Articles in Getting Started sample application in order to
78
+ better align with the actual guides.
79
+
80
+ *John Kelly Ferguson*
81
+
82
+ * Update all Rails 4.1.0 references to 4.1.1 within the guides and code.
83
+
84
+ *John Kelly Ferguson*
85
+
86
+ * Split up rows in the Explain Queries table of the ActiveRecord Querying section
87
+ in order to improve readability.
88
+
89
+ *John Kelly Ferguson*
90
+
91
+ * Change all non-HTTP method 'post' references to 'article'.
92
+
93
+ *John Kelly Ferguson*
94
+
95
+ * Updates the maintenance policy to match the latest versions of Rails
96
+
97
+ *Matias Korhonen*
98
+
99
+ * Switched the order of `Applying a default scope` and `Merging of scopes` subsections so default scopes are introduced first.
100
+
101
+ *Alex Riabov*
102
+
103
+ Please check [4-1-stable](https://github.com/rails/rails/blob/4-1-stable/guides/CHANGELOG.md) for previous changes.
@@ -0,0 +1,92 @@
1
+ namespace :guides do
2
+
3
+ desc 'Generate guides (for authors), use ONLY=foo to process just "foo.md"'
4
+ task :generate => 'generate:html'
5
+
6
+ # Guides are written in UTF-8, but the environment may be configured for some
7
+ # other locale, these tasks are responsible for ensuring the default external
8
+ # encoding is UTF-8.
9
+ #
10
+ # Real use cases: Generation was reported to fail on a machine configured with
11
+ # GBK (Chinese). The docs server once got misconfigured somehow and had "C",
12
+ # which broke generation too.
13
+ task :encoding do
14
+ %w(LANG LANGUAGE LC_ALL).each do |env_var|
15
+ ENV[env_var] = "en_US.UTF-8"
16
+ end
17
+ end
18
+
19
+ namespace :generate do
20
+
21
+ desc "Generate HTML guides"
22
+ task :html => :encoding do
23
+ ENV["WARN_BROKEN_LINKS"] = "1" # authors can't disable this
24
+ ruby "rails_guides.rb"
25
+ end
26
+
27
+ desc "Generate .mobi file. The kindlegen executable must be in your PATH. You can get it for free from http://www.amazon.com/kindlepublishing"
28
+ task :kindle => :encoding do
29
+ unless `kindlerb -v 2> /dev/null` =~ /kindlerb 0.1.1/
30
+ abort "Please `gem install kindlerb` and make sure you have `kindlegen` in your PATH"
31
+ end
32
+ unless `convert` =~ /convert/
33
+ abort "Please install ImageMagick`"
34
+ end
35
+ ENV['KINDLE'] = '1'
36
+ Rake::Task['guides:generate:html'].invoke
37
+ end
38
+ end
39
+
40
+ # Validate guides -------------------------------------------------------------------------
41
+ desc 'Validate guides, use ONLY=foo to process just "foo.html"'
42
+ task :validate => :encoding do
43
+ ruby "w3c_validator.rb"
44
+ end
45
+
46
+ desc "Show help"
47
+ task :help do
48
+ puts <<-help
49
+
50
+ Guides are taken from the source directory, and the result goes into the
51
+ output directory. Assets are stored under files, and copied to output/files as
52
+ part of the generation process.
53
+
54
+ You can generate HTML, Kindle or both formats using the `guides:generate` task.
55
+
56
+ All this process is handled via rake tasks, here's a full list of them:
57
+
58
+ #{%x[rake -T]}
59
+ Some arguments may be passed via environment variables:
60
+
61
+ WARNINGS=1
62
+ Internal links (anchors) are checked, also detects duplicated IDs.
63
+
64
+ ALL=1
65
+ Force generation of all guides.
66
+
67
+ ONLY=name
68
+ Useful if you want to generate only one or a set of guides.
69
+
70
+ Generate only association_basics.html:
71
+ ONLY=assoc
72
+
73
+ Separate many using commas:
74
+ ONLY=assoc,migrations
75
+
76
+ GUIDES_LANGUAGE
77
+ Use it when you want to generate translated guides in
78
+ source/<GUIDES_LANGUAGE> folder (such as source/es)
79
+
80
+ EDGE=1
81
+ Indicate generated guides should be marked as edge.
82
+
83
+ Examples:
84
+ $ rake guides:generate ALL=1
85
+ $ rake guides:generate EDGE=1
86
+ $ rake guides:generate:kindle EDGE=1
87
+ $ rake guides:generate GUIDES_LANGUAGE=es
88
+ help
89
+ end
90
+ end
91
+
92
+ task :default => 'guides:help'
@@ -0,0 +1,5 @@
1
+ Replaced the plain DocBook XSL admonition icons with Jimmac's DocBook
2
+ icons (http://jimmac.musichall.cz/ikony.php3). I dropped transparency
3
+ from the Jimmac icons to get round MS IE and FOP PNG incompatibilities.
4
+
5
+ Stuart Rackham