inherited_resources 0.9.5 → 1.0.6

data/CHANGELOG

@@ -1,7 +1,14 @@
-# Version 0.9.4
+# Version 1.0
 
-* DEPRECATION: Use :success and :failure as flash messages instead :notice and :error
+* responders was removed from InheritedResources core and is a dependency. To install it, please do:
 
+    sudo gem install responders
+
+* has_scope was removed from InheritedResources core and is now available as a standalone gem.
+  To install it, please do:
+
+    sudo gem install has_scope
+  
 # Version 0.9
 
 * Allow dual blocks in destroy;

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 José Valim
+Copyright (c) 2009 José Valim http://blog.plataformatec.com.br
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,8 +1,4 @@
-Inherited Resources
-License: MIT
-Version: 0.9.2
-
-== Description
+== Inherited Resources
 
 Inherited Resources speeds up development by making your controllers inherit
 all restful actions so you just have to focus on what is important. It makes
@@ -14,27 +10,60 @@ a screencast made by Fabio Akita about its features:
 
 http://akitaonrails.com/2009/09/01/screencast-real-thin-restful-controllers-with-inherited-resources
 
-Inherited Resources is tested and compatible with Rails 2.2.x and Rails 2.3.x.
-
-keywords: resources, controller, singleton, belongs_to, polymorphic, named_scope and I18n
+This Inherited Resources branch is tested and compatible with Rails 2.3.x.
 
 == Installation
 
-Install Inherited Resources is very easy. It is stored in GitHub, so just run
-the following:
+Inherited Resources is available as gem on Gemcutter, so just run the following:
 
-    gem sources -a http://gemcutter.org
-    sudo gem install inherited_resources
+    sudo gem install inherited_resources --version=1.0.3
 
 If you want it as plugin, just do:
 
     script/plugin install git://github.com/josevalim/inherited_resources.git
 
+=== HasScope
+
+Since Inherited Resources 1.0, has_scope is not part of its core anymore.
+However, if you are using has_scope in your application, Inherited Resources
+will handle all the required hooks automatically.
+
+has_scope gem is available at:
+
+  http://github.com/plataformatec/has_scope
+
+And can be installed as:
+
+  sudo gem install has_scope
+
+=== Responders
+
+Since Inherited Resources 1.0, responders are not part of its core anymore,
+but is set as Inherited Resources dependency and it's used by default by
+InheritedResources controllers. Be sure to check the documentation to see
+how it will change your application:
+
+  http://github.com/plataformatec/responders
+
+And it can be installed as:
+
+  sudo gem install responders
+
+Using responders will set the flash message to :notice and :alert. You can change
+that through the following configuration value:
+
+  InheritedResources.flash_keys = [ :success, :failure ]
+
 == Rspec known bug
 
-When used with integrate_views equals to false, rspec overwrites default_render,
-render and some other controller methods which makes Inherited Resources not work
-properly. In such cases, you have to set integrate_views to true.
+Rspec monkey patches a couple of controller methods in a way that Controller specs
+(with integrate views true or false) and Inherited Resources are not compatible.
+
+However, since your controllers inherit from InheritedResources::Base, they are
+already unit-tested in the plugin, so there is no need to test them again in Rspec.
+
+You should test things like url redirection and associations in your integration
+specs.
 
 == Basic Usage
 
@@ -45,7 +74,7 @@ To use Inherited Resources you just have to inherit (duh) it:
 
 And all actions are defined and working, check it! Your projects collection
 (in the index action) is still available in the instance variable @projects
-and your project resource (all other actions) is available as @ project.
+and your project resource (all other actions) is available as @project.
 
 The next step is to define which mime types this controller provides:
 
@@ -228,6 +257,21 @@ 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.
 
+== Success and failure scenarios on destroy
+
+The destroy action can also fail, this usually happens when you have a
+before_destroy callback in your model which returns false. However, in
+order to tell InheritedResources that it really failed, you need to add
+errors to your model. So your before_destroy callback on the model should
+be something like this:
+
+    def before_destroy
+      if cant_be_destroyed?
+        errors.add(:base, "not allowed")
+        false
+      end
+    end
+
 == Some DSL
 
 For those DSL lovers, InheritedResources won't leave you alone. You can overwrite
@@ -246,109 +290,6 @@ And then you can rewrite the last example as:
       end
     end
 
