actionpack 1.13.1 → 1.13.2

data/CHANGELOG

@@ -1,3 +1,32 @@
+*1.13.2* (February 5th, 2007)
+
+* Add much-needed html-scanner tests.  Fixed CDATA parsing bug. [Rick]
+
+* improve error message for Routing for named routes. [Rob Sanheim]
+
+* Added enhanced docs to routing assertions. [Rob Sanheim]
+
+* fix form_for example in ActionController::Resources documentation. [gnarg]
+
+* Add singleton resources from trunk [Rick Olson]
+
+* TestSession supports indifferent access so session['foo'] == session[:foo] in your tests.  #7372 [julik, jean.helou]
+
+* select :multiple => true suffixes the attribute name with [] unless already suffixed.  #6977 [nik.kakelin, ben, julik]
+
+* Improve routes documentation.  #7095 [zackchandler]
+
+* Resource member routes require :id, eliminating the ambiguous overlap with collection routes.  #7229 [dkubb]
+
+* Fixed NumberHelper#number_with_delimiter to use "." always for splitting the original number, not the delimiter parameter #7389 [ceefour]
+
+* Autolinking recognizes trailing and embedded . , : ;  #7354 [Jarkko Laine]
+
+* Make TextHelper::auto_link recognize URLs with colons in path correctly, fixes #7268.  [imajes]
+
+* Improved auto_link to match more valid urls correctly [Tobias Luetke]
+
+
 *1.13.1* (January 18th, 2007)
 
 * Fixed content-type bug in Prototype [sam]

data/Rakefile

@@ -75,7 +75,7 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc = true
   s.requirements << 'none'
 
-  s.add_dependency('activesupport', '= 1.4.0' + PKG_BUILD)
+  s.add_dependency('activesupport', '= 1.4.1' + PKG_BUILD)
 
   s.require_path = 'lib'
   s.autorequire = 'action_controller'

data/lib/action_controller.rb

@@ -30,7 +30,7 @@ unless defined?(ActiveSupport)
     require 'active_support'  
   rescue LoadError
     require 'rubygems'
-    require_gem 'activesupport'
+    gem 'activesupport'
   end
 end
 

data/lib/action_controller/assertions/routing_assertions.rb

@@ -3,13 +3,23 @@ module ActionController
     module RoutingAssertions
       # Asserts that the routing of the given path was handled correctly and that the parsed options match.
       #
-      #   assert_recognizes({:controller => 'items', :action => 'index'}, 'items')
+      #   assert_recognizes({:controller => 'items', :action => 'index'}, 'items') # check the default action
+      #   assert_recognizes({:controller => 'items', :action => 'list'}, 'items/list') # check a specific action
+      #   assert_recognizes({:controller => 'items', :action => 'list', :id => '1'}, 'items/list/1') # check an action with a parameter
       #
       # Pass a hash in the second argument to specify the request method.  This is useful for routes
-      # requiring a specific method.
+      # requiring a specific HTTP method.  The hash should contain a :path with the incoming request path
+      # and a :method containing the required HTTP verb.
       #
+      #   # assert that POSTing to /items will call the create action on ItemsController
       #   assert_recognizes({:controller => 'items', :action => 'create'}, {:path => 'items', :method => :post})
       #
+      # You can also pass in "extras" with a hash containing URL parameters that would normally be in the query string.  This can be used
+      # to assert that values in the query string string will end up in the params hash correctly.  To test query strings you must use the
+      # extras argument, appending the query string on the path directly will not work.  For example: 
+      #
+      #   # assert that a path of '/items/list/1?view=print' returns the correct options
+      #   assert_recognizes({:controller => 'items', :action => 'list', :id => '1', :view => 'print'}, 'items/list/1', { :view => "print" }) 
       def assert_recognizes(expected_options, path, extras={}, message=nil)
         if path.is_a? Hash
           request_method = path[:method]
@@ -33,7 +43,12 @@ module ActionController
         end
       end
 
-      # Asserts that the provided options can be used to generate the provided path.
+      # Asserts that the provided options can be used to generate the provided path.  This is the inverse of assert_recognizes.
+      # For example:
+      #
+      #   assert_generates("/items", :controller => "items", :action => "index")
+      #   assert_generates("/items/list", :controller => "items", :action => "list")
+      #   assert_generates("/items/list/1", { :controller => "items", :action => "list", :id => "1" }) 
       def assert_generates(expected_path, options, defaults={}, extras = {}, message=nil)
         clean_backtrace do 
           expected_path = "/#{expected_path}" unless expected_path[0] == ?/
@@ -53,7 +68,8 @@ module ActionController
       end
 
       # Asserts that path and options match both ways; in other words, the URL generated from 
