responders 0.8.0 → 0.9.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - ree
+  - jruby-18mode
+gemfile:
+  - gemfiles/Gemfile-rails.3.1.x
+  - Gemfile
+notifications:
+  recipients:
+    - jose.valim@plataformatec.com.br
+    - carlos@plataformatec.com.br
+    - rafael.franca@plataformatec.com.br

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+## 0.9
+
+* Disable namespace lookup by default
+
+## 0.8
+
+* Allow embedded HTML in flash messages
+
+## 0.7
+
+* Support Rails 3.1 onward
+* Support namespaced engines
+
+## 0.6
+
+* Allow engine detection in generators
+* HTTP Cache is no longer triggered for collections
+* `:js` now sets the `flash.now` by default, instead of `flash`
+* Renamed `responders_install` generator to `responders:install`
+* Added `CollectionResponder` which allows you to always redirect to the collection path
+  (index action) after POST/PUT/DELETE
+
+## 0.5
+
+* Added Railtie and better Rails 3 support
+* Added `:flash_now` as option
+
+## 0.4
+
+* 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

data/Gemfile

@@ -1,7 +1,7 @@
-source "http://rubygems.org"
+source :rubygems
 
 gemspec
 
-gem "mocha"
+gem 'mocha'
 
-gem "ruby-debug", :platform => :mri_18
+gem 'ruby-debug', :platform => :mri_18

data/README.md

