actionview 5.0.7.2 → 5.1.0.beta1

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

@@ -25,9 +25,15 @@ module ActionView
         end
       end
 
+      def callable_cache_key?
+        @options[:cached].respond_to?(:call)
+      end
+
       def collection_by_cache_keys
+        seed = callable_cache_key? ? @options[:cached] : ->(i) { i }
+
         @collection.each_with_object({}) do |item, hash|
-          hash[expanded_cache_key(item)] = item
+          hash[expanded_cache_key(seed.call(item))] = item
         end
       end
 

data/lib/action_view/renderer/streaming_template_renderer.rb

@@ -1,10 +1,9 @@
-require 'fiber'
+require "fiber"
 
 module ActionView
   # == TODO
   #
   # * Support streaming from child templates, partials and so on.
-  # * Integrate exceptions with exceptron
   # * Rack::Cache needs to support streaming bodies
   class StreamingTemplateRenderer < TemplateRenderer #:nodoc:
     # A valid Rack::Body (i.e. it responds to each).
@@ -27,17 +26,16 @@ module ActionView
 
       private
 
-      # This is the same logging logic as in ShowExceptions middleware.
-      # TODO Once "exceptron" is in, refactor this piece to simply re-use exceptron.
-      def log_error(exception) #:nodoc:
-        logger = ActionView::Base.logger
-        return unless logger
+        # This is the same logging logic as in ShowExceptions middleware.
+        def log_error(exception)
+          logger = ActionView::Base.logger
+          return unless logger
 
-        message = "\n#{exception.class} (#{exception.message}):\n"
-        message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
-        message << "  " << exception.backtrace.join("\n  ")
-        logger.fatal("#{message}\n\n")
-      end
+          message = "\n#{exception.class} (#{exception.message}):\n"
+          message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
+          message << "  " << exception.backtrace.join("\n  ")
+          logger.fatal("#{message}\n\n")
+        end
     end
 
     # For streaming, instead of rendering a given a template, we return a Body
@@ -56,48 +54,48 @@ module ActionView
 
     private
 
-    def delayed_render(buffer, template, layout, view, locals)
-      # Wrap the given buffer in the StreamingBuffer and pass it to the
-      # underlying template handler. Now, every time something is concatenated
-      # to the buffer, it is not appended to an array, but streamed straight
-      # to the client.
-      output  = ActionView::StreamingBuffer.new(buffer)
-      yielder = lambda { |*name| view._layout_for(*name) }
-
-      instrument(:template, :identifier => template.identifier, :layout => layout.try(:virtual_path)) do
-        fiber = Fiber.new do
-          if layout
-            layout.render(view, locals, output, &yielder)
-          else
-            # If you don't have a layout, just render the thing
-            # and concatenate the final result. This is the same
-            # as a layout with just <%= yield %>
-            output.safe_concat view._layout_for
+      def delayed_render(buffer, template, layout, view, locals)
+        # Wrap the given buffer in the StreamingBuffer and pass it to the
+        # underlying template handler. Now, every time something is concatenated
+        # to the buffer, it is not appended to an array, but streamed straight
+        # to the client.
+        output  = ActionView::StreamingBuffer.new(buffer)
+        yielder = lambda { |*name| view._layout_for(*name) }
+
+        instrument(:template, identifier: template.identifier, layout: layout.try(:virtual_path)) do
+          fiber = Fiber.new do
+            if layout
+              layout.render(view, locals, output, &yielder)
+            else
+              # If you don't have a layout, just render the thing
+              # and concatenate the final result. This is the same
+              # as a layout with just <%= yield %>
+              output.safe_concat view._layout_for
+            end
           end
-        end
 
-        # Set the view flow to support streaming. It will be aware
-        # when to stop rendering the layout because it needs to search
-        # something in the template and vice-versa.
-        view.view_flow = StreamingFlow.new(view, fiber)
+          # Set the view flow to support streaming. It will be aware
+          # when to stop rendering the layout because it needs to search
+          # something in the template and vice-versa.
+          view.view_flow = StreamingFlow.new(view, fiber)
 
-        # Yo! Start the fiber!
-        fiber.resume
+          # Yo! Start the fiber!
+          fiber.resume
 
-        # If the fiber is still alive, it means we need something
-        # from the template, so start rendering it. If not, it means
-        # the layout exited without requiring anything from the template.
-        if fiber.alive?
-          content = template.render(view, locals, &yielder)
+          # If the fiber is still alive, it means we need something
+          # from the template, so start rendering it. If not, it means
+          # the layout exited without requiring anything from the template.
+          if fiber.alive?
+            content = template.render(view, locals, &yielder)
 
