RubyGems - railties - Versions diffs - 3.0.0.beta → 3.0.0.beta2 - Mend

railties 3.0.0.beta → 3.0.0.beta2

Files changed (232) hide show

data/guides/source/activerecord_validations_callbacks.textile CHANGED

@@ -44,7 +44,7 @@ class Person < ActiveRecord::Base
 end
 </ruby>
-We can see how it works by looking at some script/console output:
+We can see how it works by looking at some +rails console+ output:
 <shell>
 >> p = Person.new(:name => "John Doe")
@@ -240,11 +240,11 @@ 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. This example uses the +:message+ option to show how you can include the attribute's value.
-The default error message for +validates_exclusion_of+  is "_is not included in the list_".
+The default error message for +validates_exclusion_of+  is "_is reserved_".
 h4. +validates_format_of+
-This helper validates the attributes' values by testing whether they match a given regular expresion, which is specified using the +:with+ option.
+This helper validates the attributes' values by testing whether they match a given regular expression, which is specified using the +:with+ option.
 <ruby>
 class Product < ActiveRecord::Base

data/guides/source/caching_with_rails.textile CHANGED

@@ -152,7 +152,7 @@ expire_fragment('all_available_products')
 h4. Sweepers
-Cache sweeping is a mechanism which allows you to get around having a ton of +expire_{page,action,fragment}+ calls in your code.  It does this by moving all the work required to expire cached content into a +ActionController::Caching::Sweeper+ class.  This class is an Observer and looks for changes to an object via callbacks, and when a change occurs it expires the caches associated with that object in an around or after filter.
+Cache sweeping is a mechanism which allows you to get around having a ton of +expire_{page,action,fragment}+ calls in your code.  It does this by moving all the work required to expire cached content into an +ActionController::Caching::Sweeper+ subclass.  This class is an observer and looks for changes to an object via callbacks, and when a change occurs it expires the caches associated with that object in an around or after filter.
 Continuing with our Product controller example, we could rewrite it with a sweeper like this:

data/guides/source/command_line.textile CHANGED

@@ -12,15 +12,18 @@ NOTE: This tutorial assumes you have basic Rails knowledge from reading the "Get
 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. 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
+* rails console
+* rails server
 * rake
-* generate
-* rails
+* rails generate
+* rails dbconsole
+* rails app_name
 Let's create a simple Rails application to step through each of these commands in context.
@@ -28,37 +31,39 @@ h4. +rails+
 The first thing we'll want to do is create a new Rails application by running the +rails+ command after installing Rails.
-WARNING: You know you need the rails gem installed by typing +gem install rails+ first, right? Okay, okay, just making sure.
+WARNING: You know you need the rails gem installed by typing +gem install rails+ first, if you don't have this installed, follow the instructions in the "Rails 3 Release Notes":/3_0_release_notes.textile
 <shell>
 $ rails commandsapp
-     create
-     create  app/controllers
-     create  app/helpers
-     create  app/models
-     ...
+     create
+     create  README
+     create  .gitignore
+     create  Rakefile
+     create  config.ru
+     create  Gemfile
+     create  app
      ...
-     create  log/production.log
-     create  log/development.log
-     create  log/test.log
+     create  tmp/cache
+     create  tmp/pids
+     create  vendor/plugins
+     create  vendor/plugins/.gitkeep
 </shell>
 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.
 INFO: This output will seem very familiar when we get to the +generate+ command. Creepy foreshadowing!
-h4. +server+
+h4. +rails server+
-Let's try it! The +server+ command launches a small web server named WEBrick which comes bundled with Ruby. You'll use this any time you want to view your work through a web browser.
+Let's try it! The +rails server+ command launches a small web server named WEBrick which comes bundled with Ruby. You'll use this any time you want to view your work through a web browser.
 INFO: WEBrick isn't your only option for serving Rails. We'll get to that in a later section.
-Without any prodding of any kind, +server+ will run our new shiny Rails app:
+Without any prodding of any kind, +rails server+ will run our new shiny Rails app:
 <shell>
 $ cd commandsapp
-$ ./script/server
+$ rails 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
@@ -67,45 +72,45 @@ $ ./script/server
 [2008-11-04 10:11:38] INFO  WEBrick::HTTPServer#start: pid=18994 port=3000
 </shell>
