actionpack 4.0.1 → 4.2.11.1

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2004-2013 David Heinemeier Hansson
+Copyright (c) 2004-2014 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

@@ -17,11 +17,6 @@ It consists of several modules:
   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
@@ -37,7 +32,7 @@ The latest version of Action Pack can be installed with RubyGems:
 
 Source code can be downloaded as part of the Rails project on GitHub
 
-* https://github.com/rails/rails/tree/4-0-stable/actionpack
+* https://github.com/rails/rails/tree/4-2-stable/actionpack
 
 
 == License
@@ -53,6 +48,11 @@ 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 can be filed for the Ruby on Rails project 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/base.rb

@@ -8,7 +8,8 @@ module AbstractController
   class Error < StandardError #:nodoc:
   end
 
-  class ActionNotFound < StandardError #:nodoc:
+  # 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
@@ -120,14 +121,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 = method_for_action(action_name)
+      unless action_name = _find_action_name(@_action_name)
         raise ActionNotFound, "The action '#{action}' could not be found for #{self.class.name}"
       end
 
@@ -160,7 +161,15 @@ module AbstractController
     # ==== Returns
     # * <tt>TrueClass</tt>, <tt>FalseClass</tt>
     def available_action?(action_name)
-      method_for_action(action_name).present?
+      _find_action_name(action_name).present?
+    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
@@ -203,6 +212,24 @@ module AbstractController
         action_missing(@_action_name, *args)
       end
 
+      # Takes an action name and returns the name of the method that will
+      # handle the action.
+      #
+      # It checks if the action name is valid and returns false otherwise.
+      #
+      # See method_for_action for more information.
+      #
+      # ==== Parameters
+      # * <tt>action_name</tt> - An action name to find a method name for
+      #
+      # ==== Returns
+      # * <tt>string</tt> - The name of the method that handles the action
+      # * 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
+
       # Takes an action name and returns the name of the method that will
       # handle the action. In normal cases, this method returns the same
       # name as it receives. By default, if #method_for_action receives
@@ -218,14 +245,14 @@ module AbstractController
       # the case.
       #
       # If none of these conditions are true, and method_for_action
-      # returns nil, an ActionNotFound exception will be raised.
+      # returns nil, an AbstractController::ActionNotFound exception will be raised.
       #
       # ==== Parameters
       # * <tt>action_name</tt> - An action name to find a method name for
       #
       # ==== Returns
       # * <tt>string</tt> - The name of the method that handles the action
-      # * <tt>nil</tt>    - No method name could be found. Raise ActionNotFound.
+      # * <tt>nil</tt>    - No method name could be found.
       def method_for_action(action_name)
         if action_method?(action_name)
           action_name
@@ -233,5 +260,10 @@ module AbstractController
           "_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.include? File::SEPARATOR
+      end
   end
 end

data/lib/abstract_controller/callbacks.rb

@@ -8,7 +8,9 @@ module AbstractController
     include ActiveSupport::Callbacks
 
     included do
-      define_callbacks :process_action, :terminator => "response_body", :skip_after_callbacks_if_terminated => true
+      define_callbacks :process_action,
+                       terminator: ->(controller,_) { controller.response_body },
+                       skip_after_callbacks_if_terminated: true
     end
 
     # Override AbstractController::Base's process_action to run the
@@ -40,20 +42,18 @@ module AbstractController
         end
       end
 
-      # Skip before, after, and around action callbacks matching any of the names
-      # Aliased as skip_filter.
+      # Skip before, after, and around action callbacks matching any of the names.
       #
       # ==== Parameters
       # * <tt>names</tt> - A list of valid names that could be used for
       #   callbacks. Note that skipping uses Ruby equality, so it's
       #   impossible to skip a callback defined using an anonymous proc
-      #   using #skip_filter
+      #   using #skip_action_callback
       def skip_action_callback(*names)
         skip_before_action(*names)
         skip_after_action(*names)
         skip_around_action(*names)
       end
-
       alias_method :skip_filter, :skip_action_callback
 
       # Take callback names and an optional callback proc, normalize them,
@@ -69,7 +69,7 @@ module AbstractController
       # * <tt>name</tt>     - The callback to be added
       # * <tt>options</tt>  - A hash of options to be used when adding the callback
       def _insert_callbacks(callbacks, block = nil)
