actionpack 3.2.22.5 → 5.2.4

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2004-2011 David Heinemeier Hansson
+Copyright (c) 2004-2018 David Heinemeier Hansson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -10,332 +10,48 @@ It consists of several modules:
 
 * Action Dispatch, which parses information about the web request, handles
   routing as defined by the user, and does advanced processing related to HTTP
-  such as MIME-type negotiation, decoding parameters in POST/PUT bodies,
+  such as MIME-type negotiation, decoding parameters in POST, PATCH, or PUT bodies,
   handling HTTP caching logic, cookies and sessions.
 
 * Action Controller, which provides a base controller class that can be
   subclassed to implement filters and actions to handle requests. The result
   of an action is typically content generated from views.
 
-* Action View, which handles view template lookup and rendering, and provides
-  view helpers that assist when building HTML forms, Atom feeds and more.
-  Template formats that Action View handles are ERB (embedded Ruby, typically
-  used to inline short Ruby snippets inside HTML), and XML Builder.
-
 With the Ruby on Rails framework, users only directly interface with the
 Action Controller module. Necessary Action Dispatch functionality is activated
 by default and Action View rendering is implicitly triggered by Action
 Controller. However, these modules are designed to function on their own and
 can be used outside of Rails.
 
-A short rundown of some of the major features:
-
-* Actions grouped in controller as methods instead of separate command objects
-  and can therefore share helper methods
-
-    class CustomersController < ActionController::Base
-      def show
-        @customer = find_customer
-      end
-
-      def update
-        @customer = find_customer
-        if @customer.update_attributes(params[:customer])
-          redirect_to :action => "show"
-        else
-          render :action => "edit"
-        end
-      end
-
-      private
-        def find_customer
-          Customer.find params[:id]
-        end
-    end
-
-  {Learn more}[link:classes/ActionController/Base.html]
-
-
-* ERB templates (static content mixed with dynamic output from ruby)
-
-    <% @posts.each do |post| %>
-      Title: <%= post.title %>
-    <% end %>
-
-    All post titles: <%= @posts.collect{ |p| p.title }.join(", ") %>
-
-    <% unless @person.is_client? %>
-      Not for clients to see...
-    <% end %>
-
-  {Learn more}[link:classes/ActionView.html]
-
-
-* "Builder" templates (great for XML content, like RSS)
-
-    xml.rss("version" => "2.0") do
-      xml.channel do
-        xml.title(@feed_title)
-        xml.link(@url)
-        xml.description "Basecamp: Recent items"
-        xml.language "en-us"
-        xml.ttl "40"
-
-        @recent_items.each do |item|
-          xml.item do
-            xml.title(item_title(item))
-            xml.description(item_description(item))
-            xml.pubDate(item_pubDate(item))
-            xml.guid(@recent_items.url(item))
-            xml.link(@recent_items.url(item))
-          end
-        end
-      end
-    end
-
-  {Learn more}[link:classes/ActionView/Base.html]
-
-
-* Filters for pre- and post-processing of the response
-
-    class WeblogController < ActionController::Base
-      # filters as methods
-      before_filter :authenticate, :cache, :audit
-
-      # filter as a proc
-      after_filter { |c| c.response.body = Gzip::compress(c.response.body) }
-
-      # class filter
-      after_filter LocalizeFilter
-
-      def index
-        # Before this action is run, the user will be authenticated, the cache
-        # will be examined to see if a valid copy of the results already
-        # exists, and the action will be logged for auditing.
-
-        # After this action has run, the output will first be localized then
-        # compressed to minimize bandwidth usage
-      end
-
-      private
-        def authenticate
-          # Implement the filter with full access to both request and response
-        end
-    end
-
-  {Learn more}[link:classes/ActionController/Filters/ClassMethods.html]
-
-
-* Helpers for forms, dates, action links, and text
-
-    <%= text_field_tag "post", "title", "size" => 30 %>
-    <%= link_to "New post", :controller => "post", :action => "new" %>
-    <%= truncate(post.title, :length => 25) %>
-
-  {Learn more}[link:classes/ActionView/Helpers.html]
-
-
-* Layout sharing for template reuse
-
-    class WeblogController < ActionController::Base
-      layout "weblog_layout"
-
-      def hello_world
-      end
-    end
-
-    Layout file (called weblog_layout):
-      <html><body><%= yield %></body></html>
-
-    Template for hello_world action:
-      <h1>Hello world</h1>
-
-    Result of running hello_world action:
-      <html><body><h1>Hello world</h1></body></html>
-
-  {Learn more}[link:classes/ActionController/Layout/ClassMethods.html]
-
-
-* Routing makes pretty URLs incredibly easy
-
-    match 'clients/:client_name/:project_name/:controller/:action'
-
-    Accessing "/clients/37signals/basecamp/project/index" calls ProjectController#index with
-    { "client_name" => "37signals", "project_name" => "basecamp" } in `params`
-
-    From that action, you can write the redirect in a number of ways:
-
-    redirect_to(:action => "edit") =>
-      /clients/37signals/basecamp/project/edit
-
-    redirect_to(:client_name => "nextangle", :project_name => "rails") =>
-      /clients/nextangle/rails/project/index
-
-  {Learn more}[link:classes/ActionDispatch/Routing.html]
-
-
-* Easy testing of both controller and rendered template through ActionController::TestCase
-
-    class LoginControllerTest < ActionController::TestCase
-      def test_failing_authenticate
-        process :authenticate, :user_name => "nop", :password => ""
-        assert flash.has_key?(:alert)
-        assert_redirected_to :action => "index"
-      end
-    end
-
-  {Learn more}[link:classes/ActionController/TestCase.html]
-
-
-* Automated benchmarking and integrated logging
-
-    Started GET "/weblog" for 127.0.0.1 at Fri May 28 00:41:55
-      Processing by WeblogController#index as HTML
-    Rendered weblog/index.html.erb within layouts/application (25.7ms)
-    Completed 200 OK in 29.3ms
-
-    If Active Record is used as the model, you'll have the database debugging
-    as well:
-
-    Started POST "/posts" for 127.0.0.1 at Sat Jun 19 14:04:23
-      Processing by PostsController#create as HTML
-      Parameters: {"post"=>{"title"=>"this is good"}}
-    SQL (0.6ms) INSERT INTO posts (title) VALUES('this is good')
-    Redirected to http://example.com/posts/5
-    Completed 302 Found in 221ms (Views: 215ms | ActiveRecord: 0.6ms)
-
-    You specify a logger through a class method, such as:
-
-    ActionController::Base.logger = Logger.new("Application Log")
-    ActionController::Base.logger = Log4r::Logger.new("Application Log")
-
-
-* Caching at three levels of granularity (page, action, fragment)
-
-    class WeblogController < ActionController::Base
-      caches_page :show
-      caches_action :account
-
-      def show
-        # the output of the method will be cached as
-        # ActionController::Base.page_cache_directory + "/weblog/show.html"
-        # and the web server will pick it up without even hitting Rails
-      end
-
-      def account
-        # the output of the method will be cached in the fragment store
-        # but Rails is hit to retrieve it, so filters are run
-      end
-
-      def update
-        List.update(params[:list][:id], params[:list])
-        expire_page   :action => "show", :id => params[:list][:id]
-        expire_action :action => "account"
-        redirect_to   :action => "show", :id => params[:list][:id]
-      end
-    end
-
-  {Learn more}[link:classes/ActionController/Caching.html]
-
-
-* Powerful debugging mechanism for local requests
-
-    All exceptions raised on actions performed on the request of a local user
-    will be presented with a tailored debugging screen that includes exception
-    message, stack trace, request parameters, session contents, and the
-    half-finished response.
-
-  {Learn more}[link:classes/ActionController/Rescue.html]
-
-
-== Simple example (from outside of Rails)
-
-This example will implement a simple weblog system using inline templates and
-an Active Record model. So let's build that WeblogController with just a few
-methods:
-
-  require 'action_controller'
-  require 'post'
-
-  class WeblogController < ActionController::Base
-    layout "weblog/layout"
-
-    def index
-      @posts = Post.all
-    end
-
-    def show
-      @post = Post.find(params[:id])
-    end
-
-    def new
-      @post = Post.new
-    end
-
-    def create
-      @post = Post.create(params[:post])
-      redirect_to :action => "show", :id => @post.id
-    end
-  end
-
-  WeblogController::Base.view_paths = [ File.dirname(__FILE__) ]
-  WeblogController.process_cgi if $0 == __FILE__
-
-The last two lines are responsible for telling ActionController where the
-template files are located and actually running the controller on a new
-request from the web-server (e.g., Apache).
-
-And the templates look like this:
-
-  weblog/layout.html.erb:
-    <html><body>
-    <%= yield %>
-    </body></html>
-
-  weblog/index.html.erb:
-    <% @posts.each do |post| %>
-      <p><%= link_to(post.title, :action => "show", :id => post.id) %></p>
-    <% end %>
-
-  weblog/show.html.erb:
-    <p>
-      <b><%= @post.title %></b><br/>
-      <b><%= @post.content %></b>
-    </p>
-
-  weblog/new.html.erb:
-    <%= form "post" %>
-
-This simple setup will list all the posts in the system on the index page,
-which is called by accessing /weblog/. It uses the form builder for the Active
-Record model to make the new screen, which in turn hands everything over to
-the create action (that's the default target for the form builder when given a
-new model). After creating the post, it'll redirect to the show page using
-an URL such as /weblog/5 (where 5 is the id of the post).
-
 
 == Download and installation
 
 The latest version of Action Pack can be installed with RubyGems:
 
