wycats-merb-core 0.9.8 → 0.9.9

data/lib/merb-core/dispatch/router/resources.rb

@@ -1,191 +1,305 @@
 module Merb
   class Router
-    class Behavior
-      module Resources
-
-        # Behavior#+resources+ is a route helper for defining a collection of
-        # RESTful resources. It yields to a block for child routes.
-        #
-        # ==== Parameters
-        # name<String, Symbol>:: The name of the resources
-        # options<Hash>::
-        #   Ovverides and parameters to be associated with the route
-        #
-        # ==== Options (options)
-        # :namespace<~to_s>: The namespace for this route.
-        # :name_prefix<~to_s>:
-        #   A prefix for the named routes. If a namespace is passed and there
-        #   isn't a name prefix, the namespace will become the prefix.
-        # :controller<~to_s>: The controller for this route
-        # :collection<~to_s>: Special settings for the collections routes
-        # :member<Hash>:
-        #   Special settings and resources related to a specific member of this
-        #   resource.
-        # :keys<Array>:
-        #   A list of the keys to be used instead of :id with the resource in the order of the url.
-        #
-        # ==== Block parameters
-        # next_level<Behavior>:: The child behavior.
-        #
-        # ==== Returns
-        # Array::
-        #   Routes which will define the specified RESTful collection of resources
-        #
-        # ==== Examples
-        #
-        #  r.resources :posts # will result in the typical RESTful CRUD
-        #    # lists resources
-        #    # GET     /posts/?(\.:format)?      :action => "index"
-        #    # GET     /posts/index(\.:format)?  :action => "index"
-        #
-        #    # shows new resource form
-        #    # GET     /posts/new                :action => "new"
-        #
-        #    # creates resource
-        #    # POST    /posts/?(\.:format)?,     :action => "create"
-        #
-        #    # shows resource
-        #    # GET     /posts/:id(\.:format)?    :action => "show"
-        #
-        #    # shows edit form
-        #    # GET     /posts/:id/edit        :action => "edit"
-        #
-        #    # updates resource
-        #    # PUT     /posts/:id(\.:format)?    :action => "update"
-        #
-        #    # shows deletion confirmation page
-        #    # GET     /posts/:id/delete      :action => "delete"
-        #
-        #    # destroys resources
-        #    # DELETE  /posts/:id(\.:format)?    :action => "destroy"
-        #
-        #  # Nesting resources
-        #  r.resources :posts do |posts|
-        #    posts.resources :comments
-        #  end
-        #---
-        # @public
-        def resources(name, options = {}, &block)
-          singular   = name.to_s.singularize
-          keys       = options.delete(:keys) || [:id]
-          params     = { :controller => options.delete(:controller) || name.to_s }
-          collection = options.delete(:collection) || {}
-          member     = { :edit => :get, :delete => :get }.merge(options.delete(:member) || {})
+    
+    module Resources
+      # Behavior#+resources+ is a route helper for defining a collection of
+      # RESTful resources. It yields to a block for child routes.
+      #
+      # ==== Parameters
+      # name<String, Symbol>:: The name of the resources
+      # options<Hash>::
+      #   Ovverides and parameters to be associated with the route
+      #
+      # ==== Options (options)
+      # :namespace<~to_s>: The namespace for this route.
+      # :name_prefix<~to_s>:
+      #   A prefix for the named routes. If a namespace is passed and there
+      #   isn't a name prefix, the namespace will become the prefix.
+      # :controller<~to_s>: The controller for this route
+      # :collection<~to_s>: Special settings for the collections routes
+      # :member<Hash>:
+      #   Special settings and resources related to a specific member of this
+      #   resource.
+      # :identify<Symbol|Array>: The method(s) that should be called on the object
+      #   before inserting it into an URL.
+      # :keys<Array>:
+      #   A list of the keys to be used instead of :id with the resource in the order of the url.
+      # :singular<Symbol>
+      #
+      # ==== Block parameters
+      # next_level<Behavior>:: The child behavior.
+      #
+      # ==== Returns
+      # Array::
+      #   Routes which will define the specified RESTful collection of resources
+      #
+      # ==== Examples
+      #
+      #  r.resources :posts # will result in the typical RESTful CRUD
+      #    # lists resources
+      #    # GET     /posts/?(\.:format)?      :action => "index"
+      #    # GET     /posts/index(\.:format)?  :action => "index"
+      #
+      #    # shows new resource form
+      #    # GET     /posts/new                :action => "new"
+      #
+      #    # creates resource
+      #    # POST    /posts/?(\.:format)?,     :action => "create"
+      #
+      #    # shows resource
+      #    # GET     /posts/:id(\.:format)?    :action => "show"
+      #
+      #    # shows edit form
+      #    # GET     /posts/:id/edit        :action => "edit"
+      #
+      #    # updates resource
+      #    # PUT     /posts/:id(\.:format)?    :action => "update"
+      #
+      #    # shows deletion confirmation page
+      #    # GET     /posts/:id/delete      :action => "delete"
+      #
+      #    # destroys resources
+      #    # DELETE  /posts/:id(\.:format)?    :action => "destroy"
+      #
+      #  # Nesting resources
+      #  r.resources :posts do |posts|
+      #    posts.resources :comments
+      #  end
+      #---
+      # @public
+      def resources(name, *args, &block)
+        name       = name.to_s
+        options    = extract_options_from_args!(args) || {}
+        singular   = options[:singular] ? options[:singular].to_s : Extlib::Inflection.singularize(name)
+        klass_name = args.first ? args.first.to_s : Extlib::Inflection.classify(singular)
+        klass      = Object.full_const_get(klass_name) rescue nil
+        keys       = options.delete(:keys) || options.delete(:key)
+        params     = { :controller => options.delete(:controller) || name }
+        collection = options.delete(:collection) || {}
+        member     = { :edit => :get, :delete => :get }.merge(options.delete(:member) || {})
+        
+        # Use the identifier for the class as a default
+        if klass
+          keys ||= options[:identify]
+          keys ||= @identifiers[klass]
+        elsif options[:identify]
+          raise Error, "The constant #{klass_name} does not exist, please specify the constant for this resource"
+        end
+        
+        keys = [ keys || :id ].flatten
+        
 
