actionpack 0.9.0 → 0.9.5

data/CHANGELOG

@@ -1,3 +1,91 @@
+*0.9.5* (28)
+
+* Added helper_method to designate that a given private or protected method you should available as a helper in the view. [bitsweat]
+
+* Fixed assert_rendered_file so it actually verifies if that was the rendered file [htonl]
+
+* Added the option for sharing partial spacer templates just like partials themselves [radsaq]
+
+* Fixed that Russia was named twice in country_select [alexey]
+
+* Fixed request_origin to use remote_ip instead of remote_addr [bitsweat]
+
+* Fixed link_to breakage when nil was passed for html_options [alexey]
+
+* Fixed redirect_to on a virtual server setup with apache with a port other than the default where it would forget the port number [seanohalpin]
+
+* Fixed that auto-loading webrick on Windows would cause file uploads to fail [bitsweat]
+
+* Fixed issues with sending files on WEBrick by setting the proper binmode [bitsweat]
+
+* Added send_data as an alternative to send_file when the stream is not read off the filesystem but from a database or generated live [bitsweat]
+
+* Added a new way to include helpers that doesn't require the include hack and can go without the explicit require. [bitsweat]
+
+  Before:
+
+    module WeblogHelper
+      def self.append_features(controller) #:nodoc:
+        controller.ancestors.include?(ActionController::Base) ? controller.add_template_helper(self) : super
+      end
+    end
+
+    require 'weblog_helper'
+    class WeblogController < ActionController::Base
+      include WeblogHelper
+    end
+    
+  After:
+
+    module WeblogHelper
+    end
+
+    class WeblogController < ActionController::Base
+      helper :weblog
+    end
+
+* Added a default content-type of "text/xml" to .rxml renders [Ryan Platte]
+
+* Fixed that when /controller/index was requested by the browser, url_for would generates wrong URLs [Ryan Platte]
+
+* Fixed a bug that would share cookies between users when using FastCGI and mod_ruby [The Robot Co-op]
+
+* Added an optional third hash parameter to the process method in functional tests that takes the session data to be used [alexey]
+
+* Added UrlHelper#mail_to to make it easier to create mailto: style ahrefs
+
+* Added better error messages for layouts declared with the .rhtml extension (which they shouldn't) [geech]
+
+* Added another case to DateHelper#distance_in_minutes to return "less than a minute" instead of "0 minutes" and "1 minute" instead of "1 minutes"
+
+* Added a hidden field to checkboxes generated with FormHelper#check_box that will make sure that the unchecked value (usually 0)
+  is sent even if the checkbox is not checked. This relieves the controller from doing custom checking if the the checkbox wasn't
+  checked. BEWARE: This might conflict with your run-on-the-mill work-around code. [Tobias Luetke]
+
+* Fixed error_message_on to just use the first if more than one error had been added [marcel]
+
+* Fixed that URL rewriting with /controller/ was working but /controller was not and that you couldn't use :id on index [geech]
+
+* Fixed a bug with link_to where the :confirm option wouldn't be picked up if the link was a straight url instead of an option hash
+
+* Changed scaffolding of forms to use <label> tags instead of <b> to please W3C [evl]
+
+* Added DateHelper#distance_of_time_in_words_to_now(from_time) that works like distance_of_time_in_words, 
+  but where <tt>to_time</tt> is fixed to <tt>Time.now</tt>.
+
+* Added assert_flash_equal(expected, key, message), assert_session_equal(expected, key, message), 
+  assert_assigned_equal(expected, key, message) to test the contents of flash, session, and template assigns.
+
+* Improved the failure report on assert_success when the action triggered a redirection [alexey].
+
+* Added "markdown" to accompany "textilize" as a TextHelper method for converting text to HTML using the Markdown syntax.
+  BlueCloth must be installed in order for this method to become available.
+
+* Made sure that an active session exists before we attempt to delete it [Samuel]
+
+* Changed link_to with Javascript confirmation to use onclick instead of onClick for XHTML validity [Scott Barron]
+
+
 *0.9.0 (43)*
 
 * Added support for Builder-based templates for files with the .rxml extension. These new templates are an alternative to ERb that

data/README

@@ -95,7 +95,7 @@ A short rundown of the major features:
 
     class WeblogController < ActionController::Base
       before_filter :authenticate, :cache, :audit
-      after_filter proc{|c| c.response.body = GZip::compress(c.response.body)}
+      after_filter { |c| c.response.body = GZip::compress(c.response.body) }
       after_filter LocalizeFilter
       
       def list
@@ -174,7 +174,7 @@ A short rundown of the major features:
     class LoginControllerTest < Test::Unit::TestCase
       def setup
         @controller = LoginController.new
-        @request     = ActionController::TestRequest.new
+        @request    = ActionController::TestRequest.new
         @response   = ActionController::TestResponse.new
       end
 

data/RUNNING_UNIT_TESTS

@@ -11,4 +11,15 @@ Rake can be found at http://rake.rubyforge.org
 If you only want to run a single test suite, or don't want to bother with Rake,
 you can do so with something like:
 
-   ruby controller/base_test.rb
+   ruby controller/base_test.rb
+
+== Dependency on ActiveRecord and database setup
+
+Test cases in test/controller/active_record_assertions.rb depend on having
+activerecord installed and configured in a particular way. See comment in the
+test file itself for details. If ActiveRecord is not in 
+actionpack/../activerecord directory, these tests are skipped. If activerecord
+is installed, but not configured as expected, the tests will fail.
+
+Other tests are runnable from a fresh copy of actionpack without any configuration.
+

data/install.rb

@@ -18,9 +18,10 @@ unless $sitedir
   end
 end
 
-makedirs = %w{ action_controller/cgi_ext action_controller/session
-               action_controller/support action_controller/templates
-               action_controller/templates/rescues action_controller/templates/scaffolds
+makedirs = %w{ action_controller/assertions action_controller/cgi_ext
+               action_controller/session action_controller/support
+               action_controller/templates action_controller/templates/rescues
+               action_controller/templates/scaffolds
                action_view/helpers action_view/vendor action_view/vendor/builder
 }
 
@@ -33,6 +34,8 @@ makedirs.each {|f| File::makedirs(File.join($sitedir, *f.split(/\//)))}
 # files to install in library path
 files = %w-
  action_controller.rb
+ action_controller/assertions/action_pack_assertions.rb
+ action_controller/assertions/active_record_assertions.rb
  action_controller/base.rb
  action_controller/benchmarking.rb
  action_controller/cgi_ext/cgi_ext.rb
@@ -40,6 +43,7 @@ files = %w-
  action_controller/cgi_process.rb
  action_controller/filters.rb
  action_controller/flash.rb
+ action_controller/helpers.rb
  action_controller/layout.rb
  action_controller/request.rb
  action_controller/rescue.rb

data/lib/action_controller.rb

@@ -32,12 +32,14 @@ require 'action_controller/filters'
 require 'action_controller/layout'
 require 'action_controller/flash'
 require 'action_controller/scaffolding'
+require 'action_controller/helpers'
 require 'action_controller/cgi_process'
 
 ActionController::Base.class_eval do
   include ActionController::Filters
   include ActionController::Layout
   include ActionController::Flash
+  include ActionController::Helpers
   include ActionController::Benchmarking
   include ActionController::Rescue
   include ActionController::Scaffolding

data/lib/action_controller/assertions/action_pack_assertions.rb

@@ -11,19 +11,30 @@ module Test #:nodoc:
       # ensure that the web request has been serviced correctly
       def assert_success(message=nil)
         response = acquire_assertion_target
-        msg = build_message(message, "unsuccessful request (response code = <?>)", response.response_code)
-        assert_block(msg) { response.success? }
+        if response.success?
+          # to count the assertion
+          assert_block("") { true }
+        else
+          if response.redirect?
+            msg = build_message(message, "Response unexpectedly redirect to <?>", response.redirect_url)
+          else
+            msg = build_message(message, "unsuccessful request (response code = <?>)", 
+                response.response_code)
+          end
+          assert_block(msg) { false }
+        end
       end
 
       # ensure the request was rendered with the appropriate template file
       def assert_rendered_file(expected=nil, message=nil)
         response = acquire_assertion_target
-        msg = build_message(message, "expecting <?> but rendering with <?>", expected, response.rendered_file)
+        rendered = expected ? response.rendered_file(!expected.include?('/')) : response.rendered_file
+        msg = build_message(message, "expecting <?> but rendering with <?>", expected, rendered)
         assert_block(msg) do
           if expected.nil?
             response.rendered_with_file?
           else
-            expected != response.rendered_file(expected.include?('/')) 
+            expected == rendered
           end
         end
       end
@@ -44,6 +55,12 @@ module Test #:nodoc:
         assert_block(msg) { !response.has_session_object?(key) }
       end
       
+      def assert_session_equal(expected = nil, key = nil, message = nil)
+        response = acquire_assertion_target
+        msg = build_message(message, "<?> expected in session['?'] but was <?>", expected, key, response.session[key])
+        assert_block(msg) { expected == response.session[key] }
+      end
+      
       # -- flash assertions ---------------------------------------------------
 
       # ensure that the flash has an object with the specified name
@@ -88,6 +105,12 @@ module Test #:nodoc:
         assert_block(msg) { response.has_flash_with_contents? }
       end
       
+      def assert_flash_equal(expected = nil, key = nil, message = nil)
+        response = acquire_assertion_target
+        msg = build_message(message, "<?> expected in flash['?'] but was <?>", expected, key, response.flash[key])
+        assert_block(msg) { expected == response.flash[key] }
+      end
+      
       # -- redirection assertions ---------------------------------------------
 
       # ensure we have be redirected
@@ -103,8 +126,11 @@ module Test #:nodoc:
 
         msg = build_message(message, "response is not a redirection to all of the options supplied (redirection is <?>)", response.redirected_to)
         assert_block(msg) do
-          response.redirected_to == options ||
+          if options.is_a?(Symbol)
+            response.redirected_to == options
+          else
             options.keys.all? { |k| options[k] == response.redirected_to[k] }
+          end
         end
       end
 
@@ -140,6 +166,13 @@ module Test #:nodoc:
         assert_block(msg) { !response.has_template_object?(key) }
       end
 
+      # ensures that the object assigned to the template on +key+ is equal to +expected+ object.
+      def assert_assigned_equal(expected = nil, key = nil, message = nil)
+        response = acquire_assertion_target
+        msg = build_message(message, "<?> expected in assigns['?'] but was <?>", expected, key, response.template.assigns[key.to_s])
+        assert_block(msg) { expected == response.template.assigns[key.to_s] }
+      end
+
       # Asserts that the template returns the +expected+ string or array based on the XPath +expression+.
       # This will only work if the template rendered a valid XML document.
       def assert_template_xpath_match(expression=nil, expected=nil, message=nil)
@@ -163,4 +196,4 @@ module Test #:nodoc:
       
     end # Assertions
   end # Unit
-end # Test
+end # Test

data/lib/action_controller/base.rb

@@ -174,6 +174,13 @@ module ActionController #:nodoc:
   
     DEFAULT_RENDER_STATUS_CODE = "200 OK"
   
+    DEFAULT_SEND_FILE_OPTIONS = {
+      :type => 'application/octet_stream',
+      :disposition  => 'attachment',
+      :stream => true, :buffer_size  => 4096
+    }
+
+
     # Determines whether the view has access to controller internals @request, @response, @session, and @template.
     # By default, it does.
     @@view_controller_internals = true
@@ -234,13 +241,6 @@ module ActionController #:nodoc:
       def process(request, response) #:nodoc:
         new.process(request, response)
       end
-
-      # Makes all the (instance) methods in the helper module available to templates rendered through this controller.
-      # See ActionView::Helpers (link:classes/ActionView/Helpers.html) for more about making your own helper modules 
-      # available to the templates.
-      def add_template_helper(helper_module)
-        template_class.class_eval "include #{helper_module}"
-      end      
     end
 
     public
@@ -285,12 +285,13 @@ module ActionController #:nodoc:
       #   "/library/books/ISBN/0743536703/show?temporary=1"
       # * <tt>:anchor</tt> - specifies the anchor name to be appended to the path. Called with "x14" would give
       #   "/library/books/ISBN/0743536703/show#x14"
+      # * <tt>:only_path</tt> - if true, returns the absolute URL (omitting the protocol, host name, and port).
       #
       # Naturally, you can combine multiple options in a single redirect. Examples:
       #
       #   redirect_to(:controller_prefix => "/shop", :controller => "settings")
       #   redirect_to(:action => "edit", :id => 3425)
-      #   redirect_to(:action => "edit", :path_params => { "type" => "XTC"}, :params => { "temp" => 1})
+      #   redirect_to(:action => "edit", :path_params => { "type" => "XTC" }, :params => { "temp" => 1})
       #   redirect_to(:action => "publish", :action_prefix => "/published", :anchor => "x14")
       #
       # Instead of passing an options hash, you can also pass a method reference in the form of a symbol. Consider this example:
@@ -380,16 +381,18 @@ module ActionController #:nodoc:
       # 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
+      # page.  send_file(@params['path']) allows a malicious user to
       # download any file on your server.
       #
       # Options:
-      # * <tt>:filename</tt> - specifies the filename the browser will see.
+      # * <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.
       #
@@ -416,46 +419,57 @@ module ActionController #:nodoc:
       # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
       # for the Cache-Control header spec.
       def send_file(path, options = {})
-        options = {
-          :filename => File.basename(path),
-          :type => 'application/octet_stream',
-          :disposition => 'attachment',
-          :buffer_size => 4096
-        }.merge(options)
-
-        # Internet Explorer cache workaround.
-        if @request.env['HTTP_USER_AGENT'] =~ /msie/i
-          @headers['Pragma']        = ''
-          @headers['Cache-Control'] = ''
-
-        # HTTP 1.1 headers require strict validation with server before
-        # releasing a cached response to client.
-        else
-          @headers['Pragma']        = 'no-cache'
-          @headers['Cache-Control'] = 'no-cache, must-revalidate'
-        end
-
-        # HTTP 1.0 headers for cache expiry.
-        @headers['Last-Modified'] = CGI.rfc1123_date(File.mtime(path))
-        @headers['Expires'] = CGI.rfc1123_date(Time.now)
-
-        # HTTP Content headers.
-        @headers['Content-Type']              = options[:type]
-        @headers['Content-Disposition']       = "#{options[:disposition]}; filename=\"#{options[:filename]}\""
-        @headers['Content-Length']            = File.size(path)
-        @headers['Content-Transfer-Encoding'] = 'binary'
-
-        logger.info("Sending file #{path}") unless logger.nil?
-
-        render_text do
-          File.open(path, 'rb') do |file|
-            while buf = file.read(options[:buffer_size])
-              print buf
+        raise MissingFile unless File.file?(path) and File.readable?(path)
+
+        options[:length]   ||= File.size(path)
+        options[:filename] ||= File.basename(path)
+        send_file_headers! options
+
+        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|
+              begin
+                while true
+                  $stdout.syswrite file.sysread(len)
+                end
+              rescue EOFError
+              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 = {})
+        logger.info "Sending data #{options[:filename]}" unless logger.nil?
+        send_file_headers! options.merge(:length => data.size)
+        render_text data
+      end
+
       def rewrite_options(options)
         if defaults = default_url_options(options)
           defaults.merge(options)
@@ -602,7 +616,7 @@ module ActionController #:nodoc:
       end
 
       def request_origin
-        "#{@request.remote_addr} at #{Time.now.to_s}"
+        "#{@request.remote_ip} at #{Time.now.to_s}"
       end
       
       def close_session
@@ -614,13 +628,32 @@ module ActionController #:nodoc:
       end
 
       def template_public?(template_name = "#{controller_name}/#{action_name}")
-	      @template.file_public?(template_name)
+        @template.file_public?(template_name)
       end
 
       def assert_existance_of_template_file(template_name)
         unless template_exists?(template_name) || ignore_missing_templates
-          raise(MissingTemplate, "Couldn't find #{template_name}")
+          full_template_path = @template.send(:full_template_path, template_name, 'rhtml')
+          template_type = (template_name =~ /layouts/i) ? 'layout' : 'template'
+          raise(MissingTemplate, "Missing #{template_type} #{full_template_path}")
         end
       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] || 'attachment'
+        disposition <<= %(; filename="#{options[:filename]}") if options[:filename]
+
+        @headers.update(
+          'Content-Length' => options[:length],
+          'Content-Type' => options[:type],
+          'Content-Disposition' => disposition,
+          'Content-Transfer-Encoding' => 'binary'
+        );
+      end
   end
 end