-  % [sudo] gem install actionpack
+  $ gem install actionpack
 
-Source code can be downloaded as part of the Rails project on GitHub
+Source code can be downloaded as part of the Rails project on GitHub:
 
-* https://github.com/rails/rails/tree/3-2-stable/actionpack
+* https://github.com/rails/rails/tree/5-2-stable/actionpack
 
 
 == License
 
-Action Pack is released under the MIT license.
+Action Pack is released under the MIT license:
+
+* https://opensource.org/licenses/MIT
 
 
 == Support
 
-API documentation is at
+API documentation is at:
 
 * http://api.rubyonrails.org
 
-Bug reports and feature requests can be filed with the rest for the Ruby on Rails project here:
+Bug reports for the Ruby on Rails project can be filed here:
 
 * https://github.com/rails/rails/issues
+
+Feature requests should be discussed on the rails-core mailing list here:
+
+* https://groups.google.com/forum/?fromgroups#!forum/rubyonrails-core

data/lib/abstract_controller/asset_paths.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module AbstractController
-  module AssetPaths
+  module AssetPaths #:nodoc:
     extend ActiveSupport::Concern
 
     included do
-      config_accessor :asset_host, :asset_path, :assets_dir, :javascripts_dir,
+      config_accessor :asset_host, :assets_dir, :javascripts_dir,
         :stylesheets_dir, :default_asset_host_protocol, :relative_url_root
     end
   end

