actionview 4.2.11.3 → 5.0.0.beta1

data/lib/action_view/renderer/partial_renderer/collection_caching.rb

@@ -0,0 +1,70 @@
+require 'active_support/core_ext/object/try'
+
+module ActionView
+  module CollectionCaching # :nodoc:
+    extend ActiveSupport::Concern
+
+    included do
+      # Fallback cache store if Action View is used without Rails.
+      # Otherwise overridden in Railtie to use Rails.cache.
+      mattr_accessor(:collection_cache) { ActiveSupport::Cache::MemoryStore.new }
+    end
+
+    private
+      def cache_collection_render
+        return yield unless cache_collection?
+
+        keyed_collection = collection_by_cache_keys
+        partial_cache = collection_cache.read_multi(*keyed_collection.keys)
+
+        @collection = keyed_collection.reject { |key, _| partial_cache.key?(key) }.values
+        rendered_partials = @collection.any? ? yield.dup : []
+
+        fetch_or_cache_partial(partial_cache, order_by: keyed_collection.each_key) do
+          rendered_partials.shift
+        end
+      end
+
+      def cache_collection?
+        @options.fetch(:cache, automatic_cache_eligible?)
+      end
+
+      def automatic_cache_eligible?
+        single_template_render? && !callable_cache_key? &&
+          @template.eligible_for_collection_caching?(as: @options[:as])
+      end
+
+      def single_template_render?
+        @template # Template is only set when a collection renders one template.
+      end
+
+      def callable_cache_key?
+        @options[:cache].respond_to?(:call)
+      end
+
+      def collection_by_cache_keys
+        seed = callable_cache_key? ? @options[:cache] : ->(i) { i }
+
+        @collection.each_with_object({}) do |item, hash|
+          hash[expanded_cache_key(seed.call(item))] = item
+        end
+      end
+
+      def expanded_cache_key(key)
+        key = @view.fragment_cache_key(@view.cache_fragment_name(key, virtual_path: @template.virtual_path))
+        key.frozen? ? key.dup : key # #read_multi & #write may require mutability, Dalli 2.6.0.
+      end
+
+      def fetch_or_cache_partial(cached_partials, order_by:)
+        cache_options = @options[:cache_options] || @locals[:cache_options] || {}
+
+        order_by.map do |key|
+          cached_partials.fetch(key) do
+            yield.tap do |rendered_partial|
+              collection_cache.write(key, rendered_partial, cache_options)
+            end
+          end
+        end
+      end
+  end
+end

data/lib/action_view/renderer/renderer.rb

@@ -15,12 +15,8 @@ module ActionView
       @lookup_context = lookup_context
     end
 
-    # Main render entry point shared by AV and AC.
+    # Main render entry point shared by Action View and Action Controller.
     def render(context, options)
-      if options.respond_to?(:permitted?) && !options.permitted?
-        raise ArgumentError, "render parameters are not permitted"
-      end
-
       if options.key?(:partial)
         render_partial(context, options)
       else
@@ -41,7 +37,7 @@ module ActionView
       end
     end
 
-    # Direct accessor to template rendering.
+    # Direct access to template rendering.
     def render_template(context, options) #:nodoc:
       TemplateRenderer.new(@lookup_context).render(context, options)
     end

data/lib/action_view/renderer/streaming_template_renderer.rb

@@ -47,7 +47,7 @@ module ActionView
       return [super] unless layout_name && template.supports_streaming?
 
       locals ||= {}
-      layout   = layout_name && find_layout(layout_name, locals.keys)
+      layout   = layout_name && find_layout(layout_name, locals.keys, [formats.first])
 
       Body.new do |buffer|
         delayed_render(buffer, template, layout, @view, locals)

data/lib/action_view/renderer/template_renderer.rb

@@ -29,7 +29,7 @@ module ActionView
       elsif options.key?(:html)
         Template::HTML.new(options[:html], formats.first)
       elsif options.key?(:file)
-        with_fallbacks { find_file(options[:file], nil, false, keys, @details) }
+        with_fallbacks { find_template(options[:file], nil, false, keys, @details) }
       elsif options.key?(:inline)
         handler = Template.handler_for_extension(options[:type] || "erb")
         Template.new(options[:inline], "inline template", handler, :locals => keys)
