actionview 6.0.0

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

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+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, default: ActiveSupport::Cache::MemoryStore.new
+    end
+
+    private
+      def cache_collection_render(instrumentation_payload, view, template)
+        return yield unless @options[:cached]
+
+        # Result is a hash with the key represents the
+        # key used for cache lookup and the value is the item
+        # on which the partial is being rendered
+        keyed_collection, ordered_keys = collection_by_cache_keys(view, template)
+
+        # Pull all partials from cache
+        # Result is a hash, key matches the entry in
+        # `keyed_collection` where the cache was retrieved and the
+        # value is the value that was present in the cache
+        cached_partials = collection_cache.read_multi(*keyed_collection.keys)
+        instrumentation_payload[:cache_hits] = cached_partials.size
+
+        # Extract the items for the keys that are not found
+        # Set the uncached values to instance variable @collection
+        # which is used by the caller
+        @collection = keyed_collection.reject { |key, _| cached_partials.key?(key) }.values
+
+        # If all elements are already in cache then
+        # rendered partials will be an empty array
+        #
+        # If the cache is missing elements then
+        # the block will be called against the remaining items
+        # in the @collection.
+        rendered_partials = @collection.empty? ? [] : yield
+
+        index = 0
+        keyed_partials = fetch_or_cache_partial(cached_partials, template, order_by: keyed_collection.each_key) do
+          # This block is called once
+          # for every cache miss while preserving order.
+          rendered_partials[index].tap { index += 1 }
+        end
+
+        ordered_keys.map do |key|
+          keyed_partials[key]
+        end
+      end
+
+      def callable_cache_key?
+        @options[:cached].respond_to?(:call)
+      end
+
+      def collection_by_cache_keys(view, template)
+        seed = callable_cache_key? ? @options[:cached] : ->(i) { i }
+
+        digest_path = view.digest_path_from_template(template)
+
+        @collection.each_with_object([{}, []]) do |item, (hash, ordered_keys)|
+          key = expanded_cache_key(seed.call(item), view, template, digest_path)
+          ordered_keys << key
+          hash[key] = item
+        end
+      end
+
+      def expanded_cache_key(key, view, template, digest_path)
+        key = view.combined_fragment_cache_key(view.cache_fragment_name(key, virtual_path: template.virtual_path, digest_path: digest_path))
+        key.frozen? ? key.dup : key # #read_multi & #write may require mutability, Dalli 2.6.0.
+      end
+
+      # `order_by` is an enumerable object containing keys of the cache,
+      # all keys are  passed in whether found already or not.
+      #
+      # `cached_partials` is a hash. If the value exists
+      # it represents the rendered partial from the cache
+      # otherwise `Hash#fetch` will take the value of its block.
+      #
+      # This method expects a block that will return the rendered
+      # partial. An example is to render all results
+      # for each element that was not found in the cache and store it as an array.
+      # Order it so that the first empty cache element in `cached_partials`
+      # corresponds to the first element in `rendered_partials`.
+      #
+      # If the partial is not already cached it will also be
+      # written back to the underlying cache store.
+      def fetch_or_cache_partial(cached_partials, template, order_by:)
+        order_by.each_with_object({}) do |cache_key, hash|
+            hash[cache_key] =
+              if content = cached_partials[cache_key]
+                build_rendered_template(content, template)
+              else
+                yield.tap do |rendered_partial|
+                  collection_cache.write(cache_key, rendered_partial.body)
+                end
+              end
+          end
+      end
+  end
+end

