responders 0.4.8 → 0.5.0

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.5
+
+* Added Railtie and better Rails 3 support
+
 == 0.4
 
 * Added Responders::FlashResponder.flash_keys and default to [ :notice, :alert ]

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2009 Plataforma Tecnologia. http://blog.plataformatec.com.br
+Copyright 2010 Plataforma Tecnologia. 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,9 @@
 == Responders
 
-A set of responders modules to dry up your Rails application. This branch (v0.4) is meant
-to be used with Rails 2.3 with Inherited Resources. Check the master branch for Rails 3
-version.
+A set of responders modules to dry up your Rails 3 app. If you are interested in the version
+to be used with Rails 2.3 together with Inherited Resources, please check this branch instead:
+
+  http://github.com/plataformatec/responders/tree/v0.4
 
 * 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
@@ -12,12 +13,11 @@ version.
     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."
+          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
@@ -29,7 +29,11 @@ version.
           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:
+  :notice and :alert, but they can be changed in your application:
+
+	config.responders.flash_keys = [ :success, :failure ]
+
+  Or:
 
     Responders::FlashResponder.flash_keys = [ :success, :failure ]
 
@@ -37,9 +41,29 @@ version.
   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.
 
-== Installation
+== Configuring your own responder
+
+The first step is instal responders gem and configure it in your application:
+
+  sudo 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:
+
+  class AppResponder < ActionController::Responder
+    include Responders::FlashResponder
+    include Responders::HttpCacheResponder
+  end
+
+Or, for your convenience, just do:
+
+  rails generate responders_install
+
+== Generator
 
-  sudo gem install responders --version=0.4.5
+This gem also includes a responders controller generator, so your scaffold can be customized
+to use respond_with instead of default respond_to blocks. Installing this gem automatically
+sets the generator.
 
 == Bugs and Feedback
 

data/Rakefile

@@ -29,7 +29,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name = "responders"
-    s.version = Responders::VERSION.dup
+    s.version = Responders::VERSION
     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/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Stubs out a scaffolded controller and its views. Different from rails
+    scaffold_controller, it uses respond_with instead of respond_to blocks.
+    Pass the model name, either CamelCased or under_scored. The controller
+    name is retrieved as a pluralized version of the model name.
+
+    To create a controller within a module, specify the model name as a
+    path like 'parent_module/controller_name'.
+
+    This generates a controller class in app/controllers and invokes helper,
+    template engine and test framework generators.

data/lib/generators/rails/responders_controller_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/rails/scaffold_controller/scaffold_controller_generator'
+
+module Rails
+  module Generators
+    class RespondersControllerGenerator < ScaffoldControllerGenerator
+      def self.source_root
+        @_source_root ||= File.expand_path("templates", File.dirname(__FILE__))
+      end
+
+    protected
+
+      def flash?
+        !ApplicationController.responder.ancestors.include?(Responders::FlashResponder)
+      end
+    end
+  end
+end

data/lib/generators/rails/templates/controller.rb

@@ -0,0 +1,53 @@
+class <%= controller_class_name %>Controller < ApplicationController
+<% unless options[:singleton] -%>
+  # GET /<%= table_name %>
+  # GET /<%= table_name %>.xml
+  def index
+    @<%= table_name %> = <%= orm_class.all(class_name) %>
+    respond_with(@<%= table_name %>)
+  end
+<% end -%>
+
+  # GET /<%= table_name %>/1
+  # GET /<%= table_name %>/1.xml
+  def show
+    @<%= file_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    respond_with(@<%= file_name %>)
+  end
+
+  # GET /<%= table_name %>/new
+  # GET /<%= table_name %>/new.xml
+  def new
+    @<%= file_name %> = <%= orm_class.build(class_name) %>
+    respond_with(@<%= file_name %>)
+  end
+
+  # GET /<%= table_name %>/1/edit
+  def edit
+    @<%= file_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+  end
+
+  # POST /<%= table_name %>
+  # POST /<%= table_name %>.xml
+  def create
+    @<%= file_name %> = <%= orm_class.build(class_name, "params[:#{file_name}]") %>
+    <%= "flash[:notice] = '#{class_name} was successfully created.' if " if flash? %>@<%= orm_instance.save %>
+    respond_with(@<%= file_name %>)
+  end
+
+  # PUT /<%= table_name %>/1
+  # PUT /<%= table_name %>/1.xml
+  def update
+    @<%= file_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    <%= "flash[:notice] = '#{class_name} was successfully updated.' if " if flash? %>@<%= orm_instance.update_attributes("params[:#{file_name}]") %>
+    respond_with(@<%= file_name %>)
+  end
+
+  # DELETE /<%= table_name %>/1
+  # DELETE /<%= table_name %>/1.xml
+  def destroy
+    @<%= file_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    @<%= orm_instance.destroy %>
+    respond_with(@<%= file_name %>)
+  end
+end

