responders 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1048b35bc57148e916fc54ea72aa8a0e3f9f7498
-  data.tar.gz: 8d4c1c0825d565528c29371185d374e8266336ff
+  metadata.gz: 06ba4b048f7ab149753ce1222674abcde97594ce
+  data.tar.gz: d10721b4e6683ecc3095d709134d9e8785909c7f
 SHA512:
-  metadata.gz: 2cd86b1e17658300952e4fea7326eafc6474d9b47ee7520322521a103300fa3ad803ed41c5c7849febdf0769bb7f43085d2898fe589d0b85cc835a9017f7e07c
-  data.tar.gz: f390f3b7d962ede7cda0b454d45b7864d2606472c33029a24981d84374be0ba8d8f98536aa5af2ef9aa4c0f915e4d2750a2f06278cf4113f82f35e30ceb5dc6a
+  metadata.gz: 89dbb2374f73e0090d5ef320ae5d52235a075de8f344475717c1dc45474d86a0a2fd8de8dd8d7a7661f166f014658841106635c57cf1dc9db36b1acea5ad37d5
+  data.tar.gz: 973bbda1f6a6b6b4f056a8a5615b170d22f0e954fb2b77625279347e23f85378100fbf1d3079897c69174b304132099ed77c29963741439466bc0fdaff3b7120

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1.0
+
+* No longer automatically set the responders generator as many projects may use this gem as a dependency. When upgrading, users will need to add `config.app_generators.scaffold_controller :responders_controller` to their application. The `responders:install` generator has been updated to automatically insert it in new applications
+
 ## 2.0.1
 
 * Require `rails/railtie` explicitly before using it
@@ -8,7 +12,7 @@
 
 * Import `respond_with` and class-level `respond_to` from Rails
 * Support only Rails ~> 4.2
-* `Responders::LocationResponder` is now included by in the default responder (and therefore deprecated)
+* `Responders::LocationResponder` is now included by the default responder (and therefore deprecated)
 
 ## 1.1.0
 

data/README.md