data/lib/action_view/renderer/renderer.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ActionView
+  # This is the main entry point for rendering. It basically delegates
+  # to other objects like TemplateRenderer and PartialRenderer which
+  # actually renders the template.
+  #
+  # The Renderer will parse the options from the +render+ or +render_body+
+  # method and render a partial or a template based on the options. The
+  # +TemplateRenderer+ and +PartialRenderer+ objects are wrappers which do all
+  # the setup and logic necessary to render a view and a new object is created
+  # each time +render+ is called.
+  class Renderer
+    attr_accessor :lookup_context
+
+    def initialize(lookup_context)
+      @lookup_context = lookup_context
+    end
+
+    # Main render entry point shared by Action View and Action Controller.
+    def render(context, options)
+      render_to_object(context, options).body
+    end
+
+    def render_to_object(context, options) # :nodoc:
+      if options.key?(:partial)
+        render_partial_to_object(context, options)
+      else
+        render_template_to_object(context, options)
+      end
+    end
+
+    # Render but returns a valid Rack body. If fibers are defined, we return
+    # a streaming body that renders the template piece by piece.
+    #
+    # Note that partials are not supported to be rendered with streaming,
+    # so in such cases, we just wrap them in an array.
+    def render_body(context, options)
+      if options.key?(:partial)
+        [render_partial(context, options)]
+      else
+        StreamingTemplateRenderer.new(@lookup_context).render(context, options)
+      end
+    end
+
+    # Direct access to template rendering.
+    def render_template(context, options) #:nodoc:
+      render_template_to_object(context, options).body
+    end
+
+    # Direct access to partial rendering.
+    def render_partial(context, options, &block) #:nodoc:
+      render_partial_to_object(context, options, &block).body
+    end
+
+    def cache_hits # :nodoc:
+      @cache_hits ||= {}
+    end
+
+    def render_template_to_object(context, options) #:nodoc:
+      TemplateRenderer.new(@lookup_context).render(context, options)
+    end
+
+    def render_partial_to_object(context, options, &block) #:nodoc:
+      PartialRenderer.new(@lookup_context).render(context, options, block)
+    end
+  end
+end

data/lib/action_view/renderer/streaming_template_renderer.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "fiber"
+
+module ActionView
+  # == TODO
+  #
+  # * Support streaming from child templates, partials and so on.
+  # * Rack::Cache needs to support streaming bodies
+  class StreamingTemplateRenderer < TemplateRenderer #:nodoc:
+    # A valid Rack::Body (i.e. it responds to each).
+    # It is initialized with a block that, when called, starts
+    # rendering the template.
+    class Body #:nodoc:
+      def initialize(&start)
+        @start = start
+      end
+
+      def each(&block)
+        begin
+          @start.call(block)
+        rescue Exception => exception
+          log_error(exception)
+          block.call ActionView::Base.streaming_completion_on_exception
+        end
+        self
+      end
+
+      private
+
+        # 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.annotated_source_code.to_s if exception.respond_to?(:annotated_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
+    # object that responds to each. This object is initialized with a block
+    # that knows how to render the template.
+    def render_template(view, template, layout_name = nil, locals = {}) #:nodoc:
+      return [super.body] unless layout_name && template.supports_streaming?
+
+      locals ||= {}
+      layout   = layout_name && find_layout(layout_name, locals.keys, [formats.first])
+
+      Body.new do |buffer|
+        delayed_render(buffer, template, layout, view, locals)
+      end
+    end
+
+    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
+          outer_config = I18n.config
+          fiber = Fiber.new do
+            I18n.config = outer_config
+            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
+
+          # 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
+
+          # 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)
+
+            # 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