-        options = callbacks.last.is_a?(Hash) ? callbacks.pop : {}
+        options = callbacks.extract_options!
         _normalize_callback_options(options)
         callbacks.push(block) if block
         callbacks.each do |callback|
@@ -83,7 +83,6 @@ module AbstractController
       # :call-seq: before_action(names, block)
       #
       # Append a callback before actions. See _insert_callbacks for parameter details.
-      # Aliased as before_filter.
 
       ##
       # :method: prepend_before_action
@@ -91,7 +90,6 @@ module AbstractController
       # :call-seq: prepend_before_action(names, block)
       #
       # Prepend a callback before actions. See _insert_callbacks for parameter details.
-      # Aliased as prepend_before_filter.
 
       ##
       # :method: skip_before_action
@@ -99,7 +97,6 @@ module AbstractController
       # :call-seq: skip_before_action(names)
       #
       # Skip a callback before actions. See _insert_callbacks for parameter details.
-      # Aliased as skip_before_filter.
 
       ##
       # :method: append_before_action
@@ -107,7 +104,6 @@ module AbstractController
       # :call-seq: append_before_action(names, block)
       #
       # Append a callback before actions. See _insert_callbacks for parameter details.
-      # Aliased as append_before_filter.
 
       ##
       # :method: after_action
@@ -115,7 +111,6 @@ module AbstractController
       # :call-seq: after_action(names, block)
       #
       # Append a callback after actions. See _insert_callbacks for parameter details.
-      # Aliased as after_filter.
 
       ##
       # :method: prepend_after_action
@@ -123,7 +118,6 @@ module AbstractController
       # :call-seq: prepend_after_action(names, block)
       #
       # Prepend a callback after actions. See _insert_callbacks for parameter details.
-      # Aliased as prepend_after_filter.
 
       ##
       # :method: skip_after_action
@@ -131,7 +125,6 @@ module AbstractController
       # :call-seq: skip_after_action(names)
       #
       # Skip a callback after actions. See _insert_callbacks for parameter details.
-      # Aliased as skip_after_filter.
 
       ##
       # :method: append_after_action
@@ -139,7 +132,6 @@ module AbstractController
       # :call-seq: append_after_action(names, block)
       #
       # Append a callback after actions. See _insert_callbacks for parameter details.
-      # Aliased as append_after_filter.
 
       ##
       # :method: around_action
@@ -147,7 +139,6 @@ module AbstractController
       # :call-seq: around_action(names, block)
       #
       # Append a callback around actions. See _insert_callbacks for parameter details.
-      # Aliased as around_filter.
 
       ##
       # :method: prepend_around_action
@@ -155,7 +146,6 @@ module AbstractController
       # :call-seq: prepend_around_action(names, block)
       #
       # Prepend a callback around actions. See _insert_callbacks for parameter details.
-      # Aliased as prepend_around_filter.
 
       ##
       # :method: skip_around_action
@@ -163,7 +153,6 @@ module AbstractController
       # :call-seq: skip_around_action(names)
       #
       # Skip a callback around actions. See _insert_callbacks for parameter details.
-      # Aliased as skip_around_filter.
 
       ##
       # :method: append_around_action
@@ -171,46 +160,36 @@ module AbstractController
       # :call-seq: append_around_action(names, block)
       #
       # Append a callback around actions. See _insert_callbacks for parameter details.
-      # Aliased as append_around_filter.
 
       # set up before_action, prepend_before_action, skip_before_action, etc.
       # for each of before, after, and around.
       [:before, :after, :around].each do |callback|