-      # options is the same as path, and also that the options recognized from path are the same as options
+      # options is the same as path, and also that the options recognized from path are the same as options.  This
+      # essentially combines assert_recognizes and assert_generates into one step.
       def assert_routing(path, options, defaults={}, extras={}, message=nil)
         assert_recognizes(options, path, extras, message)
         

data/lib/action_controller/resources.rb

@@ -18,26 +18,26 @@ module ActionController
       end
       
       def controller
-        (options[:controller] || plural).to_s
+        @controller ||= (options[:controller] || plural).to_s
       end
       
       def path
-        "#{path_prefix}/#{plural}"
+        @path ||= "#{path_prefix}/#{plural}"
       end
       
       def new_path
-        "#{path}/new"
+        @new_path ||= "#{path}/new"
       end
       
       def member_path
-        "#{path}/:id"
+        @member_path ||= "#{path}/:id"
       end
       
       def nesting_path_prefix
-        "#{path}/:#{singular}_id"
+        @nesting_path_prefix ||= "#{path}/:#{singular}_id"
       end
       
-      private
+      protected
         def arrange_actions
           @collection_methods = arrange_actions_by_methods(options.delete(:collection))
           @member_methods     = arrange_actions_by_methods(options.delete(:member))
@@ -65,7 +65,20 @@ module ActionController
           (collection[method] ||= []).unshift(action)
         end
     end
-    
+
+    class SingletonResource < Resource #:nodoc:
+      def initialize(entity, options)
+        @plural = @singular = entity
+        @options = options
+        arrange_actions
+        add_default_actions
+        set_prefixes
+      end
+
+      alias_method :member_path,         :path
+      alias_method :nesting_path_prefix, :path
+    end
+
     # Creates named routes for implementing verb-oriented controllers. This is
     # useful for implementing REST API's, where a single resource has different
     # behavior based on the HTTP verb (method) used to access it.
@@ -145,7 +158,7 @@ module ActionController
     #   
     # or 
     #   
-    #   <% form_for :message, @message, message_path(@message), :html => {:method => :put} do |f| %>
+    #   <% form_for :message, @message, :url => message_path(@message), :html => {:method => :put} do |f| %>
     # 
     # The #resources method accepts various options, too, to customize the resulting
     # routes:
@@ -217,12 +230,87 @@ module ActionController
       entities.each { |entity| map_resource entity, options.dup, &block }
     end
 
+    # Creates named routes for implementing verb-oriented controllers for a singleton resource. 
+    # A singleton resource is global to the current user visiting the application, such as a user's
+    # /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.
+    #   - When nesting singleton resources, only the singular name is used as the path prefix (example: 'account/messages/1')
+    #
+    # Example:
+    #
+    #   map.resource :account 
+    #
+    #   class AccountController < ActionController::Base
+    #     # POST account_url
+    #     def create
+    #       # create an account
+    #     end
+    #
+    #     # GET new_account_url
+    #     def new
+    #       # return an HTML form for describing the new account
+    #     end
+    #
+    #     # GET account_url
+    #     def show
+    #       # find and return the account
+    #     end
+    #
+    #     # GET edit_account_url
+    #     def edit
+    #       # return an HTML form for editing the account
+    #     end
+    #
+    #     # PUT account_url
+    #     def update
+    #       # find and update the account
+    #     end
+    #
+    #     # DELETE account_url
+    #     def destroy
+    #       # delete the account
+    #     end
+    #   end
+    #
+    # Along with the routes themselves, #resource generates named routes for use in
+    # controllers and views. <tt>map.resource :account</tt> produces the following named routes and helpers:
+    # 
+    #   Named Route   Helpers
+    #   account       account_url, hash_for_account_url, 
+    #                 account_path, hash_for_account_path
+    #   edit_account  edit_account_url, hash_for_edit_account_url,
+    #                 edit_account_path, hash_for_edit_account_path
+    def resource(*entities, &block)
+      options = entities.last.is_a?(Hash) ? entities.pop : { }
+      entities.each { |entity| map_singleton_resource entity, options.dup, &block }
+    end
+
     private
       def map_resource(entities, options = {}, &block)
         resource = Resource.new(entities, options)
 
         with_options :controller => resource.controller do |map|
           map_collection_actions(map, resource)
+          map_default_collection_actions(map, resource)
+          map_new_actions(map, resource)
+          map_member_actions(map, resource)
+
+          if block_given?
+            with_options(:path_prefix => resource.nesting_path_prefix, &block)
+          end
+        end
+      end
+
+      def map_singleton_resource(entities, options = {}, &block)
+        resource = SingletonResource.new(entities, options)
+
+        with_options :controller => resource.controller do |map|
+          map_collection_actions(map, resource)
+          map_default_singleton_actions(map, resource)
           map_new_actions(map, resource)
           map_member_actions(map, resource)
 