@@ -4,7 +4,18 @@
 [![Build Status](https://api.travis-ci.org/plataformatec/responders.png?branch=master)](http://travis-ci.org/plataformatec/responders)
 [![Code Climate](https://codeclimate.com/github/plataformatec/responders.png)](https://codeclimate.com/github/plataformatec/responders)
 
-A set of responders modules to dry up your Rails 3.2+ app.
+A set of responders modules to dry up your Rails 4.2+ app.
+
+## Installation
+
+Add the responders gem to your Gemfile:
+
+    gem "responders"
+
+Update your bundle and run the install generator:
+
+    $ bundle install
+    $ rails g responders:install
 
 ## Responders Types
 
@@ -60,15 +71,27 @@ You can also have embedded HTML. Just create a `_html` scope.
 
 See also the `namespace_lookup` option to search the full hierarchy of possible keys.
 
+### 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.
+
 ### LocationResponder
 
 This responder allows you to use callable objects as the redirect location.
 Useful when you want to use the `respond_with` method with
 a custom route that requires persisted objects, but the validation may fail.
 
+Note: this responder is included by default, and doesn't need to be included
+on the top of your controller (including it will issue a deprecation warning).
+
 ```ruby
 class ThingsController < ApplicationController
-  responders :location, :flash
   respond_to :html
 
   def create
@@ -78,46 +101,25 @@ class ThingsController < ApplicationController
 end
 ```
 
-### 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 to install the 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:
+Responders only provides a set of modules and to use them you have to create your own
+responder. After you run the install command, the following responder will be
+generated in your application:
 
 ```ruby
-# lib/app_responder.rb
+# lib/application_responder.rb
 class AppResponder < ActionController::Responder
   include Responders::FlashResponder
   include Responders::HttpCacheResponder
 end
 ```
 
-And then you need to configure your application to use it:
+Your application also needs to be configured to use it:
 
 ```ruby
 # app/controllers/application_controller.rb
-require "app_responder"
+require "application_responder"
 
 class ApplicationController < ActionController::Base
   self.responder = AppResponder
@@ -125,12 +127,6 @@ class ApplicationController < ActionController::Base
 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
@@ -168,14 +164,14 @@ Now you would see the message "bob@bob.com was successfully created" instead of
 ## 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.
+to use `respond_with` instead of default `respond_to` blocks. From 2.1, you need to explicitly opt-in to use this generator by adding the following to your `config/application.rb`:
+
+    config.app_generators.scaffold_controller :responders_controller
 
 ## Examples
 
 Want more examples ? Check out this blog posts:
 
-* [One in Three: Inherited Resources, Has Scope and Responders](http://blog.plataformatec.com.br/2009/12/one-in-three-inherited-resources-has-scope-and-responders/)
 * [Embracing REST with mind, body and soul](http://blog.plataformatec.com.br/2009/08/embracing-rest-with-mind-body-and-soul/)
 * [Three reasons to love ActionController::Responder](http://weblog.rubyonrails.org/2009/8/31/three-reasons-love-responder/)
 * [My five favorite things about Rails 3](http://www.engineyard.com/blog/2009/my-five-favorite-things-about-rails-3/)

data/lib/action_controller/respond_with.rb

@@ -194,7 +194,7 @@ module ActionController #:nodoc:
       mimes = collect_mimes_from_class_level()
       collector = ActionController::MimeResponds::Collector.new(mimes, request.variant)
       block.call(collector) if block_given?
-      
+
       if format = collector.negotiate_format(request)
         _process_format(format)
         options = resources.size == 1 ? {} : resources.extract_options!
@@ -226,4 +226,4 @@ module ActionController #:nodoc:
       end
     end
   end
-end
+end

data/lib/generators/rails/responders_controller_generator.rb

@@ -15,32 +15,8 @@ module Rails
         end
       end
 
-      def orm_instance_update(params)
-        if orm_instance.respond_to?(:update)
-          orm_instance.update params
-        else
-          orm_instance.update_attributes params
-        end
-      end
-
-      def controller_before_filter
-        if ActionController::Base.respond_to?(:before_action)
-          "before_action"
-        else
-          "before_filter"
-        end
-      end
-
       def attributes_params
-        if strong_parameters_defined?
-          "#{file_name}_params"
-        else
-          "params[:#{file_name}]"
-        end
-      end
-
-      def strong_parameters_defined?
-        defined?(ActionController::StrongParameters)
+        "#{singular_table_name}_params"
       end
     end
   end

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

@@ -1,6 +1,10 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApplicationController
-  <%= controller_before_filter %> :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
 
   respond_to :html
 
@@ -30,7 +34,7 @@ class <%= controller_class_name %>Controller < ApplicationController
   end
 
   def update
-    <%= "flash[:notice] = '#{class_name} was successfully updated.' if " if flash? %>@<%= orm_instance_update(attributes_params) %>
+    <%= "flash[:notice] = '#{class_name} was successfully updated.' if " if flash? %>@<%= orm_instance.update(attributes_params) %>
     respond_with(@<%= singular_table_name %>)
   end
 
@@ -43,7 +47,6 @@ class <%= controller_class_name %>Controller < ApplicationController
     def set_<%= singular_table_name %>
       @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
     end
-    <%- if strong_parameters_defined? -%>
 
     def <%= "#{singular_table_name}_params" %>
       <%- if attributes_names.empty? -%>
@@ -52,6 +55,5 @@ class <%= controller_class_name %>Controller < ApplicationController
       params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
       <%- end -%>
     end
-    <%- end -%>
 end
 <% end -%>

data/lib/generators/responders/install_generator.rb

@@ -18,6 +18,14 @@ end
         RUBY
       end
 
+      def update_application
+        inject_into_class "config/application.rb", "Application", <<-RUBY
+    # Use the responders controller from the responders gem
+    config.app_generators.scaffold_controller :responders_controller
+
+        RUBY
+      end
+
       def update_application_controller
         prepend_file "app/controllers/application_controller.rb", %{require "application_responder"\n\n}
         inject_into_class "app/controllers/application_controller.rb", "ApplicationController", <<-RUBY

data/lib/responders.rb

@@ -19,12 +19,6 @@ module Responders
     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
-      config.generators.scaffold_controller = :responders_controller
-    end
-
     # 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__)

data/lib/responders/location_responder.rb

@@ -1,7 +1,7 @@
 module Responders
   module LocationResponder
     def self.included(_base)
-      ActiveSupport::Deprecation.warn "Responders::LocationResponder is enabled by default, "
+      ActiveSupport::Deprecation.warn "Responders::LocationResponder is enabled by default, " \
                                       "no need to include it", caller
     end
   end

data/lib/responders/version.rb

@@ -1,3 +1,3 @@
 module Responders
-  VERSION = "2.0.2".freeze
+  VERSION = "2.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: responders
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - José Valim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0.alpha
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0.alpha
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'