data/lib/generators/responders_install_generator.rb

@@ -0,0 +1,23 @@
+class RespondersInstallGenerator < Rails::Generators::Base
+  def self.source_root
+    @_source_root ||= File.expand_path("..", __FILE__)
+  end
+
+  desc "Creates an initializer with default responder configuration and copy locale file"
+
+  def create_responder_initializer
+    create_file "config/initializers/responders.rb", <<-FILE
+class ApplicationResponder
+  include Responders::FlashResponder
+  include Responders::HttpCacheResponder
+end
+
+ApplicationController.respond_to :html
+ApplicationController.responder = ApplicationResponder
+    FILE
+  end
+
+  def copy_locale
+    copy_file "../responders/locales/en.yml", "config/locales/responders.en.yml"
+  end
+end

data/lib/responders.rb

@@ -1,4 +1,20 @@
 module Responders
   autoload :FlashResponder,     'responders/flash_responder'
   autoload :HttpCacheResponder, 'responders/http_cache_responder'
+
+  class Railtie < ::Rails::Railtie
+    railtie_name :responders
+
+    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 
+      end
+    end
+  end
 end

data/lib/responders/flash_responder.rb

@@ -64,8 +64,6 @@ module Responders
   #
   #     respond_with(@user, :notice => "Hooray! Welcome!", :alert => "Woot! You failed.")
   #
-  # * :flash_now - Sets the flash message using flash.now. Accepts true, :on_failure or :on_sucess.
-  #
   # == Configure status keys
   #
   # As said previously, FlashResponder by default use :notice and :alert
@@ -82,30 +80,24 @@ module Responders
 
     def initialize(controller, resources, options={})
       super
-      @flash     = options.delete(:flash)
-      @notice    = options.delete(:notice)
-      @alert     = options.delete(:alert)
-      @flash_now = options.delete(:flash_now)
+      @flash  = options.delete(:flash)
+      @notice = options.delete(:notice)
+      @alert  = options.delete(:alert)
     end
 
     def to_html
-      set_flash_message! if set_flash_message?
       super
-    end
-
-    def to_js
       set_flash_message! if set_flash_message?
-      to_format
     end
 
   protected
 
     def set_flash_message!
       if has_errors?
-        set_flash(:alert, @alert)
+        controller.flash[:alert] ||= @alert if @alert
         status = Responders::FlashResponder.flash_keys.last
       else
-        set_flash(:notice, @notice)
+        controller.flash[:notice] ||= @notice if @notice
         status = Responders::FlashResponder.flash_keys.first
       end
 
@@ -113,18 +105,7 @@ module Responders
 
       options = mount_i18n_options(status)
       message = ::I18n.t options[:default].shift, options
-      set_flash(status, message)
-    end
-
-    def set_flash(key, value)
-      return if value.blank?
-      flash = controller.flash
-      flash = flash.now if set_flash_now?
-      flash[key] ||= value
-    end
-
-    def set_flash_now?
-      (@flash_now == true) || (has_errors? ? @flash_now == :on_failure : @flash_now == :on_success) || (format == :js)
+      controller.flash[status] = message unless message.blank?
     end
 
     def set_flash_message? #:nodoc:
@@ -132,8 +113,8 @@ module Responders
     end
 
     def mount_i18n_options(status) #:nodoc:
