actionview 4.1.0.beta1

data/lib/action_view/renderer/renderer.rb

@@ -0,0 +1,50 @@
+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 AV and AC.
+    def render(context, options)
+      if options.key?(:partial)
+        render_partial(context, options)
+      else
+        render_template(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 accessor to template rendering.
+    def render_template(context, options) #:nodoc:
+      TemplateRenderer.new(@lookup_context).render(context, options)
+    end
+
+    # Direct access to partial rendering.
+    def render_partial(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,103 @@
+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).
+    # 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.
+      # 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
+
+        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
+    # object that responds to each. This object is initialized with a block
+    # that knows how to render the template.
+    def render_template(template, layout_name = nil, locals = {}) #:nodoc:
+      return [super] unless layout_name && template.supports_streaming?
+
+      locals ||= {}
+      layout   = layout_name && find_layout(layout_name, locals.keys)
+
+      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
+        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
+
+        # 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,96 @@
+require 'active_support/core_ext/object/try'
+
+module ActionView
+  class TemplateRenderer < AbstractRenderer #:nodoc:
+    def render(context, options)
+      @view    = context
+      @details = extract_details(options)
+      template = determine_template(options)
+      context  = @lookup_context
+
+      prepend_formats(template.formats)
+
+      unless context.rendered_format
+        context.rendered_format = template.formats.first || formats.first
+      end
+
+      render_template(template, options[:layout], options[:locals])
+    end
+
+    # Determine the template to be rendered using the given options.
+    def determine_template(options) #:nodoc:
+      keys = options.fetch(:locals, {}).keys
+
+      if options.key?(:text)
+        Template::Text.new(options[:text], formats.first)
+      elsif options.key?(:file)
+        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)
+      elsif options.key?(:template)
+        if options[:template].respond_to?(:render)
+          options[:template]
+        else
+          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 or :text 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 || {}
+
+      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
+
+    def render_with_layout(path, locals) #:nodoc:
+      layout  = path && find_layout(path, locals.keys)
+      content = yield(layout)
+
+      if layout
+        view = @view
+        view.view_flow.set(:layout, content)
+        layout.render(view, locals){ |*name| view._layout_for(*name) }
+      else
+        content
+      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)
+      with_layout_format { resolve_layout(layout, keys) }
+    end
+
+    def resolve_layout(layout, keys)
+      case layout
+      when String
+        begin
+          if layout =~ /^\//
+            with_fallbacks { find_template(layout, nil, false, keys, @details) }
+          else
+            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
+      else
+        layout
+      end
+    end
+  end
+end

data/lib/action_view/rendering.rb

@@ -0,0 +1,145 @@
+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
+
+    # 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 view_context_class
+        @view_context_class ||= begin
+          routes = respond_to?(:_routes) && _routes
+          helpers = respond_to?(:_helpers) && _helpers
+
+          Class.new(ActionView::Base) do
+            if routes
+              include routes.url_helpers
+              include routes.mounted_helpers
+            end
+
+            if helpers
+              include helpers
+            end
+          end
+        end
+      end
+    end
+
+    attr_internal_writer :view_context_class
+
+    def view_context_class
+      @_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:
+    # View.new[lookup_context, assigns, controller]
+    #   Create a new ActionView instance for a controller
+    # View#render[options]
+    #   Returns String with the rendered template
+    #
+    # Override this method in a module to change the default behavior.
+    def view_context
+      view_context_class.new(view_renderer, view_assigns, self)
+    end
+
+    # Returns an object that is able to render templates.
+    # :api: private
+    def view_renderer
+      @_view_renderer ||= ActionView::Renderer.new(lookup_context)
+    end
+
+    def render_to_body(options = {})
+      _process_options(options)
+      _render_template(options)
+    end
+
+    def rendered_format
+      Mime[lookup_context.rendered_format]
+    end
+
+    private
+
+      # Find and render a template based on the options given.
+      # :api: private
+      def _render_template(options) #:nodoc:
+        variant = options[:variant]
+
+        lookup_context.rendered_format = nil if options[:formats]
+        lookup_context.variants = [variant] if variant
+
+        view_renderer.render(view_context, options)
+      end
+
+      # Assign the rendered format to lookup context.
+      def _process_format(format) #:nodoc:
+        super
+        lookup_context.formats = [format.to_sym]
+        lookup_context.rendered_format = lookup_context.formats.first
+      end
+
+      # Normalize args by converting render "foo" to render :action => "foo" and
+      # render "foo/bar" to render :file => "foo/bar".
+      # :api: private
+      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?(?/) ? :file : :action
+          options[key] = action
+        else
+          options[:partial] = action
+        end
+
+        options
+      end
+
+      # Normalize options.
+      # :api: private
+      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

