RubyGems - railties - Versions diffs - 3.1.12 → 3.2.0.rc1 - Mend

railties 3.1.12 → 3.2.0.rc1

Files changed (210) hide show

data/guides/source/action_view_overview.textile CHANGED

@@ -16,7 +16,7 @@ Action View and Action Controller are the two major components of Action Pack. I
 Action View templates are written using embedded Ruby in tags mingled with HTML. To avoid cluttering the templates with boilerplate code, a number of helper classes provide common behavior for forms, dates, and strings. It's also easy to add new helpers to your application as it evolves.
-Note: Some features of Action View are tied to Active Record, but that doesn't mean that Action View depends on Active Record. Action View is an independent package that can be used with any sort of backend.
+NOTE. Some features of Action View are tied to Active Record, but that doesn't mean that Action View depends on Active Record. Action View is an independent package that can be used with any sort of backend.
 h3. Using Action View with Rails
@@ -454,6 +454,83 @@ input("post", "title") # =>
   <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
 </ruby>
+h4. RecordTagHelper
+This module provides methods for generating a container tag, such as a +<div>+, for your record. This is the recommended way of creating a container for render your Active Record object, as it adds an appropriate class and id attributes to that container. You can then refer to those containers easily by following the convention, instead of having to think about which class or id attribute you should use.
+h5. content_tag_for
+Renders a container tag that relates to your Active Record Object.
+For example, given +@post+ is the object of +Post+ class, you can do:
+<ruby>
+<%= content_tag_for(:tr, @post) do %>
+  <td><%= @post.title %></td>
+<% end %>
+</ruby>
+This will generate this HTML output:
+<html>
+<tr id="post_1234" class="post">
+  <td>Hello World!</td>
+</tr>
+</html>
+You can also supply HTML attributes as an additional option hash. For example:
+<ruby>
+<%= content_tag_for(:tr, @post, :class => "frontpage") do %>
+  <td><%= @post.title %></td>
+<% end %>
+</ruby>
+Will generate this HTML output:
+<html>
+<tr id="post_1234" class="post frontpage">
+  <td>Hello World!</td>
+</tr>
+</html>
+You can pass a collection of Active Record objects. This method will loop through your objects and create a container for each of them. For example, given +@posts+ is an array of two +Post+ objects:
+<ruby>
+<%= content_tag_for(:tr, @posts) do |post| %>
+  <td><%= post.title %></td>
+<% end %>
+</ruby>
+Will generate this HTML output:
+<html>
+<tr id="post_1234" class="post">
+  <td>Hello World!</td>
+</tr>
+<tr id="post_1235" class="post">
+  <td>Ruby on Rails Rocks!</td>
+</tr>
+</html>
+h5. div_for
+This is actually a convenient method which calls +content_tag_for+ internally with +:div+ as the tag name. You can pass either an Active Record object or a collection of objects. For example:
+<ruby>
+<%= div_for(@post, :class => "frontpage") do %>
+  <td><%= @post.title %></td>
+<% end %>
+</ruby>
+Will generate this HTML output:
+<html>
+<div id="post_1234" class="post frontpage">
+  <td>Hello World!</td>
+</div>
+</html>
 h4. AssetTagHelper
 This module provides methods for generating HTML that links views to assets such as images, JavaScript files, stylesheets, and feeds.
@@ -478,7 +555,6 @@ javascript_include_tag :monkey # =>
   <script type="text/javascript" src="/javascripts/tail.js"></script>
 </ruby>
 h5. register_stylesheet_expansion
 Register one or more stylesheet files to be included when symbol is passed to +stylesheet_link_tag+. This method is typically intended to be called from plugin initialization to register stylesheet files that the plugin installed in +public/stylesheets+.
@@ -1419,10 +1495,3 @@ end
 Then you could create special views like +app/views/posts/show.expert.html.erb+ that would only be displayed to expert users.
 You can read more about the Rails Internationalization (I18n) API "here":i18n.html.
-h3. Changelog
-* May 29, 2011: Removed references to remote_* helpers - Vijay Dev
-* April 16, 2011: Added 'Using Action View with Rails', 'Templates' and 'Partials' sections. "Sebastian Martinez":http://wyeworks.com
-* September 3, 2009: Continuing work by Trevor Turk, leveraging the Action Pack docs and "What's new in Edge Rails":http://ryandaigle.com/articles/2007/8/3/what-s-new-in-edge-rails-partials-get-layouts
-* April 5, 2009: Starting work by Trevor Turk, leveraging Mike Gunderloy's docs