@@ -234,67 +322,82 @@ module ActionController
 
       def map_collection_actions(map, resource)
         resource.collection_methods.each do |method, actions|
-          route_options = requirements_for(method)
-
           actions.each do |action|
-            map.named_route(
-              "#{resource.name_prefix}#{action}_#{resource.plural}", 
-              "#{resource.path};#{action}", 
-              route_options.merge(:action => action.to_s)
-            )
-
-            map.named_route(
-              "formatted_#{resource.name_prefix}#{action}_#{resource.plural}",
-              "#{resource.path}.:format;#{action}",
-              route_options.merge(:action => action.to_s)
-            )
+            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)
           end
         end
+      end
 
-        map.named_route("#{resource.name_prefix}#{resource.plural}", resource.path, :action => "index", :conditions => { :method => :get })
-        map.named_route("formatted_#{resource.name_prefix}#{resource.plural}", "#{resource.path}.:format", :action => "index", :conditions => { :method => :get })
+      def map_default_collection_actions(map, resource)
+        index_action_options = action_options_for("index", resource)
+        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)
+
+        create_action_options = action_options_for("create", resource)
+        map.connect(resource.path, create_action_options)
+        map.connect("#{resource.path}.:format", create_action_options)
+      end
 
-        map.connect(resource.path, :action => "create", :conditions => { :method => :post })
-        map.connect("#{resource.path}.:format", :action => "create", :conditions => { :method => :post })
+      def map_default_singleton_actions(map, resource)
+        create_action_options = action_options_for("create", resource)
+        map.connect(resource.path, create_action_options)
+        map.connect("#{resource.path}.:format", create_action_options)
       end
 
       def map_new_actions(map, resource)
         resource.new_methods.each do |method, actions|
-          route_options = requirements_for(method)
           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, route_options.merge(:action => "new"))
-              map.named_route("formatted_#{resource.name_prefix}new_#{resource.singular}", "#{resource.new_path}.:format", route_options.merge(: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)
             else
-              map.named_route("#{resource.name_prefix}#{action}_new_#{resource.singular}", "#{resource.new_path};#{action}", route_options.merge(:action => action.to_s))
-              map.named_route("formatted_#{resource.name_prefix}#{action}_new_#{resource.singular}", "#{resource.new_path}.:format;#{action}", route_options.merge(:action => action.to_s))
+              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)
             end
           end
         end
       end
-      
+
       def map_member_actions(map, resource)
         resource.member_methods.each do |method, actions|
-          route_options = requirements_for(method)
-
           actions.each do |action|
-            map.named_route("#{resource.name_prefix}#{action}_#{resource.singular}", "#{resource.member_path};#{action}", route_options.merge(:action => action.to_s))
-            map.named_route("formatted_#{resource.name_prefix}#{action}_#{resource.singular}", "#{resource.member_path}.:format;#{action}", route_options.merge(:action => action.to_s))
+            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)
           end
         end
 
-        map.named_route("#{resource.name_prefix}#{resource.singular}", resource.member_path, :action => "show", :conditions => { :method => :get })
-        map.named_route("formatted_#{resource.name_prefix}#{resource.singular}", "#{resource.member_path}.:format", :action => "show", :conditions => { :method => :get })
+        show_action_options = action_options_for("show", resource)
+        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)
 
-        map.connect(resource.member_path, :action => "update", :conditions => { :method => :put })
-        map.connect("#{resource.member_path}.:format", :action => "update", :conditions => { :method => :put })
+        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)
 
-        map.connect(resource.member_path, :action => "destroy", :conditions => { :method => :delete })
-        map.connect("#{resource.member_path}.:format", :action => "destroy", :conditions => { :method => :delete })
+        destroy_action_options = action_options_for("destroy", resource)
+        map.connect(resource.member_path, destroy_action_options)
+        map.connect("#{resource.member_path}.:format", destroy_action_options)
       end
-    
-      def requirements_for(method)
-        method == :any ? {} : { :conditions => { :method => method } }
+
+      def conditions_for(method)
+        { :conditions => method == :any ? {} : { :method => method } }
+      end
+
+      def action_options_for(action, resource, method = nil)
+        default_options = { :action => action.to_s }
+        require_id = resource.kind_of?(SingletonResource) ? {} : { :requirements => { :id => Regexp.new("[^#{Routing::SEPARATORS.join}]+") } }
+        case default_options[:action]
+          when "index", "new" : default_options.merge(conditions_for(method || :get))
+          when "create"       : default_options.merge(conditions_for(method || :post))
+          when "show", "edit" : default_options.merge(conditions_for(method || :get)).merge(require_id)
+          when "update"       : default_options.merge(conditions_for(method || :put)).merge(require_id)
+          when "destroy"      : default_options.merge(conditions_for(method || :delete)).merge(require_id)
+          else                  default_options.merge(conditions_for(method))
+        end
       end
   end
 end