-== Flash messages and I18n
-
-Flash messages are powered by I18n api. It checks for messages in the following
-order:
-
-    flash.controller_name.action_name.status
-    flash.actions.action_name.status
-
-If none is available, a default message in english set. In a create action
-on projects controller, it will search for:
-
-    flash.projects.create.status
-    flash.actions.create.status
-
-The status can be :notice (when the object can be created, updated
-or destroyed with success) or :error (when the objecy cannot be created
-or updated).
-
-Those messages are interpolated by using the resource class human name, which 
-is also localized and it means you can set:
-
-    flash:
-      actions:
-        create:
-          notice: "Hooray! {{resource_name}} was successfully created!"
-
-It will replace {{resource_name}} by the human name of the resource class,
-which is "Project" in this case.
-
-But sometimes, flash messages are not that simple. Sometimes you want to say
-the title of the project while updating a project. Well, that's easy also:
-
-    flash:
-      projects:
-        update:
-          notice: "Hooray! The project "{{project_title}}" was updated!"
-
-Since :project_title is not available for interpolation by default, you have
-to overwrite interpolation_options.
-
-    def interpolation_options
-      { :project_title => @project.title }
-    end
-
-Then you will finally have:
-
-    "Hooray! The project "Plataforma" was updated!"
-
-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
-    flash.projects.create.notice
-    flash.actions.create.notice
-
-== Has Scope
-
-InheritedResources tries to integrate nicely with your model. In order to do so,
-it also is named_scope fluent. Let's suppose our Project model with the scopes:
-
-    class Project < ActiveRecord::Base
-      named_scope :featured, :conditions => { :featured => true }
-      named_scope :by_methodology, proc {|methodology| { :conditions => { :methodology => methodology } } }
-      named_scope :limit, proc{|limit| :limit => limit.to_i }
-    end
-
-Your controller:
-
-    class ProjectsController < InheritedResources::Base
-      has_scope :featured, :boolean => true, :only => :index
-      has_scope :by_methodology
-      has_scope :limit, :default => 10
-    end
-
-Then for each request:
-
-    /projects
-    #=> acts like a normal request, but returning 10 projects
-
-    /projects?featured=true
-    #=> calls the featured named scope and bring 10 featured projects
-
-    /projects?featured=true&by_methodology=agile&limit=20
-    #=> brings 20 featured projects with methodology agile
-
-You can retrieve the current scopes in use with :current_scopes method.
-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
 
 Finally, our Projects are going to get some Tasks. Then you create a
@@ -522,3 +463,4 @@ If you discover any bugs or want to drop a line, join us in the mailing list:
 http://groups.google.com/group/inherited_resources
 
 Copyright (c) 2009 José Valim http://blog.plataformatec.com.br
+See the attached MIT License.

data/Rakefile

@@ -16,7 +16,9 @@ begin
     s.homepage = "http://github.com/josevalim/inherited_resources"
     s.description = "Inherited Resources speeds up development by making your controllers inherit all restful actions so you just have to focus on what is important."
     s.authors = ['José Valim']
-    s.files =  FileList["[A-Z]*", "{lib}/**/*"]
+    s.files =  FileList["[A-Z]*", "rails/init.rb", "{lib}/**/*"]
+    s.add_dependency("responders", "~> 0.4.6")
+    s.add_dependency("has_scope",  "~> 0.5.0")
   end
 
   Jeweler::GemcutterTasks.new

data/lib/inherited_resources/actions.rb

@@ -3,26 +3,26 @@ module InheritedResources
   module Actions
 
     # GET /resources
-    def index(&block)
-      respond_with(collection, &block)
+    def index(options={}, &block)
+      respond_with(*(with_chain(collection) << options), &block)
     end
     alias :index! :index
 
     # GET /resources/1
-    def show(&block)
-      respond_with(resource, &block)
+    def show(options={}, &block)
+      respond_with(*(with_chain(resource) << options), &block)
     end
     alias :show! :show
 
     # GET /resources/new
-    def new(&block)
-      respond_with(build_resource, &block)
+    def new(options={}, &block)
+      respond_with(*(with_chain(build_resource) << options), &block)
     end
     alias :new! :new
 
     # GET /resources/1/edit
-    def edit(&block)
-      respond_with(resource, &block)
+    def edit(options={}, &block)
+      respond_with(*(with_chain(resource) << options), &block)
     end
     alias :edit! :edit
 
@@ -31,13 +31,10 @@ module InheritedResources
       object = build_resource
 
       if create_resource(object)
-        set_flash_message!(:notice, '{{resource_name}} was successfully created.')
         options[:location] ||= resource_url rescue nil
