railties 3.2.0.rc1 → 3.2.0.rc2

data/guides/source/caching_with_rails.textile

@@ -64,6 +64,28 @@ end
 
 If you want a more complicated expiration scheme, you can use cache sweepers to expire cached objects when things change. This is covered in the section on Sweepers.
 
+By default, page caching automatically gzips files (for example, to +products.html.gz+ if user requests +/products+) to reduce the size of data transmitted (web servers are typically configured to use a moderate compression ratio as a compromise, but since precompilation happens once, compression ratio is maximum).
+
+Nginx is able to serve compressed content directly from disk by enabling +gzip_static+:
+
+<plain>
+location /  {
+  gzip_static on; # to serve pre-gzipped version
+}
+</plain>
+
+You can disable gzipping by setting +:gzip+ option to false (for example, if action returns image):
+
+<ruby>
+caches_page :image, :gzip => false
+</ruby>
+
+Or, you can set custom gzip compression level (level names are taken from +Zlib+ constants):
+
+<ruby>
+caches_page :image, :gzip => :best_speed
+</ruby>
+
 NOTE: Page caching ignores all parameters. For example +/products?page=1+ will be written out to the filesystem as +products.html+ with no reference to the +page+ parameter. Thus, if someone requests +/products?page=2+ later, they will get the cached first page. A workaround for this limitation is to include the parameters in the page's path, e.g. +/productions/page/1+.
 
 INFO: Page caching runs in an after filter. Thus, invalid requests won't generate spurious cache entries as long as you halt them. Typically, a redirection in some before filter that checks request preconditions does the job.

data/guides/source/documents.yaml

