Changeset 1350

Timestamp:

05/22/05 08:58:43 (3 years ago)

Author:

david

Message:

Deprecated all render_* methods in favor of consolidating all rendering behavior in Base#render(options). This enables more natural use of combining options, such as layouts

Files:

• trunk/actionpack/CHANGELOG (modified) (1 diff)
• trunk/actionpack/lib/action_controller.rb (modified) (3 diffs)
• trunk/actionpack/lib/action_controller/base.rb (modified) (9 diffs)
• trunk/actionpack/lib/action_controller/benchmarking.rb (modified) (1 diff)
• trunk/actionpack/lib/action_controller/cookies.rb (modified) (2 diffs)
• trunk/actionpack/lib/action_controller/deprecated_renders_and_redirects.rb (added)
• trunk/actionpack/lib/action_controller/layout.rb (modified) (4 diffs)
• trunk/actionpack/lib/action_controller/streaming.rb (added)
• trunk/actionpack/test/controller/new_render_test.rb (modified) (3 diffs)

trunk/actionpack/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Deprecated all render_* methods in favor of consolidating all rendering behavior in Base#render(options). This enables more natural use of combining options, such as layouts. Examples:
+
+    +---------------------------------------------------------------+-------------------------------------------------------+
+    | BEFORE                                                        | AFTER                                                 |
+    +---------------------------------------------------------------+-------------------------------------------------------+
+    | render_with_layout "weblog/show", "200 OK", "layouts/dialog"  | render :action => "show", :layout => "dialog"         |
+    | render_without_layout "weblog/show"                           | render :action => "show", :layout => false            |
+    | render_action "error", "404 Not Found"                        | render :action => "error", :status => "404 Not Found" |
+    | render_template "xml.div('stuff')", "200 OK", :rxml           | render :inline => "xml.div('stuff')", :type => :rxml  |
+    | render_text "hello world!"                                    | render :text => "hello world!"                        |
+    | render_partial_collection "person", @people, nil, :a => 1     | render :partial => "person", :collection => @people,  |
+    |                                                               |        :locals => { :a => 1 }                         |
+    +---------------------------------------------------------------+-------------------------------------------------------+      
-
-* Deprecated redirect_to_path and redirect_to_url in favor of letting redirect_to do the right thing when passed either a path or url.

trunk/actionpack/lib/action_controller.rb

@@ -33 +33 @@
-
-require 'action_controller/base'
+require 'action_controller/deprecated_renders_and_redirects'
-require 'action_controller/rescue'
-require 'action_controller/benchmarking'
@@ -48 +49 @@
-require 'action_controller/components'
-require 'action_controller/verification'
+require 'action_controller/streaming'
-
-require 'action_view'
@@ -67 +69 @@
-  include ActionController::Components
-  include ActionController::Verification
+  include ActionController::Streaming
-end

trunk/actionpack/lib/action_controller/base.rb

