resource_controller 0.5.2 → 0.5.3

data/lib/resource_controller/helpers/current_objects.rb

@@ -1,69 +1,73 @@
-module ResourceController::Helpers::CurrentObjects
-  protected
-    # Used internally to return the model for your resource.  
-    #
-    def model
-      model_name.to_s.camelize.constantize
-    end
+module ResourceController
+  module Helpers
+    module CurrentObjects
+      protected
+        # Used internally to return the model for your resource.  
+        #
+        def model
+          model_name.to_s.camelize.constantize
+        end
 
   
-    # Used to fetch the collection for the index method
-    #
-    # In order to customize the way the collection is fetched, to add something like pagination, for example, override this method.
-    #
-    def collection
-      end_of_association_chain.find(:all)
-    end
+        # Used to fetch the collection for the index method
+        #
+        # In order to customize the way the collection is fetched, to add something like pagination, for example, override this method.
+        #
+        def collection
+          end_of_association_chain.find(:all)
+        end
     
-    # Returns the current param.
-    # 
-    # Defaults to params[:id].
-    #
-    # Override this method if you'd like to use an alternate param name.
-    #
-    def param
-      params[:id]
-    end
+        # Returns the current param.
+        # 
+        # Defaults to params[:id].
+        #
+        # Override this method if you'd like to use an alternate param name.
+        #
+        def param
+          params[:id]
+        end
   
-    # Used to fetch the current member object in all of the singular methods that operate on an existing member.
-    #
-    # Override this method if you'd like to fetch your objects in some alternate way, like using a permalink.
-    #
-    # class PostsController < ResourceController::Base
-    #   private
-    #     def object
-    #       @object ||= end_of_association_chain.find_by_permalink(param)
-    #     end
-    #   end
-    #
-    def object
-      @object ||= end_of_association_chain.find(param) unless param.nil?
-      @object
-    end
+        # Used to fetch the current member object in all of the singular methods that operate on an existing member.
+        #
+        # Override this method if you'd like to fetch your objects in some alternate way, like using a permalink.
+        #
+        # class PostsController < ResourceController::Base
+        #   private
+        #     def object
+        #       @object ||= end_of_association_chain.find_by_permalink(param)
+        #     end
+        #   end
+        #
+        def object
+          @object ||= end_of_association_chain.find(param) unless param.nil?
+          @object
+        end
     
-    # Used internally to load the member object in to an instance variable @#{model_name} (i.e. @post)
-    #
-    def load_object
-      instance_variable_set "@#{parent_type}", parent_object if parent?
-      instance_variable_set "@#{object_name}", object
-    end
+        # Used internally to load the member object in to an instance variable @#{model_name} (i.e. @post)
+        #
+        def load_object
+          instance_variable_set "@#{parent_type}", parent_object if parent?
+          instance_variable_set "@#{object_name}", object
+        end
     
-    # Used internally to load the collection in to an instance variable @#{model_name.pluralize} (i.e. @posts)
-    #
-    def load_collection
-      instance_variable_set "@#{parent_type}", parent_object if parent?
-      instance_variable_set "@#{object_name.to_s.pluralize}", collection
-    end
+        # Used internally to load the collection in to an instance variable @#{model_name.pluralize} (i.e. @posts)
+        #
+        def load_collection
+          instance_variable_set "@#{parent_type}", parent_object if parent?
+          instance_variable_set "@#{object_name.to_s.pluralize}", collection
+        end
   
-    # Returns the form params.  Defaults to params[model_name] (i.e. params["post"])
-    #
-    def object_params
-      params["#{object_name}"]
-    end
+        # Returns the form params.  Defaults to params[model_name] (i.e. params["post"])
+        #
+        def object_params
+          params["#{object_name}"]
+        end
     
-    # Builds the object, but doesn't save it, during the new, and create action.
-    #
-    def build_object
-      @object ||= end_of_association_chain.send parent? ? :build : :new, object_params
+        # Builds the object, but doesn't save it, during the new, and create action.
+        #
+        def build_object
+          @object ||= end_of_association_chain.send parent? ? :build : :new, object_params
+        end
     end
