snusnu-merb_resource_controller 0.1.0 → 0.2.0

data/README.textile

@@ -200,84 +200,222 @@ how the controllers behave. Of course you are also free to override all the meth
 <pre>
 <code>  
 def index
+  set_action_specific_provides(:index)
   load_resource
   display requested_resource
 end
 
 def show
+  set_action_specific_provides(:show)
   load_resource
   raise Merb::ControllerExceptions::NotFound unless requested_resource
   display requested_resource
 end
 
 def new
-  only_provides :html
+  set_action_specific_provides(:new)
   load_resource
   set_member(new_member)
   display member
 end
 
 def edit
-  only_provides :html
+  set_action_specific_provides(:edit)
   load_resource
   raise Merb::ControllerExceptions::NotFound unless requested_resource
   display requested_resource
 end
 
 def create
+  set_action_specific_provides(:create)
   load_resource
-  set_member(new_member(params[member_name]))
+  set_member(new_member)
   if member.save
-    options = flash_supported? ? { :message => successful_create_messages } : {}
-    redirect redirect_on_successful_create, options
+    handle_successful_create
   else
-    message.merge!(failed_create_messages) if flash_supported?
-    render :new
+    handle_failed_create
   end
 end
 
 def update
+  set_action_specific_provides(:update)
   load_resource
   raise Merb::ControllerExceptions::NotFound unless requested_resource
   if requested_resource.update_attributes(params[member_name])
-    options = flash_supported? ? { :message => successful_update_messages } : {}
-    redirect redirect_on_successful_update, options
+    handle_successful_update
   else
-    message.merge!(failed_update_messages) if flash_supported?
-    display requested_resource, :edit
+    handle_failed_update
   end
 end
 
 def destroy
+  set_action_specific_provides(:destroy)
   load_resource
   raise Merb::ControllerExceptions::NotFound unless requested_resource
   if requested_resource.destroy
-    options = flash_supported? ? { :message => successful_destroy_messages } : {}
-    redirect redirect_on_successful_destroy, options
+    handle_successful_destroy
   else
-    raise Merb::ControllerExceptions::InternalServerError
+    handle_failed_destroy
   end
 end
 </code>
 </pre>
 
-h2. Additional Helper Methods
+h2. Additional Methods to override
+
+In addition to the actions and the methods they are using, you will probably want to override some other methods that
+@merb_resource_controller@ uses to do its thing. Here are some default method implementations you can override to this effect:
 
-In addition to the actions and the methods they are using, you will probably want to override the redirection targets
-These are the default method implementations you can override to this effect:
+h3. Customize the create action
 
 <pre>
 <code>
+def handle_successful_create
+  handle_content_type(:create, content_type, :success)
+end
+
+def handle_failed_create
+  handle_content_type(:create, content_type, :failure)
+end
+
+
+def html_response_on_successful_create
+  options = flash_messages_for?(:create) ? { :message => successful_create_messages } : {}
+  redirect redirect_on_successful_create, options          
+end
+        
+def html_response_on_failed_create
+  message.merge!(failed_create_messages) if flash_messages_for?(:create)
+  render :new, :status => 406         
+end
+
+        
+def xml_response_on_successful_create
+  display member, :status => 201, :location => resource(member)
+end
+        
+def xml_response_on_failed_create
+  display member.errors, :status => 422
+end        
+
+     
+def json_response_on_successful_create
+  display member, :status => 201, :location => resource(member)         
+end
+        
+def json_response_on_failed_create
+  display member.errors, :status => 422
+end
+
+
 def redirect_on_successful_create
   target = singleton_controller? ? member_name : member
   resource(*(has_parent? ? parents + [ target ] : [ target ]))
 end
 
+# These are available by default (i.e. if all actions are available)
+# If you specify specific actions inside the block passed to #controlling
+# you need to pass the :flash option to the ResourceProxy#action like so:
+# action :create, :flash => true
+
+def successful_create_messages
+  { :notice => "#{member.class.name} was successfully created" }
+end
+
+def failed_create_messages
+  { :error => "Failed to create new #{member.class.name}" }
+end
+</code>
+</pre>
+
+h3. Customize the update action
+
+<code>
+<pre>
+def handle_successful_update
+  handle_content_type(:update, content_type, :success)
+end
+
+def handle_failed_update
+  handle_content_type(:update, content_type, :failure)
+end
+
+
+def html_response_on_successful_update
+  options = flash_messages_for?(:update) ? { :message => successful_update_messages } : {}
+  redirect redirect_on_successful_update, options       
+end
+        
+def html_response_on_failed_update
+  message.merge!(failed_update_messages) if flash_messages_for?(:update)
+  display requested_resource, :edit, :status => 406
+end
+
+        
+def xml_response_on_successful_update
+  "" # render no content, just 200 (OK) status.
+end
+        
+def xml_response_on_failed_update
+  display member.errors, :status => 422
+end        
+
+     
+def json_response_on_successful_update
+  "" # render no content, just 200 (OK) status.
+end
+        
+def json_response_on_failed_update
+  display member.errors, :status => 422
+end
+
 def redirect_on_successful_update
   target = singleton_controller? ? member_name : member
   resource(*(has_parent? ? parents + [ target ] : [ target ]))
 end
 