-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.
+With just three commands we whipped up a Rails server listening on port 3000. Go to your browser and open "http://localhost:3000":http://localhost:3000, you will see a basic rails app running.
-See? Cool! It doesn't do much yet, but we'll change that.
+h4. +rails generate+
-h4. +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:
+The +rails generate+ command uses templates to create a whole lot of things. You can always find out what's available by running +rails generate+ by itself. Let's do that:
 <shell>
-$ ./script/generate
-Usage: ./script/generate generator [options] [args]
+$ rails generate
+Usage: rails generate generator [options] [args]
 ...
 ...
-Installed Generators
-  Built-in: controller, integration_test, mailer, migration, model, observer, performance_test, plugin, resource, scaffold, session_migration
+Please choose a generator below.
-...
-...
+Rails:
+  controller
+  generator
+  ...
+  ...
 </shell>
 NOTE: 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?
+Using generators will save you a large amount of time by writing *boilerplate code*, code that is necessary for the app to work, but not necessary for you to spend time writing. That's what we have computers for.
 Let's make our own controller with the controller generator. But what command should we use? Let's ask the generator:
-INFO: All Rails console utilities have help text. As with most *NIX utilities, you can try adding +--help+ or +-h+ to the end, for example +./script/server --help+.
+INFO: All Rails console utilities have help text. As with most *NIX utilities, you can try adding +--help+ or +-h+ to the end, for example +rails server --help+.
 <shell>
-$ ./script/generate controller
-Usage: ./script/generate controller ControllerName [options]
+$ rails generate controller
+Usage: rails generate controller ControllerName [options]
 ...
 ...
 Example:
-    ./script/generate controller CreditCard open debit credit close
+    rails generate controller CreditCard open debit credit close
     Credit card controller with URLs like /credit_card/debit.
         Controller: app/controllers/credit_card_controller.rb
@@ -114,7 +119,7 @@ Example:
         Test:       test/functional/credit_card_controller_test.rb
 Modules Example:
-    ./script/generate controller 'admin/credit_card' suspend late_fee
+    rails 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
@@ -123,81 +128,80 @@ Modules Example:
         Test:       test/functional/admin/credit_card_controller_test.rb
 </shell>
-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.
+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.
 <shell>
-$ ./script/generate controller Greetings hello
-     exists  app/controllers/
-     exists  app/helpers/
-     create  app/views/greetings
-     exists  test/functional/
+$ rails generate controller Greetings hello
      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
+     invoke  erb
+     create    app/views/greetings
+     create    app/views/greetings/hello.html.erb
+      error  rspec [not found]
+     invoke  helper
+     create    app/helpers/greetings_helper.rb
+      error    rspec [not found]
 </shell>
-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.
+What all did this generate?  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.
-Let's check out the controller and modify it a little (in +app/controllers/greetings_controller.rb+):
+Check out the controller and modify it a little (in +app/controllers/greetings_controller.rb+):ma
 <ruby>
 class GreetingsController < ApplicationController
   def hello
-    @message = "Hello, how are you today? I am exuberant!"
+    @message = "Hello, how are you today?"
   end
 end
 </ruby>
-Then the view, to display our nice message (in +app/views/greetings/hello.html.erb+):
+Then the view, to display our message (in +app/views/greetings/hello.html.erb+):
 <html>
 <h1>A Greeting for You!</h1>
 <p><%= @message %></p>
 </html>
-Deal. Go check it out in your browser. Fire up your server. Remember? +./script/server+ at the root of your Rails application should do it.
+Deal. Go check it out in your browser. Fire up your server. Remember? +rails server+ at the root of your Rails application should do it.
 <shell>
-$ ./script/server
+$ rails server
 => Booting WEBrick...
 </shell>
 WARNING: Make sure that you do not have any "tilde backup" files in +app/views/(controller)+, or else WEBrick will _not_ show the expected output. This seems to be a *bug* in Rails 2.3.0.
-The URL will be +http://localhost:3000/greetings/hello+. I'll wait for you to be suitably impressed.
+The URL will be "http://localhost:3000/greetings/hello":http://localhost:3000/greetings/hello.
 INFO: With a normal, plain-old Rails application, your URLs will generally follow the pattern of http://(host)/(controller)/(action), and a URL like http://(host)/(controller) will hit the *index* action of that controller.
-"What about data, though?", you ask over a cup of coffee. Rails comes with a generator for data models too. Can you guess its generator name?
+Rails comes with a generator for data models too:
 <shell>