@@ -206 +206 @@
-    DEFAULT_RENDER_STATUS_CODE = "200 OK"
-  
-    DEFAULT_SEND_FILE_OPTIONS = {
-      :type         => 'application/octet-stream'.freeze,
-      :disposition  => 'attachment'.freeze,
-      :stream       => true, 
-      :buffer_size  => 4096
-    }.freeze
-
-    # Determines whether the view has access to controller internals @request, @response, @session, and @template.
-    # By default, it does.
@@ -440 +433 @@
-
-    protected
-      # A unified replacement for the individual renders (work-in-progress).
-      def r(options = {}, &block)
-        raise DoubleRenderError, "Can only render or redirect once per action" if performed?
-        add_variables_to_assigns
-        options[:status] = (options[:status] || DEFAULT_RENDER_STATUS_CODE).to_s
-
-        if options[:text]
-          @response.headers["Status"] = options[:status]
-          @response.body = block_given? ? block : options[:text]
-          @performed_render = true
-          return options[:text]
-
-        elsif options[:file]
-          assert_existance_of_template_file(options[:file]) if options[:use_full_path]
-          logger.info("Rendering #{options[:file]} (#{options[:status]})") unless logger.nil?
-          r(options.merge({ :text => @template.render_file(options[:file], options[:use_full_path])}))
-
-        elsif options[:template]
-          r(options.merge({ :file => options[:template], :use_full_path => true }))
-
-        elsif options[:inline]
-          r(options.merge({ :text => @template.render_template(options[:type] || :rhtml, options[:inline]) }))
-
-        elsif options[:action]
-          r(options.merge({ :template => default_template_name(options[:action]) }))
-
-        elsif options[:partial] && options[:collection]
-          r(options.merge({ 
-            :text => (
-              @template.render_partial_collection(
-                options[:partial], options[:collection], options[:spacer_template], options[:local_assigns]
-              ) || ''
-            )
-          }))
-
-        elsif options[:partial]
-          r(options.merge({ :text => @template.render_partial(options[:partial], options[:object], options[:local_assigns]) }))
-          
-        elsif options[:nothing]
-          r(options.merge({ :text => "" }))
-
-        else
-          r(options.merge({ :template => default_template_name }))
-        end
-      end
-    
-      # Renders the template specified by <tt>template_name</tt>, which defaults to the name of the current controller and action.
-      # So calling +render+ in WeblogController#show will attempt to render "#{template_root}/weblog/show.rhtml" or 
@@ -491 +438 @@
-      # shared by all controllers. It's also possible to pass a status code using the second parameter. This defaults to "200 OK", 
-      # but can be changed, such as by calling <tt>render("weblog/error", "500 Error")</tt>.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-        add_variables_to_assigns
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      end
-
-      # Returns the result of the render as a string.
-
-
-
-
-
+
+
+
+
+
+
-      # Clears the rendered results, allowing for another render or redirect to be performed.
-      def erase_render_results #:nodoc:
-        @response.body = nil
-        @performed_render = false
-      end
-      
-      # Renders the partial specified by <tt>partial_path</tt>, which by default is the name of the action itself. Example:
-      #
-      #   class WeblogController < ActionController::Base
-      #     def show
-      #       render_partial # renders "weblog/_show.r(xml|html)"
-      #     end
-      #   end
-      def render_partial(partial_path = default_template_name, object = nil, local_assigns = {}) #:doc:
-        add_variables_to_assigns
-        render_text(@template.render_partial(partial_path, object, local_assigns))
-      end
-
-      # Renders a collection of partials using <tt>partial_name</tt> to iterate over the +collection+.
-      def render_partial_collection(partial_name, collection, partial_spacer_template = nil, local_assigns = {})#:doc:
-        add_variables_to_assigns
-        render_text(@template.render_collection_of_partials(partial_name, collection, partial_spacer_template, local_assigns) || '')
-      end
-
-      # Sends the file by streaming it 4096 bytes at a time. This way the
-      # whole file doesn't need to be read into memory at once.  This makes
-      # it feasible to send even large files.
-      #
-      # Be careful to sanitize the path parameter if it coming from a web
-      # page.  send_file(@params['path']) allows a malicious user to
-      # download any file on your server.
-      #
-      # Options:
-      # * <tt>:filename</tt> - suggests a filename for the browser to use.
-      #   Defaults to File.basename(path).
-      # * <tt>:type</tt> - specifies an HTTP content type.
-      #   Defaults to 'application/octet-stream'.
-      # * <tt>:disposition</tt> - specifies whether the file will be shown inline or downloaded.  
-      #   Valid values are 'inline' and 'attachment' (default).
-      # * <tt>:streaming</tt> - whether to send the file to the user agent as it is read (true)
-      #   or to read the entire file before sending (false). Defaults to true.
-      # * <tt>:buffer_size</tt> - specifies size (in bytes) of the buffer used to stream the file.
-      #   Defaults to 4096.
-      #
-      # The default Content-Type and Content-Disposition headers are
-      # set to download arbitrary binary files in as many browsers as
-      # possible.  IE versions 4, 5, 5.5, and 6 are all known to have
-      # a variety of quirks (especially when downloading over SSL).
-      #
-      # Simple download:
-      #   send_file '/path/to.zip'
-      #
-      # Show a JPEG in browser:
-      #   send_file '/path/to.jpeg', :type => 'image/jpeg', :disposition => 'inline'
-      #
-      # Read about the other Content-* HTTP headers if you'd like to
-      # provide the user with more information (such as Content-Description).
-      # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
-      #
-      # Also be aware that the document may be cached by proxies and browsers.
-      # The Pragma and Cache-Control headers declare how the file may be cached
-      # by intermediaries.  They default to require clients to validate with
-      # the server before releasing cached responses.  See
-      # http://www.mnot.net/cache_docs/ for an overview of web caching and
-      # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
-      # for the Cache-Control header spec.
-      def send_file(path, options = {}) #:doc:
-        raise MissingFile, "Cannot read file #{path}" unless File.file?(path) and File.readable?(path)
-
-        options[:length]   ||= File.size(path)
-        options[:filename] ||= File.basename(path)
-        send_file_headers! options
-
-        @performed_render = false
-
-        if options[:stream]
-          render_text do
-            logger.info "Streaming file #{path}" unless logger.nil?
-            len = options[:buffer_size] || 4096
-            File.open(path, 'rb') do |file|
-              if $stdout.respond_to?(:syswrite)
-                begin
-                  while true
-                    $stdout.syswrite file.sysread(len)
-                  end
-                rescue EOFError
-                end
-              else
-                while buf = file.read(len)
-                  $stdout.write buf
-                end
-              end
-            end
-          end
-        else
-          logger.info "Sending file #{path}" unless logger.nil?
-          File.open(path, 'rb') { |file| render_text file.read }
-        end
-      end
-
-      # Send binary data to the user as a file download.  May set content type, apparent file name,
-      # and specify whether to show data inline or download as an attachment.
-      #
-      # Options:
-      # * <tt>:filename</tt> - Suggests a filename for the browser to use.
-      # * <tt>:type</tt> - specifies an HTTP content type.
-      #   Defaults to 'application/octet-stream'.
-      # * <tt>:disposition</tt> - specifies whether the file will be shown inline or downloaded.  
-      #   Valid values are 'inline' and 'attachment' (default).
-      #
-      # Generic data download:
-      #   send_data buffer
-      #
-      # Download a dynamically-generated tarball:
-      #   send_data generate_tgz('dir'), :filename => 'dir.tgz'
-      #
-      # Display an image Active Record in the browser:
-      #   send_data image.data, :type => image.content_type, :disposition => 'inline'
-      #
-      # See +send_file+ for more information on HTTP Content-* headers and caching.
-      def send_data(data, options = {}) #:doc:
-        logger.info "Sending data #{options[:filename]}" unless logger.nil?
-        send_file_headers! options.merge(:length => data.size)
-        @performed_render = false
-        render_text data
-      end
-
@@ -725 +556 @@
-        end
-      end
-      
-      # Deprecated in favor of calling redirect_to directly with the path.
-      def redirect_to_path(path) #:doc:
-        redirect_to(path)
-      end
-
-      # Deprecated in favor of calling redirect_to directly with the url. If the resource has moved permanently, it's possible to pass
-      # true as the second parameter and the browser will get "301 Moved Permanently" instead of "302 Found". This can also be done through
-      # just setting the headers["Status"] to "301 Moved Permanently" before using the redirect_to.
-      def redirect_to_url(url, permanently = false) #:doc:
-        headers["Status"] = "301 Moved Permanently" if permanently
-        redirect_to(url)
-      end
-
-      # Resets the session by clearing out all the objects stored within and initializing a new session object.
@@ -746 +564 @@
-      end
-    
-      # Deprecated cookie writer method
-      def cookie(*options)
-        @response.headers["cookie"] << CGI::Cookie.new(*options)
-      end
-
-    private
-      def initialize_template_class(response)
@@ -801 +614 @@
-        @action_methods ||= (self.class.public_instance_methods - self.class.hidden_actions)
-      end
-
+
+
-      def add_variables_to_assigns
-        add_instance_variables_to_assigns
@@ -829 +643 @@
-      end
-
+
-      def request_origin
-        "#{@request.remote_ip} at #{Time.now.to_s}"
@@ -836 +651 @@
-        @session.close unless @session.nil? || Hash === @session
-      end
+
-      
-      def template_exists?(template_name = default_template_name)
@@ -853 +669 @@
-      end
-
-      def send_file_headers!(options)
-        options.update(DEFAULT_SEND_FILE_OPTIONS.merge(options))
-        [:length, :type, :disposition].each do |arg|
-          raise ArgumentError, ":#{arg} option required" if options[arg].nil?
-        end
-
-        disposition = options[:disposition].dup || 'attachment'
-        disposition <<= %(; filename="#{options[:filename]}") if options[:filename]
-
-        @headers.update(
-          'Content-Length'            => options[:length],
-          'Content-Type'              => options[:type].strip,  # fixes a problem with extra '\r' with some browsers
-          'Content-Disposition'       => disposition,
-          'Content-Transfer-Encoding' => 'binary'
-        );
-      end
-
-      def default_template_name(default_action_name = action_name)
-        "#{self.class.controller_path}/#{default_action_name}"