+# These are available by default (i.e. if all actions are available)
+# If you specify specific actions inside the block passed to #controlling
+# you need to pass the :flash option to the ResourceProxy#action like so:
+# action :update, :flash => true
+
+def successful_update_messages
+  { :notice => "#{member.class.name} was successfully updated" }
+end
+
+def failed_update_messages
+  { :error => "Failed to update #{member.class.name}" }
+end
+</code>
+</pre>
+
+h3. Customize the destroy action
+
+<code>
+<pre>
+def handle_successful_destroy
+  handle_content_type(:destroy, content_type, :success)
+end
+
+def handle_failed_destroy
+  raise Merb::ControllerExceptions::InternalServerError
+end
+
+
+def html_response_on_successful_destroy
+  options = flash_messages_for?(:destroy) ? { :message => successful_destroy_messages } : {}
+  redirect redirect_on_successful_destroy, options 
+end
+        
+def xml_response_on_successful_destroy
+  "" # render no content, just 200 (OK) status.
+end
+     
+def json_response_on_successful_destroy
+  "" # render no content, just 200 (OK) status.
+end
+
+
 def redirect_on_successful_destroy
   if singleton_controller?
     has_parent? ? resource(parent) : '/'
@@ -285,6 +423,19 @@ def redirect_on_successful_destroy
     resource(*(has_parent? ? parents + [ collection_name ] : [ collection_name ]))
   end
 end
+
+# These are available by default (i.e. if all actions are available)
+# If you specify specific actions inside the block passed to #controlling
+# you need to pass the :flash option to the ResourceProxy#action like so:
+# action :destroy, :flash => true
+
+def successful_destroy_messages
+  { :notice => "#{member.class.name} was successfully destroyed" }
+end
+
+def failed_destroy_messages
+  { :error => "Failed to destroy #{member.class.name}" }
+end
 </code>
 </pre>
 
@@ -301,6 +452,5 @@ behaves under the given circumstances.
 h2. TODO
 
 # Infer route nesting strategy from @Merb::Router@
-# Customizable support for @provides@ and @only_provides@
 # Support for user stamps (aka created_by and updated_by)
 # Support for pagination once an _official_ merb pagination solution exists

data/Rakefile

@@ -6,7 +6,7 @@ require 'merb-core/tasks/merb'
 require "spec/rake/spectask"
 
 GEM_NAME = "merb_resource_controller"
-GEM_VERSION = "0.1.0"
+GEM_VERSION = "0.2.0"
 AUTHOR = "Martin Gamsjaeger"
 EMAIL = "gamsnjaga@gmail.com"
 HOMEPAGE = "http://merbivore.com/"

data/TODO

@@ -2,6 +2,5 @@ TODO
 ====
 
 # Infer route nesting strategy from @Merb::Router@
-# Customizable support for @provides@ and @only_provides@
 # Support for user stamps (aka created_by and updated_by)
 # Support for pagination once an _official_ merb pagination solution exists

data/lib/merb_resource_controller.rb

@@ -11,9 +11,10 @@ if defined?(Merb::Plugins)
   Merb::BootLoader.before_app_loads do
     # require code that must be loaded before the application
     mrc = File.join(File.dirname(__FILE__), 'merb_resource_controller')
-    require mrc / 'resource_proxy'
     require mrc / 'actions'
+    require mrc / 'action_descriptor'
     require mrc / 'resource_controller'
+    require mrc / 'resource_proxy'
     if Merb::Plugins.config[:merb_resource_controller][:identity_map]
       require mrc / 'identity_map_support'
     end

data/lib/merb_resource_controller/action_descriptor.rb

