responders 0.6.1 → 0.6.2

data/CHANGELOG.rdoc

@@ -2,7 +2,7 @@
 
 * :js now sets the flash.now by default, instead of flash
 * Renamed responders_install generator to responders:install
-* Added a fix for Rails 3.0.0.beta3
+* Added CollectionResponder which allows you to always redirect to the collection path (index action) after POST/PUT/DELETE
 
 == 0.5
 

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
-gem "rails", "3.0.0.beta3"
+gem "rails", :path => "../rails"
 gem "mocha"
 
 if RUBY_VERSION < "1.9"

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: /Users/jose/Work/github/rails
+  specs:
+    actionmailer (3.0.0.beta4)
+      actionpack (= 3.0.0.beta4)
+      mail (~> 2.2.5)
+    actionpack (3.0.0.beta4)
+      activemodel (= 3.0.0.beta4)
+      activesupport (= 3.0.0.beta4)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.9)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.22)
+    activemodel (3.0.0.beta4)
+      activesupport (= 3.0.0.beta4)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0.beta4)
+      activemodel (= 3.0.0.beta4)
+      activesupport (= 3.0.0.beta4)
+      arel (~> 0.4.0)
+      tzinfo (~> 0.3.22)
+    activeresource (3.0.0.beta4)
+      activemodel (= 3.0.0.beta4)
+      activesupport (= 3.0.0.beta4)
+    activesupport (3.0.0.beta4)
+    rails (3.0.0.beta4)
+      actionmailer (= 3.0.0.beta4)
+      actionpack (= 3.0.0.beta4)
+      activerecord (= 3.0.0.beta4)
+      activeresource (= 3.0.0.beta4)
+      activesupport (= 3.0.0.beta4)
+      bundler (>= 1.0.0.beta.10)
+      railties (= 3.0.0.beta4)
+    railties (3.0.0.beta4)
+      actionpack (= 3.0.0.beta4)
+      activesupport (= 3.0.0.beta4)
+      rake (>= 0.8.3)
+      thor (~> 0.14.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    arel (0.4.0)
+      activesupport (>= 3.0.0.beta)
+    builder (2.1.2)
+    columnize (0.3.1)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    linecache (0.43)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    mocha (0.9.8)
+      rake
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.9)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rake (0.8.7)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    thor (0.14.0)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.22)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  rails!
+  ruby-debug

data/README.rdoc

@@ -13,12 +13,12 @@ to be used with Rails 2.3 together with Inherited Resources, please check this b
     flash:
       actions:
         create:
-          notice: "{{resource_name}} was successfully created."
+          notice: "%{resource_name} was successfully created."
         update:
-          notice: "{{resource_name}} was successfully updated."
+          notice: "%{resource_name} was successfully updated."
         destroy:
-          notice: "{{resource_name}} was successfully destroyed."
-          alert: "{{resource_name}} could not be destroyed."
+          notice: "%{resource_name} was successfully destroyed."
+          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
@@ -42,6 +42,8 @@ to be used with Rails 2.3 together with Inherited Resources, please check this b
   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.
 
+* CollectionResponder - Makes your create and update action redirect to the collection on success.
+
 == Configuring your own responder
 
 The first step is instal responders gem and configure it in your application:
@@ -49,13 +51,24 @@ The first step is instal responders gem and configure it in your application:
   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:
+responder. This can be done inside the lib folder for example:
 
+  # lib/app_responder.rb
   class AppResponder < ActionController::Responder
     include Responders::FlashResponder
     include Responders::HttpCacheResponder
   end
 
+And then you need to configure your application to use it:
+
+  # app/controllers/application_controller.rb
+  require "app_responder"
+
+  class ApplicationController < ActionController::Base
+    self.responder = AppResponder
+    respond_to :html
+  end
+
 Or, for your convenience, just do:
 
   rails generate responders:install

data/lib/generators/rails/responders_controller_generator.rb

@@ -3,9 +3,7 @@ require 'rails/generators/rails/scaffold_controller/scaffold_controller_generato
 module Rails
   module Generators
     class RespondersControllerGenerator < ScaffoldControllerGenerator