data/lib/action_view/routing_url_for.rb

@@ -0,0 +1,109 @@
+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
+    # <tt>:only_path</tt> is <tt>true</tt> so you'll get the relative "/controller/action"
+    # instead of the fully qualified URL like "http://example.com/controller/action".
+    #
+    # ==== Options
+    # * <tt>:anchor</tt> - Specifies the anchor name to be appended to the path.
+    # * <tt>:only_path</tt> - If true, returns the relative URL (omitting the protocol, host name, and port) (<tt>true</tt> by default unless <tt>:host</tt> is specified).
+    # * <tt>:trailing_slash</tt> - If true, adds a trailing slash, as in "/archive/2005/". Note that this
+    #   is currently not recommended since it breaks caching.
+    # * <tt>:host</tt> - Overrides the default (current) host if provided.
+    # * <tt>:protocol</tt> - Overrides the default (current) protocol if provided.
+    # * <tt>:user</tt> - Inline HTTP authentication (only plucked out if <tt>:password</tt> is also present).
+    # * <tt>:password</tt> - Inline HTTP authentication (only plucked out if <tt>:user</tt> is also present).
+    #
+    # ==== Relying on named routes
+    #
+    # Passing a record (like an Active Record) instead of a hash as the options parameter will
+    # trigger the named route for that record. The lookup will happen on the name of the class. So passing a
+    # Workshop object will attempt to use the +workshop_path+ route. If you have a nested route, such as
+    # +admin_workshop_path+ you'll have to call that explicitly (it's impossible for +url_for+ to guess that route).
+    #
+    # ==== Implicit Controller Namespacing
+    #
+    # Controllers passed in using the +:controller+ option will retain their namespace unless it is an absolute one.
+    #
+    # ==== Examples
+    #   <%= url_for(action: 'index') %>
+    #   # => /blog/
+    #
+    #   <%= url_for(action: 'find', controller: 'books') %>
+    #   # => /books/find
+    #
+    #   <%= url_for(action: 'login', controller: 'members', only_path: false, protocol: 'https') %>
+    #   # => https://www.example.com/members/login/
+    #
+    #   <%= url_for(action: 'play', anchor: 'player') %>
+    #   # => /messages/play/#player
+    #
+    #   <%= url_for(action: 'jump', anchor: 'tax&ship') %>
+    #   # => /testing/jump/#tax&ship
+    #
+    #   <%= url_for(Workshop.new) %>
+    #   # relies on Workshop answering a persisted? call (and in this case returning false)
+    #   # => /workshops
+    #
+    #   <%= url_for(@workshop) %>
+    #   # calls @workshop.to_param which by default returns the id
+    #   # => /workshops/5
+    #
+    #   # to_param can be re-defined in a model to provide different URL names:
+    #   # => /workshops/1-workshop-name
+    #
+    #   <%= url_for("http://www.example.com") %>
+    #   # => http://www.example.com
+    #
+    #   <%= url_for(:back) %>
+    #   # if request.env["HTTP_REFERER"] is set to "http://www.example.com"
+    #   # => http://www.example.com
+    #
+    #   <%= url_for(:back) %>
+    #   # if request.env["HTTP_REFERER"] is not set or is blank
+    #   # => javascript:history.back()
+    #
+    #   <%= url_for(action: 'index', controller: 'users') %>
+    #   # Assuming an "admin" namespace
+    #   # => /admin/users
+    #
+    #   <%= url_for(action: 'index', controller: '/users') %>
+    #   # Specify absolute path with beginning slash
+    #   # => /users
+    def url_for(options = nil)
+      case options
+      when String
+        options
+      when nil, Hash
+        options ||= {}
+        options = { :only_path => options[:host].nil? }.merge!(options.symbolize_keys)
+        super
+      when :back
+        _back_url
+      when Array
+        polymorphic_path(options, options.extract_options!)
+      else
+        polymorphic_path(options)
+      end
+    end
+
+    def url_options #:nodoc:
+      return super unless controller.respond_to?(:url_options)
+      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?
+  end
+end