snusnu-merb_resource_controller 0.1.0 → 0.2.0

data/lib/merb_resource_controller/resource_controller.rb

@@ -10,15 +10,14 @@ module Merb
       module ClassMethods
         
         def controlling(name, options = {})
-          options = { :flash => true }.merge!(options)
-          @resource_proxy = Merb::ResourceController::ResourceProxy.new(name, options)
+          @resource_proxy = ResourceProxy.new(name, class_provided_formats, options)
           yield @resource_proxy if block_given?
           class_inheritable_reader :resource_proxy
           include InstanceMethods
-          include FlashSupport if options[:flash]
-          @resource_proxy.registered_actions.each do |a|
-            include Merb::ResourceController::Actions.const_get("#{a[:name].to_s.camel_case}")
-            show_action(a[:name])
+          @resource_proxy.registered_actions.each do |action_descriptor|
+            include action_descriptor.action_module
+            include action_descriptor.flash_module if action_descriptor.supports_flash_messages?
+            show_action(action_descriptor.action_name)
           end
         end
     
@@ -33,6 +32,26 @@ module Merb
         end
         
         
+        def handle_content_type(action, format, scenario)
+          if handler = content_type_handler(action, format, scenario)
+            self.send(handler) if self.respond_to?(handler)
+          else
+            raise "no content type handler registered for #{action} #{format} #{scenario}"
+          end
+        end
+        
+        def content_type_handler(action, format, scenario)
+          resource_proxy.content_type_handler(action, format, scenario)
+        end
+        
+        def set_action_specific_provides(action)
+          if resource_proxy.has_format_restriction?(action)
+            provides_api, formats = resource_proxy.action_specific_provides(action)
+            self.send(provides_api, *formats)
+          end
+        end
+        
+        
         def singleton_controller?
           resource_proxy.singleton_resource?
         end
@@ -63,10 +82,7 @@ module Merb
         
         
         def load_resource
-          path = resource_proxy.path_to_resource(params)
-          # puts "path_to_resource: #{path.inspect}"
-          path.each do |pc|
-            # puts "setting @#{pc[0]} to #{pc[1].inspect}" if pc[1]
+          resource_proxy.path_to_resource(params).each do |pc|
             instance_variable_set("@#{pc[0]}", pc[1]) if pc[1]
           end
         end
@@ -116,43 +132,11 @@ module Merb
         end
         
         
-        def flash_supported?
-          self.kind_of?(FlashSupport)
+        def flash_messages_for?(action)
+          resource_proxy.flash_messages_for?(action)
         end
     
       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
-        
-                
-        def successful_update_messages
-          { :notice => "#{member.class.name} was successfully updated" }
-        end
-                
-        def failed_update_messages
-          { :error => "Failed to update #{member.class.name}" }
-        end
-                
-                
-        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
   

data/lib/merb_resource_controller/resource_proxy.rb

@@ -13,11 +13,12 @@ module Merb
         :use => :all
       })
       
-      attr_reader :resource, :parents, :registered_methods
+      attr_reader :resource, :provided_formats, :parents, :registered_methods
       
-      def initialize(resource, options = {})
+      def initialize(resource, provided_formats, options = {})
         options = DEFAULT_OPTIONS.merge(options)
         @resource, @singleton = load_resource(resource), !!options[:singleton]
+        @provided_formats = provided_formats || [ :html ]
         @fully_qualified = !!options[:fully_qualified]
         @actions, @registered_methods, @parents = [], [], []
         @specific_methods_registered = options[:use] != :all
@@ -26,17 +27,54 @@ module Merb
       end
       
       def action(name, options = {})
-        @actions << { :name => name.to_sym }.merge(options)
+        options = { :default_formats => true }.merge(options)
+        descriptor = ActionDescriptor.new(name, @provided_formats, options)
+        yield descriptor if block_given?
+        @actions << descriptor
       end
             
-      def actions(*names)
-        names.each { |n| @actions << n.is_a?(Hash) ? n : { :name => n.to_sym } }
+      def actions(*action_specs)
+        action_specs.each { |a| a.is_a?(Hash) ? action(a.delete(:name), a) : action(a) }
       end
       
       def registered_actions
         @actions
       end
       