-        class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
-          # Append a before, after or around callback. See _insert_callbacks
-          # for details on the allowed parameters.
-          def #{callback}_action(*names, &blk)                                                    # def before_action(*names, &blk)
-            _insert_callbacks(names, blk) do |name, options|                                      #   _insert_callbacks(names, blk) do |name, options|
-              set_callback(:process_action, :#{callback}, name, options)                          #     set_callback(:process_action, :before, name, options)
-            end                                                                                   #   end
-          end                                                                                     # end
-
-          alias_method :#{callback}_filter, :#{callback}_action
-
-          # Prepend a before, after or around callback. See _insert_callbacks
-          # for details on the allowed parameters.
-          def prepend_#{callback}_action(*names, &blk)                                            # def prepend_before_action(*names, &blk)
-            _insert_callbacks(names, blk) do |name, options|                                      #   _insert_callbacks(names, blk) do |name, options|
-              set_callback(:process_action, :#{callback}, name, options.merge(:prepend => true))  #     set_callback(:process_action, :before, name, options.merge(:prepend => true))
-            end                                                                                   #   end
-          end                                                                                     # end
-
-          alias_method :prepend_#{callback}_filter, :prepend_#{callback}_action
-
-          # Skip a before, after or around callback. See _insert_callbacks
-          # for details on the allowed parameters.
-          def skip_#{callback}_action(*names)                                                     # def skip_before_action(*names)
-            _insert_callbacks(names) do |name, options|                                           #   _insert_callbacks(names) do |name, options|
-              skip_callback(:process_action, :#{callback}, name, options)                         #     skip_callback(:process_action, :before, name, options)
-            end                                                                                   #   end
-          end                                                                                     # end
-
-          alias_method :skip_#{callback}_filter, :skip_#{callback}_action
-
-          # *_action is the same as append_*_action
-          alias_method :append_#{callback}_action, :#{callback}_action  # alias_method :append_before_action, :before_action
-          alias_method :append_#{callback}_filter, :#{callback}_action  # alias_method :append_before_filter, :before_action
-        RUBY_EVAL
+        define_method "#{callback}_action" do |*names, &blk|
+          _insert_callbacks(names, blk) do |name, options|
+            set_callback(:process_action, callback, name, options)
+          end
+        end
+        alias_method :"#{callback}_filter", :"#{callback}_action"
+
+        define_method "prepend_#{callback}_action" do |*names, &blk|
+          _insert_callbacks(names, blk) do |name, options|
+            set_callback(:process_action, callback, name, options.merge(:prepend => true))
+          end
+        end
+        alias_method :"prepend_#{callback}_filter", :"prepend_#{callback}_action"
+
+        # Skip a before, after or around callback. See _insert_callbacks
+        # for details on the allowed parameters.
+        define_method "skip_#{callback}_action" do |*names|
+          _insert_callbacks(names) do |name, options|
+            skip_callback(:process_action, callback, name, options)
+          end
+        end
+        alias_method :"skip_#{callback}_filter", :"skip_#{callback}_action"
+
+        # *_action is the same as append_*_action
+        alias_method :"append_#{callback}_action", :"#{callback}_action"
+        alias_method :"append_#{callback}_filter", :"#{callback}_action"
       end
     end
   end

data/lib/abstract_controller/collector.rb

@@ -23,7 +23,17 @@ module AbstractController
   protected
 
     def method_missing(symbol, &block)
-      mime_constant = Mime.const_get(symbol.upcase)
+      const_name = symbol.upcase
+
+      unless Mime.const_defined?(const_name)
+        raise NoMethodError, "To respond to a custom format, register it as a MIME type first: " \
+          "http://guides.rubyonrails.org/action_controller_overview.html#restful-downloads. " \
+          "If you meant to respond to a variant like :tablet or :phone, not a custom format, " \
+          "be sure to nest your variant response within a format response: " \
+          "format.html { |html| html.tablet { ... } }"
+      end
+
+      mime_constant = Mime.const_get(const_name)
 
       if Mime::SET.include?(mime_constant)
         AbstractController::Collector.generate_method_for_mime(mime_constant)

data/lib/abstract_controller/helpers.rb

@@ -12,6 +12,20 @@ module AbstractController
       self._helper_methods = Array.new
     end
 
+    class MissingHelperError < LoadError
+      def initialize(error, path)
+        @error = error
+        @path  = "helpers/#{path}.rb"
+        set_backtrace error.backtrace
+
+        if error.path =~ /^#{path}(\.rb)?$/
+          super("Missing helper file helpers/%s.rb" % path)
+        else
+          raise error
+        end
+      end
+    end
+
     module ClassMethods
       # When a class is inherited, wrap its helper module in a new module.
       # This ensures that the parent class's module can be changed
@@ -134,9 +148,19 @@ module AbstractController
             begin
               require_dependency(file_name)
             rescue LoadError => e
-              raise MissingHelperError.new(e, file_name)
+              raise AbstractController::Helpers::MissingHelperError.new(e, file_name)
+            end
+
+            mod_name = file_name.camelize
+            begin
+              mod_name.constantize
+            rescue LoadError
+              # dependencies.rb gives a similar error message but its wording is
+              # not as clear because it mentions autoloading. To the user all it
+              # matters is that a helper module couldn't be loaded, autoloading
+              # is an internal mechanism that should not leak.
+              raise NameError, "Couldn't find #{mod_name}, expected it to be defined in helpers/#{file_name}.rb"
             end
-            file_name.camelize.constantize
           when Module
             arg
           else
@@ -145,20 +169,6 @@ module AbstractController
         end
       end
 
-      class MissingHelperError < LoadError
-        def initialize(error, path)
-          @error = error
-          @path  = "helpers/#{path}.rb"
-          set_backtrace error.backtrace
-
-          if error.path =~ /^#{path}(\.rb)?$/
-            super("Missing helper file helpers/%s.rb" % path)
-          else
-            raise error
-          end
-        end
-      end
-
       private
       # Makes all the (instance) methods in the helper module available to templates
       # rendered through this controller.

data/lib/abstract_controller/railties/routes_helpers.rb

@@ -1,14 +1,14 @@
 module AbstractController
   module Railties
     module RoutesHelpers
-      def self.with(routes)
+      def self.with(routes, include_path_helpers = true)
         Module.new do
           define_method(:inherited) do |klass|
             super(klass)
             if namespace = klass.parents.detect { |m| m.respond_to?(:railtie_routes_url_helpers) }
-              klass.send(:include, namespace.railtie_routes_url_helpers)
+              klass.send(:include, namespace.railtie_routes_url_helpers(include_path_helpers))
             else
-              klass.send(:include, routes.url_helpers)
+              klass.send(:include, routes.url_helpers(include_path_helpers))
             end
           end
         end

data/lib/abstract_controller/rendering.rb

@@ -1,5 +1,8 @@
-require "abstract_controller/base"
-require "action_view"
+require 'active_support/concern'
+require 'active_support/core_ext/class/attribute'
+require 'action_view'
+require 'action_view/view_paths'
+require 'set'
 
 module AbstractController
   class DoubleRenderError < Error
@@ -10,91 +13,18 @@ module AbstractController
     end
   end
 
-  # This is a class to fix I18n global state. Whenever you provide I18n.locale during a request,
-  # it will trigger the lookup_context and consequently expire the cache.
-  class I18nProxy < ::I18n::Config #:nodoc:
-    attr_reader :original_config, :lookup_context
-
-    def initialize(original_config, lookup_context)
-      original_config = original_config.original_config if original_config.respond_to?(:original_config)
-      @original_config, @lookup_context = original_config, lookup_context
-    end
-
-    def locale
-      @original_config.locale
-    end
-
-    def locale=(value)
-      @lookup_context.locale = value
-    end
-  end
-
   module Rendering
     extend ActiveSupport::Concern
-    include AbstractController::ViewPaths
-
-    included do
-      class_attribute :protected_instance_variables
-      self.protected_instance_variables = []
-    end
-
-    # Overwrite process to setup I18n proxy.
-    def process(*) #:nodoc:
-      old_config, I18n.config = I18n.config, I18nProxy.new(I18n.config, lookup_context)
-      super
-    ensure
-      I18n.config = old_config
-    end
-
-    module ClassMethods
-      def view_context_class
-        @view_context_class ||= begin
-          routes = respond_to?(:_routes) && _routes
-          helpers = respond_to?(:_helpers) && _helpers
-
-          Class.new(ActionView::Base) do
-            if routes
-              include routes.url_helpers
-              include routes.mounted_helpers
-            end
-
-            if helpers
-              include helpers
-            end
-          end
-        end
-      end
-    end
-
-    attr_internal_writer :view_context_class
-
-    def view_context_class
-      @_view_context_class ||= self.class.view_context_class
-    end
-
-    # An instance of a view class. The default view class is ActionView::Base
-    #
-    # The view class must have the following methods:
-    # View.new[lookup_context, assigns, controller]
-    #   Create a new ActionView instance for a controller
-    # View#render[options]
-    #   Returns String with the rendered template
-    #
-    # Override this method in a module to change the default behavior.
-    def view_context
-      view_context_class.new(view_renderer, view_assigns, self)
-    end
-
-    # Returns an object that is able to render templates.
-    def view_renderer
-      @_view_renderer ||= ActionView::Renderer.new(lookup_context)
-    end
+    include ActionView::ViewPaths
 
     # Normalize arguments, options and then delegates render_to_body and
     # sticks the result in self.response_body.
+    # :api: public
     def render(*args, &block)
       options = _normalize_render(*args, &block)
       self.response_body = render_to_body(options)
+      _process_format(rendered_format, options) if rendered_format
+      self.response_body
     end
 
     # Raw rendering of a template to a string.
@@ -113,84 +43,84 @@ module AbstractController
       render_to_body(options)
     end
 
-    # Raw rendering of a template.
-    # :api: plugin
+    # Performs the actual template rendering.
+    # :api: public
     def render_to_body(options = {})
-      _process_options(options)
-      _render_template(options)
     end
 
-    # Find and renders a template based on the options given.
-    # :api: private
-    def _render_template(options) #:nodoc:
-      lookup_context.rendered_format = nil if options[:formats]
-      view_renderer.render(view_context, options)
+    # Returns Content-Type of rendered content
+    # :api: public
+    def rendered_format
+      Mime::TEXT
     end
 
-    DEFAULT_PROTECTED_INSTANCE_VARIABLES = [
-      :@_action_name, :@_response_body, :@_formats, :@_prefixes, :@_config,
-      :@_view_context_class, :@_view_renderer, :@_lookup_context
-    ]
+    DEFAULT_PROTECTED_INSTANCE_VARIABLES = Set.new %w(
+      @_action_name @_response_body @_formats @_prefixes @_config
+      @_view_context_class @_view_renderer @_lookup_context
+      @_routes @_db_runtime
+    ).map(&:to_sym)
 
     # This method should return a hash with assigns.
     # You can overwrite this configuration per controller.
     # :api: public
     def view_assigns
-      hash = {}
-      variables  = instance_variables
-      variables -= protected_instance_variables
-      variables -= DEFAULT_PROTECTED_INSTANCE_VARIABLES
-      variables.each { |name| hash[name[1..-1]] = instance_variable_get(name) }
-      hash
-    end
-
-    private
+      protected_vars = _protected_ivars
+      variables      = instance_variables
 
-    # Normalize args and options.
-    # :api: private
-    def _normalize_render(*args, &block)
-      options = _normalize_args(*args, &block)
-      _normalize_options(options)
-      options
+      variables.reject! { |s| protected_vars.include? s }
+      variables.each_with_object({}) { |name, hash|
+        hash[name.slice(1, name.length)] = instance_variable_get(name)
+      }
     end
 
     # Normalize args by converting render "foo" to render :action => "foo" and
     # render "foo/bar" to render :file => "foo/bar".
     # :api: plugin
     def _normalize_args(action=nil, options={})
-      case action
-      when NilClass
-      when Hash
-        options = action
-      when String, Symbol
-        action = action.to_s
-        key = action.include?(?/) ? :file : :action
-        options[key] = action
+      if action.respond_to?(:permitted?)
+        if action.permitted?
+          action
+        else
+          raise ArgumentError, "render parameters are not permitted"
+        end
+      elsif action.is_a?(Hash)
+        action
       else
-        options[:partial] = action
+        options
       end
-
-      options
     end
 
     # Normalize options.
     # :api: plugin
     def _normalize_options(options)
-      if options[:partial] == true
-        options[:partial] = action_name
-      end
-
-      if (options.keys & [:partial, :file, :template]).empty?
-        options[:prefixes] ||= _prefixes
-      end
-
-      options[:template] ||= (options[:action] || action_name).to_s
       options
     end
 
     # Process extra options.
     # :api: plugin
     def _process_options(options)
+      options
+    end
+
+    # Process the rendered format.
+    # :api: private
+    def _process_format(format, options = {})
+    end
+
+    # Normalize args and options.
+    # :api: private
+    def _normalize_render(*args, &block)
+      options = _normalize_args(*args, &block)
+      #TODO: remove defined? when we restore AP <=> AV dependency
+      if defined?(request) && request && request.variant.present?
+        options[:variant] = request.variant
+      end
+      _normalize_options(options)
+      options
+    end
+
+    def _protected_ivars # :nodoc:
+      DEFAULT_PROTECTED_INSTANCE_VARIABLES
     end
   end
 end