trunk/actionpack/lib/action_controller/benchmarking.rb

@@ -16 +16 @@
-    end
-
-template_name = default_template_name, status = "200 OK"
+options = {}, deprecated_status = nil
-      if logger.nil?
-template_name, 
+options, deprecated_
-      else
-        db_runtime = ActiveRecord::Base.connection.reset_runtime if Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?
-template_name, 
+options, deprecated_
-
-        if Object.const_defined?("ActiveRecord") && ActiveRecord::Base.connected?

trunk/actionpack/lib/action_controller/cookies.rb

@@ -4 +4 @@
-  # itself back -- just the value it holds). Examples for writing:
-  #
-"user_name"
-"login"
+:user_name
+:login
-  #   
-  # Examples for reading:
-  #
-"user_name"
+:user_name
-  #   cookies.size         # => 2
-  # 
-  # Example for deleting:
-  #
-"user_name"
+:user_name
-  #
-  # All the option symbols for setting cookies are:
@@ -25 +25 @@
-  #   Secure cookies are only transmitted to HTTPS servers.
-  module Cookies
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-  end
-  

trunk/actionpack/lib/action_controller/layout.rb

@@ -6 +6 @@
-        alias_method :render_without_layout, :render
-        alias_method :render, :render_with_layout
-
-        alias_method :r_without_layout, :r
-        alias_method :r, :r_with_layout
-
-        class << self
@@ -206 +203 @@
-    end
-
-
+x
-      if layout ||= active_layout and action_has_layout?
-        add_variables_to_assigns
@@ -217 +214 @@
-    end
-
-_with_layout(options = {}
-
+ender_with_layout(options = {}, deprecated_status = nil, deprecated_layout = nil
+, deprecated_layout
-        add_variables_to_assigns
-        logger.info("Rendering #{template_name} within #{layout}") unless logger.nil?
-
-
+ender
-        add_variables_to_assigns
-
-        erase_render_results
-_without_layout(options.merge({ :text => @template.render_file(layout, true)
+ender_without_layout(options.merge({ :text => @template.render_file(layout, true), :status => options[:status] || deprecated_status 
-      else
-_without_layout(option
+ender_without_layout(options, deprecated_statu
-      end
-    end
-
-    private
-
+
+
+
-        case options[:layout]
-          when FalseClass
@@ -245 +244 @@
-    
-      def action_has_layout?
-
+ || {}
-        case
-          when conditions[:only]

trunk/actionpack/test/controller/new_render_test.rb

@@ -18 +18 @@
-
-  def render_hello_world
-
+ender
-  end
-
-  def render_hello_world_from_variable
-    @person = "david"
-
+ender
-  end
-
-  def render_action_hello_world
-
+ender
-  end
-  
-  def render_text_hello_world
-
+ender
-  end
-
-  def render_custom_code
-
+ender
-  end
-  
-  def render_xml_hello
-    @name = "David"
-
+ender
-  end
-
@@ -48 +48 @@
-
-  def layout_test
-
+ender
-  end
-
-  def layout_test_with_different_layout
-
+ender
-  end
-  
-  def rendering_without_layout
-
+ender
-  end
-  
-  def builder_layout_test
-
+ender
-  end
-
-  def partials_list
-    @customers = [ Customer.new("david"), Customer.new("mary") ]
-
+ender
-  end
-
@@ -74 +74 @@
-  def hello_in_a_string
-    @customers = [ Customer.new("david"), Customer.new("mary") ]
-
+ender
-  end
-  
-  def accessing_params_in_template
-
+ender
-  end
-