actionpack 1.13.3 → 1.13.4

data/lib/action_controller/integration.rb

@@ -67,7 +67,7 @@ module ActionController
         @https = false
         @cookies = {}
         @controller = @request = @response = nil
-      
+
         self.host        = "www.example.com"
         self.remote_addr = "127.0.0.1"
         self.accept      = "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
@@ -89,7 +89,7 @@ module ActionController
       #   session.https!
       #   session.https!(false)
       def https!(flag=true)
-        @https = flag        
+        @https = flag
       end
 
       # Return +true+ if the session is mimicing a secure HTTPS request.
@@ -143,10 +143,10 @@ module ActionController
       # Performs a GET request with the given parameters. The parameters may
       # be +nil+, a Hash, or a string that is appropriately encoded
       # (application/x-www-form-urlencoded or multipart/form-data).  The headers
-      # should be a hash.  The keys will automatically be upcased, with the 
+      # should be a hash.  The keys will automatically be upcased, with the
       # prefix 'HTTP_' added if needed.
       #
-      # You can also perform POST, PUT, DELETE, and HEAD requests with #post, 
+      # You can also perform POST, PUT, DELETE, and HEAD requests with #post,
       # #put, #delete, and #head.
       def get(path, parameters=nil, headers=nil)
         process :get, path, parameters, headers
@@ -161,31 +161,41 @@ module ActionController
       def put(path, parameters=nil, headers=nil)
         process :put, path, parameters, headers
       end
-      
+
       # Performs a DELETE request with the given parameters. See get() for more details.
       def delete(path, parameters=nil, headers=nil)
         process :delete, path, parameters, headers
       end
-      
+
       # Performs a HEAD request with the given parameters. See get() for more details.
       def head(path, parameters=nil, headers=nil)
         process :head, path, parameters, headers
       end
 
-      # Performs an XMLHttpRequest request with the given parameters, mimicing
-      # the request environment created by the Prototype library. The parameters
-      # may be +nil+, a Hash, or a string that is appropriately encoded
-      # (application/x-www-form-urlencoded or multipart/form-data).  The headers
-      # should be a hash.  The keys will automatically be upcased, with the 
-      # prefix 'HTTP_' added if needed.
-      def xml_http_request(path, parameters=nil, headers=nil)
-        headers = (headers || {}).merge(
-          "X-Requested-With" => "XMLHttpRequest",
-          "Accept"           => "text/javascript, text/html, application/xml, text/xml, */*"
-        )
+      # Performs an XMLHttpRequest request with the given parameters, mirroring
+      # a request from the Prototype library.
+      #
+      # The request_method is :get, :post, :put, :delete or :head; the
+      # parameters are +nil+, a hash, or a url-encoded or multipart string;
+      # the headers are a hash.  Keys are automatically upcased and prefixed
+      # with 'HTTP_' if not already.
+      #
+      # This method used to omit the request_method parameter, assuming it
+      # was :post. This was deprecated in Rails 1.2.4. Always pass the request
+      # method as the first argument.
+      def xml_http_request(request_method, path, parameters = nil, headers = nil)
+        unless request_method.is_a?(Symbol)
+          ActiveSupport::Deprecation.warn 'xml_http_request now takes the request_method (:get, :post, etc.) as the first argument. It used to assume :post, so add the :post argument to your existing method calls to silence this warning.'
+          request_method, path, parameters, headers = :post, request_method, path, parameters
+        end
+
+        headers ||= {}
+        headers['X-Requested-With'] = 'XMLHttpRequest'
+        headers['Accept'] = 'text/javascript, text/html, application/xml, text/xml, */*'
 
-        post(path, parameters, headers)
+        process(request_method, path, parameters, headers)
       end
+      alias xhr :xml_http_request
 
       # Returns the URL for the given options, according to the rules specified
       # in the application's routes.
@@ -292,7 +302,7 @@ module ActionController
           @status = @status.to_i
         end
 
-        # Encode the cookies hash in a format suitable for passing to a 
+        # Encode the cookies hash in a format suitable for passing to a
         # request.
         def encode_cookies
           cookies.inject("") do |string, (name, value)|
@@ -450,7 +460,7 @@ module ActionController
     # without any test methods.
     def run(*args) #:nodoc:
       return if @method_name == "default_test"
-      super   
+      super
     end
 
     # Because of how use_instantiated_fixtures and use_transactional_fixtures
@@ -490,7 +500,7 @@ module ActionController
       @integration_session = open_session
     end
 
-    %w(get post cookies assigns xml_http_request).each do |method|
+    %w(get post put head delete cookies assigns xml_http_request).each do |method|
       define_method(method) do |*args|
         reset! unless @integration_session
         # reset the html_document variable, but only for new get/post calls

