map.resources :photos, :only => [:index, :show] +map.resources :products, :except => :destroy +
On the controller side, there are a couple of changes that will help tidy up your routes.
On the controller side, there are several changes that will help tidy up your routes. There are also some internal changes in the routing engine to lower memory usage on complex applications.
6.1. Shallow Route Nesting
-Shallow route nesting provides a solution to the well-known difficulty of using deeply-nested resources. With shallow nesting, you need only supply enough information to uniquely identify the resource that you want to work with - but you can supply more information.
Shallow route nesting provides a solution to the well-known difficulty of using deeply-nested resources. With shallow nesting, you need only supply enough information to uniquely identify the resource that you want to work with.
+
-
+
-
+
+Lead Contributor: Tom Stuart +
+
+
6.4. Other Action Controller Changes
-
diff --git a/railties/doc/guides/html/actioncontroller_basics.html b/railties/doc/guides/html/actioncontroller_basics.html index d58536cc37ba7..66563bf1a375f 100644 --- a/railties/doc/guides/html/actioncontroller_basics.html +++ b/railties/doc/guides/html/actioncontroller_basics.html @@ -349,7 +349,7 @@
1. What Does a Controller do?
2. Methods and Actions
-
+
-
+
-
+
-
+
+
-A controller is a Ruby class which inherits from ApplicationController and has methods just like any other class. Usually these methods correspond to actions in MVC, but they can just as well be helpful methods which can be called by actions. When your application receives a request, the routing will determine which controller and action to run. Then Rails creates an instance of that controller and runs the method corresponding to the action (the method with the same name as the action).
A controller is a Ruby class which inherits from ApplicationController and has methods just like any other class. When your application receives a request, the routing will determine which controller and action to run, then Rails creates an instance of that controller and runs the public method with the same name as the action.
class AdminController < ApplicationController - USERNAME, PASSWORD = "humbaba", "f59a4805511bf4bb61978445a5380c6c" + USERNAME, PASSWORD = "humbaba", "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8" before_filter :authenticate @@ -1038,7 +1047,7 @@10. HTTP Basic Authentication
def authenticate authenticate_or_request_with_http_basic do |username, password| - username == USERNAME && Digest::MD5.hexdigest(password) == PASSWORD + username == USERNAME && Digest::SHA1.hexdigest(password) == PASSWORD end end @@ -1095,7 +1104,7 @@11.1. Sending Files
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.
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.
diff --git a/railties/doc/guides/html/activerecord_validations_callbacks.html b/railties/doc/guides/html/activerecord_validations_callbacks.html
index c9128a8533776..0aa507a9b94ce 100644
--- a/railties/doc/guides/html/activerecord_validations_callbacks.html
+++ b/railties/doc/guides/html/activerecord_validations_callbacks.html
@@ -199,10 +199,72 @@ Sustainable productivity for web-application develop
|
+
+ |
+Pay attention not to use validates_associated on both ends of your associations, because this will lead to several recursive calls and blow up the method calls' stack. | +
The default error message for validates_associated is "is invalid". Note that the errors for each failed validation in the associated objects will be set there and not in this model.
3.3. The validates_confirmation_of helper
+You should use this helper when you have two text fields that should receive exactly the same content, like when you want to confirm an email address or password. This validation creates a virtual attribute, using the name of the field that has to be confirmed with _confirmation appended.
+
+
+
class Person < ActiveRecord::Base + validates_confirmation_of :email +end +
In your view template you could use something like
+
+
+
<%= text_field :person, :email %> +<%= text_field :person, :email_confirmation %>+
+
+
+
+
+ |
+This check is performed only if email_confirmation is not nil, and by default only on save. To require confirmation, make sure to add a presence check for the confirmation attribute (we'll take a look at validates_presence_of later on this guide): | +
+
+
+
class Person < ActiveRecord::Base + validates_confirmation_of :email + validates_presence_of :email_confirmation +end +
The default error message for validates_confirmation_of is "doesn't match confirmation"
3.4. The validates_each helper
+This helper validates attributes against a block. It doesn't have a predefined validation function. You should create one using a block, and every attribute passed to validates_each will be tested against it. In the following example, we don't want names and surnames to begin with lower case.
+
+
+
class Person < ActiveRecord::Base + validates_each :name, :surname do |model, attr, value| + model.errors.add(attr, 'Must start with upper case') if value =~ /^[a-z]/ + end +end +
The block receives the model, the attribute's name and the attribute's value. If your validation fails, you can add an error message to the model, therefore making it invalid.
3.5. The validates_exclusion_of helper
+This helper validates that the attributes' values are not included in a given set. In fact, this set can be any enumerable object.
+
+
+
class MovieFile < ActiveRecord::Base + validates_exclusion_of :format, :in => %w(mov avi), :message => "Extension %s is not allowed" +end +
The validates_exclusion_of helper has an option :in that receives the set of values that will not be accepted for the validated attributes. The :in option has an alias called :within that you can use for the same purpose, if you'd like to. In the previous example we used the :message option to show how we can personalize it with the current attribute's value, through the %s format mask.
The default error message for validates_exclusion_of is "is not included in the list".
3.6. The validates_format_of helper
+This helper validates the attributes's values by testing if they match a given pattern. This pattern must be specified using a Ruby regular expression, which must be passed through the :with option.
+
+
+
class Product < ActiveRecord::Base + validates_format_of :description, :with => /^[a-zA-Z]+$/, :message => "Only letters allowed" +end +
The default error message for validates_format_of is "is invalid".
3.7. The validates_inclusion_of helper
+This helper validates that the attributes' values are included in a given set. In fact, this set can be any enumerable object.
+
+
+
class Coffee < ActiveRecord::Base + validates_inclusion_of :size, :in => %w(small medium large), :message => "%s is not a valid size" +end +
The validates_inclusion_of helper has an option :in that receives the set of values that will be accepted. The :in option has an alias called :within that you can use for the same purpose, if you'd like to. In the previous example we used the :message option to show how we can personalize it with the current attribute's value, through the %s format mask.
The default error message for validates_inclusion_of is "is not included in the list".
3.8. The validates_length_of helper
+This helper validates the length of your attribute's value. It can receive a variety of different options, so you can specify length contraints in different ways.
+
+
+
class Person < ActiveRecord::Base + validates_length_of :name, :minimum => 2 + validates_length_of :bio, :maximum => 500 + validates_length_of :password, :in => 6..20 + validates_length_of :registration_number, :is => 6 +end +
The possible length constraint options are:
-
+
-
+
+:minimum - The attribute cannot have less than the specified length. +
+
+ -
+
+:maximum - The attribute cannot have more than the specified length. +
+
+ -
+
+:in (or :within) - The attribute length must be included in a given interval. The value for this option must be a Ruby range. +
+
+ -
+
+:is - The attribute length must be equal to a given value. +
+
+
The default error messages depend on the type of length validation being performed. You can personalize these messages, using the :wrong_length, :too_long and :too_short options and the %d format mask as a placeholder for the number corresponding to the length contraint being used. You can still use the :message option to specify an error message.
+
+
+
class Person < ActiveRecord::Base + validates_length_of :bio, :too_long => "you're writing too much. %d characters is the maximum allowed." +end +
This helper has an alias called validates_size_of, it's the same helper with a different name. You can use it if you'd like to.
3.9. The validates_numericallity_of helper
+This helper validates that your attributes have only numeric values. By default, it will match an optional sign followed by a integral or floating point number. Using the :integer_only option set to true, you can specify that only integral numbers are allowed.
If you use :integer_only set to true, then it will use the /\A[+\-]?\d+\Z/ regular expression to validate the attribute's value. Otherwise, it will try to convert the value using Kernel.Float.
+
+
+
class Player < ActiveRecord::Base + validates_numericallity_of :points + validates_numericallity_of :games_played, :integer_only => true +end +
The default error message for validates_numericallity_of is "is not a number".
3.10. The validates_presence_of helper
+This helper validates that the attributes are not empty. It uses the blank? method to check if the value is either nil or an empty string (if the string has only spaces, it will still be considered empty).
+
+
+
class Person < ActiveRecord::Base + validates_presence_of :name, :login, :email +end +
+
+
+|
+
+ |
+If you want to be sure that an association is present, you'll need to test if the foreign key used to map the association is present, and not the associated object itself. | +
+
+
+
class LineItem < ActiveRecord::Base + belongs_to :order + validates_presence_of :order_id +end +
+
+
+|
+
+ |
+If you want to validate the presence of a boolean field (where the real values are true and false), you will want to use validates_inclusion_of :field_name, :in ⇒ [true, false] This is due to the way Object#blank? handles boolean values. false.blank? # ⇒ true | +
The default error message for validates_presence_of is "can't be empty".
3.11. The validates_uniqueness_of helper
+This helper validates that the attribute's value is unique right before the object gets saved. It does not create a uniqueness constraint directly into your database, so it may happen that two different database connections create two records with the same value for a column that you wish were unique. To avoid that, you must create an unique index in your database.
+
+
+
class Account < ActiveRecord::Base + validates_uniqueness_of :email +end +
The validation happens by performing a SQL query into the model's table, searching for a record where the attribute that must be validated is equal to the value in the object being validated.
There is a :scope option that you can use to specify other attributes that must be used to define uniqueness:
+
+
+
class Holiday < ActiveRecord::Base + validates_uniqueness_of :name, :scope => :year, :message => "Should happen once per year" +end +
There is also a :case_sensitive option that you can use to define if the uniqueness contraint will be case sensitive or not. This option defaults to true.
+
+
+
class Person < ActiveRecord::Base + validates_uniqueness_of :name, :case_sensitive => false +end +
The default error message for validates_uniqueness_of is "has already been taken".
4. Common validation options
+
+
+
+
+
+
+There are some common options that all the validation helpers can use. Here they are, except for the :if and :unless options, which we'll cover right at the next topic.
4.1. The :allow_nil option
+You may use the :allow_nil option everytime you just want to trigger a validation if the value being validated is not nil. You may be asking yourself if it makes any sense to use :allow_nil and validates_presence_of together. Well, it does. Remember, validation will be skipped only for nil attributes, but empty strings are not considered nil.
+
+
+
class Coffee < ActiveRecord::Base + validates_inclusion_of :size, :in => %w(small medium large), + :message => "%s is not a valid size", :allow_nil => true +end +
4.2. The :message option
+As stated before, the :message option lets you specify the message that will be added to the errors collection when validation fails. When this option is not used, Active Record will use the respective default error message for each validation helper.
4.3. The :on option
+As stated before, the :on option lets you specify when the validation should happen. The default behaviour for all the built-in validation helpers is to be ran on save (both when you're creating a new record and when you're updating it). If you want to change it, you can use :on => :create to run the validation only when a new record is created or :on => :update to run the validation only when a record is updated.
+
+
+
class Person < ActiveRecord::Base + validates_uniqueness_of :email, :on => :create # => it will be possible to update email with a duplicated value + validates_numericallity_of :age, :on => :update # => it will be possible to create the record with a 'non-numerical age' + validates_presence_of :name, :on => :save # => that's the default +end +
5. Conditional validation
+
+
+
+
+
-Sometimes it will make sense to validate an object just when a given predicate is satisfied. You can do that by using the :if and :unless options, which can take a symbol, a string or a Ruby Proc. You may use the :if option when you want to specify when the validation should happen. If you want to specify when the validation should not happen, then you may use the :unless option.
5.1. Using a symbol with the :if and :unless options
+You can associated the :if and :unless options with a symbol corresponding to the name of a method that will get called right before validation happens. This is the most commonly used option.
+
+
+
class Order < ActiveRecord::Base + validates_presence_of :card_number, :if => :paid_with_card? + + def paid_with_card? + payment_type == "card" + end +end +
5.2. Using a string with the :if and :unless options
+You can also use a string that will be evaluated using :eval and needs to contain valid Ruby code. You should use this option only when the string represents a really short condition.
+
+
+
class Person < ActiveRecord::Base + validates_presence_of :surname, :if => "name.nil?" +end +
5.3. Using a Proc object with the :if and :unless options
+Finally, it's possible to associate :if and :unless with a Ruby Proc object which will be called. Using a Proc object can give you the hability to write a condition that will be executed only when the validation happens and not when your code is loaded by the Ruby interpreter. This option is best suited when writing short validation methods, usually one-liners.
+
+
class Account < ActiveRecord::Base + validates_confirmation_of :password, :unless => Proc.new { |a| a.password.blank? } +end +
2. Credits
+6. Writing your own validation methods
+
+
+
-When the built-in validation helpers are not enough for your needs, you can write your own validation methods, by implementing one or more of the validate, validate_on_create or validate_on_update methods. As the names of the methods states, the right method to implement depends on when you want the validations to be ran. The meaning of valid is still the same: to make an object invalid you just need to add a message to it's errors collection.
+
+
+
class Invoice < ActiveRecord::Base + def validate_on_create + errors.add(:expiration_date, "can't be in the past") if !expiration_date.blank? and expiration_date < Date.today + end +end +
If your validation rules are too complicated and you want to break it in small methods, you can implement all of them and call one of validate, validate_on_create or validate_on_update methods, passing it the symbols for the methods' names.
+
+
class Invoice < ActiveRecord::Base + validate :expiration_date_cannot_be_in_the_past, :discount_cannot_be_more_than_total_value + + def expiration_date_cannot_be_in_the_past + errors.add(:expiration_date, "can't be in the past") if !expiration_date.blank? and expiration_date < Date.today + end + + def discount_cannot_be_greater_than_total_value + errors.add(:discount, "can't be greater than total value") unless discount <= total_value + end +end +
3. Changelog
+7. Changelog
diff --git a/railties/doc/guides/html/caching_with_rails.html b/railties/doc/guides/html/caching_with_rails.html index df30c46c356c4..7aa5999e1a64e 100644 --- a/railties/doc/guides/html/caching_with_rails.html +++ b/railties/doc/guides/html/caching_with_rails.html @@ -235,48 +235,54 @@1. Basic Caching
This is an introduction to the three types of caching techniques that Rails provides by default without the use of any third party plugins.
To get started make sure Base.perform_caching is set to true for your -environment.
To get started make sure config.action_controller.perform_caching is set +to true for your environment. This flag is normally set in the +corresponding config/environments/*.rb and caching is disabled by default +there for development and test, and enabled for production.
-
Base.perform_caching = true +config.action_controller.perform_caching = true
1.1. Page Caching
Page caching is a Rails mechanism which allows the request for a generated page to be fulfilled by the webserver, without ever having to go through the -Rails stack at all. Obviously, this is super fast. Unfortunately, it can't be +Rails stack at all. Obviously, this is super-fast. Unfortunately, it can't be applied to every situation (such as pages that need authentication) and since the webserver is literally just serving a file from the filesystem, cache expiration is an issue that needs to be dealt with.
So, how do you enable this super-fast cache behavior? Simple, let's say you -have a controller called ProductController and a list action that lists all +have a controller called ProductsController and a list action that lists all the products
-
class ProductController < ActionController +class ProductsController < ActionController - cache_page :list + caches_page :index - def list; end + def index; end end
The first time anyone requestsion products/list, Rails will generate a file -called list.html and the webserver will then look for that file before it -passes the next request for products/list to your Rails application.
The first time anyone requests products/index, Rails will generate a file +called index.html and the webserver will then look for that file before it +passes the next request for products/index to your Rails application.
By default, the page cache directory is set to Rails.public_path (which is -usually set to RAILS_ROOT + "/public") and this can be configured by changing -the configuration setting Base.cache_public_directory
The page caching mechanism will automatically add a .html exxtension to +usually set to RAILS_ROOT + "/public") and this can be configured by +changing the configuration setting ActionController::Base.page_cache_directory. Changing the +default from /public helps avoid naming conflicts, since you may want to +put other static html in /public, but changing this will require web +server reconfiguration to let the web server know where to serve the +cached files from.
The Page Caching mechanism will automatically add a .html exxtension to requests for pages that do not have an extension to make it easy for the webserver to find those pages and this can be configured by changing the -configuration setting Base.page_cache_extension
In order to expire this page when a new product is added we could extend our example controler like this:
@@ -284,9 +290,9 @@
1.1. Page Caching
by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -class ProductController < ActionController +class ProductsController < ActionController - cache_page :list + caches_page :list def list; end @@ -299,11 +305,11 @@1.1. Page Caching
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.
1.2. Action Caching
--One of the issues with page caching is that you cannot use it for pages that +
One of the issues with Page Caching is that you cannot use it for pages that require to restrict access somehow. This is where Action Caching comes in. Action Caching works like Page Caching except for the fact that the incoming web request does go from the webserver to the Rails stack and Action Pack so -that before_filters can be run on it before the cache is served, so that +that before filters can be run on it before the cache is served, so that authentication and other restrictions can be used while still serving the result of the output from a cached copy.
@@ -314,10 +320,10 @@Clearing the cache works in the exact same way as with Page Caching.
1.2. Action Caching
by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -class ProductController < ActionController +class ProductsController < ActionController before_filter :authenticate, :only => [ :edit, :create ] - cache_page :list + caches_page :list caches_action :edit def list; end @@ -336,7 +342,7 @@1.2. Action Caching
layout so that dynamic information in the layout such as logged in user info or the number of items in the cart can be left uncached. This feature is available as of Rails 2.2.-[More: more examples? Walk-through of action caching from request to response? +
@@ -346,13 +352,13 @@[More: more examples? Walk-through of Action Caching from request to response? Description of Rake tasks to clear cached files? Show example of subdomain caching? Talk about :cache_path, :if and assing blocks/Procs to expire_action?]
1.3. Fragment Caching
applications usually build pages with a variety of components not all of which have the same caching characteristics. In order to address such a dynamically created page where different parts of the page need to be cached and expired -differently Rails provides a mechanism called Fragment caching.+Fragment caching allows a fragment of view logic to be wrapped in a cache +differently Rails provides a mechanism called Fragment Caching.
-Fragment Caching allows a fragment of view logic to be wrapped in a cache block and served out of the cache store when the next request comes in.
+As an example, if you wanted to show all the orders placed on your website in -real time and didn't want to cache that part of the page, but did want to -cache the part of the page which lists all products available, you could use -this piece of code:
As an example, if you wanted to show all the orders placed on your website +in real time and didn't want to cache that part of the page, but did want +to cache the part of the page which lists all products available, you +could use this piece of code:
-class ProductController < ActionController +class ProductsController < ActionController before_filter :authenticate, :only => [ :edit, :create ] - cache_page :list + caches_page :list caches_action :edit cache_sweeper :store_sweeper, :only => [ :create ] @@ -468,10 +474,10 @@1.5. SQL Caching
by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -class ProductController < ActionController +class ProductsController < ActionController before_filter :authenticate, :only => [ :edit, :create ] - cache_page :list + caches_page :list caches_action :edit cache_sweeper :store_sweeper, :only => [ :create ] diff --git a/railties/doc/guides/html/command_line.html b/railties/doc/guides/html/command_line.html new file mode 100644 index 0000000000000..2add20446ebf1 --- /dev/null +++ b/railties/doc/guides/html/command_line.html @@ -0,0 +1,434 @@ + + + + +A Guide to The Rails Command Line + + + + + + + +++ +++ ++
Ruby on Rails
+Sustainable productivity for web-application development
+ + ++ + + ++ + diff --git a/railties/doc/guides/html/configuring.html b/railties/doc/guides/html/configuring.html new file mode 100644 index 0000000000000..4aa3a0f545299 --- /dev/null +++ b/railties/doc/guides/html/configuring.html @@ -0,0 +1,438 @@ + + + + +++A Guide to The Rails Command Line
++++++Rails comes with every command line tool you'll need to
++
- +
++Create a Rails application +
+- +
++Generate models, controllers, database migrations, and unit tests +
+- +
++Start a development server +
+- +
++Mess with objects through an interactive shell +
+- +
++Profile and benchmark your new creation +
++… and much, much more! (Buy now!)
+This tutorial assumes you have basic Rails knowledge from reading the Getting Started with Rails Guide.
1. Command Line Basics
+++ ++There are a few commands that are absolutely critical to your everyday usage of Rails. In the order of how much you'll probably use them are:
++
- +
++console +
+- +
++server +
+- +
++rake +
+- +
++generate +
+- +
++rails +
++Let's create a simple Rails application to step through each of these commands in context.
1.1. rails
++The first thing we'll want to do is create a new Rails application by running the rails command after installing Rails.
+++
+ + +You know you need the rails gem installed by typing gem install rails first, right? Okay, okay, just making sure. ++++$ rails commandsapp + + create + create app/controllers + create app/helpers + create app/models + ... + ... + create log/production.log + create log/development.log + create log/test.log ++Rails will set you up with what seems like a huge amount of stuff for such a tiny command! You've got the entire Rails directory structure now with all the code you need to run our simple application right out of the box.
+++
+ + +This output will seem very familiar when we get to the generate command. Creepy foreshadowing! +1.2. server
++Let's try it! The server command launches a small web server written in Ruby named WEBrick which was also installed when you installed Rails. You'll use this any time you want to view your work through a web browser.
+++
+ + +WEBrick isn't your only option for serving Rails. We'll get to that in a later section. [XXX: which section] ++Here we'll flex our server command, which without any prodding of any kind will run our new shiny Rails app:
+++$ cd commandsapp +$ ./script/server +=> Booting WEBrick... +=> Rails 2.2.0 application started on http://0.0.0.0:3000 +=> Ctrl-C to shutdown server; call with --help for options +[2008-11-04 10:11:38] INFO WEBrick 1.3.1 +[2008-11-04 10:11:38] INFO ruby 1.8.5 (2006-12-04) [i486-linux] +[2008-11-04 10:11:38] INFO WEBrick::HTTPServer#start: pid=18994 port=3000 ++WHOA. With just three commands we whipped up a Rails server listening on port 3000. Go! Go right now to your browser and go to http://localhost:3000. I'll wait.
+See? Cool! It doesn't do much yet, but we'll change that.
1.3. generate
++The generate command uses templates to create a whole lot of things. You can always find out what's available by running generate by itself. Let's do that:
+++$ ./script/generate +Usage: ./script/generate generator [options] [args] + +... +... + +Installed Generators + Builtin: controller, integration_test, mailer, migration, model, observer, performance_test, plugin, resource, scaffold, session_migration + +... +... ++++
+ + +You can install more generators through generator gems, portions of plugins you'll undoubtedly install, and you can even create your own! ++Using generators will save you a large amount of time by writing boilerplate code for you — necessary for the darn thing to work, but not necessary for you to spend time writing. That's what we have computers for, right?
+Let's make our own controller with the controller generator. But what command should we use? Let's ask the generator:
+++
+ + +All Rails console utilities have help text. For commands that require a lot of input to run correctly, you can just try the command without any parameters (like rails or ./script/generate). For others, you can try adding —help or -h to the end, as in ./script/server —help. ++++$ ./script/generate controller +Usage: ./script/generate controller ControllerName [options] + +... +... + +Example: + `./script/generate controller CreditCard open debit credit close` + + Credit card controller with URLs like /credit_card/debit. + Controller: app/controllers/credit_card_controller.rb + Views: app/views/credit_card/debit.html.erb [...] + Helper: app/helpers/credit_card_helper.rb + Test: test/functional/credit_card_controller_test.rb + +Modules Example: + `./script/generate controller 'admin/credit_card' suspend late_fee` + + Credit card admin controller with URLs /admin/credit_card/suspend. + Controller: app/controllers/admin/credit_card_controller.rb + Views: app/views/admin/credit_card/debit.html.erb [...] + Helper: app/helpers/admin/credit_card_helper.rb + Test: test/functional/admin/credit_card_controller_test.rb ++Ah, the controller generator is expecting parameters in the form of generate controller ControllerName action1 action2. Let's make a Greetings controller with an action of hello, which will say something nice to us.
+++$ ./script/generate controller Greeting hello + exists app/controllers/ + exists app/helpers/ + create app/views/greeting + exists test/functional/ + create app/controllers/greetings_controller.rb + create test/functional/greetings_controller_test.rb + create app/helpers/greetings_helper.rb + create app/views/greetings/hello.html.erb ++Look there! Now what all did this generate? It looks like it made sure a bunch of directories were in our application, and created a controller file, a functional test file, a helper for the view, and a view file. All from one command!
Configuring Rails Applications + + + + + + + +++ +++ +Ruby on Rails
+Sustainable productivity for web-application development
+ + ++ + + ++ + diff --git a/railties/doc/guides/html/creating_plugins.html b/railties/doc/guides/html/creating_plugins.html index 48d5f03687ba5..375d216b4ab2b 100644 --- a/railties/doc/guides/html/creating_plugins.html +++ b/railties/doc/guides/html/creating_plugins.html @@ -204,26 +204,61 @@++Configuring Rails Applications
++++++This guide covers the configuration and initialization features available to Rails applications. By referring to this guide, you will be able to:
++
- +
++Adjust the behavior of your Rails applications +
+- +
++Add additional code to be run at application start time +
+1. Locations for Initialization Code
++++preinitializers +environment.rb first +env-specific files +initializers (load_application_initializers) +after-initializer
2. Using a Preinitializer
+++3. Configuring Rails Components
+++3.1. Configuring Active Record
+3.2. Configuring Action Controller
+3.3. Configuring Action View
+3.4. Configuring Action Mailer
+3.5. Configuring Active Resource
+3.6. Configuring Active Support
+4. Using Initializers
++++++organization, controlling load order+5. Using an After-Initializer
+++6. Changelog
++ ++ +++
- +
++November 5, 2008: Rough outline by Mike Gunderloy +
++actionmailer/lib/action_mailer/base.rb +257: cattr_accessor :logger +267: cattr_accessor :smtp_settings +273: cattr_accessor :sendmail_settings +276: cattr_accessor :raise_delivery_errors +282: cattr_accessor :perform_deliveries +285: cattr_accessor :deliveries +288: cattr_accessor :default_charset +291: cattr_accessor :default_content_type +294: cattr_accessor :default_mime_version +297: cattr_accessor :default_implicit_parts_order +299: cattr_reader :protected_instance_variables
+actionmailer/Rakefile +36: rdoc.options << —line-numbers << —inline-source << -A cattr_accessor=object
+actionpack/lib/action_controller/base.rb +263: cattr_reader :protected_instance_variables +273: cattr_accessor :asset_host +279: cattr_accessor :consider_all_requests_local +285: cattr_accessor :allow_concurrency +317: cattr_accessor :param_parsers +321: cattr_accessor :default_charset +325: cattr_accessor :logger +329: cattr_accessor :resource_action_separator +333: cattr_accessor :resources_path_names +337: cattr_accessor :request_forgery_protection_token +341: cattr_accessor :optimise_named_routes +351: cattr_accessor :use_accept_header +361: cattr_accessor :relative_url_root
+actionpack/lib/action_controller/caching/pages.rb +55: cattr_accessor :page_cache_directory +58: cattr_accessor :page_cache_extension
+actionpack/lib/action_controller/caching.rb +37: cattr_reader :cache_store +48: cattr_accessor :perform_caching
+actionpack/lib/action_controller/dispatcher.rb +98: cattr_accessor :error_file_path
+actionpack/lib/action_controller/mime_type.rb +24: cattr_reader :html_types, :unverifiable_types
+actionpack/lib/action_controller/rescue.rb +36: base.cattr_accessor :rescue_responses +40: base.cattr_accessor :rescue_templates
+actionpack/lib/action_controller/session/active_record_store.rb +60: cattr_accessor :data_column_name +170: cattr_accessor :connection +173: cattr_accessor :table_name +177: cattr_accessor :session_id_column +181: cattr_accessor :data_column +282: cattr_accessor :session_class
+actionpack/lib/action_controller/vendor/html-scanner/html/sanitizer.rb +44: cattr_accessor :included_tags, :instance_writer ⇒ false
+actionpack/lib/action_view/base.rb +189: cattr_accessor :debug_rjs +193: cattr_accessor :warn_cache_misses
+actionpack/lib/action_view/helpers/active_record_helper.rb +7: cattr_accessor :field_error_proc
+actionpack/lib/action_view/helpers/form_helper.rb +805: cattr_accessor :default_form_builder
+actionpack/lib/action_view/template_handlers/erb.rb +47: cattr_accessor :erb_trim_mode
+actionpack/test/active_record_unit.rb +5: cattr_accessor :able_to_connect +6: cattr_accessor :connected
+actionpack/test/controller/filters_test.rb +286: cattr_accessor :execution_log
+actionpack/test/template/form_options_helper_test.rb +3:TZInfo::Timezone.cattr_reader :loaded_zones
+activemodel/lib/active_model/errors.rb +28: cattr_accessor :default_error_messages
+activemodel/Rakefile +19: rdoc.options << —line-numbers << —inline-source << -A cattr_accessor=object
+activerecord/lib/active_record/attribute_methods.rb +9: base.cattr_accessor :attribute_types_cached_by_default, :instance_writer ⇒ false +11: base.cattr_accessor :time_zone_aware_attributes, :instance_writer ⇒ false
+activerecord/lib/active_record/base.rb +394: cattr_accessor :logger, :instance_writer ⇒ false +443: cattr_accessor :configurations, :instance_writer ⇒ false +450: cattr_accessor :primary_key_prefix_type, :instance_writer ⇒ false +456: cattr_accessor :table_name_prefix, :instance_writer ⇒ false +461: cattr_accessor :table_name_suffix, :instance_writer ⇒ false +467: cattr_accessor :pluralize_table_names, :instance_writer ⇒ false +473: cattr_accessor :colorize_logging, :instance_writer ⇒ false +478: cattr_accessor :default_timezone, :instance_writer ⇒ false +487: cattr_accessor :schema_format , :instance_writer ⇒ false +491: cattr_accessor :timestamped_migrations , :instance_writer ⇒ false
+activerecord/lib/active_record/connection_adapters/abstract/connection_specification.rb +11: cattr_accessor :connection_handler, :instance_writer ⇒ false
+activerecord/lib/active_record/connection_adapters/mysql_adapter.rb +166: cattr_accessor :emulate_booleans
+activerecord/lib/active_record/fixtures.rb +498: cattr_accessor :all_loaded_fixtures
+activerecord/lib/active_record/locking/optimistic.rb +38: base.cattr_accessor :lock_optimistically, :instance_writer ⇒ false
+activerecord/lib/active_record/migration.rb +259: cattr_accessor :verbose
+activerecord/lib/active_record/schema_dumper.rb +13: cattr_accessor :ignore_tables
+activerecord/lib/active_record/serializers/json_serializer.rb +4: base.cattr_accessor :include_root_in_json, :instance_writer ⇒ false
+activerecord/Rakefile +142: rdoc.options << —line-numbers << —inline-source << -A cattr_accessor=object
+activerecord/test/cases/lifecycle_test.rb +61: cattr_reader :last_inherited
+activerecord/test/cases/mixin_test.rb +9: cattr_accessor :forced_now_time
+activeresource/lib/active_resource/base.rb +206: cattr_accessor :logger
+activeresource/Rakefile +43: rdoc.options << —line-numbers << —inline-source << -A cattr_accessor=object
+activesupport/lib/active_support/buffered_logger.rb +17: cattr_accessor :silencer
+activesupport/lib/active_support/cache.rb +81: cattr_accessor :logger
+activesupport/lib/active_support/core_ext/class/attribute_accessors.rb +5:# cattr_accessor :hair_colors +10: def cattr_reader(*syms) +29: def cattr_writer(*syms) +50: def cattr_accessor(*syms) +51: cattr_reader(*syms) +52: cattr_writer(*syms)
+activesupport/lib/active_support/core_ext/logger.rb +34: cattr_accessor :silencer
+activesupport/test/core_ext/class/attribute_accessor_test.rb +6: cattr_accessor :foo +7: cattr_accessor :bar, :instance_writer ⇒ false
+activesupport/test/core_ext/module/synchronization_test.rb +6: @target.cattr_accessor :mutex, :instance_writer ⇒ false
+railties/doc/guides/html/creating_plugins.html +786: cattr_accessor <span style="color: #990000">:</span>yaffle_text_field<span style="color: #990000">,</span> <span style="color: #990000">:</span>yaffle_date_field +860: cattr_accessor <span style="color: #990000">:</span>yaffle_text_field<span style="color: #990000">,</span> <span style="color: #990000">:</span>yaffle_date_field
+railties/lib/rails_generator/base.rb +93: cattr_accessor :logger
+railties/Rakefile +265: rdoc.options << —line-numbers << —inline-source << —accessor << cattr_accessor=object
+railties/test/rails_info_controller_test.rb +12: cattr_accessor :local_request
+Rakefile +32: rdoc.options << -A cattr_accessor=object
Chapters
- Create the basic app
-- Create the plugin
+- Generate the plugin skeleton
- Setup the plugin for testing
+- Run the plugin tests
+ + + +- + Extending core classes +
++ +
+- Creating the test
+ +- Organize your files
+ +- Working with init.rb
+ +- + Add an acts_as_yaffle method to Active Record +
+ +
- Add a class method
+ +- Add an instance method
+- - Add a to_squawk method to String + Create a generator +
+ +
- Testing generators
+ +- Adding to the manifest
+ +- Manually test the generator
+ +- The USAGE file
+ +- - Add an acts_as_yaffle method to ActiveRecord + Add a custom generator command
- - Create a squawk_info_for view helper + Add a model
- - Create a migration generator + Add a controller
- - Add a custom generator command + Add a helper
- Add a Custom Route @@ -232,12 +267,8 @@
Chapters
Odds and ends-
- Work with init.rb
-- Generate RDoc Documentation
-- Store models, views, helpers, and controllers in your plugins
-- Write custom Rake tasks in your plugin
- Store plugins in alternate locations
@@ -265,123 +296,107 @@Chapters
The Basics of Creating Rails Plugins
--Pretend for a moment that you are an avid bird watcher. Your favorite bird is the Yaffle, and you want to create a plugin that allows other developers to share in the Yaffle goodness.
+In this tutorial you will learn how to create a plugin that includes:
A Rails plugin is either an extension or a modification of the core framework. Plugins provide:
+
-Core Extensions - extending String with a to_squawk method: +a way for developers to share bleeding-edge ideas without hurting the stable code base
---# Anywhere -"hello!".to_squawk # => "squawk! hello!" --An acts_as_yaffle method for ActiveRecord models that adds a squawk method: +a segmented architecture so that units of code can be fixed or updated on their own release schedule
---class Hickwall < ActiveRecord::Base - acts_as_yaffle :yaffle_text_field => :last_sang_at -end - -Hickwall.new.squawk("Hello World") -- +
-A view helper that will print out squawking info: +an outlet for the core developers so that they don’t have to include every cool new feature under the sun
---squawk_info_for(@hickwall) -+After reading this guide you should be familiar with:
-
-A generator that creates a migration to add squawk columns to a model: +Creating a plugin from scratch
---script/generate yaffle hickwall--A custom generator command: +Writing and running tests for the plugin
---class YaffleGenerator < Rails::Generator::NamedBase - def manifest - m.yaffle_definition - end -end -- +
-A custom route method: +Storing models, views, controllers, helpers and even other plugins in your plugins +
+- +
++Writing generators +
+- +
++Writing custom Rake tasks in your plugin +
+- +
++Generating RDoc documentation for your plugin +
+- +
+Avoiding common pitfalls with init.rb
---ActionController::Routing::Routes.draw do |map| - map.yaffles -end -+In addition you'll learn how to:
This guide describes how to build a test-driven plugin that will:
+
- +
-test your plugins. +Extend core ruby classes like Hash and String +
+- +
++Add methods to ActiveRecord::Base in the tradition of the acts_as plugins +
+- +
+Add a view helper that can be used in erb templates
-work with init.rb, how to store model, views, controllers, helpers and even other plugins in your plugins. +Add a new generator that will generate a migration
-create documentation for your plugin. +Add a custom generator command
-write custom Rake tasks in your plugin. +A custom route method that can be used in routes.rb
For the purpose of this guide pretend for a moment that you are an avid bird watcher. Your favorite bird is the Yaffle, and you want to create a plugin that allows other developers to share in the Yaffle goodness. First, you need to get setup for development.
1. Preparation
1.1. Create the basic app
-+In this tutorial we will create a basic rails application with 1 resource: bird. Start out by building the basic rails app:
The examples in this guide require that you have a working rails application. To create a simple rails app execute:
-rails plugin_demo -cd plugin_demo +gem install rails +rails yaffle_guide +cd yaffle_guide script/generate scaffold bird name:string rake db:migrate script/server@@ -392,22 +407,24 @@1.1. Create the basic app
- The aforementioned instructions will work for sqlite3. For more detailed instructions on how to create a rails app for other databases see the API docs. ++ Editor's note:The aforementioned instructions will work for sqlite3. For more detailed instructions on how to create a rails app for other databases see the API docs.
1.2. Create the plugin
-The built-in Rails plugin generator stubs out a new plugin. Pass the plugin name, either CamelCased or under_scored, as an argument. Pass --with-generator to add an example generator also.
1.2. Generate the plugin skeleton
+Rails ships with a plugin generator which creates a basic plugin skeleton. Pass the plugin name, either CamelCased or under_scored, as an argument. Pass --with-generator to add an example generator also.
This creates a plugin in vendor/plugins including an init.rb and README as well as standard lib, task, and test directories.
Examples:
-
./script/generate plugin BrowserFilters -./script/generate plugin BrowserFilters --with-generator+
./script/generate plugin yaffle +./script/generate plugin yaffle --with-generator
Later in the plugin we will create a generator, so go ahead and add the --with-generator option now:
To get more detailed help on the plugin generator, type ./script/generate plugin.
Later on this guide will describe how to work with generators, so go ahead and generate your plugin with the --with-generator option now:
-
script/generate plugin yaffle --with-generator+
./script/generate plugin yaffle --with-generator
You should see the following output:
@@ -430,51 +447,37 @@
1.2. Create the plugin
create vendor/plugins/yaffle/generators/yaffle/yaffle_generator.rb create vendor/plugins/yaffle/generators/yaffle/USAGEFor this plugin you won't need the file vendor/plugins/yaffle/lib/yaffle.rb so you can delete that.
-
-
-
rm vendor/plugins/yaffle/lib/yaffle.rb-
-
-
+|
-
- |
-
- Editor's note: Many plugin authors prefer to keep this file, and add all of the require statements in it. That way, they only line in init.rb would be require "yaffle". If you are developing a plugin that has a lot of files in the lib directory, you may want to create a subdirectory like lib/yaffle and store your files in there. That way your init.rb file stays clean |
-
To begin just change one thing - move init.rb to rails/init.rb.
1.3. Setup the plugin for testing
-Testing plugins that use the entire Rails stack can be complex, and the generator doesn't offer any help. In this tutorial you will learn how to test your plugin against multiple different adapters using ActiveRecord. This tutorial will not cover how to use fixtures in plugin tests.
If your plugin interacts with a database, you'll need to setup a database connection. In this guide you will learn how to test your plugin against multiple different database adapters using Active Record. This guide will not cover how to use fixtures in plugin tests.
To setup your plugin to allow for easy testing you'll need to add 3 files:
-
-A database.yml file with all of your connection strings. +A database.yml file with all of your connection strings
-
-A schema.rb file with your table definitions. +A schema.rb file with your table definitions
-
-A test helper that sets up the database before your tests. +A test helper method that sets up the database
For this plugin you'll need 2 tables/models, Hickwalls and Wickwalls, so add the following files:
vendor/plugins/yaffle/test/database.yml:
sqlite: :adapter: sqlite - :dbfile: yaffle_plugin.sqlite.db + :dbfile: vendor/plugins/yaffle/test/yaffle_plugin.sqlite.db sqlite3: :adapter: sqlite3 - :dbfile: yaffle_plugin.sqlite3.db + :dbfile: vendor/plugins/yaffle/test/yaffle_plugin.sqlite3.db postgresql: :adapter: postgresql @@ -486,11 +489,12 @@1.3. Setup the plugin for testing
mysql: :adapter: mysql :host: localhost - :username: rails - :password: + :username: root + :password: password :database: yaffle_plugin_test
vendor/plugins/yaffle/test/test_helper.rb:
For this guide you'll need 2 tables/models, Hickwalls and Wickwalls, so add the following:
vendor/plugins/yaffle/test/schema.rb:
+
ENV['RAILS_ENV'] = 'test' ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..' require 'test/unit' require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb')) -config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml')) -ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log") +def load_schema + config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml')) + ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log") -db_adapter = ENV['DB'] + db_adapter = ENV['DB'] -# no db passed, try one of these fine config-free DBs before bombing. -db_adapter ||= - begin - require 'rubygems' - require 'sqlite' - 'sqlite' - rescue MissingSourceFile + # no db passed, try one of these fine config-free DBs before bombing. + db_adapter ||= begin - require 'sqlite3' - 'sqlite3' + require 'rubygems' + require 'sqlite' + 'sqlite' rescue MissingSourceFile + begin + require 'sqlite3' + 'sqlite3' + rescue MissingSourceFile + end end + + if db_adapter.nil? + raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3." end -if db_adapter.nil? - raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3." + ActiveRecord::Base.establish_connection(config[db_adapter]) + load(File.dirname(__FILE__) + "/schema.rb") + require File.dirname(__FILE__) + '/../rails/init.rb' end +
Now whenever you write a test that requires the database, you can call load_schema.
1.4. Run the plugin tests
+Once you have these files in place, you can write your first test to ensure that your plugin-testing setup is correct. By default rails generates a file in vendor/plugins/yaffle/test/yaffle_test.rb with a sample test. Replace the contents of that file with:
vendor/plugins/yaffle/test/yaffle_test.rb:
+
+
+
require File.dirname(__FILE__) + '/test_helper.rb' -ActiveRecord::Base.establish_connection(config[db_adapter]) +class YaffleTest < Test::Unit::TestCase + load_schema -load(File.dirname(__FILE__) + "/schema.rb") + class Hickwall < ActiveRecord::Base + end -require File.dirname(__FILE__) + '/../init.rb' + class Wickwall < ActiveRecord::Base + end -class Hickwall < ActiveRecord::Base - acts_as_yaffle -end + def test_schema_has_loaded_correctly + assert_equal [], Hickwall.all + assert_equal [], Wickwall.all + end -class Wickwall < ActiveRecord::Base - acts_as_yaffle :yaffle_text_field => :last_tweet, :yaffle_date_field => :last_tweeted_at end
To run this, go to the plugin directory and run rake:
+
+
+
cd vendor/plugins/yaffle +rake+
You should see output like:
+
+
+
/opt/local/bin/ruby -Ilib:lib "/opt/local/lib/ruby/gems/1.8/gems/rake-0.8.3/lib/rake/rake_test_loader.rb" "test/yaffle_test.rb"
+-- create_table(:hickwalls, {:force=>true})
+ -> 0.0220s
+-- create_table(:wickwalls, {:force=>true})
+ -> 0.0077s
+-- initialize_schema_migrations_table()
+ -> 0.0007s
+-- assume_migrated_upto_version(0)
+ -> 0.0007s
+Loaded suite /opt/local/lib/ruby/gems/1.8/gems/rake-0.8.3/lib/rake/rake_test_loader
+Started
+.
+Finished in 0.002236 seconds.
+
+1 test, 1 assertion, 0 failures, 0 errors
+By default the setup above runs your tests with sqlite or sqlite3. To run tests with one of the other connection strings specified in database.yml, pass the DB environment variable to rake:
+
+
+
rake DB=sqlite +rake DB=sqlite3 +rake DB=mysql +rake DB=postgresql+
Now you are ready to test-drive your plugin!
+
+