+  end
 end

data/lib/resource_controller/helpers/internal.rb

@@ -2,75 +2,79 @@
 # 
 # All of these methods are used internally to execute the options, set by the user in ActionOptions and FailableActionOptions
 #
-module ResourceController::Helpers::Internal
-  protected
-    # Used to actually pass the responses along to the controller's respond_to method.
-    #
-    def response_for(action)
-      respond_to do |wants|
-        options_for(action).response.each do |method, block|
-          if block.nil?
-            wants.send(method)
-          else
-            wants.send(method) { instance_eval(&block) }
+module ResourceController
+  module Helpers
+    module Internal
+      protected
+        # Used to actually pass the responses along to the controller's respond_to method.
+        #
+        def response_for(action)
+          respond_to do |wants|
+            options_for(action).response.each do |method, block|
+              if block.nil?
+                wants.send(method)
+              else
+                wants.send(method) { instance_eval(&block) }
+              end
+            end
           end
         end
-      end
-    end
+
+        # Calls the after callbacks for the action, if one is present.
+        #
+        def after(action)
+          invoke_callbacks *options_for(action).after
+        end
+
+        # Calls the before block for the action, if one is present.
+        #
+        def before(action)
+          invoke_callbacks *self.class.send(action).before
+        end
   
-    # Calls the after callbacks for the action, if one is present.
-    #
-    def after(action)
-      invoke_callbacks *options_for(action).after
-    end
+        # Sets the flash and flash_now for the action, if it is present.
+        #
+        def set_flash(action)
+          set_normal_flash(action)
+          set_flash_now(action)
+        end
   
-    # Calls the before block for the action, if one is present.
-    #
-    def before(action)
-      invoke_callbacks *self.class.send(action).before
-    end
-    
-    # Sets the flash and flash_now for the action, if it is present.
-    #
-    def set_flash(action)
-      set_normal_flash(action)
-      set_flash_now(action)
-    end
-    
-    # Sets the regular flash (i.e. flash[:notice] = '...')
-    #
-    def set_normal_flash(action)
-      if f = options_for(action).flash
-        flash[:notice]     = f.is_a?(Proc) ? instance_eval(&f) : options_for(action).flash
-      end
-    end
-    
-    # Sets the flash.now (i.e. flash.now[:notice] = '...')
-    #
-    def set_flash_now(action)
-      if f = options_for(action).flash_now
-        flash.now[:notice] = f.is_a?(Proc) ? instance_eval(&f) : options_for(action).flash_now
-      end
-    end
-    
-    # Returns the options for an action, which is a symbol.
-    #
-    # Manages splitting things like :create_fails.
-    #
-    def options_for(action)
-      action = action == :new_action ? [action] : "#{action}".split('_').map(&:to_sym)
-      options = self.class.send(action.first)
-      options = options.send(action.last == :fails ? :fails : :success) if ResourceController::FAILABLE_ACTIONS.include? action.first
+        # Sets the regular flash (i.e. flash[:notice] = '...')
+        #
+        def set_normal_flash(action)
+          if f = options_for(action).flash
+            flash[:notice]     = f.is_a?(Proc) ? instance_eval(&f) : options_for(action).flash
+          end
+        end
+  
+        # Sets the flash.now (i.e. flash.now[:notice] = '...')
+        #
+        def set_flash_now(action)
+          if f = options_for(action).flash_now
+            flash.now[:notice] = f.is_a?(Proc) ? instance_eval(&f) : options_for(action).flash_now
+          end
+        end
+  
+        # Returns the options for an action, which is a symbol.
+        #
+        # Manages splitting things like :create_fails.
+        #
+        def options_for(action)
+          action = action == :new_action ? [action] : "#{action}".split('_').map(&:to_sym)
+          options = self.class.send(action.first)
+          options = options.send(action.last == :fails ? :fails : :success) if ResourceController::FAILABLE_ACTIONS.include? action.first
+  
+          options
+        end
+  
+        def invoke_callbacks(*callbacks)
+          unless callbacks.empty?
+            callbacks.select { |callback| callback.is_a? Symbol }.each { |symbol| send(symbol) }
     