@@ -0,0 +1,153 @@
+- 
+  name: Start Here
+  documents:
+    -
+      name: Getting Started with Rails
+      url: getting_started.html
+      description: Everything you need to know to install Rails and create your first application.
+-
+  name: Models
+  documents:
+    -
+      name: Rails Database Migrations
+      url: migrations.html
+      description: This guide covers how you can use Active Record migrations to alter your database in a structured and organized manner.
+    -
+      name: Active Record Validations and Callbacks
+      url: active_record_validations_callbacks.html
+      description: This guide covers how you can use Active Record validations and callbacks.
+    -
+      name: Active Record Associations
+      url: association_basics.html
+      description: This guide covers all the associations provided by Active Record.
+    -
+      name: Active Record Query Interface
+      url: active_record_querying.html
+      description: This guide covers the database query interface provided by Active Record.
+-
+  name: Views
+  documents:      
+    - 
+      name: Layouts and Rendering in Rails
+      url: layouts_and_rendering.html
+      description: This guide covers the basic layout features of Action Controller and Action View, including rendering and redirecting, using content_for blocks, and working with partials.
+    - 
+      name: Action View Form Helpers
+      url: form_helpers.html
+      description: Guide to using built-in Form helpers.
+-
+  name: Controllers
+  documents:
+    - 
+      name: Action Controller Overview
+      url: action_controller_overview.html
+      description: This guide covers how controllers work and how they fit into the request cycle in your application. It includes sessions, filters, and cookies, data streaming, and dealing with exceptions raised by a request, among other topics.
+    - 
+      name: Rails Routing from the Outside In
+      url: routing.html
+      description: This guide covers the user-facing features of Rails routing. If you want to understand how to use routing in your own Rails applications, start here.
+-
+  name: Digging Deeper
+  documents:
+    - 
+      name: Active Support Core Extensions
+      url: active_support_core_extensions.html
+      description: This guide documents the Ruby core extensions defined in Active Support.
+    - 
+      name: Rails Internationalization API
+      url: i18n.html
+      description: This guide covers how to add internationalization to your applications. Your application will be able to translate content to different languages, change pluralization rules, use correct date formats for each country and so on.
+    - 
+      name: Action Mailer Basics
+      url: action_mailer_basics.html
+      work_in_progress: true
+      description: This guide describes how to use Action Mailer to send and receive emails.
+    - 
+      name: Testing Rails Applications
+      url: testing.html
+      work_in_progress: true
+      description: This is a rather comprehensive guide to doing both unit and functional tests in Rails. It covers everything from 'What is a test?' to the testing APIs. Enjoy.
+    - 
+      name: Securing Rails Applications
+      url: security.html
+      description: This guide describes common security problems in web applications and how to avoid them with Rails.
+    - 
+      name: Debugging Rails Applications
+      url: debugging_rails_applications.html
+      description: This guide describes how to debug Rails applications. It covers the different ways of achieving this and how to understand what is happening "behind the scenes" of your code.
+    - 
+      name: Performance Testing Rails Applications
+      url: performance_testing.html
+      description: This guide covers the various ways of performance testing a Ruby on Rails application.
+    - 
+      name: Configuring Rails Applications
+      url: configuring.html
+      description: This guide covers the basic configuration settings for a Rails application.
+    - 
+      name: Rails Command Line Tools and Rake Tasks
+      url: command_line.html
+      description: This guide covers the command line tools and rake tasks provided by Rails.
+    - 
+      name: Caching with Rails
+      work_in_progress: true
+      url: caching_with_rails.html
+      description: Various caching techniques provided by Rails.
+    - 
+      name: Asset Pipeline
+      url: asset_pipeline.html
+      description: This guide documents the asset pipeline.
+    - 
+      name: The Rails Initialization Process
+      work_in_progress: true
+      url: initialization.html
+      description: This guide explains the internals of the Rails initialization process as of Rails 3.1
+-
+  name: Extending Rails
+  documents:
+    - 
+      name: The Basics of Creating Rails Plugins
+      work_in_progress: true
+      url: plugins.html
+      description: This guide covers how to build a plugin to extend the functionality of Rails.
+    - 
+      name: Rails on Rack
+      url: rails_on_rack.html
+      description: This guide covers Rails integration with Rack and interfacing with other Rack components.
+    - 
+      name: Creating and Customizing Rails Generators
+      url: generators.html
+      description: This guide covers the process of adding a brand new generator to your extension or providing an alternative to an element of a built-in Rails generator (such as providing alternative test stubs for the scaffold generator).
+-
+  name: Contributing to Ruby on Rails
+  documents:
+    - 
+      name: Contributing to Ruby on Rails
+      url: contributing_to_ruby_on_rails.html
+      description: Rails is not 'somebody else's framework.' This guide covers a variety of ways that you can get involved in the ongoing development of Rails.
+    - 
+      name: API Documentation Guidelines
+      url: api_documentation_guidelines.html
+      description: This guide documents the Ruby on Rails API documentation guidelines.
+    - 
+      name: Ruby on Rails Guides Guidelines
+      url: ruby_on_rails_guides_guidelines.html
+      description: This guide documents the Ruby on Rails guides guidelines.
+-
+  name: Release Notes
+  documents:
+    - 
+      name: Ruby on Rails 3.1 Release Notes
+      url: 3_1_release_notes.html
+      description: Release notes for Rails 3.1.
+    - 
+      name: Ruby on Rails 3.0 Release Notes
+      url: 3_0_release_notes.html
+      description: Release notes for Rails 3.0.
+    - 
+      name: Ruby on Rails 2.3 Release Notes
+      url: 2_3_release_notes.html
+      description: Release notes for Rails 2.3.
+    - 
+      name: Ruby on Rails 2.2 Release Notes
+      url: 2_2_release_notes.html
+      description: Release notes for Rails 2.2.

data/guides/source/getting_started.textile

@@ -814,8 +814,7 @@ and links. A few things to note in the view:
 
 NOTE. In previous versions of Rails, you had to use +<%=h post.name %>+ so
 that any HTML would be escaped before being inserted into the page. In Rails
-3.0+, this is now the default. To get unescaped HTML, you now use +<%= raw
-post.name %>+.
+3 and above, this is now the default. To get unescaped HTML, you now use <tt>&lt;%= raw post.name %&gt;</tt>.
 
 TIP: For more details on the rendering process, see "Layouts and Rendering in
 Rails":layouts_and_rendering.html.
