actionpack 7.1.3 → 7.2.1.1

data/lib/action_controller/metal/testing.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionController
   module Testing
     # Behavior specific to functional tests

data/lib/action_controller/metal/url_for.rb

@@ -1,27 +1,29 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionController
-  # = Action Controller \UrlFor
+  # # Action Controller UrlFor
   #
-  # Includes +url_for+ into the host class. The class has to provide a +RouteSet+ by implementing
-  # the <tt>_routes</tt> method. Otherwise, an exception will be raised.
+  # Includes `url_for` into the host class. The class has to provide a `RouteSet`
+  # by implementing the `_routes` method. Otherwise, an exception will be raised.
   #
-  # In addition to AbstractController::UrlFor, this module accesses the HTTP layer to define
-  # URL options like the +host+. In order to do so, this module requires the host class
-  # to implement +env+ which needs to be Rack-compatible, and +request+ which
-  # returns an ActionDispatch::Request instance.
+  # In addition to AbstractController::UrlFor, this module accesses the HTTP layer
+  # to define URL options like the `host`. In order to do so, this module requires
+  # the host class to implement `env` which needs to be Rack-compatible, and
+  # `request` which returns an ActionDispatch::Request instance.
   #
-  #   class RootUrl
-  #     include ActionController::UrlFor
-  #     include Rails.application.routes.url_helpers
+  #     class RootUrl
+  #       include ActionController::UrlFor
+  #       include Rails.application.routes.url_helpers
   #
-  #     delegate :env, :request, to: :controller
+  #       delegate :env, :request, to: :controller
   #
-  #     def initialize(controller)
-  #       @controller = controller
-  #       @url        = root_path # named route from the application.
+  #       def initialize(controller)
+  #         @controller = controller
+  #         @url        = root_path # named route from the application.
+  #       end
   #     end
-  #   end
   module UrlFor
     extend ActiveSupport::Concern
 

data/lib/action_controller/metal.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/core_ext/array/extract_options"
 require "action_dispatch/middleware/stack"
 
 module ActionController
-  # = Action Controller \MiddlewareStack
+  # # Action Controller MiddlewareStack
   #
-  # Extend ActionDispatch middleware stack to make it aware of options
-  # allowing the following syntax in controllers:
+  # Extend ActionDispatch middleware stack to make it aware of options allowing
+  # the following syntax in controllers:
   #
-  #   class PostsController < ApplicationController
-  #     use AuthenticationMiddleware, except: [:index, :show]
-  #   end
+  #     class PostsController < ApplicationController
+  #       use AuthenticationMiddleware, except: [:index, :show]
+  #     end
   #
   class MiddlewareStack < ActionDispatch::MiddlewareStack # :nodoc:
     class Middleware < ActionDispatch::MiddlewareStack::Middleware # :nodoc:
@@ -60,73 +62,71 @@ module ActionController
       end
   end
 
-  # = Action Controller \Metal
+  # # Action Controller Metal
   #
-  # +ActionController::Metal+ is the simplest possible controller, providing a
+  # `ActionController::Metal` is the simplest possible controller, providing a
   # valid Rack interface without the additional niceties provided by
   # ActionController::Base.
   #
   # A sample metal controller might look like this:
   #
-  #   class HelloController < ActionController::Metal
-  #     def index
-  #       self.response_body = "Hello World!"
+  #     class HelloController < ActionController::Metal
+  #       def index
+  #         self.response_body = "Hello World!"
+  #       end
   #     end
-  #   end
   #
-  # And then to route requests to your metal controller, you would add
-  # something like this to <tt>config/routes.rb</tt>:
+  # And then to route requests to your metal controller, you would add something
+  # like this to `config/routes.rb`:
   #
-  #   get 'hello', to: HelloController.action(:index)
+  #     get 'hello', to: HelloController.action(:index)
   #
-  # The +action+ method returns a valid Rack application for the \Rails
-  # router to dispatch to.
+  # The ::action method returns a valid Rack application for the Rails router to
+  # dispatch to.
   #
-  # == \Rendering \Helpers
+  # ## Rendering Helpers
   #
