josevalim-inherited_resources 0.7.1 → 0.7.2

data/CHANGELOG

@@ -1,5 +1,13 @@
 # Version 0.7
 
+* Allow procs as default value in has scope to be able to use values from session, for example.
+* Allow blocks with arity 0 or -1 to be given as the redirect url:
+
+    def destroy
+      destroy!{ project_url(@project) }
+    end
+
+* Allow interpolation_options to be set in the application controller.
 * Added has_scope to controller (an interface for named_scopes).
 * Added polymorphic_belongs_to, optional_belongs_to and singleton_belongs_to
   as quick methods.

data/README

@@ -1,6 +1,6 @@
 Inherited Resources
 License: MIT
-Version: 0.7.1
+Version: 0.7.2
 
 You can also read this README in pretty html at the GitHub project Wiki page:
 
@@ -18,7 +18,7 @@ code by following fat models and skinny controllers convention.
 
 Inherited Resources is tested and compatible with Rails 2.2.x and Rails 2.3.x.
 
-keywords: resources, controller, singleton, belongs_to, polymorphic and I18n
+keywords: resources, controller, singleton, belongs_to, polymorphic, named_scope and I18n
 
 Installation
 ------------
@@ -135,7 +135,7 @@ and scopes (more about this below).
 
 InheritedResources also introduces another method called begin_of_association_chain.
 It's mostly used when you want to create resources based on the @current_user and
-you have urls like "account/projects". In such cases, so you have to do
+you have urls like "account/projects". In such cases, you have to do
 @current_user.projects.find or @current_user.projects.build in your actions.
 
 You can deal with it just doing:
@@ -175,13 +175,13 @@ That's why all methods have aliases. So this is equivalent:
      end
    end
 
-Even more, since most of the times when you change a :create, :update or :destroy
+Even more, since most of the times when you change a create, update or destroy
 action is because you want to to change to where it redirects, a shortcut is
 provided. So you can do:
 
    class ProjectsController < InheritedResources::Base
      def destroy
-       destroy!(root_url)
+       destroy!{ root_url }
      end
    end
 
@@ -225,7 +225,7 @@ Looks to verbose, right? We can actually do:
      end
    end
 
-Much better! So explaning everything: when you give a block which expects one
+Much better! So explaining 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
@@ -280,8 +280,15 @@ Then you will finally have:
 
    "Hooray! The project "Plataforma" was updated!"
 
-If your controller is namespaced, for example Admin::ProjectsController, the
-messages will be checked in the following order:
+By default, resource name is capitalized. If you want to make it lower case, you
+can add to your application controller:
+
+   def interpolation_options
+     { :resource_name => resource_class.human_name.downcase }
+  end
+
+Finally, if your controller is namespaced, for example Admin::ProjectsController,
+the messages will be checked in the following order:
 
    flash.admin.projects.create.notice
    flash.admin.actions.create.notice
@@ -302,7 +309,7 @@ it also is named_scope fluent. Let's suppose our Project model with the scopes:
 
 Your controller:
 
-  class GraduationsController < InheritedResources::Base
+  class ProjectsController < InheritedResources::Base
     has_scope :featured, :boolean => true, :only => :index
     has_scope :by_methodology
     has_scope :limit, :default => 10
@@ -324,6 +331,11 @@ In the last case, it would return:
 
   { :featured => "true", :by_methodology => "agile", :limit => "20" }
 
+Finally, let's suppose you store on the session how many projects the user sees
+per page. In such cases, you can give a proc as default value:
+
+   has_scope :limit, :default => proc{|c| c.session[:limit] || 10 }
+
 Belongs to
 ----------
 

data/lib/inherited_resources/base.rb

@@ -67,23 +67,23 @@ module InheritedResources
       alias :edit! :edit
 
       # POST /resources
-      def create(redirect_to=nil, &block)
+      def create(redirect_url=nil, &block)
         object = build_resource(params[resource_instance_name])
+        respond_block, redirect_block = select_block_by_arity(block)
 
         if object.save
           set_flash_message!(:notice, '{{resource_name}} was successfully created.')
-
           options = { :with => object, :status => :created, :location => (resource_url rescue nil) }
 
-          respond_to_with_dual_blocks(true, block, options) do |format|
-            format.html { redirect_to(redirect_to || resource_url) }
+          respond_to_with_dual_blocks(true, respond_block, options) do |format|
+            format.html { redirect_to parse_redirect_url(redirect_url, :resource_url, redirect_block) }
           end
         else
           set_flash_message!(:error)
 
           options = { :with => object.errors, :status => :unprocessable_entity }
 