data/lib/action_controller/pagination.rb

@@ -1,7 +1,9 @@
 module ActionController
   # === Action Pack pagination for Active Record collections
   #
-  # DEPRECATION WARNING: Pagination will be separated into its own plugin with Rails 2.0.
+  # DEPRECATION WARNING: Pagination will be moved to a plugin in Rails 2.0.
+  # Install the classic_pagination plugin for forward compatibility:
+  #   script/plugin install svn://errtheblog.com/svn/plugins/classic_pagination
   #
   # The Pagination module aids in the process of paging large collections of
   # Active Record objects. It offers macro-style automatic fetching of your
@@ -130,6 +132,8 @@ module ActionController
       paginator_and_collection_for(collection_id, options)
     end
 
+    deprecate :paginate => 'Pagination is moving to a plugin in Rails 2.0: script/plugin install svn://errtheblog.com/svn/plugins/classic_pagination'
+
     # These methods become class methods on any controller 
     module ClassMethods
       # Creates a +before_filter+ which automatically paginates an Active
@@ -148,6 +152,8 @@ module ActionController
           OPTIONS[self][collection_id] = options
         end
       end
+
+      deprecate :paginate => 'Pagination is moving to a plugin in Rails 2.0: script/plugin install svn://errtheblog.com/svn/plugins/classic_pagination'
     end
 
     def create_paginators_and_retrieve_collections #:nodoc:

data/lib/action_controller/resources.rb

@@ -2,48 +2,68 @@ module ActionController
   module Resources
     class Resource #:nodoc:
       attr_reader :collection_methods, :member_methods, :new_methods
-      attr_reader :path_prefix, :name_prefix
+      attr_reader :path_prefix, :new_name_prefix
       attr_reader :plural, :singular
       attr_reader :options
 
       def initialize(entities, options)
         @plural   = entities
         @singular = options[:singular] || plural.to_s.singularize
-        
+
         @options = options
 
         arrange_actions
         add_default_actions
         set_prefixes
       end
-      
+
       def controller
         @controller ||= (options[:controller] || plural).to_s
       end
-      
+
       def path
         @path ||= "#{path_prefix}/#{plural}"
       end
-      
+
       def new_path
         @new_path ||= "#{path}/new"
       end
-      
+
       def member_path
         @member_path ||= "#{path}/:id"
       end
-      
+
       def nesting_path_prefix
         @nesting_path_prefix ||= "#{path}/:#{singular}_id"
       end
-      
+
+      def deprecate_name_prefix?
+        @name_prefix.blank? && !@new_name_prefix.blank?
+      end
+
+      def name_prefix
+        deprecate_name_prefix? ? @new_name_prefix : @name_prefix
+      end
+
+      def old_name_prefix
+        @name_prefix
+      end
+
+      def nesting_name_prefix
+        "#{new_name_prefix}#{singular}_"
+      end
+
+      def action_separator
+        @action_separator ||= Base.resource_action_separator
+      end
+
       protected
         def arrange_actions
           @collection_methods = arrange_actions_by_methods(options.delete(:collection))
           @member_methods     = arrange_actions_by_methods(options.delete(:member))
           @new_methods        = arrange_actions_by_methods(options.delete(:new))
         end
-        
+
         def add_default_actions
           add_default_action(member_methods, :get, :edit)
           add_default_action(new_methods, :get, :new)
@@ -52,6 +72,7 @@ module ActionController
         def set_prefixes
           @path_prefix = options.delete(:path_prefix)
           @name_prefix = options.delete(:name_prefix)
+          @new_name_prefix = options.delete(:new_name_prefix)
         end
 
         def arrange_actions_by_methods(actions)
@@ -60,7 +81,7 @@ module ActionController
             flipped_hash
           end
         end
-        
+
         def add_default_action(collection, method, action)
           (collection[method] ||= []).unshift(action)
         end
@@ -178,11 +199,11 @@ module ActionController
     #
     #   The comment resources work the same, but must now include a value for :article_id.
     #   
-    #     comments_url(@article)
-    #     comment_url(@article, @comment)
+    #     article_comments_url(@article)
+    #     article_comment_url(@article, @comment)
     #
-    #     comments_url(:article_id => @article)
-    #     comment_url(:article_id => @article, :id => @comment)
+    #     article_comments_url(:article_id => @article)
+    #     article_comment_url(:article_id => @article, :id => @comment)
     #
     # * <tt>:name_prefix</tt> -- define a prefix for all generated routes, usually ending in an underscore.
     #   Use this if you have named routes that may clash.