@@ -828,7 +827,7 @@ Rails renders a view to the browser, it does so by putting the view's HTML into
 a layout's HTML. In previous versions of Rails, the +rails generate scaffold+
 command would automatically create a controller specific layout, like
 +app/views/layouts/posts.html.erb+, for the posts controller. However this has
-been changed in Rails 3.0+. An application specific +layout+ is used for all the
+been changed in Rails 3. An application specific +layout+ is used for all the
 controllers and can be found in +app/views/layouts/application.html.erb+. Open
 this layout in your editor and modify the +body+ tag to include the style directive
 below:
@@ -1873,7 +1872,6 @@ free to consult these support resources:
 * The "Ruby on Rails Tutorial":http://railstutorial.org/book
 * The "Ruby on Rails mailing list":http://groups.google.com/group/rubyonrails-talk
 * The "#rubyonrails":irc://irc.freenode.net/#rubyonrails channel on irc.freenode.net
-* The "Rails Wiki":http://wiki.rubyonrails.org/
 
 Rails also comes with built-in help that you can generate using the rake command-line utility:
 

data/guides/source/index.html.erb

@@ -3,189 +3,28 @@ Ruby on Rails Guides
 <% end %>
 
 <% content_for :header_section do %>
-<h2>Ruby on Rails Guides (<%= ENV['RAILS_VERSION'] || 'edge' %>)</h2>
-
-<% if @edge %>
-<p>
-  These are <b>Edge Guides</b>, based on the current
-  <a href="https://github.com/rails/rails/tree/master">master branch</a>.
-</p>
-<p>
-  If you are looking for the ones for the stable version please check
-  <a href="http://guides.rubyonrails.org">http://guides.rubyonrails.org</a> instead.
-</p>
-<% else %>
-<p>
-  These are the new guides for Rails 3. The guides for Rails 2.3 are still available
-  at <a href="http://guides.rubyonrails.org/v2.3.11/">http://guides.rubyonrails.org/v2.3.11/</a>.
-</p>
-<% end %>
-<p>
-  These guides are designed to make you immediately productive with Rails,
-  and to help you understand how all of the pieces fit together.
-</p>
-
+<%= render 'welcome' %>
 <% end %>
 
 <% content_for :index_section do %>
 <div id="subCol">
   <dl>
+    <dd class="kindle">Rails Guides are also available for the <%= link_to 'Kindle', 'https://kindle.amazon.com' %>
+and <%= link_to 'Free Kindle Reading Apps', 'http://www.amazon.com/gp/kindle/kcp' %> for the iPad,
+iPhone, Mac, Android, etc. Download them from <%= link_to 'here', @mobi %>.
+    </dd>
     <dd class="work-in-progress">Guides marked with this icon are currently being worked on. While they might still be useful to you, they may contain incomplete information and even errors. You can help by reviewing them and posting your comments and corrections to the author.</dd>
   </dl>
 </div>
 <% end %>
 