-          respond_to_with_dual_blocks(false, block, options) do |format|
+          respond_to_with_dual_blocks(false, respond_block, options) do |format|
             format.html { render :action => 'new' }
           end
         end
@@ -91,14 +91,15 @@ module InheritedResources
       alias :create! :create
 
       # PUT /resources/1
-      def update(redirect_to=nil, &block)
+      def update(redirect_url=nil, &block)
         object = resource
+        respond_block, redirect_block = select_block_by_arity(block)
 
         if object.update_attributes(params[resource_instance_name])
           set_flash_message!(:notice, '{{resource_name}} was successfully updated.')
 
           respond_to_with_dual_blocks(true, block) do |format|
-            format.html { redirect_to(redirect_to || resource_url) }
+            format.html { redirect_to parse_redirect_url(redirect_url, :resource_url, redirect_block) }
             format.all  { head :ok }
           end
         else
@@ -114,13 +115,14 @@ module InheritedResources
       alias :update! :update
 
       # DELETE /resources/1
-      def destroy(redirect_to=nil, &block)
+      def destroy(redirect_url=nil, &block)
         resource.destroy
+        respond_block, redirect_block = select_block_by_arity(block)
 
         set_flash_message!(:notice, '{{resource_name}} was successfully destroyed.')
 
-        respond_to_with_dual_blocks(nil, block) do |format|
-          format.html { redirect_to(redirect_to || collection_url) }
+        respond_to_with_dual_blocks(nil, respond_block) do |format|
+          format.html { redirect_to parse_redirect_url(redirect_url, :collection_url, redirect_block) }
           format.all  { head :ok }
         end
       end

data/lib/inherited_resources/base_helpers.rb

@@ -82,12 +82,9 @@ module InheritedResources
       # Overwrite this method to provide other interpolation options when
       # the flash message is going to be set.
       #
-      # You cannot overwrite :resource_name and :default options using this
-      # method. Check <tt>set_flash_message!</tt> for more information.
-      #
-      def interpolation_options
-        { }
-      end
+      # def interpolation_options
+      #    { }
+      # end
 
     private
 
@@ -216,13 +213,29 @@ module InheritedResources
       #   flash.cars.create.status
       #   flash.actions.create.status
       #
-      def set_flash_message!(status, default_message = '')
+      def set_flash_message!(status, default_message=nil)
         return flash[status] = default_message unless defined?(::I18n)
 
+        resource_name = if resource_class
+          if resource_class.respond_to?(:human_name)
+            resource_class.human_name
+          else
+            resource_class.name.humanize
+          end
+        else
+          "Resource"
+        end
+
+        given_options = if self.respond_to?(:interpolation_options)
+          interpolation_options
+        else
+          {}
+        end
+
         options = {
           :default  => default_message || '',
-          :resource_name => resource_class ? resource_class.human_name : 'Resource',
-        }.merge(interpolation_options)
+          :resource_name => resource_name
+        }.merge(given_options)
 
         defaults = []
         slices   = controller_path.split('/')
@@ -284,5 +297,36 @@ module InheritedResources
         []
       end
 
+      # If block is not nil, call it and uses the result as redirect to url.
+      # Otherwise, send the default url as message.
+      #
+      def parse_redirect_url(redirect_url, default_url, block) #:nodoc:
+        if redirect_url
+          ActiveSupport::Deprecation.warn "#{action_name}!(redirect_url) is deprecated. " << 
+                                          "Use #{action_name}!{ redirect_url } instead."
+          return redirect_url
+        end
+
+        block ? block.call : send(default_url)
+      end
+
+      # Holds InheritedResources block structure. It returns two blocks: the first
+      # is used in respond_to blocks and the second is the redirect_to url.
+      #
+      def select_block_by_arity(block) #:nodoc
+        if block
+          case block.arity
+            when 2, 1
+              [block, nil]
+            when 0, -1
+              [nil, block]
+            else
+              raise ScriptError, "InheritedResources does not know how to handle blocks with arity #{block.arity}"
+          end
+        else
+          [nil, nil]
+        end
+      end
+
   end
 end

data/lib/inherited_resources/has_scope_helpers.rb

@@ -23,6 +23,7 @@ module InheritedResources
             value, call_scope = params[key], true
           elsif options.key?(:default)
             value, call_scope = options[:default], true
+            value = value.call(self) if value.is_a?(Proc)
           end
 
           if call_scope

data/test/has_scope_test.rb

@@ -7,8 +7,9 @@ end
 class TreesController < InheritedResources::Base
   has_scope :color
   has_scope :only_tall, :boolean => true, :only => :index
-  has_scope :shadown_range, :default => 10, :except => [ :index, :show, :destroy ]
+  has_scope :shadown_range, :default => 10, :except => [ :index, :show, :destroy, :new ]
   has_scope :root_type, :key => :root