@@ -192,7 +213,7 @@ module ActionController
     #
     # * <tt>:collection</tt> -- add named routes for other actions that operate on the collection.
     #   Takes a hash of <tt>#{action} => #{method}</tt>, where method is <tt>:get</tt>/<tt>:post</tt>/<tt>:put</tt>/<tt>:delete</tt>
-    #   or <tt>:any</tt> if the method does not matter.  These routes map to a URL like /messages;rss, with a route of rss_messages_url.
+    #   or <tt>:any</tt> if the method does not matter.  These routes map to a URL like /messages/rss, with a route of rss_messages_url.
     # * <tt>:member</tt> -- same as :collection, but for actions that operate on a specific member.
     # * <tt>:new</tt> -- same as :collection, but for actions that operate on the new resource action.
     #
@@ -204,19 +225,19 @@ module ActionController
     #   # --> GET /thread/7/messages/1
     #  
     #   map.resources :messages, :collection => { :rss => :get }
-    #   # --> GET /messages;rss (maps to the #rss action)
+    #   # --> GET /messages/rss (maps to the #rss action)
     #   #     also adds a named route called "rss_messages"
     # 
     #   map.resources :messages, :member => { :mark => :post }
-    #   # --> POST /messages/1;mark (maps to the #mark action)
+    #   # --> POST /messages/1/mark (maps to the #mark action)
     #   #     also adds a named route called "mark_message"
     # 
     #   map.resources :messages, :new => { :preview => :post }
-    #   # --> POST /messages/new;preview (maps to the #preview action)
+    #   # --> POST /messages/new/preview (maps to the #preview action)
     #   #     also adds a named route called "preview_new_message"
     # 
     #   map.resources :messages, :new => { :new => :any, :preview => :post }
-    #   # --> POST /messages/new;preview (maps to the #preview action)
+    #   # --> POST /messages/new/preview (maps to the #preview action)
     #   #     also adds a named route called "preview_new_message"
     #   # --> /messages/new can be invoked via any request method
     # 
@@ -235,9 +256,10 @@ module ActionController
     # /account profile.
     # 
     # See map.resources for general conventions.  These are the main differences:
-    #   - a singular name is given to map.resource.  The default controller name is taken from the singular name.
-    #   - To specify a custom plural name, use the :plural option.  There is no :singular option
-    #   - No default index, new, or create routes are created for the singleton resource controller.
+    #   - A singular name is given to map.resource.  The default controller name is taken from the singular name.
+    #   - There is no <tt>:collection</tt> option as there is only the singleton resource.
+    #   - There is no <tt>:singular</tt> option as the singular name is passed to map.resource.
+    #   - No default index route is created for the singleton resource controller.
     #   - When nesting singleton resources, only the singular name is used as the path prefix (example: 'account/messages/1')
     #
     # Example:
@@ -300,7 +322,7 @@ module ActionController
           map_member_actions(map, resource)
 
           if block_given?
-            with_options(:path_prefix => resource.nesting_path_prefix, &block)
+            with_options(:path_prefix => resource.nesting_path_prefix, :new_name_prefix => resource.nesting_name_prefix, &block)
           end
         end
       end
@@ -315,7 +337,7 @@ module ActionController
           map_member_actions(map, resource)
 
           if block_given?
-            with_options(:path_prefix => resource.nesting_path_prefix, &block)
+            with_options(:path_prefix => resource.nesting_path_prefix, :new_name_prefix => resource.nesting_name_prefix, &block)
           end
         end
       end
@@ -324,8 +346,21 @@ module ActionController
         resource.collection_methods.each do |method, actions|
           actions.each do |action|
             action_options = action_options_for(action, resource, method)
-            map.named_route("#{resource.name_prefix}#{action}_#{resource.plural}", "#{resource.path};#{action}", action_options)
-            map.named_route("formatted_#{resource.name_prefix}#{action}_#{resource.plural}", "#{resource.path}.:format;#{action}", action_options)
+
+            unless resource.old_name_prefix.blank?
+              map.deprecated_named_route("#{action}_#{resource.name_prefix}#{resource.plural}", "#{resource.old_name_prefix}#{action}_#{resource.plural}")
+              map.deprecated_named_route("formatted_#{action}_#{resource.name_prefix}#{resource.plural}", "formatted_#{resource.old_name_prefix}#{action}_#{resource.plural}")
+            end
+
+            if resource.deprecate_name_prefix?
+              map.deprecated_named_route("#{action}_#{resource.name_prefix}#{resource.plural}", "#{action}_#{resource.plural}")
+              map.deprecated_named_route("formatted_#{action}_#{resource.name_prefix}#{resource.plural}", "formatted_#{action}_#{resource.plural}")
+            end
+
+            map.named_route("#{action}_#{resource.name_prefix}#{resource.plural}", "#{resource.path}#{resource.action_separator}#{action}", action_options)
+            map.connect("#{resource.path};#{action}", action_options)
+            map.connect("#{resource.path}.:format;#{action}", action_options)
+            map.named_route("formatted_#{action}_#{resource.name_prefix}#{resource.plural}", "#{resource.path}#{resource.action_separator}#{action}.:format", action_options)
           end
         end
       end