@@ -40,7 +40,7 @@ module ActionView
           find_template(options[:template], options[:prefixes], false, keys, @details)
         end
       else
-        raise ArgumentError, "You invoked render but did not give any of :partial, :template, :inline, :file, :plain, :text or :body option."
+        raise ArgumentError, "You invoked render but did not give any of :partial, :template, :inline, :file, :plain, :html, :text or :body option."
       end
     end
 
@@ -57,7 +57,7 @@ module ActionView
     end
 
     def render_with_layout(path, locals) #:nodoc:
-      layout  = path && find_layout(path, locals.keys)
+      layout  = path && find_layout(path, locals.keys, [formats.first])
       content = yield(layout)
 
       if layout
@@ -72,27 +72,28 @@ module ActionView
     # This is the method which actually finds the layout using details in the lookup
     # context object. If no layout is found, it checks if at least a layout with
     # the given name exists across all details before raising the error.
-    def find_layout(layout, keys)
-      with_layout_format { resolve_layout(layout, keys) }
+    def find_layout(layout, keys, formats)
+      resolve_layout(layout, keys, formats)
     end
 
-    def resolve_layout(layout, keys)
+    def resolve_layout(layout, keys, formats)
+      details = @details.dup
+      details[:formats] = formats
+
       case layout
       when String
         begin
           if layout =~ /^\//
-            with_fallbacks { find_template(layout, nil, false, keys, @details) }
+            with_fallbacks { find_template(layout, nil, false, keys, details) }
           else
-            find_template(layout, nil, false, keys, @details)
+            find_template(layout, nil, false, keys, details)
           end
         rescue ActionView::MissingTemplate
           all_details = @details.merge(:formats => @lookup_context.default_formats)
           raise unless template_exists?(layout, nil, false, keys, all_details)
         end
       when Proc
-        resolve_layout(layout.call, keys)
-      when FalseClass
-        nil
+        resolve_layout(layout.call(formats), keys, formats)
       else
         layout
       end

data/lib/action_view/rendering.rb

@@ -59,7 +59,7 @@ module ActionView
       @_view_context_class ||= self.class.view_context_class
     end
 
-    # An instance of a view class. The default view class is ActionView::Base
+    # 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]
@@ -92,16 +92,19 @@ module ActionView
       # Find and render a template based on the options given.
       # :api: private
       def _render_template(options) #:nodoc:
-        variant = options[:variant]
+        variant = options.delete(:variant)
+        assigns = options.delete(:assigns)
+        context = view_context
 
+        context.assign assigns if assigns
         lookup_context.rendered_format = nil if options[:formats]
         lookup_context.variants = variant if variant
 
-        view_renderer.render(view_context, options)
+        view_renderer.render(context, options)
       end
 
-      # Assign the rendered format to lookup context.
-      def _process_format(format, options = {}) #:nodoc:
+      # Assign the rendered format to look up context.
+      def _process_format(format) #:nodoc:
         super
         lookup_context.formats = [format.to_sym]
         lookup_context.rendered_format = lookup_context.formats.first

data/lib/action_view/routing_url_for.rb

@@ -32,7 +32,7 @@ module ActionView
     #
     # ==== Examples
     #   <%= url_for(action: 'index') %>
-    #   # => /blog/
+    #   # => /blogs/
     #
     #   <%= url_for(action: 'find', controller: 'books') %>
     #   # => /books/find
@@ -84,11 +84,13 @@ module ActionView
       when Hash
         options = options.symbolize_keys
         unless options.key?(:only_path)
-          if options[:host].nil?
-            options[:only_path] = _generate_paths_by_default
-          else
-            options[:only_path] = false
-          end
+          options[:only_path] = only_path?(options[:host])
+        end
+
+        super(options)
+      when ActionController::Parameters
+        unless options.key?(:only_path)
+          options[:only_path] = only_path?(options[:host])
         end
 
         super(options)
@@ -131,5 +133,15 @@ module ActionView
         controller.optimize_routes_generation? : super
     end
     protected :optimize_routes_generation?
+
+    private
+
+      def _generate_paths_by_default
+        true
+      end
+
+      def only_path?(host)
+        _generate_paths_by_default unless host
+      end
   end
 end