-        respond_with_dual_blocks(object, options, true, block)
-      else
-        set_flash_message!(:error)
-        respond_with_dual_blocks(object, options, false, block)
       end
+
+      respond_with_dual_blocks(object, options, &block)
     end
     alias :create! :create
 
@@ -46,13 +43,10 @@ module InheritedResources
       object = resource
 
       if update_resource(object, params[resource_instance_name])
-        set_flash_message!(:notice, '{{resource_name}} was successfully updated.')
         options[:location] ||= resource_url rescue nil
-        respond_with_dual_blocks(object, options, true, block)
-      else
-        set_flash_message!(:error)
-        respond_with_dual_blocks(object, options, false, block)
       end
+
+      respond_with_dual_blocks(object, options, &block)
     end
     alias :update! :update
 
@@ -61,19 +55,13 @@ module InheritedResources
       object = resource
       options[:location] ||= collection_url rescue nil
 
-      if destroy_resource(object)
-        set_flash_message!(:notice, '{{resource_name}} was successfully destroyed.')
-        respond_with_dual_blocks(object, options, true, block)
-      else
-        set_flash_message!(:error, '{{resource_name}} could not be destroyed.')
-        respond_with_dual_blocks(object, options, false, block)
-      end
+      destroy_resource(object)
+      respond_with_dual_blocks(object, options, &block)
     end
     alias :destroy! :destroy
 
     # Make aliases protected
     protected :index!, :show!, :new!, :create!, :edit!, :update!, :destroy!
-
   end
 end
 

data/lib/inherited_resources/base.rb

@@ -1,3 +1,6 @@
+require 'inherited_resources/blank_slate'
+require 'inherited_resources/responder'
+
 module InheritedResources
   # = Base
   #
@@ -22,6 +25,7 @@ module InheritedResources
 
         # Add at least :html mime type
         respond_to :html
+        self.responder = InheritedResources::Responder
 
         helper_method :collection_url, :collection_path, :resource_url, :resource_path,
                       :new_resource_url, :new_resource_path, :edit_resource_url, :edit_resource_path,
@@ -31,10 +35,10 @@ module InheritedResources
         base.with_options :instance_writer => false do |c|
           c.class_inheritable_accessor :resource_class
           c.class_inheritable_array :parents_symbols
-          c.class_inheritable_hash :resources_configuration, :scopes_configuration
+          c.class_inheritable_hash :resources_configuration
         end
 
-        protected :resource_class, :parents_symbols, :resources_configuration, :scopes_configuration
+        protected :resource_class, :parents_symbols, :resources_configuration
       end
     end
 

data/lib/inherited_resources/base_helpers.rb

@@ -1,5 +1,5 @@
 # Whenever base is required load the dumb responder since it's used inside actions.
-require File.dirname(__FILE__) + '/dumb_responder.rb'
+require 'inherited_resources/blank_slate'
 
 module InheritedResources
   # Base helpers for InheritedResource work. Some methods here can be overwriten
@@ -138,6 +138,11 @@ module InheritedResources
 
     private
 
+      # Adds the given object to association chain.
+      def with_chain(object)
+        association_chain + [ object ]
+      end
+
       # Fast accessor to resource_collection_name
       #
       def resource_collection_name #:nodoc:
@@ -156,7 +161,7 @@ module InheritedResources
       def end_of_association_chain #:nodoc:
         if chain = association_chain.last
           if method_for_association_chain
-            apply_scope_to(chain.send(method_for_association_chain))
+            apply_scopes_if_available(chain.send(method_for_association_chain))
           else
             # This only happens when we specify begin_of_association_chain in
             # a singletion controller without parents. In this case, the chain
@@ -165,7 +170,7 @@ module InheritedResources
             chain
           end
         else
-          apply_scope_to(resource_class)
+          apply_scopes_if_available(resource_class)
         end
       end
 
@@ -214,98 +219,6 @@ module InheritedResources
         instance_variable_set("@#{resource_collection_name}", collection)
       end
 