@@ -335,6 +370,11 @@ module ActionController
         map.named_route("#{resource.name_prefix}#{resource.plural}", resource.path, index_action_options)
         map.named_route("formatted_#{resource.name_prefix}#{resource.plural}", "#{resource.path}.:format", index_action_options)
 
+        if resource.deprecate_name_prefix?
+          map.deprecated_named_route("#{resource.name_prefix}#{resource.plural}", "#{resource.plural}")
+          map.deprecated_named_route("formatted_#{resource.name_prefix}#{resource.plural}", "formatted_#{resource.plural}")
+        end
+
         create_action_options = action_options_for("create", resource)
         map.connect(resource.path, create_action_options)
         map.connect("#{resource.path}.:format", create_action_options)
@@ -351,11 +391,37 @@ module ActionController
           actions.each do |action|
             action_options = action_options_for(action, resource, method)
             if action == :new
-              map.named_route("#{resource.name_prefix}new_#{resource.singular}", resource.new_path, action_options)
-              map.named_route("formatted_#{resource.name_prefix}new_#{resource.singular}", "#{resource.new_path}.:format", action_options)
+
+              unless resource.old_name_prefix.blank?
+                map.deprecated_named_route("new_#{resource.name_prefix}#{resource.singular}", "#{resource.old_name_prefix}new_#{resource.singular}")
+                map.deprecated_named_route("formatted_new_#{resource.name_prefix}#{resource.singular}", "formatted_#{resource.old_name_prefix}new_#{resource.singular}")
+              end
+
+              if resource.deprecate_name_prefix?
+                map.deprecated_named_route("new_#{resource.name_prefix}#{resource.singular}", "new_#{resource.singular}")
+                map.deprecated_named_route("formatted_new_#{resource.name_prefix}#{resource.singular}", "formatted_new_#{resource.singular}")
+              end
+
+              map.named_route("new_#{resource.name_prefix}#{resource.singular}", resource.new_path, action_options)
+              map.named_route("formatted_new_#{resource.name_prefix}#{resource.singular}", "#{resource.new_path}.:format", action_options)
+
             else
-              map.named_route("#{resource.name_prefix}#{action}_new_#{resource.singular}", "#{resource.new_path};#{action}", action_options)
-              map.named_route("formatted_#{resource.name_prefix}#{action}_new_#{resource.singular}", "#{resource.new_path}.:format;#{action}", action_options)
+
+              unless resource.old_name_prefix.blank?
+                map.deprecated_named_route("#{action}_new_#{resource.name_prefix}#{resource.singular}", "#{resource.old_name_prefix}#{action}_new_#{resource.singular}")
+                map.deprecated_named_route("formatted_#{action}_new_#{resource.name_prefix}#{resource.singular}", "formatted_#{resource.old_name_prefix}#{action}_new_#{resource.singular}")
+              end
+
+              if resource.deprecate_name_prefix?
+                map.deprecated_named_route("#{action}_new_#{resource.name_prefix}#{resource.singular}", "#{action}_new_#{resource.singular}")
+                map.deprecated_named_route("formatted_#{action}_new_#{resource.name_prefix}#{resource.singular}", "formatted_#{action}_new_#{resource.singular}")
+              end
+
+              map.named_route("#{action}_new_#{resource.name_prefix}#{resource.singular}", "#{resource.new_path}#{resource.action_separator}#{action}", action_options)
+              map.connect("#{resource.new_path};#{action}", action_options)
+              map.connect("#{resource.new_path}.:format;#{action}", action_options)
+              map.named_route("formatted_#{action}_new_#{resource.name_prefix}#{resource.singular}", "#{resource.new_path}#{resource.action_separator}#{action}.:format", action_options)
+
             end
           end
         end
@@ -365,8 +431,22 @@ module ActionController
         resource.member_methods.each do |method, actions|
           actions.each do |action|
             action_options = action_options_for(action, resource, method)