data/lib/abstract_controller/base.rb

@@ -1,25 +1,36 @@
-require 'erubis'
-require 'active_support/configurable'
-require 'active_support/descendants_tracker'
-require 'active_support/core_ext/module/anonymous'
+# frozen_string_literal: true
+
+require "abstract_controller/error"
+require "active_support/configurable"
+require "active_support/descendants_tracker"
+require "active_support/core_ext/module/anonymous"
+require "active_support/core_ext/module/attr_internal"
 
 module AbstractController
-  class Error < StandardError; end
-  class ActionNotFound < StandardError; end
+  # Raised when a non-existing controller action is triggered.
+  class ActionNotFound < StandardError
+  end
 
-  # <tt>AbstractController::Base</tt> is a low-level API. Nobody should be
+  # AbstractController::Base is a low-level API. Nobody should be
   # using it directly, and subclasses (like ActionController::Base) are
   # expected to provide their own +render+ method, since rendering means
   # different things depending on the context.
   class Base
+    ##
+    # Returns the body of the HTTP response sent by the controller.
     attr_internal :response_body
+
+    ##
+    # Returns the name of the action this controller is processing.
     attr_internal :action_name
+
+    ##
+    # Returns the formats that can be processed by the controller.
     attr_internal :formats
 
     include ActiveSupport::Configurable
     extend ActiveSupport::DescendantsTracker
 
