responders 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e208731d0352ee25ec32e97623939136d0008e8591f7017e31723d33196001d
-  data.tar.gz: 7983c8e1faea117019ea9166714725947cb9770d0c2e208e70dbdca5b3346595
+  metadata.gz: bbd11b54b7dff0d570ff0231c4947ef6c086e75eec2939a6b96d4ebb65bc40f1
+  data.tar.gz: 5f6df15df62211cdc47025a70f4037a493dc1d679aa2a6a5a834d90135b07de1
 SHA512:
-  metadata.gz: f6be9a9d459b573d73e83329a4443bb8e02e353ab3f9fa11c0004ff4dd9c8d073847dd936b4308095236312a1468007f09a04f963fd544a244f2ad7c566412f3
-  data.tar.gz: 6a7bd98426677b71939e1fa1d373ccbb014fd0c25b9f986e2540b9dc76c9ff7307b727bf20034e1fb51e9df45dd070102deb3badefe79f78738426fb3fd06dc9
+  metadata.gz: 62f893c63385f0d2de498143a4bcf0dafde98ef920778e5115af3d7b14f2d4c7dcdae08712193db9543e205e9830e307758b702970fe2480e7ccc322e8a81c38
+  data.tar.gz: 888a7bae0e92cdbdd8037f5cbfde45d09ec23d528d783aa11ac436bf21992aae7c63252285161a42513fb9c7dbb1ab4abf45b6371cadebfe9efd05bb2175d8e7

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## Unreleased
+
+
+## 3.1.0
+
+* Add config `responders.redirect_status` to allow overriding the redirect code/status used in redirects. The default is `302 Found`, which matches Rails, but it allows to change responders to redirect with `303 See Other` for example, to make it more compatible with how Hotwire/Turbo expects redirects to work.
+* Add config `responders.error_status` to allow overriding the status code used to respond to `HTML` or `JS` requests that have errors on the resource. The default is `200 OK`, but it allows to change the response to be `422 Unprocessable Entity` in such cases for example, which makes it more consistent with other statuses more commonly used in APIs (like JSON/XML), and works by default with Turbo/Hotwire which expects a 422 on form error HTML responses. Note that changing this may break your application if you're relying on the previous 2xx status to handle error cases.
+* Add support for Ruby 3.0, 3.1, and 3.2, drop support for Ruby < 2.5.
+* Add support for Rails 6.1 and 7.0, drop support for Rails < 5.2.
+* Move CI to GitHub Actions.
+
+## 3.0.1
+
+* Add support to Ruby 2.7
+
 ## 3.0.0
 
 * Remove support for Rails 4.2
@@ -9,8 +24,8 @@
 
 ## 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
+* `respond_with` now accepts a new kwarg called `:render` which goes straight to the `render`
+   call after an unsuccessful post request. Useful 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' }`

data/MIT-LICENSE

@@ -1,3 +1,4 @@
+Copyright (c) 2020-2022 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

data/README.md

@@ -1,10 +1,8 @@
 # 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)
 
-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
 
@@ -179,19 +177,21 @@ class InvitationsController < ApplicationController
 end
 ```
 
-Now you would see the message "name@example.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
@@ -211,7 +211,8 @@ assertions on this behavior for your controllers.
 def create
   @widget = Widget.new(widget_params)
   @widget.errors.add(:base, :invalid)
-  # `respond_with` will render the `new` template again.
+  # `respond_with` will render the `new` template again,
+  # and set the status based on the configured `error_status`.
   respond_with @widget
 end
 ```
@@ -219,7 +220,7 @@ 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_requested_format!` method as a `before_action`
@@ -236,9 +237,37 @@ class WidgetsController < ApplicationController
     respond_with widget
   end
 end
+```
+
+## Configuring error and redirect statuses
+
+By default, `respond_with` will respond to errors on `HTML` & `JS` requests using the HTTP status code `200 OK`,
+and perform redirects using the HTTP status code `302 Found`, both for backwards compatibility reasons.
+
+You can configure this behavior by setting `config.responders.error_status` and `config.responders.redirect_status` to the desired status codes.
 