-      # Helper to set flash messages. It's powered by I18n API.
-      # It checks for messages in the following order:
-      #
-      #   flash.controller_name.action_name.status
-      #   flash.actions.action_name.status
-      #
-      # If none is available, a default message is set. So, if you have
-      # a CarsController, create action, it will check for:
-      #
-      #   flash.cars.create.status
-      #   flash.actions.create.status
-      #
-      # The statuses can be :notice (when the object can be created, updated
-      # or destroyed with success) or :error (when the objecy cannot be created
-      # or updated).
-      #
-      # Those messages are interpolated by using the resource class human name.
-      # This means you can set:
-      #
-      #   flash:
-      #     actions:
-      #       create:
-      #         notice: "Hooray! {{resource_name}} was successfully created!"
-      #
-      # But sometimes, flash messages are not that simple. Going back
-      # to cars example, you might want to say the brand of the car when it's
-      # updated. Well, that's easy also:
-      #
-      #   flash:
-      #     cars:
-      #       update:
-      #         notice: "Hooray! You just tuned your {{car_brand}}!"
-      #
-      # Since :car_name is not available for interpolation by default, you have
-      # to overwrite interpolation_options.
-      #
-      #   def interpolation_options
-      #     { :car_brand => @car.brand }
-      #   end
-      #
-      # Then you will finally have:
-      #
-      #   'Hooray! You just tuned your Aston Martin!'
-      #
-      # If your controller is namespaced, for example Admin::CarsController,
-      # the messages will be checked in the following order:
-      #
-      #   flash.admin.cars.create.status
-      #   flash.admin.actions.create.status
-      #   flash.cars.create.status
-      #   flash.actions.create.status
-      #
-      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.underscore.humanize
-          end
-        else
-          "Resource"
-        end
-
-        given_options = if self.respond_to?(:interpolation_options)
-          interpolation_options
-        else
-          {}
-        end
-
-        options = {
-          :default  => default_message || '',
-          :resource_name => resource_name
-        }.merge(given_options)
-
-        defaults = []
-        slices   = controller_path.split('/')
-
-        while slices.size > 0
-          defaults << :"flash.#{slices.fill(controller_name, -1).join('.')}.#{action_name}.#{status}"
-          defaults << :"flash.#{slices.fill(:actions, -1).join('.')}.#{action_name}.#{status}"
-          slices.shift
-        end
-
-        options[:default] = defaults.push(options[:default])
-        options[:default].flatten!
-
-        message = ::I18n.t options[:default].shift, options
-        flash[status] = message unless message.blank?
-      end
-
       # Used to allow to specify success and failure within just one block:
       #
       #   def create
@@ -317,38 +230,32 @@ module InheritedResources
       # It also calculates the response url in case a block without arity is
       # given and returns it. Otherwise returns nil.
       #
-      def respond_with_dual_blocks(object, options, success, given_block, &block) #:nodoc:
-        case given_block.try(:arity)
+      def respond_with_dual_blocks(object, options, &block) #:nodoc:
+        args = (with_chain(object) << options)
+
+        case block.try(:arity)
           when 2
-            respond_with(object, options) do |responder|
-              dumb_responder = InheritedResources::DumbResponder.new
-              if success
-                given_block.call(responder, dumb_responder)
+            respond_with(*args) do |responder|
+              blank_slate = InheritedResources::BlankSlate.new
+              if object.errors.empty?
+                block.call(responder, blank_slate)
               else
-                given_block.call(dumb_responder, responder)
+                block.call(blank_slate, responder)
               end
-              block.try(:call, responder)
             end
           when 1
-            if block
-              respond_with(object, options) do |responder|
-                given_block.call(responder)
-                block.call(responder)
-              end
-            else
-              respond_with(object, options, &given_block)
-            end
+            respond_with(*args, &block)
           else
-            options[:location] = given_block.call if given_block
-            respond_with(object, options, &block)
+            options[:location] = block.call if block
+            respond_with(*args)
         end
       end
 
       # Hook to apply scopes. By default returns only the target_object given.
       # It's extend by HasScopeHelpers.
       #
-      def apply_scope_to(target_object) #:nodoc:
-        target_object
+      def apply_scopes_if_available(target_object) #:nodoc:
+        respond_to?(:apply_scopes) ? apply_scopes(target_object) : target_object
       end
 
       # Symbols chain in base helpers return nothing. This is later overwriten

data/lib/inherited_resources/belongs_to_helpers.rb

@@ -56,6 +56,14 @@ module InheritedResources
       def parent?
         true
       end
+      
+      def parent
+        @parent ||= association_chain[-1]
+      end
+      
+      def parent_type
+        parent.class.name.underscore.to_sym
+      end
 
     private
 

data/lib/inherited_resources/blank_slate.rb

@@ -0,0 +1,12 @@
+module InheritedResources
+  # An object from BlankSlate simply discards all messages sent to it.
+  class BlankSlate
+    instance_methods.each do |m|
+      undef_method m unless m =~ /^(__|object_id)/
+    end
+
+    def method_missing(*args)
+      nil
+    end
+  end
+end