actionview 4.2.11.1 → 6.0.4

data/lib/action_view/renderer/partial_renderer.rb

@@ -1,4 +1,7 @@
-require 'thread_safe'
+# frozen_string_literal: true
+
+require "concurrent/map"
+require "action_view/renderer/partial_renderer/collection_caching"
 
 module ActionView
   class PartialIteration
@@ -49,12 +52,12 @@ module ActionView
   #     <%= render partial: "ad", locals: { ad: ad } %>
   #   <% end %>
   #
-  # This would first render "advertiser/_account.html.erb" with @buyer passed in as the local variable +account+, then
-  # render "advertiser/_ad.html.erb" and pass the local variable +ad+ to the template for display.
+  # This would first render <tt>advertiser/_account.html.erb</tt> with <tt>@buyer</tt> passed in as the local variable +account+, then
+  # render <tt>advertiser/_ad.html.erb</tt> and pass the local variable +ad+ to the template for display.
   #
   # == The :as and :object options
   #
-  # By default <tt>ActionView::PartialRenderer</tt> doesn't have any local variables.
+  # By default ActionView::PartialRenderer doesn't have any local variables.
   # The <tt>:object</tt> option can be used to pass an object to the partial. For instance:
   #
   #   <%= render partial: "account", object: @buyer %>
@@ -73,7 +76,7 @@ module ActionView
   #
   #   <%= render partial: "account", locals: { user: @buyer } %>
   #
-  # == Rendering a collection of partials
+  # == \Rendering a collection of partials
   #
   # The example of partial use describes a familiar pattern where a template needs to iterate over an array and
   # render a sub template for each of the elements. This pattern has been implemented as a single method that
@@ -82,7 +85,7 @@ module ActionView
   #
   #   <%= render partial: "ad", collection: @advertisements %>
   #
-  # This will render "advertiser/_ad.html.erb" and pass the local variable +ad+ to the template for display. An
+  # This will render <tt>advertiser/_ad.html.erb</tt> and pass the local variable +ad+ to the template for display. An
   # iteration object will automatically be made available to the template with a name of the form
   # +partial_name_iteration+. The iteration object has knowledge about which index the current object has in
   # the collection and the total size of the collection. The iteration object also has two convenience methods,
@@ -97,37 +100,34 @@ module ActionView
   #
   #   <%= render partial: "ad", collection: @advertisements, spacer_template: "ad_divider" %>
   #
-  # If the given <tt>:collection</tt> is nil or empty, <tt>render</tt> will return nil. This will allow you
-  # to specify a text which will displayed instead by using this form:
+  # If the given <tt>:collection</tt> is +nil+ or empty, <tt>render</tt> will return +nil+. This will allow you
+  # to specify a text which will be displayed instead by using this form:
   #
   #   <%= render(partial: "ad", collection: @advertisements) || "There's no ad to be displayed" %>
   #
-  # NOTE: Due to backwards compatibility concerns, the collection can't be one of hashes. Normally you'd also
-  # just keep domain objects, like Active Records, in there.
-  #
-  # == Rendering shared partials
+  # == \Rendering shared partials
   #
   # Two controllers can share a set of partials and render them like this:
   #
   #   <%= render partial: "advertisement/ad", locals: { ad: @advertisement } %>
   #
-  # This will render the partial "advertisement/_ad.html.erb" regardless of which controller this is being called from.
+  # This will render the partial <tt>advertisement/_ad.html.erb</tt> regardless of which controller this is being called from.
   #
-  # == Rendering objects that respond to `to_partial_path`
+  # == \Rendering objects that respond to +to_partial_path+
   #
   # Instead of explicitly naming the location of a partial, you can also let PartialRenderer do the work
-  # and pick the proper path by checking `to_partial_path` method.
+  # and pick the proper path by checking +to_partial_path+ method.
   #
   #  # @account.to_partial_path returns 'accounts/account', so it can be used to replace:
   #  # <%= render partial: "accounts/account", locals: { account: @account} %>
   #  <%= render partial: @account %>
   #