-      def self.source_root
-        @_source_root ||= File.expand_path("templates", File.dirname(__FILE__))
-      end
+      source_root File.expand_path("../templates", __FILE__)
 
     protected
 

data/lib/generators/responders/install_generator.rb

@@ -1,9 +1,7 @@
 module Responders
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      def self.source_root
-        @_source_root ||= File.expand_path("..", __FILE__)
-      end
+      source_root File.expand_path("..", __FILE__)
 
       desc "Creates an initializer with default responder configuration and copy locale file"
 
@@ -12,6 +10,10 @@ module Responders
 class ApplicationResponder < ActionController::Responder
   include Responders::FlashResponder
   include Responders::HttpCacheResponder
+
+  # Uncomment this responder if you want your resources to redirect to the collection
+  # path (index action) instead of the resource path for POST/PUT/DELETE requests.
+  # include Responders::CollectionResponder
 end
         RUBY
       end

data/lib/responders.rb

@@ -1,8 +1,9 @@
 require 'action_controller/base'
 
 module Responders
-  autoload :FlashResponder,     'responders/flash_responder'
-  autoload :HttpCacheResponder, 'responders/http_cache_responder'
+  autoload :FlashResponder,      'responders/flash_responder'
+  autoload :HttpCacheResponder,  'responders/http_cache_responder'
+  autoload :CollectionResponder, 'responders/collection_responder'
 
   require 'responders/controller_method'
 

data/lib/responders/collection_responder.rb

@@ -0,0 +1,30 @@
+module Responders
+  # This responder modifies your current responder to redirect
+  # to the collection page on POST/PUT/DELETE.
+  module CollectionResponder
+    protected
+
+    # Returns the collection location for redirecting after POST/PUT/DELETE.
+    # This method, converts the following resources array to the following:
+    #
+    #   [:admin, @post] #=> [:admin, :posts]
+    #   [@user, @post]  #=> [@user, :posts]
+    #
+    # When these new arrays are given to redirect_to, it will generate the
+    # proper URL pointing to the index action.
+    #
+    #   [:admin, @post] #=> admin_posts_url
+    #   [@user, @post]  #=> user_posts_url(@user.to_param)
+    #
+    def navigation_location
+      return options[:location] if options[:location]
+      klass = resources.last.class
+
+      if klass.respond_to?(:model_name)
+        resources[0...-1] << klass.model_name.plural.to_sym
+      else
+        resources
+      end
+    end
+  end
+end

data/lib/responders/controller_method.rb

@@ -22,7 +22,7 @@ module Responders
           when Module
             responder
           when String, Symbol
-            "#{responder.to_s.classify}Responder".constantize
+            Responders.const_get("#{responder.to_s.classify}Responder")
           else
             raise "responder has to be a string, a symbol or a module"
           end
@@ -34,13 +34,4 @@ module Responders
   end
 end
 
-# Fix for Rails <= 3.0.0.beta3
-require "action_controller/metal/responder"
-
-class ActionController::Responder
-  def default_action
-    @action ||= ACTIONS_FOR_VERBS[request.request_method_symbol]
-  end
-end
-
 ActionController::Base.extend Responders::ControllerMethod

data/lib/responders/flash_responder.rb

@@ -21,7 +21,7 @@ module Responders
   #   flash:
   #     actions:
   #       create:
-  #         notice: "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
@@ -30,7 +30,7 @@ module Responders
   #   flash:
   #     cars:
   #       update:
-  #         notice: "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.

data/lib/responders/http_cache_responder.rb

@@ -23,8 +23,7 @@ module Responders
 
     def do_http_cache!
       timestamp = resources.flatten.map do |resource|
-        next unless resource.respond_to?(:updated_at)
-        resource.updated_at.utc
+        resource.updated_at.try(:utc) if resource.respond_to?(:updated_at)
       end.compact.max
 
       controller.response.last_modified ||= timestamp if timestamp

data/lib/responders/version.rb

@@ -1,3 +1,3 @@
 module Responders
