responders 2.2.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7ba43cee72d6a197eff78818683a01dfe43814d3
-  data.tar.gz: 37ceb10a23ee46f1ec142176eee690c33a98b73d
+SHA256:
+  metadata.gz: 00a016ab308a0960fc75a6dc1d6f8b35b3165fe0edfef25cb3b898631c7c0454
+  data.tar.gz: bf658c0505d528307b5b61b9c1854fa76b50269c7ddedc27f7c3816e588c2a1f
 SHA512:
-  metadata.gz: e198e8715fefd1e87c21d7a52ed255ad51445bdfe2eb83e0e8a5eb8845eae8d3b1e665217ce1ac6f836156abd1d56cff5a2082f48cfb6f44e3cabe875117125f
-  data.tar.gz: c59cbdaf34207e264e7551bdd700f2d9afe200fa29c2a31672d79debce0979853c76ee8ce0500347f5ee8fb19ebf8b86fc270a45add262d06b4d9c43c7c7ae17
+  metadata.gz: 316cf7158bbfede88e505b1b2dfe25cf86ef873f678362da6062d5b4093849a190da2f730265021e7a3613f5a5bb1622553bc423d8850226ee5235083a9cf38b
+  data.tar.gz: 7aa5dbc3ef20b9c7ddafa0d8342067eaccfc2b50231eef76c00cf7c9a5e07703d449110ee4ec8dc4f3dcb9fa7c06472e0635cc3c41d05820a193c9f7445d14e7

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## 3.0.1
+
+* Add support to Ruby 2.7
+
+## 3.0.0
+
+* Remove support for Rails 4.2
+* Remove support for Ruby < 2.4
+
+## 2.4.1
+
+* Add support for Rails 6 beta
+
+## 2.4.0
+
+* `respond_with` now accepts a new kwargs called `:render` which goes straight to the `render`
+   call after an unsuccessful post request. Usefull if for example you need to render a template
+   which is outside of controller's path eg:
+
+   `respond_with resource, render: { template: 'path/to/template' }`
+
+## 2.3.0
+
+* `verify_request_format!` is aliased to `verify_requested_format!` now.
+* Implementing the `interpolation_options` method on your controller is deprecated
+  in favor of naming it `flash_interpolation_options` instead.
+
 ## 2.2.0
 
 * Added the `verify_request_format!` method, that can be used as a `before_action`

data/MIT-LICENSE

@@ -1,4 +1,5 @@
-Copyright 2009-2016 Plataformatec. http://plataformatec.com.br
+Copyright (c) 2020 Rafael França, Carlos Antônio da Silva
+Copyright 2009-2019 Plataformatec. http://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.md