-      resource_name = if resource.class.respond_to?(:human_name)
-        resource.class.human_name
+      resource_name = if resource.class.respond_to?(:model_name)
+        resource.class.model_name.human
       else
         resource.class.name.underscore.humanize
       end
@@ -141,7 +122,7 @@ module Responders
       options = {
         :default => flash_defaults_by_namespace(status),
         :resource_name => resource_name,
-        :resource_sym  => resource_name.downcase
+        :downcase_resource_name => resource_name.downcase
       }
 
       if controller.respond_to?(:interpolation_options, true)

data/lib/responders/http_cache_responder.rb

@@ -33,8 +33,7 @@ module Responders
     end
 
     def do_http_cache?
-      get? && @http_cache != false && ActionController::Base.perform_caching &&
-        !new_record? && controller.response.last_modified.nil? && resource.respond_to?(:updated_at)
+      get? && @http_cache != false && !new_record? && controller.response.last_modified.nil?
     end
 
     def new_record?

data/lib/responders/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  flash:
+    actions:
+      create:
+        notice: '{{resource_name}} was successfully created.'
+      update:
+        notice: '{{resource_name}} was successfully updated.'
+      destroy:
+        notice: '{{resource_name}} was successfully destroyed.'
+        alert: '{{resource_name}} could not be destroyed.'

data/lib/responders/version.rb

@@ -1,3 +1,3 @@
 module Responders
-  VERSION = "0.4.8".freeze
+  VERSION = "0.5.0".freeze
 end

data/test/flash_responder_test.rb

@@ -16,10 +16,9 @@ end
 class AddressesController < ApplicationController
   before_filter :set_resource
   self.responder = FlashResponder
-  respond_to :js, :only => :create
 
   def action
-    options = params.slice(:flash, :flash_now)
+    options = params.slice(:flash)
     flash[:success] = "Flash is set" if params[:set_flash]
     respond_with(@resource, options)
   end
@@ -108,32 +107,6 @@ 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)
-    post :create, :flash_now => true
-    assert_equal "Resource created with success", @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]
-  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
-  end
-
   def test_sets_message_based_on_notice_key
     Responders::FlashResponder.flash_keys = [ :notice, :alert ]
     post :another

data/test/http_cache_responder_test.rb

@@ -94,9 +94,9 @@ class HttpCacheResponderTest < ActionController::TestCase
     assert_equal 200, @response.status
   end
 
-  def test_collection_does_not_trigger_http_cache
+  def test_collection_chooses_the_latest_timestamp
     get :collection
-    assert_equal nil, @response.headers["Last-Modified"]
+    assert_equal Time.utc(2009).httpdate, @response.headers["Last-Modified"]
     assert_match /xml/, @response.body
     assert_equal 200, @response.status
   end
@@ -108,6 +108,11 @@ class HttpCacheResponderTest < ActionController::TestCase
     assert_equal 200, @response.status
   end
 
+  def test_it_does_not_set_body_etag
+    get :collection
+    assert_nil @response.headers["ETag"]
+  end
+
   def test_does_not_set_cache_for_new_records
     get :new_record
     assert_nil @response.headers["Last-Modified"]

data/test/test_helper.rb

@@ -20,13 +20,14 @@ RAILS_ROOT = "anywhere"
 
 require 'active_support'
 require 'action_controller'
-require 'action_controller/test_case'
+require 'action_dispatch/middleware/flash'
+
+require 'rails/railtie'
 
 class ApplicationController < ActionController::Base
   respond_to :html, :xml
 end
 
-# Add IR to load path and load the main file
 $:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 require 'responders'
 

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: responders
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 8
-  version: 0.4.8
+  version: 0.5.0
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -15,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-07 00:00:00 +02:00
+date: 2010-02-07 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -32,44 +26,40 @@ files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
+- lib/generators/rails/USAGE
+- lib/generators/rails/responders_controller_generator.rb
+- lib/generators/rails/templates/controller.rb
+- lib/generators/responders_install_generator.rb
 - lib/responders.rb
 - lib/responders/flash_responder.rb
 - lib/responders/http_cache_responder.rb
+- lib/responders/locales/en.yml
 - lib/responders/version.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: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
+  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
+  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A set of Rails 3 responders to dry up your application