-    undef_method :not_implemented
     class << self
       attr_reader :abstract
       alias_method :abstract?, :abstract
@@ -30,36 +41,36 @@ module AbstractController
         @abstract = true
       end
 
+      def inherited(klass) # :nodoc:
+        # Define the abstract ivar on subclasses so that we don't get
+        # uninitialized ivar warnings
+        unless klass.instance_variable_defined?(:@abstract)
+          klass.instance_variable_set(:@abstract, false)
+        end
+        super
+      end
+
       # A list of all internal methods for a controller. This finds the first
       # abstract superclass of a controller, and gets a list of all public
       # instance methods on that abstract class. Public instance methods of
       # a controller would normally be considered action methods, so methods
       # declared on abstract classes are being removed.
-      # (ActionController::Metal and ActionController::Base are defined as abstract)
+      # (<tt>ActionController::Metal</tt> and ActionController::Base are defined as abstract)
       def internal_methods
         controller = self
+
         controller = controller.superclass until controller.abstract?
         controller.public_instance_methods(true)
       end
 
-      # The list of hidden actions to an empty array. Defaults to an
-      # empty array. This can be modified by other modules or subclasses
-      # to specify particular actions as hidden.
-      #
-      # ==== Returns
-      # * <tt>array</tt> - An array of method names that should not be considered actions.
-      def hidden_actions
-        []
-      end
-
       # A list of method names that should be considered actions. This
       # includes all public instance methods on a controller, less
-      # any internal methods (see #internal_methods), adding back in
+      # any internal methods (see internal_methods), adding back in
       # any methods that are internal, but still exist on the class
-      # itself. Finally, #hidden_actions are removed.
+      # itself.
       #
       # ==== Returns
-      # * <tt>array</tt> - A list of all methods that should be considered actions.
+      # * <tt>Set</tt> - A set of all methods that should be considered actions.
       def action_methods
         @action_methods ||= begin
           # All public instance methods of this class, including ancestors
@@ -67,32 +78,34 @@ module AbstractController
             # Except for public instance methods of Base and its ancestors
             internal_methods +
             # Be sure to include shadowed public instance methods of this class
-            public_instance_methods(false)).uniq.map { |x| x.to_s } -
-            # And always exclude explicitly hidden actions
-            hidden_actions.to_a
+            public_instance_methods(false)).uniq.map(&:to_s)
 
-          # Clear out AS callback method pollution
-          methods.reject { |method| method =~ /_one_time_conditions/ }
+          methods.to_set
         end
       end
 
-      # action_methods are cached and there is sometimes need to refresh
-      # them. clear_action_methods! allows you to do that, so next time
-      # you run action_methods, they will be recalculated
+      # action_methods are cached and there is sometimes a need to refresh
+      # them. ::clear_action_methods! allows you to do that, so next time
+      # you run action_methods, they will be recalculated.
       def clear_action_methods!
         @action_methods = nil
       end
 
       # Returns the full controller name, underscored, without the ending Controller.
-      # For instance, MyApp::MyPostsController would return "my_app/my_posts" for
-      # controller_name.
+      #
+      #   class MyApp::MyPostsController < AbstractController::Base
+      #
+      #   end
+      #
+      #   MyApp::MyPostsController.controller_path # => "my_app/my_posts"
       #
       # ==== Returns
-      # * <tt>string</tt>
+      # * <tt>String</tt>
       def controller_path
-        @controller_path ||= name.sub(/Controller$/, '').underscore unless anonymous?
+        @controller_path ||= name.sub(/Controller$/, "".freeze).underscore unless anonymous?
       end
 
+      # Refresh the cached action_methods when a new action_method is added.
       def method_added(name)
         super
         clear_action_methods!
