responders 0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+== 0.1
+
+* Added FlashResponder
+* Added HttpCacheResponder
+* Added responders generators

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2009 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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,44 @@
+== Responders
+
+A set of responders 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"
+
+  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
+  for a controller, let's say, for PostsController, you can also do:
+
+    flash:
+      posts:
+        create:
+          success: "Your post was created and will be published soon"
+
+* 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.
+
+== 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:
+
+  config.generators do |g|
+    g.scaffold_controller = :responders_controller
+  end
+
+== Bugs and Feedback
+
+If you discover any bugs or want to drop a line, feel free to create an issue on GitHub.
+
+http://github.com/plataformatec/responders/issues
+
+MIT License. Copyright 2009 Plataforma Tecnologia. http://blog.plataformatec.com.br

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'responders', 'version')
+
+desc 'Default: run unit tests'
+task :default => :test
+
+desc 'Test Responders'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for Responders'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Responders'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "responders"
+    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"
+    s.description = "A set of Rails 3 responders to dry up your application"
+    s.authors = ['José Valim']
+    s.files =  FileList["[A-Z]*", "lib/**/*", "init.rb"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/lib/generators/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/responders_controller_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/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/responders_install_generator.rb

@@ -0,0 +1,14 @@
+class RespondersInstallGenerator < Rails::Generators::Base
+  desc "Creates an initializer file with default responder configuration"
+
+  def create_responder_initializer
+    create_file "config/initializers/responders.rb", <<-FILE
+class #{Rails.application.class.name}Responder
+  include FlashResponder
+  include HttpCacheResponder
+end
+
+ApplicationController.responder = #{Rails.application.class.name}Responder
+    FILE
+  end
+end

data/lib/generators/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/responders.rb

@@ -0,0 +1,4 @@
+module Responders
+  autoload :FlashResponder,     'responders/flash_responder'
+  autoload :HttpCacheResponder, 'responders/http_cache_responder'
+end

data/lib/responders/flash_responder.rb

@@ -0,0 +1,102 @@
+module Responders
+  # Responder to automatically set flash messages based on I18n API. It checks for
+  # message based on the current action, but also allows defaults to be set, using
+  # the following order:
+  #
+  #   flash.controller_name.action_name.status
+  #   flash.actions.action_name.status
+  #
+  # So, if you have a CarsController, create action, it will check for:
+  #
+  #   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
+  # or updated).
+  #
+  # The resource_name given is available as interpolation option, this means you can set:
+  #
+  #   flash:
+  #     actions:
+  #       create:
+  #         success: "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
+  # updated. Well, that's easy also:
+  #
+  #   flash:
+  #     cars:
+  #       update:
+  #         success: "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.
+  #
+  #   def interpolation_options
+  #     { :car_brand => @car.brand }
+  #   end
+  #
+  # Then you will finally have:
+  #
+  #   'Hooray! You just tuned your Aston Martin!'
+  #
+  # If your controller is namespaced, for example Admin::CarsController,
+  # the messages will be checked in the following order:
+  #
+  #   flash.admin.cars.create.status
+  #   flash.admin.actions.create.status
+  #   flash.cars.create.status
+  #   flash.actions.create.status
+  #
+  module FlashResponder
+    def initialize(controller, resources, options={})
+      super
+      @flash = options.delete(:flash)
+    end
+
+    def navigation_behavior(error)
+      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
+        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
+
+        message = ::I18n.t options[:default].shift, options
+        controller.send(:flash)[status] = message unless message.blank?
+      end
+    end
+
+  protected
+
+    def flash_defaults_by_namespace(status)
+      defaults = []
+      slices   = controller.controller_path.split('/')
+
+      while slices.size > 0
+        defaults << :"flash.#{slices.fill(controller.controller_name, -1).join('.')}.#{controller.action_name}.#{status}"
+        defaults << :"flash.#{slices.fill(:actions, -1).join('.')}.#{controller.action_name}.#{status}"
+        slices.shift
+      end
+
+      defaults << ""
+    end
+  end
+end

data/lib/responders/http_cache_responder.rb

@@ -0,0 +1,33 @@
+module Responders
+  # Set HTTP Last-Modified headers based on the given resource. It's used only
+  # on API behavior (to_format) and is useful for a client to check in the server
+  # if a resource changed after a specific date or not.
+  #
+  # This is not usually not used in html requests because pages contains a lot
+  # information besides the resource information, as current_user, flash messages,
+  # widgets... that are better handled with other strategies, as fragment caches and
+  # the digest of the body.
+  #
+  module HttpCacheResponder
+    def initialize(controller, resources, options={})
+      super
+      @http_cache = options.delete(:http_cache)
+    end
+
+    def to_format
+      if get? && @http_cache != false && controller.response.last_modified.nil?
+        timestamp = resources.flatten.map do |resource|
+          resource.updated_at.utc if resource.respond_to?(:updated_at)
+        end.compact.max
+
+        controller.response.last_modified = timestamp if timestamp
+        if request.fresh?(controller.response)
+          head :not_modified
+          return
+        end
+      end
+
+      super
+    end
+  end
+end

data/lib/responders/version.rb

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

data/test/flash_responder_test.rb

@@ -0,0 +1,116 @@
+require File.dirname(__FILE__) + '/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
+
+class AddressesController < ApplicationController
+  before_filter :set_resource
+  self.responder = FlashResponder
+
+  def action
+    options = params.slice(:flash)
+    flash[:success] = "Flash is set" if params[:set_flash]
+    respond_with(@resource, options)
+  end
+  alias :new     :action
+  alias :create  :action
+  alias :update  :action
+  alias :destroy :action
+
+protected
+
+  def interpolation_options
+    { :reference => 'Ocean Avenue' }
+  end
+
+  def set_resource
+    @resource = Address.new
+    @resource.errors[:fail] = true if params[:fail]
+  end
+end
+
+module Admin
+  class AddressesController < ::AddressesController
+  end
+end
+
+class FlashResponderTest < ActionController::TestCase
+  tests AddressesController
+
+  def setup
+    @controller.stubs(:polymorphic_url).returns("/")
+  end
+
+  def test_sets_success_flash_message_on_non_get_requests
+    post :create
+    assert_equal "Resource created with success", flash[:success]
+  end
+
+  def test_sets_failure_flash_message_on_not_get_requests
+    post :create, :fail => true
+    assert_equal "Resource could not be created", flash[:failure]
+  end
+
+  def test_does_not_set_flash_message_on_get_requests
+    get :new
+    assert flash.empty?
+  end
+
+  def test_sets_flash_message_for_the_current_controller
+    put :update, :fail => true
+    assert_equal "Oh no! We could not update your address!", flash[:failure]
+  end
+
+  def test_sets_flash_message_with_resource_name
+    put :update
+    assert_equal "Nice! Address was updated with success!", flash[:success]
+  end
+
+  def test_sets_flash_message_with_interpolation_options
+    delete :destroy
+    assert_equal "Successfully deleted the address at Ocean Avenue", flash[:success]
+  end
+
+  def test_does_not_set_flash_if_flash_false_is_given
+    post :create, :flash => false
+    assert flash.empty?
+  end
+
+  def test_does_not_overwrite_the_flash_if_already_set
+    post :create, :set_flash => true
+    assert_equal "Flash is set", flash[:success]
+  end
+end
+
+class NamespacedFlashResponderTest < ActionController::TestCase
+  tests Admin::AddressesController
+
+  def setup
+    @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]
+  end
+
+  def test_sets_the_flash_message_based_on_namespace_actions
+    post :create
+    assert_equal "Admin created address with success", flash[:success]
+  end
+
+  def test_fallbacks_to_non_namespaced_controller_flash_message
+    delete :destroy
+    assert_equal "Successfully deleted the address at Ocean Avenue", flash[:success]
+  end
+end

