josevalim-inherited_resources 0.1.2 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,12 @@
+# Version 0.2.0
+
+* Added support success/failure blocks.
+* Eager loading of files to work properly in multithreaded environments.
+
+# Version 0.1.2
+
+* Added more helper_methods.
+
 # Version 0.1.1
 
 * Added Rails 2.3.0 and changed tests to work with ActionController::TestCase.

data/README

@@ -1,6 +1,6 @@
 Inherited Resources
 License: MIT
-Version: 0.1.1
+Version: 0.2.0
 
 You can also read this README in pretty html at the GitHub project Wiki page:
 
@@ -141,8 +141,9 @@ twin brother: begin_of_association_chain.
 It's mostly used when you want to create resources based on the @current_user.
 In such cases, you don't have your @current_user in the url, but in the session.
 
-So if you have to do: @current_user.projects.find or @current_user.projects.build
-you can deal with both just doing:
+This is usually when you have urls like "account/projects" and you have to do
+@current_user.projects.find or @current_user.projects.build in your actions.
+You can deal with it just doing:
 
    class ProjectsController < InheritedResources::Base
      protected
@@ -195,6 +196,39 @@ Yeap, that simple! The nice part is since you already set the instance variable
 @project, it will not do it again and overwrite your @project with something
 special. :)
 
+Before we finish this topic, we should talk about one more thing: "success/failure
+blocks". Let's suppose that when we update our project, in case of failure, we
+want to redirect to the project url instead of re-rendering the edit template.
+
+Our first attempt to do this would be:
+
+   class ProjectsController < InheritedResources::Base
+     def update
+       update! do |format|
+         unless @project.errors.empty? # failure
+           format.html { redirect_to project_url(@project) }
+         end
+       end
+     end
+   end
+
+Looks to verbose, right? (Maybe it reminds you of something! :P)
+But this is Ruby and we can actually do:
+
+   class ProjectsController < InheritedResources::Base
+     def update
+       update! do |success, failure|
+         failure.html { redirect_to project_url(@project) }
+       end
+     end
+   end
+
+Much better! So explaning everything: when you give a block which expects one
+argument it will be executed in both scenarios: success and failure. But If you
+give a block that expects two arguments, the first will be executed only in
+success scenarios and the second in failure scenarios. You keep everything
+clean and organized inside the same action.
+
 Flash messages and I18n
 -----------------------
 

data/lib/inherited_resources/base.rb

@@ -157,7 +157,18 @@
 #
 # Further customizations can be done replacing some methods. Check
 # base_helpers.rb file for more information.
-#
+
+# Let's require all needed files here. We are still on time to eager load
+# everything on multithreaded environments.
+require File.dirname(__FILE__) + '/base_helpers.rb'
+require File.dirname(__FILE__) + '/belongs_to.rb'
+require File.dirname(__FILE__) + '/belongs_to_helpers.rb'
+require File.dirname(__FILE__) + '/class_methods.rb'
+require File.dirname(__FILE__) + '/dumb_responder.rb'
+require File.dirname(__FILE__) + '/polymorphic_helpers.rb'
+require File.dirname(__FILE__) + '/singleton_helpers.rb'
+require File.dirname(__FILE__) + '/url_helpers.rb'
+
 module InheritedResources
   RESOURCES_ACTIONS = [ :index, :show, :new, :edit, :create, :update, :destroy ]
 
@@ -217,14 +228,14 @@ module InheritedResources
           set_flash_message!(:notice, '{{resource}} was successfully created.')
 
           respond_to(:with => object, :status => :created, :location => resource_url) do |format|
-            yield(format) if block_given?
+            block.call args_for_block(block, format, true) if block_given?
             format.html { redirect_to(resource_url) }
           end
         else
           set_flash_message!(:error)
 
           respond_to(:with => object.errors, :status => :unprocessable_entity) do |format|
-            yield(format) if block_given?
+            block.call args_for_block(block, format, false) if block_given?
             format.html { render :action => "new" }
           end
         end
@@ -239,7 +250,7 @@ module InheritedResources
           set_flash_message!(:notice, '{{resource}} was successfully updated.')
 
           respond_to do |format|
-            yield(format) if block_given?
+            block.call args_for_block(block, format, true) if block_given?
             format.html { redirect_to(resource_url) }
             format.all  { head :ok }
           end
@@ -247,7 +258,7 @@ module InheritedResources
           set_flash_message!(:error)
 
           respond_to(:with => object.errors, :status => :unprocessable_entity) do |format|
-            yield(format) if block_given?
+            block.call args_for_block(block, format, false) if block_given?
             format.html { render :action => "edit" }
           end
         end
@@ -255,7 +266,7 @@ module InheritedResources
       alias :update! :update
 
       # DELETE /resources/1
-      def destroy(&block)
+      def destroy
         resource.destroy
 
         set_flash_message!(:notice, '{{resource}} was successfully destroyed.')

data/lib/inherited_resources/base_helpers.rb

@@ -195,5 +195,26 @@ module InheritedResources #:nodoc:
         { }
       end
 