-<h3>Start Here</h3>
-
-<dl>
-<%= guide('Getting Started with Rails', 'getting_started.html') do %>
-  <p>Everything you need to know to install Rails and create your first application.</p>
-<% end %>
-</dl>
-
-<h3>Models</h3>
-
-<dl>
-<%= guide("Rails Database Migrations", 'migrations.html') do %>
-  <p>This guide covers how you can use Active Record migrations to alter your database in a structured and organized manner.</p>
-<% end %>
-
-<%= guide("Active Record Validations and Callbacks", 'active_record_validations_callbacks.html') do %>
-  <p>This guide covers how you can use Active Record validations and callbacks.</p>
-<% end %>
-
-<%= guide("Active Record Associations", 'association_basics.html') do %>
-  <p>This guide covers all the associations provided by Active Record.</p>
-<% end %>
-
-<%= guide("Active Record Query Interface", 'active_record_querying.html') do %>
-  <p>This guide covers the database query interface provided by Active Record.</p>
-<% end %>
-</dl>
-
-<h3>Views</h3>
-
-<dl>
-<%= guide("Layouts and Rendering in Rails", 'layouts_and_rendering.html') do %>
-  <p>This guide covers the basic layout features of Action Controller and Action View, including rendering and redirecting, using content_for blocks, and working with partials.</p>
-<% end %>
-
-<%= guide("Action View Form Helpers", 'form_helpers.html', :work_in_progress => true) do %>
-  <p>Guide to using built-in Form helpers.</p>
-<% end %>
-</dl>
-
-<h3>Controllers</h3>
-
-<dl>
-<%= guide("Action Controller Overview", 'action_controller_overview.html') do %>
-  <p>This guide covers how controllers work and how they fit into the request cycle in your application. It includes sessions, filters, and cookies, data streaming, and dealing with exceptions raised by a request, among other topics.</p>
-<% end %>
-
-<%= guide("Rails Routing from the Outside In", 'routing.html') do %>
-  <p>This guide covers the user-facing features of Rails routing. If you want to understand how to use routing in your own Rails applications, start here.</p>
-<% end %>
-</dl>
-
-<h3>Digging Deeper</h3>
-
-<dl>
-
-<%= guide("Active Support Core Extensions", 'active_support_core_extensions.html') do %>
-  <p>This guide documents the Ruby core extensions defined in Active Support.</p>
-<% end %>
-
-<%= guide("Rails Internationalization API", 'i18n.html') do %>
-  <p>This guide covers how to add internationalization to your applications. Your application will be able to translate content to different languages, change pluralization rules, use correct date formats for each country and so on.</p>
-<% end %>
-
-<%= guide("Action Mailer Basics", 'action_mailer_basics.html', :work_in_progress => true) do %>
-  <p>This guide describes how to use Action Mailer to send and receive emails.</p>
-<% end %>
-
-<%= guide("Testing Rails Applications", 'testing.html', :work_in_progress => true) do %>
-  <p>This is a rather comprehensive guide to doing both unit and functional tests in Rails. It covers everything from &quot;What is a test?&quot; to the testing APIs. Enjoy.</p>
-<% end %>
-
-<%= guide("Securing Rails Applications", 'security.html') do %>
-  <p>This guide describes common security problems in web applications and how to avoid them with Rails.</p>
-<% end %>
-
-<%= guide("Debugging Rails Applications", 'debugging_rails_applications.html') do %>
-  <p>This guide describes how to debug Rails applications. It covers the different ways of achieving this and how to understand what is happening "behind the scenes" of your code.</p>
-<% end %>
-
-<%= guide("Performance Testing Rails Applications", 'performance_testing.html') do %>
-  <p>This guide covers the various ways of performance testing a Ruby on Rails application.</p>
-<% end %>
-
-<%= guide("Configuring Rails Applications", 'configuring.html') do %>
-  <p>This guide covers the basic configuration settings for a Rails application.</p>
-<% end %>
-
-<%= guide("Rails Command Line Tools and Rake tasks", 'command_line.html') do %>
-  <p>This guide covers the command line tools and rake tasks provided by Rails.</p>
-<% end %>
-
-<%= guide("Caching with Rails", 'caching_with_rails.html', :work_in_progress => true) do %>
-  <p>Various caching techniques provided by Rails.</p>
-<% end %>
-
-<%= guide('Asset Pipeline', 'asset_pipeline.html') do %>
-  <p>This guide documents the asset pipeline.</p>
-<% end %>
-</dl>
-
-<h3>Extending Rails</h3>
-
-<dl>
-  <%= guide("The Basics of Creating Rails Plugins", 'plugins.html', :work_in_progress => true) do %>
-    <p>This guide covers how to build a plugin to extend the functionality of Rails.</p>
-  <% end %>
-
-  <%= guide("Rails on Rack", 'rails_on_rack.html') do %>
-    <p>This guide covers Rails integration with Rack and interfacing with other Rack components.</p>
-  <% end %>
-
-  <%= guide("Creating and Customizing Rails Generators", 'generators.html') do %>
-    <p>This guide covers the process of adding a brand new generator to your extension
-      or providing an alternative to an element of a built-in Rails generator (such as
-      providing alternative test stubs for the scaffold generator).</p>
-  <% end %>
-</dl>
-
-<h3>Contributing to Ruby on Rails</h3>
-
-<dl>
-  <%= guide("Contributing to Ruby on Rails", 'contributing_to_ruby_on_rails.html') do %>
-    <p>Rails is not &quot;somebody else's framework.&quot; This guide covers a variety of ways that you can get involved in the ongoing development of Rails.</p>
-  <% end %>
-
-  <%= guide('API Documentation Guidelines', 'api_documentation_guidelines.html') do %>
-    <p>This guide documents the Ruby on Rails API documentation guidelines.</p>
-  <% end %>
-
-  <%= guide('Ruby on Rails Guides Guidelines', 'ruby_on_rails_guides_guidelines.html') do %>
-    <p>This guide documents the Ruby on Rails guides guidelines.</p>
-  <% end %>
-</dl>
-
-<h3>Release Notes</h3>
-
-<dl>
-<%= guide("Ruby on Rails 3.1 Release Notes", '3_1_release_notes.html') do %>
-  <p>Release notes for Rails 3.1.</p>
-<% end %>
-
-<%= guide("Ruby on Rails 3.0 Release Notes", '3_0_release_notes.html') do %>
-  <p>Release notes for Rails 3.0.</p>
-<% end %>
-
-<%= guide("Ruby on Rails 2.3 Release Notes", '2_3_release_notes.html') do %>
-  <p>Release notes for Rails 2.3.</p>
-<% end %>
-
-<%= guide("Ruby on Rails 2.2 Release Notes", '2_2_release_notes.html') do %>
-  <p>Release notes for Rails 2.2.</p>
+<% documents_by_section.each do |section| %>
+  <h3><%= section['name'] %></h3>
+  <dl>
+    <% section['documents'].each do |document| %>
+      <%= guide(document['name'], document['url'], :work_in_progress => document['work_in_progress']) do %>
+        <p><%= document['description'] %></p>
+      <% end %>
+    <% end %>
+  </dl>
 <% end %>