+      def flash_messages_for?(action)
+        return false unless @actions.map { |ad| ad.action_name }.include?(action.to_sym)
+        @actions.any? { |ad| ad.action_name == action.to_sym && ad.supports_flash_messages? }
+      end
+      
+      
+      def action_descriptor(action)
+        ad = @actions.select { |ad| ad.action_name == action.to_sym }
+        ad.first ? ad.first : raise("No action named #{action} is registered for this controller")
+      end
+      
+      def content_type_handler(action, format, scenario)
+        action_descriptor(action).content_type_handler(format, scenario)
+      end
+      
+      def has_format_restriction?(action)
+        action_descriptor(action).has_format_restriction?
+      end
+      
+      def action_specific_provides(action)
+        ad = action_descriptor(action)
+        [ ad.format_restriction_api, ad.restricted_formats ]
+      end
+      
+      def register_default_actions!
+        action :index    unless @singleton
+        action :show
+        action :new,     :only_provides => :html
+        action :edit,    :only_provides => :html
+        action :create,  :flash => true
+        action :update,  :flash => true
+        action :destroy, :flash => true
+      end
+      
       # ----------------------------------------------------------------------------------------
       # # one level nestings
       # ----------------------------------------------------------------------------------------
@@ -275,13 +313,6 @@ module Merb
         end
       end
       
-      def register_default_actions!
-        action :index unless @singleton
-        [ :show, :new, :edit, :create, :update, :destroy ].each do |a|
-          action(a)
-        end
-      end
-      
       
       # KEEP THESE for later
       

data/spec/mrc_test_app/app/controllers/articles.rb

@@ -1,3 +1,4 @@
 class Articles < Application
+  provides :xml, :json
   controlling :articles
 end

data/spec/mrc_test_app/app/models/community/comment.rb

@@ -0,0 +1,20 @@
+module Community
+
+  class Comment
+  
+    include DataMapper::Resource
+  
+    property :id,         Serial
+    property :article_id, Integer, :nullable => false
+    property :body,       String,  :nullable => false, :length => (3..255)
+  
+    belongs_to :article
+    has n, :ratings, :class_name => "Community::Rating"
+    
+    def article_title
+      article.title
+    end
+  
+  end
+
+end

data/spec/mrc_test_app/app/models/community/rating.rb

@@ -0,0 +1,19 @@
+module Community
+
+  class Rating
+  
+    include DataMapper::Resource
+  
+    property :id,         Serial
+    property :comment_id, Integer, :nullable => false
+    property :rate,       Integer, :nullable => false
+  
+    belongs_to :comment
+    
+    def comment_body
+      comment.body
+    end
+  
+  end
+
+end

data/spec/mrc_test_app/app/views/community/ratings/new.html.erb

@@ -0,0 +1,11 @@
+<h2>New Rating</h2>
+ 
+<%= form_for(@rating, :action => resource(@comment, :ratings)) do %>
+ 
+  <p><%= text_field :rate, :label => "Rating" %></p>
+  
+  <p><%= submit "Create" %></p>
+  
+<% end =%>
+
+<%= link_to 'Show Comment', resource(@comment) %>

data/spec/mrc_test_app/config/init.rb

@@ -11,7 +11,6 @@ dependency "dm-constraints", dm_gems_version
 dependency "merb-assets",    merb_gems_version
 dependency "merb-helpers",   merb_gems_version
 
-
 use_orm :datamapper
 use_test :rspec
 use_template_engine :erb

data/spec/mrc_test_app/spec/lib/action_descriptor_spec.rb

