rails 2.2.2 → 3.0.0

data/doc/guides/source/actioncontroller_basics/session.txt

@@ -1,187 +0,0 @@
-== Session ==
-
-Your application has a session for each user in which you can store small amounts of data that will be persisted between requests. The session is only available in the controller and the view and can use one of a number of different storage mechanisms:
-
- * CookieStore - Stores everything on the client.
- * DRbStore - Stores the data on a DRb server.
- * MemCacheStore - Stores the data in a memcache.
- * ActiveRecordStore - Stores the data in a database using Active Record.
-
-All session stores use a cookie - this is required and Rails does not allow any part of the session to be passed in any other way (e.g. you can't use the query string to pass a session ID) because of security concerns (it's easier to hijack a session when the ID is part of the URL).
-
-Most stores use a cookie to store the session ID which is then used to look up the session data on the server. The default and recommended store, the CookieStore, does not store session data on the server, but in the cookie itself. The data is cryptographically signed to make it tamper-proof, but it is not encrypted, so anyone with access to it can read its contents but not edit it (Rails will not accept it if it has been edited). It can only store about 4kB of data - much less than the others - but this is usually enough. Storing large amounts of data is discouraged no matter which session store your application uses. You should especially avoid storing complex objects (anything other than basic Ruby objects, the most common example being model instances) in the session, as the server might not be able to reassemble them between requests, which will result in an error. The CookieStore has the added advantage that it does not require any setting up beforehand - Rails will generate a "secret key" which will be used to sign the cookie when you create the application.
-
-Read more about session storage in the link:../security.html[Security Guide].
-
-If you need a different session storage mechanism, you can change it in the `config/environment.rb` file:
-
-[source, ruby]
-------------------------------------------
-# Set to one of [:active_record_store, :drb_store, :mem_cache_store, :cookie_store]
-config.action_controller.session_store = :active_record_store
-------------------------------------------
-
-=== Disabling the Session ===
-
-Sometimes you don't need a session. In this case, you can turn it off to avoid the unnecessary overhead. To do this, use the `session` class method in your controller:
-
-[source, ruby]
-------------------------------------------
-class ApplicationController < ActionController::Base
-  session :off
-end
-------------------------------------------
-
-You can also turn the session on or off for a single controller:
-
-[source, ruby]
-------------------------------------------
-# The session is turned off by default in ApplicationController, but we
-# want to turn it on for log in/out.
-class LoginsController < ActionController::Base
-  session :on
-end
-------------------------------------------
-
-Or even for specified actions:
-
-[source, ruby]
-------------------------------------------
-class ProductsController < ActionController::Base
-  session :on, :only => [:create, :update]
-end
-------------------------------------------
-
-=== Accessing the Session ===
-
-In your controller you can access the session through the `session` instance method.
-
-NOTE: There are two `session` methods, the class and the instance method. The class method which is described above is used to turn the session on and off while the instance method described below is used to access session values.
-
-Session values are stored using key/value pairs like a hash:
-
-[source, ruby]
-------------------------------------------
-class ApplicationController < ActionController::Base
-
-private
-
-  # Finds the User with the ID stored in the session with the key :current_user_id
-  # This is a common way to handle user login in a Rails application; logging in sets the
-  # session value and logging out removes it.
-  def current_user
-    @_current_user ||= session[:current_user_id] && User.find(session[:current_user_id])
-  end
-
-end
-------------------------------------------
-
-To store something in the session, just assign it to the key like a hash:
-
-[source, ruby]
-------------------------------------------
-class LoginsController < ApplicationController
-
-  # "Create" a login, aka "log the user in"
-  def create
-    if user = User.authenticate(params[:username, params[:password])
-      # Save the user ID in the session so it can be used in subsequent requests
-      session[:current_user_id] = user.id
-      redirect_to root_url
-    end
-  end
-
-end
-------------------------------------------
-
-To remove something from the session, assign that key to be `nil`:
-
-[source, ruby]
-------------------------------------------
-class LoginsController < ApplicationController
-
-  # "Delete" a login, aka "log the user out"
-  def destroy
-    # Remove the user id from the session
-    session[:current_user_id] = nil
-    redirect_to root_url
-  end
-
-end
-------------------------------------------
-
-To reset the entire session, use `reset_session`.
-
-=== The flash ===
-
-The flash is a special part of the session which is cleared with each request. This means that values stored there will only be available in the next request, which is useful for storing error messages etc. It is accessed in much the same way as the session, like a hash. Let's use the act of logging out as an example. The controller can send a message which will be displayed to the user on the next request:
-
-[source, ruby]
-------------------------------------------
-class LoginsController < ApplicationController
-
-  def destroy
-    session[:current_user_id] = nil
-    flash[:notice] = "You have successfully logged out"
-    redirect_to root_url
-  end
-
-end
-------------------------------------------
-
-The `destroy` action redirects to the application's `root_url`, where the message will be displayed. Note that it's entirely up to the next action to decide what, if anything, it will do with what the previous action put in the flash. It's conventional to display eventual errors or notices from the flash in the application's layout:
-
-------------------------------------------
-<html>
-  <!-- <head/> -->
-  <body>
-    <% if flash[:notice] -%>
-      <p class="notice"><%= flash[:notice] %></p>
-    <% end -%>
-    <% if flash[:error] -%>
-      <p class="error"><%= flash[:error] %></p>
-    <% end -%>
-    <!-- more content -->
-  </body>
-</html>
-------------------------------------------
-
-This way, if an action sets an error or a notice message, the layout will display it automatically.
-
-If you want a flash value to be carried over to another request, use the `keep` method:
-
-[source, ruby]
-------------------------------------------
-class MainController < ApplicationController
-
-  # Let's say this action corresponds to root_url, but you want all requests here to be redirected to
-  # UsersController#index. If an action sets the flash and redirects here, the values would normally be
-  # lost when another redirect happens, but you can use keep to make it persist for another request.
-  def index
-    flash.keep # Will persist all flash values. You can also use a key to keep only that value: flash.keep(:notice)
-    redirect_to users_url
-  end
-
-end
-------------------------------------------
-
-==== +flash.now+ ====
-
-By default, adding values to the flash will make them available to the next request, but sometimes you may want to access those values in the same request. For example, if the `create` action fails to save a resource and you render the `new` template directly, that's not going to result in a new request, but you may still want to display a message using the flash. To do this, you can use `flash.now` in the same way you use the normal `flash`:
-
-[source, ruby]
-------------------------------------------
-class ClientsController < ApplicationController
-
-  def create
-    @client = Client.new(params[:client])
-    if @client.save
-      # ...
-    else
-      flash.now[:error] = "Could not save client"
-      render :action => "new"
-    end
-  end
-
-end
-------------------------------------------

data/doc/guides/source/actioncontroller_basics/streaming.txt

@@ -1,91 +0,0 @@
-== Streaming and File Downloads ==
-
-Sometimes you may want to send a file to the user instead of rendering an HTML page. All controllers in Rails have the `send_data` and the `send_file` methods, that will both stream data to the client. `send_file` is a convenience method which lets you provide the name of a file on the disk and it will stream the contents of that file for you.
-
-To stream data to the client, use `send_data`:
-
-[source, ruby]
-----------------------------
-require "prawn"
-class ClientsController < ApplicationController
-
-  # Generate a PDF document with information on the client and return it.
-  # The user will get the PDF as a file download.
-  def download_pdf
-    client = Client.find(params[:id])
-    send_data(generate_pdf, :filename => "#{client.name}.pdf", :type => "application/pdf")
-  end
-
-private
-
-  def generate_pdf(client)
-    Prawn::Document.new do
-      text client.name, :align => :center
-      text "Address: #{client.address}"
-      text "Email: #{client.email}"
-    end.render
-  end
-
-end
-----------------------------
-
-The `download_pdf` action in the example above will call a private method which actually generates the file (a PDF document) and returns it as a string. This string will then be streamed to the client as a file download and a filename will be suggested to the user. Sometimes when streaming files to the user, you may not want them to download the file. Take images, for example, which can be embedded into HTML pages. To tell the browser a file is not meant to be downloaded, you can set the `:disposition` option to "inline". The opposite and default value for this option is "attachment".
-
-=== Sending Files ===
-
-If you want to send a file that already exists on disk, use the `send_file` method. This is usually not recommended, but can be useful if you want to perform some authentication before letting the user download the file.
-
-[source, ruby]
-----------------------------
-class ClientsController < ApplicationController
-
-  # Stream a file that has already been generated and stored on disk
-  def download_pdf
-    client = Client.find(params[:id])
-    send_data("#{RAILS_ROOT}/files/clients/#{client.id}.pdf", :filename => "#{client.name}.pdf", :type => "application/pdf")
-  end
-
-end
-----------------------------
-
-This will read and stream the file 4Kb at the time, avoiding loading the entire file into memory at once. You can turn off streaming with the `:stream` option or adjust the block size with the `:buffer_size` option.
-
-WARNING: Be careful when using (or just don't use) "outside" data (params, cookies, etc) to locate the file on disk, as this is a security risk that might allow someone to gain access to files they are not meant to see.
-
-TIP: It is not recommended that you stream static files through Rails if you can instead keep them in a public folder on your web server. It is much more efficient to let the user download the file directly using Apache or another web server, keeping the request from unnecessarily going through the whole Rails stack.
-
-=== RESTful Downloads ===
-
-While `send_data` works just fine, if you are creating a RESTful application having separate actions for file downloads is usually not necessary. In REST terminology, the PDF file from the example above can be considered just another representation of the client resource. Rails provides an easy and quite sleek way of doing "RESTful downloads". Here's how you can rewrite the example so that the PDF download is a part of the `show` action, without any streaming:
-
-[source, ruby]
-----------------------------
-class ClientsController < ApplicationController
-
-  # The user can request to receive this resource as HTML or PDF.
-  def show
-    @client = Client.find(params[:id])
-
-    respond_to do |format|
-      format.html
-      format.pdf{ render :pdf => generate_pdf(@client) }
-    end
-  end
-
-end
-----------------------------
-
-In order for this example to work, you have to add the PDF MIME type to Rails. This can be done by adding the following line to the file `config/initializers/mime_types.rb`:
-
-[source, ruby]
-----------------------------
-Mime::Type.register "application/pdf", :pdf
-----------------------------
-
-NOTE: Configuration files are not reloaded on each request, so you have to restart the server in order for their changes to take effect.
-
-Now the user can request to get a PDF version of a client just by adding ".pdf" to the URL:
-
-----------------------------
-GET /clients/1.pdf
-----------------------------

data/doc/guides/source/actioncontroller_basics/verification.txt

@@ -1,40 +0,0 @@
-== Verification ==
-
-Verifications make sure certain criteria are met in order for a controller or action to run. They can specify that a certain key (or several keys in the form of an array) is present in the `params`, `session` or `flash` hashes or that a certain HTTP method was used or that the request was made using XMLHTTPRequest (Ajax). The default action taken when these criteria are not met is to render a 400 Bad Request response, but you can customize this by specifying a redirect URL or rendering something else and you can also add flash messages and HTTP headers to the response. It is described in the link:http://api.rubyonrails.org/classes/ActionController/Verification/ClassMethods.html[API documentation] as "essentially a special kind of before_filter".
-
-Here's an example of using verification to make sure the user supplies a username and a password in order to log in:
-
-[source, ruby]
----------------------------------------
-class LoginsController < ApplicationController
-
-  verify :params => [:username, :password],
-         :render => {:action => "new"},
-         :add_flash => {:error => "Username and password required to log in"}
-
-  def create
-    @user = User.authenticate(params[:username], params[:password])
-    if @user
-      flash[:notice] = "You're logged in"
-      redirect_to root_url
-    else
-      render :action => "new"
-    end
-  end
-
-end
----------------------------------------
-
-Now the `create` action won't run unless the "username" and "password" parameters are present, and if they're not, an error message will be added to the flash and the "new" action will be rendered. But there's something rather important missing from the verification above: It will be used for *every* action in LoginsController, which is not what we want. You can limit which actions it will be used for with the `:only` and `:except` options just like a filter:
-
-[source, ruby]
----------------------------------------
-class LoginsController < ApplicationController
-
-  verify :params => [:username, :password],
-         :render => {:action => "new"},
-         :add_flash => {:error => "Username and password required to log in"},
-         :only => :create # Only run this verification for the "create" action
-
-end
----------------------------------------

data/doc/guides/source/active_record_basics.txt

@@ -1,181 +0,0 @@
-Active Record Basics
-====================
-
-Active Record is a design pattern that mitigates the mind-numbing mental gymnastics often needed to get your application to communicate with a database. This guide uses a mix of real-world examples, metaphors and detailed explanations of the actual Rails source code to help you make the most of ActiveRecord.
-
-After reading this guide readers should have a strong grasp of the Active Record pattern and how it can be used with or without Rails. Hopefully, some of the philosophical and theoretical intentions discussed here will also make them a stronger and better developer.
-
-== ORM The Blueprint of Active Record
-
-If Active Record is the engine of Rails then ORM is the blueprint of that engine. ORM is short for “Object Relational Mapping” and is a programming concept used to make structures within a system relational. As a thought experiment imagine the components that make up a typical car. There are doors, seats, windows, engines etc. Viewed independently they are simple parts, yet when bolted together through the aid of a blueprint, the parts become a more complex device. ORM is the blueprint that describes how the individual parts relate to one another and in some cases infers the part’s purpose through the way the associations are described.
-
-== Active Record The Engine of Rails
-
-Active Record is a design pattern used to access data within a database. The name “Active Record” was coined by Martin Fowler in his book “Patterns of Enterprise Application Architecture”. Essentially, when a record is returned from the database instead of being just the data it is wrapped in a class, which gives you methods to control that data with. The rails framework is built around the MVC (Model View Controller) design patten and the Active Record is used as the default Model. 
-
-The Rails community added several useful concepts to their version of Active Record, including inheritance and associations, which are extremely useful for web applications. The associations are created by using a DSL (domain specific language) of macros, and inheritance is achieved through the use of STI (Single Table Inheritance) at the database level.
-
-By following a few simple conventions the Rails Active Record will automatically map between:
-
-* Classes & Database Tables
-* Class attributes & Database Table Columns
-
-=== Rails Active Record Conventions
-Here are the key conventions to consider when using Active Record.
-
-==== Naming Conventions
-Database Table - Plural with underscores separating words i.e. (book_clubs)
-Model Class - Singular with the first letter of each word capitalized i.e. (BookClub) 
-Here are some additional Examples:
-
-[grid="all"]
-`-------------`---------------
-Model / Class Table / Schema
-----------------------------
-Post          posts
-LineItem      line_items
-Deer          deer
-Mouse         mice
-Person        people
-----------------------------
-
-==== Schema Conventions
-
-To take advantage of some of the magic of Rails database tables must be modeled 
-to reflect the ORM decisions that Rails makes.
-
-[grid="all"]
-`-------------`---------------------------------------------------------------------------------
-Convention
--------------------------------------------------------------------------------------------------
-Foreign keys  These fields are named table_id i.e. (item_id, order_id)
-Primary Key   Rails automatically creates a primary key column named "id" unless told otherwise.
--------------------------------------------------------------------------------------------------
-
-==== Magic Field Names
-
-When these optional fields are used in your database table definition they give the Active Record
-instance additional features. 
-
-NOTE: While these column names are optional they are in fact reserved by ActiveRecord. Steer clear of reserved keywords unless you want the extra functionality. For example, "type" is a reserved keyword
-used to designate a table using Single Table Inheritance. If you are not using STI, try an analogous 
-keyword like "context", that may still accurately describe the data you are modeling.
-
-[grid="all"]
-`------------------------`------------------------------------------------------------------------------
-Attribute                 Purpose
-------------------------------------------------------------------------------------------------------
-created_at / created_on  Rails stores the current date & time to this field when creating the record.
-updated_at / updated_on  Rails stores the current date & time to this field when updating the record.
-lock_version             Adds optimistic locking to a model link:http://api.rubyonrails.com/classes/ActiveRecord/Locking.html[more about optimistic locking].
-type                     Specifies that the model uses Single Table Inheritance link:http://api.rubyonrails.com/classes/ActiveRecord/Base.html[more about STI].
-id                       All models require an id. the default is name is "id" but can be changed using the "set_primary_key" or "primary_key" methods.
-_table_name_\_count       Can be used to caches the number of belonging objects on the associated class.
-------------------------------------------------------------------------------------------------------
-
-By default rails assumes all tables will use “id” as their primary key to identify each record. Though fortunately you won’t have explicitly declare this, Rails will automatically create that field unless you tell it not to.
-
-For example suppose you created a database table called cars:
-
-[source, sql]
--------------------------------------------------------
-mysql> CREATE TABLE cars (
-         id INT,
-         color VARCHAR(100),
-         doors INT,
-         horses INT,
-         model VARCHAR(100)
-       );
--------------------------------------------------------
-
-Now you created a class named Car, which is to represent an instance of a record from your table. 
-
-[source, ruby]
-------------------------------------------------------- 
-class Car
-end
--------------------------------------------------------
-
-As you might expect without defining the explicit mappings between your class and the table it is impossible for Rails or any other program to correctly map those relationships.
-
-[source, ruby]
--------------------------------------------------------
->> c = Car.new
-=> #<Class:0x11e1e90>
->> c.doors
-NoMethodError: undefined method `doors' for #<Class:0x11e1e90>
-        from (irb):2
--------------------------------------------------------
-
-Now you could define a door methods to write and read data to and from the database. In a nutshell this is what ActiveRecord does. According to the Rails API: 
-“Active Record objects don‘t specify their attributes directly, but rather infer them from the table definition with which they‘re linked. Adding, removing, and changing attributes and their type is done directly in the database. Any change is instantly reflected in the Active Record objects. The mapping that binds a given Active Record class to a certain database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.”
-Lets try our Car class again, this time inheriting from ActiveRecord.
-
-[source, ruby]
--------------------------------------------------------
-class Car < ActiveRecord::Base
-end
--------------------------------------------------------
-
-Now if we try to access an attribute of the table ActiveRecord automatically handles the mappings for us, as you can see in the following example.
-
-[source, ruby]
--------------------------------------------------------
->> c = Car.new
-=> #<Car id: nil, doors: nil, color: nil, horses: nil, model: nil>
->> c.doors
-=> nil
--------------------------------------------------------
-
-Rails further extends this model by giving each ActiveRecord a way of describing the variety of ways records are associated with one another. We will touch on some of these associations later in the guide but I encourage readers who are interested to read the guide to ActiveRecord associations for an in-depth explanation of the variety of ways rails can model associations.
-- Associations between objects controlled by meta-programming macros.
-
-== Philosophical Approaches & Common Conventions
-Rails has a reputation of being a zero-config  framework which means that it aims to get you off the ground with as little pre-flight checking as possible. This speed benefit is achieved by following “Convention over Configuration”, which is to say that if you agree to live with the defaults then you benefit from a the inherent speed-boost. As Courtneay Gasking put it to me once “You don’t want to off-road on Rails”. ActiveRecord is no different, while it’s possible to override or subvert any of the conventions of AR, unless you have a good reason for doing so you will probably be happy with the defaults. The following is a list of the common conventions of ActiveRecord
-
-== ActiveRecord Magic
- - timestamps
- - updates
-
-== How ActiveRecord Maps your Database.
-- sensible defaults
-- overriding conventions
-
-== Growing Your Database Relationships Naturally
-
-== Attributes
- - attribute accessor method. How to override them?
- - attribute?
- - dirty records
- - 
-== ActiveRecord handling the CRUD of your Rails application - Understanding the life-cycle of an ActiveRecord
-
-== Validations & Callbacks
-- Validations
-    *  create!
-    * validates_acceptance_of
-    * validates_associated
-    * validates_confirmation_of
-    * validates_each
-    * validates_exclusion_of
-    * validates_format_of
-    * validates_inclusion_of
-    * validates_length_of
-    * validates_numericality_of
-    * validates_presence_of
-    * validates_size_of
-    * validates_uniqueness_of
- - Callback
-    * (-) save
-    * (-) valid
-    * (1) before_validation
-    * (2) before_validation_on_create
-    * (-) validate
-    * (-) validate_on_create
-    * (3) after_validation
-    * (4) after_validation_on_create
-    * (5) before_save
-    * (6) before_create
-    * (-) create
-    * (7) after_create
-    * (8) after_save