@@ -0,0 +1,107 @@
+module Merb
+  module ResourceController
+    
+    
+    FLASH_SUPPORT_MODULE = "FlashSupport"
+
+    def self.action_module(action)
+      Actions.const_get(Extlib::Inflection.classify(action))
+    end
+    
+    
+    class ActionDescriptor
+      
+      SUPPORTED_SCENARIOS     = [ :success, :failure ]
+      FORMAT_RESTRICTION_APIS = [ :provides, :only_provides, :does_not_provide ]
+    
+      attr_reader :action_name, :provided_formats, :options
+      
+      def initialize(name, provided_formats, options = {})
+        raise unless valid_format_restriction?(options)
+        @action_name, @provided_formats, @options = name.to_sym, provided_formats, options
+        @content_type_handlers = { :success => {}, :failure => {} }
+        handle_default_content_types if options[:default_formats]
+      end
+      
+      
+      def action_module
+        Merb::ResourceController.action_module(@action_name)
+      end
+      
+      
+      def supports_flash_messages?
+        !!@options[:flash] && has_flash_module?
+      end
+      
+      def has_flash_module?
+        !flash_module.nil?
+      end
+      
+      def flash_module
+        action_module.const_get Merb::ResourceController::FLASH_SUPPORT_MODULE
+      rescue
+        nil
+      end
+      
+      
+      def handle_default_content_types
+        handle
+      end
+      
+      def handle(format = nil, scenario = nil)
+        raise "#{scenario} is not supported" unless SUPPORTED_SCENARIOS.include?(scenario) || scenario.nil?
+        (format ? format.is_a?(Array) ? format : [ format ] : @provided_formats).each do |f|
+          (scenario ? [ scenario ] : SUPPORTED_SCENARIOS).each do |s| 
+            @content_type_handlers[s][f] = content_type_handler_method(f, s)
+          end
+        end
+      end
+      
+      def content_type_handler(format, scenario)
+        @content_type_handlers[scenario.to_sym][format.to_sym]
+      end
+      
+      def content_type_handler_method(format, scenario)
+        case scenario
+        when :success then "#{format}_response_on_successful_#{@action_name}"
+        when :failure then "#{format}_response_on_failed_#{@action_name}"
+        else
+          raise "default_content_type_handler doesn't support #{scenario.inspect} (only :on_success and :on_failure)"
+        end
+      end
+      
+      
+      def valid_format_restriction?(options = nil)
+        format_restriction(options || @options).size <= 1 # empty is valid too
+      end
+      
+      def has_format_restriction?(options = nil)
+        format_restriction(options).size > 0
+      end
+      
+      def format_restrictor_method(options = nil)
+        o = options || @options
+        lambda { send(format_restriction_api(o), restricted_formats(o)) }
+      end
+      
+      
+      def format_restriction_api(options = nil)
+        format_restriction(options || @options).map { |kv| kv[0] }.first
+      end
+      
+      def restricted_formats(options = nil)
+        format_restriction(options || @options).map { |kv| kv[1] }.flatten
+      end
+      
+      def format_restriction(options = nil)
+        (options || @options).select { |k,v| format_restriction_apis.include?(k) }
+      end
+      
+      def format_restriction_apis
+        FORMAT_RESTRICTION_APIS
+      end
+  
+    end
+  
+  end
+end

data/lib/merb_resource_controller/actions.rb

@@ -11,6 +11,7 @@ module Merb
         # end
         
         def index
+          set_action_specific_provides(:index)
           load_resource
           display requested_resource
         end
@@ -26,6 +27,7 @@ module Merb
         # end
         
         def show
+          set_action_specific_provides(:show)
           load_resource
           raise Merb::ControllerExceptions::NotFound unless requested_resource
           display requested_resource
@@ -42,7 +44,7 @@ module Merb
         # end
         
         def new
-          only_provides :html
+          set_action_specific_provides(:new)
           load_resource
           set_member(new_member)
           display member
@@ -60,7 +62,7 @@ module Merb
         # end
         
         def edit
-          only_provides :html
+          set_action_specific_provides(:edit)
           load_resource
           raise Merb::ControllerExceptions::NotFound unless requested_resource
           display requested_resource
@@ -81,22 +83,75 @@ module Merb
         # end
         
         def create
+          set_action_specific_provides(:create)
           load_resource
           set_member(new_member)
           if member.save
-            options = flash_supported? ? { :message => successful_create_messages } : {}
-            redirect redirect_on_successful_create, options
+            handle_successful_create
           else
-            message.merge!(failed_create_messages) if flash_supported?
-            render :new, :status => 406
+            handle_failed_create
           end
         end
         
