RubyGems - rails - Versions diffs - 4.0.0 → 4.2.11.3 - Mend

rails 4.0.0 → 4.2.11.3

Files changed (190) hide show

data/guides/source/kindle/toc.html.erb CHANGED Viewed

@@ -20,5 +20,5 @@ Ruby on Rails Guides
 <ul>
   <li><a href="credits.html">Credits</a></li>
   <li><a href="copyright.html">Copyright &amp; License</a></li>
-<ul>
+</ul>
 </div>

data/guides/source/layout.html.erb CHANGED Viewed

@@ -1,10 +1,9 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
-<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title><%= yield(:page_title) || 'Ruby on Rails Guides' %></title>
 <link rel="stylesheet" type="text/css" href="stylesheets/style.css" />
@@ -30,15 +29,11 @@
         More Ruby on Rails
       </span>
       <ul class="more-info-links s-hidden">
-        <li class="more-info"><a href="http://rubyonrails.org/">Overview</a></li>
-        <li class="more-info"><a href="http://rubyonrails.org/download">Download</a></li>
-        <li class="more-info"><a href="http://rubyonrails.org/deploy">Deploy</a></li>
-        <li class="more-info"><a href="https://github.com/rails/rails">Code</a></li>
-        <li class="more-info"><a href="http://rubyonrails.org/screencasts">Screencasts</a></li>
-        <li class="more-info"><a href="http://rubyonrails.org/documentation">Documentation</a></li>
-        <li class="more-info"><a href="http://rubyonrails.org/ecosystem">Ecosystem</a></li>
-        <li class="more-info"><a href="http://rubyonrails.org/community">Community</a></li>
         <li class="more-info"><a href="http://weblog.rubyonrails.org/">Blog</a></li>
+        <li class="more-info"><a href="http://guides.rubyonrails.org/">Guides</a></li>
+        <li class="more-info"><a href="http://api.rubyonrails.org/">API</a></li>
+        <li class="more-info"><a href="http://stackoverflow.com/questions/tagged/ruby-on-rails">Ask for help</a></li>
+        <li class="more-info"><a href="https://github.com/rails/rails">Contribute on GitHub</a></li>
       </ul>
     </div>
   </div>
@@ -48,7 +43,7 @@
       <ul class="nav">
         <li><a class="nav-item" href="index.html">Home</a></li>
         <li class="guides-index guides-index-large">
-          <a href="index.html" onclick="guideMenu(); return false;" id="guidesMenu" class="guides-index-item nav-item">Guides Index</a>
+          <a href="index.html" id="guidesMenu" class="guides-index-item nav-item">Guides Index</a>
           <div id="guides" class="clearfix" style="display: none;">
             <hr />
             <% ['L', 'R'].each do |position| %>
@@ -78,7 +73,6 @@
           </select>
         </li>
       </ul>
-      </div>
     </div>
   </div>
   <hr class="hide" />
@@ -101,17 +95,15 @@
           You're encouraged to help improve the quality of this guide.
         </p>
         <p>
-          If you see any typos or factual errors you are confident to
-          patch, please clone the <%= link_to 'rails', 'https://github.com/rails/rails' %>
-          repository and open a new pull request. You can also ask for commit rights on
-          <%= link_to 'docrails', 'https://github.com/rails/docrails' %> if you plan to submit
-          several patches. Commits are reviewed, but that happens after you've submitted your
-          contribution. This repository is cross-merged with master periodically.
+          Please contribute if you see any typos or factual errors.
+          To get started, you can read our <%= link_to 'documentation contributions', 'http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#contributing-to-the-rails-documentation' %> section.
         </p>
         <p>
           You may also find incomplete content, or stuff that is not up to date.
-          Please do add any missing documentation for master. Check the
-          <%= link_to 'Ruby on Rails Guides Guidelines', 'ruby_on_rails_guides_guidelines.html' %>
+          Please do add any missing documentation for master. Make sure to check
+          <%= link_to 'Edge Guides','http://edgeguides.rubyonrails.org' %> first to verify
+          if the issues are already fixed or not on the master branch.
+          Check the <%= link_to 'Ruby on Rails Guides Guidelines', 'ruby_on_rails_guides_guidelines.html' %>
           for style and conventions.
         </p>
         <p>
@@ -141,7 +133,7 @@
   <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushSql.js"></script>
   <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushPlain.js"></script>
   <script type="text/javascript">
-    SyntaxHighlighter.all()
+    SyntaxHighlighter.all();
     $(guidesIndex.bind);
   </script>
 </body>

