responders 0.1 → 0.2

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
+== 0.2
+
+* Added Responders::FlashResponder.flash_keys and default to [ :notice, :alert ]
+* Added support to respond_with(@resource, :notice => "Yes!", :alert => "No!")
+
 == 0.1
 
 * Added FlashResponder
 * Added HttpCacheResponder
-* Added responders generators
+* Added responders generators

data/README.rdoc

@@ -1,18 +1,20 @@
 == Responders
 
-A set of responders to dry up your Rails 3 app:
+A set of responders modules to dry up your Rails 3 app:
 
 * FlashResponder - Sets the flash based on the controller action and resource status.
   For instance, if you do: respond_with(@post) on a POST request and the resource @post
   does not contain errors, it will automatically set the flash message to
   "Post was successfully created" as long as you configure your I18n file:
 
-	flash:
-	  actions:
-	    create:
-	      success: "{resource_name} was successfully created"
-		update:
-		  success: "{resource_name} was successfully updated"
+    flash:
+      actions:
+        create:
+          notice: "{resource_name} was successfully created"
+        update:
+          notice: "{resource_name} was successfully updated"
+        destroy:
+          alert: "{resource_name} could not be destroyed"
 
   In case the resource contains errors, you should use the failure key on I18n. This is
   useful to dry up flash messages from your controllers. If you need a specific message
@@ -21,12 +23,27 @@ A set of responders to dry up your Rails 3 app:
     flash:
       posts:
         create:
-          success: "Your post was created and will be published soon"
+          notice: "Your post was created and will be published soon"
+
+  This responder is activated in all non get requests. By default it will use the keys
+  :notice and :alert, but they can be changed as well:
+
+    Responders::FlashResponder.flash_keys = [ :success, :failure ]
 
 * HttpCacheResponder - Automatically adds Last-Modified headers to API requests. This
   allows clients to easily query the server if a resource changed and if the client tries
   to retrieve a resource that has not been modified, it returns not_modified status.
 
+== Configuring your own responder
+
+Responders only provides a set of modules, to use them, you have to create your own
+responder. This can be done in an initializer for example:
+
+  class AppResponder < ActionController::Responder
+    include Responders::FlashResponder
+    include Responders::HttpCacheResponder
+  end
+
 == Generator
 
 This gem also includes a responders controller generator, so your scaffold can be customized to use respond_with instead of default respond_to blocks just by configuring your environment:

data/lib/responders/flash_responder.rb

@@ -11,16 +11,17 @@ module Responders
   #   flash.cars.create.status
   #   flash.actions.create.status
   #
-  # The statuses can be :success (when the object can be created, updated
-  # or destroyed with success) or :failure (when the objecy cannot be created
+  # The statuses by default are :notice (when the object can be created, updated
+  # or destroyed with success) and :alert (when the objecy cannot be created
   # or updated).
   #
-  # The resource_name given is available as interpolation option, this means you can set:
+  # On I18n, the resource_name given is available as interpolation option,
+  # this means you can set:
   #
   #   flash:
   #     actions:
   #       create:
-  #         success: "Hooray! {{resource_name}} was successfully created!"
+  #         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
@@ -29,7 +30,7 @@ module Responders
   #   flash:
   #     cars:
   #       update:
-  #         success: "Hooray! You just tuned your {{car_brand}}!"
+  #         notice: "Hooray! You just tuned your {{car_brand}}!"
   #
   # Since :car_name is not available for interpolation by default, you have
   # to overwrite interpolation_options in your controller.
@@ -50,43 +51,83 @@ module Responders
   #   flash.cars.create.status
   #   flash.actions.create.status
   #
+  # == Options
+  #
+  # FlashResponder also accepts some options through respond_with API.
+  #
+  # * :flash - When set to false, no flash message is set.
+  #
+  #     respond_with(@user, :flash => true)
+  #
+  # * :notice - Supply the message to be set if the record has no errors.
+  # * :alert - Supply the message to be set if the record has errors.
+  #
+  #     respond_with(@user, :notice => "Hooray! Welcome!", :alert => "Woot! You failed.")
+  #
+  # == Configure status keys
+  #
+  # As said previously, FlashResponder by default use :notice and :alert
+  # keys. You can change that by setting the status_keys:
+  #
+  #   Responders::FlashResponder.flash_keys = [ :success, :failure ]
+  #
+  # However, the options :notice and :alert to respond_with are kept :notice
+  # and :alert.
+  #
   module FlashResponder
+    mattr_accessor :flash_keys
+    @@flash_keys = [ :notice, :alert ]
+
     def initialize(controller, resources, options={})
       super
-      @flash = options.delete(:flash)
+      @flash  = options.delete(:flash)
+      @notice = options.delete(:notice)
+      @alert  = options.delete(:alert)
     end
 
-    def navigation_behavior(error)
+    def to_html
       super
 
-      unless get? || @flash == false
-        status = has_errors? ? :failure : :success
-        return if controller.send(:flash)[status].present?
-
-        resource_name = if resource.class.respond_to?(:human_name)
-          resource.class.human_name
+      unless !respond_to?(:"to_#{format}") || get? || @flash == false
+        if has_errors?
+          controller.flash[:alert] ||= @alert if @alert
+          status = Responders::FlashResponder.flash_keys.last
         else
