actionpack 3.0.20 → 3.1.0.beta1

data/lib/action_view/base.rb

@@ -6,27 +6,23 @@ require 'active_support/ordered_options'
 require 'action_view/log_subscriber'
 
 module ActionView #:nodoc:
-  class NonConcattingString < ActiveSupport::SafeBuffer
-  end
-
   # = Action View Base
   #
-  # Action View templates can be written in three ways. If the template file has a <tt>.erb</tt> (or <tt>.rhtml</tt>) extension then it uses a mixture of ERb
+  # Action View templates can be written in several ways. If the template file has a <tt>.erb</tt> (or <tt>.rhtml</tt>) extension then it uses a mixture of ERb
   # (included in Ruby) and HTML. If the template file has a <tt>.builder</tt> (or <tt>.rxml</tt>) extension then Jim Weirich's Builder::XmlMarkup library is used.
-  # If the template file has a <tt>.rjs</tt> extension then it will use ActionView::Helpers::PrototypeHelper::JavaScriptGenerator.
   #
-  # == ERb
+  # == ERB
   #
-  # You trigger ERb by using embeddings such as <% %>, <% -%>, and <%= %>. The <%= %> tag set is used when you want output. Consider the
+  # You trigger ERB by using embeddings such as <% %>, <% -%>, and <%= %>. The <%= %> tag set is used when you want output. Consider the
   # following loop for names:
   #
   #   <b>Names of all the people</b>
-  #   <% for person in @people %>
+  #   <% @people.each do |person| %>
   #     Name: <%= person.name %><br/>
   #   <% end %>
   #
   # The loop is setup in regular embedding tags <% %> and the name is written using the output embedding tag <%= %>. Note that this
-  # is not just a usage suggestion. Regular output functions like print or puts won't work with ERb templates. So this would be wrong:
+  # is not just a usage suggestion. Regular output functions like print or puts won't work with ERB templates. So this would be wrong:
   #
   #   <%# WRONG %>
   #   Hi, Mr. <% puts "Frodo" %>
@@ -84,7 +80,7 @@ module ActionView #:nodoc:
   #
   # == Builder
   #
-  # Builder templates are a more programmatic alternative to ERb. They are especially useful for generating XML content. An XmlMarkup object
+  # Builder templates are a more programmatic alternative to ERB. They are especially useful for generating XML content. An XmlMarkup object
   # named +xml+ is automatically made available to templates with a <tt>.builder</tt> extension.
   #
   # Here are some basic examples:
@@ -134,108 +130,87 @@ module ActionView #:nodoc:
   #   end
   #
   # More builder documentation can be found at http://builder.rubyforge.org.
-  #
-  # == JavaScriptGenerator
-  #
-  # JavaScriptGenerator templates end in <tt>.rjs</tt>. Unlike conventional templates which are used to
-  # render the results of an action, these templates generate instructions on how to modify an already rendered page. This makes it easy to
-  # modify multiple elements on your page in one declarative Ajax response. Actions with these templates are called in the background with Ajax
-  # and make updates to the page where the request originated from.
-  #
-  # An instance of the JavaScriptGenerator object named +page+ is automatically made available to your template, which is implicitly wrapped in an ActionView::Helpers::PrototypeHelper#update_page block.
-  #
-  # When an <tt>.rjs</tt> action is called with +link_to_remote+, the generated JavaScript is automatically evaluated.  Example:
-  #
-  #   link_to_remote :url => {:action => 'delete'}
-  #
-  # The subsequently rendered <tt>delete.rjs</tt> might look like:
-  #
-  #   page.replace_html  'sidebar', :partial => 'sidebar'
-  #   page.remove        "person-#{@person.id}"
-  #   page.visual_effect :highlight, 'user-list'
-  #
-  # This refreshes the sidebar, removes a person element and highlights the user list.
-  #
-  # See the ActionView::Helpers::PrototypeHelper::JavaScriptGenerator::GeneratorMethods documentation for more details.
   class Base