-  VERSION = "0.6.1".freeze
+  VERSION = "0.6.2".freeze
 end

data/test/collection_responder_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+class CollectionResponder < ActionController::Responder
+  include Responders::CollectionResponder
+end
+
+class CollectionController < ApplicationController
+  self.responder = CollectionResponder
+
+  def single
+    respond_with Address.new
+  end
+
+  def namespaced
+    respond_with :admin, Address.new
+  end
+
+  def nested
+    respond_with User.new, Address.new
+  end
+
+  def only_symbols
+    respond_with :admin, :addresses
+  end
+
+  def with_location
+    respond_with Address.new, :location => "given_location"
+  end
+end
+
+class CollectionResponderTest < ActionController::TestCase
+  tests CollectionController
+
+  def test_collection_with_single_resource
+    @controller.expects(:addresses_url).returns("addresses_url")
+    post :single
+    assert_redirected_to "addresses_url"
+  end
+
+  def test_collection_with_namespaced_resource
+    @controller.expects(:admin_addresses_url).returns("admin_addresses_url")
+    put :namespaced
+    assert_redirected_to "admin_addresses_url"
+  end
+
+  def test_collection_with_nested_resource
+    @controller.expects(:user_addresses_url).returns("user_addresses_url")
+    delete :nested
+    assert_redirected_to "user_addresses_url"
+  end
+
+  def test_collection_respects_location_option
+    delete :with_location
+    assert_redirected_to "given_location"
+  end
+
+  def test_collection_respects_only_symbols
+    @controller.expects(:admin_addresses_url).returns("admin_addresses_url")
+    post :only_symbols
+    assert_redirected_to "admin_addresses_url"
+  end
+end

data/test/flash_responder_test.rb

@@ -1,14 +1,5 @@
 require 'test_helper'
 
-class Address
-  attr_accessor :errors
-  def self.human_name; 'Address'; end
-  
-  def initialize
-    @errors = {}
-  end
-end
-
 class FlashResponder < ActionController::Responder
   include Responders::FlashResponder
 end
@@ -16,6 +7,7 @@ end
 class AddressesController < ApplicationController
   before_filter :set_resource
   self.responder = FlashResponder
+
   respond_to :js, :only => :create
 
   def action
@@ -38,7 +30,7 @@ class AddressesController < ApplicationController
     respond_with(@resource, :notice => "Yes, notice this!", :alert => "Warning, warning!")
   end
 
-protected
+  protected
 
   def interpolation_options
     { :reference => 'Ocean Avenue' }
@@ -46,7 +38,7 @@ protected
 
   def set_resource
     @resource = Address.new
-    @resource.errors[:fail] = true if params[:fail]
+    @resource.errors[:fail] << "FAIL" if params[:fail]
   end
 end
 
@@ -109,29 +101,26 @@ class FlashResponderTest < ActionController::TestCase
   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]
+    assert_equal "Resource created with success", flash[:success]
+    assert_flash_now :success
   end
 
   def test_sets_flash_message_can_be_set_to_now
-    @now = {}
-    @controller.flash.expects(:now).returns(@now)
     post :create, :flash_now => true
-    assert_equal "Resource created with success", @now[:success]
+    assert_equal "Resource created with success", @controller.flash.now[:success]
+    assert_flash_now :success
   end
 
   def test_sets_flash_message_can_be_set_to_now_only_on_success
-    @now = {}
-    @controller.flash.expects(:now).returns(@now)
     post :create, :flash_now => :on_success
-    assert_equal "Resource created with success", @now[:success]
+    assert_equal "Resource created with success", @controller.flash.now[:success]
+    assert_flash_now :success
   end
 
   def test_sets_flash_message_can_be_set_to_now_only_on_failure
-    @controller.flash.expects(:now).never
     post :create, :flash_now => :on_failure
+    assert_not_flash_now :success
   end
 
   def test_sets_message_based_on_notice_key
@@ -145,6 +134,17 @@ class FlashResponderTest < ActionController::TestCase
     post :another, :fail => true
     assert_equal "Warning, warning!", flash[:alert]
   end