-  #  # @posts is an array of Post instances, so every post record returns 'posts/post' on `to_partial_path`,
+  #  # @posts is an array of Post instances, so every post record returns 'posts/post' on +to_partial_path+,
   #  # that's why we can replace:
   #  # <%= render partial: "posts/post", collection: @posts %>
   #  <%= render partial: @posts %>
   #
-  # == Rendering the default case
+  # == \Rendering the default case
   #
   # If you're not going to be using any of the options like collections or layouts, you can also use the short-hand
   # defaults of render to render partials. Examples:
@@ -142,34 +142,34 @@ module ActionView
   #  # <%= render partial: "accounts/account", locals: { account: @account} %>
   #  <%= render @account %>
   #
-  #  # @posts is an array of Post instances, so every post record returns 'posts/post' on `to_partial_path`,
+  #  # @posts is an array of Post instances, so every post record returns 'posts/post' on +to_partial_path+,
   #  # that's why we can replace:
   #  # <%= render partial: "posts/post", collection: @posts %>
   #  <%= render @posts %>
   #
-  # == Rendering partials with layouts
+  # == \Rendering partials with layouts
   #
   # Partials can have their own layouts applied to them. These layouts are different than the ones that are
   # specified globally for the entire action, but they work in a similar fashion. Imagine a list with two types
   # of users:
   #
-  #   <%# app/views/users/index.html.erb &>
+  #   <%# app/views/users/index.html.erb %>
   #   Here's the administrator:
   #   <%= render partial: "user", layout: "administrator", locals: { user: administrator } %>
   #
   #   Here's the editor:
   #   <%= render partial: "user", layout: "editor", locals: { user: editor } %>
   #
-  #   <%# app/views/users/_user.html.erb &>
+  #   <%# app/views/users/_user.html.erb %>
   #   Name: <%= user.name %>
   #
-  #   <%# app/views/users/_administrator.html.erb &>
+  #   <%# app/views/users/_administrator.html.erb %>
   #   <div id="administrator">
   #     Budget: $<%= user.budget %>
   #     <%= yield %>
   #   </div>
   #
-  #   <%# app/views/users/_editor.html.erb &>
+  #   <%# app/views/users/_editor.html.erb %>
   #   <div id="editor">
   #     Deadline: <%= user.deadline %>
   #     <%= yield %>
@@ -232,7 +232,7 @@ module ActionView
   #
   # You can also apply a layout to a block within any template:
   #
-  #   <%# app/views/users/_chief.html.erb &>
+  #   <%# app/views/users/_chief.html.erb %>
   #   <%= render(layout: "administrator", locals: { user: chief }) do %>
   #     Title: <%= chief.title %>
   #   <% end %>
@@ -249,13 +249,13 @@ module ActionView
   # If you pass arguments to "yield" then this will be passed to the block. One way to use this is to pass
   # an array to layout and treat it as an enumerable.
   #
-  #   <%# app/views/users/_user.html.erb &>
+  #   <%# app/views/users/_user.html.erb %>
   #   <div class="user">
   #     Budget: $<%= user.budget %>
   #     <%= yield user %>
   #   </div>
   #
-  #   <%# app/views/users/index.html.erb &>
+  #   <%# app/views/users/index.html.erb %>
   #   <%= render layout: @users do |user| %>
   #     Title: <%= user.title %>
   #   <% end %>
@@ -264,14 +264,14 @@ module ActionView
   #
   # You can also yield multiple times in one layout and use block arguments to differentiate the sections.
   #
-  #   <%# app/views/users/_user.html.erb &>
+  #   <%# app/views/users/_user.html.erb %>
   #   <div class="user">
   #     <%= yield user, :header %>
   #     Budget: $<%= user.budget %>
   #     <%= yield user, :footer %>
   #   </div>
   #
-  #   <%# app/views/users/index.html.erb &>
+  #   <%# app/views/users/index.html.erb %>
   #   <%= render layout: @users do |user, section| %>
   #     <%- case section when :header -%>
   #       Title: <%= user.title %>
@@ -280,8 +280,10 @@ module ActionView
   #     <%- end -%>
   #   <% end %>
   class PartialRenderer < AbstractRenderer