data/guides/source/active_model_basics.textile ADDED

@@ -0,0 +1,205 @@
+h2. Active Model Basics
+This guide should provide you with all you need to get started using model classes. Active Model allow for Action Pack helpers to interact with non-ActiveRecord models. Active Model also helps building custom ORMs for use outside of the Rails framework.
+endprologue.
+WARNING. This Guide is based on Rails 3.0. Some of the code shown here will not work in earlier versions of Rails.
+h3. Introduction
+Active Model is a library containing various modules used in developing frameworks that need to interact with the Rails Action Pack library. Active Model provides a known set of interfaces for usage in classes. Some of modules are explained below -
+h4. AttributeMethods
+AttributeMethods module can add custom prefixes and suffixes on methods of a class. It is used by defining the prefixes and suffixes, which methods on the object will use them.
+<ruby>
+class Person
+  include ActiveModel::AttributeMethods
+  attribute_method_prefix 'reset_'
+  attribute_method_suffix '_highest?'
+  define_attribute_methods ['age']
+  attr_accessor :age
+private
+  def reset_attribute(attribute)
+    send("#{attribute}=", 0)
+  end
+  def attribute_highest?(attribute)
+    send(attribute) > 100 ? true : false
+  end
+end
+person = Person.new
+person.age = 110
+person.age_highest?  # true
+person.reset_age     # 0
+person.age_highest?  # false
+</ruby>
+h4. Callbacks
+Callbacks gives Active Record style callbacks. This provides the ability to define the callbacks and those will run at appropriate time. After defining a callbacks you can wrap with before, after and around custom methods.
+<ruby>
+class Person
+  extend ActiveModel::Callbacks
+  define_model_callbacks :update
+  before_update :reset_me
+  def update
+    _run_update_callbacks do
+      # This will call when we are trying to call update on object.
+    end
+  end
+  def reset_me
+    # This method will call when you are calling update on object as a before_update callback as defined.
+  end
+end
+</ruby>
+h4. Conversion
+If a class defines persisted? and id methods then you can include Conversion module in that class and you can able to call Rails conversion methods to objects of that class.
+<ruby>
+class Person
+  include ActiveModel::Conversion
+  def persisted?
+    false
+  end
+  def id
+    nil
+  end
+end
+person = Person.new
+person.to_model == person  #=> true
+person.to_key              #=> nil
+person.to_param            #=> nil
+</ruby>
+h4. Dirty
+An object becomes dirty when an object is gone through one or more changes to its attributes and not yet saved. This gives the ability to check whether an object has been changed or not. It also has attribute based accessor methods. Lets consider a Person class with attributes first_name and last_name
+<ruby>
+require 'rubygems'
+require 'active_model'
+class Person
+  include ActiveModel::Dirty
+  define_attribute_methods [:first_name, :last_name]
+  def first_name
+    @first_name
+  end
+  def first_name=(value)
+    first_name_will_change!
+    @first_name = value
+  end
+  def last_name
+    @last_name
+  end
+  def last_name=(value)
+    last_name_will_change!
+    @last_name = value
+  end
+  def save
+    @previously_changed = changes
+  end
+end
+</ruby>
+h5. Querying object directly for its list of all changed attributes.
+<ruby>
+person = Person.new
+person.first_name = "First Name"
+person.first_name #=> "First Name"
+person.first_name = "First Name Changed"
+person.changed? #=> true
+#returns an list of fields arry which all has been changed before saved.
+person.changed #=> ["first_name"]
+#returns a hash of the fields that have changed with their original values.
+person.changed_attributes #=> {"first_name" => "First Name Changed"}
+#returns a hash of changes, with the attribute names as the keys, and the values will be an array of the old and new value for that field.
+person.changes #=> {"first_name" => ["First Name","First Name Changed"]}
+</ruby>
+h5. Attribute based accessor methods
+Track whether the particular attribute has been changed or not.
+<ruby>
+#attr_name_changed?
+person.first_name #=> "First Name"
+#assign some other value to first_name attribute
+person.first_name = "First Name 1"
+person.first_name_changed? #=> true
+</ruby>
+Track what was the previous value of the attribute.
+<ruby>
+#attr_name_was accessor
+person.first_name_was  #=> "First Name"
+</ruby>
+Track  both previous and current value of the changed attribute. Returns an array if changed else returns nil
+<ruby>
+#attr_name_change
+person.first_name_change #=> ["First Name", "First Name 1"]
+person.last_name_change #=> nil
+</ruby>
+h4. Validations
+Validations module adds the ability to class objects to validate them in Active Record style.
+<ruby>
+class Person
+  include ActiveModel::Validations
+  attr_accessor :name, :email, :token
+  validates :name, :presence => true
+  validates_format_of :email, :with => /^([^\s]+)((?:[-a-z0-9]\.)[a-z]{2,})$/i
+  validates! :token, :presence => true
+end
+person = Person.new(:token => "2b1f325")
+person.valid?                        #=> false
+person.name  = 'vishnu'
+person.email  = 'me'
+person.valid?                        #=> false
+person.email = 'me@vishnuatrai.com'
+person.valid?                        #=> true
+person.token = nil
+person.valid?                        #=> raises ActiveModel::StrictValidationFailed
+</ruby>