data/lib/action_view/template.rb

@@ -87,6 +87,19 @@ module ActionView
     #       expected_encoding
     #     )
 
+    ##
+    # :method: local_assigns
+    #
+    # Returns a hash with the defined local variables.
+    #
+    # Given this sub template rendering:
+    #
+    #   <%= render "shared/header", { headline: "Welcome", person: person } %>
+    #
+    # You can use +local_assigns+ in the sub templates to access the local variables:
+    #
+    #   local_assigns[:headline] # => "Welcome"
+
     eager_autoload do
       autoload :Error
       autoload :Handlers
@@ -103,7 +116,7 @@ module ActionView
 
     # This finalizer is needed (and exactly with a proc inside another proc)
     # otherwise templates leak in development.
-    Finalizer = proc do |method_name, mod|
+    Finalizer = proc do |method_name, mod| # :nodoc:
       proc do
         mod.module_eval do
           remove_possible_method method_name
@@ -117,6 +130,7 @@ module ActionView
       @source            = source
       @identifier        = identifier
       @handler           = handler
+      @cache_name        = extract_resource_cache_name
       @compiled          = false
       @original_encoding = nil
       @locals            = details[:locals] || []
@@ -127,7 +141,7 @@ module ActionView
       @compile_mutex     = Mutex.new
     end
 
-    # Returns if the underlying handler supports streaming. If so,
+    # Returns whether the underlying handler supports streaming. If so,
     # a streaming buffer *may* be passed when it start rendering.
     def supports_streaming?
       handler.respond_to?(:supports_streaming?) && handler.supports_streaming?
@@ -140,7 +154,7 @@ module ActionView
     # we use a bang in this instrumentation because you don't want to
     # consume this in production. This is only slow if it's being listened to.
     def render(view, locals, buffer=nil, &block)
-      instrument("!render_template") do
+      instrument("!render_template".freeze) do
         compile!(view)
         view.send(method_name, locals, buffer, &block)
       end
@@ -152,6 +166,10 @@ module ActionView
       @type ||= Types[@formats.first] if @formats.first
     end
 
+    def eligible_for_collection_caching?(as: nil)
+      @cache_name == (as || inferred_cache_name).to_s
+    end
+
     # Receives a view object and return a template similar to self by using @virtual_path.
     #
     # This method is useful if you have a template object but it does not contain its source
@@ -172,7 +190,7 @@ module ActionView
     end
 
     def inspect
-      @inspect ||= defined?(Rails.root) ? identifier.sub("#{Rails.root}/", '') : identifier
+      @inspect ||= defined?(Rails.root) ? identifier.sub("#{Rails.root}/", ''.freeze) : identifier
     end
 
     # This method is responsible for properly setting the encoding of the
@@ -307,34 +325,53 @@ module ActionView
             template = refresh(view)
             template.encode!
           end
-          raise Template::Error.new(template, e)
+          raise Template::Error.new(template)
         end
       end
 
       def locals_code #:nodoc:
-        # Only locals with valid variable names get set directly. Others will
-        # still be available in local_assigns.
-        locals = @locals.to_set - Module::DELEGATION_RESERVED_METHOD_NAMES
-        locals = locals.grep(/\A(?![A-Z0-9])(?:[[:alnum:]_]|[^\0-\177])+\z/)
         # Double assign to suppress the dreaded 'assigned but unused variable' warning
-        locals.each_with_object('') { |key, code| code << "#{key} = #{key} = local_assigns[:#{key}];" }
+        @locals.each_with_object('') { |key, code| code << "#{key} = #{key} = local_assigns[:#{key}];" }
       end
 
       def method_name #:nodoc:
         @method_name ||= begin
           m = "_#{identifier_method_name}__#{@identifier.hash}_#{__id__}"
-          m.tr!('-', '_')
+          m.tr!('-'.freeze, '_'.freeze)
           m
         end
       end
 
       def identifier_method_name #:nodoc:
-        inspect.tr('^a-z_', '_')
+        inspect.tr('^a-z_'.freeze, '_'.freeze)
       end
 
       def instrument(action, &block)
         payload = { virtual_path: @virtual_path, identifier: @identifier }