-          # Try pulling :namespace out of options for backwards compatibility
-          options[:name_prefix]       ||= nil # Don't use a name_prefix if not needed
-          options[:controller_prefix] ||= options.delete(:namespace)
+        # Try pulling :namespace out of options for backwards compatibility
+        options[:name_prefix]       ||= nil # Don't use a name_prefix if not needed
+        options[:resource_prefix]   ||= nil # Don't use a resource_prefix if not needed
+        options[:controller_prefix] ||= options.delete(:namespace)
 
-          self.namespace(name, options).to(params) do |resource|
-            root_keys = keys.map { |k| ":#{k}" }.join("/")
-            # => index
-            resource.match("(/index)(.:format)", :method => :get).to(:action => "index").name(name)
-            # => create
-            resource.match("(.:format)", :method => :post).to(:action => "create")
-            # => new
-            resource.match("/new(.:format)", :method => :get).to(:action => "new").name(:new, singular)
+        context = options[:identify]
+        context = klass && options[:identify] ? identify(klass => options.delete(:identify)) : self
+        context.namespace(name, options).to(params) do |resource|
+          root_keys = keys.map { |k| ":#{k}" }.join("/")
+          
+          # => index
+          resource.match("(/index)(.:format)", :method => :get).to(:action => "index").
+            name(name).register_resource(name)
+            
+          # => create
+          resource.match("(.:format)", :method => :post).to(:action => "create")
+          
+          # => new
+          resource.match("/new(.:format)", :method => :get).to(:action => "new").
+            name("new", singular).register_resource(name, "new")
 
-            # => user defined collection routes
-            collection.each_pair do |action, method|
-              resource.match("/#{action}(.:format)", :method => method).to(:action => "#{action}").name(action, name)
-            end
+          # => user defined collection routes
+          collection.each_pair do |action, method|
+            action = action.to_s
+            resource.match("/#{action}(.:format)", :method => method).to(:action => "#{action}").
+              name(action, name).register_resource(name, action)
+          end
 
-            # => show
-            resource.match("/#{root_keys}(.:format)", :method => :get).to(:action => "show").name(singular)
+          # => show
+          resource.match("/#{root_keys}(.:format)", :method => :get).to(:action => "show").
+            name(singular).register_resource(klass_name)
 
-            # => user defined member routes
-            member.each_pair do |action, method|
-              resource.match("/#{root_keys}/#{action}(.:format)", :method => method).to(:action => "#{action}").name(action, singular)
-            end
+          # => user defined member routes
+          member.each_pair do |action, method|
+            action = action.to_s
+            resource.match("/#{root_keys}/#{action}(.:format)", :method => method).
+              to(:action => "#{action}").name(action, singular).register_resource(klass_name, action)
+          end
 