-    PREFIXED_PARTIAL_NAMES = ThreadSafe::Cache.new do |h, k|
-      h[k] = ThreadSafe::Cache.new
+    include CollectionCaching
+
+    PREFIXED_PARTIAL_NAMES = Concurrent::Map.new do |h, k|
+      h[k] = Concurrent::Map.new
     end
 
     def initialize(*)
@@ -290,259 +292,271 @@ module ActionView
     end
 
     def render(context, options, block)
-      setup(context, options, block)
-      identifier = (@template = find_partial) ? @template.identifier : @path
+      as = as_variable(options)
+      setup(context, options, as, block)
 
-      @lookup_context.rendered_format ||= begin
-        if @template && @template.formats.present?
-          @template.formats.first
+      if @path
+        if @has_object || @collection
+          @variable, @variable_counter, @variable_iteration = retrieve_variable(@path, as)
+          @template_keys = retrieve_template_keys(@variable)
         else
-          formats.first
+          @template_keys = @locals.keys
         end
+        template = find_partial(@path, @template_keys)
+        @variable ||= template.variable
+      else
+        if options[:cached]
+          raise NotImplementedError, "render caching requires a template. Please specify a partial when rendering"
+        end
+        template = nil
       end
 
       if @collection
-        instrument(:collection, :identifier => identifier || "collection", :count => @collection.size) do
-          render_collection
-        end
+        render_collection(context, template)
       else
-        instrument(:partial, :identifier => identifier) do
-          render_partial
-        end
+        render_partial(context, template)
       end
     end
 
     private
-
-    def render_collection
-      return nil if @collection.blank?
-
-      if @options.key?(:spacer_template)
-        spacer = find_template(@options[:spacer_template], @locals.keys).render(@view, @locals)
+      def render_collection(view, template)
+        identifier = (template && template.identifier) || @path
+        instrument(:collection, identifier: identifier, count: @collection.size) do |payload|
+          return RenderedCollection.empty(@lookup_context.formats.first) if @collection.blank?
+
+          spacer = if @options.key?(:spacer_template)
+            spacer_template = find_template(@options[:spacer_template], @locals.keys)
+            build_rendered_template(spacer_template.render(view, @locals), spacer_template)
+          else
+            RenderedTemplate::EMPTY_SPACER
+          end
+
+          collection_body = if template
+            cache_collection_render(payload, view, template) do
+              collection_with_template(view, template)
+            end
+          else
+            collection_without_template(view)
+          end
+          build_rendered_collection(collection_body, spacer)
+        end
       end
 
-      result = @template ? collection_with_template : collection_without_template
-      result.join(spacer).html_safe
-    end
+      def render_partial(view, template)
+        instrument(:partial, identifier: template.identifier) do |payload|
+          locals, block = @locals, @block
+          object, as = @object, @variable
 
-    def render_partial
-      view, locals, block = @view, @locals, @block
-      object, as = @object, @variable
+          if !block && (layout = @options[:layout])
+            layout = find_template(layout.to_s, @template_keys)
+          end
 
-      if !block && (layout = @options[:layout])
-        layout = find_template(layout.to_s, @template_keys)
-      end
+          object = locals[as] if object.nil? # Respect object when object is false
+          locals[as] = object if @has_object
 
-      object = locals[as] if object.nil? # Respect object when object is false
-      locals[as] = object
+          content = template.render(view, locals) do |*name|
+            view._layout_for(*name, &block)
+          end
 
-      content = @template.render(view, locals) do |*name|
-        view._layout_for(*name, &block)
+          content = layout.render(view, locals) { content } if layout
+          payload[:cache_hit] = view.view_renderer.cache_hits[template.virtual_path]
+          build_rendered_template(content, template, layout)
+        end
       end
 