data/lib/action_view/renderer/template_renderer.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/try"
+
+module ActionView
+  class TemplateRenderer < AbstractRenderer #:nodoc:
+    def render(context, options)
+      @details = extract_details(options)
+      template = determine_template(options)
+
+      prepend_formats(template.format)
+
+      render_template(context, template, options[:layout], options[:locals] || {})
+    end
+
+    private
+
+      # 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?(:plain)
+          Template::Text.new(options[:plain])
+        elsif options.key?(:html)
+          Template::HTML.new(options[:html], formats.first)
+        elsif options.key?(:file)
+          if File.exist?(options[:file])
+            Template::RawFile.new(options[:file])
+          else
+            ActiveSupport::Deprecation.warn "render file: should be given the absolute path to a file"
+            @lookup_context.with_fallbacks.find_template(options[:file], nil, false, keys, @details)
+          end
+        elsif options.key?(:inline)
+          handler = Template.handler_for_extension(options[:type] || "erb")
+          format = if handler.respond_to?(:default_format)
+            handler.default_format
+          else
+            @lookup_context.formats.first
+          end
+          Template::Inline.new(options[:inline], "inline template", handler, locals: keys, format: format)
+        elsif options.key?(:template)
+          if options[:template].respond_to?(:render)
+            options[:template]
+          else
+            @lookup_context.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, :html or :body option."
+        end
+      end
+
+      # Renders the given template. A string representing the layout can be
+      # supplied as well.
+      def render_template(view, template, layout_name, locals)
+        render_with_layout(view, template, 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
+
+      def render_with_layout(view, template, path, locals)
+        layout  = path && find_layout(path, locals.keys, [formats.first])
+        content = yield(layout)
+
+        body = if layout
+          view.view_flow.set(:layout, content)
+          layout.render(view, locals) { |*name| view._layout_for(*name) }
+        else
+          content
+        end
+        build_rendered_template(body, template, layout)
+      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
+
+        case layout
+        when String
+          begin
+            if layout.start_with?("/")
+              ActiveSupport::Deprecation.warn "Rendering layouts from an absolute path is deprecated."
+              @lookup_context.with_fallbacks.find_template(layout, nil, false, [], details)
+            else
+              @lookup_context.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
+        when Proc
+          resolve_layout(layout.call(@lookup_context, formats), keys, formats)
+        else
+          layout
+        end
+      end
+  end
+end

data/lib/action_view/rendering.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require "action_view/view_paths"
+
+module ActionView
+  # 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 ActionView::ViewPaths
+
+    attr_reader :rendered_format
+
+    def initialize
+      @rendered_format = nil
+      super
+    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 _routes
+      end
+
+      def _helpers
+      end
+
+      def build_view_context_class(klass, supports_path, routes, helpers)
+        Class.new(klass) do
+          if routes
+            include routes.url_helpers(supports_path)
+            include routes.mounted_helpers
+          end
+
+          if helpers
+            include helpers
+          end
+        end
+      end
+
+      def view_context_class
+        klass = ActionView::LookupContext::DetailsKey.view_context_class(ActionView::Base)
+
+        @view_context_class ||= build_view_context_class(klass, supports_path?, _routes, _helpers)
+
+        if klass.changed?(@view_context_class)
+          @view_context_class = build_view_context_class(klass, supports_path?, _routes, _helpers)
+        end
+
+        @view_context_class
+      end
+    end
+
+    def 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:
+    #
+    # * <tt>View.new(lookup_context, assigns, controller)</tt> — Create a new
+    #   ActionView instance for a controller and we can also pass the arguments.
+    #
+    # * <tt>View#render(option)</tt> — Returns String with the rendered template.
+    #
+    # Override this method in a module to change the default behavior.
+    def view_context
+      view_context_class.new(lookup_context, view_assigns, self)
+    end
+
+    # Returns an object that is able to render templates.
+    def view_renderer # :nodoc:
+      # Lifespan: Per controller
+      @_view_renderer ||= ActionView::Renderer.new(lookup_context)
+    end
+
+    def render_to_body(options = {})
+      _process_options(options)
+      _render_template(options)
+    end
+
+    private
+
+      # Find and render a template based on the options given.
+      def _render_template(options)
+        variant = options.delete(:variant)
+        assigns = options.delete(:assigns)
+        context = view_context
+
+        context.assign assigns if assigns
+        lookup_context.variants = variant if variant
+
+        rendered_template = context.in_rendering_context(options) do |renderer|
+          renderer.render_to_object(context, options)
+        end
+
+        rendered_format = rendered_template.format || lookup_context.formats.first
+        @rendered_format = Template::Types[rendered_format]
+
+        rendered_template.body
+      end
+
+      # Assign the rendered format to look up context.
+      def _process_format(format)
+        super
+        lookup_context.formats = [format.to_sym] if format.to_sym
+      end
+
+      # Normalize args by converting render "foo" to render :action => "foo" and
+      # render "foo/bar" to render :template => "foo/bar".
+      def _normalize_args(action = nil, options = {})
+        options = super(action, options)
+        case action
+        when NilClass
+        when Hash
+          options = action
+        when String, Symbol
+          action = action.to_s
+          key = action.include?(?/) ? :template : :action
+          options[key] = action
+        else
+          if action.respond_to?(:permitted?) && action.permitted?
+            options = action
+          else
+            options[:partial] = action
+          end
+        end
+
+        options
+      end
+
+      # Normalize options.
+      def _normalize_options(options)
+        options = super(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
+  end
+end