+        protected
+                
+        def handle_successful_create
+          handle_content_type(:create, content_type, :success)
+        end
+        
+        def handle_failed_create
+          handle_content_type(:create, content_type, :failure)
+        end
+        
+        
+        def html_response_on_successful_create
+          options = flash_messages_for?(:create) ? { :message => successful_create_messages } : {}
+          redirect redirect_on_successful_create, options          
+        end
+                
+        def html_response_on_failed_create
+          message.merge!(failed_create_messages) if flash_messages_for?(:create)
+          render :new, :status => 406         
+        end
+        
+                
+        def xml_response_on_successful_create
+          display member, :status => 201, :location => resource(member)
+        end
+                
+        def xml_response_on_failed_create
+          display member.errors, :status => 422
+        end        
+        
+             
+        def json_response_on_successful_create
+          display member, :status => 201, :location => resource(member)         
+        end
+                
+        def json_response_on_failed_create
+          display member.errors, :status => 422
+        end
+        
+        
         def redirect_on_successful_create
           target = singleton_controller? ? member_name : member
           resource(*(has_parent? ? parents + [ target ] : [ target ]))
         end
         
+        module FlashSupport
+
+          protected
+
+          def successful_create_messages
+            { :notice => "#{member.class.name} was successfully created" }
+          end
+
+          def failed_create_messages
+            { :error => "Failed to create new #{member.class.name}" }
+          end
+          
+        end
+        
       end
 
       module Update
@@ -112,22 +167,74 @@ module Merb
         # end
         
         def update
+          set_action_specific_provides(:update)
           load_resource
           raise Merb::ControllerExceptions::NotFound unless requested_resource
           if requested_resource.update_attributes(params[member_name])
-            options = flash_supported? ? { :message => successful_update_messages } : {}
-            redirect redirect_on_successful_update, options
+            handle_successful_update
           else
-            message.merge!(failed_update_messages) if flash_supported?
-            display requested_resource, :edit, :status => 406
+            handle_failed_update
           end
         end
         
+        protected
+        
+        def handle_successful_update
+          handle_content_type(:update, content_type, :success)
+        end
+        
+        def handle_failed_update
+          handle_content_type(:update, content_type, :failure)
+        end
+        
+        
+        def html_response_on_successful_update
+          options = flash_messages_for?(:update) ? { :message => successful_update_messages } : {}
+          redirect redirect_on_successful_update, options       
+        end
+                
+        def html_response_on_failed_update
+          message.merge!(failed_update_messages) if flash_messages_for?(:update)
+          display requested_resource, :edit, :status => 406
+        end
+        
+                
+        def xml_response_on_successful_update
+          "" # render no content, just 200 (OK) status.
+        end
+                
+        def xml_response_on_failed_update
+          display member.errors, :status => 422
+        end        
+        
+             
+        def json_response_on_successful_update
+          "" # render no content, just 200 (OK) status.
+        end
+                
+        def json_response_on_failed_update
+          display member.errors, :status => 422
+        end
+        
         def redirect_on_successful_update
           target = singleton_controller? ? member_name : member
           resource(*(has_parent? ? parents + [ target ] : [ target ]))
         end
         
+        module FlashSupport
+
+          protected
+
+          def successful_update_messages
+            { :notice => "#{member.class.name} was successfully updated" }
+          end
+
+          def failed_update_messages
+            { :error => "Failed to update #{member.class.name}" }
+          end
+          
+        end
+        
       end
 
       module Destroy
@@ -143,16 +250,41 @@ module Merb
         # end
         
         def destroy
+          set_action_specific_provides(:destroy)
           load_resource
           raise Merb::ControllerExceptions::NotFound unless requested_resource
           if requested_resource.destroy
-            options = flash_supported? ? { :message => successful_destroy_messages } : {}
-            redirect redirect_on_successful_destroy, options
+            handle_successful_destroy
           else
-            raise Merb::ControllerExceptions::InternalServerError
+            handle_failed_destroy
           end
         end
         
+        protected
+        
+        def handle_successful_destroy
+          handle_content_type(:destroy, content_type, :success)
+        end
+        
+        def handle_failed_destroy
+          raise Merb::ControllerExceptions::InternalServerError
+        end
+        
+        
+        def html_response_on_successful_destroy
+          options = flash_messages_for?(:destroy) ? { :message => successful_destroy_messages } : {}
+          redirect redirect_on_successful_destroy, options 
+        end
+                
+        def xml_response_on_successful_destroy
+          "" # render no content, just 200 (OK) status.
+        end
+             
+        def json_response_on_successful_destroy
+          "" # render no content, just 200 (OK) status.
+        end
+        
+        
         def redirect_on_successful_destroy
           if singleton_controller?
             has_parent? ? resource(parent) : '/'
@@ -161,6 +293,20 @@ module Merb
           end
         end
         
+        module FlashSupport
+
+          protected
+
+          def successful_destroy_messages
+            { :notice => "#{member.class.name} was successfully destroyed" }
+          end
+
+          def failed_destroy_messages
+            { :error => "Failed to destroy #{member.class.name}" }
+          end
+          
+        end
+        
       end
 
     end