actionview 5.0.7.2 → 5.1.0.beta1

data/lib/action_view/record_identifier.rb

@@ -1,5 +1,5 @@
-require 'active_support/core_ext/module'
-require 'action_view/model_naming'
+require "active_support/core_ext/module"
+require "action_view/model_naming"
 
 module ActionView
   # RecordIdentifier encapsulates methods used by various ActionView helpers
@@ -57,8 +57,8 @@ module ActionView
 
     include ModelNaming
 
-    JOIN = '_'.freeze
-    NEW = 'new'.freeze
+    JOIN = "_".freeze
+    NEW = "new".freeze
 
     # The DOM class convention is to use the singular form of an object or class.
     #
@@ -92,7 +92,7 @@ module ActionView
       end
     end
 
-  protected
+  private
 
     # Returns a string representation of the key attribute(s) that is suitable for use in an HTML DOM id.
     # This can be overwritten to customize the default generated string representation if desired.
@@ -102,7 +102,7 @@ module ActionView
     # overwritten version of the method. By default, this implementation passes the key string through a
     # method that replaces all characters that are invalid inside DOM ids, with valid ones. You need to
     # make sure yourself that your dom ids are valid, in case you overwrite this method.
-    def record_key_for_dom_id(record)
+    def record_key_for_dom_id(record) # :doc:
       key = convert_to_model(record).to_key
       key ? key.join(JOIN) : key
     end

data/lib/action_view/renderer/abstract_renderer.rb

@@ -15,7 +15,7 @@ module ActionView
   # that new object is called in turn. This abstracts the setup and rendering
   # into a separate classes for partials and templates.
   class AbstractRenderer #:nodoc:
-    delegate :find_template, :find_file, :template_exists?, :any_templates?, :with_fallbacks, :with_layout_format, :formats, :to => :@lookup_context
+    delegate :find_template, :find_file, :template_exists?, :any_templates?, :with_fallbacks, :with_layout_format, :formats, to: :@lookup_context
 
     def initialize(lookup_context)
       @lookup_context = lookup_context
@@ -25,29 +25,29 @@ module ActionView
       raise NotImplementedError
     end
 
-    protected
+    private
 
-    def extract_details(options)
-      @lookup_context.registered_details.each_with_object({}) do |key, details|
-        value = options[key]
+      def extract_details(options) # :doc:
+        @lookup_context.registered_details.each_with_object({}) do |key, details|
+          value = options[key]
 
-        details[key] = Array(value) if value
+          details[key] = Array(value) if value
+        end
       end
-    end
 
-    def instrument(name, **options)
-      options[:identifier] ||= (@template && @template.identifier) || @path
+      def instrument(name, **options) # :doc:
+        options[:identifier] ||= (@template && @template.identifier) || @path
 
-      ActiveSupport::Notifications.instrument("render_#{name}.action_view", options) do |payload|
-        yield payload
+        ActiveSupport::Notifications.instrument("render_#{name}.action_view", options) do |payload|
+          yield payload
+        end
       end
-    end
 
-    def prepend_formats(formats)
-      formats = Array(formats)
-      return if formats.empty? || @lookup_context.html_fallback_for_js
+      def prepend_formats(formats) # :doc:
+        formats = Array(formats)
+        return if formats.empty? || @lookup_context.html_fallback_for_js
 
-      @lookup_context.formats = formats | @lookup_context.formats
-    end
+        @lookup_context.formats = formats | @lookup_context.formats
+      end
   end
 end

data/lib/action_view/renderer/partial_renderer.rb

@@ -1,5 +1,5 @@
-require 'action_view/renderer/partial_renderer/collection_caching'
-require 'concurrent/map'
+require "concurrent/map"
+require "action_view/renderer/partial_renderer/collection_caching"
 
 module ActionView
   class PartialIteration
@@ -98,8 +98,8 @@ 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" %>
   #
@@ -307,243 +307,244 @@ module ActionView
       if @collection
         render_collection
       else
-        instrument(:partial) do
-          render_partial
-        end
+        render_partial
       end
     end
 
     private
 
-    def render_collection
-      instrument(:collection, count: @collection.size) do |payload|
-        return nil if @collection.blank?
+      def render_collection
+        instrument(:collection, count: @collection.size) do |payload|
+          return nil if @collection.blank?
 
-        if @options.key?(:spacer_template)
-          spacer = find_template(@options[:spacer_template], @locals.keys).render(@view, @locals)
-        end
+          if @options.key?(:spacer_template)
+            spacer = find_template(@options[:spacer_template], @locals.keys).render(@view, @locals)
+          end
 
-        cache_collection_render(payload) do
-          @template ? collection_with_template : collection_without_template
-        end.join(spacer).html_safe
+          cache_collection_render(payload) do
+            @template ? collection_with_template : collection_without_template
+          end.join(spacer).html_safe
+        end
       end
-    end
 
-    def render_partial
-      view, locals, block = @view, @locals, @block
-      object, as = @object, @variable
+      def render_partial
+        instrument(:partial) do |payload|
+          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 if @has_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.cache_hit
+          content
+        end
       end
 
-      content = layout.render(view, locals){ content } if layout
-      content
-    end
+      # 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
+          else
+            @path = partial_path
+          end
+        end
 
-    # 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 as = options[:as]
+          raise_invalid_option_as(as) unless /\A[a-z_]\w*\z/.match?(as.to_s)
+          as = as.to_sym
+        end
 
-        if @collection
-          paths = @collection_data = @collection.map { |o| partial_path(o) }
-          @path = paths.uniq.one? ? paths.first : nil
+        if @path
+          @variable, @variable_counter, @variable_iteration = retrieve_variable(@path, as)
+          @template_keys = retrieve_template_keys
         else
-          @path = partial_path
+          paths.map! { |path| retrieve_variable(path, as).unshift(path) }
         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 collection_from_options
+        if @options.key?(:collection)
+          collection = @options[:collection]
+          collection ? collection.to_a : []
+        end
       end
 
-      self
-    end
-
-    def collection_from_options
-      if @options.key?(:collection)
-        collection = @options[:collection]
-        collection ? collection.to_a : []
+      def collection_from_object
+        @object.to_ary if @object.respond_to?(:to_ary)
       end
-    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
+        find_template(@path, @template_keys) if @path
+      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, locals, template = @view, @locals, @template
+        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!
+          content
+        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 = @view, @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, iteration]))
-        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!
+          content
+        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 = @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.")
+        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
+        keys = @locals.keys
+        keys << @variable if @has_object || @collection
+        if @collection
+          keys << @variable_counter
+          keys << @variable_iteration
+        end
+        keys
       end
-      keys
-    end
 
-    def retrieve_variable(path, as)
-      variable = as || begin
-        base = path[-1] == "/".freeze ? "".freeze : 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"
+      def retrieve_variable(path, as)
+        variable = as || begin
+          base = path[-1] == "/".freeze ? "".freeze : 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."
+      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