-          # Once rendering the template is done, sets its content in the :layout key.
-          view.view_flow.set(:layout, content)
+            # Once rendering the template is done, sets its content in the :layout key.
+            view.view_flow.set(:layout, content)
 
-          # In case the layout continues yielding, we need to resume
-          # the fiber until all yields are handled.
-          fiber.resume while fiber.alive?
+            # In case the layout continues yielding, we need to resume
+            # the fiber until all yields are handled.
+            fiber.resume while fiber.alive?
+          end
         end
       end
-    end
   end
 end

data/lib/action_view/renderer/template_renderer.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/object/try'
+require "active_support/core_ext/object/try"
 
 module ActionView
   class TemplateRenderer < AbstractRenderer #:nodoc:
@@ -16,87 +16,85 @@ module ActionView
 
     private
 
-    # Determine the template to be rendered using the given options.
-    def determine_template(options)
-      keys = options.has_key?(:locals) ? options[:locals].keys : []
+      # Determine the template to be rendered using the given options.
+      def determine_template(options)
+        keys = options.has_key?(:locals) ? options[:locals].keys : []
 
-      if options.key?(:body)
-        Template::Text.new(options[:body])
-      elsif options.key?(:text)
-        Template::Text.new(options[:text], formats.first)
-      elsif options.key?(:plain)
-        Template::Text.new(options[:plain])
-      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) }
-      elsif options.key?(:inline)
-        handler = Template.handler_for_extension(options[:type] || "erb")
-        Template.new(options[:inline], "inline template", handler, :locals => keys)
-      elsif options.key?(:template)
-        if options[:template].respond_to?(:render)
-          options[:template]
+        if options.key?(:body)
+          Template::Text.new(options[:body])
+        elsif options.key?(:plain)
+          Template::Text.new(options[:plain])
+        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) }
+        elsif options.key?(:inline)
+          handler = Template.handler_for_extension(options[:type] || "erb")
+          Template.new(options[:inline], "inline template", handler, locals: keys)
+        elsif options.key?(:template)
+          if options[:template].respond_to?(:render)
+            options[:template]
+          else
+            find_template(options[:template], options[:prefixes], false, keys, @details)
+          end
         else
-          find_template(options[:template], options[:prefixes], false, keys, @details)
+          raise ArgumentError, "You invoked render but did not give any of :partial, :template, :inline, :file, :plain, :html or :body option."
         end
-      else
-        raise ArgumentError, "You invoked render but did not give any of :partial, :template, :inline, :file, :plain, :html, :text or :body option."
       end
-    end
 
-    # Renders the given template. A string representing the layout can be
-    # supplied as well.
-    def render_template(template, layout_name = nil, locals = nil) #:nodoc:
-      view, locals = @view, locals || {}
+      # Renders the given template. A string representing the layout can be
+      # supplied as well.
+      def render_template(template, layout_name = nil, locals = nil)
+        view, locals = @view, locals || {}
 
-      render_with_layout(layout_name, locals) do |layout|
-        instrument(:template, :identifier => template.identifier, :layout => layout.try(:virtual_path)) do
-          template.render(view, locals) { |*name| view._layout_for(*name) }
+        render_with_layout(layout_name, locals) do |layout|
+          instrument(:template, identifier: template.identifier, layout: layout.try(:virtual_path)) do
+            template.render(view, locals) { |*name| view._layout_for(*name) }
+          end
         end
       end
-    end
 
-    def render_with_layout(path, locals) #:nodoc:
-      layout  = path && find_layout(path, locals.keys, [formats.first])
-      content = yield(layout)
+      def render_with_layout(path, locals)
+        layout  = path && find_layout(path, locals.keys, [formats.first])
+        content = yield(layout)
 
-      if layout
-        view = @view
-        view.view_flow.set(:layout, content)
-        layout.render(view, locals){ |*name| view._layout_for(*name) }
-      else
-        content
+        if layout
+          view = @view
+          view.view_flow.set(:layout, content)
+          layout.render(view, locals) { |*name| view._layout_for(*name) }
+        else
+          content
+        end
       end
-    end
 
-    # 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, formats)
-      resolve_layout(layout, keys, formats)
-    end
+      # 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, formats)
+        resolve_layout(layout, keys, formats)
+      end
 
-    def resolve_layout(layout, keys, formats)
-      details = @details.dup
-      details[:formats] = formats
+      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) }
-          else
-            find_template(layout, nil, false, keys, details)
+        case layout
+        when String
+          begin
+            if layout.start_with?("/")
+              with_fallbacks { find_template(layout, nil, false, [], details) }
+            else
+              find_template(layout, nil, false, [], details)
+            end
+          rescue ActionView::MissingTemplate
+            all_details = @details.merge(formats: @lookup_context.default_formats)
+            raise unless template_exists?(layout, nil, false, [], all_details)
           end
