railties 3.0.1 → 3.0.2

data/guides/source/routing.textile

@@ -39,10 +39,10 @@ You can also generate paths and URLs. If your application contains this code:
 </ruby>
 
 <erb>
-<%= link_to "Patient Record", patients_path(@patient.id) %>
+<%= link_to "Patient Record", patient_path(@patient) %>
 </erb>
 
-The router will generate the path +/patients/17+. This reduces the brittleness of your view and makes your code easier to understand.
+The router will generate the path +/patients/17+. This reduces the brittleness of your view and makes your code easier to understand. Note that the id does not need to be specified in the route helper.
 
 h3. Resource Routing: the Rails Default
 
@@ -91,7 +91,7 @@ Creating a resourceful route will also expose a number of helpers to the control
 
 * +photos_path+ returns +/photos+
 * +new_photo_path+ returns +/photos/new+
-* +edit_photo_path+ returns +/photos/edit+
+* +edit_photo_path(id)+ returns +/photos/:id/edit+ (for instance, +edit_photo_path(10)+ returns +/photos/10/edit+)
 * +photo_path(id)+ returns +/photos/:id+ (for instance, +photo_path(10)+ returns +/photos/10+)
 
 Each of these helpers has a corresponding +_url+ helper (such as +photos_url+) which returns the same path prefixed with the current host, port and path prefix.
@@ -116,7 +116,7 @@ resources :videos
 
 h4. Singular Resources
 
-Sometimes, you have a resource that clients always look up without referencing an ID. A common example, +/profile+ always shows the profile of the currently logged in user. In this case, you can use a singular resource to map +/profile+ (rather than +/profile/:id+) to the +show+ action.
+Sometimes, you have a resource that clients always look up without referencing an ID. For example, you would like +/profile+ to always show the profile of the currently logged in user. In this case, you can use a singular resource to map +/profile+ (rather than +/profile/:id+) to the +show+ action.
 
 <ruby>
 match "profile" => "users#show"
@@ -161,15 +161,15 @@ end
 This will create a number of routes for each of the +posts+ and +comments+ controller. For +Admin::PostsController+, Rails will create:
 
 |_. Verb |_.Path               |_.action |_. helper                  |
-|GET     |/admin/photos        |index    | admin_photos_path         |
-|GET     |/admin/photos/new    |new      | new_admin_photos_path     |
-|POST    |/admin/photos        |create   | admin_photos_path         |
-|GET     |/admin/photos/1      |show     | admin_photo_path(id)      |
-|GET     |/admin/photos/1/edit |edit     | edit_admin_photo_path(id) |
-|PUT     |/admin/photos/1      |update   | admin_photo_path(id)      |
-|DELETE  |/admin/photos/1      |destroy  | admin_photo_path(id)      |
+|GET     |/admin/posts        |index    | admin_posts_path         |
+|GET     |/admin/posts/new    |new      | new_admin_posts_path     |
+|POST    |/admin/posts        |create   | admin_posts_path         |
+|GET     |/admin/posts/1      |show     | admin_post_path(id)      |
+|GET     |/admin/posts/1/edit |edit     | edit_admin_post_path(id) |
+|PUT     |/admin/posts/1      |update   | admin_post_path(id)      |
+|DELETE  |/admin/posts/1      |destroy  | admin_post_path(id)      |
 
-If you want to route +/photos+ (without the prefix +/admin+) to +Admin::PostsController+, you could use
+If you want to route +/posts+ (without the prefix +/admin+) to +Admin::PostsController+, you could use
 
 <ruby>
 scope :module => "admin" do
@@ -183,7 +183,7 @@ or, for a single case
 resources :posts, :module => "admin"
 </ruby>
 
-If you want to route +/admin/photos+ to +PostsController+ (without the +Admin::+ module prefix), you could use
+If you want to route +/admin/posts+ to +PostsController+ (without the +Admin::+ module prefix), you could use
 
 <ruby>
 scope "/admin" do
@@ -200,13 +200,13 @@ resources :posts, :path => "/admin"
 In each of these cases, the named routes remain the same as if you did not use +scope+. In the last case, the following paths map to +PostsController+:
 
 |_. Verb |_.Path               |_.action |_. helper            |