-            # => update
-            resource.match("/#{root_keys}(.:format)", :method => :put).to(:action => "update")
-            # => destroy
-            resource.match("/#{root_keys}(.:format)", :method => :delete).to(:action => "destroy")
+          # => update
+          resource.match("/#{root_keys}(.:format)", :method => :put).
+            to(:action => "update")
+            
+          # => destroy
+          resource.match("/#{root_keys}(.:format)", :method => :delete).
+            to(:action => "destroy")
 
-            if block_given?
-              nested_keys = keys.map { |k| k.to_s == "id" ? ":#{singular}_id" : ":#{k}" }.join("/")
-              resource.options(:name_prefix => singular).match("/#{nested_keys}", &block)
+          if block_given?
+            nested_keys = keys.map do |k|
+              k.to_s == "id" ? ":#{singular}_id" : ":#{k}"
+            end.join("/")
+            
+            # Procs for building the extra collection/member resource routes
+            placeholder = Router.resource_routes[ [@options[:resource_prefix], klass_name].flatten.compact ]
+            builders    = {}
+            
+            builders[:collection] = lambda do |action, to, method|
+              resource.before(placeholder).match("/#{action}(.:format)", :method => method).
+                to(:action => to).name(action, name).register_resource(name, action)
             end
-
+            
+            builders[:member] = lambda do |action, to, method|
+              resource.match("/#{root_keys}/#{action}(.:format)", :method => method).
+                to(:action => to).name(action, singular).register_resource(klass_name, action)
+            end
+            
+            resource.options(:name_prefix => singular, :resource_prefix => klass_name).
+              match("/#{nested_keys}").resource_block(builders, &block)
           end
-        end
+        end # namespace
+      end # resources
 
-        # Behavior#+resource+ is a route helper for defining a singular RESTful
-        # resource. It yields to a block for child routes.
-        #
-        # ==== Parameters
-        # name<String, Symbol>:: The name of the resource.
-        # options<Hash>::
-        #   Overides and parameters to be associated with the route.
-        #
-        # ==== Options (options)
-        # :namespace<~to_s>: The namespace for this route.
-        # :name_prefix<~to_s>:
-        #   A prefix for the named routes. If a namespace is passed and there
-        #   isn't a name prefix, the namespace will become the prefix.
-        # :controller<~to_s>: The controller for this route
-        #
-        # ==== Block parameters
-        # next_level<Behavior>:: The child behavior.
-        #
-        # ==== Returns
-        # Array:: Routes which define a RESTful single resource.
-        #
-        # ==== Examples
-        #
-        #  r.resource :account # will result in the typical RESTful CRUD
-        #    # shows new resource form      
-        #    # GET     /account/new                :action => "new"
-        #
-        #    # creates resource      
-        #    # POST    /account/?(\.:format)?,     :action => "create"
-        #
-        #    # shows resource      
-        #    # GET     /account/(\.:format)?       :action => "show"
-        #
-        #    # shows edit form      
-        #    # GET     /account//edit           :action => "edit"
-        #
-        #    # updates resource      
-        #    # PUT     /account/(\.:format)?       :action => "update"
-        #
-        #    # shows deletion confirmation page      
-        #    # GET     /account//delete         :action => "delete"
-        #
-        #    # destroys resources      
-        #    # DELETE  /account/(\.:format)?       :action => "destroy"
-        #
-        # You can optionally pass :namespace and :controller to refine the routing
-        # or pass a block to nest resources.
-        #
-        #   r.resource :account, :namespace => "admin" do |account|
-        #     account.resources :preferences, :controller => "settings"
-        #   end
-        # ---
-        # @public
-        def resource(name, options = {}, &block)
-          params = { :controller => options.delete(:controller) || name.to_s.pluralize }
+      # Behavior#+resource+ is a route helper for defining a singular RESTful
+      # resource. It yields to a block for child routes.
+      #
+      # ==== Parameters
+      # name<String, Symbol>:: The name of the resource.
+      # options<Hash>::
+      #   Overides and parameters to be associated with the route.
+      #
+      # ==== Options (options)
+      # :namespace<~to_s>: The namespace for this route.
+      # :name_prefix<~to_s>:
+      #   A prefix for the named routes. If a namespace is passed and there
+      #   isn't a name prefix, the namespace will become the prefix.
+      # :controller<~to_s>: The controller for this route
+      #
+      # ==== Block parameters
+      # next_level<Behavior>:: The child behavior.
+      #
+      # ==== Returns
+      # Array:: Routes which define a RESTful single resource.
+      #
+      # ==== Examples
+      #
+      #  r.resource :account # will result in the typical RESTful CRUD
+      #    # shows new resource form      
+      #    # GET     /account/new                :action => "new"
+      #
+      #    # creates resource      
+      #    # POST    /account/?(\.:format)?,     :action => "create"
+      #
+      #    # shows resource      
+      #    # GET     /account/(\.:format)?       :action => "show"
+      #
+      #    # shows edit form      
+      #    # GET     /account//edit           :action => "edit"
+      #
+      #    # updates resource      
+      #    # PUT     /account/(\.:format)?       :action => "update"
+      #
+      #    # shows deletion confirmation page      
+      #    # GET     /account//delete         :action => "delete"
+      #
+      #    # destroys resources      
+      #    # DELETE  /account/(\.:format)?       :action => "destroy"
+      #
+      # You can optionally pass :namespace and :controller to refine the routing
+      # or pass a block to nest resources.
+      #
+      #   r.resource :account, :namespace => "admin" do |account|
+      #     account.resources :preferences, :controller => "settings"
+      #   end
+      # ---
+      # @public
+      def resource(name, *args, &block)
+        name    = name.to_s
+        options = extract_options_from_args!(args) || {}
+        params  = { :controller => options.delete(:controller) || name.pluralize }
+        member  = { :new => :get, :edit => :get, :delete => :get }.merge(options.delete(:member) || {})
 