+      # Used to allow to specify success and failure within just one block:
+      #
+      #   def create
+      #     create! do |success, failure|
+      #       failure.html { redirect_to root_url }
+      #     end
+      #   end
+      #
+      def args_for_block(block_to_check_args, format, success = true)
+        if block_to_check_args.arity == 2
+          dumb_responder = InheritedResources::DumbResponder.new
+          if success
+            return format, dumb_responder
+          else
+            return dumb_responder, format
+          end
+        else
+          return format
+        end
+      end
+
   end
 end

data/lib/inherited_resources/dumb_responder.rb

@@ -0,0 +1,19 @@
+# = Dumb Responder
+#
+# This responder discards all messages sent to him.
+#
+module InheritedResources #:nodoc:
+  class DumbResponder #:nodoc:
+
+    instance_methods.each do |m|
+      undef_method m unless m =~ /^__/
+    end
+
+    # This is like a good husband, he will just listen everything that his wife
+    # says (which is a lot) without complaining. :)
+    def method_missing(*args)
+      return true
+    end
+
+  end
+end

data/test/aliases_test.rb

@@ -2,7 +2,9 @@
 # methods works properly.
 require File.dirname(__FILE__) + '/test_helper'
 
-class Student; end
+class Student;
+  def self.human_name; 'Student'; end
+end
 
 class StudentsController < InheritedResources::Base
 
@@ -17,6 +19,25 @@ class StudentsController < InheritedResources::Base
     new!
   end
 
+  def create
+    create! do |success, failure|
+      success.html { render :text => "I won't redirect!" }
+    end
+  end
+
+  def update
+    update! do |success, failure|
+      success.html { redirect_to(resource_url) }
+      failure.html { render :text => "I won't render!" }
+    end
+  end
+
+  def destroy
+    destroy! do |format|
+      format.html { render :text => "Destroyed!" }
+    end
+  end
+
 end
 
 class AliasesBaseTest < TEST_CLASS
@@ -41,7 +62,7 @@ class AliasesBaseTest < TEST_CLASS
     assert_equal 'New HTML', @response.body.strip
   end
 
-  def test_expose_the_resquested_user
+  def test_expose_the_resquested_user_on_edit
     Student.expects(:find).with('42').returns(mock_student)
     get :edit, :id => '42'
     assert_equal mock_student, assigns(:student)
@@ -63,6 +84,42 @@ class AliasesBaseTest < TEST_CLASS
     assert_equal 'Render XML', @response.body
   end
 
+  def test_is_not_redirected_on_create_with_success_if_success_block_is_given
+    Student.stubs(:new).returns(mock_student(:save => true))
+    @controller.stubs(:resource_url).returns('http://test.host/')
+    post :create
+    assert_response :success
+    assert_equal "I won't redirect!", @response.body
+  end
+
+  def test_dumb_responder_with_quietly_receive_everything_on_failure
+    Student.stubs(:new).returns(mock_student(:save => false, :errors => []))
+    @controller.stubs(:resource_url).returns('http://test.host/')
+    post :create
+    assert_response :success
+    assert_template :edit
+  end
+
+  def test_wont_render_edit_template_on_update_with_failure_if_failure_block_is_given
+    Student.stubs(:find).returns(mock_student(:update_attributes => false, :errors => []))
+    put :update
+    assert_response :success
+    assert_equal "I won't render!", @response.body
+  end
+
+  def test_dumb_responder_with_quietly_receive_everything_on_success
+    Student.stubs(:find).returns(mock_student(:update_attributes => true))
+    put :update, :id => '42', :student => {:these => 'params'}
+    assert_equal mock_student, assigns(:student)
+  end
+
+  def test_block_is_called_when_student_is_destroyed
+    Student.stubs(:find).returns(mock_student(:destroy => true))
+    delete :destroy
+    assert_response :success
+    assert_equal "Destroyed!", @response.body
+  end
+
   protected
     def mock_student(stubs={})
       @mock_student ||= mock(stubs)

data/test/test_helper.rb

@@ -26,13 +26,6 @@ require File.dirname(__FILE__) + '/../lib/inherited_resources/respond_to.rb'
 class ApplicationController < ActionController::Base; end
 
 # Load InheritedResources::Base after defining ApplicationController
-require File.dirname(__FILE__) + '/../lib/inherited_resources/base_helpers.rb'
-require File.dirname(__FILE__) + '/../lib/inherited_resources/belongs_to.rb'
-require File.dirname(__FILE__) + '/../lib/inherited_resources/belongs_to_helpers.rb'
-require File.dirname(__FILE__) + '/../lib/inherited_resources/class_methods.rb'
-require File.dirname(__FILE__) + '/../lib/inherited_resources/polymorphic_helpers.rb'
-require File.dirname(__FILE__) + '/../lib/inherited_resources/singleton_helpers.rb'
-require File.dirname(__FILE__) + '/../lib/inherited_resources/url_helpers.rb'
 require File.dirname(__FILE__) + '/../lib/inherited_resources/base.rb'
 
 # Define view_paths

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-inherited_resources
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-04 00:00:00 -08:00
+date: 2009-02-06 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -33,6 +33,7 @@ files:
 - lib/inherited_resources/belongs_to.rb
 - lib/inherited_resources/belongs_to_helpers.rb
 - lib/inherited_resources/class_methods.rb
+- lib/inherited_resources/dumb_responder.rb
 - lib/inherited_resources/polymorphic_helpers.rb
 - lib/inherited_resources/respond_to.rb
 - lib/inherited_resources/singleton_helpers.rb