data/lib/action_controller/routing.rb

@@ -126,7 +126,8 @@ module ActionController
   # == Named routes
   #
   # Routes can be named with the syntax <tt>map.name_of_route options</tt>,
-  # allowing for easy reference within your source as +name_of_route_url+.
+  # allowing for easy reference within your source as +name_of_route_url+
+  # for the full URL and +name_of_route_path+ for the URI path.
   #
   # Example:
   #   # In routes.rb
@@ -137,29 +138,39 @@ module ActionController
   #
   # Arguments can be passed as well.
   #
-  #   redirect_to show_item_url(:id => 25)
+  #   redirect_to show_item_path(:id => 25)
   #
-  # When using +with_options+, the name goes after the item passed to the block.
+  # Use <tt>map.root</tt> as a shorthand to name a route for the root path ""
   #
-  #  ActionController::Routing::Routes.draw do |map| 
-  #    map.with_options :controller => 'blog' do |blog|
-  #      blog.show    '',            :action  => 'list'
-  #      blog.delete  'delete/:id',  :action  => 'delete',
-  #      blog.edit    'edit/:id',    :action  => 'edit'
-  #    end
-  #    map.connect ':controller/:action/:view 
-  #  end
+  #   # In routes.rb
+  #   map.root :controller => 'blogs'
+  #
+  #   # would recognize http://www.example.com/ as
+  #   params = { :controller => 'blogs', :action => 'index' }
+  #
+  #   # and provide these named routes
+  #   root_url   # => 'http://www.example.com/'
+  #   root_path  # => ''
   #
-  # You would then use the named routes in your views:
+  # Note: when using +with_options+, the route is simply named after the
+  # method you call on the block parameter rather than map.
   #
-  #   link_to @article.title, show_url(:id => @article.id) 
+  #   # In routes.rb
+  #   map.with_options :controller => 'blog' do |blog|
+  #     blog.show    '',            :action  => 'list'
+  #     blog.delete  'delete/:id',  :action  => 'delete',
+  #     blog.edit    'edit/:id',    :action  => 'edit'
+  #   end
+  #
+  #   # provides named routes for show, delete, and edit
+  #   link_to @article.title, show_path(:id => @article.id) 
   #
-  # == Pretty URL's
+  # == Pretty URLs
   #
   # Routes can generate pretty URLs. For example:
   #
   #  map.connect 'articles/:year/:month/:day',
-  #   	         :controller => 'articles', 
+  #              :controller => 'articles', 
   #              :action     => 'find_by_date',
   #              :year       => /\d{4}/,
   #              :month => /\d{1,2}/, 
@@ -1230,8 +1241,11 @@ module ActionController
     
         if named_route
           path = named_route.generate(options, merged, expire_on)
-          raise RoutingError, "#{named_route_name}_url failed to generate from #{options.inspect}, expected: #{named_route.requirements.inspect}, diff: #{named_route.requirements.diff(options).inspect}" if path.nil?
-          return path
+          if path.nil? 
+            raise_named_route_error(options, named_route, named_route_name)
+          else
+            return path
+          end
         else
           merged[:action] ||= 'index'
           options[:action] ||= 'index'
@@ -1251,6 +1265,18 @@ module ActionController
     
         raise RoutingError, "No route matches #{options.inspect}"
       end
+      
+      # try to give a helpful error message when named route generation fails
+      def raise_named_route_error(options, named_route, named_route_name)
+        diff = named_route.requirements.diff(options)
+        unless diff.empty?
+          raise RoutingError, "#{named_route_name}_url failed to generate from #{options.inspect}, expected: #{named_route.requirements.inspect}, diff: #{named_route.requirements.diff(options).inspect}"
+        else
+          required_segments = named_route.segments.select {|seg| (!seg.optional?) && (!seg.is_a?(DividerSegment)) }
+          required_keys_or_values = required_segments.map { |seg| seg.key rescue seg.value } # we want either the key or the value from the segment
+          raise RoutingError, "#{named_route_name}_url failed to generate from #{options.inspect} - you may have ambiguous routes, or you may need to supply additional parameters for this route.  content_url has the following required parameters: #{required_keys_or_values.inspect} - are they all satisifed?"
+        end
+      end
   
       def recognize(request)
         params = recognize_path(request.path, extract_request_environment(request))