-          options[:name_prefix]       ||= nil # Don't use a name_prefix if not needed
-          options[:controller_prefix] ||= options.delete(:namespace)
+        options[:name_prefix]       ||= nil # Don't use a name_prefix if not needed
+        options[:resource_prefix]   ||= nil # Don't use a resource_prefix if not needed
+        options[:controller_prefix] ||= options.delete(:namespace)
 
-          self.namespace(name, options).to(params) do |resource|
-            resource.match("(.:format)",        :method => :get   ).to(:action => "show"   ).name(name)
-            resource.match("(.:format)",        :method => :post  ).to(:action => "create" )
-            resource.match("(.:format)",        :method => :put   ).to(:action => "update" )
-            resource.match("(.:format)",        :method => :delete).to(:action => "destroy")
-            resource.match("/new(.:format)",    :method => :get   ).to(:action => "new"    ).name(:new, name)
-            resource.match("/edit(.:format)",   :method => :get   ).to(:action => "edit"   ).name(:edit, name)
-            resource.match("/delete(.:format)", :method => :get   ).to(:action => "delete" ).name(:delete, name)
+        self.namespace(name, options).to(params) do |resource|
+          # => show
+          resource.match("(.:format)", :method => :get).to(:action => "show").
+            name(name).register_resource(name)
+            
+          # => create
+          resource.match("(.:format)", :method => :post).to(:action => "create")
+            
+          # => update
+          resource.match("(.:format)", :method => :put).to(:action => "update")
+            
+          # => destroy
+          resource.match("(.:format)", :method => :delete).to(:action => "destroy")
+          
+          member.each_pair do |action, method|
+            action = action.to_s
+            resource.match("/#{action}(.:format)", :method => method).to(:action => action).
+              name(action, name).register_resource(name, action)
+          end
 
-            resource.options(:name_prefix => name, &block) if block_given?
+          if block_given?
+            builders = {}
+            
+            builders[:member] = lambda do |action, to, method|
+              resource.match("/#{action}(.:format)", :method => method).to(:action => to).
+                name(action, name).register_resource(name, action)
+            end
+            
+            resource.options(:name_prefix => name, :resource_prefix => name).
+              resource_block(builders, &block)
           end
         end
+      end
+      
+    protected
+    
+      def register_resource(*key)
+        key = [@options[:resource_prefix], key].flatten.compact
+        @route.resource = key
+        self
+      end
 
+      def resource_block(builders, &block)
+        behavior = ResourceBehavior.new(builders, @proxy, @conditions, @params, @defaults, @identifiers, @options, @blocks)
+        with_behavior_context(behavior, &block)
       end
 
+    end # Resources
+    
+    class Behavior
       include Resources
     end
+    
+    # Adding the collection and member methods to behavior
+    class ResourceBehavior < Behavior #:nodoc:
+      
+      def initialize(builders, *args)
+        super(*args)
+        @collection = builders[:collection]
+        @member     = builders[:member]
+      end
+      
+      def collection(action, options = {})
+        action = action.to_s
+        method = options[:method]
+        to     = options[:to] || action
+        @collection[action, to, method]
+      end
+      
+      def member(action, options = {})
+        action = action.to_s
+        method = options[:method]
+        to     = options[:to] || action
+        @member[action, to, method]
+      end
+      
+    end
   end
 end