-        rescue ActionView::MissingTemplate
-          all_details = @details.merge(:formats => @lookup_context.default_formats)
-          raise unless template_exists?(layout, nil, false, keys, all_details)
+        when Proc
+          resolve_layout(layout.call(formats), keys, formats)
+        else
+          layout
         end
-      when Proc
-        resolve_layout(layout.call(formats), keys, formats)
-      else
-        layout
       end
-    end
   end
 end

data/lib/action_view/rendering.rb

@@ -84,15 +84,14 @@ module ActionView
     end
 
     def rendered_format
-      format = lookup_context.rendered_format
-      Template::Types[format] || format
+      Template::Types[lookup_context.rendered_format]
     end
 
     private
 
       # Find and render a template based on the options given.
       # :api: private
-      def _render_template(options) #:nodoc:
+      def _render_template(options)
         variant = options.delete(:variant)
         assigns = options.delete(:assigns)
         context = view_context
@@ -105,7 +104,7 @@ module ActionView
       end
 
       # Assign the rendered format to look up context.
-      def _process_format(format) #:nodoc:
+      def _process_format(format)
         super
         lookup_context.formats = [format.to_sym]
         lookup_context.rendered_format = lookup_context.formats.first
@@ -114,7 +113,7 @@ module ActionView
       # Normalize args by converting render "foo" to render :action => "foo" and
       # render "foo/bar" to render :template => "foo/bar".
       # :api: private
-      def _normalize_args(action=nil, options={})
+      def _normalize_args(action = nil, options = {})
         options = super(action, options)
         case action
         when NilClass

data/lib/action_view/routing_url_for.rb

@@ -1,8 +1,7 @@
-require 'action_dispatch/routing/polymorphic_routes'
+require "action_dispatch/routing/polymorphic_routes"
 
 module ActionView
   module RoutingUrlFor
-
     # Returns the URL for the set of +options+ provided. This takes the
     # same options as +url_for+ in Action Controller (see the
     # documentation for <tt>ActionController::Base#url_for</tt>). Note that by default
@@ -123,18 +122,15 @@ module ActionView
       controller.url_options
     end
 
-    def _routes_context #:nodoc:
-      controller
-    end
-    protected :_routes_context
-
-    def optimize_routes_generation? #:nodoc:
-      controller.respond_to?(:optimize_routes_generation?, true) ?
-        controller.optimize_routes_generation? : super
-    end
-    protected :optimize_routes_generation?
-
     private
+      def _routes_context
+        controller
+      end
+
+      def optimize_routes_generation?
+        controller.respond_to?(:optimize_routes_generation?, true) ?
+          controller.optimize_routes_generation? : super
+      end
 
       def _generate_paths_by_default
         true

data/lib/action_view/tasks/cache_digests.rake

@@ -1,19 +1,19 @@
 namespace :cache_digests do
-  desc 'Lookup nested dependencies for TEMPLATE (like messages/show or comments/_comment.html)'
-  task :nested_dependencies => :environment do
-    abort 'You must provide TEMPLATE for the task to run' unless ENV['TEMPLATE'].present?
+  desc "Lookup nested dependencies for TEMPLATE (like messages/show or comments/_comment.html)"
+  task nested_dependencies: :environment do
+    abort "You must provide TEMPLATE for the task to run" unless ENV["TEMPLATE"].present?
     puts JSON.pretty_generate ActionView::Digestor.tree(CacheDigests.template_name, CacheDigests.finder).children.map(&:to_dep_map)
   end
 
-  desc 'Lookup first-level dependencies for TEMPLATE (like messages/show or comments/_comment.html)'
-  task :dependencies => :environment do
-    abort 'You must provide TEMPLATE for the task to run' unless ENV['TEMPLATE'].present?
+  desc "Lookup first-level dependencies for TEMPLATE (like messages/show or comments/_comment.html)"
+  task dependencies: :environment do
+    abort "You must provide TEMPLATE for the task to run" unless ENV["TEMPLATE"].present?
     puts JSON.pretty_generate ActionView::Digestor.tree(CacheDigests.template_name, CacheDigests.finder).children.map(&:name)
   end
 
   class CacheDigests
     def self.template_name
-      ENV['TEMPLATE'].split('.', 2).first
+      ENV["TEMPLATE"].split(".", 2).first
     end
 
     def self.finder

data/lib/action_view/template.rb

@@ -1,6 +1,5 @@
 require "active_support/core_ext/object/try"
 require "active_support/core_ext/kernel/singleton_class"
-require "active_support/core_ext/module/delegation"
 require "thread"
 
 module ActionView
@@ -66,8 +65,7 @@ module ActionView
     # If you want to provide an alternate mechanism for
     # specifying encodings (like ERB does via <%# encoding: ... %>),
     # you may indicate that you will handle encodings yourself