@@ -0,0 +1,137 @@
+describe "Merb::ResourceController::ActionDescriptor" do
+  
+  it "should raise if no action is given" do
+    lambda { Merb::ResourceController::ActionDescriptor.new }.should raise_error
+  end
+  
+  it "should raise if more than one format restriction was specified" do
+    provided_formats = [ :html, :xml, :json, :yml ]
+    options = { :provides => :xml, :does_not_provide => :json, :only_provides => :yml }
+    lambda { Merb::ResourceController::ActionDescriptor.new(:index, provided_formats, options) }.should raise_error
+    options = { :provides => :xml, :does_not_provide => :json }
+    lambda { Merb::ResourceController::ActionDescriptor.new(:index, provided_formats, options) }.should raise_error  
+    options = { :provides => :xml, :only_provides => :json }
+    lambda { Merb::ResourceController::ActionDescriptor.new(:index, provided_formats, options) }.should raise_error    
+  end
+    
+  it "should allow valid format restriction apis" do
+    provided_formats = [ :html, :xml, :json, :yml ]
+    lambda { Merb::ResourceController::ActionDescriptor.new(:index, provided_formats, :provides => :xml)         }.should_not raise_error
+    lambda { Merb::ResourceController::ActionDescriptor.new(:index, provided_formats, :does_not_provide => :xml) }.should_not raise_error    
+    lambda { Merb::ResourceController::ActionDescriptor.new(:index, provided_formats, :only_provides => :xml)    }.should_not raise_error    
+  end
+        
+  it "should be able to infer the format restriction api" do
+    provided_formats = [ :html, :xml, :json, :yml ]
+    p = Merb::ResourceController::ActionDescriptor.new(:index, provided_formats)
+    p.format_restriction_api.should == nil
+    p.has_format_restriction?.should be_false
+    p = Merb::ResourceController::ActionDescriptor.new(:index, provided_formats, :provides => :xml)
+    p.format_restriction_api.should == :provides
+    p.has_format_restriction?.should be_true
+    p = Merb::ResourceController::ActionDescriptor.new(:index, provided_formats, :provides => [ :xml, :json ])
+    p.format_restriction_api.should == :provides
+    p.has_format_restriction?.should be_true
+  end
+            
+  it "should be able to infer the restricted formats" do
+    provided_formats = [ :html, :xml, :json, :yml ]
+    p = Merb::ResourceController::ActionDescriptor.new(:index, provided_formats)
+    p.restricted_formats.should be_empty
+    p = Merb::ResourceController::ActionDescriptor.new(:index, provided_formats, :provides => :xml)
+    p.restricted_formats.should == [ :xml ]
+    p = Merb::ResourceController::ActionDescriptor.new(:index, provided_formats, :provides => [ :xml, :json ])
+    p.restricted_formats.should == [ :xml, :json ]
+  end
+  
+      
+  it "should remember the action it is proxying" do
+    provided_formats = [ :html, :xml, :json, :yml ]
+    p = Merb::ResourceController::ActionDescriptor.new(:index, provided_formats)
+    p.action_name.should == :index
+  end    
+      
+  it "should know about the module that defines the action" do
+    provided_formats = [ :html, :xml, :json, :yml ]
+    p = Merb::ResourceController::ActionDescriptor.new(:index, provided_formats)
+    p.action_module.should == Merb::ResourceController::Actions::Index
+  end
+        
+  it "should know about the module that defines the flash support" do
+    provided_formats = [ :html, :xml, :json, :yml ]
+    p = Merb::ResourceController::ActionDescriptor.new(:index, provided_formats)
+    p.supports_flash_messages?.should be_false
+    p.has_flash_module?.should be_false
+    p.flash_module.should == nil
+    p = Merb::ResourceController::ActionDescriptor.new(:show, provided_formats)
+    p.supports_flash_messages?.should be_false
+    p.has_flash_module?.should be_false
+    p.flash_module.should == nil
+    p = Merb::ResourceController::ActionDescriptor.new(:new, provided_formats)
+    p.supports_flash_messages?.should be_false
+    p.has_flash_module?.should be_false
+    p.flash_module.should == nil
+    
+    p = Merb::ResourceController::ActionDescriptor.new(:edit, provided_formats)
+    p.supports_flash_messages?.should be_false
+    p.has_flash_module?.should be_false
+    p.flash_module.should == nil
+    
+    p = Merb::ResourceController::ActionDescriptor.new(:create, provided_formats)
+    p.supports_flash_messages?.should be_false
+    p.has_flash_module?.should be_true
+    p.flash_module.should == Merb::ResourceController::Actions::Create::FlashSupport
+    
+    p = Merb::ResourceController::ActionDescriptor.new(:update, provided_formats)
+    p.supports_flash_messages?.should be_false
+    p.has_flash_module?.should be_true
+    p.flash_module.should == Merb::ResourceController::Actions::Update::FlashSupport
+    
+    p = Merb::ResourceController::ActionDescriptor.new(:destroy, provided_formats)
+    p.supports_flash_messages?.should be_false
+    p.has_flash_module?.should be_true
+    p.flash_module.should == Merb::ResourceController::Actions::Destroy::FlashSupport
+    
+  end  
+      
+  it "should be able to infer the content_type_handler_method" do
+    provided_formats = [ :html, :xml, :json, :yml ]
+    p = Merb::ResourceController::ActionDescriptor.new(:create, provided_formats)
+    # builtin formats
+    p.content_type_handler_method(:html, :success).should == "html_response_on_successful_create"
+    p.content_type_handler_method(:html, :failure).should == "html_response_on_failed_create"
+    p.content_type_handler_method(:xml, :success).should  == "xml_response_on_successful_create"
+    p.content_type_handler_method(:xml, :failure).should  == "xml_response_on_failed_create"
+    p.content_type_handler_method(:json, :success).should == "json_response_on_successful_create"
+    p.content_type_handler_method(:json, :failure).should == "json_response_on_failed_create"
+    p.content_type_handler_method(:yml, :success).should  == "yml_response_on_successful_create"
+    p.content_type_handler_method(:yml, :failure).should  == "yml_response_on_failed_create"
+    # custom formats                                         
+    p.content_type_handler_method(:foo, :success).should  == "foo_response_on_successful_create"
+    p.content_type_handler_method(:foo, :failure).should  == "foo_response_on_failed_create"    
+  end
+        
+  it "should be able to register content type handlers" do
+    provided_formats = [ :html, :xml, :json, :yml ]
+    
+    p = Merb::ResourceController::ActionDescriptor.new(:create, provided_formats)
+    p.handle :json, :success
+    # p.content_type_handler(:json, :success).should == "json_response_on_successful_create"
+    # p.content_type_handler(:json, :failure).should be_nil
+    
+    # p = Merb::ResourceController::ActionDescriptor.new(:create, provided_formats)
+    # p.handle [ :xml, :json ], :success
+    # p.content_type_handler(:xml, :succes).should == "xml_response_on_successful_create"
+    # p.content_type_handler(:xml, :failure).should  be_nil
+    # p.content_type_handler(:json, :succes).should == "json_response_on_successful_create"
+    # p.content_type_handler(:json, :failure).should  be_nil
+    #     
+    # p = Merb::ResourceController::ActionDescriptor.new(:create, provided_formats)
+    # p.handle [ :xml, :json ]
+    # p.content_type_handler(:xml, :succes).should  == "xml_response_on_successful_create"
+    # p.content_type_handler(:xml, :failure).should  == "xml_response_on_failed_create"
+    # p.content_type_handler(:json, :succes).should == "json_response_on_successful_create"
+    # p.content_type_handler(:json, :failure).should == "json_response_on_failed_create"
+  end
+  
+end