data/guides/source/layouts_and_rendering.md CHANGED Viewed

@@ -88,7 +88,7 @@ If we want to display the properties of all the books in our view, we can do so
 <% end %>
 </table>
-<br />
+<br>
 <%= link_to "New book", new_book_path %>
 ```
@@ -122,8 +122,7 @@ X-Runtime: 0.014297
 Set-Cookie: _blog_session=...snip...; path=/; HttpOnly
 Cache-Control: no-cache
- $
+$
 ```
 We see there is an empty response (no data after the `Cache-Control` line), but the request was successful because Rails has set the response to 200 OK. You can set the `:status` option on render to change this response. Rendering nothing can be useful for Ajax requests where all you want to send back to the browser is an acknowledgment that the request was completed.
@@ -137,7 +136,7 @@ If you want to render the view that corresponds to a different template within t
 ```ruby
 def update
   @book = Book.find(params[:id])
-  if @book.update(params[:book])
+  if @book.update(book_params)
     redirect_to(@book)
   else
     render "edit"
@@ -152,7 +151,7 @@ If you prefer, you can use a symbol instead of a string to specify the action to
 ```ruby
 def update
   @book = Book.find(params[:id])
-  if @book.update(params[:book])
+  if @book.update(book_params)
     redirect_to(@book)
   else
     render :edit
@@ -176,23 +175,22 @@ render template: "products/show"
 #### Rendering an Arbitrary File
-The `render` method can also use a view that's entirely outside of your application (perhaps you're sharing views between two Rails applications):
-```ruby
-render "/u/apps/warehouse_app/current/app/views/products/show"
-```
-Rails determines that this is a file render because of the leading slash character. To be explicit, you can use the `:file` option (which was required on Rails 2.2 and earlier):
+The `render` method can also use a view that's entirely outside of your application:
 ```ruby
 render file: "/u/apps/warehouse_app/current/app/views/products/show"
 ```
-The `:file` option takes an absolute file-system path. Of course, you need to have rights to the view that you're using to render the content.
+The `:file` option takes an absolute file-system path. Of course, you need to have rights
+to the view that you're using to render the content.
-NOTE: By default, the file is rendered without using the current layout. If you want Rails to put the file into the current layout, you need to add the `layout: true` option.
+NOTE: Using the `:file` option in combination with users input can lead to security problems
+since an attacker could use this action to access security sensitive files in your file system.
-TIP: If you're running Rails on Microsoft Windows, you should use the `:file` option to render a file, because Windows filenames do not have the same format as Unix filenames.
+NOTE: By default, the file is rendered using the current layout.
+TIP: If you're running Rails on Microsoft Windows, you should use the `:file` option to
+render a file, because Windows filenames do not have the same format as Unix filenames.
 #### Wrapping it up
@@ -237,15 +235,35 @@ render inline: "xml.p {'Horrid coding practice!'}", type: :builder
 #### Rendering Text
-You can send plain text - with no markup at all - back to the browser by using the `:text` option to `render`:
+You can send plain text - with no markup at all - back to the browser by using
+the `:plain` option to `render`:
+```ruby
+render plain: "OK"
+```
+TIP: Rendering pure text is most useful when you're responding to Ajax or web
+service requests that are expecting something other than proper HTML.
+NOTE: By default, if you use the `:plain` option, the text is rendered without
+using the current layout. If you want Rails to put the text into the current
+layout, you need to add the `layout: true` option and use the `.txt.erb`
+extension for the layout file.
+#### Rendering HTML
+You can send a HTML string back to the browser by using the `:html` option to
+`render`:
 ```ruby
-render text: "OK"
+render html: "<strong>Not Found</strong>".html_safe
 ```
-TIP: Rendering pure text is most useful when you're responding to Ajax or web service requests that are expecting something other than proper HTML.
+TIP: This is useful when you're rendering a small snippet of HTML code.
+However, you might want to consider moving it to a template file if the markup
+is complex.
-NOTE: By default, if you use the `:text` option, the text is rendered without using the current layout. If you want Rails to put the text into the current layout, you need to add the `layout: true` option.
+NOTE: This option will escape HTML entities if the string is not HTML safe.
 #### Rendering JSON
@@ -277,6 +295,22 @@ render js: "alert('Hello Rails');"
 This will send the supplied string to the browser with a MIME type of `text/javascript`.
