actionpack 1.8.1 → 1.9.0

data/lib/action_controller/streaming.rb

@@ -0,0 +1,133 @@
+module ActionController #:nodoc:
+  # Methods for sending files and streams to the browser instead of rendering.
+  module Streaming
+    DEFAULT_SEND_FILE_OPTIONS = {
+      :type         => 'application/octet-stream'.freeze,
+      :disposition  => 'attachment'.freeze,
+      :stream       => true, 
+      :buffer_size  => 4096
+    }.freeze
+
+    protected
+      # 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>:stream</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 => Proc.new {
+            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
+          }
+        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
+
+    private
+      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
+  end
+end

data/lib/action_controller/templates/rescues/_request_and_response.rhtml

@@ -33,10 +33,6 @@
   request_dump  = request_parameters_without_action.inspect.gsub(/,/, ",\n")
   session_dump  = @request.session.instance_variable_get("@data").inspect.gsub(/,/, ",\n")
   response_dump = @response.inspect.gsub(/,/, ",\n")
-
-  template_assigns = @response.template.instance_variable_get("@assigns")
-  %w( response exception template session request template_root template_class url ignore_missing_templates logger cookies headers params ).each { |t| template_assigns.delete(t) }
-  template_dump = template_assigns.inspect.gsub(/,/, ",\n")
 %>
 
 <h2 style="margin-top: 30px">Request</h2>
@@ -48,6 +44,3 @@
 
 <h2 style="margin-top: 30px">Response</h2>
 <b>Headers</b>: <%=h @response.headers.inspect.gsub(/,/, ",\n") %><br/>
-
-<p><a href="#" onclick="document.getElementById('template_dump').style.display='block'; return false;">Show template parameters</a></p>
-<div id="template_dump" style="display:none"><%= debug(template_assigns) %></div>

data/lib/action_controller/templates/scaffolds/edit.rhtml

@@ -1,7 +1,7 @@
 <h1>Editing <%= @scaffold_singular_name %></h1>
 
 <%= error_messages_for(@scaffold_singular_name) %>
-<%= form(@scaffold_singular_name, :action => "update" + @scaffold_suffix) %>
+<%= form(@scaffold_singular_name, :action => "update#{@scaffold_suffix}") %>
 
-<%= link_to "Show", :action => "show#{@scaffold_suffix}", :id => instance_variable_get("@#{@scaffold_singular_name}").id %> |
+<%= link_to "Show", :action => "show#{@scaffold_suffix}", :id => instance_variable_get("@#{@scaffold_singular_name}") %> |
 <%= link_to "Back", :action => "list#{@scaffold_suffix}" %>

data/lib/action_controller/templates/scaffolds/layout.rhtml

@@ -1,3 +1,5 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+   "http://www.w3.org/TR/html4/loose.dtd">
 <html>
 <head>
   <title>Scaffolding</title>
@@ -28,38 +30,40 @@
 
     #ErrorExplanation {
       width: 400px;
-    	border: 2px solid #red;
-    	padding: 7px;
-    	padding-bottom: 12px;
-    	margin-bottom: 20px;
-    	background-color: #f0f0f0;
+      border: 2px solid 'red';
+      padding: 7px;
+      padding-bottom: 12px;
+      margin-bottom: 20px;
+      background-color: #f0f0f0;
     }
 
     #ErrorExplanation h2 {
-    	text-align: left;
-    	font-weight: bold;
-    	padding: 5px 5px 5px 15px;
-    	font-size: 12px;
-    	margin: -7px;
-    	background-color: #c00;
-    	color: #fff;
+      text-align: left;
+      font-weight: bold;
+      padding: 5px 5px 5px 15px;
+      font-size: 12px;
+      margin: -7px;
+      background-color: #c00;
+      color: #fff;
     }
 
     #ErrorExplanation p {
-    	color: #333;
-    	margin-bottom: 0;
-    	padding: 5px;
+      color: #333;
+      margin-bottom: 0;
+      padding: 5px;
     }
 
     #ErrorExplanation ul li {
-    	font-size: 12px;
-    	list-style: square;
+      font-size: 12px;
+      list-style: square;
     }
   </style>
 </head>
 <body>
 
+<p style="color: green"><%= flash[:notice] %></p>
+
 <%= @content_for_layout %>
 
 </body>
-</html>
+</html>

data/lib/action_controller/templates/scaffolds/list.rhtml

@@ -12,9 +12,9 @@
   <% for column in @scaffold_class.content_columns %>
     <td><%= entry.send(column.name) %></td>
   <% end %>