@@ -1,10 +1,10 @@
 # Responders
 
 [![Gem Version](https://fury-badge.herokuapp.com/rb/responders.svg)](http://badge.fury.io/rb/responders)
-[![Build Status](https://api.travis-ci.org/plataformatec/responders.svg?branch=master)](http://travis-ci.org/plataformatec/responders)
-[![Code Climate](https://codeclimate.com/github/plataformatec/responders.svg)](https://codeclimate.com/github/plataformatec/responders)
+[![Build Status](https://api.travis-ci.org/plataformatec/responders.svg?branch=master)](http://travis-ci.org/heartcombo/responders)
+[![Code Climate](https://codeclimate.com/github/plataformatec/responders.svg)](https://codeclimate.com/github/heartcombo/responders)
 
-A set of responders modules to dry up your Rails 4.2+ app.
+A set of responders modules to dry up your Rails app.
 
 ## Installation
 
@@ -160,7 +160,7 @@ end
 
 ## Interpolation Options
 
-You can pass in extra interpolation options for the translation by adding an `interpolation_options` method to your controller:
+You can pass in extra interpolation options for the translation by adding an `flash_interpolation_options` method to your controller:
 
 ```ruby
 class InvitationsController < ApplicationController
@@ -173,25 +173,27 @@ class InvitationsController < ApplicationController
 
   private
 
-  def interpolation_options
+  def flash_interpolation_options
     { resource_name: @invitation.email }
   end
 end
 ```
 
-Now you would see the message "bob@bob.com was successfully created" instead of the default "Invitation was successfully created."
+Now you would see the message `"name@example.com was successfully created"` instead of the default `"Invitation was successfully created."`
 
 ## 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. 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
+```ruby
+config.app_generators.scaffold_controller :responders_controller
+```
 
 ## Failure handling
 
 Responders don't use `valid?` to check for errors in models to figure out if
-the request was successfull or not, and relies on your controllers to call
+the request was successful or not, and relies on your controllers to call
 `save` or `create` to trigger the validations.
 
 ```ruby
@@ -219,16 +221,16 @@ end
 ## Verifying request formats
 
 `respond_with` will raise an `ActionController::UnknownFormat` if the request
-mime type was not configured through the class level `respond_to`, but the
+MIME type was not configured through the class level `respond_to`, but the
 action will still be executed and any side effects (like creating a new record)
 will still occur. To raise the `UnknownFormat` exception before your action
-is invoked you can set the `verify_request_format!` method as a `before_action`
+is invoked you can set the `verify_requested_format!` method as a `before_action`
 on your controller.
 
 ```ruby
 class WidgetsController < ApplicationController
   respond_to :json
-  before_action :verify_request_format!
+  before_action :verify_requested_format!
 
   # POST /widgets.html won't reach the `create` action.
   def create
@@ -241,7 +243,7 @@ end
 
 ## Examples
 
-Want more examples ? Check out this blog posts:
+Want more examples ? Check out these blog posts:
 
 * [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/)
@@ -251,6 +253,6 @@ Want more examples ? Check out this blog posts:
 
 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
+http://github.com/heartcombo/responders/issues
 
-MIT License. Copyright 2009-2016 Plataformatec. http://plataformatec.com.br
+MIT License. Copyright 2020 Rafael França, Carlos Antônio da Silva. Copyright 2009-2019 Plataformatec.

data/lib/action_controller/respond_with.rb

@@ -1,5 +1,7 @@
-require 'active_support/core_ext/array/extract_options'
-require 'action_controller/metal/mime_responds'
+# frozen_string_literal: true
+
+require "active_support/core_ext/array/extract_options"
+require "action_controller/metal/mime_responds"
 
 module ActionController #:nodoc:
   module RespondWith
@@ -37,8 +39,8 @@ module ActionController #:nodoc:
       def respond_to(*mimes)
         options = mimes.extract_options!
 
-        only_actions   = Array(options.delete(:only)).map(&:to_s)
-        except_actions = Array(options.delete(:except)).map(&:to_s)
+        only_actions   = Array(options.delete(:only)).map(&:to_sym)
+        except_actions = Array(options.delete(:except)).map(&:to_sym)
 
         hash = mimes_for_respond_to.dup
         mimes.each do |mime|
@@ -182,11 +184,17 @@ module ActionController #:nodoc:
     # to save a resource, e.g. when automatically rendering <tt>:new</tt>
     # after a post request.
     #
-    # Two additional options are relevant specifically to +respond_with+ -
+    # Three additional options are relevant specifically to +respond_with+ -
     # 1. <tt>:location</tt> - overwrites the default redirect location used after
     #    a successful html +post+ request.
     # 2. <tt>:action</tt> - overwrites the default render action used after an
     #    unsuccessful html +post+ request.
+    # 3. <tt>:render</tt> - allows to pass any options directly to the <tt>:render<tt/>
+    #    call after unsuccessful html +post+ request. Useful if for example you
+    #    need to render a template which is outside of controller's path or you
+    #    want to override the default http <tt>:status</tt> code, e.g.
+    #
+    #    respond_with(resource, render: { template: 'path/to/template', status: 422 })
     def respond_with(*resources, &block)
       if self.class.mimes_for_respond_to.empty?
         raise "In order to use respond_with, first you need to declare the " \
@@ -216,9 +224,9 @@ module ActionController #:nodoc:
     #   class PeopleController < ApplicationController
     #     respond_to :html, :xml, :json
     #
-    #     before_action :verify_request_format!
+    #     before_action :verify_requested_format!
     #   end
-    def verify_request_format!
+    def verify_requested_format!
       mimes = collect_mimes_from_class_level
       collector = ActionController::MimeResponds::Collector.new(mimes, request.variant)
 
@@ -227,10 +235,12 @@ module ActionController #:nodoc:
       end
     end
 
+    alias :verify_request_format! :verify_requested_format!
+
     # Collect mimes declared in the class method respond_to valid for the
     # current action.
     def collect_mimes_from_class_level #:nodoc:
-      action = action_name.to_s
+      action = action_name.to_sym
 
       self.class.mimes_for_respond_to.keys.select do |mime|
         config = self.class.mimes_for_respond_to[mime]

data/lib/action_controller/responder.rb

@@ -1,4 +1,6 @@
-require 'active_support/json'
+# frozen_string_literal: true
+
+require "active_support/json"
 
 module ActionController #:nodoc:
   # Responsible for exposing a resource to different mime requests,
@@ -121,12 +123,12 @@ module ActionController #:nodoc:
     attr_reader :controller, :request, :format, :resource, :resources, :options
 
     DEFAULT_ACTIONS_FOR_VERBS = {
-      :post => :new,
-      :patch => :edit,
-      :put => :edit
+      post: :new,
+      patch: :edit,
+      put: :edit
     }
 
-    def initialize(controller, resources, options={})
+    def initialize(controller, resources, options = {})
       @controller = controller
       @request = @controller.request
       @format = @controller.formats.first
@@ -142,8 +144,8 @@ module ActionController #:nodoc:
       end
     end
 
-    delegate :head, :render, :redirect_to, :to => :controller
-    delegate :get?, :post?, :patch?, :put?, :delete?, :to => :request
+    delegate :head, :render, :redirect_to, to: :controller
+    delegate :get?, :post?, :patch?, :put?, :delete?, to: :request
 
     # Undefine :to_json and :to_yaml since it's defined on Object
     undef_method(:to_json) if method_defined?(:to_json)
@@ -200,7 +202,7 @@ module ActionController #:nodoc:
       if get?
         raise error
       elsif has_errors? && default_action
-        render :action => default_action
+        render rendering_options
       else
         redirect_to navigation_location
       end
@@ -213,7 +215,7 @@ module ActionController #:nodoc:
       if get?
         display resource
       elsif post?
-        display resource, :status => :created, :location => api_location
+        display resource, status: :created, location: api_location
       else
         head :no_content
       end
@@ -256,7 +258,7 @@ module ActionController #:nodoc:
     #
     #   render xml: @user, status: :created
     #
-    def display(resource, given_options={})
+    def display(resource, given_options = {})
       controller.render given_options.merge!(options).merge!(format => resource)
     end
 
@@ -291,11 +293,19 @@ module ActionController #:nodoc:
     end
 
     def json_resource_errors
-      {:errors => resource.errors}
+      { errors: resource.errors }
     end
 
     def response_overridden?
       @default_response.present?
     end
+
+    def rendering_options
+      if options[:render]
+        options[:render]
+      else
+        { action: default_action }
+      end
+    end
   end
 end

data/lib/generators/rails/responders_controller_generator.rb

@@ -1,4 +1,6 @@
-require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+# frozen_string_literal: true
+
+require "rails/generators/rails/scaffold_controller/scaffold_controller_generator"
 
 module Rails
   module Generators

data/lib/generators/responders/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Responders
   module Generators
     class InstallGenerator < Rails::Generators::Base

data/lib/responders.rb

@@ -1,18 +1,20 @@
-require 'action_controller'
-require 'rails/railtie'
+# frozen_string_literal: true
+
+require "action_controller"
+require "rails/railtie"
 
 module ActionController
-  autoload :Responder, 'action_controller/responder'
-  autoload :RespondWith, 'action_controller/respond_with'
+  autoload :Responder, "action_controller/responder"
+  autoload :RespondWith, "action_controller/respond_with"
 end
 
 module Responders
-  autoload :FlashResponder,      'responders/flash_responder'
-  autoload :HttpCacheResponder,  'responders/http_cache_responder'
-  autoload :CollectionResponder, 'responders/collection_responder'
-  autoload :LocationResponder,   'responders/location_responder'
+  autoload :FlashResponder,      "responders/flash_responder"
+  autoload :HttpCacheResponder,  "responders/http_cache_responder"
+  autoload :CollectionResponder, "responders/collection_responder"
+  autoload :LocationResponder,   "responders/location_responder"
 
-  require 'responders/controller_method'
+  require "responders/controller_method"
 
   class Railtie < ::Rails::Railtie
     config.responders = ActiveSupport::OrderedOptions.new
@@ -20,8 +22,8 @@ module Responders
     config.responders.namespace_lookup = false
 
     # 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__)
+    require "active_support/i18n"
+    I18n.load_path << File.expand_path("../responders/locales/en.yml", __FILE__)
 
     initializer "responders.flash_responder" do |app|
       Responders::FlashResponder.flash_keys = app.config.responders.flash_keys

data/lib/responders/collection_responder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Responders
   # This responder modifies your current responder to redirect
   # to the collection page on POST/PUT/DELETE.

data/lib/responders/controller_method.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Responders
   module ControllerMethod
     # Adds the given responders to the current controller's responder, allowing you to cherry-pick
@@ -18,7 +20,8 @@ module Responders
     #
     def responders(*responders)
       self.responder = responders.inject(Class.new(responder)) do |klass, responder|
-        responder = case responder
+        responder = \
+          case responder
           when Module
             responder
           when String, Symbol

data/lib/responders/flash_responder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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
@@ -33,9 +35,9 @@ module Responders
   #         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.
+  # to overwrite `flash_interpolation_options` in your controller.
   #
-  #   def interpolation_options
+  #   def flash_interpolation_options
   #     { :car_brand => @car.brand }
   #   end
   #
@@ -94,7 +96,7 @@ module Responders
       ActionView::Helpers::TagHelper
     )
 
-    def initialize(controller, resources, options={})
+    def initialize(controller, resources, options = {})
       super
       @flash     = options.delete(:flash)
       @notice    = options.delete(:notice)
@@ -126,7 +128,7 @@ module Responders
       return if controller.flash[status].present?
 
       options = mount_i18n_options(status)
-      message = Responders::FlashResponder.helper.t options[:default].shift, options
+      message = Responders::FlashResponder.helper.t options[:default].shift, **options
       set_flash(status, message)
     end
 
@@ -147,34 +149,46 @@ module Responders
     end
 
     def mount_i18n_options(status) #:nodoc:
-      resource_name = if resource.class.respond_to?(:model_name)
-        resource.class.model_name.human
-      else
-        resource.class.name.underscore.humanize
-      end
-
       options = {
-        :default => flash_defaults_by_namespace(status),
-        :resource_name => resource_name,
-        :downcase_resource_name => resource_name.downcase
+        default: flash_defaults_by_namespace(status),
+        resource_name: resource_name,
+        downcase_resource_name: resource_name.downcase
       }
 
-      if controller.respond_to?(:interpolation_options, true)
-        options.merge!(controller.send(:interpolation_options))
+      controller_options = controller_interpolation_options
+      if controller_options
+        options.merge!(controller_options)
       end
 
       options
     end
 
+    def controller_interpolation_options
+      if controller.respond_to?(:flash_interpolation_options, true)
+        controller.send(:flash_interpolation_options)
+      elsif controller.respond_to?(:interpolation_options, true)
+        ActiveSupport::Deprecation.warn("[responders] `#{controller.class}#interpolation_options` is deprecated, please rename it to `flash_interpolation_options`.")
+        controller.send(:interpolation_options)
+      end
+    end
+
+    def resource_name
+      if resource.class.respond_to?(:model_name)
+        resource.class.model_name.human
+      else
+        resource.class.name.underscore.humanize
+      end
+    end
+
     def flash_defaults_by_namespace(status) #:nodoc:
       defaults = []
-      slices   = controller.controller_path.split('/')
+      slices   = controller.controller_path.split("/")
       lookup   = Responders::FlashResponder.namespace_lookup
 
       begin
-        controller_scope = :"flash.#{slices.fill(controller.controller_name, -1).join('.')}.#{controller.action_name}.#{status}"
+        controller_scope = :"flash.#{slices.fill(controller.controller_name, -1).join(".")}.#{controller.action_name}.#{status}"
 
-        actions_scope = lookup ? slices.fill('actions', -1).join('.') : :actions
+        actions_scope = lookup ? slices.fill("actions", -1).join(".") : :actions
         actions_scope = :"flash.#{actions_scope}.#{controller.action_name}.#{status}"
 
         defaults << :"#{controller_scope}_html"

data/lib/responders/http_cache_responder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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
@@ -9,7 +11,7 @@ module Responders
   # the digest of the body.
   #
   module HttpCacheResponder
-    def initialize(controller, resources, options={})
+    def initialize(controller, resources, options = {})
       super
       @http_cache = options.delete(:http_cache)
     end

data/lib/responders/location_responder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Responders
   module LocationResponder
     def self.included(_base)

data/lib/responders/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Responders
-  VERSION = "2.2.0".freeze
+  VERSION = "3.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: responders
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.1
 platform: ruby
 authors:
 - José Valim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,22 +16,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
-    - - "<"
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
 description: A set of Rails responders to dry up your application
-email: contact@plataformatec.com.br
+email: heartcombo@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -43,8 +51,8 @@ files:
 - lib/action_controller/responder.rb
 - lib/generators/rails/USAGE
 - lib/generators/rails/responders_controller_generator.rb
-- lib/generators/rails/templates/api_controller.rb
-- lib/generators/rails/templates/controller.rb
+- lib/generators/rails/templates/api_controller.rb.tt
+- lib/generators/rails/templates/controller.rb.tt
 - lib/generators/responders/install_generator.rb
 - lib/responders.rb
 - lib/responders/collection_responder.rb
@@ -54,7 +62,7 @@ files:
 - lib/responders/locales/en.yml
 - lib/responders/location_responder.rb
 - lib/responders/version.rb
-homepage: http://github.com/plataformatec/responders
+homepage: https://github.com/heartcombo/responders
 licenses:
 - MIT
 metadata: {}
@@ -66,15 +74,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: responders
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A set of Rails responders to dry up your application