+
+  # If we have flash.now, it's always marked as used.
+  def assert_flash_now(k)
+    assert flash.instance_variable_get(:@used).include?(k.to_sym),
+     "Expected #{k} to be in flash.now, but it's not."
+  end
+
+  def assert_not_flash_now(k)
+    assert !flash.instance_variable_get(:@used).include?(k.to_sym),
+     "Expected #{k} to not be in flash.now, but it is."
+  end
 end
 
 class NamespacedFlashResponderTest < ActionController::TestCase

data/test/http_cache_responder_test.rb

@@ -10,15 +10,15 @@ class HttpCacheController < ApplicationController
   def single
     options = params.slice(:http_cache)
     response.last_modified = Time.utc(2008) if params[:last_modified]
-    respond_with(Model.new(Time.utc(2009)), options)
+    respond_with(Address.new(Time.utc(2009)), options)
   end
 
   def collection
-    respond_with [Model.new(Time.utc(2009)), Model.new(Time.utc(2008))]
+    respond_with [Address.new(Time.utc(2009)), Address.new(Time.utc(2008))]
   end
 
   def not_persisted
-    model = Model.new(Time.utc(2009))
+    model = Address.new(Time.utc(2009))
     model.persisted = false
     respond_with(model)
   end

data/test/test_helper.rb

@@ -2,7 +2,6 @@ require 'rubygems'
 require 'bundler'
 
 Bundler.setup
-
 require 'test/unit'
 require 'mocha'
 
@@ -11,6 +10,7 @@ ENV["RAILS_ENV"] = "test"
 
 require 'active_support'
 require 'action_controller'
+require 'active_model'
 require 'rails/railtie'
 
 class ApplicationController < ActionController::Base
@@ -26,26 +26,42 @@ I18n.reload!
 ActionController::Base.view_paths = File.join(File.dirname(__FILE__), 'views')
 
 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'
+Responders::Routes.draw do
+  match '/admin/:action', :controller => "admin/addresses"
+  match '/:controller(/:action(/:id))'
 end
 
+ActionController::Base.send :include, Responders::Routes.url_helpers
+
 class ActiveSupport::TestCase
   setup do
     @routes = Responders::Routes
   end
 end
 
-class Model < Struct.new(:updated_at)
-  attr_writer :persisted
+class Model
+  include ActiveModel::Conversion
+  include ActiveModel::Validations
+
+  attr_accessor :persisted, :updated_at
+  alias :persisted? :persisted
 
   def persisted?
-    defined?(@persisted) ? @persisted : true
+    @persisted
   end
 
   def to_xml(*args)
     "<xml />"
   end
+
+  def initialize(updated_at=nil)
+    @persisted = true
+    self.updated_at = updated_at
+  end
+end
+
+class Address < Model
+end
+
+class User < Model
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: responders
 version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: false
   segments: 
   - 0
   - 6
-  - 1
-  version: 0.6.1
+  - 2
+  version: 0.6.2
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-24 00:00:00 +02:00
+date: 2010-07-26 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +30,7 @@ extra_rdoc_files:
 files: 
 - CHANGELOG.rdoc
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
@@ -37,11 +39,17 @@ files:
 - lib/generators/rails/templates/controller.rb
 - lib/generators/responders/install_generator.rb
 - lib/responders.rb
+- lib/responders/collection_responder.rb
 - lib/responders/controller_method.rb
 - lib/responders/flash_responder.rb
 - lib/responders/http_cache_responder.rb
 - lib/responders/locales/en.yml
 - lib/responders/version.rb
+- test/collection_responder_test.rb
+- test/controller_method_test.rb
+- test/flash_responder_test.rb
+- test/http_cache_responder_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/plataformatec/responders
 licenses: []
@@ -52,27 +60,32 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A set of Rails 3 responders to dry up your application
 test_files: 
+- test/collection_responder_test.rb
 - test/controller_method_test.rb
 - test/flash_responder_test.rb
 - test/http_cache_responder_test.rb