+  has_scope :calculate_height, :default => proc {|c| c.session[:height] || 20 }, :only => :new
 end
 
 class HasScopeTest < ActionController::TestCase
@@ -92,6 +93,15 @@ class HasScopeTest < ActionController::TestCase
     assert_equal({ :root => 'outside' }, assigns(:current_scopes))
   end
 
+  def test_scope_with_default_value_as_proc
+    session[:height] = 100
+    Tree.expects(:calculate_height).with(100).returns(Tree).in_sequence
+    Tree.expects(:new).returns(mock_tree).in_sequence
+    get :new
+    assert_equal(mock_tree, assigns(:tree))
+    assert_equal({ :calculate_height => 100 }, assigns(:current_scopes))
+   end
+
   protected
 
     def mock_tree(stubs={})

data/test/redirect_to_test.rb

@@ -1,11 +1,11 @@
 require File.dirname(__FILE__) + '/test_helper'
 
-class Machine;
+class SuperMachine;
   def self.human_name; 'Machine'; end
 end
 
-class MachinesController < InheritedResources::Base
-
+# Use this to test blocks with multiple arity in the future.
+class SuperMachinesController < InheritedResources::Base
   def create
     create!('http://test.host/')
   end
@@ -17,31 +17,87 @@ class MachinesController < InheritedResources::Base
   def destroy
     destroy!('http://test.host/')
   end
+end
+
+class RedirectToWithArgumentTest < ActionController::TestCase
+  tests SuperMachinesController
+
+  def test_redirect_to_the_given_url_on_create
+    ActiveSupport::Deprecation.expects(:warn).with('create!(redirect_url) is deprecated. Use create!{ redirect_url } instead.')
+    SuperMachine.stubs(:new).returns(mock_machine(:save => true))
+    @controller.expects(:resource_url).times(0)
+    post :create
+    assert_redirected_to 'http://test.host/'
+  end
+
+  def test_redirect_to_the_given_url_on_update
+    ActiveSupport::Deprecation.expects(:warn).with('update!(redirect_url) is deprecated. Use update!{ redirect_url } instead.')
+    SuperMachine.stubs(:find).returns(mock_machine(:update_attributes => true))
+    @controller.expects(:resource_url).times(0)
+    put :update
+    assert_redirected_to 'http://test.host/'
+  end
+
+  def test_redirect_to_the_given_url_on_destroy
+    ActiveSupport::Deprecation.expects(:warn).with('destroy!(redirect_url) is deprecated. Use destroy!{ redirect_url } instead.')
+    SuperMachine.stubs(:find).returns(mock_machine(:destroy => true))
+    @controller.expects(:collection_url).times(0)
+    delete :destroy
+    assert_redirected_to 'http://test.host/'
+  end
+
+  protected
+    def mock_machine(stubs={})
+      @mock_machine ||= mock(stubs)
+    end
+end
+
+class Machine;
+  def self.human_name; 'Machine'; end
+end
+
+class MachinesController < InheritedResources::Base
+
+  def create
+    create!{ complex_url(:create, true, true) }
+  end
+
+  def update
+    update!{ complex_url(:update, false, false) }
+  end
+
+  def destroy
+    destroy!{ complex_url(:destroy, true, false) }
+  end
 
+  protected
+    def complex_url(name, arg2, arg3)
+      'http://test.host/' + name.to_s
+    end
 end
 
-class RedirectToTest < ActionController::TestCase
+class RedirectToWithBlockTest < ActionController::TestCase
   tests MachinesController
 
   def test_redirect_to_the_given_url_on_create
     Machine.stubs(:new).returns(mock_machine(:save => true))
     @controller.expects(:resource_url).times(0)
     post :create
-    assert_redirected_to 'http://test.host/'
+    assert_redirected_to 'http://test.host/create'
   end
 
   def test_redirect_to_the_given_url_on_update
     Machine.stubs(:find).returns(mock_machine(:update_attributes => true))
     @controller.expects(:resource_url).times(0)
     put :update
-    assert_redirected_to 'http://test.host/'
+    assert_redirected_to 'http://test.host/update'
   end
 
   def test_redirect_to_the_given_url_on_destroy
     Machine.stubs(:find).returns(mock_machine(:destroy => true))
     @controller.expects(:collection_url).times(0)
-    put :destroy
-    assert_redirected_to 'http://test.host/'
+    delete :destroy
+    assert_redirected_to 'http://test.host/destroy'
   end
 
   protected

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-inherited_resources
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-26 00:00:00 -07:00
+date: 2009-04-28 00:00:00 -07:00
 default_executable: 
 dependencies: []