@@ -105,14 +118,14 @@ module AbstractController
     #
     # The actual method that is called is determined by calling
     # #method_for_action. If no method can handle the action, then an
-    # ActionNotFound error is raised.
+    # AbstractController::ActionNotFound error is raised.
     #
     # ==== Returns
     # * <tt>self</tt>
     def process(action, *args)
-      @_action_name = action_name = action.to_s
+      @_action_name = action.to_s
 
-      unless action_name = _find_action_name(action_name)
+      unless action_name = _find_action_name(@_action_name)
         raise ActionNotFound, "The action '#{action}' could not be found for #{self.class.name}"
       end
 
@@ -121,11 +134,12 @@ module AbstractController
       process_action(action_name, *args)
     end
 
-    # Delegates to the class' #controller_path
+    # Delegates to the class' ::controller_path
     def controller_path
       self.class.controller_path
     end
 
+    # Delegates to the class' ::action_methods
     def action_methods
       self.class.action_methods
     end
@@ -135,10 +149,28 @@ module AbstractController
     #
     # Notice that <tt>action_methods.include?("foo")</tt> may return
     # false and <tt>available_action?("foo")</tt> returns true because
-    # available action consider actions that are also available
+    # this method considers actions that are also available
     # through other means, for example, implicit render ones.
+    #
+    # ==== Parameters
+    # * <tt>action_name</tt> - The name of an action to be tested
     def available_action?(action_name)
-      _find_action_name(action_name).present?
+      _find_action_name(action_name)
+    end
+
+    # Tests if a response body is set. Used to determine if the
+    # +process_action+ callback needs to be terminated in
+    # +AbstractController::Callbacks+.
+    def performed?
+      response_body
+    end
+
+    # Returns true if the given controller is capable of rendering
+    # a path. A subclass of +AbstractController::Base+
+    # may return false. An Email controller for example does not
+    # support paths, only full URLs.
+    def self.supports_path?
+      true
     end
 
     private
@@ -148,11 +180,6 @@ module AbstractController
       #
       # ==== Parameters
       # * <tt>name</tt> - The name of an action to be tested
-      #
-      # ==== Returns
-      # * <tt>TrueClass</tt>, <tt>FalseClass</tt>
-      #
-      # :api: private
       def action_method?(name)
         self.class.action_methods.include?(name)
       end
@@ -193,7 +220,8 @@ module AbstractController
       #
       # ==== Returns
       # * <tt>string</tt> - The name of the method that handles the action
-      # * false           - No valid method name could be found. Raise ActionNotFound.
+      # * false           - No valid method name could be found.
+      # Raise +AbstractController::ActionNotFound+.
       def _find_action_name(action_name)
         _valid_action_name?(action_name) && method_for_action(action_name)
       end
@@ -209,11 +237,11 @@ module AbstractController
       # with a template matching the action name is considered to exist.
       #
       # If you override this method to handle additional cases, you may
-      # also provide a method (like _handle_method_missing) to handle
+      # also provide a method (like +_handle_method_missing+) to handle
       # the case.
       #
-      # If none of these conditions are true, and method_for_action
-      # returns nil, an ActionNotFound exception will be raised.
+      # If none of these conditions are true, and +method_for_action+
+      # returns +nil+, an +AbstractController::ActionNotFound+ exception will be raised.
       #
       # ==== Parameters
       # * <tt>action_name</tt> - An action name to find a method name for
@@ -222,14 +250,16 @@ module AbstractController
       # * <tt>string</tt> - The name of the method that handles the action
       # * <tt>nil</tt>    - No method name could be found.
       def method_for_action(action_name)
-        if action_method?(action_name) then action_name
-        elsif respond_to?(:action_missing, true) then "_handle_action_missing"
+        if action_method?(action_name)
+          action_name
+        elsif respond_to?(:action_missing, true)
+          "_handle_action_missing"
         end
       end
 
       # Checks if the action name is valid and returns false otherwise.
       def _valid_action_name?(action_name)
-        action_name.to_s !~ Regexp.new(File::SEPARATOR)
+        !action_name.to_s.include? File::SEPARATOR
       end
   end
 end