-      options
+            block = callbacks.detect { |callback| callback.is_a? Proc }
+            instance_eval &block unless block.nil?
+          end
+        end 
     end
-    
-    def invoke_callbacks(*callbacks)
-      unless callbacks.empty?
-        callbacks.select { |callback| callback.is_a? Symbol }.each { |symbol| send(symbol) }
-      
-        block = callbacks.detect { |callback| callback.is_a? Proc }
-        instance_eval &block unless block.nil?
-      end
-    end 
+  end
 end

data/lib/resource_controller/helpers/nested.rb

@@ -1,63 +1,67 @@
 # Nested and Polymorphic Resource Helpers
 #
-module ResourceController::Helpers::Nested
-  protected    
-    # Returns the relevant association proxy of the parent. (i.e. /posts/1/comments # => @post.comments)
-    #
-    def parent_association
-      @parent_association ||= parent_object.send(model_name.to_s.pluralize.to_sym)
-    end
+module ResourceController
+  module Helpers
+    module Nested
+      protected    
+        # Returns the relevant association proxy of the parent. (i.e. /posts/1/comments # => @post.comments)
+        #
+        def parent_association
+          @parent_association ||= parent_object.send(model_name.to_s.pluralize.to_sym)
+        end
     
-    # Returns the type of the current parent
-    #
-    def parent_type
-      @parent_type ||= parent_type_from_params || parent_type_from_request
-    end
+        # Returns the type of the current parent
+        #
+        def parent_type
+          @parent_type ||= parent_type_from_params || parent_type_from_request
+        end
     
-    # Returns the type of the current parent extracted from params
-    #    
-    def parent_type_from_params
-      [*belongs_to].find { |parent| !params["#{parent}_id".to_sym].nil? }
-    end
+        # Returns the type of the current parent extracted from params
+        #    
+        def parent_type_from_params
+          [*belongs_to].find { |parent| !params["#{parent}_id".to_sym].nil? }
+        end
     
-    # Returns the type of the current parent extracted form a request path
-    #    
-    def parent_type_from_request
-      [*belongs_to].find { |parent| request.path.split('/').include? parent.to_s }
-    end
+        # Returns the type of the current parent extracted form a request path
+        #    
+        def parent_type_from_request
+          [*belongs_to].find { |parent| request.path.split('/').include? parent.to_s }
+        end
     
-    # Returns true/false based on whether or not a parent is present.
-    #
-    def parent?
-      !parent_type.nil?
-    end
+        # Returns true/false based on whether or not a parent is present.
+        #
+        def parent?
+          !parent_type.nil?
+        end
     
-    # Returns true/false based on whether or not a parent is a singleton.
-    #    
-    def parent_singleton?
-      !parent_type_from_request.nil?
-    end
+        # Returns true/false based on whether or not a parent is a singleton.
+        #    
+        def parent_singleton?
+          !parent_type_from_request.nil?
+        end
     
-    # Returns the current parent param, if there is a parent. (i.e. params[:post_id])
-    def parent_param
-      params["#{parent_type}_id".to_sym]
-    end
+        # Returns the current parent param, if there is a parent. (i.e. params[:post_id])
+        def parent_param
+          params["#{parent_type}_id".to_sym]
+        end
     
-    # Like the model method, but for a parent relationship.
-    # 
-    def parent_model
-      parent_type.to_s.camelize.constantize
-    end
+        # Like the model method, but for a parent relationship.
+        # 
+        def parent_model
+          parent_type.to_s.camelize.constantize
+        end
     
-    # Returns the current parent object if a parent object is present.
-    #
-    def parent_object
-      parent? && !parent_singleton? ? parent_model.find(parent_param) : nil
-    end
+        # Returns the current parent object if a parent object is present.
+        #
+        def parent_object
+          parent? && !parent_singleton? ? parent_model.find(parent_param) : nil
+        end
     
-    # If there is a parent, returns the relevant association proxy.  Otherwise returns model.
-    #
-    def end_of_association_chain
-      parent? ? parent_association : model
+        # If there is a parent, returns the relevant association proxy.  Otherwise returns model.
+        #
+        def end_of_association_chain
+          parent? ? parent_association : model
+        end
     end