+#### Rendering raw body
+You can send a raw content back to the browser, without setting any content
+type, by using the `:body` option to `render`:
+```ruby
+render body: "raw"
+```
+TIP: This option should be used only if you don't care about the content type of
+the response. Using `:plain` or `:html` might be more appropriate in most of the
+time.
+NOTE: Unless overridden, your response returned from this render option will be
+`text/html`, as that is the default content type of Action Dispatch response.
 #### Options for `render`
 Calls to the `render` method generally accept four options:
@@ -375,9 +409,9 @@ Rails understands both numeric status codes and the corresponding symbols shown
 |                     | 423              | :locked                          |
 |                     | 424              | :failed_dependency               |
 |                     | 426              | :upgrade_required                |
-|                     | 423              | :precondition_required           |
-|                     | 424              | :too_many_requests               |
-|                     | 426              | :request_header_fields_too_large |
+|                     | 428              | :precondition_required           |
+|                     | 429              | :too_many_requests               |
+|                     | 431              | :request_header_fields_too_large |
 | **Server Error**    | 500              | :internal_server_error           |
 |                     | 501              | :not_implemented                 |
 |                     | 502              | :bad_gateway                     |
@@ -405,7 +439,7 @@ class ProductsController < ApplicationController
 end
 ```
-With this declaration, all of the views rendered by the products controller will use `app/views/layouts/inventory.html.erb` as their layout.
+With this declaration, all of the views rendered by the `ProductsController` will use `app/views/layouts/inventory.html.erb` as their layout.
 To assign a specific layout for the entire application, use a `layout` declaration in your `ApplicationController` class:
@@ -472,33 +506,33 @@ Layout declarations cascade downward in the hierarchy, and more specific layout
     end
     ```
-* `posts_controller.rb`
+* `articles_controller.rb`
     ```ruby
-    class PostsController < ApplicationController
+    class ArticlesController < ApplicationController
     end
     ```
-* `special_posts_controller.rb`
+* `special_articles_controller.rb`
     ```ruby
-    class SpecialPostsController < PostsController
+    class SpecialArticlesController < ArticlesController
       layout "special"
     end
     ```
-* `old_posts_controller.rb`
+* `old_articles_controller.rb`
     ```ruby
-    class OldPostsController < SpecialPostsController
+    class OldArticlesController < SpecialArticlesController
       layout false
       def show
-        @post = Post.find(params[:id])
+        @article = Article.find(params[:id])
       end
       def index
-        @old_posts = Post.older
+        @old_articles = Article.older
         render layout: "old"
       end
       # ...
@@ -508,10 +542,10 @@ Layout declarations cascade downward in the hierarchy, and more specific layout
 In this application:
 * In general, views will be rendered in the `main` layout
-* `PostsController#index` will use the `main` layout
-* `SpecialPostsController#index` will use the `special` layout
-* `OldPostsController#show` will use no layout at all
-* `OldPostsController#index` will use the `old` layout
+* `ArticlesController#index` will use the `main` layout
+* `SpecialArticlesController#index` will use the `special` layout
+* `OldArticlesController#show` will use no layout at all
+* `OldArticlesController#index` will use the `old` layout
 #### Avoiding Double Render Errors
@@ -592,7 +626,7 @@ def index
 end
 def show
-  @book = Book.find_by_id(params[:id])
+  @book = Book.find_by(id: params[:id])
   if @book.nil?
     render action: "index"
   end
@@ -607,7 +641,7 @@ def index
 end
 def show
-  @book = Book.find_by_id(params[:id])
+  @book = Book.find_by(id: params[:id])
   if @book.nil?
     redirect_to action: :index
   end
@@ -626,10 +660,10 @@ def index
 end
 def show
-  @book = Book.find_by_id(params[:id])
+  @book = Book.find_by(id: params[:id])
   if @book.nil?
     @books = Book.all
-    flash[:alert] = "Your book was not found"
+    flash.now[:alert] = "Your book was not found"
     render "index"
   end
 end
@@ -704,7 +738,7 @@ WARNING: The asset tag helpers do _not_ verify the existence of the assets at th
 #### Linking to Feeds with the `auto_discovery_link_tag`
-The `auto_discovery_link_tag` helper builds HTML that most browsers and newsreaders can use to detect the presence of RSS or Atom feeds. It takes the type of the link (`:rss` or `:atom`), a hash of options that are passed through to url_for, and a hash of options for the tag:
+The `auto_discovery_link_tag` helper builds HTML that most browsers and feed readers can use to detect the presence of RSS or Atom feeds. It takes the type of the link (`:rss` or `:atom`), a hash of options that are passed through to url_for, and a hash of options for the tag:
 ```erb
 <%= auto_discovery_link_tag(:rss, {action: "feed"},
@@ -869,7 +903,7 @@ You can also specify multiple videos to play by passing an array of videos to th
 This will produce:
 ```erb