-      content = layout.render(view, locals){ content } if layout
-      content
-    end
-
-    private
-
-    # Sets up instance variables needed for rendering a partial. This method
-    # finds the options and details and extracts them. The method also contains
-    # logic that handles the type of object passed in as the partial.
-    #
-    # If +options[:partial]+ is a string, then the +@path+ instance variable is
-    # set to that string. Otherwise, the +options[:partial]+ object must
-    # respond to +to_partial_path+ in order to setup the path.
-    def setup(context, options, block)
-      @view   = context
-      @options = options
-      @block   = block
-
-      @locals  = options[:locals] || {}
-      @details = extract_details(options)
-
-      prepend_formats(options[:formats])
-
-      partial = options[:partial]
-
-      if String === partial
-        @has_object = options.key?(:object)
-        @object     = options[:object]
-        @collection = collection_from_options
-        @path       = partial
-      else
-        @has_object = true
-        @object = partial
-        @collection = collection_from_object || collection_from_options
-
-        if @collection
-          paths = @collection_data = @collection.map { |o| partial_path(o) }
-          @path = paths.uniq.one? ? paths.first : nil
+      # Sets up instance variables needed for rendering a partial. This method
+      # finds the options and details and extracts them. The method also contains
+      # logic that handles the type of object passed in as the partial.
+      #
+      # If +options[:partial]+ is a string, then the <tt>@path</tt> instance variable is
+      # set to that string. Otherwise, the +options[:partial]+ object must
+      # respond to +to_partial_path+ in order to setup the path.
+      def setup(context, options, as, block)
+        @options = options
+        @block   = block
+
+        @locals  = options[:locals] || {}
+        @details = extract_details(options)
+
+        partial = options[:partial]
+
+        if String === partial
+          @has_object = options.key?(:object)
+          @object     = options[:object]
+          @collection = collection_from_options
+          @path       = partial
         else
-          @path = partial_path
+          @has_object = true
+          @object = partial
+          @collection = collection_from_object || collection_from_options
+
+          if @collection
+            paths = @collection_data = @collection.map { |o| partial_path(o, context) }
+            if paths.uniq.length == 1
+              @path = paths.first
+            else
+              paths.map! { |path| retrieve_variable(path, as).unshift(path) }
+              @path = nil
+            end
+          else
+            @path = partial_path(@object, context)
+          end
         end
-      end
 
-      if as = options[:as]
-        raise_invalid_option_as(as) unless as.to_s =~ /\A[a-z_]\w*\z/
-        as = as.to_sym
+        self
       end
 
-      if @path
-        @variable, @variable_counter, @variable_iteration = retrieve_variable(@path, as)
-        @template_keys = retrieve_template_keys
-      else
-        paths.map! { |path| retrieve_variable(path, as).unshift(path) }
+      def as_variable(options)
+        if as = options[:as]
+          raise_invalid_option_as(as) unless /\A[a-z_]\w*\z/.match?(as.to_s)
+          as.to_sym
+        end
       end
 
-      self
-    end
-
-    def collection_from_options
-      if @options.key?(:collection)
-        collection = @options[:collection]
-        collection.respond_to?(:to_ary) ? collection.to_ary : []
+      def collection_from_options
+        if @options.key?(:collection)
+          collection = @options[:collection]
+          collection ? collection.to_a : []
+        end
       end
-    end
 
-    def collection_from_object
-      @object.to_ary if @object.respond_to?(:to_ary)
-    end
+      def collection_from_object
+        @object.to_ary if @object.respond_to?(:to_ary)
+      end
 
-    def find_partial
-      find_template(@path, @template_keys) if @path
-    end
+      def find_partial(path, template_keys)
+        find_template(path, template_keys)
+      end
 
-    def find_template(path, locals)
-      prefixes = path.include?(?/) ? [] : @lookup_context.prefixes
-      @lookup_context.find_template(path, prefixes, true, locals, @details)
-    end
+      def find_template(path, locals)
+        prefixes = path.include?(?/) ? [] : @lookup_context.prefixes
+        @lookup_context.find_template(path, prefixes, true, locals, @details)
+      end
 
-    def collection_with_template
-      view, locals, template = @view, @locals, @template
-      as, counter, iteration = @variable, @variable_counter, @variable_iteration
+      def collection_with_template(view, template)
+        locals = @locals
+        as, counter, iteration = @variable, @variable_counter, @variable_iteration
 