-  # +ActionController::Metal+ by default provides no utilities for rendering
-  # views, partials, or other responses aside from explicitly calling of
-  # <tt>response_body=</tt>, <tt>content_type=</tt>, and <tt>status=</tt>. To
-  # add the render helpers you're used to having in a normal controller, you
-  # can do the following:
+  # By default, `ActionController::Metal` provides no utilities for rendering
+  # views, partials, or other responses aside from some low-level setters such
+  # as #response_body=, #content_type=, and #status=. To add the render helpers
+  # you're used to having in a normal controller, you can do the following:
   #
-  #   class HelloController < ActionController::Metal
-  #     include AbstractController::Rendering
-  #     include ActionView::Layouts
-  #     append_view_path "#{Rails.root}/app/views"
+  #     class HelloController < ActionController::Metal
+  #       include AbstractController::Rendering
+  #       include ActionView::Layouts
+  #       append_view_path "#{Rails.root}/app/views"
   #
-  #     def index
-  #       render "hello/index"
+  #       def index
+  #         render "hello/index"
+  #       end
   #     end
-  #   end
   #
-  # == Redirection \Helpers
+  # ## Redirection Helpers
   #
   # To add redirection helpers to your metal controller, do the following:
   #
-  #   class HelloController < ActionController::Metal
-  #     include ActionController::Redirecting
-  #     include Rails.application.routes.url_helpers
+  #     class HelloController < ActionController::Metal
+  #       include ActionController::Redirecting
+  #       include Rails.application.routes.url_helpers
   #
-  #     def index
-  #       redirect_to root_url
+  #       def index
+  #         redirect_to root_url
+  #       end
   #     end
-  #   end
   #
-  # == Other \Helpers
-  #
-  # You can refer to the modules included in ActionController::Base to see
-  # other features you can bring into your metal controller.
+  # ## Other Helpers
   #
+  # You can refer to the modules included in ActionController::Base to see other
+  # features you can bring into your metal controller.
   class Metal < AbstractController::Base
     abstract!
 
-    # Returns the last part of the controller's name, underscored, without the ending
-    # <tt>Controller</tt>. For instance, +PostsController+ returns <tt>posts</tt>.
-    # Namespaces are left out, so +Admin::PostsController+ returns <tt>posts</tt> as well.
+    # Returns the last part of the controller's name, underscored, without the
+    # ending `Controller`. For instance, `PostsController` returns `posts`.
+    # Namespaces are left out, so `Admin::PostsController` returns `posts` as well.
     #
-    # ==== Returns
-    # * <tt>string</tt>
+    # #### Returns
+    # *   `string`
     def self.controller_name
       @controller_name ||= (name.demodulize.delete_suffix("Controller").underscore unless anonymous?)
     end
@@ -172,15 +172,40 @@ module ActionController
     ##
     # The ActionDispatch::Request::Session instance for the current request.
     # See further details in the
-    # {Active Controller Session guide}[https://guides.rubyonrails.org/action_controller_overview.html#session].
+    # [Active Controller Session guide](https://guides.rubyonrails.org/action_controller_overview.html#session).
     delegate :session, to: "@_request"
 
     ##
     # Delegates to ActionDispatch::Response#headers.
     delegate :headers, to: "@_response"
 
-    delegate :status=, :location=, :content_type=,
-             :status, :location, :content_type, :media_type, to: "@_response"
+    ##
+    # Delegates to ActionDispatch::Response#status=
+    delegate :status=, to: "@_response"
+
+    ##
+    # Delegates to ActionDispatch::Response#location=
+    delegate :location=, to: "@_response"
+
+    ##
+    # Delegates to ActionDispatch::Response#content_type=
+    delegate :content_type=, to: "@_response"
+
+    ##
+    # Delegates to ActionDispatch::Response#status
+    delegate :status, to: "@_response"
+
+    ##
+    # Delegates to ActionDispatch::Response#location
+    delegate :location, to: "@_response"
+
+    ##
+    # Delegates to ActionDispatch::Response#content_type
+    delegate :content_type, to: "@_response"
+
+    ##
+    # Delegates to ActionDispatch::Response#media_type
+    delegate :media_type, to: "@_response"
 
     def initialize
       @_request = nil
@@ -201,7 +226,7 @@ module ActionController
 
     alias :response_code :status # :nodoc:
 
-    # Basic \url_for that can be overridden for more robust functionality.
+    # Basic `url_for` that can be overridden for more robust functionality.
     def url_for(string)
       string
     end
@@ -238,7 +263,8 @@ module ActionController
       @_response = response
     end
 
-    # Assign the response and mark it as committed. No further processing will occur.
+    # Assign the response and mark it as committed. No further processing will
+    # occur.
     def response=(response)
       set_response!(response)
 
@@ -271,15 +297,15 @@ module ActionController
 
     # The middleware stack used by this controller.
     #
-    # By default uses a variation of ActionDispatch::MiddlewareStack which
-    # allows for the following syntax:
+    # By default uses a variation of ActionDispatch::MiddlewareStack which allows
+    # for the following syntax:
     #
-    #   class PostsController < ApplicationController
-    #     use AuthenticationMiddleware, except: [:index, :show]
-    #   end
+    #     class PostsController < ApplicationController
+    #       use AuthenticationMiddleware, except: [:index, :show]
+    #     end
     #
-    # Read more about {Rails middleware
-    # stack}[https://guides.rubyonrails.org/rails_on_rack.html#action-dispatcher-middleware-stack]
+    # Read more about [Rails middleware stack]
+    # (https://guides.rubyonrails.org/rails_on_rack.html#action-dispatcher-middleware-stack)
     # in the guides.
     def self.middleware
       middleware_stack
@@ -300,8 +326,8 @@ module ActionController
       end
     end
 
-    # Direct dispatch to the controller. Instantiates the controller, then
-    # executes the action named +name+.
+    # Direct dispatch to the controller. Instantiates the controller, then executes
+    # the action named `name`.
     def self.dispatch(name, req, res)
       if middleware_stack.any?
         middleware_stack.build(name) { |env| new.dispatch(name, req, res) }.call req.env

data/lib/action_controller/railtie.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "rails"
 require "action_controller"
 require "action_dispatch/railtie"
@@ -77,6 +79,7 @@ module ActionController
 
         # Configs used in other initializers
         filtered_options = options.except(
+          :default_protect_from_forgery,
           :log_query_tags_around_actions,
           :permit_all_parameters,
           :action_on_unpermitted_parameters,

data/lib/action_controller/railties/helpers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionController
   module Railties
     module Helpers

data/lib/action_controller/renderer.rb

@@ -1,25 +1,28 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionController
-  # = Action Controller \Renderer
+  # # Action Controller Renderer
   #
   # ActionController::Renderer allows you to render arbitrary templates without
   # being inside a controller action.
   #
-  # You can get a renderer instance by calling +renderer+ on a controller class:
+  # You can get a renderer instance by calling `renderer` on a controller class:
   #
-  #   ApplicationController.renderer
-  #   PostsController.renderer
+  #     ApplicationController.renderer
+  #     PostsController.renderer
   #
   # and render a template by calling the #render method:
   #
-  #   ApplicationController.renderer.render template: "posts/show", assigns: { post: Post.first }
-  #   PostsController.renderer.render :show, assigns: { post: Post.first }
+  #     ApplicationController.renderer.render template: "posts/show", assigns: { post: Post.first }
+  #     PostsController.renderer.render :show, assigns: { post: Post.first }
   #
-  # As a shortcut, you can also call +render+ directly on the controller class itself:
+  # As a shortcut, you can also call `render` directly on the controller class
+  # itself:
   #
-  #   ApplicationController.render template: "posts/show", assigns: { post: Post.first }
-  #   PostsController.render :show, assigns: { post: Post.first }
+  #     ApplicationController.render template: "posts/show", assigns: { post: Post.first }
+  #     PostsController.render :show, assigns: { post: Post.first }
   #
   class Renderer
     attr_reader :controller
@@ -64,45 +67,47 @@ module ActionController
 
     # Creates a new renderer using the same controller, but with a new Rack env.
     #
-    #   ApplicationController.renderer.new(method: "post")
+    #     ApplicationController.renderer.new(method: "post")
     #
     def new(env = nil)
       self.class.new controller, env, @defaults
     end
 
-    # Creates a new renderer using the same controller, but with the given
-    # defaults merged on top of the previous defaults.
+    # Creates a new renderer using the same controller, but with the given defaults
+    # merged on top of the previous defaults.
     def with_defaults(defaults)
       self.class.new controller, @env, @defaults.merge(defaults)
     end
 
     # Initializes a new Renderer.
     #
-    # ==== Parameters
+    # #### Parameters
+    #
+    # *   `controller` - The controller class to instantiate for rendering.
+    # *   `env` - The Rack env to use for mocking a request when rendering. Entries
+    #     can be typical Rack env keys and values, or they can be any of the
+    #     following, which will be converted appropriately:
+    #     *   `:http_host` - The HTTP host for the incoming request. Converts to
+    #         Rack's `HTTP_HOST`.
+    #     *   `:https` - Boolean indicating whether the incoming request uses HTTPS.
+    #         Converts to Rack's `HTTPS`.
+    #     *   `:method` - The HTTP method for the incoming request,
+    #         case-insensitive. Converts to Rack's `REQUEST_METHOD`.
+    #     *   `:script_name` - The portion of the incoming request's URL path that
+    #         corresponds to the application. Converts to Rack's `SCRIPT_NAME`.
+    #     *   `:input` - The input stream. Converts to Rack's `rack.input`.
+    #
+    # *   `defaults` - Default values for the Rack env. Entries are specified in the
+    #     same format as `env`. `env` will be merged on top of these values.
+    #     `defaults` will be retained when calling #new on a renderer instance.
     #
-    # * +controller+ - The controller class to instantiate for rendering.
-    # * +env+ - The Rack env to use for mocking a request when rendering.
-    #   Entries can be typical Rack env keys and values, or they can be any of
-    #   the following, which will be converted appropriately:
-    #   * +:http_host+ - The HTTP host for the incoming request. Converts to
-    #     Rack's +HTTP_HOST+.
-    #   * +:https+ - Boolean indicating whether the incoming request uses HTTPS.
-    #     Converts to Rack's +HTTPS+.
-    #   * +:method+ - The HTTP method for the incoming request, case-insensitive.
-    #     Converts to Rack's +REQUEST_METHOD+.
-    #   * +:script_name+ - The portion of the incoming request's URL path that
-    #     corresponds to the application. Converts to Rack's +SCRIPT_NAME+.
-    #   * +:input+ - The input stream. Converts to Rack's +rack.input+.
-    # * +defaults+ - Default values for the Rack env. Entries are specified in
-    #   the same format as +env+. +env+ will be merged on top of these values.
-    #   +defaults+ will be retained when calling #new on a renderer instance.
     #
-    # If no +http_host+ is specified, the env HTTP host will be derived from the
-    # routes' +default_url_options+. In this case, the +https+ boolean and the
-    # +script_name+ will also be derived from +default_url_options+ if they were
-    # not specified. Additionally, the +https+ boolean will fall back to
-    # +Rails.application.config.force_ssl+ if +default_url_options+ does not
-    # specify a +protocol+.
+    # If no `http_host` is specified, the env HTTP host will be derived from the
+    # routes' `default_url_options`. In this case, the `https` boolean and the
+    # `script_name` will also be derived from `default_url_options` if they were not
+    # specified. Additionally, the `https` boolean will fall back to
+    # `Rails.application.config.force_ssl` if `default_url_options` does not specify
+    # a `protocol`.
     def initialize(controller, env, defaults)
       @controller = controller
       @defaults = defaults
@@ -119,7 +124,8 @@ module ActionController
       @defaults
     end
 
-    # Renders a template to a string, just like ActionController::Rendering#render_to_string.
+    # Renders a template to a string, just like
+    # ActionController::Rendering#render_to_string.
     def render(*args)
       request = ActionDispatch::Request.new(env_for_request)
       request.routes = controller._routes

data/lib/action_controller/template_assertions.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionController
   module TemplateAssertions # :nodoc:
     def assert_template(options = {}, message = nil)
       raise NoMethodError,
-        "assert_template has been extracted to a gem. To continue using it,
-        add `gem 'rails-controller-testing'` to your Gemfile."
+        'assert_template has been extracted to a gem. To continue using it,
+        add `gem "rails-controller-testing"` to your Gemfile.'
     end
   end
 end