responders 0.5.5 → 0.6.0

data/README.rdoc

@@ -46,7 +46,7 @@ to be used with Rails 2.3 together with Inherited Resources, please check this b
 
 The first step is instal responders gem and configure it in your application:
 
-  sudo gem install responders
+  gem install responders
 
 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:
@@ -60,6 +60,14 @@ Or, for your convenience, just do:
 
   rails generate responders_install
 
+== Controller method
+
+This gem also includes the controller method 'responders', which allows you to cherry-pick which responders you want included in your controller.
+
+  class InvitationsController < ApplicationController
+    responders :flash, :http_cache
+  end
+
 == Generator
 
 This gem also includes a responders controller generator, so your scaffold can be customized
@@ -72,4 +80,4 @@ If you discover any bugs or want to drop a line, feel free to create an issue on
 
 http://github.com/plataformatec/responders/issues
 
-MIT License. Copyright 2009 Plataforma Tecnologia. http://blog.plataformatec.com.br
+MIT License. Copyright 2010 Plataforma Tecnologia. http://blog.plataformatec.com.br

data/Rakefile

@@ -29,7 +29,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name = "responders"
-    s.version = Responders::VERSION
+    s.version = Responders::VERSION.dup
     s.summary = "A set of Rails 3 responders to dry up your application"
     s.email = "contact@plataformatec.com.br"
     s.homepage = "http://github.com/plataformatec/responders"

data/lib/generators/rails/responders_controller_generator.rb

@@ -1,4 +1,4 @@
-require 'generators/rails/scaffold_controller/scaffold_controller_generator'
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
 
 module Rails
   module Generators

data/lib/responders/controller_method.rb

@@ -0,0 +1,35 @@
+module Responders
+  module ControllerMethod
+    # Adds the given responders to the current controller's responder, allowing you to cherry-pick
+    # which responders you want per controller.
+    # 
+    #   class InvitationsController < ApplicationController
+    #     responders :flash, :http_cache
+    #   end
+    #
+    # Takes symbols and strings and translates them to VariableResponder (eg. :flash becomes FlashResponder).
+    # Also allows passing in the responders modules in directly, so you could do:
+    #
+    #    responders FlashResponder, HttpCacheResponder
+    #
+    # Or a mix of both methods:
+    #
+    #    responders :flash, MyCustomResponder
+    #
+    def responders(*responders)
+      self.responder = responders.inject(Class.new(responder)) do |klass, responder|
+        responder = case responder
+          when Module
+            responder
+          when String, Symbol
+            "#{responder.to_s.classify}Responder".constantize
+          else
+            raise "responder has to be a string, a symbol or a module"
+          end
+        
+        klass.send(:include, responder)
+        klass
+      end
+    end
+  end
+end

data/lib/responders/flash_responder.rb

@@ -93,6 +93,11 @@ module Responders
       super
     end
 
+    def to_js
+      set_flash_message! if set_flash_message?
+      to_format
+    end
+
   protected
 
     def set_flash_message!
@@ -119,7 +124,7 @@ module Responders
     end
 
     def set_flash_now?
-      (@flash_now == true) || (has_errors? ? @flash_now == :on_failure : @flash_now == :on_success)
+      (@flash_now == true) || (has_errors? ? @flash_now == :on_failure : @flash_now == :on_success) || (format == :js)
     end
 
     def set_flash_message? #:nodoc:

data/lib/responders/version.rb

@@ -1,3 +1,3 @@
 module Responders
-  VERSION = "0.5.5".freeze
+  VERSION = "0.6.0".freeze
 end

data/lib/responders.rb

@@ -1,19 +1,23 @@
+require 'action_controller/base'
+
 module Responders
   autoload :FlashResponder,     'responders/flash_responder'
   autoload :HttpCacheResponder, 'responders/http_cache_responder'
 
-  class Railtie < ::Rails::Railtie
-    railtie_name :responders
+  require 'responders/controller_method'
+  ActionController::Base.extend Responders::ControllerMethod
 
+  class Railtie < ::Rails::Railtie
+    config.responders = ActiveSupport::OrderedOptions.new
     config.generators.scaffold_controller = :responders_controller
 
     # Add load paths straight to I18n, so engines and application can overwrite it.
     require 'active_support/i18n'
     I18n.load_path << File.expand_path('../responders/locales/en.yml', __FILE__)
 
