emmanuel-inherited_resources 0.9.1 → 0.9.2

data/CHANGELOG

@@ -1,3 +1,10 @@
+# Version 0.9
+
+* Added #association_chain and #context_chain to provide visibility into the
+  instances scoping the current resource/collection
+* Added several configuration hooks (#lood_collection, #load_resource,
+  #build_resource_instance, #translate_flash_lookup_defaults)
+
 # Version 0.8
 
 * Fixed a small bug on optional belongs to with namespaced controllers.

data/lib/inherited_resources/base_helpers.rb

@@ -9,44 +9,22 @@ module InheritedResources
 
     protected
 
-      # This is how the collection is loaded.
-      #
-      # You might want to overwrite this method if you want to add pagination
-      # for example. When you do that, don't forget to cache the result in an
-      # instance_variable:
-      #
-      #   def collection
-      #     @projects ||= end_of_association_chain.paginate(params[:page]).all
-      #   end
+      # If you overwrite this, don't forget to cache the result in an instance variable.
       #
       def collection
-        get_collection_ivar || set_collection_ivar(end_of_association_chain.find(:all))
+        get_collection_ivar || set_collection_ivar(load_collection)
       end
 
-      # This is how the resource is loaded.
-      #
-      # You might want to overwrite this method when you are using permalink.
-      # When you do that, don't forget to cache the result in an
-      # instance_variable:
-      #
-      #   def resource
-      #     @project ||= end_of_association_chain.find_by_permalink!(params[:id])
-      #   end
-      #
-      # You also might want to add the exclamation mark at the end of the method
-      # because it will raise a 404 if nothing can be found. Otherwise it will
-      # probably render a 500 error message.
+      # If you overwrite this, don't forget to cache the result in an instance variable.
       #
       def resource
-        get_resource_ivar || set_resource_ivar(end_of_association_chain.find(params[:id]))
+        get_resource_ivar || set_resource_ivar(load_resource)
       end
 
-      # This method is responsable for building the object on :new and :create
-      # methods. If you overwrite it, don't forget to cache the result in an
-      # instance variable.
+      # If you overwrite this, don't forget to cache the result in an instance variable.
       #
       def build_resource
-        get_resource_ivar || set_resource_ivar(end_of_association_chain.send(method_for_build, params[resource_instance_name] || {}))
+        get_resource_ivar || set_resource_ivar(build_resource_instance)
       end
 
       # This class allows you to set a instance variable to begin your
@@ -82,12 +60,12 @@ module InheritedResources
         false
       end
 
-      # Overwrite this method to provide other interpolation options when
-      # the flash message is going to be set.
+      # Overwrite this method to provide interpolation options for
+      # flash messages, and page titles
       #
-      # def interpolation_options
-      #    { }
-      # end
+      def interpolation_options
+         { }
+      end
 
     private
 
@@ -103,6 +81,18 @@ module InheritedResources
         self.resources_configuration[:self][:instance_name]
       end
 
+      def 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
+      end
+
       def context_chain
         @context_chain ||= begin
           chain = []
@@ -140,6 +130,41 @@ module InheritedResources
         end
       end
 
+      # This is how the collection is loaded.
+      #
+      # You might want to overwrite this method if you want to add pagination,
+      # for example:
+      #
+      #   def load_collection
+      #     end_of_association_chain.paginate(params[:page]).all
+      #   end
+      #
+      def load_collection
+        end_of_association_chain.find(:all)
+      end
+
+      # This is how the resource is loaded.
+      #
+      # You might want to overwrite this method when you are using permalink.
+      #
+      #   def load_resource
+      #     end_of_association_chain.find_by_permalink!(params[:id])
+      #   end
+      #
+      # You also might want to add the exclamation mark at the end of the method
+      # because it will raise a 404 if nothing can be found. Otherwise it will
+      # probably render a 500 error message.
+      #
+      def load_resource
+        end_of_association_chain.find(params[:id])
+      end
+
+      # This method is responsible for building the object on :new and :create methods.
+      #
+      def build_resource_instance
+        end_of_association_chain.send(method_for_build, params[resource_instance_name] || {})
+      end
+
       # Returns the appropriated method to build the resource.
       #
       def method_for_build #:nodoc:
@@ -240,37 +265,9 @@ module InheritedResources
       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_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 = { :resource_name => resource_name }.merge(interpolation_options)
+        options[:default] = translate_flash_lookup_defaults(status)
+        options[:default] << (default_message || '')
         options[:default].flatten!
 
         message = ::I18n.t options[:default].shift, options
@@ -315,6 +312,17 @@ module InheritedResources
         end
       end
 
+      # Hook to control flash message lookup strategy
+      def translate_flash_lookup_defaults(status, slices=controller_path.split('/'))
+        defaults = []
+        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
+        defaults
+      end
+
       # Hook to apply scopes. By default returns only the target_object given.
       # It's extend by HasScopeHelpers.
       #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: emmanuel-inherited_resources
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -42,6 +42,7 @@ files:
 - lib/inherited_resources/url_helpers.rb
 has_rdoc: true
 homepage: http://github.com/josevalim/inherited_resources
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -62,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: inherited_resources
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Inherited Resources speeds up development by making your controllers inherit all restful actions so you just have to focus on what is important.