-    module Subclasses
-    end
-
-    include Helpers, Rendering, Partials, Layouts, ::ERB::Util, Context
-
-    # Specify whether RJS responses should be wrapped in a try/catch block
-    # that alert()s the caught exception (and then re-raises it).
-    cattr_reader :debug_rjs
-    @@debug_rjs = false
-    def self.debug_rjs=(new_value)
-      ActiveSupport::Deprecation.warn("config.action_view.debug_rjs will be removed in 3.1, from 3.1 onwards you will need to install prototype-rails to continue to use RJS templates ")
-      @@debug_rjs = new_value
-    end
+    include Helpers, ::ERB::Util, Context
 
     # Specify the proc used to decorate input tags that refer to attributes with errors.
     cattr_accessor :field_error_proc
     @@field_error_proc = Proc.new{ |html_tag, instance| "<div class=\"field_with_errors\">#{html_tag}</div>".html_safe }
 
+    # How to complete the streaming when an exception occurs.
+    # This is our best guess: first try to close the attribute, then the tag.
+    cattr_accessor :streaming_completion_on_exception
+    @@streaming_completion_on_exception = %("><script type="text/javascript">window.location = "/500.html"</script></html>)
+
     class_attribute :helpers
     class_attribute :_routes
 
     class << self
       delegate :erb_trim_mode=, :to => 'ActionView::Template::Handlers::ERB'
       delegate :logger, :to => 'ActionController::Base', :allow_nil => true
-    end
 
-    attr_accessor :base_path, :assigns, :template_extension, :lookup_context
-    attr_internal :captures, :request, :controller, :template, :config
+      def cache_template_loading
+        ActionView::Resolver.caching?
+      end
 
-    delegate :find_template, :template_exists?, :formats, :formats=, :locale, :locale=,
-             :view_paths, :view_paths=, :with_fallbacks, :update_details, :with_layout_format, :to => :lookup_context
+      def cache_template_loading=(value)
+        ActionView::Resolver.caching = value
+      end
 
-    delegate :request_forgery_protection_token, :template, :params, :session, :cookies, :response, :headers,
-             :flash, :action_name, :controller_name, :to => :controller
+      def process_view_paths(value)
+        value.is_a?(PathSet) ?
+          value.dup : ActionView::PathSet.new(Array.wrap(value))
+      end
 
-    delegate :logger, :to => :controller, :allow_nil => true
+      def xss_safe? #:nodoc:
+        true
+      end
 
-    # TODO: HACK FOR RJS
-    def view_context
-      self
+      # This method receives routes and helpers from the controller
+      # and return a subclass ready to be used as view context.
+      def prepare(routes, helpers) #:nodoc:
+        Class.new(self) do
+          if routes
+            include routes.url_helpers
+            include routes.mounted_helpers
+          end
+
+          if helpers
+            include helpers
+            self.helpers = helpers
+          end
+        end
+      end
     end
 
-    def self.xss_safe? #:nodoc:
-      true
-    end
+    attr_accessor :view_renderer
+    attr_internal :config, :assigns
 
-    def self.process_view_paths(value)
-      value.is_a?(PathSet) ?
-        value.dup : ActionView::PathSet.new(Array.wrap(value))
-    end
+    delegate :lookup_context, :to => :view_renderer
+    delegate :formats, :formats=, :locale, :locale=, :view_paths, :view_paths=, :to => :lookup_context
 
     def assign(new_assigns) # :nodoc:
-      self.assigns = new_assigns.each { |key, value| instance_variable_set("@#{key}", value) }
+      @_assigns = new_assigns.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
-    def initialize(lookup_context = nil, assigns_for_first_render = {}, controller = nil, formats = nil) #:nodoc:
-      assign(assigns_for_first_render)
-      self.helpers = self.class.helpers || Module.new
-
-      if @_controller = controller
-        @_request = controller.request if controller.respond_to?(:request)
+    def initialize(context = nil, assigns = {}, controller = nil, formats = nil) #:nodoc:
+      @_config = {}
+
+      # Handle all these for backwards compatibility.
+      # TODO Provide a new API for AV::Base and deprecate this one.
+      if context.is_a?(ActionView::Renderer)
+        @view_renderer = context
+      elsif
+        lookup_context = context.is_a?(ActionView::LookupContext) ?
+          context : ActionView::LookupContext.new(context)
+        lookup_context.formats  = formats if formats
+        lookup_context.prefixes = controller._prefixes if controller
+        @view_renderer = ActionView::Renderer.new(lookup_context)
       end
 
-      config = controller && controller.respond_to?(:config) ? controller.config : {}
-      @_config = ActiveSupport::InheritableOptions.new(config)
-
-      @_content_for  = Hash.new { |h,k| h[k] = ActiveSupport::SafeBuffer.new }
-      @_virtual_path = nil
-      @output_buffer = nil
-
-      @lookup_context = lookup_context.is_a?(ActionView::LookupContext) ?
-        lookup_context : ActionView::LookupContext.new(lookup_context)
-      @lookup_context.formats = formats if formats
-      @controller = ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy.new(self, :controller)
-    end
-
-    def controller_path
-      @controller_path ||= controller && controller.controller_path
+      assign(assigns)
+      assign_controller(controller)
+      _prepare_context
     end
 
     ActiveSupport.run_load_hooks(:action_view, self)

data/lib/action_view/buffers.rb

@@ -0,0 +1,43 @@
+require 'active_support/core_ext/string/output_safety'
+
+module ActionView
+  class OutputBuffer < ActiveSupport::SafeBuffer #:nodoc:
+    def initialize(*)
+      super
+      encode! if encoding_aware?
+    end
+
+    def <<(value)
+      super(value.to_s)
+    end
+    alias :append= :<<
+    alias :safe_append= :safe_concat
+  end
+
+  class StreamingBuffer #:nodoc:
+    def initialize(block)
+      @block = block
+    end
+
+    def <<(value)
+      value = value.to_s
+      value = ERB::Util.h(value) unless value.html_safe?
+      @block.call(value)
+    end
+    alias :concat  :<<
+    alias :append= :<<
+
+    def safe_concat(value)
+      @block.call(value.to_s)
+    end
+    alias :safe_append= :safe_concat
+
+    def html_safe?
+      true
+    end
+    
+    def html_safe
+      self
+    end
+  end
+end

data/lib/action_view/context.rb

@@ -2,38 +2,35 @@ module ActionView
   module CompiledTemplates #:nodoc:
     # holds compiled template code
   end
+
   # = Action View Context
   #
   # Action View contexts are supplied to Action Controller to render template.
   # The default Action View context is ActionView::Base.
   #
-  # In order to work with ActionController, a Context must implement:
-  #
-  # Context#render_partial[options]
-  #   - responsible for setting options[:_template]
-  #   - Returns String with the rendered partial
-  #   options<Hash>:: see _render_partial in ActionView::Base
-  # Context#render_template[template, layout, options, partial]
-  #   - Returns String with the rendered template
-  #   template<ActionView::Template>:: The template to render
-  #   layout<ActionView::Template>:: The layout to render around the template
-  #   options<Hash>:: See _render_template_with_layout in ActionView::Base
-  #   partial<Boolean>:: Whether or not the template to render is a partial
-  #
-  # An Action View context can also mix in Action View's helpers. In order to
-  # mix in helpers, a context must implement:
-  #
-  # Context#controller
-  # - Returns an instance of AbstractController
-  #
-  # In any case, a context must mix in ActionView::Context, which stores compiled
-  # template and provides the output buffer.
+  # In order to work with ActionController, a Context must just include this module.
+  # The initialization of the variables used by the context (@output_buffer, @view_flow,
+  # and @virtual_path) is responsibility of the object that includes this module
+  # (although you can call _prepare_context defined below).
   module Context
     include CompiledTemplates
-    attr_accessor :output_buffer
+    attr_accessor :output_buffer, :view_flow
+
+    # Prepares the context by setting the appropriate instance variables.
+    # :api: plugin
+    def _prepare_context
+      @view_flow     = OutputFlow.new
+      @output_buffer = nil
+      @virtual_path  = nil
+    end
 
-    def convert_to_model(object)
-      object.respond_to?(:to_model) ? object.to_model : object
+    # Encapsulates the interaction with the view flow so it
+    # returns the correct buffer on yield. This is usually
+    # overwriten by helpers to add more behavior.
+    # :api: plugin
+    def _layout_for(name=nil)
+      name ||= :layout
+      view_flow.get(name).html_safe
     end
   end
 end

data/lib/action_view/flows.rb

@@ -0,0 +1,79 @@
+require 'active_support/core_ext/string/output_safety'
+
+module ActionView
+  class OutputFlow #:nodoc:
+    attr_reader :content
+
+    def initialize
+      @content = Hash.new { |h,k| h[k] = ActiveSupport::SafeBuffer.new }
+    end
+
+    # Called by _layout_for to read stored values.
+    def get(key)
+      @content[key]
+    end
+
+    # Called by each renderer object to set the layout contents.
+    def set(key, value)
+      @content[key] = value
+    end
+
+    # Called by content_for
+    def append(key, value)
+      @content[key] << value
+    end
+
+    # Called by provide
+    def append!(key, value)
+      @content[key] << value
+    end
+  end
+
+  class StreamingFlow < OutputFlow #:nodoc:
+    def initialize(view, fiber)
+      @view    = view
+      @parent  = nil
+      @child   = view.output_buffer
+      @content = view.view_flow.content
+      @fiber   = fiber
+      @root    = Fiber.current.object_id
+    end
+
+    # Try to get an stored content. If the content
+    # is not available and we are inside the layout
+    # fiber, we set that we are waiting for the given
+    # key and yield.
+    def get(key)
+      return super if @content.key?(key)
+
+      if inside_fiber?
+        view = @view
+
+        begin
+          @waiting_for = key
+          view.output_buffer, @parent = @child, view.output_buffer
+          Fiber.yield
+        ensure
+          @waiting_for = nil
+          view.output_buffer, @child = @parent, view.output_buffer
+        end
+      end
+
+      super
+    end
+
+    # Appends the contents for the given key. This is called
+    # by provides and resumes back to the fiber if it is
+    # the key it is waiting for.
+    def append!(key, value)
+      super
+      @fiber.resume if @waiting_for == key
+    end
+
+    private
+
+    def inside_fiber?
+      Fiber.current.object_id != @root
+    end
+  end
+end

data/lib/action_view/helpers.rb

@@ -9,6 +9,7 @@ module ActionView #:nodoc:
     autoload :AtomFeedHelper
     autoload :CacheHelper
     autoload :CaptureHelper
+    autoload :ControllerHelper
     autoload :CsrfHelper
     autoload :DateHelper
     autoload :DebugHelper
@@ -17,11 +18,11 @@ module ActionView #:nodoc:
     autoload :FormTagHelper
     autoload :JavaScriptHelper, "action_view/helpers/javascript_helper"
     autoload :NumberHelper
-    autoload :PrototypeHelper
-    autoload :RawOutputHelper
+    autoload :OutputSafetyHelper
     autoload :RecordTagHelper
+    autoload :RenderingHelper
     autoload :SanitizeHelper
-    autoload :ScriptaculousHelper
+    autoload :SprocketsHelper
     autoload :TagHelper
     autoload :TextHelper
     autoload :TranslationHelper
@@ -39,6 +40,7 @@ module ActionView #:nodoc:
     include AtomFeedHelper
     include CacheHelper
     include CaptureHelper
+    include ControllerHelper
     include CsrfHelper
     include DateHelper
     include DebugHelper
@@ -47,11 +49,11 @@ module ActionView #:nodoc:
     include FormTagHelper
     include JavaScriptHelper
     include NumberHelper
-    include PrototypeHelper
-    include RawOutputHelper
+    include OutputSafetyHelper
     include RecordTagHelper
+    include RenderingHelper
     include SanitizeHelper
-    include ScriptaculousHelper
+    include SprocketsHelper
     include TagHelper
     include TextHelper
     include TranslationHelper

data/lib/action_view/helpers/active_model_helper.rb

@@ -7,25 +7,6 @@ module ActionView
   # = Active Model Helpers
   module Helpers
     module ActiveModelHelper
-      %w(input form error_messages_for error_message_on).each do |method|
-        class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{method}(*args)
-            ActiveSupport::Deprecation.warn "#{method} was removed from Rails and is now available as a plugin. " <<
-              "Please install it with `rails plugin install git://github.com/rails/dynamic_form.git`.", caller
-          end
-        RUBY
-      end
-    end
-
-    module ActiveModelFormBuilder
-      %w(error_messages error_message_on).each do |method|
-        class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{method}(*args)
-            ActiveSupport::Deprecation.warn "f.#{method} was removed from Rails and is now available as a plugin. " <<
-              "Please install it with `rails plugin install git://github.com/rails/dynamic_form.git`.", caller
-          end
-        RUBY
-      end
     end
 
     module ActiveModelInstanceTag
@@ -67,10 +48,6 @@ module ActionView
       end
     end
 
-    class FormBuilder
-      include ActiveModelFormBuilder
-    end
-
     class InstanceTag
       include ActiveModelInstanceTag
     end