-    # by implementing <tt>self.handles_encoding?</tt>
-    # on your handler.
+    # by implementing <tt>handles_encoding?</tt> on your handler.
     #
     # If you do, Rails will not try to encode the String
     # into the default_internal, passing you the unaltered
@@ -142,7 +140,7 @@ module ActionView
     end
 
     # Returns whether the underlying handler supports streaming. If so,
-    # a streaming buffer *may* be passed when it start rendering.
+    # a streaming buffer *may* be passed when it starts rendering.
     def supports_streaming?
       handler.respond_to?(:supports_streaming?) && handler.supports_streaming?
     end
@@ -153,8 +151,8 @@ module ActionView
     # This method is instrumented as "!render_template.action_view". Notice that
     # 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".freeze) do
+    def render(view, locals, buffer = nil, &block)
+      instrument_render_template do
         compile!(view)
         view.send(method_name, locals, buffer, &block)
       end
@@ -181,12 +179,12 @@ module ActionView
       name    = pieces.pop
       partial = !!name.sub!(/^_/, "")
       lookup.disable_cache do
-        lookup.find_template(name, [ pieces.join('/') ], partial, @locals)
+        lookup.find_template(name, [ pieces.join("/") ], partial, @locals)
       end
     end
 
     def inspect
-      @inspect ||= defined?(Rails.root) ? identifier.sub("#{Rails.root}/", ''.freeze) : identifier
+      @inspect ||= defined?(Rails.root) ? identifier.sub("#{Rails.root}/", "".freeze) : identifier
     end
 
     # This method is responsible for properly setting the encoding of the
@@ -205,7 +203,7 @@ module ActionView
       # Look for # encoding: *. If we find one, we'll encode the
       # String in that encoding, otherwise, we'll use the
       # default external encoding.
-      if source.sub!(/\A#{ENCODING_FLAG}/, '')
+      if source.sub!(/\A#{ENCODING_FLAG}/, "")
         encoding = magic_encoding = $1
       else
         encoding = Encoding.default_external
@@ -233,11 +231,11 @@ module ActionView
       end
     end
 
-    protected
+    private
 
       # Compile a template. This method ensures a template is compiled
       # just once and removes the source after it is compiled.
-      def compile!(view) #:nodoc:
+      def compile!(view)
         return if @compiled
 
         # Templates can be used concurrently in threaded environments
@@ -278,9 +276,8 @@ module ActionView
       # encode the source into <tt>Encoding.default_internal</tt>.
       # In general, this means that templates will be UTF-8 inside of Rails,
       # regardless of the original source encoding.
-      def compile(mod) #:nodoc:
+      def compile(mod)
         encode!
-        method_name = self.method_name
         code = @handler.call(self)
 
         # Make sure that the resulting String to be eval'd is in the
@@ -311,7 +308,7 @@ module ActionView
         ObjectSpace.define_finalizer(self, Finalizer[method_name, mod])
       end
 
-      def handle_render_error(view, e) #:nodoc:
+      def handle_render_error(view, e)
         if e.is_a?(Template::Error)
           e.sub_template_of(self)
           raise e
@@ -325,7 +322,7 @@ module ActionView
         end
       end
 
-      def locals_code #:nodoc:
+      def locals_code
         # Only locals with valid variable names get set directly. Others will
         # still be available in local_assigns.
         locals = @locals - Module::RUBY_RESERVED_KEYWORDS
@@ -335,26 +332,28 @@ module ActionView
         locals.each_with_object("") { |key, code| code << "#{key} = #{key} = local_assigns[:#{key}];" }
       end
 
-      def method_name #:nodoc:
+      def method_name
         @method_name ||= begin
           m = "_#{identifier_method_name}__#{@identifier.hash}_#{__id__}"
-          m.tr!('-'.freeze, '_'.freeze)
+          m.tr!("-".freeze, "_".freeze)
           m
         end
       end
 
-      def identifier_method_name #:nodoc:
-        inspect.tr('^a-z_'.freeze, '_'.freeze)
+      def identifier_method_name
+        inspect.tr("^a-z_".freeze, "_".freeze)
       end
 
-      def instrument(action, &block)
-        payload = { virtual_path: @virtual_path, identifier: @identifier }
-        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
+      def instrument(action, &block) # :doc:
+        ActiveSupport::Notifications.instrument("#{action}.action_view", instrument_payload, &block)
+      end
+
+      def instrument_render_template(&block)
+        ActiveSupport::Notifications.instrument("!render_template.action_view".freeze, instrument_payload, &block)
+      end
+
+      def instrument_payload
+        { virtual_path: @virtual_path, identifier: @identifier }
       end
   end
 end