-    initializer "responders.flash_responder" do
-      if config.responders.flash_keys
-        Responders::FlashResponder.flash_keys = config.responders.flash_keys 
+    initializer "responders.flash_responder" do |app|
+      if app.config.responders.flash_keys
+        Responders::FlashResponder.flash_keys = app.config.responders.flash_keys
       end
     end
   end

data/test/controller_method_test.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+ActionController::Base.extend Responders::ControllerMethod
+
+module FooResponder
+  def to_html
+    @resource << "foo"
+    super
+  end
+end
+
+module BarResponder
+  def to_html
+    @resource << "bar"
+    super
+  end
+end
+
+module BazResponder
+  def to_html
+    @resource << "baz"
+    super
+  end
+end
+
+class PeopleController < ApplicationController
+  responders :foo, BarResponder
+  
+  def index
+    @array = []
+    respond_with(@array) do |format|
+      format.html { render :text => "Success!" }
+    end
+  end
+end
+
+class SpecialPeopleController < PeopleController
+  responders :baz
+end
+
+class ControllerMethodTest < ActionController::TestCase
+  tests PeopleController
+
+  def setup
+    @controller.stubs(:polymorphic_url).returns("/")
+  end
+
+  def test_foo_responder_gets_added
+    get :index
+    assert assigns(:array).include? "foo"
+  end
+  
+  def test_bar_responder_gets_added
+    get :index
+    assert assigns(:array).include? "bar"
+  end
+end
+
+class ControllerMethodInheritanceTest < ActionController::TestCase
+  tests SpecialPeopleController
+  
+  def setup
+    @controller.stubs(:polymorphic_url).returns("/") 
+  end
+  
+  def test_responder_is_inherited
+    get :index
+    assert assigns(:array).include? "foo"
+    assert assigns(:array).include? "bar"
+    assert assigns(:array).include? "baz"
+  end
+end

data/test/flash_responder_test.rb

@@ -16,6 +16,7 @@ end
 class AddressesController < ApplicationController
   before_filter :set_resource
   self.responder = FlashResponder
+  respond_to :js, :only => :create
 
   def action
     options = params.slice(:flash, :flash_now)
@@ -107,6 +108,13 @@ class FlashResponderTest < ActionController::TestCase
     assert_equal "Resource with block created with success", flash[:success]
   end
 
+  def test_sets_now_flash_message_on_javascript_requests
+    @now = {}
+    @controller.flash.expects(:now).returns(@now)
+    post :create, :format => :js
+    assert_equal "Resource created with success", @now[:success]
+  end
+
   def test_sets_flash_message_can_be_set_to_now
     @now = {}
     @controller.flash.expects(:now).returns(@now)

data/test/test_helper.rb

@@ -1,5 +1,10 @@
 require 'rubygems'
 
+gem 'activesupport', '3.0.0.beta2'
+gem 'activemodel', '3.0.0.beta2'
+gem 'actionpack', '3.0.0.beta2'
+gem 'railties', '3.0.0.beta2'
+
 begin
   gem "test-unit"
 rescue LoadError
@@ -33,8 +38,8 @@ I18n.reload!
 
 ActionController::Base.view_paths = File.join(File.dirname(__FILE__), 'views')
 
-Responders::Router = ActionDispatch::Routing::RouteSet.new
-Responders::Router.draw do |map|
+Responders::Routes = ActionDispatch::Routing::RouteSet.new
+Responders::Routes.draw do |map|
   map.connect 'admin/:action', :controller => "admin/addresses"
   map.connect ':controller/:action/:id'
   map.connect ':controller/:action'
@@ -42,7 +47,7 @@ end
 
 class ActiveSupport::TestCase
   setup do
-    @router = Responders::Router
+    @routes = Responders::Routes
   end
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 5
-  version: 0.5.5
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-26 00:00:00 +01:00
+date: 2010-04-03 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,7 @@ files:
 - lib/generators/rails/templates/controller.rb
 - lib/generators/responders_install_generator.rb
 - lib/responders.rb
+- lib/responders/controller_method.rb
 - lib/responders/flash_responder.rb
 - lib/responders/http_cache_responder.rb
 - lib/responders/locales/en.yml
@@ -71,6 +72,7 @@ signing_key:
 specification_version: 3
 summary: A set of Rails 3 responders to dry up your application
 test_files: 
+- test/controller_method_test.rb
 - test/flash_responder_test.rb
 - test/http_cache_responder_test.rb
 - test/test_helper.rb