-<video><source src="trailer.ogg" /><source src="movie.ogg" /></video>
+<video><source src="/videos/trailer.ogg" /><source src="/videos/trailer.flv" /></video>
 ```
 #### Linking to Audio Files with the `audio_tag`
@@ -1009,7 +1043,6 @@ You can also pass local variables into partials, making them even more powerful
     ```html+erb
     <h1>New zone</h1>
-    <%= error_messages_for :zone %>
     <%= render partial: "form", locals: {zone: @zone} %>
     ```
@@ -1017,7 +1050,6 @@ You can also pass local variables into partials, making them even more powerful
     ```html+erb
     <h1>Editing zone</h1>
-    <%= error_messages_for :zone %>
     <%= render partial: "form", locals: {zone: @zone} %>
     ```
@@ -1026,7 +1058,7 @@ You can also pass local variables into partials, making them even more powerful
     ```html+erb
     <%= form_for(zone) do |f| %>
       <p>
-        <b>Zone name</b><br />
+        <b>Zone name</b><br>
         <%= f.text_field :name %>
       </p>
       <p>
@@ -1122,11 +1154,11 @@ With this change, you can access an instance of the `@products` collection as th
 You can also pass in arbitrary local variables to any partial you are rendering with the `locals: {}` option:
 ```erb
-<%= render partial: "products", collection: @products,
+<%= render partial: "product", collection: @products,
            as: :item, locals: {title: "Products Page"} %>
 ```
-Would render a partial `_products.html.erb` once for each instance of `product` in the `@products` instance variable passing the instance to the partial as a local variable called `item` and to each partial, make the local variable `title` available with the value `Products Page`.
+In this case, the partial will have access to a local variable `title` with the value "Products Page".
 TIP: Rails also makes a counter variable available within a partial called by the collection, named after the member of the collection followed by `_counter`. For example, if you're rendering `@products`, within the partial you can refer to `product_counter` to tell you how many times the partial has been rendered. This does not work in conjunction with the `as: :value` option.

data/guides/source/maintenance_policy.md ADDED Viewed

@@ -0,0 +1,78 @@
+Maintenance Policy for Ruby on Rails
+====================================
+Support of the Rails framework is divided into four groups: New features, bug
+fixes, security issues, and severe security issues. They are handled as
+follows, all versions in `X.Y.Z` format.
+--------------------------------------------------------------------------------
+Rails follows a shifted version of [semver](http://semver.org/):
+**Patch `Z`**
+Only bug fixes, no API changes, no new features.
+Except as necessary for security fixes.
+**Minor `Y`**
+New features, may contain API changes (Serve as major versions of Semver).
+Breaking changes are paired with deprecation notices in the previous minor
+or major release.
+**Major `X`**
+New features, will likely contain API changes. The difference between Rails'
+minor and major releases is the magnitude of breaking changes, and usually
+reserved for special occasions.
+New Features
+------------
+New features are only added to the master branch and will not be made available
+in point releases.
+Bug Fixes
+---------
+Only the latest release series will receive bug fixes. When enough bugs are
+fixed and its deemed worthy to release a new gem, this is the branch it happens
+from.
+In special situations, where someone from the Core Team agrees to support more series,
+they are included in the list of supported series.
+**Currently included series:** `4.2.Z`, `4.1.Z` (Supported by Rafael França).
+Security Issues
+---------------
+The current release series and the next most recent one will receive patches
+and new versions in case of a security issue.
+These releases are created by taking the last released version, applying the
+security patches, and releasing. Those patches are then applied to the end of
+the x-y-stable branch. For example, a theoretical 1.2.3 security release would
+be built from 1.2.2, and then added to the end of 1-2-stable. This means that
+security releases are easy to upgrade to if you're running the latest version
+of Rails.
+**Currently included series:** `4.2.Z`, `4.1.Z`.
+Severe Security Issues
+----------------------
+For severe security issues we will provide new versions as above, and also the
+last major release series will receive patches and new versions. The
+classification of the security issue is judged by the core team.
+**Currently included series:** `4.2.Z`, `4.1.Z`, `3.2.Z`.
+Unsupported Release Series
+--------------------------
+When a release series is no longer supported, it's your own responsibility to
+deal with bugs and security issues. We may provide backports of the fixes and
+publish them to git, however there will be no new versions released. If you are
+not comfortable maintaining your own versions, you should upgrade to a
+supported version.