-$ ./script/generate model
-Usage: ./script/generate model ModelName [field:type, field:type]
+$ rails generate model
+Usage: rails generate model ModelName [field:type, field:type]
 ...
 Examples:
-    ./script/generate model account
+    rails generate model account
-        creates an Account model, test, fixture, and migration:
             Model:      app/models/account.rb
             Test:       test/unit/account_test.rb
             Fixtures:   test/fixtures/accounts.yml
             Migration:  db/migrate/XXX_add_accounts.rb
-    ./script/generate model post title:string body:text published:boolean
+    rails generate model post title:string body:text published:boolean
-        creates a Post model with a string title, text body, and published flag.
+        Creates a Post model with a string title, text body, and published flag.
 </shell>
 But instead of generating a model directly (which we'll be doing later), let's set up a scaffold. A *scaffold* in Rails is a full set of model, database migration for that model, controller to manipulate it, views to view and manipulate the data, and a test suite for each of the above.
-Let's set up a simple resource called "HighScore" that will keep track of our highest score on video games we play.
+We will set up a simple resource called "HighScore" that will keep track of our highest score on video games we play.
 <shell>
-$ ./script/generate scaffold HighScore game:string score:integer
+$ rails generate scaffold HighScore game:string score:integer
     exists  app/models/
     exists  app/controllers/
     exists  app/helpers/
@@ -227,45 +231,43 @@ dependency  model
     create    db/migrate/20081217071914_create_high_scores.rb
 </shell>
-Taking it from the top - the generator checks that there exist the directories for models, controllers, helpers, layouts, functional and unit tests, stylesheets, creates the views, controller, model and database migration for HighScore (creating the +high_scores+ table and fields), takes care of the route for the *resource*, and new tests for everything.
+The generator checks that there exist the directories for models, controllers, helpers, layouts, functional and unit tests, stylesheets, creates the views, controller, model and database migration for HighScore (creating the +high_scores+ table and fields), takes care of the route for the *resource*, and new tests for everything.
-The migration requires that we *migrate*, that is, run some Ruby code (living in that +20081217071914_create_high_scores.rb+) to modify the schema of our database. Which database? The sqlite3 database that Rails will create for you when we run the +rake db:migrate+ command. We'll talk more about Rake in-depth in a little while.
-CAUTION: Hey. Install the sqlite3-ruby gem while you're at it. +gem install sqlite3-ruby+
+The migration requires that we *migrate*, that is, run some Ruby code (living in that +20100209025147_create_high_scores.rb+) to modify the schema of our database. Which database? The sqlite3 database that Rails will create for you when we run the +rake db:migrate+ command. We'll talk more about Rake in-depth in a little while.
 <shell>
 $ rake db:migrate
-(in /home/commandsapp)
-  CreateHighScores: migrating
-    create_table(:high_scores)
-    -> 0.0070s
-  CreateHighScores: migrated (0.0077s)
+(in /Users/mikel/rails_programs/commandsapp)
+==  CreateHighScores: migrating ===============================================
+-- create_table(:high_scores)
+   -> 0.0026s
+==  CreateHighScores: migrated (0.0028s) ======================================
 </shell>
 INFO: Let's talk about unit tests. Unit tests are code that tests and makes assertions about code. In unit testing, we take a little part of code, say a method of a model, and test its inputs and outputs. Unit tests are your friend. The sooner you make peace with the fact that your quality of life will drastically increase when you unit test your code, the better. Seriously. We'll make one in a moment.
-Let's see the interface Rails created for us. ./script/server; http://localhost:3000/high_scores
+Let's see the interface Rails created for us. rails server; http://localhost:3000/high_scores
 We can create new high scores (55,160 on Space Invaders!)
-h4. +console+
+h4. +rails console+
-The +console+ command lets you interact with your Rails application from the command line. On the underside, +script/console+ uses IRB, so if you've ever used it, you'll be right at home. This is useful for testing out quick ideas with code and changing data server-side without touching the website.
+The +console+ command lets you interact with your Rails application from the command line. On the underside, +rails console+ uses IRB, so if you've ever used it, you'll be right at home. This is useful for testing out quick ideas with code and changing data server-side without touching the website.
-h4. +dbconsole+
+h4. +rails dbconsole+
-+dbconsole+ figures out which database you're using and drops you into whichever command line interface you would use with it (and figures out the command line parameters to give to it, too!). It supports MySQL, PostgreSQL, SQLite and SQLite3.
++rails dbconsole+ figures out which database you're using and drops you into whichever command line interface you would use with it (and figures out the command line parameters to give to it, too!). It supports MySQL, PostgreSQL, SQLite and SQLite3.
-h4. +plugin+
+h4. +rails plugin+
-The +plugin+ command simplifies plugin management; think a miniature version of the Gem utility. Let's walk through installing a plugin. You can call the sub-command *discover*, which sifts through repositories looking for plugins, or call *source* to add a specific repository of plugins, or you can specify the plugin location directly.
+The +rails plugin+ command simplifies plugin management; think a miniature version of the Gem utility. Let's walk through installing a plugin. You can call the sub-command *discover*, which sifts through repositories looking for plugins, or call *source* to add a specific repository of plugins, or you can specify the plugin location directly.
 Let's say you're creating a website for a client who wants a small accounting system. Every event having to do with money must be logged, and must never be deleted. Wouldn't it be great if we could override the behavior of a model to never actually take its record out of the database, but *instead*, just set a field?
 There is such a thing! The plugin we're installing is called "acts_as_paranoid", and it lets models implement a "deleted_at" column that gets set when you call destroy. Later, when calling find, the plugin will tack on a database check to filter out "deleted" things.
+==================================================================================
 <shell>
-$ ./script/plugin install http://svn.techno-weenie.net/projects/plugins/acts_as_paranoid
+$ rails plugin install http://svn.techno-weenie.net/projects/plugins/acts_as_paranoid
 + ./CHANGELOG
 + ./MIT-LICENSE
 ...
@@ -277,7 +279,7 @@ h4. +runner+
 <tt>runner</tt> runs Ruby code in the context of Rails non-interactively. For instance:
 <shell>
-$ ./script/runner "Model.long_running_method"
+$ rails runner "Model.long_running_method"
 </shell>
 h4. +destroy+
@@ -285,7 +287,7 @@ h4. +destroy+
 Think of +destroy+ as the opposite of +generate+. It'll figure out what generate did, and undo it. Believe you-me, the creation of this tutorial used this command many times!
 <shell>
-$ ./script/generate model Oops
+$ rails generate model Oops
       exists  app/models/
       exists  test/unit/
       exists  test/fixtures/
@@ -294,7 +296,7 @@ $ ./script/generate model Oops
       create  test/fixtures/oops.yml
       exists  db/migrate
       create  db/migrate/20081221040817_create_oops.rb
-$ ./script/destroy model Oops
+$ rails destroy model Oops
     notempty  db/migrate
     notempty  db
           rm  db/migrate/20081221040817_create_oops.rb
@@ -314,7 +316,7 @@ h4. +about+
 Check it: Version numbers for Ruby, RubyGems, Rails, the Rails subcomponents, your application's folder, the current Rails environment name, your app's database adapter, and schema version! +about+ is useful when you need to ask for help, check if a security patch might affect you, or when you need some stats for an existing Rails installation.
 <shell>
-$ ./script/about
+$ rails about
 About your application's environment
 Ruby version              1.8.6 (i486-linux)
 RubyGems version          1.3.1
@@ -399,7 +401,7 @@ Many people have created a large number different web servers in Ruby, and many
 NOTE: For more details on the Rack integration, see "Rails on Rack":rails_on_rack.html.
-To use a different server, just install its gem, then use its name for the first parameter to +script/server+:
+To use a different server, just install its gem, then use its name for the first parameter to +rails server+:
 <shell>
 $ sudo gem install mongrel
@@ -412,9 +414,9 @@ Successfully installed mongrel-1.1.5
 ...
 ...
 Installing RDoc documentation for mongrel-1.1.5...
-$ script/server mongrel
-=> Booting Mongrel (use 'script/server webrick' to force WEBrick)
-=> Rails 2.2.0 application starting on http://0.0.0.0:3000
+$ rails server mongrel
+=> Booting Mongrel (use 'rails server webrick' to force WEBrick)
+=> Rails 3.0.0 application starting on http://0.0.0.0:3000
 ...
 </shell>
@@ -481,7 +483,7 @@ I got assigned some args:
 Then we'll make sure it got included in the list of available generators:
 <shell>
-$ ./script/generate
+$ rails generate
 ...
 ...
 Installed Generators
@@ -491,7 +493,7 @@ Installed Generators
 SWEET! Now let's generate some text, yeah!
 <shell>
-$ ./script/generate tutorial_test arg1 arg2 arg3
+$ rails generate tutorial_test arg1 arg2 arg3
       exists  public
       create  public/tutorial.txt
 </shell>

data/guides/source/configuring.textile CHANGED

@@ -9,24 +9,24 @@ endprologue.
 h3. Locations for Initialization Code
-Rails offers (at least) five good spots to place initialization code:
+Rails offers (at least) four good spots to place initialization code:
-* Preinitializers
-* environment.rb
+* application.rb
 * Environment-specific Configuration Files
 * Initializers (load_application_initializers)
 * After-Initializers
-h3. Using a Preinitializer
+h3. Running Code Before Rails
-Rails allows you to use a preinitializer to run code before the framework itself is loaded. If you save code in +RAILS_ROOT/config/preinitializer.rb+, that code will be the first thing loaded, before any of the framework components (Active Record, Action Pack, and so on.) If you want to change the behavior of one of the classes that is used in the initialization process, you can do so in this file.
+To run some code before Rails itself is loaded, simply put it above the call to
++require 'rails/all'+ in your +application.rb+.
 h3. Configuring Rails Components
-In general, the work of configuring Rails means configuring the components of Rails, as well as configuring Rails itself. The +environment.rb+ and environment-specific configuration files (such as +config/environments/production.rb+) allow you to specify the various settings that you want to pass down to all of the components. For example, the default Rails 2.3 +environment.rb+ file includes one setting:
+In general, the work of configuring Rails means configuring the components of Rails, as well as configuring Rails itself. The +application.rb+ and environment-specific configuration files (such as +config/environments/production.rb+) allow you to specify the various settings that you want to pass down to all of the components. For example, the default Rails 2.3 +application.rb+ file includes one setting:
 <ruby>
-config.time_zone = 'UTC'
+config.filter_parameters << :password
 </ruby>
 This is a setting for Rails itself. If you want to pass settings to individual Rails components, you can do so via the same +config+ object:
@@ -53,8 +53,6 @@ h4. Rails General Configuration
 * +config.eager_load_paths+ accepts an array of paths from which Rails will eager load on boot if cache classes is enabled. All elements of this array must also be in +load_paths+.
-* +config.frameworks+ accepts an array of rails framework components that should be loaded. (Defaults to +:active_record+, +:action_controller+, +:action_view+, +:action_mailer+, and +:active_resource+).
 * +config.load_once_paths+ accepts an array of paths from which Rails will automatically load from only once. All elements of this array must also be in +load_paths+.
 * +config.load_paths+ accepts an array of additional paths to prepend to the load path. By default, all app, lib, vendor and mock paths are included in this list.
@@ -133,6 +131,8 @@ h4. Configuring Action Controller
 * +config.action_controller.asset_host+ provides a string that is prepended to all of the URL-generating helpers in +AssetHelper+. This is designed to allow moving all javascript, CSS, and image files to a separate asset host.
+* +config.action_controller.asset_path+ allows you to override the default asset path generation by providing your own instructions.
 * +config.action_controller.consider_all_requests_local+ is generally set to +true+ during development and +false+ during production; if it is set to +true+, then any error will cause detailed debugging information to be dumped in the HTTP response. For finer-grained control, set this to +false+ and implement +local_request?+ to specify which requests should provide debugging information on errors.
 * +config.action_controller.allow_concurrency+ should be set to +true+ to allow concurrent (threadsafe) action processing. Set to +false+ by default. You probably don't want to call this one directly, though, because a series of other adjustments need to be made for threadsafe mode to work properly. Instead, you should simply call +config.threadsafe!+ inside your +production.rb+ file, which makes all the necessary adjustments.
@@ -159,7 +159,7 @@ WARNING: Threadsafe operation in incompatible with the normal workings of develo
 * +config.action_controller.relative_url_root+ can be used to tell Rails that you are deploying to a subdirectory. The default is +ENV['RAILS_RELATIVE_URL_ROOT']+.
-* +config.action_controller.session_store+ sets the name of the store for session data. The default is +:cookie_store+; other valid options include +:active_record_store+, +:mem_cache_store+ or the name of your own custom class.
+* +config.action_dispatch.session_store+ sets the name of the store for session data. The default is +:cookie_store+; other valid options include +:active_record_store+, +:mem_cache_store+ or the name of your own custom class.
 The caching code adds two additional settings: