actionpack 4.2.10 → 7.2.0.rc1

data/lib/action_controller/base.rb

@@ -1,197 +1,224 @@
-require 'action_view'
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "action_view"
 require "action_controller/log_subscriber"
 require "action_controller/metal/params_wrapper"
 
 module ActionController
-  # Action Controllers are the core of a web request in \Rails. They are made up of one or more actions that are executed
-  # on request and then either it renders a template or redirects to another action. An action is defined as a public method
-  # on the controller, which will automatically be made accessible to the web-server through \Rails Routes.
+  # # Action Controller Base
   #
-  # By default, only the ApplicationController in a \Rails application inherits from <tt>ActionController::Base</tt>. All other
-  # controllers in turn inherit from ApplicationController. This gives you one class to configure things such as
+  # Action Controllers are the core of a web request in Rails. They are made up of
+  # one or more actions that are executed on request and then either it renders a
+  # template or redirects to another action. An action is defined as a public
+  # method on the controller, which will automatically be made accessible to the
+  # web-server through Rails Routes.
+  #
+  # By default, only the ApplicationController in a Rails application inherits
+  # from `ActionController::Base`. All other controllers inherit from
+  # ApplicationController. This gives you one class to configure things such as
   # request forgery protection and filtering of sensitive request parameters.
   #
   # A sample controller could look like this:
   #
-  #   class PostsController < ApplicationController
-  #     def index
-  #       @posts = Post.all
-  #     end
+  #     class PostsController < ApplicationController
+  #       def index
+  #         @posts = Post.all
+  #       end
   #
-  #     def create
-  #       @post = Post.create params[:post]
-  #       redirect_to posts_path
+  #       def create
+  #         @post = Post.create params[:post]
+  #         redirect_to posts_path
+  #       end
   #     end
-  #   end
-  #
-  # Actions, by default, render a template in the <tt>app/views</tt> directory corresponding to the name of the controller and action
-  # after executing code in the action. For example, the +index+ action of the PostsController would render the
-  # template <tt>app/views/posts/index.html.erb</tt> by default after populating the <tt>@posts</tt> instance variable.
   #
-  # Unlike index, the create action will not render a template. After performing its main purpose (creating a
-  # new post), it initiates a redirect instead. This redirect works by returning an external
-  # "302 Moved" HTTP response that takes the user to the index action.
+  # Actions, by default, render a template in the `app/views` directory
+  # corresponding to the name of the controller and action after executing code in
+  # the action. For example, the `index` action of the PostsController would
+  # render the template `app/views/posts/index.html.erb` by default after
+  # populating the `@posts` instance variable.
   #
-  # These two methods represent the two basic action archetypes used in Action Controllers. Get-and-show and do-and-redirect.
-  # Most actions are variations on these themes.
+  # Unlike index, the create action will not render a template. After performing
+  # its main purpose (creating a new post), it initiates a redirect instead. This
+  # redirect works by returning an external `302 Moved` HTTP response that takes
+  # the user to the index action.
   #
-  # == Requests
+  # These two methods represent the two basic action archetypes used in Action
+  # Controllers: Get-and-show and do-and-redirect. Most actions are variations on
+  # these themes.
   #
-  # For every request, the router determines the value of the +controller+ and +action+ keys. These determine which controller
-  # and action are called. The remaining request parameters, the session (if one is available), and the full request with
-  # all the HTTP headers are made available to the action through accessor methods. Then the action is performed.
+  # ## Requests
   #
-  # The full request object is available via the request accessor and is primarily used to query for HTTP headers:
+  # For every request, the router determines the value of the `controller` and
+  # `action` keys. These determine which controller and action are called. The
+  # remaining request parameters, the session (if one is available), and the full
+  # request with all the HTTP headers are made available to the action through
+  # accessor methods. Then the action is performed.
   #
-  #   def server_ip
-  #     location = request.env["REMOTE_ADDR"]
-  #     render plain: "This server hosted at #{location}"
-  #   end
+  # The full request object is available via the request accessor and is primarily
+  # used to query for HTTP headers:
   #
-  # == Parameters
+  #     def server_ip
+  #       location = request.env["REMOTE_ADDR"]
+  #       render plain: "This server hosted at #{location}"
+  #     end
   #
-  # All request parameters, whether they come from a GET or POST request, or from the URL, are available through the params method
-  # which returns a hash. For example, an action that was performed through <tt>/posts?category=All&limit=5</tt> will include
-  # <tt>{ "category" => "All", "limit" => "5" }</tt> in params.
+  # ## Parameters
   #
-  # It's also possible to construct multi-dimensional parameter hashes by specifying keys using brackets, such as:
+  # All request parameters, whether they come from a query string in the URL or
+  # form data submitted through a POST request are available through the `params`
+  # method which returns a hash. For example, an action that was performed through
+  # `/posts?category=All&limit=5` will include `{ "category" => "All", "limit" =>
+  # "5" }` in `params`.
   #
-  #   <input type="text" name="post[name]" value="david">
-  #   <input type="text" name="post[address]" value="hyacintvej">
+  # It's also possible to construct multi-dimensional parameter hashes by
+  # specifying keys using brackets, such as:
   #
-  # A request stemming from a form holding these inputs will include <tt>{ "post" => { "name" => "david", "address" => "hyacintvej" } }</tt>.
-  # If the address input had been named <tt>post[address][street]</tt>, the params would have included
-  # <tt>{ "post" => { "address" => { "street" => "hyacintvej" } } }</tt>. There's no limit to the depth of the nesting.
+  #     <input type="text" name="post[name]" value="david">
+  #     <input type="text" name="post[address]" value="hyacintvej">
   #
-  # == Sessions
+  # A request coming from a form holding these inputs will include `{ "post" => {
+  # "name" => "david", "address" => "hyacintvej" } }`. If the address input had
+  # been named `post[address][street]`, the `params` would have included `{ "post"
+  # => { "address" => { "street" => "hyacintvej" } } }`. There's no limit to the
+  # depth of the nesting.
   #
-  # Sessions allow you to store objects in between requests. This is useful for objects that are not yet ready to be persisted,
-  # such as a Signup object constructed in a multi-paged process, or objects that don't change much and are needed all the time, such
-  # as a User object for a system that requires login. The session should not be used, however, as a cache for objects where it's likely
-  # they could be changed unknowingly. It's usually too much work to keep it all synchronized -- something databases already excel at.
+  # ## Sessions
   #
-  # You can place objects in the session by using the <tt>session</tt> method, which accesses a hash:
+  # Sessions allow you to store objects in between requests. This is useful for
+  # objects that are not yet ready to be persisted, such as a Signup object
+  # constructed in a multi-paged process, or objects that don't change much and
+  # are needed all the time, such as a User object for a system that requires
+  # login. The session should not be used, however, as a cache for objects where
+  # it's likely they could be changed unknowingly. It's usually too much work to
+  # keep it all synchronized -- something databases already excel at.
   #
-  #   session[:person] = Person.authenticate(user_name, password)
+  # You can place objects in the session by using the `session` method, which
+  # accesses a hash:
   #
-  # And retrieved again through the same hash:
+  #     session[:person] = Person.authenticate(user_name, password)
   #
-  #   Hello #{session[:person]}
+  # You can retrieve it again through the same hash:
   #
-  # For removing objects from the session, you can either assign a single key to +nil+:
+  #     "Hello #{session[:person]}"
   #
-  #   # removes :person from session
-  #   session[:person] = nil
+  # For removing objects from the session, you can either assign a single key to
+  # `nil`:
   #
-  # or you can remove the entire session with +reset_session+.
+  #     # removes :person from session
+  #     session[:person] = nil
   #
-  # Sessions are stored by default in a browser cookie that's cryptographically signed, but unencrypted.
-  # This prevents the user from tampering with the session but also allows them to see its contents.
+  # or you can remove the entire session with `reset_session`.
   #
-  # Do not put secret information in cookie-based sessions!
+  # By default, sessions are stored in an encrypted browser cookie (see
+  # ActionDispatch::Session::CookieStore). Thus the user will not be able to read
+  # or edit the session data. However, the user can keep a copy of the cookie even
+  # after it has expired, so you should avoid storing sensitive information in
+  # cookie-based sessions.
   #
-  # == Responses
+  # ## Responses
   #
-  # Each action results in a response, which holds the headers and document to be sent to the user's browser. The actual response
-  # object is generated automatically through the use of renders and redirects and requires no user intervention.
+  # Each action results in a response, which holds the headers and document to be
+  # sent to the user's browser. The actual response object is generated
+  # automatically through the use of renders and redirects and requires no user
+  # intervention.
   #
-  # == Renders
+  # ## Renders
   #
-  # Action Controller sends content to the user by using one of five rendering methods. The most versatile and common is the rendering
-  # of a template. Included in the Action Pack is the Action View, which enables rendering of ERB templates. It's automatically configured.
-  # The controller passes objects to the view by assigning instance variables:
+  # Action Controller sends content to the user by using one of five rendering
+  # methods. The most versatile and common is the rendering of a template.
+  # Included in the Action Pack is the Action View, which enables rendering of ERB
+  # templates. It's automatically configured. The controller passes objects to the
+  # view by assigning instance variables:
   #
-  #   def show
-  #     @post = Post.find(params[:id])
-  #   end
+  #     def show
+  #       @post = Post.find(params[:id])
+  #     end
   #
   # Which are then automatically available to the view:
   #
-  #   Title: <%= @post.title %>
+  #     Title: <%= @post.title %>
   #
-  # You don't have to rely on the automated rendering. For example, actions that could result in the rendering of different templates
-  # will use the manual rendering methods:
+  # You don't have to rely on the automated rendering. For example, actions that
+  # could result in the rendering of different templates will use the manual
+  # rendering methods:
   #
-  #   def search
-  #     @results = Search.find(params[:query])
-  #     case @results.count
-  #       when 0 then render action: "no_results"
-  #       when 1 then render action: "show"
-  #       when 2..10 then render action: "show_many"
+  #     def search
+  #       @results = Search.find(params[:query])
+  #       case @results.count
+  #         when 0 then render action: "no_results"
+  #         when 1 then render action: "show"
+  #         when 2..10 then render action: "show_many"
+  #       end
   #     end
-  #   end
   #
   # Read more about writing ERB and Builder templates in ActionView::Base.
   #
-  # == Redirects
+  # ## Redirects
   #
-  # Redirects are used to move from one action to another. For example, after a <tt>create</tt> action, which stores a blog entry to the
-  # database, we might like to show the user the new entry. Because we're following good DRY principles (Don't Repeat Yourself), we're
-  # going to reuse (and redirect to) a <tt>show</tt> action that we'll assume has already been created. The code might look like this:
+  # Redirects are used to move from one action to another. For example, after a
+  # `create` action, which stores a blog entry to the database, we might like to
+  # show the user the new entry. Because we're following good DRY principles
+  # (Don't Repeat Yourself), we're going to reuse (and redirect to) a `show`
+  # action that we'll assume has already been created. The code might look like
+  # this:
   #
-  #   def create
-  #     @entry = Entry.new(params[:entry])
-  #     if @entry.save
-  #       # The entry was saved correctly, redirect to show
-  #       redirect_to action: 'show', id: @entry.id
-  #     else
-  #       # things didn't go so well, do something else
+  #     def create
+  #       @entry = Entry.new(params[:entry])
+  #       if @entry.save
+  #         # The entry was saved correctly, redirect to show
+  #         redirect_to action: 'show', id: @entry.id
+  #       else
+  #         # things didn't go so well, do something else
+  #       end
   #     end
-  #   end
   #
-  # In this case, after saving our new entry to the database, the user is redirected to the <tt>show</tt> method, which is then executed.
-  # Note that this is an external HTTP-level redirection which will cause the browser to make a second request (a GET to the show action),
-  # and not some internal re-routing which calls both "create" and then "show" within one request.
+  # In this case, after saving our new entry to the database, the user is
+  # redirected to the `show` method, which is then executed. Note that this is an
+  # external HTTP-level redirection which will cause the browser to make a second
+  # request (a GET to the show action), and not some internal re-routing which
+  # calls both "create" and then "show" within one request.
   #
-  # Learn more about <tt>redirect_to</tt> and what options you have in ActionController::Redirecting.
+  # Learn more about `redirect_to` and what options you have in
+  # ActionController::Redirecting.
   #
-  # == Calling multiple redirects or renders
+  # ## Calling multiple redirects or renders
   #
-  # An action may contain only a single render or a single redirect. Attempting to try to do either again will result in a DoubleRenderError:
+  # An action may perform only a single render or a single redirect. Attempting to
+  # do either again will result in a DoubleRenderError:
   #
-  #   def do_something
-  #     redirect_to action: "elsewhere"
-  #     render action: "overthere" # raises DoubleRenderError
-  #   end
+  #     def do_something
+  #       redirect_to action: "elsewhere"
+  #       render action: "overthere" # raises DoubleRenderError
+  #     end
   #
-  # If you need to redirect on the condition of something, then be sure to add "and return" to halt execution.
+  # If you need to redirect on the condition of something, then be sure to add
+  # "return" to halt execution.
   #
-  #   def do_something
-  #     redirect_to(action: "elsewhere") and return if monkeys.nil?
-  #     render action: "overthere" # won't be called if monkeys is nil
-  #   end
+  #     def do_something
+  #       if monkeys.nil?
+  #         redirect_to(action: "elsewhere")
+  #         return
+  #       end
+  #       render action: "overthere" # won't be called if monkeys is nil
+  #     end
   #
   class Base < Metal
     abstract!
 
-    # We document the request and response methods here because albeit they are
-    # implemented in ActionController::Metal, the type of the returned objects
-    # is unknown at that level.
-
-    ##
-    # :method: request
-    #
-    # Returns an ActionDispatch::Request instance that represents the
-    # current request.
-
-    ##
-    # :method: response
-    #
-    # Returns an ActionDispatch::Response that represents the current
-    # response.
-
     # Shortcut helper that returns all the modules included in
     # ActionController::Base except the ones passed as arguments:
     #
-    #   class MyBaseController < ActionController::Metal
-    #     ActionController::Base.without_modules(:ParamsWrapper, :Streaming).each do |left|
-    #       include left
+    #     class MyBaseController < ActionController::Metal
+    #       ActionController::Base.without_modules(:ParamsWrapper, :Streaming).each do |left|
+    #         include left
+    #       end
     #     end
-    #   end
     #
-    # This gives better control over what you want to exclude and makes it
-    # easier to create a bare controller class, instead of listing the modules
-    # required manually.
+    # This gives better control over what you want to exclude and makes it easier to
+    # create a bare controller class, instead of listing the modules required
+    # manually.
     def self.without_modules(*modules)
       modules = modules.map do |m|
         m.is_a?(Symbol) ? ActionController.const_get(m) : m
@@ -204,9 +231,7 @@ module ActionController
       AbstractController::Rendering,
       AbstractController::Translation,
       AbstractController::AssetPaths,
-
       Helpers,
-      HideActions,
       UrlFor,
       Redirecting,
       ActionView::Layouts,
@@ -214,55 +239,94 @@ module ActionController
       Renderers::All,
       ConditionalGet,
       EtagWithTemplateDigest,
-      RackDelegation,
+      EtagWithFlash,
       Caching,
       MimeResponds,
       ImplicitRender,
       StrongParameters,
-
+      ParameterEncoding,
       Cookies,
       Flash,
+      FormBuilder,
       RequestForgeryProtection,
-      ForceSSL,
+      ContentSecurityPolicy,
+      PermissionsPolicy,
+      RateLimiting,
+      AllowBrowser,
       Streaming,
       DataStreaming,
       HttpAuthentication::Basic::ControllerMethods,
       HttpAuthentication::Digest::ControllerMethods,
       HttpAuthentication::Token::ControllerMethods,
-
-      # Before callbacks should also be executed the earliest as possible, so
-      # also include them at the bottom.
+      DefaultHeaders,
+      Logging,
       AbstractController::Callbacks,
-
-      # Append rescue at the bottom to wrap as much as possible.
       Rescue,
-
-      # Add instrumentations hooks at the bottom, to ensure they instrument
-      # all the methods properly.
       Instrumentation,
-
-      # Params wrapper should come before instrumentation so they are
-      # properly showed in logs
       ParamsWrapper
     ]
 
-    MODULES.each do |mod|
-      include mod
-    end
+    # Note: Documenting these severely degrates the performance of rdoc
+    # :stopdoc:
+    include AbstractController::Rendering
+    include AbstractController::Translation
+    include AbstractController::AssetPaths
+    include Helpers
+    include UrlFor
+    include Redirecting
+    include ActionView::Layouts
+    include Rendering
+    include Renderers::All
+    include ConditionalGet
+    include EtagWithTemplateDigest
+    include EtagWithFlash
+    include Caching
+    include MimeResponds
+    include ImplicitRender
+    include StrongParameters
+    include ParameterEncoding
+    include Cookies
+    include Flash
+    include FormBuilder
+    include RequestForgeryProtection
+    include ContentSecurityPolicy
+    include PermissionsPolicy
+    include RateLimiting
+    include AllowBrowser
+    include Streaming
+    include DataStreaming
+    include HttpAuthentication::Basic::ControllerMethods
+    include HttpAuthentication::Digest::ControllerMethods
+    include HttpAuthentication::Token::ControllerMethods
+    include DefaultHeaders
+    include Logging
+    # Before callbacks should also be executed as early as possible, so also include
+    # them at the bottom.
+    include AbstractController::Callbacks
+    # Append rescue at the bottom to wrap as much as possible.
+    include Rescue
+    # Add instrumentations hooks at the bottom, to ensure they instrument all the
+    # methods properly.
+    include Instrumentation
+    # Params wrapper should come before instrumentation so they are properly showed
+    # in logs
+    include ParamsWrapper
+    # :startdoc:
+    setup_renderer!
 
     # Define some internal variables that should not be propagated to the view.
-    PROTECTED_IVARS = AbstractController::Rendering::DEFAULT_PROTECTED_INSTANCE_VARIABLES + [
-      :@_status, :@_headers, :@_params, :@_env, :@_response, :@_request,
-      :@_view_runtime, :@_stream, :@_url_options, :@_action_has_layout ]
-
-    def _protected_ivars # :nodoc:
-      PROTECTED_IVARS
-    end
+    PROTECTED_IVARS = AbstractController::Rendering::DEFAULT_PROTECTED_INSTANCE_VARIABLES + %i(
+      @_params @_response @_request @_config @_url_options @_action_has_layout @_view_context_class
+      @_view_renderer @_lookup_context @_routes @_view_runtime @_db_runtime @_helper_proxy
+      @_marked_for_same_origin_verification @_rendered_format
+    )
 
-    def self.protected_instance_variables
+    def _protected_ivars
       PROTECTED_IVARS
     end
+    private :_protected_ivars
 
+    ActiveSupport.run_load_hooks(:action_controller_base, self)
     ActiveSupport.run_load_hooks(:action_controller, self)
   end
 end

data/lib/action_controller/caching.rb

@@ -1,89 +1,49 @@
-require 'fileutils'
-require 'uri'
-require 'set'
+# frozen_string_literal: true
+
+# :markup: markdown
 
 module ActionController
-  # \Caching is a cheap way of speeding up slow applications by keeping the result of
-  # calculations, renderings, and database calls around for subsequent requests.
+  # # Action Controller Caching
+  #
+  # Caching is a cheap way of speeding up slow applications by keeping the result
+  # of calculations, renderings, and database calls around for subsequent
+  # requests.
   #
   # You can read more about each approach by clicking the modules below.
   #
-  # Note: To turn off all caching, set
-  #   config.action_controller.perform_caching = false
+  # Note: To turn off all caching provided by Action Controller, set
+  #     config.action_controller.perform_caching = false
   #
-  # == \Caching stores
+  # ## Caching stores
   #
-  # All the caching stores from ActiveSupport::Cache are available to be used as backends
-  # for Action Controller caching.
+  # All the caching stores from ActiveSupport::Cache are available to be used as
+  # backends for Action Controller caching.
   #
   # Configuration examples (FileStore is the default):
   #
-  #   config.action_controller.cache_store = :memory_store
-  #   config.action_controller.cache_store = :file_store, '/path/to/cache/directory'
-  #   config.action_controller.cache_store = :mem_cache_store, 'localhost'
-  #   config.action_controller.cache_store = :mem_cache_store, Memcached::Rails.new('localhost:11211')
-  #   config.action_controller.cache_store = MyOwnStore.new('parameter')
+  #     config.action_controller.cache_store = :memory_store
+  #     config.action_controller.cache_store = :file_store, '/path/to/cache/directory'
+  #     config.action_controller.cache_store = :mem_cache_store, 'localhost'
+  #     config.action_controller.cache_store = :mem_cache_store, Memcached::Rails.new('localhost:11211')
+  #     config.action_controller.cache_store = MyOwnStore.new('parameter')
   module Caching
     extend ActiveSupport::Concern
-    extend ActiveSupport::Autoload
-
-    eager_autoload do
-      autoload :Fragments
-    end
-
-    module ConfigMethods
-      def cache_store
-        config.cache_store
-      end
-
-      def cache_store=(store)
-        config.cache_store = ActiveSupport::Cache.lookup_store(store)
-      end
-
-      private
-        def cache_configured?
-          perform_caching && cache_store
-        end
-    end
-
-    include RackDelegation
-    include AbstractController::Callbacks
-
-    include ConfigMethods
-    include Fragments
 
     included do
-      extend ConfigMethods
-
-      config_accessor :default_static_extension
-      self.default_static_extension ||= '.html'
-
-      config_accessor :perform_caching
-      self.perform_caching = true if perform_caching.nil?
-
-      class_attribute :_view_cache_dependencies
-      self._view_cache_dependencies = []
-      helper_method :view_cache_dependencies if respond_to?(:helper_method)
+      include AbstractController::Caching
     end
 
-    module ClassMethods
-      def view_cache_dependency(&dependency)
-        self._view_cache_dependencies += [dependency]
+    private
+      def instrument_payload(key)
+        {
+          controller: controller_name,
+          action: action_name,
+          key: key
+        }
       end
-    end
-
-    def view_cache_dependencies
-      self.class._view_cache_dependencies.map { |dep| instance_exec(&dep) }.compact
-    end
 
-    protected
-      # Convenience accessor.
-      def cache(key, options = {}, &block)
-        if cache_configured?
-          cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &block)
-        else
-          yield
-        end
+      def instrument_name
+        "action_controller"
       end
   end
 end

data/lib/action_controller/deprecator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module ActionController
+  def self.deprecator # :nodoc:
+    AbstractController.deprecator
+  end
+end