diff options
Diffstat (limited to 'railties')
| -rw-r--r-- | railties/README | 241 | ||||
| -rw-r--r-- | railties/guides/source/3_0_release_notes.textile | 1 | ||||
| -rw-r--r-- | railties/guides/source/active_support_core_extensions.textile | 127 | ||||
| -rw-r--r-- | railties/guides/source/activerecord_validations_callbacks.textile | 10 | ||||
| -rw-r--r-- | railties/guides/source/routing.textile | 2 | ||||
| -rw-r--r-- | railties/lib/rails/configuration.rb | 4 | ||||
| -rw-r--r-- | railties/lib/rails/generators/rails/app/templates/README | 295 | ||||
| -rw-r--r-- | railties/lib/rails/log_subscriber.rb | 13 | ||||
| -rw-r--r-- | railties/lib/rails/rack/logger.rb | 7 | ||||
| -rw-r--r-- | railties/test/application/initializers/frameworks_test.rb | 4 | ||||
| -rw-r--r-- | railties/test/application/middleware_test.rb | 6 | ||||
| -rw-r--r-- | railties/test/isolation/abstract_unit.rb | 2 |
12 files changed, 442 insertions, 270 deletions
diff --git a/railties/README b/railties/README index e4de4a5cb2..b8c84dd07d 100644 --- a/railties/README +++ b/railties/README @@ -3,12 +3,13 @@ Rails is a web-application framework that includes everything needed to create database-backed web applications according to the Model-View-Control pattern. -This pattern splits the view (also called the presentation) into "dumb" templates -that are primarily responsible for inserting pre-built data in between HTML tags. -The model contains the "smart" domain objects (such as Account, Product, Person, -Post) that holds all the business logic and knows how to persist themselves to -a database. The controller handles the incoming requests (such as Save New Account, -Update Product, Show Post) by manipulating the model and directing data to the view. +This pattern splits the view (also called the presentation) into "dumb" +templates that are primarily responsible for inserting pre-built data in between +HTML tags. The model contains the "smart" domain objects (such as Account, +Product, Person, Post) that holds all the business logic and knows how to +persist themselves to a database. The controller handles the incoming requests +(such as Save New Account, Update Product, Show Post) by manipulating the model +and directing data to the view. In Rails, the model is handled by what's called an object-relational mapping layer entitled Active Record. This layer allows you to present the data from @@ -21,88 +22,65 @@ layers by its two parts: Action View and Action Controller. These two layers are bundled in a single package due to their heavy interdependence. This is unlike the relationship between the Active Record and Action Pack that is much more separate. Each of these packages can be used independently outside of -Rails. You can read more about Action Pack in +Rails. You can read more about Action Pack in link:files/vendor/rails/actionpack/README.html. == Getting Started -1. At the command prompt, start a new Rails application using the <tt>rails</tt> command - and your application name. Ex: <tt>rails myapp</tt> -2. Change directory into myapp and start the web server: <tt>rails server</tt> (run with --help for options) -3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!" -4. Follow the guidelines to start developing your application +1. At the command prompt, create a new Rails application: + <tt>rails myapp</tt> (where <tt>myapp</tt> is the application name) +2. Change directory to <tt>myapp</tt> and start the web server: + <tt>cd myapp; rails server</tt> (run with --help for options) -== Web Servers - -By default, Rails will try to use Mongrel if it's installed when started with <tt>rails server</tt>, otherwise -Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails with a variety of -other web servers. - -Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is -suitable for development and deployment of Rails applications. If you have Ruby Gems installed, -getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>. -More info at: http://mongrel.rubyforge.org - -Other ruby web servers exist which can run your rails application, however <tt>rails server</tt> does -not search for them or start them. These include {Thin}[http://code.macournoyer.com/thin/], {Ebb}[http://ebb.rubyforge.org/], and Apache with {mod_rails}[http://www.modrails.com/]. - -For production use, often a web/proxy server such as {Apache}[http://apache.org], {Nginx}[http://nginx.net/], {LiteSpeed}[http://litespeedtech.com/], {Lighttpd}[http://www.lighttpd.net/] or {IIS}[http://www.iis.net/] is -deployed as the front-end server, with the chosen ruby web server running in the back-end -and receiving the proxied requests via one of several protocols (HTTP, CGI, FCGI). - +3. Go to http://localhost:3000/ and you'll see: + "Welcome aboard: You're riding the Rails!" -== Apache .htaccess example for FCGI/CGI +4. Follow the guidelines to start developing your application. You can find +the following resources handy: -General Apache options +* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html +* Ruby on Rails Tutorial Book: http://www.railstutorial.org/ - AddHandler fastcgi-script .fcgi - AddHandler cgi-script .cgi - Options +FollowSymLinks +ExecCGI -If you don't want Rails to look in certain directories, use the following -rewrite rules so that Apache won't rewrite certain requests. - - RewriteCond %{REQUEST_URI} ^/notrails.* - RewriteRule .* - [L] - -Redirect all requests not available on the filesystem to Rails. By default the -cgi dispatcher is used which is very slow, for better performance replace the -dispatcher with the fastcgi one. +== Web Servers - RewriteRule ^(.*)$ dispatch.fcgi [QSA,L] - RewriteEngine On +By default, Rails will try to use Mongrel if it's installed when started with +<tt>rails server</tt>, otherwise Rails will use WEBrick, the web server that +ships with Ruby. -If your Rails application is accessed via an Alias directive, then you MUST also -set the RewriteBase in this htaccess file. +Mongrel is a Ruby-based web server with a C component (which requires +compilation) that is suitable for development. If you have Ruby Gems installed, +getting up and running with mongrel is as easy as: + <tt>sudo gem install mongrel</tt>. - Alias /myrailsapp /path/to/myrailsapp/public - RewriteBase /myrailsapp +You can find more info at: http://mongrel.rubyforge.org - RewriteRule ^$ index.html [QSA] - RewriteRule ^([^.]+)$ $1.html [QSA] - RewriteCond %{REQUEST_FILENAME} !-f - RewriteRule ^(.*)$ dispatch.cgi [QSA,L] +You can alternatively run Rails applications with other Ruby web servers, e.g., +{Thin}[http://code.macournoyer.com/thin/], {Ebb}[http://ebb.rubyforge.org/], and +Apache with {mod_rails}[http://www.modrails.com/]. However, <tt>rails server</tt> +doesn't search for or start them. -Incase Rails experiences terminal errors instead of displaying those messages you -can supply a file here which will be rendered instead. +For production use, often a web/proxy server, e.g., {Apache}[http://apache.org], +{Nginx}[http://nginx.net/], {LiteSpeed}[http://litespeedtech.com/], +{Lighttpd}[http://www.lighttpd.net/], or {IIS}[http://www.iis.net/], is deployed +as the front end server with the chosen Ruby web server running in the back end +and receiving the proxied requests via one of several protocols (HTTP, CGI, FCGI). - ErrorDocument 500 /500.html - ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly" == Debugging Rails -Sometimes your application goes wrong. Fortunately there are a lot of tools that +Sometimes your application goes wrong. Fortunately there are a lot of tools that will help you debug it and get it back on the rails. -First area to check is the application log files. Have "tail -f" commands running -on the server.log and development.log. Rails will automatically display debugging -and runtime information to these files. Debugging info will also be shown in the -browser on requests from 127.0.0.1. +First area to check is the application log files. Have "tail -f" commands +running on the server.log and development.log. Rails will automatically display +debugging and runtime information to these files. Debugging info will also be +shown in the browser on requests from 127.0.0.1. -You can also log your own messages directly into the log file from your code using -the Ruby logger class from inside your controllers. Example: +You can also log your own messages directly into the log file from your code +using the Ruby logger class from inside your controllers. Example: class WeblogController < ActionController::Base def destroy @@ -114,26 +92,27 @@ the Ruby logger class from inside your controllers. Example: The result will be a message in your log file along the lines of: - Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1 + Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1! More information on how to use the logger is at http://www.ruby-doc.org/core/ -Also, Ruby documentation can be found at http://www.ruby-lang.org/ including: +Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are +several books available online as well: -* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/ -* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide) +* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe) +* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide) -These two online (and free) books will bring you up to speed on the Ruby language -and also on programming in general. +These two books will bring you up to speed on the Ruby language and also on +programming in general. == Debugger -Debugger support is available through the debugger command when you start your Mongrel or -Webrick server with --debugger. This means that you can break out of execution at any point -in the code, investigate and change the model, AND then resume execution! -You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug' -Example: +Debugger support is available through the debugger command when you start your +Mongrel or WEBrick server with --debugger. This means that you can break out of +execution at any point in the code, investigate and change the model, and then, +resume execution! You need to install ruby-debug to run the server in debugging +mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example: class WeblogController < ActionController::Base def index @@ -146,49 +125,60 @@ So the controller will accept the action, run the first line, then present you with a IRB prompt in the server window. Here you can do things like: >> @posts.inspect - => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>, - #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]" + => "[#<Post:0x14a6be8 + @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>, + #<Post:0x14a6620 + @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]" >> @posts.first.title = "hello from a debugger" => "hello from a debugger" -...and even better is that you can examine how your runtime objects actually work: +...and even better, you can examine how your runtime objects actually work: >> f = @posts.first => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}> >> f. Display all 152 possibilities? (y or n) -Finally, when you're ready to resume execution, you enter "cont" +Finally, when you're ready to resume execution, you can enter "cont". == Console -The console is a ruby shell, which allows you to interact with your application's domain -model. Here you'll have all parts of the application configured, just like it is when the -application is running. You can inspect domain models, change values, and save to the -database. Starting the script without arguments will launch it in the development environment. +The console is a Ruby shell, which allows you to interact with your +application's domain model. Here you'll have all parts of the application +configured, just like it is when the application is running. You can inspect +domain models, change values, and save to the database. Starting the script +without arguments will launch it in the development environment. -To start the console, just run <tt>rails console</tt> from the application directory. +To start the console, run <tt>rails console</tt> from the application +directory. Options: -* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications made to the database. -* Passing an environment name as an argument will load the corresponding environment. - Example: <tt>rails console production</tt>. +* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications + made to the database. +* Passing an environment name as an argument will load the corresponding + environment. Example: <tt>rails console production</tt>. + +To reload your controllers and models after launching the console run +<tt>reload!</tt> + +More information about irb can be found at: +link:http://www.rubycentral.com/pickaxe/irb.html -More information about irb can be found at link:http://www.rubycentral.com/pickaxe/irb.html == dbconsole -You can go to the command line of your database directly through <tt>rails dbconsole</tt>. -You would be connected to the database with the credentials defined in database.yml. -Starting the script without arguments will connect you to the development database. Passing an -argument will connect you to a different database, like <tt>rails dbconsole production</tt>. -Currently works for mysql, postgresql and sqlite. +You can go to the command line of your database directly through <tt>rails +dbconsole</tt>. You would be connected to the database with the credentials +defined in database.yml. Starting the script without arguments will connect you +to the development database. Passing an argument will connect you to a different +database, like <tt>rails dbconsole production</tt>. Currently works for MySQL, +PostgreSQL and SQLite 3. == Description of Contents -The default directory structure of a generated Ruby on Rails applicartion: +The default directory structure of a generated Ruby on Rails application: |-- app | |-- controllers @@ -230,57 +220,62 @@ app app/controllers Holds controllers that should be named like weblogs_controller.rb for - automated URL mapping. All controllers should descend from ApplicationController - which itself descends from ActionController::Base. + automated URL mapping. All controllers should descend from + ApplicationController which itself descends from ActionController::Base. app/models - Holds models that should be named like post.rb. - Most models will descend from ActiveRecord::Base. + Holds models that should be named like post.rb. Models descend from + ActiveRecord::Base by default. app/views Holds the template files for the view that should be named like - weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby - syntax. + weblogs/index.html.erb for the WeblogsController#index action. All views use + eRuby syntax by default. app/views/layouts - Holds the template files for layouts to be used with views. This models the common - header/footer method of wrapping views. In your views, define a layout using the - <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb, - call <% yield %> to render the view using this layout. + Holds the template files for layouts to be used with views. This models the + common header/footer method of wrapping views. In your views, define a layout + using the <tt>layout :default</tt> and create a file named default.html.erb. + Inside default.html.erb, call <% yield %> to render the view using this + layout. app/helpers - Holds view helpers that should be named like weblogs_helper.rb. These are generated - for you automatically when using <tt>rails generate</tt> for controllers. Helpers can be used to - wrap functionality for your views into methods. + Holds view helpers that should be named like weblogs_helper.rb. These are + generated for you automatically when using generators for controllers. + Helpers can be used to wrap functionality for your views into methods. config - Configuration files for the Rails environment, the routing map, the database, and other dependencies. + Configuration files for the Rails environment, the routing map, the database, + and other dependencies. db - Contains the database schema in schema.rb. db/migrate contains all - the sequence of Migrations for your schema. + Contains the database schema in schema.rb. db/migrate contains all the + sequence of Migrations for your schema. doc - This directory is where your application documentation will be stored when generated - using <tt>rake doc:app</tt> + This directory is where your application documentation will be stored when + generated using <tt>rake doc:app</tt> lib - Application specific libraries. Basically, any kind of custom code that doesn't - belong under controllers, models, or helpers. This directory is in the load path. + Application specific libraries. Basically, any kind of custom code that + doesn't belong under controllers, models, or helpers. This directory is in + the load path. public - The directory available for the web server. Contains subdirectories for images, stylesheets, - and javascripts. Also contains the dispatchers and the default HTML files. This should be - set as the DOCUMENT_ROOT of your web server. + The directory available for the web server. Contains subdirectories for + images, stylesheets, and javascripts. Also contains the dispatchers and the + default HTML files. This should be set as the DOCUMENT_ROOT of your web + server. script Helper scripts for automation and generation. test - Unit and functional tests along with fixtures. When using the <tt>rails generate</tt> scripts, template - test files will be generated for you and placed in this directory. + Unit and functional tests along with fixtures. When using the rails generate + command, template test files will be generated for you and placed in this + directory. vendor - External libraries that the application depends on. Also includes the plugins subdirectory. - If the app has frozen rails, those gems also go here, under vendor/rails/. - This directory is in the load path. + External libraries that the application depends on. Also includes the plugins + subdirectory. If the app has frozen rails, those gems also go here, under + vendor/rails/. This directory is in the load path. diff --git a/railties/guides/source/3_0_release_notes.textile b/railties/guides/source/3_0_release_notes.textile index 2a8d7fbcdb..75c03be87c 100644 --- a/railties/guides/source/3_0_release_notes.textile +++ b/railties/guides/source/3_0_release_notes.textile @@ -512,6 +512,7 @@ These are the main changes in Active Support: * Active Support no longer provides vendored versions of "TZInfo":http://tzinfo.rubyforge.org/, "Memcache Client":http://deveiate.org/projects/RMemCache/ and "Builder":http://builder.rubyforge.org/, these are all included as dependencies and installed via the <tt>bundle install</tt> command. * Safe buffers are implemented in <tt>ActiveSupport::SafeBuffer</tt>. * Added <tt>Array.uniq_by</tt> and <tt>Array.uniq_by!</tt>. +* Removed <tt>Array#rand</tt> and backported <tt>Array#sample</tt> from Ruby 1.9. * Fixed bug on +TimeZone.seconds_to_utc_offset+ returning wrong value. * Added <tt>ActiveSupport::Notifications</tt> middleware. * <tt>ActiveSupport.use_standard_json_time_format</tt> now defaults to true. diff --git a/railties/guides/source/active_support_core_extensions.textile b/railties/guides/source/active_support_core_extensions.textile index de82e871a6..ba5c443b34 100644 --- a/railties/guides/source/active_support_core_extensions.textile +++ b/railties/guides/source/active_support_core_extensions.textile @@ -1927,13 +1927,21 @@ Similarly, +from+ returns the tail from the element at the passed index on: The methods +second+, +third+, +fourth+, and +fifth+ return the corresponding element (+first+ is builtin). Thanks to social wisdom and positive constructiveness all around, +forty_two+ is also available. -You can pick a random element with +random_element+: +NOTE: Defined in +active_support/core_ext/array/access.rb+. + +h4. Random Access + +Active Support backports +sample+ from Ruby 1.9: <ruby> -shape_type = [Circle, Square, Triangle].random_element +shape_type = [Circle, Square, Triangle].sample +# => Square, for example + +shape_types = [Circle, Square, Triangle].sample(2) +# => [Triangle, Circle], for example </ruby> -NOTE: Defined in +active_support/core_ext/array/access.rb+. +NOTE: Defined in +active_support/core_ext/array/random_access.rb+. h4. Options Extraction @@ -2683,13 +2691,13 @@ h3. Extensions to +Date+ h4. Calculations -All the following methods are defined in +active_support/core_ext/date/calculations.rb+. +NOTE: All the following methods are defined in +active_support/core_ext/date/calculations.rb+. INFO: The following calculation methods have edge cases in October 1582, since days 5..14 just do not exist. This guide does not document their behavior around those days for brevity, but it is enough to say that they do what you would expect. That is, +Date.new(1582, 10, 4).tomorrow+ returns +Date.new(1582, 10, 15)+ and so on. Please check +test/core_ext/date_ext_test.rb+ in the Active Support test suite for expected behavior. h5. +Date.current+ -Active Support defines +Date.current+ to be today in the current time zone. That's like +Date.today+, except that it honors +Time.zone_default+. It also defines +Date.yesterday+ and +Date.tomorrow+, and the instance predicates +past?+, +today?+, and +future?+, all of them relative to +Date.current+. +Active Support defines +Date.current+ to be today in the current time zone. That's like +Date.today+, except that it honors the user time zone, if defined. It also defines +Date.yesterday+ and +Date.tomorrow+, and the instance predicates +past?+, +today?+, and +future?+, all of them relative to +Date.current+. h5. Named dates @@ -2792,6 +2800,115 @@ d.end_of_year # => Fri, 31 Dec 2010 +beginning_of_year+ is aliased to +at_beginning_of_year+, and +end_of_year+ is aliased to +at_end_of_year+. +h5. Other Date Computations + +h6. +years_ago+, +years_since+ + +The method +years_ago+ receives a number of years and returns the same date those many years ago: + +<ruby> +date = Date.new(2010, 6, 7) +date.years_ago(10) # => Wed, 07 Jun 2000 +</ruby> + ++years_since+ moves forward in time: + +<ruby> +date = Date.new(2010, 6, 7) +date.years_since(10) # => Sun, 07 Jun 2020 +</ruby> + +If such a day does not exist, the last day of the corresponding month is returned: + +<ruby> +Date.new(2012, 2, 29).years_ago(3) # => Sat, 28 Feb 2009 +Date.new(2012, 2, 29).years_since(3) # => Sat, 28 Feb 2015 +</ruby> + +h6. +months_ago+, +months_since+ + +The methods +months_ago+ and +months_since+ work analogously for months: + +<ruby> +Date.new(2010, 4, 30).months_ago(2) # => Sun, 28 Feb 2010 +Date.new(2010, 4, 30).months_since(2) # => Wed, 30 Jun 2010 +</ruby> + +If such a day does not exist, the last day of the corresponding month is returned: + +<ruby> +Date.new(2010, 4, 30).months_ago(2) # => Sun, 28 Feb 2010 +Date.new(2009, 12, 31).months_since(2) # => Sun, 28 Feb 2010 +</ruby> + +h6. +advance+ + +The most generic way to jump to other days is +advance+. This method receives a hash with keys +:years+, +:months+, +:weeks+, +:days+, and returns a date advanced as much as the present keys indicate: + +<ruby> +date = Date.new(2010, 6, 6) +date.advance(:years => 1, :weeks => 2) # => Mon, 20 Jun 2011 +date.advance(:months => 2, :days => -2) # => Wed, 04 Aug 2010 +</ruby> + +Note in the previous example that increments may be negative. + +To perform the computation the method first increments years, then months, then weeks, and finally days. This order is important towards the end of months. Say for example we are at the end of February of 2010, and we want to move one month and one day forward. + +The method +advance+ advances first one month, and the one day, the result is: + +<ruby> +Date.new(2010, 2, 28).advance(:months => 1, :day => 1) +# => Sun, 28 Mar 2010 +</ruby> + +While if it did it the other way around the result would be different: + +<ruby> +Date.new(2010, 2, 28).advance(:days => 1).advance(:months => 1) +# => Thu, 01 Apr 2010 +</ruby> + +h5. Changing Date Components + +The method +change+ allows you to get a new date which is the same as the receiver except for the given year, month, or day: + +<ruby> +Date.new(2010, 12, 23).change(:year => 2011, :month => 11) +# => Wed, 23 Nov 2011 +</ruby> + +This method is not tolerant to non-existing dates, if the change is invalid +ArgumentError+ is raised: + +<ruby> +Date.new(2010, 1, 31).change(:month => 2) +# => ArgumentError: invalid date +</ruby> + +h5. Named Times + +WARNING: The following methods do not take into account the user time zone. They return timestamps in localtime. + +INFO: The following methods return a +Time+ object if possible, otherwise a +DateTime+. + +h6. +beginning_of_day+, +end_of_day+ + +The method +beginning_of_day+ returns a timestamp at the beginning of the day (00:00:00): + +<ruby> +date = Date.new(2010, 6, 7) +date.beginning_of_day # => Sun Jun 07 00:00:00 +0200 2010 +</ruby> + +The method +end_of_day+ returns a timestamp at the end of the day (23:59:59): + +<ruby> +date = Date.new(2010, 6, 7) +date.end_of_day # => Sun Jun 06 23:59:59 +0200 2010 +</ruby> + ++beginning_of_day+ is aliased to +at_beginning_of_day+, +midnight+, +at_midnight+ + h4. Conversions h3. Extensions to +DateTime+ diff --git a/railties/guides/source/activerecord_validations_callbacks.textile b/railties/guides/source/activerecord_validations_callbacks.textile index d83ea57864..1f9bc1279a 100644 --- a/railties/guides/source/activerecord_validations_callbacks.textile +++ b/railties/guides/source/activerecord_validations_callbacks.textile @@ -115,17 +115,17 @@ end >> p = Person.new => #<Person id: nil, name: nil> >> p.errors -=> #<ActiveRecord::Errors..., @errors={}> +=> {} >> p.valid? => false >> p.errors -=> #<ActiveRecord::Errors..., @errors={"name"=>["can't be blank"]}> +=> {:name=>["can't be blank"]} >> p = Person.create => #<Person id: nil, name: nil> >> p.errors -=> #<ActiveRecord::Errors..., @errors={"name"=>["can't be blank"]}> +=> {:name=>["can't be blank"]} >> p.save => false @@ -1112,6 +1112,10 @@ h4. Creating Observers For example, imagine a +User+ model where we want to send an email every time a new user is created. Because sending emails is not directly related to our model's purpose, we could create an observer to contain this functionality. +<shell> +rails generate observer User +</shell> + <ruby> class UserObserver < ActiveRecord::Observer def after_create(model) diff --git a/railties/guides/source/routing.textile b/railties/guides/source/routing.textile index 2bc1736137..79c5f4fabe 100644 --- a/railties/guides/source/routing.textile +++ b/railties/guides/source/routing.textile @@ -717,7 +717,7 @@ resources :magazines do end </ruby> -This will create routing helpers such as +periodical_ads_url+ and +periodical_edit_ad_path+. +This will create routing helpers such as +magazine_periodical_ads_url+ and +edit_magazine_periodical_ad_path+. h3. Inspecting and Testing Routes diff --git a/railties/lib/rails/configuration.rb b/railties/lib/rails/configuration.rb index ee0fca6592..0becb780de 100644 --- a/railties/lib/rails/configuration.rb +++ b/railties/lib/rails/configuration.rb @@ -28,6 +28,10 @@ module Rails @operations << [:use, args, block] end + def delete(*args, &block) + @operations << [:delete, args, block] + end + def merge_into(other) @operations.each do |operation, args, block| other.send(operation, *args, &block) diff --git a/railties/lib/rails/generators/rails/app/templates/README b/railties/lib/rails/generators/rails/app/templates/README index 65d1459d0e..b8c84dd07d 100644 --- a/railties/lib/rails/generators/rails/app/templates/README +++ b/railties/lib/rails/generators/rails/app/templates/README @@ -1,14 +1,15 @@ == Welcome to Rails -Rails is a web-application framework that includes everything needed to create -database-backed web applications according to the Model-View-Control pattern. +Rails is a web-application framework that includes everything needed to create +database-backed web applications according to the Model-View-Control pattern. -This pattern splits the view (also called the presentation) into "dumb" templates -that are primarily responsible for inserting pre-built data in between HTML tags. -The model contains the "smart" domain objects (such as Account, Product, Person, -Post) that holds all the business logic and knows how to persist themselves to -a database. The controller handles the incoming requests (such as Save New Account, -Update Product, Show Post) by manipulating the model and directing data to the view. +This pattern splits the view (also called the presentation) into "dumb" +templates that are primarily responsible for inserting pre-built data in between +HTML tags. The model contains the "smart" domain objects (such as Account, +Product, Person, Post) that holds all the business logic and knows how to +persist themselves to a database. The controller handles the incoming requests +(such as Save New Account, Update Product, Show Post) by manipulating the model +and directing data to the view. In Rails, the model is handled by what's called an object-relational mapping layer entitled Active Record. This layer allows you to present the data from @@ -21,90 +22,65 @@ layers by its two parts: Action View and Action Controller. These two layers are bundled in a single package due to their heavy interdependence. This is unlike the relationship between the Active Record and Action Pack that is much more separate. Each of these packages can be used independently outside of -Rails. You can read more about Action Pack in +Rails. You can read more about Action Pack in link:files/vendor/rails/actionpack/README.html. == Getting Started -1. At the command prompt, start a new Rails application using the <tt>rails</tt> command - and your application name. Ex: rails myapp -2. Change directory into myapp and start the web server: <tt>rails server</tt> (run with --help for options) -3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!" -4. Follow the guidelines to start developing your application +1. At the command prompt, create a new Rails application: + <tt>rails myapp</tt> (where <tt>myapp</tt> is the application name) + +2. Change directory to <tt>myapp</tt> and start the web server: + <tt>cd myapp; rails server</tt> (run with --help for options) + +3. Go to http://localhost:3000/ and you'll see: + "Welcome aboard: You're riding the Rails!" + +4. Follow the guidelines to start developing your application. You can find +the following resources handy: + +* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html +* Ruby on Rails Tutorial Book: http://www.railstutorial.org/ == Web Servers -By default, Rails will try to use Mongrel if it's installed when started with <tt>rails server</tt>, otherwise -Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails -with a variety of other web servers. - -Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is -suitable for development and deployment of Rails applications. If you have Ruby Gems installed, -getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>. -More info at: http://mongrel.rubyforge.org - -You can also use other Ruby web servers like Thin and Ebb or regular web servers like Apache, LiteSpeed, -Lighttpd, or IIS. The Ruby web servers are run through Rack and the others can be setup to use -FCGI or proxy to a pack of Mongrels/Thin/Ebb servers. - -== Apache .htaccess example for FCGI/CGI - -# General Apache options -AddHandler fastcgi-script .fcgi -AddHandler cgi-script .cgi -Options +FollowSymLinks +ExecCGI - -# If you don't want Rails to look in certain directories, -# use the following rewrite rules so that Apache won't rewrite certain requests -# -# Example: -# RewriteCond %{REQUEST_URI} ^/notrails.* -# RewriteRule .* - [L] - -# Redirect all requests not available on the filesystem to Rails -# By default the cgi dispatcher is used which is very slow -# -# For better performance replace the dispatcher with the fastcgi one -# -# Example: -# RewriteRule ^(.*)$ dispatch.fcgi [QSA,L] -RewriteEngine On - -# If your Rails application is accessed via an Alias directive, -# then you MUST also set the RewriteBase in this htaccess file. -# -# Example: -# Alias /myrailsapp /path/to/myrailsapp/public -# RewriteBase /myrailsapp - -RewriteRule ^$ index.html [QSA] -RewriteRule ^([^.]+)$ $1.html [QSA] -RewriteCond %{REQUEST_FILENAME} !-f -RewriteRule ^(.*)$ dispatch.cgi [QSA,L] - -# In case Rails experiences terminal errors -# Instead of displaying this message you can supply a file here which will be rendered instead -# -# Example: -# ErrorDocument 500 /500.html - -ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly" +By default, Rails will try to use Mongrel if it's installed when started with +<tt>rails server</tt>, otherwise Rails will use WEBrick, the web server that +ships with Ruby. + +Mongrel is a Ruby-based web server with a C component (which requires +compilation) that is suitable for development. If you have Ruby Gems installed, +getting up and running with mongrel is as easy as: + <tt>sudo gem install mongrel</tt>. + +You can find more info at: http://mongrel.rubyforge.org + +You can alternatively run Rails applications with other Ruby web servers, e.g., +{Thin}[http://code.macournoyer.com/thin/], {Ebb}[http://ebb.rubyforge.org/], and +Apache with {mod_rails}[http://www.modrails.com/]. However, <tt>rails server</tt> +doesn't search for or start them. + +For production use, often a web/proxy server, e.g., {Apache}[http://apache.org], +{Nginx}[http://nginx.net/], {LiteSpeed}[http://litespeedtech.com/], +{Lighttpd}[http://www.lighttpd.net/], or {IIS}[http://www.iis.net/], is deployed +as the front end server with the chosen Ruby web server running in the back end +and receiving the proxied requests via one of several protocols (HTTP, CGI, FCGI). == Debugging Rails -Sometimes your application goes wrong. Fortunately there are a lot of tools that +Sometimes your application goes wrong. Fortunately there are a lot of tools that will help you debug it and get it back on the rails. -First area to check is the application log files. Have "tail -f" commands running -on the server.log and development.log. Rails will automatically display debugging -and runtime information to these files. Debugging info will also be shown in the -browser on requests from 127.0.0.1. +First area to check is the application log files. Have "tail -f" commands +running on the server.log and development.log. Rails will automatically display +debugging and runtime information to these files. Debugging info will also be +shown in the browser on requests from 127.0.0.1. -You can also log your own messages directly into the log file from your code using -the Ruby logger class from inside your controllers. Example: +You can also log your own messages directly into the log file from your code +using the Ruby logger class from inside your controllers. Example: class WeblogController < ActionController::Base def destroy @@ -120,22 +96,23 @@ The result will be a message in your log file along the lines of: More information on how to use the logger is at http://www.ruby-doc.org/core/ -Also, Ruby documentation can be found at http://www.ruby-lang.org/ including: +Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are +several books available online as well: -* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/ -* Learn to Program: http://pine.fm/LearnToProgram/ (a beginner's guide) +* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe) +* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide) -These two online (and free) books will bring you up to speed on the Ruby language -and also on programming in general. +These two books will bring you up to speed on the Ruby language and also on +programming in general. == Debugger -Debugger support is available through the debugger command when you start your Mongrel or -Webrick server with --debugger. This means that you can break out of execution at any point -in the code, investigate and change the model, AND then resume execution! -You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug' -Example: +Debugger support is available through the debugger command when you start your +Mongrel or WEBrick server with --debugger. This means that you can break out of +execution at any point in the code, investigate and change the model, and then, +resume execution! You need to install ruby-debug to run the server in debugging +mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example: class WeblogController < ActionController::Base def index @@ -148,97 +125,157 @@ So the controller will accept the action, run the first line, then present you with a IRB prompt in the server window. Here you can do things like: >> @posts.inspect - => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>, - #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]" + => "[#<Post:0x14a6be8 + @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>, + #<Post:0x14a6620 + @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]" >> @posts.first.title = "hello from a debugger" => "hello from a debugger" -...and even better is that you can examine how your runtime objects actually work: +...and even better, you can examine how your runtime objects actually work: >> f = @posts.first => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}> >> f. Display all 152 possibilities? (y or n) -Finally, when you're ready to resume execution, you enter "cont" +Finally, when you're ready to resume execution, you can enter "cont". == Console -You can interact with the domain model by starting the console through <tt>rails console</tt>. -Here you'll have all parts of the application configured, just like it is when the -application is running. You can inspect domain models, change values, and save to the -database. Starting the script without arguments will launch it in the development environment. -Passing an argument will specify a different environment, like <tt>rails console production</tt>. +The console is a Ruby shell, which allows you to interact with your +application's domain model. Here you'll have all parts of the application +configured, just like it is when the application is running. You can inspect +domain models, change values, and save to the database. Starting the script +without arguments will launch it in the development environment. + +To start the console, run <tt>rails console</tt> from the application +directory. + +Options: + +* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications + made to the database. +* Passing an environment name as an argument will load the corresponding + environment. Example: <tt>rails console production</tt>. + +To reload your controllers and models after launching the console run +<tt>reload!</tt> + +More information about irb can be found at: +link:http://www.rubycentral.com/pickaxe/irb.html -To reload your controllers and models after launching the console run <tt>reload!</tt> == dbconsole -You can go to the command line of your database directly through <tt>rails dbconsole</tt>. -You would be connected to the database with the credentials defined in database.yml. -Starting the script without arguments will connect you to the development database. Passing an -argument will connect you to a different database, like <tt>rails dbconsole production</tt>. -Currently works for mysql, postgresql and sqlite. +You can go to the command line of your database directly through <tt>rails +dbconsole</tt>. You would be connected to the database with the credentials +defined in database.yml. Starting the script without arguments will connect you +to the development database. Passing an argument will connect you to a different +database, like <tt>rails dbconsole production</tt>. Currently works for MySQL, +PostgreSQL and SQLite 3. == Description of Contents +The default directory structure of a generated Ruby on Rails application: + + |-- app + | |-- controllers + | |-- helpers + | |-- models + | `-- views + | `-- layouts + |-- config + | |-- environments + | |-- initializers + | `-- locales + |-- db + |-- doc + |-- lib + | `-- tasks + |-- log + |-- public + | |-- images + | |-- javascripts + | `-- stylesheets + |-- script + | `-- performance + |-- test + | |-- fixtures + | |-- functional + | |-- integration + | |-- performance + | `-- unit + |-- tmp + | |-- cache + | |-- pids + | |-- sessions + | `-- sockets + `-- vendor + `-- plugins + app Holds all the code that's specific to this particular application. app/controllers Holds controllers that should be named like weblogs_controller.rb for - automated URL mapping. All controllers should descend from ApplicationController - which itself descends from ActionController::Base. + automated URL mapping. All controllers should descend from + ApplicationController which itself descends from ActionController::Base. app/models - Holds models that should be named like post.rb. - Most models will descend from ActiveRecord::Base. + Holds models that should be named like post.rb. Models descend from + ActiveRecord::Base by default. app/views Holds the template files for the view that should be named like - weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby - syntax. + weblogs/index.html.erb for the WeblogsController#index action. All views use + eRuby syntax by default. app/views/layouts - Holds the template files for layouts to be used with views. This models the common - header/footer method of wrapping views. In your views, define a layout using the - <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb, - call <% yield %> to render the view using this layout. + Holds the template files for layouts to be used with views. This models the + common header/footer method of wrapping views. In your views, define a layout + using the <tt>layout :default</tt> and create a file named default.html.erb. + Inside default.html.erb, call <% yield %> to render the view using this + layout. app/helpers - Holds view helpers that should be named like weblogs_helper.rb. These are generated - for you automatically when using rails generate for controllers. Helpers can be used to - wrap functionality for your views into methods. + Holds view helpers that should be named like weblogs_helper.rb. These are + generated for you automatically when using generators for controllers. + Helpers can be used to wrap functionality for your views into methods. config - Configuration files for the Rails environment, the routing map, the database, and other dependencies. + Configuration files for the Rails environment, the routing map, the database, + and other dependencies. db - Contains the database schema in schema.rb. db/migrate contains all - the sequence of Migrations for your schema. + Contains the database schema in schema.rb. db/migrate contains all the + sequence of Migrations for your schema. doc - This directory is where your application documentation will be stored when generated - using <tt>rake doc:app</tt> + This directory is where your application documentation will be stored when + generated using <tt>rake doc:app</tt> lib - Application specific libraries. Basically, any kind of custom code that doesn't - belong under controllers, models, or helpers. This directory is in the load path. + Application specific libraries. Basically, any kind of custom code that + doesn't belong under controllers, models, or helpers. This directory is in + the load path. public - The directory available for the web server. Contains subdirectories for images, stylesheets, - and javascripts. Also contains the dispatchers and the default HTML files. This should be - set as the DOCUMENT_ROOT of your web server. + The directory available for the web server. Contains subdirectories for + images, stylesheets, and javascripts. Also contains the dispatchers and the + default HTML files. This should be set as the DOCUMENT_ROOT of your web + server. script Helper scripts for automation and generation. test - Unit and functional tests along with fixtures. When using the rails generate command, template - test files will be generated for you and placed in this directory. + Unit and functional tests along with fixtures. When using the rails generate + command, template test files will be generated for you and placed in this + directory. vendor - External libraries that the application depends on. Also includes the plugins subdirectory. - If the app has frozen rails, those gems also go here, under vendor/rails/. - This directory is in the load path. + External libraries that the application depends on. Also includes the plugins + subdirectory. If the app has frozen rails, those gems also go here, under + vendor/rails/. This directory is in the load path. diff --git a/railties/lib/rails/log_subscriber.rb b/railties/lib/rails/log_subscriber.rb index 145c7e0ace..9a74fee745 100644 --- a/railties/lib/rails/log_subscriber.rb +++ b/railties/lib/rails/log_subscriber.rb @@ -52,6 +52,7 @@ module Rails def self.add(namespace, log_subscriber, notifier = ActiveSupport::Notifications) log_subscribers << log_subscriber + @flushable_loggers = nil log_subscriber.public_methods(false).each do |event| notifier.subscribe("#{event}.#{namespace}") do |*args| @@ -70,11 +71,17 @@ module Rails @log_subscribers ||= [] end + def self.flushable_loggers + @flushable_loggers ||= begin + loggers = log_subscribers.map(&:logger) + loggers.uniq! + loggers.select { |l| l.respond_to?(:flush) } + end + end + # Flush all log_subscribers' logger. def self.flush_all! - loggers = log_subscribers.map(&:logger) - loggers.uniq! - loggers.each { |l| l.flush if l.respond_to?(:flush) } + flushable_loggers.each(&:flush) end # By default, we use the Rails.logger for logging. diff --git a/railties/lib/rails/rack/logger.rb b/railties/lib/rails/rack/logger.rb index dd8b342f59..73e9af3b41 100644 --- a/railties/lib/rails/rack/logger.rb +++ b/railties/lib/rails/rack/logger.rb @@ -1,4 +1,5 @@ require 'rails/log_subscriber' +require 'active_support/core_ext/time/conversions' module Rails module Rack @@ -19,10 +20,10 @@ module Rails def before_dispatch(env) request = ActionDispatch::Request.new(env) - path = request.fullpath.inspect rescue "unknown" + path = request.fullpath - info "\n\nStarted #{request.method.to_s.upcase} #{path} " << - "for #{request.remote_ip} at #{Time.now.to_s(:db)}" + info "\n\nStarted #{env["REQUEST_METHOD"]} \"#{path}\" " \ + "for #{request.ip} at #{Time.now.to_default_s}" end def after_dispatch(env) diff --git a/railties/test/application/initializers/frameworks_test.rb b/railties/test/application/initializers/frameworks_test.rb index fadcc4c025..35ea2729d3 100644 --- a/railties/test/application/initializers/frameworks_test.rb +++ b/railties/test/application/initializers/frameworks_test.rb @@ -47,7 +47,7 @@ module ApplicationTests test "if there's no config.active_support.bare, all of ActiveSupport is required" do use_frameworks [] require "#{app_path}/config/environment" - assert_nothing_raised { [1,2,3].random_element } + assert_nothing_raised { [1,2,3].sample } end test "config.active_support.bare does not require all of ActiveSupport" do @@ -57,7 +57,7 @@ module ApplicationTests Dir.chdir("#{app_path}/app") do require "#{app_path}/config/environment" - assert_raises(NoMethodError) { [1,2,3].random_element } + assert_raises(NoMethodError) { [1,2,3].sample } end end diff --git a/railties/test/application/middleware_test.rb b/railties/test/application/middleware_test.rb index bab17d8af5..aa75fed793 100644 --- a/railties/test/application/middleware_test.rb +++ b/railties/test/application/middleware_test.rb @@ -57,6 +57,12 @@ module ApplicationTests assert !middleware.include?("ActionDispatch::Static") end + test "can delete a middleware from the stack" do + add_to_config "config.middleware.delete ActionDispatch::Static" + boot! + assert !middleware.include?("ActionDispatch::Static") + end + test "removes show exceptions if action_dispatch.show_exceptions is disabled" do add_to_config "config.action_dispatch.show_exceptions = false" boot! diff --git a/railties/test/isolation/abstract_unit.rb b/railties/test/isolation/abstract_unit.rb index 6f4c5d77f3..b46ac0efaf 100644 --- a/railties/test/isolation/abstract_unit.rb +++ b/railties/test/isolation/abstract_unit.rb @@ -232,7 +232,7 @@ Module.new do require_environment = "-r #{environment}" end - `#{Gem.ruby} #{require_environment} #{RAILS_FRAMEWORK_ROOT}/bin/rails #{tmp_path('app_template')}` + `#{Gem.ruby} #{require_environment} #{RAILS_FRAMEWORK_ROOT}/bin/rails new #{tmp_path('app_template')}` File.open("#{tmp_path}/app_template/config/boot.rb", 'w') do |f| if require_environment f.puts "Dir.chdir('#{File.dirname(environment)}') do" |