-    <td><%= link_to "Show", :action => "show#{@scaffold_suffix}", :id => entry.id %></td>
-    <td><%= link_to "Edit", :action => "edit#{@scaffold_suffix}", :id => entry.id %></td>
-    <td><%= link_to "Destroy", :action => "destroy#{@scaffold_suffix}", :id => entry.id %></td>
+    <td><%= link_to "Show", :action => "show#{@scaffold_suffix}", :id => entry %></td>
+    <td><%= link_to "Edit", :action => "edit#{@scaffold_suffix}", :id => entry %></td>
+    <td><%= link_to "Destroy", :action => "destroy#{@scaffold_suffix}", :id => entry, :confirm => "Are you sure?" %></td>
   </tr>
 <% end %>
 </table>

data/lib/action_controller/templates/scaffolds/new.rhtml

@@ -1,6 +1,6 @@
 <h1>New <%= @scaffold_singular_name %></h1>
 
 <%= error_messages_for(@scaffold_singular_name) %>
-<%= form(@scaffold_singular_name, :action => "create" + @scaffold_suffix) %>
+<%= form(@scaffold_singular_name, :action => "create#{@scaffold_suffix}") %>
 
-<%= link_to "Back", :action => "list#{@scaffold_suffix}" %>
+<%= link_to "Back", :action => "list#{@scaffold_suffix}" %>

data/lib/action_controller/templates/scaffolds/show.rhtml

@@ -5,5 +5,5 @@
   </p>
 <% end %>
 
-<%= link_to "Edit", :action => "edit#{@scaffold_suffix}", :id => instance_variable_get("@#{@scaffold_singular_name}").id %> |
+<%= link_to "Edit", :action => "edit#{@scaffold_suffix}", :id => instance_variable_get("@#{@scaffold_singular_name}") %> |
 <%= link_to "Back", :action => "list#{@scaffold_suffix}" %>

data/lib/action_controller/test_process.rb

@@ -1,29 +1,13 @@
 require File.dirname(__FILE__) + '/assertions'
 require File.dirname(__FILE__) + '/deprecated_assertions'
 
-if defined?(RAILS_ROOT)
-  # Temporary hack for getting functional tests in Rails running under 1.8.2
-  class Object #:nodoc:
-    alias_method :require_without_load_path_reloading, :require
-    def require(file_name)
-      begin
-        require_without_load_path_reloading(file_name)
-      rescue Object => e
-        ADDITIONAL_LOAD_PATHS.reverse.each { |dir| $:.unshift(dir) if File.directory?(dir) }
-        require_without_load_path_reloading(file_name)
-      end
-    end
-  end
-end
-
-
 module ActionController #:nodoc:
   class Base
     # Process a test request called with a +TestRequest+ object.
     def self.process_test(request)
       new.process_test(request)
     end
-  
+
     def process_test(request) #:nodoc:
       process(request, TestResponse.new)
     end
@@ -32,13 +16,13 @@ module ActionController #:nodoc:
   class TestRequest < AbstractRequest #:nodoc:
     attr_accessor :cookies
     attr_accessor :query_parameters, :request_parameters, :path, :session, :env
-    attr_accessor :host, :remote_addr
+    attr_accessor :host
 
     def initialize(query_parameters = nil, request_parameters = nil, session = nil)
       @query_parameters   = query_parameters || {}
       @request_parameters = request_parameters || {}
       @session            = session || TestSession.new
-      
+
       initialize_containers
       initialize_default_values
 
@@ -47,8 +31,8 @@ module ActionController #:nodoc:
 
     def reset_session
       @session = {}
-    end    
-
+    end              
+    
     def port=(number)
       @env["SERVER_PORT"] = number.to_i
     end
@@ -57,7 +41,7 @@ module ActionController #:nodoc:
       @query_parameters.update({ "action" => action_name })
       @parameters = nil
     end
-    
+
     # Used to check AbstractRequest's request_uri functionality.
     # Disables the use of @path and @request_uri so superclass can handle those.
     def set_REQUEST_URI(value)
@@ -71,6 +55,10 @@ module ActionController #:nodoc:
       @path = uri.split("?").first
     end
 
+    def remote_addr=(addr)
+      @env['REMOTE_ADDR'] = addr
+    end
+
     def request_uri
       @request_uri || super()
     end
@@ -78,27 +66,45 @@ module ActionController #:nodoc:
     def path
       @path || super()
     end
+
+    def assign_parameters(controller_path, action, parameters)
+      parameters = parameters.symbolize_keys.merge(:controller => controller_path, :action => action)
+      extra_keys = ActionController::Routing::Routes.extra_keys(parameters)
+      non_path_parameters = get? ? query_parameters : request_parameters
+      parameters.each do |key, value|
+        if extra_keys.include?(key.to_sym)
+          non_path_parameters[key] = value
+        else
+          path_parameters[key] = value.to_s
+        end
+      end
+    end                        
     
+    def recycle!
+      self.request_parameters = {}
+      self.query_parameters   = {}         
+      self.path_parameters    = {}     
+    end    
 
     private
       def initialize_containers
         @env, @cookies = {}, {}
       end
-    
+
       def initialize_default_values
         @host                    = "test.host"
         @request_uri             = "/"