-      if layout = @options[:layout]
-        layout = find_template(layout, @template_keys)
-      end
+        if layout = @options[:layout]
+          layout = find_template(layout, @template_keys)
+        end
 
-      partial_iteration = PartialIteration.new(@collection.size)
-      locals[iteration] = partial_iteration
+        partial_iteration = PartialIteration.new(@collection.size)
+        locals[iteration] = partial_iteration
 
-      @collection.map do |object|
-        locals[as]        = object
-        locals[counter]   = partial_iteration.index
+        @collection.map do |object|
+          locals[as]        = object
+          locals[counter]   = partial_iteration.index
 
-        content = template.render(view, locals)
-        content = layout.render(view, locals) { content } if layout
-        partial_iteration.iterate!
-        content
+          content = template.render(view, locals)
+          content = layout.render(view, locals) { content } if layout
+          partial_iteration.iterate!
+          build_rendered_template(content, template, layout)
+        end
       end
-    end
 
-    def collection_without_template
-      view, locals, collection_data = @view, @locals, @collection_data
-      cache = {}
-      keys  = @locals.keys
+      def collection_without_template(view)
+        locals, collection_data = @locals, @collection_data
+        cache = {}
+        keys  = @locals.keys
 
-      partial_iteration = PartialIteration.new(@collection.size)
+        partial_iteration = PartialIteration.new(@collection.size)
 
-      @collection.map do |object|
-        index = partial_iteration.index
-        path, as, counter, iteration = collection_data[index]
+        @collection.map do |object|
+          index = partial_iteration.index
+          path, as, counter, iteration = collection_data[index]
 
-        locals[as]        = object
-        locals[counter]   = index
-        locals[iteration] = partial_iteration
+          locals[as]        = object
+          locals[counter]   = index
+          locals[iteration] = partial_iteration
 
-        template = (cache[path] ||= find_template(path, keys + [as, counter]))
-        content = template.render(view, locals)
-        partial_iteration.iterate!
-        content
+          template = (cache[path] ||= find_template(path, keys + [as, counter, iteration]))
+          content = template.render(view, locals)
+          partial_iteration.iterate!
+          build_rendered_template(content, template)
+        end
       end
-    end
 
-    # Obtains the path to where the object's partial is located. If the object
-    # responds to +to_partial_path+, then +to_partial_path+ will be called and
-    # will provide the path. If the object does not respond to +to_partial_path+,
-    # then an +ArgumentError+ is raised.
-    #
-    # If +prefix_partial_path_with_controller_namespace+ is true, then this
-    # method will prefix the partial paths with a namespace.
-    def partial_path(object = @object)
-      object = object.to_model if object.respond_to?(:to_model)
-
-      path = if object.respond_to?(:to_partial_path)
-        object.to_partial_path
-      else
-        raise ArgumentError.new("'#{object.inspect}' is not an ActiveModel-compatible object. It must implement :to_partial_path.")
+      # Obtains the path to where the object's partial is located. If the object
+      # responds to +to_partial_path+, then +to_partial_path+ will be called and
+      # will provide the path. If the object does not respond to +to_partial_path+,
+      # then an +ArgumentError+ is raised.
+      #
+      # If +prefix_partial_path_with_controller_namespace+ is true, then this
+      # method will prefix the partial paths with a namespace.
+      def partial_path(object, view)
+        object = object.to_model if object.respond_to?(:to_model)
+
+        path = if object.respond_to?(:to_partial_path)
+          object.to_partial_path
+        else
+          raise ArgumentError.new("'#{object.inspect}' is not an ActiveModel-compatible object. It must implement :to_partial_path.")
+        end
+
+        if view.prefix_partial_path_with_controller_namespace
+          prefixed_partial_names[path] ||= merge_prefix_into_object_path(@context_prefix, path.dup)
+        else
+          path
+        end
       end
 
-      if @view.prefix_partial_path_with_controller_namespace
-        prefixed_partial_names[path] ||= merge_prefix_into_object_path(@context_prefix, path.dup)
-      else
-        path
+      def prefixed_partial_names
+        @prefixed_partial_names ||= PREFIXED_PARTIAL_NAMES[@context_prefix]
       end