data/guides/source/active_record_basics.textile CHANGED

@@ -38,47 +38,48 @@ When writing applications using other programming languages or frameworks, it ma
 h4. Naming Conventions
-By default, Active Record uses some naming conventions to find out how the mapping between models and database tables should be created. Rails will pluralize your class names to find the respective database table. So, for a class +Book+, you should have a database table called *books*. The Rails pluralization mechanisms are very powerful, being capable to pluralize (and singularize) both regular and irregular words. When using class names composed of two or more words, the model class name should follow the Ruby conventions, using the camelCase form, while the table name must contain the words separated by underscores. Examples:
+By default, Active Record uses some naming conventions to find out how the mapping between models and database tables should be created. Rails will pluralize your class names to find the respective database table. So, for a class +Book+, you should have a database table called *books*. The Rails pluralization mechanisms are very powerful, being capable to pluralize (and singularize) both regular and irregular words. When using class names composed of two or more words, the model class name should follow the Ruby conventions, using the CamelCase form, while the table name must contain the words separated by underscores. Examples:
-* Database Table - Plural with underscores separating words (e.g., book_clubs)
-* Model Class - Singular with the first letter of each word capitalized (e.g., BookClub)
+* Database Table - Plural with underscores separating words (e.g., +book_clubs+)
+* Model Class - Singular with the first letter of each word capitalized (e.g., +BookClub+)
 |_.Model / Class |_.Table / Schema |
-|Post          |posts|
-|LineItem      |line_items|
-|Deer          |deer|
-|Mouse         |mice|
-|Person        |people|
+|+Post+          |+posts+|
+|+LineItem+      |+line_items+|
+|+Deer+          |+deer+|
+|+Mouse+         |+mice+|
+|+Person+        |+people+|
 h4. Schema Conventions
 Active Record uses naming conventions for the columns in database tables, depending on the purpose of these columns.
-* *Foreign keys* - These fields should be named following the pattern table_id (e.g., item_id, order_id). These are the fields that Active Record will look for when you create associations between your models.
-* *Primary keys* - By default, Active Record will use an integer column named "id" as the table's primary key. When using "Rails Migrations":migrations.html to create your tables, this column will be automatically created.
+* *Foreign keys* - These fields should be named following the pattern +singularized_table_name_id+ (e.g., +item_id+, +order_id+). These are the fields that Active Record will look for when you create associations between your models.
+* *Primary keys* - By default, Active Record will use an integer column named +id+ as the table's primary key. When using "Rails Migrations":migrations.html to create your tables, this column will be automatically created.
 There are also some optional column names that will create additional features to Active Record instances:
-* *created_at* - Automatically gets set to the current date and time when the record is first created.
-* *created_on* - Automatically gets set to the current date when the record is first created.
-* *updated_at* - Automatically gets set to the current date and time whenever the record is updated.
-* *updated_on* - Automatically gets set to the current date whenever the record is updated.
-* *lock_version* - Adds "optimistic locking":http://api.rubyonrails.org/classes/ActiveRecord/Locking.html to a model.
-* *type* - Specifies that the model uses "Single Table Inheritance":http://api.rubyonrails.org/classes/ActiveRecord/Base.html
-* *(table_name)_count* - Used to cache the number of belonging objects on associations. For example, a +comments_count+ column in a +Post+ class that has many instances of +Comment+ will cache the number of existent comments for each post.
+* +created_at+ - Automatically gets set to the current date and time when the record is first created.
+* +created_on+ - Automatically gets set to the current date when the record is first created.
+* +updated_at+ - Automatically gets set to the current date and time whenever the record is updated.
+* +updated_on+ - Automatically gets set to the current date whenever the record is updated.
+* +lock_version+ - Adds "optimistic locking":http://api.rubyonrails.org/classes/ActiveRecord/Locking.html to a model.
+* +type+ - Specifies that the model uses "Single Table Inheritance":http://api.rubyonrails.org/classes/ActiveRecord/Base.html
+* +(table_name)_count+ - Used to cache the number of belonging objects on associations. For example, a +comments_count+ column in a +Post+ class that has many instances of +Comment+ will cache the number of existent comments for each post.
-NOTE: While these column names are optional they are in fact reserved by Active Record. 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.
+NOTE: While these column names are optional, they are in fact reserved by Active Record. 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 (STI). If you are not using STI, try an analogous keyword like "context", that may still accurately describe the data you are modeling.
 h3. Creating Active Record Models