data/spec/mrc_test_app/spec/lib/resource_proxy_spec.rb

@@ -31,7 +31,7 @@ describe "Merb::ResourceController::ResourceProxy" do
   describe "with default options" do
     
     before(:each) do
-      options = { :defaults => true, :flash => true, :use => :all }
+      options = { :defaults => true, :use => :all }
       @p = Merb::ResourceController::ResourceProxy.new(:articles, options)
     end
     
@@ -53,7 +53,7 @@ describe "Merb::ResourceController::ResourceProxy" do
     
     it "should have the default actions registered" do
       default_actions = [ :index, :show, :new, :edit, :create, :update, :destroy ]
-      actions = @p.registered_actions.map { |h| h[:name] }
+      actions = @p.registered_actions.map { |ad| ad.action_name }
       
       actions.size.should == default_actions.size
       actions.all? { |a| default_actions.include?(a) }.should be_true
@@ -77,14 +77,14 @@ describe "Merb::ResourceController::ResourceProxy" do
   describe "with invalid (parent) resource" do
 
     it "should raise NameError when initialized with an invalid resource" do
-      options = { :defaults => true, :flash => true, :use => :all }
+      options = { :defaults => true, :use => :all }
       lambda {
         Merb::ResourceController::ResourceProxy.new(:foo, options)
       }.should raise_error(NameError)
     end
     
     it "should raise NameError when it should belong to an invalid parent resource" do
-      options = { :defaults => true, :flash => true, :use => :all }
+      options = { :defaults => true, :use => :all }
       lambda {
         p = Merb::ResourceController::ResourceProxy.new("Community::Comment", options)
         p.belongs_to :foo
@@ -97,7 +97,7 @@ describe "Merb::ResourceController::ResourceProxy" do
   describe "with no parent resource" do
     
     before(:each) do
-      options = { :defaults => true, :flash => true, :use => :all }
+      options = { :defaults => true, :use => :all }
       @p = Merb::ResourceController::ResourceProxy.new(:articles, options)
     end
     
@@ -146,7 +146,7 @@ describe "Merb::ResourceController::ResourceProxy" do
   describe "with a single parent resource" do
     
     before(:each) do
-      options = { :defaults => true, :flash => true, :use => :all }
+      options = { :defaults => true, :use => :all }
       @p = Merb::ResourceController::ResourceProxy.new("Community::Comment", options)
       @p.belongs_to :article
     end
@@ -208,7 +208,7 @@ describe "Merb::ResourceController::ResourceProxy" do
   describe "with multiple parent resources with default keys" do
     
     before(:each) do
-      options = { :defaults => true, :flash => true, :use => :all }
+      options = { :defaults => true, :use => :all }
       @p = Merb::ResourceController::ResourceProxy.new("Community::Rating", options)
       @p.belongs_to [ :article, "Community::Comment" ]
     end