+  end
 end

data/lib/resource_controller/helpers/singleton_customizations.rb

@@ -2,59 +2,63 @@
 # 
 # Used internally to transform a plural RESTful controller into a singleton
 #
-module ResourceController::Helpers::SingletonCustomizations
-  def self.included(subclass)
-    subclass.class_eval do  
-      methods_to_undefine = [:param, :index, :collection, :load_collection, :collection_url, 
-        :collection_path, :hash_for_collection_url, :hash_for_collection_path]
-      methods_to_undefine.each { |method| undef_method(method) if method_defined? method }
+module ResourceController
+  module Helpers
+    module SingletonCustomizations
+      def self.included(subclass)
+        subclass.class_eval do  
+          methods_to_undefine = [:param, :index, :collection, :load_collection, :collection_url, 
+            :collection_path, :hash_for_collection_url, :hash_for_collection_path]
+          methods_to_undefine.each { |method| undef_method(method) if method_defined? method }
       
-      class << self
-        def singleton?
-          true
+          class << self
+            def singleton?
+              true
+            end
+          end
         end
       end
-    end
-  end
   
-  protected
-    # Used to fetch the current object in a singleton controller.
-    #
-    # By defult this method is able to fetch the current object for resources nested with the :has_one association only. (i.e. /users/1/image # => @user.image)
-    # In other cases you should override this method and provide your custom code to fetch a singleton resource object, like using a session hash.
-    #
-    # class AccountsController < ResourceController::Singleton
-    #   private
-    #     def object
-    #       @object ||= Account.find(session[:account_id])
-    #     end
-    #   end
-    #  
-    def object
-      @object ||= parent? ? end_of_association_chain : nil
-    end
+      protected
+        # Used to fetch the current object in a singleton controller.
+        #
+        # By defult this method is able to fetch the current object for resources nested with the :has_one association only. (i.e. /users/1/image # => @user.image)
+        # In other cases you should override this method and provide your custom code to fetch a singleton resource object, like using a session hash.
+        #
+        # class AccountsController < ResourceController::Singleton
+        #   private
+        #     def object
+        #       @object ||= Account.find(session[:account_id])
+        #     end
+        #   end
+        #  
+        def object
+          @object ||= parent? ? end_of_association_chain : nil
+        end
 
-    # Returns the :has_one association proxy of the parent. (i.e. /users/1/image # => @user.image)
-    #  
-    def parent_association
-      @parent_association ||= parent_object.send(model_name.to_sym)
-    end
+        # Returns the :has_one association proxy of the parent. (i.e. /users/1/image # => @user.image)
+        #  
+        def parent_association
+          @parent_association ||= parent_object.send(model_name.to_sym)
+        end
   
-    # Used internally to provide the options to smart_url in a singleton controller.
-    #  
-    def object_url_options(action_prefix = nil, alternate_object = nil)
-      [action_prefix] + namespaces + [parent_url_options, route_name.to_sym]
-    end
+        # Used internally to provide the options to smart_url in a singleton controller.
+        #  
+        def object_url_options(action_prefix = nil, alternate_object = nil)
+          [action_prefix] + namespaces + [parent_url_options, route_name.to_sym]
+        end
   
-    # Builds the object, but doesn't save it, during the new, and create action.
-    #
-    def build_object
-      @object ||= singleton_build_object_base.send parent? ? "build_#{model_name}".to_sym : :new, object_params
-    end
+        # Builds the object, but doesn't save it, during the new, and create action.
+        #
+        def build_object
+          @object ||= singleton_build_object_base.send parent? ? "build_#{model_name}".to_sym : :new, object_params
+        end
     
-    # Singleton controllers don't build off of association proxy, so we can't use end_of_association_chain here
-    #
-    def singleton_build_object_base
-      parent? ? parent_object : model
+        # Singleton controllers don't build off of association proxy, so we can't use end_of_association_chain here
+        #
+        def singleton_build_object_base
+          parent? ? parent_object : model
+        end
     end
+  end
 end