-It's very easy to create Active Record models. All you have to do is to subclass the +ActiveRecord::Base+ class and you're good to go:
+It is very easy to create Active Record models. All you have to do is to subclass the +ActiveRecord::Base+ class and you're good to go:
 <ruby>
-class Product < ActiveRecord::Base; end
+class Product < ActiveRecord::Base
+end
 </ruby>
-This will create a +Product+ model, mapped to a *products* table at the database. By doing this you'll also have the ability to map the columns of each row in that table with the attributes of the instances of your model. So, suppose that the *products* table was created using an SQL sentence like:
+This will create a +Product+ model, mapped to a +products+ table at the database. By doing this you'll also have the ability to map the columns of each row in that table with the attributes of the instances of your model. Suppose that the +products+ table was created using an SQL sentence like:
 <sql>
 CREATE TABLE products (
@@ -100,11 +101,11 @@ h3. Overriding the Naming Conventions
 What if you need to follow a different naming convention or need to use your Rails application with a legacy database? No problem, you can easily override the default conventions.
-You can use the +ActiveRecord::Base.set_table_name+ method to specify the table name that should be used:
+You can use the +ActiveRecord::Base.table_name=+ method to specify the table name that should be used:
 <ruby>
 class Product < ActiveRecord::Base
-  set_table_name "PRODUCT"
+  self.table_name = "PRODUCT"
 end
 </ruby>
@@ -126,21 +127,21 @@ class Product < ActiveRecord::Base
 end
 </ruby>
-h3. Reading and Writing Data
+h3. CRUD: Reading and Writing Data
 CRUD is an acronym for the four verbs we use to operate on data: *C*reate, *R*ead, *U*pdate and *D*elete. Active Record automatically creates methods to allow an application to read and manipulate data stored within its tables.
 h4. Create
-Active Record objects can be created from a hash, a block or have its attributes manually set after creation. The _new_ method will return a new object while _create_ will return the object and save it to the database.
+Active Record objects can be created from a hash, a block or have their attributes manually set after creation. The +new+ method will return a new object while +create+ will return the object and save it to the database.
-For example, given a model +User+ with attributes of +name+ and +occupation+, the _create_ method call will create and save a new record into the database:
+For example, given a model +User+ with attributes of +name+ and +occupation+, the +create+ method call will create and save a new record into the database:
 <ruby>
   user = User.create(:name => "David", :occupation => "Code Artist")
 </ruby>
-Using the _new_ method, an object can be created without being saved:
+Using the +new+ method, an object can be created without being saved:
 <ruby>
   user = User.new
@@ -148,9 +149,9 @@ Using the _new_ method, an object can be created without being saved:
   user.occupation = "Code Artist"
 </ruby>
-A call to _user.save_ will commit the record to the database.
+A call to +user.save+ will commit the record to the database.
-Finally, passing a block to either create or new will return a new User object:
+Finally, if a block is provided, both +create+ and +new+ will yield the new object to that block for initialization:
 <ruby>
   user = User.new do |u|
@@ -164,7 +165,7 @@ h4. Read
 Active Record provides a rich API for accessing data within a database. Below are a few examples of different data access methods provided by Active Record.
 <ruby>
-  # return all records
+  # return array with all records
   users = User.all
 </ruby>
@@ -204,7 +205,6 @@ Likewise, once retrieved an Active Record object can be destroyed which removes
   user.destroy
 </ruby>
 h3. Validations
 Active Record allows you to validate the state of a model before it gets written into the database. There are several methods that you can use to check your models and validate that an attribute value is not empty, is unique and not already in the database, follows a specific format and many more. You can learn more about validations in the "Active Record Validations and Callbacks guide":active_record_validations_callbacks.html#validations-overview.