-        @remote_addr, @remote_ip = "127.0.0.1"        
+        self.remote_addr         = "0.0.0.0"        
         @env["SERVER_PORT"]      = 80
       end
   end
-  
+
   class TestResponse < AbstractResponse #:nodoc:
     # the response code of the request
     def response_code
       headers['Status'][0,3].to_i rescue 0
     end
-   
+
     # was the response successful?
     def success?
       response_code == 200
@@ -113,7 +119,7 @@ module ActionController #:nodoc:
     def redirect?
       (300..399).include?(response_code)
     end
-    
+
     # was there a server-side error?
     def error?
       (500..599).include?(response_code)
@@ -125,7 +131,7 @@ module ActionController #:nodoc:
     def redirect_url
       redirect? ? headers['location'] : nil
     end
-    
+
     # does the redirect location match this regexp pattern?
     def redirect_url_match?( pattern )
       return false if redirect_url.nil?
@@ -134,7 +140,7 @@ module ActionController #:nodoc:
       return false if p.nil?
       p.match(redirect_url) != nil
     end
-   
+
     # returns the template path of the file which was used to
     # render this response (or nil) 
     def rendered_file(with_controller=false)
@@ -156,7 +162,7 @@ module ActionController #:nodoc:
     def flash
       session['flash'] || {}
     end
-    
+
     # do we have a flash? 
     def has_flash?
       !session['flash'].empty?
@@ -181,12 +187,12 @@ module ActionController #:nodoc:
     def template_objects
       template.assigns || {}
     end
-   
+
     # does the specified template object exist? 
     def has_template_object?(name=nil)
       !template_objects[name].nil?      
     end
-    
+
     # Returns the response cookies, converted to a Hash of (name => CGI::Cookie) pairs
     # Example:
     # 
@@ -226,11 +232,11 @@ end
     def []=(key, value)
       @attributes[key] = value
     end
-    
+
     def session_id
       ""
     end
-    
+
     def update() end
     def close() end
     def delete() @attributes = {} end
@@ -243,18 +249,26 @@ module Test
       private  
         # execute the request and set/volley the response
         def process(action, parameters = nil, session = nil, flash = nil)
+          @request.recycle!
+
+          # Sanity check for required instance variables so we can give an understandable error message.
+          %w(controller request response).each do |iv_name|
+            assert_not_nil instance_variable_get("@#{iv_name}"), "@#{iv_name} is nil: make sure you set it in your test's setup method."
+          end
+
           @html_document = nil
           @request.env['REQUEST_METHOD'] ||= "GET"
           @request.action = action.to_s
-          @request.path_parameters = { :controller => @controller.class.controller_path,
-                                       :action => action.to_s }
-          @request.parameters.update(parameters) unless parameters.nil?
+
+          parameters ||= {}
+          @request.assign_parameters(@controller.class.controller_path, action.to_s, parameters)
+
           @request.session = ActionController::TestSession.new(session) unless session.nil?
           @request.session["flash"] = ActionController::Flash::FlashHash.new.update(flash) if flash
           build_request_uri(action, parameters)
           @controller.process(@request, @response)
         end
-    
+
         # execute the request simulating a specific http method and set/volley the response
         %w( get post put delete head ).each do |method|
           class_eval <<-EOV
@@ -275,7 +289,7 @@ module Test
           if @response.redirected_to[:controller]
             raise "Can't follow redirects outside of current controller (#{@response.redirected_to[:controller]})"
           end
-          
+
           get(@response.redirected_to.delete(:action), @response.redirected_to.stringify_keys)
         end
 
@@ -286,7 +300,7 @@ module Test
             @response.template.assigns[key.to_s]
           end
         end
-        
+
         def session
           @response.session
         end
@@ -304,18 +318,20 @@ module Test
         end
 
         def build_request_uri(action, parameters)
-          return if @request.env['REQUEST_URI']
-          url = ActionController::UrlRewriter.new(@request, parameters)
-          @request.set_REQUEST_URI(
-            url.rewrite(@controller.send(:rewrite_options,
-              (parameters||{}).update(:only_path => true, :action=>action))))
+          unless @request.env['REQUEST_URI']
+            options = @controller.send(:rewrite_options, parameters)
+            options.update(:only_path => true, :action => action)
+
+            url = ActionController::UrlRewriter.new(@request, parameters)
+            @request.set_REQUEST_URI(url.rewrite(options))
+          end
         end
 
         def html_document
           require_html_scanner
           @html_document ||= HTML::Document.new(@response.body)
         end
-        
+
         def find_tag(conditions)
           html_document.find(conditions)
         end
@@ -331,6 +347,11 @@ module Test
           $:.unshift File.dirname(__FILE__) + "/vendor/html-scanner"
           require 'html/document'
         end
-      end
+
+        def method_missing(selector, *args)
+          return @controller.send(selector, *args) if ActionController::Routing::NamedRoutes::Helpers.include?(selector)
+          return super
+        end
+    end
   end
 end