-        ActiveSupport::Notifications.instrument("#{action}.action_view", payload, &block)
+        case action
+        when "!render_template".freeze
+          ActiveSupport::Notifications.instrument("!render_template.action_view".freeze, payload, &block)
+        else
+          ActiveSupport::Notifications.instrument("#{action}.action_view".freeze, payload, &block)
+        end
+      end
+
+      EXPLICIT_COLLECTION = /# Template Collection: (?<resource_name>\w+)/
+
+      def extract_resource_cache_name
+        if match = @source.match(EXPLICIT_COLLECTION) || resource_cache_call_match
+          match[:resource_name]
+        end
+      end
+
+      def resource_cache_call_match
+        if @handler.respond_to?(:resource_cache_call_pattern)
+          @source.match(@handler.resource_cache_call_pattern)
+        end
+      end
+
+      def inferred_cache_name
+        @inferred_cache_name ||= @virtual_path.split('/'.freeze).last.sub('_'.freeze, ''.freeze)
       end
   end
 end

data/lib/action_view/template/error.rb

@@ -59,13 +59,20 @@ module ActionView
     class Error < ActionViewError #:nodoc:
       SOURCE_CODE_RADIUS = 3
 
-      attr_reader :original_exception
+      def initialize(template, original_exception = nil)
+        if original_exception
+          ActiveSupport::Deprecation.warn("Passing #original_exception is deprecated and has no effect. " \
+                                          "Exceptions will automatically capture the original exception.", caller)
+        end
+
+        super($!.message)
+        set_backtrace($!.backtrace)
+        @template, @sub_templates = template, nil
+      end
 
-      def initialize(template, original_exception)
-        super(original_exception.message)
-        @template, @original_exception = template, original_exception
-        @sub_templates = nil
-        set_backtrace(original_exception.backtrace)
+      def original_exception
+        ActiveSupport::Deprecation.warn("#original_exception is deprecated. Use #cause instead.", caller)
+        cause
       end
 
       def file_name
@@ -75,7 +82,7 @@ module ActionView
       def sub_template_message
         if @sub_templates
           "Trace of template inclusion: " +
-          @sub_templates.collect { |template| template.inspect }.join(", ")
+          @sub_templates.collect(&:inspect).join(", ")
         else
           ""
         end

data/lib/action_view/template/handlers.rb

@@ -7,9 +7,9 @@ module ActionView #:nodoc:
       autoload :Raw, 'action_view/template/handlers/raw'
 
       def self.extended(base)
-        base.register_default_template_handler :erb, ERB.new
+        base.register_default_template_handler :raw, Raw.new
+        base.register_template_handler :erb, ERB.new
         base.register_template_handler :builder, Builder.new
-        base.register_template_handler :raw, Raw.new
         base.register_template_handler :ruby, :source.to_proc
       end
 
@@ -42,7 +42,7 @@ module ActionView #:nodoc:
       end
 
       def template_handler_extensions
-        @@template_handlers.keys.map {|key| key.to_s }.sort
+        @@template_handlers.keys.map(&:to_s).sort
       end
 
       def registered_template_handler(extension)

data/lib/action_view/template/handlers/erb.rb

@@ -123,6 +123,31 @@ module ActionView
           ).src
         end
 
+        # Returns Regexp to extract a cached resource's name from a cache call at the
+        # first line of a template.
+        # The extracted cache name is captured as :resource_name.
+        #
+        #   <% cache notification do %> # => notification
+        #
+        # The pattern should support templates with a beginning comment:
+        #
+        #   <%# Still extractable even though there's a comment %>
+        #   <% cache notification do %> # => notification
+        #
+        # But fail to extract a name if a resource association is cached.
+        #
+        #   <% cache notification.event do %> # => nil
+        def resource_cache_call_pattern
+          /\A
+            (?:<%\#.*%>)*                 # optional initial comment
+            \s*                           # followed by optional spaces or newlines
+            <%\s*cache[\(\s]              # followed by an ERB call to cache
+            \s*                           # followed by optional spaces or newlines
+            (?<resource_name>\w+)         # capture the cache call argument as :resource_name
+            [\s\)]                        # followed by a space or close paren
+          /xm
+        end
+
       private
 
         def valid_encoding(string, encoding)