-</dl>

data/guides/source/kindle/KINDLE.md

@@ -0,0 +1,26 @@
+# Rails Guides on the Kindle
+
+
+## Synopsis
+
+  1. Obtain `kindlegen` from the link below and put the binary in your path
+  2. Run `KINDLE=1 rake generate_guides` to generate the guides and compile the `.mobi` file
+  3. Copy `output/kindle/rails_guides.mobi` to your Kindle
+
+## Resources
+
+  * [StackOverflow: Kindle Periodical Format](http://stackoverflow.com/questions/5379565/kindle-periodical-format)
+  * Example Periodical [.ncx](https://gist.github.com/808c971ed087b839d462) and [.opf](https://gist.github.com/d6349aa8488eca2ee6d0)
+  * [Kindle Publishing guidelines](http://kindlegen.s3.amazonaws.com/AmazonKindlePublishingGuidelines.pdf)
+  * [KindleGen & Kindle Previewer](http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000234621) 
+
+## TODO
+
+### Post release
+
+  * Integrate generated Kindle document in to published HTML guides
+  * Tweak heading styles (most docs use h3/h4/h5, which end up being smaller than the text under it)
+  * Tweak table styles (smaller text? Many of the tables are unusable on a Kindle in portrait mode)
+  * Have the HTML/XML TOC 'drill down' into the TOCs of the individual guides
+  * `.epub` generation.
+

data/guides/source/kindle/copyright.html.erb

@@ -0,0 +1 @@
+<%= render 'license' %>

data/guides/source/kindle/layout.html.erb

@@ -0,0 +1,27 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<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"/>
+
+<title><%= yield(:page_title) || 'Ruby on Rails Guides' %></title>
+
+<link rel="stylesheet" type="text/css" href="stylesheets/kindle.css" />
+
+</head>
+<body class="guide">
+
+  <% if content_for? :header_section %>
+    <%= yield :header_section %>
+    <div class="pagebreak">
+  <% end %>
+
+  <% if content_for? :index_section %>
+    <%= yield :index_section %>
+    <div class="pagebreak">
+  <% end %>
+
+  <%= yield.html_safe %>
+</body>
+</html>