-            map.named_route("#{resource.name_prefix}#{action}_#{resource.singular}", "#{resource.member_path};#{action}", action_options)
-            map.named_route("formatted_#{resource.name_prefix}#{action}_#{resource.singular}", "#{resource.member_path}.:format;#{action}",action_options)
+
+            unless resource.old_name_prefix.blank?
+              map.deprecated_named_route("#{action}_#{resource.name_prefix}#{resource.singular}", "#{resource.old_name_prefix}#{action}_#{resource.singular}")
+              map.deprecated_named_route("formatted_#{action}_#{resource.name_prefix}#{resource.singular}", "formatted_#{resource.old_name_prefix}#{action}_#{resource.singular}")
+            end
+
+            if resource.deprecate_name_prefix?
+              map.deprecated_named_route("#{action}_#{resource.name_prefix}#{resource.singular}", "#{action}_#{resource.singular}")
+              map.deprecated_named_route("formatted_#{action}_#{resource.name_prefix}#{resource.singular}", "formatted_#{action}_#{resource.singular}")
+            end
+
+            map.named_route("#{action}_#{resource.name_prefix}#{resource.singular}", "#{resource.member_path}#{resource.action_separator}#{action}", action_options)
+            map.connect("#{resource.member_path};#{action}", action_options)
+            map.connect("#{resource.member_path}.:format;#{action}", action_options)
+            map.named_route("formatted_#{action}_#{resource.name_prefix}#{resource.singular}", "#{resource.member_path}#{resource.action_separator}#{action}.:format", action_options)
+
           end
         end
 
@@ -374,6 +454,11 @@ module ActionController
         map.named_route("#{resource.name_prefix}#{resource.singular}", resource.member_path, show_action_options)
         map.named_route("formatted_#{resource.name_prefix}#{resource.singular}", "#{resource.member_path}.:format", show_action_options)
 
+        if resource.deprecate_name_prefix?
+          map.deprecated_named_route("#{resource.name_prefix}#{resource.singular}", "#{resource.singular}")
+          map.deprecated_named_route("formatted_#{resource.name_prefix}#{resource.singular}", "formatted_#{resource.singular}")
+        end
+
         update_action_options = action_options_for("update", resource)
         map.connect(resource.member_path, update_action_options)
         map.connect("#{resource.member_path}.:format", update_action_options)

data/lib/action_controller/routing.rb

@@ -989,6 +989,10 @@ module ActionController
         def named_route(name, path, options = {})
           @set.add_named_route(name, path, options)
         end
+        
+        def deprecated_named_route(name, deprecated_name, options = {})
+          @set.add_deprecated_named_route(name, deprecated_name)
+        end
 
         # Added deprecation notice for anyone who already added a named route called "root".
         # It'll be used as a shortcut for map.connect '' in Rails 2.0.
@@ -1019,7 +1023,7 @@ module ActionController
         def clear!
           @routes = {}
           @helpers = []
-          
+
           @module ||= Module.new
           @module.instance_methods.each do |selector|
             @module.send :remove_method, selector
@@ -1055,6 +1059,38 @@ module ActionController
         def install(destinations = [ActionController::Base, ActionView::Base])
           Array(destinations).each { |dest| dest.send :include, @module }
         end
+        
+        def define_deprecated_named_route_methods(name, deprecated_name)
+
+          [:url, :path].each do |kind|
+            @module.send :module_eval, <<-end_eval # We use module_eval to avoid leaks
+
+              def #{url_helper_name(deprecated_name, kind)}(*args)
+
+                ActiveSupport::Deprecation.warn(
+                  'The named route "#{url_helper_name(deprecated_name, kind)}" uses a format that has been deprecated. ' +
+                  'You should use "#{url_helper_name(name, kind)}" instead.', caller
+                )
+
+                send :#{url_helper_name(name, kind)}, *args
+
+              end
+
+              def #{hash_access_name(deprecated_name, kind)}(*args)
+
+                ActiveSupport::Deprecation.warn(
+                  'The named route "#{hash_access_name(deprecated_name, kind)}" uses a format that has been deprecated. ' +
+                  'You should use "#{hash_access_name(name, kind)}" instead.', caller
+                )
+
+                send :#{hash_access_name(name, kind)}, *args
+
+              end
+
+            end_eval
+          end
+
+        end
 
         private
           def url_helper_name(name, kind = :url)
@@ -1177,6 +1213,10 @@ module ActionController
       def add_named_route(name, path, options = {})
         named_routes[name] = add_route(path, options)
       end
+      
+      def add_deprecated_named_route(name, deprecated_name)
+        named_routes.define_deprecated_named_route_methods(name, deprecated_name)
+      end
   
       def options_as_params(options)
         # If an explicit :controller was given, always make :action explicit