-          resource.class.name.underscore.humanize
+          controller.flash[:notice] ||= @notice if @notice
+          status = Responders::FlashResponder.flash_keys.first
         end
 
-        options = {
-          :default => flash_defaults_by_namespace(status),
-          :resource_name => resource_name,
-          :resource_sym  => resource_name.downcase
-        }
-
-        if controller.respond_to?(:interpolation_options, true)
-          options.merge!(controller.send(:interpolation_options))
-        end
+        return if controller.flash[status].present?
 
+        options = mount_i18n_options(status)
         message = ::I18n.t options[:default].shift, options
-        controller.send(:flash)[status] = message unless message.blank?
+        controller.flash[status] = message unless message.blank?
       end
     end
 
   protected
 
-    def flash_defaults_by_namespace(status)
+    def mount_i18n_options(status) #:nodoc:
+      resource_name = if resource.class.respond_to?(:human_name)
+        resource.class.human_name
+      else
+        resource.class.name.underscore.humanize
+      end
+
+      options = {
+        :default => flash_defaults_by_namespace(status),
+        :resource_name => resource_name,
+        :resource_sym  => resource_name.downcase
+      }
+
+      if controller.respond_to?(:interpolation_options, true)
+        options.merge!(controller.send(:interpolation_options))
+      end
+
+      options
+    end
+
+    def flash_defaults_by_namespace(status) #:nodoc:
       defaults = []
       slices   = controller.controller_path.split('/')
 

data/lib/responders/version.rb

@@ -1,3 +1,3 @@
 module Responders
-  VERSION = "0.1".freeze
+  VERSION = "0.2".freeze
 end

data/test/flash_responder_test.rb

@@ -27,6 +27,16 @@ class AddressesController < ApplicationController
   alias :update  :action
   alias :destroy :action
 
+  def with_block
+    respond_with(@resource) do |format|
+      format.html { render :text => "Success!" }
+    end
+  end
+
+  def another
+    respond_with(@resource, :notice => "Yes, notice this!", :alert => "Warning, warning!")
+  end
+
 protected
 
   def interpolation_options
@@ -48,6 +58,7 @@ class FlashResponderTest < ActionController::TestCase
   tests AddressesController
 
   def setup
+    Responders::FlashResponder.flash_keys = [ :success, :failure ]
     @controller.stubs(:polymorphic_url).returns("/")
   end
 
@@ -90,27 +101,45 @@ class FlashResponderTest < ActionController::TestCase
     post :create, :set_flash => true
     assert_equal "Flash is set", flash[:success]
   end
+
+  def test_sets_flash_message_even_if_block_is_given
+    post :with_block
+    assert_equal "Resource with block created with success", flash[:success]
+  end
+
+  def test_sets_message_based_on_notice_key
+    Responders::FlashResponder.flash_keys = [ :notice, :alert ]
+    post :another
+    assert_equal "Yes, notice this!", flash[:notice]
+  end
+
+  def test_sets_message_based_on_alert_key
+    Responders::FlashResponder.flash_keys = [ :notice, :alert ]
+    post :another, :fail => true
+    assert_equal "Warning, warning!", flash[:alert]
+  end
 end
 
 class NamespacedFlashResponderTest < ActionController::TestCase
   tests Admin::AddressesController
 
   def setup
+    Responders::FlashResponder.flash_keys = [ :notice, :alert ]
     @controller.stubs(:polymorphic_url).returns("/")
   end
 
   def test_sets_the_flash_message_based_on_the_current_controller
     put :update
-    assert_equal "Admin updated address with success", flash[:success]
+    assert_equal "Admin updated address with success", flash[:notice]
   end
 
   def test_sets_the_flash_message_based_on_namespace_actions
     post :create
-    assert_equal "Admin created address with success", flash[:success]
+    assert_equal "Admin created address with success", flash[:notice]
   end
 
   def test_fallbacks_to_non_namespaced_controller_flash_message
     delete :destroy
-    assert_equal "Successfully deleted the address at Ocean Avenue", flash[:success]
+    assert_equal "Successfully deleted the chosen address at Ocean Avenue", flash[:notice]
   end
 end

data/test/test_helper.rb

@@ -18,10 +18,10 @@ require 'mocha'
 ENV["RAILS_ENV"] = "test"
 RAILS_ROOT = "anywhere"
 
-require File.expand_path(File.dirname(__FILE__) + "/../../../rails/vendor/gems/environment")
+require File.expand_path(File.dirname(__FILE__) + "/../../rails/vendor/gems/environment")
 require 'active_support'
 require 'action_controller'
-require 'action_controller/testing/test_case'
+require 'action_controller/test_case'
 
 class ApplicationController < ActionController::Base
   respond_to :html, :xml

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: responders
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-04 00:00:00 -02:00
+date: 2009-12-22 00:00:00 +01:00
 default_executable: 
 dependencies: []