data/test/http_cache_responder_test.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class HttpCacheResponder < ActionController::Responder
+  include Responders::HttpCacheResponder
+end
+
+class HttpCacheController < ApplicationController
+  self.responder = HttpCacheResponder
+
+  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)
+  end
+
+  def collection
+    respond_with [Model.new(Time.utc(2009)), Model.new(Time.utc(2008))]
+  end
+
+  def empty
+    respond_with []
+  end
+end
+
+class HttpCacheResponderTest < ActionController::TestCase
+  tests HttpCacheController
+
+  def setup
+    @request.accept = "application/xml"
+    @controller.stubs(:polymorphic_url).returns("/")
+  end
+
+  def test_last_modified_at_is_set_with_single_resource_on_get
+    get :single
+    assert_equal Time.utc(2009).httpdate, @response.headers["Last-Modified"]
+    assert_equal "<xml />", @response.body
+    assert_equal 200, @response.status
+  end
+
+  def test_returns_not_modified_if_return_is_cache_is_still_valid
+    @request.env["HTTP_IF_MODIFIED_SINCE"] = Time.utc(2009, 6).httpdate
+    get :single
+    assert_equal 304, @response.status
+    assert_equal " ", @response.body
+  end
+
+  def test_refreshes_last_modified_if_cache_is_expired
+    @request.env["HTTP_IF_MODIFIED_SINCE"] = Time.utc(2008, 6).httpdate
+    get :single
+    assert_equal Time.utc(2009).httpdate, @response.headers["Last-Modified"]
+    assert_equal "<xml />", @response.body
+    assert_equal 200, @response.status
+  end
+
+  def test_does_not_set_cache_unless_get_requests
+    put :single
+    assert_nil @response.headers["Last-Modified"]
+    assert_equal 200, @response.status
+  end
+
+  def test_does_not_use_cache_unless_get_requests
+    @request.env["HTTP_IF_MODIFIED_SINCE"] = Time.utc(2009, 6).httpdate
+    put :single
+    assert_equal 200, @response.status
+  end
+
+  def test_does_not_set_cache_if_http_cache_is_false
+    get :single, :http_cache => false
+    assert_nil @response.headers["Last-Modified"]
+    assert_equal 200, @response.status
+  end
+
+  def test_does_not_use_cache_if_http_cache_is_false
+    @request.env["HTTP_IF_MODIFIED_SINCE"] = Time.utc(2009, 6).httpdate
+    get :single, :http_cache => false
+    assert_equal 200, @response.status
+  end
+
+  def test_does_not_set_cache_if_last_modified_already_set_in_response
+    get :single, :last_modified => true
+    assert_equal Time.utc(2008).httpdate, @response.headers["Last-Modified"]
+    assert_equal 200, @response.status
+  end
+
+  def test_does_not_use_cache_if_last_modified_already_set_in_response
+    @request.env["HTTP_IF_MODIFIED_SINCE"] = Time.utc(2009, 6).httpdate
+    get :single, :last_modified => true
+    assert_equal 200, @response.status
+  end
+
+  def test_collection_chooses_the_latest_timestamp
+    get :collection
+    assert_equal Time.utc(2009).httpdate, @response.headers["Last-Modified"]
+    assert_match /xml/, @response.body
+    assert_equal 200, @response.status
+  end
+
+  def test_work_with_an_empty_array
+    get :empty
+    assert_nil @response.headers["Last-Modified"]
+    assert_match /xml/, @response.body
+    assert_equal 200, @response.status
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+
+begin
+  gem "test-unit"
+rescue LoadError
+end
+
+begin
+  gem "ruby-debug"
+  require 'ruby-debug'
+rescue LoadError
+end
+
+require 'test/unit'
+require 'mocha'
+
+# Configure Rails
+ENV["RAILS_ENV"] = "test"
+RAILS_ROOT = "anywhere"
+
+require File.expand_path(File.dirname(__FILE__) + "/../../../rails/vendor/gems/environment")
+require 'active_support'
+require 'action_controller'
+require 'action_controller/testing/test_case'
+
+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'
+
+I18n.load_path << File.join(File.dirname(__FILE__), 'locales', 'en.yml')
+I18n.reload!
+
+ActionController::Base.view_paths = File.join(File.dirname(__FILE__), 'views')
+
+ActionController::Routing::Routes.draw do |map|
+  map.connect 'admin/:action', :controller => "admin/addresses"
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action'
+end
+
+class Model < Struct.new(:updated_at)
+  def to_xml(*args)
+    "<xml />"
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: responders
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- "Jos\xC3\xA9 Valim"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-04 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: A set of Rails 3 responders to dry up your application
+email: contact@plataformatec.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/generators/USAGE
+- lib/generators/responders_controller_generator.rb
+- lib/generators/responders_install_generator.rb
+- lib/generators/templates/controller.rb
+- lib/responders.rb
+- lib/responders/flash_responder.rb
+- lib/responders/http_cache_responder.rb
+- lib/responders/version.rb
+has_rdoc: true
+homepage: http://github.com/plataformatec/responders
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A set of Rails 3 responders to dry up your application
+test_files: 
+- test/flash_responder_test.rb
+- test/http_cache_responder_test.rb
+- test/test_helper.rb