-    end
 
-    def prefixed_partial_names
-      @prefixed_partial_names ||= PREFIXED_PARTIAL_NAMES[@context_prefix]
-    end
+      def merge_prefix_into_object_path(prefix, object_path)
+        if prefix.include?(?/) && object_path.include?(?/)
+          prefixes = []
+          prefix_array = File.dirname(prefix).split("/")
+          object_path_array = object_path.split("/")[0..-3] # skip model dir & partial
 
-    def merge_prefix_into_object_path(prefix, object_path)
-      if prefix.include?(?/) && object_path.include?(?/)
-        prefixes = []
-        prefix_array = File.dirname(prefix).split('/')
-        object_path_array = object_path.split('/')[0..-3] # skip model dir & partial
+          prefix_array.each_with_index do |dir, index|
+            break if dir == object_path_array[index]
+            prefixes << dir
+          end
 
-        prefix_array.each_with_index do |dir, index|
-          break if dir == object_path_array[index]
-          prefixes << dir
+          (prefixes << object_path).join("/")
+        else
+          object_path
         end
-
-        (prefixes << object_path).join("/")
-      else
-        object_path
       end
-    end
 
-    def retrieve_template_keys
-      keys = @locals.keys
-      keys << @variable if @has_object || @collection
-      if @collection
-        keys << @variable_counter
-        keys << @variable_iteration
+      def retrieve_template_keys(variable)
+        keys = @locals.keys
+        keys << variable
+        if @collection
+          keys << @variable_counter
+          keys << @variable_iteration
+        end
+        keys
       end
-      keys
-    end
 
-    def retrieve_variable(path, as)
-      variable = as || begin
-        base = path[-1] == "/" ? "" : File.basename(path)
-        raise_invalid_identifier(path) unless base =~ /\A_?([a-z]\w*)(\.\w+)*\z/
-        $1.to_sym
-      end
-      if @collection
-        variable_counter = :"#{variable}_counter"
-        variable_iteration = :"#{variable}_iteration"
+      def retrieve_variable(path, as)
+        variable = as || begin
+          base = path[-1] == "/" ? "" : File.basename(path)
+          raise_invalid_identifier(path) unless base =~ /\A_?(.*?)(?:\.\w+)*\z/
+          $1.to_sym
+        end
+        if @collection
+          variable_counter = :"#{variable}_counter"
+          variable_iteration = :"#{variable}_iteration"
+        end
+        [variable, variable_counter, variable_iteration]
       end
-      [variable, variable_counter, variable_iteration]
-    end
 
-    IDENTIFIER_ERROR_MESSAGE = "The partial name (%s) is not a valid Ruby identifier; " +
-                               "make sure your partial name starts with underscore, " +
-                               "and is followed by any combination of letters, numbers and underscores."
+      IDENTIFIER_ERROR_MESSAGE = "The partial name (%s) is not a valid Ruby identifier; " \
+                                 "make sure your partial name starts with underscore."
 
-    OPTION_AS_ERROR_MESSAGE  = "The value (%s) of the option `as` is not a valid Ruby identifier; " +
-                               "make sure it starts with lowercase letter, " +
-                               "and is followed by any combination of letters, numbers and underscores."
+      OPTION_AS_ERROR_MESSAGE  = "The value (%s) of the option `as` is not a valid Ruby identifier; " \
+                                 "make sure it starts with lowercase letter, " \
+                                 "and is followed by any combination of letters, numbers and underscores."
 
-    def raise_invalid_identifier(path)
-      raise ArgumentError.new(IDENTIFIER_ERROR_MESSAGE % (path))
-    end
+      def raise_invalid_identifier(path)
+        raise ArgumentError.new(IDENTIFIER_ERROR_MESSAGE % (path))
+      end
 
-    def raise_invalid_option_as(as)
-      raise ArgumentError.new(OPTION_AS_ERROR_MESSAGE % (as))
-    end
+      def raise_invalid_option_as(as)
+        raise ArgumentError.new(OPTION_AS_ERROR_MESSAGE % (as))
+      end
   end
 end