@@ -0,0 +1,135 @@
+# Responders
+
+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
+
+## Responders Types
+
+### 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:
+
+```yaml
+  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."
+```
+
+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:
+
+```yaml
+  flash:
+    posts:
+      create:
+        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 in your application:
+
+```ruby
+config.responders.flash_keys = [ :success, :failure ]
+```
+
+You can also have embedded HTML. Just create a `_html` scope.
+
+```yaml
+  flash:
+    actions:
+      create:
+        alert_html: "<strong>OH NOES!</strong> You did it wrong!"
+    posts:
+      create:
+        notice_html: "<strong>Yay!</strong> You did it!"
+```
+
+### 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.
+
+### 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:
+
+```console
+gem install responders
+```
+
+In your Gemfile, add this line:
+
+```ruby
+gem 'responders'
+```
+
+Responders only provides a set of modules, to use them, you have to create your own
+responder. This can be done inside the lib folder for example:
+
+```ruby
+# 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:
+
+```ruby
+# 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:
+
+```console
+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.
+
+```ruby
+class InvitationsController < ApplicationController
+  responders :flash, :http_cache
+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. Installing this gem automatically
+sets the generator.
+
+## 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 2012 Plataforma Tecnologia. http://blog.plataformatec.com.br

data/gemfiles/Gemfile-rails.3.1.x

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'responders', :path => '..'
+
+gem 'railties', '~> 3.1.0'
+gem 'mocha'

data/lib/responders.rb

@@ -9,6 +9,9 @@ module Responders
 
   class Railtie < ::Rails::Railtie
     config.responders = ActiveSupport::OrderedOptions.new
+    config.responders.flash_keys = [ :notice, :alert ]
+    config.responders.namespace_lookup = false
+
     if config.respond_to?(:app_generators)
       config.app_generators.scaffold_controller = :responders_controller
     else
@@ -20,9 +23,8 @@ module Responders
     I18n.load_path << File.expand_path('../responders/locales/en.yml', __FILE__)
 
     initializer "responders.flash_responder" do |app|
-      if app.config.responders.flash_keys
-        Responders::FlashResponder.flash_keys = app.config.responders.flash_keys
-      end
+      Responders::FlashResponder.flash_keys = app.config.responders.flash_keys
+      Responders::FlashResponder.namespace_lookup = app.config.responders.namespace_lookup
     end
   end
 end

data/lib/responders/flash_responder.rb

@@ -83,18 +83,20 @@ module Responders
   # and :alert.
   #
   module FlashResponder
-    mattr_accessor :flash_keys
-    @@flash_keys = [ :notice, :alert ]
+    class << self
+      attr_accessor :flash_keys, :namespace_lookup, :helper
+    end
 
-    mattr_reader :helper
-    @@helper = Object.new.extend(ActionView::Helpers::TranslationHelper)
+    self.flash_keys = [ :notice, :alert ]
+    self.namespace_lookup = false
+    self.helper = Object.new.extend(ActionView::Helpers::TranslationHelper)
 
     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_now = options.delete(:flash_now) { :on_failure }
     end
 
     def to_html
@@ -163,10 +165,11 @@ module Responders
     def flash_defaults_by_namespace(status) #:nodoc:
       defaults = []
       slices   = controller.controller_path.split('/')
+      lookup   = Responders::FlashResponder.namespace_lookup
 
-      while slices.size > 0
+      begin
         controller_scope = :"flash.#{slices.fill(controller.controller_name, -1).join('.')}.#{controller.action_name}.#{status}"
-        actions_scope = :"flash.#{slices.fill(:actions, -1).join('.')}.#{controller.action_name}.#{status}"
+        actions_scope = :"flash.#{slices.fill('actions', -1).join('.')}.#{controller.action_name}.#{status}"
 
         defaults << :"#{controller_scope}_html"
         defaults << controller_scope
@@ -175,9 +178,9 @@ module Responders
         defaults << actions_scope
 
         slices.shift
-      end
+      end while slices.size > 0 && lookup
 
       defaults << ""
     end
   end
-end
+end

data/lib/responders/version.rb

@@ -1,3 +1,3 @@
 module Responders
-  VERSION = "0.8.0".freeze
+  VERSION = "0.9.0".freeze
 end

data/test/flash_responder_test.rb

@@ -34,6 +34,11 @@ class AddressesController < ApplicationController
     respond_with(@resource)
   end
 
+  def flexible
+    options = params[:responder_options] || {}
+    respond_with(@resource, options)
+  end
+
   protected
 
   def interpolation_options
@@ -154,6 +159,16 @@ class FlashResponderTest < ActionController::TestCase
     assert_equal "<strong>Yay!</strong> &lt;script&gt;alert(1)&lt;/script&gt;", flash[:xss]
   end
 
+  def test_sets_flash_now_on_failure_by_default
+    post :another, :fail => true
+    assert_flash_now :alert
+  end
+
+  def test_never_set_flash_now
+    post :flexible, :fail => true, :responder_options => { :flash_now => false, :alert => "Warning" }
+    assert_not_flash_now :alert
+  end
+
   # If we have flash.now, it's always marked as used.
   def assert_flash_now(k)
     assert flash.instance_variable_get(:@used).to_a.include?(k.to_sym),
@@ -161,7 +176,8 @@ class FlashResponderTest < ActionController::TestCase
   end
 
   def assert_not_flash_now(k)
-    assert !flash.instance_variable_get(:@used).to_a.include?(k.to_sym),
+    assert flash[k], "Expected #{k} to be set"
+    assert !flash.instance_variable_get(:@used).include?(k.to_sym),
      "Expected #{k} to not be in flash.now, but it is."
   end
 end
@@ -185,7 +201,15 @@ class NamespacedFlashResponderTest < ActionController::TestCase
   end
 
   def test_fallbacks_to_non_namespaced_controller_flash_message
+    Responders::FlashResponder.namespace_lookup = true
     delete :destroy
     assert_equal "Successfully deleted the chosen address at Ocean Avenue", flash[:notice]
+  ensure
+    Responders::FlashResponder.namespace_lookup = false
+  end
+
+  def test_does_not_fallbacks_to_non_namespaced_controller_flash_message_if_disabled
+    delete :destroy
+    assert_equal nil, flash[:notice]
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: responders
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000 Z
+date: 2012-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70303791369100 !ruby/object:Gem::Requirement
+  requirement: &2156123020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,19 +21,21 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70303791369100
+  version_requirements: *2156123020
 description: A set of Rails 3 responders to dry up your application
 email: contact@plataformatec.com.br
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.rdoc
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
+- gemfiles/Gemfile-rails.3.1.x
 - lib/generators/rails/USAGE
 - lib/generators/rails/responders_controller_generator.rb
 - lib/generators/rails/templates/controller.rb
@@ -67,21 +69,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -73151246775261150
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -73151246775261150
 requirements: []
 rubyforge_project: responders
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A set of Rails 3 responders to dry up your application

data/CHANGELOG.rdoc

@@ -1,32 +0,0 @@
-== 0.8
-
-* Allow embedded HTML in flash messages
-
-== 0.7
-
-* Support Rails 3.1 onward
-* Support namespaced engines
-
-== 0.6
-
-* Allow engine detection in generators
-* HTTP Cache is no longer triggered for collections
-* :js now sets the flash.now by default, instead of flash
-* Renamed responders_install generator to responders:install
-* Added CollectionResponder which allows you to always redirect to the collection path (index action) after POST/PUT/DELETE
-
-== 0.5
-
-* Added Railtie and better Rails 3 support
-* Added :flash_now as option
-
-== 0.4
-
-* 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

data/README.rdoc

@@ -1,110 +0,0 @@
-== Responders
-
-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
-  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:
-          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."
-
-  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:
-          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 in your application:
-
-    config.responders.flash_keys = [ :success, :failure ]
-
-  Or:
-
-    Responders::FlashResponder.flash_keys = [ :success, :failure ]
-
-  You can also have embedded HTML. Just create a <tt>_html</tt> scope.
-
-    flash:
-      actions:
-        create:
-          alert_html: "<strong>OH NOES!</strong> You did it wrong!"
-      posts:
-        create:
-          notice_html: "<strong>Yay!</strong> You did it!"
-
-* 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.
-
-* 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:
-
-  gem install responders
-
-In your Gemfile, add this line:
-
-  gem "responders"
-
-Responders only provides a set of modules, to use them, you have to create your own
-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
-
-== 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
-to use respond_with instead of default respond_to blocks. Installing this gem automatically
-sets the generator.
-
-== 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 2012 Plataforma Tecnologia. http://blog.plataformatec.com.br