+```ruby
+config.responders.error_status = :unprocessable_entity
+config.responders.redirect_status = :see_other
 ```
 
+These can also be set in your custom `ApplicationResponder` if you have generated one: (see install instructions)
+
+```ruby
+class ApplicationResponder < ActionController::Responder
+  self.error_status = :unprocessable_entity
+  self.redirect_status = :see_other
+end
+```
+
+_Note_: the application responder generated for new apps already configures a different set of defaults: `422 Unprocessable Entity` for errors, and `303 See Other` for redirects. _Responders may change the defaults to match these in a future major release._
+
+### Hotwire/Turbo and fetch APIs
+
+Hotwire/Turbo expects successful redirects after form submissions to respond with HTTP status `303 See Other`, and error responses to be 4xx or 5xx statuses, for example `422 Unprocessable Entity` for displaying form validation errors and `500 Internal Server Error` for other server errors. [Turbo documentation: Redirecting After a Form Submission](https://turbo.hotwired.dev/handbook/drive#redirecting-after-a-form-submission).
+
+The example configuration showed above matches the statuses that better integrate with Hotwire/Turbo.
+
 ## Examples
 
 Want more examples ? Check out these blog posts:
@@ -247,10 +276,15 @@ Want more examples ? Check out these blog posts:
 * [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)
 
+## Supported Ruby / Rails versions
+
+We intend to maintain support for all Ruby / Rails versions that haven't reached end-of-life.
+
+For more information about specific versions please check [Ruby](https://www.ruby-lang.org/en/downloads/branches/)
+and [Rails](https://guides.rubyonrails.org/maintenance_policy.html) maintenance policies, and our test matrix.
+
 ## 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-2019 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

@@ -3,7 +3,7 @@
 require "active_support/core_ext/array/extract_options"
 require "action_controller/metal/mime_responds"
 
-module ActionController #:nodoc:
+module ActionController # :nodoc:
   module RespondWith
     extend ActiveSupport::Concern
 
@@ -95,7 +95,10 @@ module ActionController #:nodoc:
     #      i.e. its +show+ action.
     #   2. If there are validation errors, the response
     #      renders a default action, which is <tt>:new</tt> for a
-    #      +post+ request or <tt>:edit</tt> for +patch+ or +put+.
+    #      +post+ request or <tt>:edit</tt> for +patch+ or +put+,
+    #      and the status is set based on the configured `error_status`.
+    #      (defaults to `422 Unprocessable Entity` on new apps,
+    #       `200 OK` for compatibility reasons on old apps.)
     #   Thus an example like this -
     #
     #     respond_to :html, :xml
@@ -116,8 +119,8 @@ module ActionController #:nodoc:
     #           format.html { redirect_to(@user) }
     #           format.xml { render xml: @user }
     #         else
-    #           format.html { render action: "new" }
-    #           format.xml { render xml: @user }
+    #           format.html { render action: "new", status: :unprocessable_entity }
+    #           format.xml { render xml: @user, status: :unprocessable_entity }
     #         end
     #       end
     #     end
@@ -190,11 +193,11 @@ module ActionController #:nodoc:
     # 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. Usefull if for example you
+    #    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 })
+    #    respond_with(resource, render: { template: 'path/to/template', status: 418 })
     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 " \
@@ -239,7 +242,7 @@ module ActionController #:nodoc:
 
     # Collect mimes declared in the class method respond_to valid for the
     # current action.
-    def collect_mimes_from_class_level #:nodoc:
+    def collect_mimes_from_class_level # :nodoc:
       action = action_name.to_sym
 
       self.class.mimes_for_respond_to.keys.select do |mime|

data/lib/action_controller/responder.rb

@@ -2,7 +2,7 @@
 
 require "active_support/json"
 
-module ActionController #:nodoc:
+module ActionController # :nodoc:
   # Responsible for exposing a resource to different mime requests,
   # usually depending on the HTTP verb. The responder is triggered when
   # <code>respond_with</code> is called. The simplest case to study is a GET request:
@@ -49,7 +49,7 @@ module ActionController #:nodoc:
   #         format.html { redirect_to(@user) }
   #         format.xml { render xml: @user, status: :created, location: @user }
   #       else
-  #         format.html { render action: "new" }
+  #         format.html { render action: "new", status: :unprocessable_entity }
   #         format.xml { render xml: @user.errors, status: :unprocessable_entity }
   #       end
   #     end
@@ -113,13 +113,16 @@ module ActionController #:nodoc:
   #       if @task.save
   #         flash[:notice] = 'Task was successfully created.'
   #       else
-  #         format.html { render "some_special_template" }
+  #         format.html { render "some_special_template", status: :unprocessable_entity }
   #       end
   #     end
   #   end
   #
   # Using <code>respond_with</code> with a block follows the same syntax as <code>respond_to</code>.
   class Responder
+    class_attribute :error_status, default: :ok, instance_writer: false, instance_predicate: false
+    class_attribute :redirect_status, default: :found, instance_writer: false, instance_predicate: false
+
     attr_reader :controller, :request, :format, :resource, :resources, :options
 
     DEFAULT_ACTIONS_FOR_VERBS = {
@@ -202,9 +205,9 @@ module ActionController #:nodoc:
       if get?
         raise error
       elsif has_errors? && default_action
-        render rendering_options
+        render error_rendering_options
       else
-        redirect_to navigation_location
+        redirect_to navigation_location, status: redirect_status
       end
     end
 
@@ -236,6 +239,8 @@ module ActionController #:nodoc:
     def default_render
       if @default_response
         @default_response.call(options)
+      elsif !get? && has_errors?
+        controller.render({ status: error_status }.merge!(options))
       else
         controller.render(options)
       end
@@ -263,6 +268,8 @@ module ActionController #:nodoc:
     end
 
     def display_errors
+      # TODO: use `error_status` once we switch the default to be `unprocessable_entity`,
+      # otherwise we'd be changing this behavior here now.
       controller.render format => resource_errors, :status => :unprocessable_entity
     end
 
@@ -300,11 +307,11 @@ module ActionController #:nodoc:
       @default_response.present?
     end
 
-    def rendering_options
+    def error_rendering_options
       if options[:render]
         options[:render]
       else
-        { action: default_action }
+        { action: default_action, status: error_status }
       end
     end
   end

data/lib/generators/responders/install_generator.rb

@@ -8,15 +8,19 @@ module Responders
       desc "Creates an initializer with default responder configuration and copy locale file"
 
       def create_responder_file
-        create_file "lib/application_responder.rb", <<-RUBY
-class ApplicationResponder < ActionController::Responder
-  include Responders::FlashResponder
-  include Responders::HttpCacheResponder
-
-  # Redirects resources to the collection path (index action) instead
-  # of the resource path (show action) for POST/PUT/DELETE requests.
-  # include Responders::CollectionResponder
-end
+        create_file "lib/application_responder.rb", <<~RUBY
+          class ApplicationResponder < ActionController::Responder
+            include Responders::FlashResponder
+            include Responders::HttpCacheResponder
+
+            # Redirects resources to the collection path (index action) instead
+            # of the resource path (show action) for POST/PUT/DELETE requests.
+            # include Responders::CollectionResponder
+
+            # Configure default status codes for responding to errors and redirects.
+            self.error_status = :unprocessable_entity
+            self.redirect_status = :see_other
+          end
         RUBY
       end
 

data/lib/responders/collection_responder.rb

@@ -20,6 +20,7 @@ module Responders
     #
     def navigation_location
       return options[:location] if options[:location]
+
       klass = resources.last.class
 
       if klass.respond_to?(:model_name)

data/lib/responders/controller_method.rb

@@ -37,6 +37,6 @@ module Responders
   end
 end
 
-ActiveSupport.on_load(:action_controller) do
+ActiveSupport.on_load(:action_controller_base) do
   ActionController::Base.extend Responders::ControllerMethod
 end

data/lib/responders/flash_responder.rb

@@ -72,7 +72,7 @@ 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.
+  # * :flash_now - Sets the flash message using flash.now. Accepts true, :on_failure or :on_success.
   #
   # == Configure status keys
   #
@@ -86,15 +86,11 @@ module Responders
   #
   module FlashResponder
     class << self
-      attr_accessor :flash_keys, :namespace_lookup, :helper
+      attr_accessor :flash_keys, :namespace_lookup
     end
 
     self.flash_keys = [ :notice, :alert ]
     self.namespace_lookup = false
-    self.helper = Object.new.extend(
-      ActionView::Helpers::TranslationHelper,
-      ActionView::Helpers::TagHelper
-    )
 
     def initialize(controller, resources, options = {})
       super
@@ -128,7 +124,7 @@ module Responders
       return if controller.flash[status].present?
 
       options = mount_i18n_options(status)
-      message = Responders::FlashResponder.helper.t options[:default].shift, options
+      message = controller.helpers.t options[:default].shift, **options
       set_flash(status, message)
     end
 
@@ -144,11 +140,11 @@ module Responders
         (default_action && (has_errors? ? @flash_now == :on_failure : @flash_now == :on_success))
     end
 
-    def set_flash_message? #:nodoc:
+    def set_flash_message? # :nodoc:
       !get? && @flash != false
     end
 
-    def mount_i18n_options(status) #:nodoc:
+    def mount_i18n_options(status) # :nodoc:
       options = {
         default: flash_defaults_by_namespace(status),
         resource_name: resource_name,
@@ -164,12 +160,7 @@ module Responders
     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
+      controller.send(:flash_interpolation_options) if controller.respond_to?(:flash_interpolation_options, true)
     end
 
     def resource_name
@@ -180,7 +171,7 @@ module Responders
       end
     end
 
-    def flash_defaults_by_namespace(status) #:nodoc:
+    def flash_defaults_by_namespace(status) # :nodoc:
       defaults = []
       slices   = controller.controller_path.split("/")
       lookup   = Responders::FlashResponder.namespace_lookup

data/lib/responders/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Responders
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/lib/responders.rb

@@ -12,7 +12,6 @@ module Responders
   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"
 
@@ -20,6 +19,8 @@ module Responders
     config.responders = ActiveSupport::OrderedOptions.new
     config.responders.flash_keys = [:notice, :alert]
     config.responders.namespace_lookup = false
+    config.responders.error_status = :ok
+    config.responders.redirect_status = :found
 
     # Add load paths straight to I18n, so engines and application can overwrite it.
     require "active_support/i18n"
@@ -28,6 +29,8 @@ module Responders
     initializer "responders.flash_responder" do |app|
       Responders::FlashResponder.flash_keys = app.config.responders.flash_keys
       Responders::FlashResponder.namespace_lookup = app.config.responders.namespace_lookup
+      ActionController::Responder.error_status = app.config.responders.error_status
+      ActionController::Responder.redirect_status = app.config.responders.redirect_status
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: responders
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - José Valim
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,30 +16,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 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: []
@@ -60,13 +60,16 @@ files:
 - lib/responders/flash_responder.rb
 - lib/responders/http_cache_responder.rb
 - lib/responders/locales/en.yml
-- lib/responders/location_responder.rb
 - lib/responders/version.rb
-homepage: https://github.com/plataformatec/responders
+homepage: https://github.com/heartcombo/responders
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/heartcombo/responders
+  changelog_uri: https://github.com/heartcombo/responders/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/heartcombo/responders
+  bug_tracker_uri: https://github.com/heartcombo/responders/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,15 +77,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.4.5
+signing_key:
 specification_version: 4
 summary: A set of Rails responders to dry up your application
 test_files: []

data/lib/responders/location_responder.rb

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