-|GET     |/admin/photos        |index    | photos_path         |
-|GET     |/admin/photos/new    |new      | photos_path         |
-|POST    |/admin/photos        |create   | photos_path         |
-|GET     |/admin/photos/1      |show     | photo_path(id)      |
-|GET     |/admin/photos/1/edit |edit     | edit_photo_path(id) |
-|PUT     |/admin/photos/1      |update   | photo_path(id)      |
-|DELETE  |/admin/photos/1      |destroy  | photo_path(id)      |
+|GET     |/admin/posts        |index    | posts_path         |
+|GET     |/admin/posts/new    |new      | posts_path         |
+|POST    |/admin/posts        |create   | posts_path         |
+|GET     |/admin/posts/1      |show     | post_path(id)      |
+|GET     |/admin/posts/1/edit |edit     | edit_post_path(id) |
+|PUT     |/admin/posts/1      |update   | post_path(id)      |
+|DELETE  |/admin/posts/1      |destroy  | post_path(id)      |
 
 h4. Nested Resources
 
@@ -370,7 +370,7 @@ When you set up a regular route, you supply a series of symbols that Rails maps
 match ':controller(/:action(/:id))'
 </ruby>
 
-If an incoming request of +/photos/show/1+ is processed by this route (because it hasn't matched any previous route in the file), then the result will be to invoke the +show+ action of the +PhotosController+, and to make the final parameter +"1"+ available as +params[:id]+. This route will also route the incoming request of +/photos+ to +PhotosController+, since +:action+ and +:id+ are optional parameters, denoted by parentheses.
+If an incoming request of +/photos/show/1+ is processed by this route (because it hasn't matched any previous route in the file), then the result will be to invoke the +show+ action of the +PhotosController+, and to make the final parameter +"1"+ available as +params[:id]+. This route will also route the incoming request of +/photos+ to +PhotosController#index+, since +:action+ and +:id+ are optional parameters, denoted by parentheses.
 
 h4. Dynamic Segments
 
@@ -434,7 +434,27 @@ You can specify a name for any route using the +:as+ option.
 match 'exit' => 'sessions#destroy', :as => :logout
 </ruby>
 
-This will create +logout_path+ and +logout_url+ as named helpers in your application. Calling +logout_path+ will return +/logout+
+This will create +logout_path+ and +logout_url+ as named helpers in your application. Calling +logout_path+ will return +/exit+
+
+h4. HTTP Verb Constraints
+
+You can use the +:via+ option to constrain the request to one or more HTTP methods:
+
+<ruby>
+match 'photos/show' => 'photos#show', :via => :get
+</ruby>
+
+There is a shorthand version of this as well:
+
+<ruby>
+get 'photos/show'
+</ruby>
+
+You can also permit more than one verb to a single route:
+
+<ruby>
+match 'photos/show' => 'photos#show', :via => [:get, :post]
+</ruby>
 
 h4. Segment Constraints
 
@@ -589,7 +609,7 @@ The +:controller+ option lets you explicitly specify a controller to use for the
 resources :photos, :controller => "images"
 </ruby>
 
-will recognize incoming paths beginning with +/photo+ but route to the +Images+ controller:
+will recognize incoming paths beginning with +/photos+ but route to the +Images+ controller:
 
 |_. Verb |_.Path         |_.action |
 |GET     |/photos        |index    |
@@ -723,7 +743,7 @@ scope(:path_names => { :new => "neu", :edit => "bearbeiten" }) do
 end
 </ruby>
 
-Rails now creates routes to the +CategoriesControlleR+.
+Rails now creates routes to the +CategoriesController+.
 
 |_.HTTP verb|_.Path                     |_.action |
 |GET        |/kategorien                |index    |
@@ -788,7 +808,7 @@ TIP: You'll find that the output from +rake routes+ is much more readable if you
 
 h4. Testing Routes
 
-Routes should be included in your testing strategy (just like the rest of your application). Rails offers three "built-in assertions":http://api.rubyonrails.org/classes/ActionController/Assertions/RoutingAssertions.html designed to make testing routes simpler:
+Routes should be included in your testing strategy (just like the rest of your application). Rails offers three "built-in assertions":http://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html designed to make testing routes simpler:
 
 * +assert_generates+
 * +assert_recognizes+

data/guides/source/ruby_on_rails_guides_guidelines.textile

@@ -0,0 +1,77 @@
+h2. Ruby on Rails Guides Guidelines
+
+This guide documents guidelines for writing guides. This guide follows itself in a gracile loop.
+
+endprologue.
+
+h3. Textile
+
+Guides are written in "Textile":http://www.textism.com/tools/textile/. There's comprehensive documentation "here":http://redcloth.org/hobix.com/textile/ and a cheatsheet for markup "here":http://redcloth.org/hobix.com/textile/quick.html.
+
+h3. Prologue
+
+Each guide should start with motivational text at the top. That's the little introduction in the blue area. The prologue should tell the readers what's the guide about, and what will they learn. See for example the "Routing Guide":routing.html.
+
+h3. Titles
+
+The title of every guide uses +h2+, guide sections use +h3+, subsections +h4+, etc.
+
+Capitalize all words except for internal articles, prepositions, conjuctions, and forms of the verb to be:
+
+<plain>
+h5. Middleware Stack is an Array
+h5. When are Objects Saved?
+</plain>
+
+Use same typography as in regular text:
+
+<plain>
+h6. The +:content_type+ Option
+</plain>
+
+h3. API Documentation Guidelines
+
+The guides and the API should be coherent where appropriate. Please have a look at these particular sections of the "API Documentation Guidelines":api_documentation_guidelines.html:
+
+* "Wording":api_documentation_guidelines.html#wording
+* "Example Code":api_documentation_guidelines.html#example-code
+* "Filenames":api_documentation_guidelines.html#filenames
+* "Fonts":api_documentation_guidelines.html#fonts
+
+Those guidelines apply also to guides.
+
+h3. HTML Generation
+
+To generate all the guides just cd into the +railties+ directory and execute
+
+<plain>
+rake generate_guides
+</plain>
+
+You'll need the gems erubis, i18n, and RedCloth. 
+
+To process +my_guide.textile+ and nothing else use the +ONLY+ environment variable:
+
+<plain>
+rake generate_guides ONLY=my_guide
+</plain>
+
+Although by default guides that have not been modified are not processed, so +ONLY+ is rarely needed in practice.
+
+To force process of al the guides pass +ALL=1+.
+
+It is also recommended that you work with +WARNINGS=1+, this detects duplicate IDs and warns about broken internal links.
+
+h3. HTML validation
+
+Please do validate the generated HTML with
+
+<plain>
+rake validate_guides
+</plain>
+
+Particularly, titles get an ID generated from their content and this often leads to duplicates. Please set +WARNINGS=1+ when generating guides to detect them. The warning messages suggest a way to fix them.
+
+h3. Changelog
+
+* October 5, 2010: ported from the docrails wiki and revised by "Xavier Noria":credits.html#fxn

data/lib/rails/application/configuration.rb

@@ -14,6 +14,8 @@ module Rails
                     :secret_token, :serve_static_assets, :session_options,
                     :time_zone, :whiny_nils
 
+      alias :generators :app_generators
+
       def initialize(*)
         super
         self.encoding = "utf-8"

data/lib/rails/application/finisher.rb

@@ -46,6 +46,13 @@ module Rails
         ActiveSupport.run_load_hooks(:after_initialize, self)
       end
 
+      # Force routes to be loaded just at the end and add it to to_prepare callbacks
+      initializer :set_routes_reloader do |app|
+        reloader = lambda { app.routes_reloader.execute_if_updated }
+        reloader.call
+        ActionDispatch::Callbacks.to_prepare(&reloader)
+      end
+
       # Disable dependency loading during request cycle
       initializer :disable_dependency_loading do
         if config.cache_classes && !config.dependency_loading

data/lib/rails/code_statistics.rb

@@ -23,7 +23,7 @@ class CodeStatistics #:nodoc:
 
   private
     def calculate_statistics
-      @pairs.inject({}) { |stats, pair| stats[pair.first] = calculate_directory_statistics(pair.last); stats }
+      Hash[@pairs.map{|pair| [pair.first, calculate_directory_statistics(pair.last)]}]
     end
 
     def calculate_directory_statistics(directory, pattern = /.*\.rb$/)

data/lib/rails/commands/console.rb

@@ -48,5 +48,5 @@ end
 
 # Has to set the RAILS_ENV before config/application is required
 if ARGV.first && !ARGV.first.index("-") && env = ARGV.pop # has to pop the env ARGV so IRB doesn't freak
-  ENV['RAILS_ENV'] = %w(production development test).find { |e| e.index(env) } || env
+  ENV['RAILS_ENV'] = %w(production development test).detect {|e| e =~ /^#{env}/} || env
 end

data/lib/rails/commands/runner.rb

@@ -17,13 +17,13 @@ ARGV.clone.options do |opts|
   opts.separator ""
 
   opts.on("-h", "--help",
-          "Show this help message.") { $stderr.puts opts; exit }
+          "Show this help message.") { $stdout.puts opts; exit }
 
   if RbConfig::CONFIG['host_os'] !~ /mswin|mingw/
     opts.separator ""
     opts.separator "You can also use runner as a shebang line for your scripts like this:"
     opts.separator "-------------------------------------------------------------"
-    opts.separator "#!/usr/bin/env #{File.expand_path($0)}"
+    opts.separator "#!/usr/bin/env #{File.expand_path($0)} runner"
     opts.separator ""
     opts.separator "Product.find(:all).each { |p| p.price *= 2 ; p.save! }"
     opts.separator "-------------------------------------------------------------"

data/lib/rails/engine/configuration.rb

@@ -33,6 +33,12 @@ module Rails
         end
       end
 
+      def generators #:nodoc:
+        ActiveSupport::Deprecation.warn "config.generators in Rails::Engine is deprecated. " <<
+          "Please use config.app_generators instead."
+        super
+      end
+
       def root=(value)
         @root = paths.path = Pathname.new(value).expand_path
       end

data/lib/rails/generators/generated_attribute.rb

@@ -6,6 +6,7 @@ module Rails
       attr_accessor :name, :type
 
       def initialize(name, type)
+        raise Thor::Error, "Missing type for attribute '#{name}'.\nExample: '#{name}:string' where string is the type." if type.blank?
         @name, @type = name, type.to_sym
       end
 

data/lib/rails/generators/rails/app/app_generator.rb

@@ -353,18 +353,21 @@ module Rails
       end
 
       def app_name
-        @app_name ||= File.basename(destination_root)
+        @app_name ||= defined_app_const_base? ? defined_app_name : File.basename(destination_root)
+      end
+
+      def defined_app_name
+        defined_app_const_base.underscore
       end
-      
-      alias_method :defined_app_name, :app_name
 
       def defined_app_const_base
         Rails.respond_to?(:application) && defined?(Rails::Application) &&
           Rails.application.is_a?(Rails::Application) && Rails.application.class.name.sub(/::Application$/, "")
       end
 
+      alias :defined_app_const_base? :defined_app_const_base
+
       def app_const_base
-        defined_app_name # ensures the correct app_name if it's already defined
         @app_const_base ||= defined_app_const_base || app_name.gsub(/\W/, '_').squeeze('_').camelize
       end
 

data/lib/rails/generators/rails/app/templates/Gemfile

@@ -2,10 +2,8 @@ source 'http://rubygems.org'
 
 <%- if options.dev? -%>
 gem 'rails', :path => '<%= Rails::Generators::RAILS_DEV_PATH %>'
-gem 'arel',  :git => 'git://github.com/rails/arel.git'
 <%- elsif options.edge? -%>
 gem 'rails', :git => 'git://github.com/rails/rails.git'
-gem 'arel',  :git => 'git://github.com/rails/arel.git'
 <%- else -%>
 gem 'rails', '<%= Rails::VERSION::STRING %>'
 
@@ -23,8 +21,9 @@ gem '<%= gem_for_database %>'<% if require_for_database %>, :require => '<%= req
 # Deploy with Capistrano
 # gem 'capistrano'
 
-# To use debugger
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
 # gem 'ruby-debug'
+# gem 'ruby-debug19'
 
 # Bundle the extra gems:
 # gem 'bj'

data/lib/rails/generators/rails/app/templates/README

@@ -158,6 +158,7 @@ The default directory structure of a generated Ruby on Rails application:
   |-- app
   |   |-- controllers
   |   |-- helpers
+  |   |-- mailers
   |   |-- models
   |   `-- views
   |       `-- layouts
@@ -175,7 +176,6 @@ The default directory structure of a generated Ruby on Rails application:
   |   |-- javascripts
   |   `-- stylesheets
   |-- script
-  |   `-- performance
   |-- test
   |   |-- fixtures
   |   |-- functional

data/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt

@@ -1,5 +1,5 @@
 <%= app_const %>.configure do
-  # Settings specified here will take precedence over those in config/environment.rb
+  # Settings specified here will take precedence over those in config/application.rb
 
   # In the development environment your application's code is reloaded on
   # every request.  This slows down response time but is perfect for development

data/lib/rails/generators/rails/app/templates/config/environments/production.rb.tt

@@ -1,5 +1,5 @@
 <%= app_const %>.configure do
-  # Settings specified here will take precedence over those in config/environment.rb
+  # Settings specified here will take precedence over those in config/application.rb
 
   # The production environment is meant for finished, "live" apps.
   # Code is not reloaded between requests

data/lib/rails/generators/rails/app/templates/config/environments/test.rb.tt

@@ -1,5 +1,5 @@
 <%= app_const %>.configure do
-  # Settings specified here will take precedence over those in config/environment.rb
+  # Settings specified here will take precedence over those in config/application.rb
 
   # The test environment is used exclusively to run your application's
   # test suite.  You never need to work with it otherwise.  Remember that

data/lib/rails/generators/rails/app/templates/config/initializers/session_store.rb.tt

@@ -4,5 +4,5 @@
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information
-# (create the session table with "rake db:sessions:create")
+# (create the session table with "rails generate session_migration")
 # <%= app_const %>.config.session_store :active_record_store

data/lib/rails/generators/resource_helpers.rb

@@ -17,7 +17,7 @@ module Rails
       def initialize(*args) #:nodoc:
         super
 
-        if name == name.pluralize && !options[:force_plural]
+        if name == name.pluralize && name.singularize != name.pluralize && !options[:force_plural]
           unless ResourceHelpers.skip_warn
             say "Plural version of the model detected, using singularized version. Override with --force-plural."
             ResourceHelpers.skip_warn = true

data/lib/rails/plugin.rb

@@ -84,7 +84,7 @@ module Rails
 
     initializer :sanity_check_railties_collision do
       if Engine.subclasses.map { |k| k.root.to_s }.include?(root.to_s)
-        raise "\"#{name}\" is a Railtie/Engine and cannot be installed as plugin"
+        raise "\"#{name}\" is a Railtie/Engine and cannot be installed as a plugin"
       end
     end
   end

data/lib/rails/railtie.rb

@@ -84,7 +84,7 @@ module Rails
   #
   #   class MyRailtie < Rails::Railtie
   #     # Customize the ORM
-  #     config.generators.orm :my_railtie_orm
+  #     config.app_generators.orm :my_railtie_orm
   #
   #     # Add a to_prepare block which is executed once in production
   #     # and before which request in development

data/lib/rails/railtie/configuration.rb

@@ -18,7 +18,7 @@ module Rails
 
       # Holds generators configuration:
       #
-      #   config.generators do |g|
+      #   config.app_generators do |g|
       #     g.orm             :datamapper, :migration => true
       #     g.template_engine :haml
       #     g.test_framework  :rspec
@@ -26,9 +26,9 @@ module Rails
       #
       # If you want to disable color in console, do:
       #
-      #   config.generators.colorize_logging = false
+      #   config.app_generators.colorize_logging = false
       #
-      def generators
+      def app_generators
         @@generators ||= Rails::Configuration::Generators.new
         if block_given?
           yield @@generators
@@ -36,6 +36,7 @@ module Rails
           @@generators
         end
       end
+      alias :generators :app_generators
 
       def before_configuration(&block)
         ActiveSupport.on_load(:before_configuration, :yield => true, &block)