actionpack 1.7.0 → 1.8.0

data/CHANGELOG

@@ -1,3 +1,112 @@
+*1.8.0* (19th April, 2005)
+
+* Added assert_tag and assert_no_tag as a much improved alternative to the deprecated assert_template_xpath_match #1126 [Jamis Buck]
+
+* Deprecated the majority of all the testing assertions and replaced them with a much smaller core and access to all the collections the old assertions relied on. That way the regular test/unit assertions can be used against these. Added documentation about how to use it all.
+
+* Added a wide range of new Javascript effects:
+    * Effect.Puff zooms the element out and makes it smoothly transparent at the same time, giving a "puff" illusion #996 [thomas@fesch.at]
+      After the animation is completed, the display property will be set to none. 
+      This effect will work on relative and absolute positioned elements.
+      
+    * Effect.Appear as the opposite of Effect.Fade #990 [thomas@fesch.at]
+      You should return elements with style="display:none;" or a like class for this to work best and have no chance of flicker.
+      
+    * Effect.Squish for scaling down an element and making it disappear at the end #972 [thomas@fesch.at]
+    
+    * Effect.Scale for smoothly scaling images or text up and down #972 [thomas@fesch.at]
+    
+    * Effect.Fade which smoothly turns opacity from 100 to 0 and then hides the element #960 [thomas@fesch.at]
+
+* Added Request#xml_http_request? (and an alias xhr?) to that'll return true when the request came from one of the Javascript helper methods (Ajax). This can be used to give one behavior for modern browsers supporting Ajax, another to old browsers #1127 [Sam Stephenson]
+
+* Changed render_partial to take local assigns as the second parameter instead of an explicit object and then the assigns. So the API changes from:
+
+    <%= render_partial "account", person, "rules" => regulations.rules %>
+    
+  ...to:
+  
+    <%= render_partial "account", :account => person, :rules => regulations.rules %>
+  
+  The old API will still work, though, and render_partial "account" will still assume :account => @account.
+
+* Added support for web servers that use PATH_INFO instead of REQUEST_URI like IIS #1014 [BradG/Nicholas Seckar]
+
+* Added graceful handling of PUT, DELETE, and OPTIONS requests for a complete coverage of REST functionality #1136 [joshknowles@gmail.com]
+
+* Fixed that you can now pass an alternative :href option to link_to_function/remote in order to point to somewhere other than # if the javascript fails or is turned off. You can do the same with form_remote_tag by passing in :action. #1113 [Sam Stephenson]
+
+* Fixed DateHelper to return values on the option tags such that they'll work properly in IE with form_remote_tag #1024 [rscottmace@gmail.com]
+
+* Fixed FormTagHelper#check_box to respect checked #1049 [DelynnB]
+
+* Added that render_partial called from a controller will use the action name as default #828 [Dan Peterson]
+
+* Added Element.toggle, Element.show, and Element.hide to the prototype javascript library. Toggle.display has been deprecated, but will still work #992 [Lucas Carlson]
+
+* Added that deleting a cookie should not just set it to an empty string but also instantly expire it #1118 [todd@robotcoop.com]
+
+* Added AssetTagHelper#image_path, AssetTagHelper#javascript_path, and AssetTagHelper#stylesheet_path #1110 [Larry Halff]
+
+* Fixed url_for(nil) in functional tests #1116 [Alisdair McDiarmid]
+
+* Fixed error handling of broken layouts #1115 [Michael Schubert]
+
+* Added submit_to_remote that allows you to trigger an Ajax form submition at the click of the submission button, which allows for multiple targets in a single form through the use of multiple submit buttons #930 [yrashk@gmail.com]
+
+* Fixed pagination to work with joins #1034 [scott@sigkill.org]
+
+* Fixed that *rest parameter in map.connect couldn't accept an empty list #1037 [Dee.Zsombor@gmail.com]
+
+* Added :confirm option to link_to_remote just like link_to has #1082 [yrashk@fp.org.ua]
+
+* Added minute_step as an option to select_minute (and the helpers that use it) to jump in larger increments than just 1 minute. At 15, it would return 0, 15, 30, 45 options #1085 [ordwaye@evergreen.edu]
+
+* Fixed that an exception would be thrown when an empty form was submitted #1090 [jan@ulbrich-boerwang.de]
+
+* Moved TextHelper#human_size to NumberHelper#number_to_human_size, but kept an deprecated alias to the old method name
+
+* Fixed that the content-type for some browsers could include an additional \r which made wonky things happen #1067 [Thomas Fuchs]
+
+* Fixed that radio buttons shouldn't have a default size attribute #1074 [hendrik@mans.de]
+
+* Added ActionView::Helpers::InstanceTag::DEFAULT_RADIO_OPTIONS that contains a hash of default options for radio buttons #1074 [hendrik@mans.de]
+
+* Fixed that in some circumstances controllers outside of modules may have hidden ones inside modules. For example, admin/content might have been hidden by /content. #1075 [Nicholas Seckar]
+
+* Added JavascriptHelper#periodically_call_remote in order to create areas of a page that update automatically at a set interval #945 [Jon Tirsen]
+
+* Fixed Cache#expire_matched_fragments that couldn't recognize the difference between string and url_for options #1030 [skaes@web.de]
+
+* Added simulation of @request.request_uri in functional tests #1038 [Jamis Buck]
+
+* Fixed autolinking to work better in more cases #1013 [Jamis Buck]
+
+* Added the possible of using symbols in form helpers that relate to instance variables like text_field :account, :name in addition to text_field "account", "name"'
+
+* Fixed javascript_include_tag to output type instead of language and conform to XHTML #1018 [Rick Olson]
+
+* Added NumberHelper for common string representations like phone number, currency, and percentage #1015 [DeLynn]
+
+* Added pagination for scaffolding (10 items per page) #964 [mortonda@dgrmm.net]
+
+* Added assert_no_cookie and fixed assert_cookie_equal to deal with non-existing cookies #979 [bitsweat]
+
+* Fixed :overwrite_param so it doesn't delete but reject elements from @request.parameters #982 [raphinou@yahoo.com]
+
+* Added :method option to verify for ensuring that either GET, POST, etc is allowed #984 [Jamis Buck]
+
+* Added options to set cc, bcc, subject, and body for UrlHelper#mail_to #966 [DeLynn]
+
+* Fixed include_blank for select_hour/minute/second #527 [edward@debian.org]
+
+* Improved the message display on the exception handler pages #963 [Johan Sorensen]
+
+* Fixed that on very rare occasions, webrick would raise a NoMethodError: private method 'split' called for nil #1001 [Flurin Egger]
+
+* Fixed problem with page caching #958 [Rick Olson]
+
+
 *1.7.0* (27th March, 2005)
 
 * Added ActionController::Base.page_cache_extension for setting the page cache file extension (the default is .html) #903 [Andreas]

data/README

@@ -187,7 +187,7 @@ A short rundown of the major features:
 
     # view
     <%= link_to "Previous page", { :page => @pages.current.previous } if @pages.current.previous %>
-    <%= link_to "Next page", { :page => @pages.current.next } of @pages.current.next =%>
+    <%= link_to "Next page", { :page => @pages.current.next } if @pages.current.next %>
 
   {Learn more}[link:classes/ActionController/Pagination.html]
 
@@ -468,4 +468,4 @@ And as Jim from Rake says:
    new feature to be submitted in the form of new unit tests.
 
 For other information, feel free to ask on the ruby-talk mailing list (which
-is mirrored to comp.lang.ruby) or contact mailto:david@loudthinking.com.
+is mirrored to comp.lang.ruby) or contact mailto:david@loudthinking.com.

data/RUNNING_UNIT_TESTS

@@ -11,7 +11,7 @@ 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_tests.rb
 
 == Dependency on ActiveRecord and database setup
 

data/install.rb

@@ -18,82 +18,13 @@ unless $sitedir
   end
 end
 
-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
-}
-
-
-makedirs.each {|f| File::makedirs(File.join($sitedir, *f.split(/\//)))}
-
-# deprecated files that should be removed
-# deprecated = %w{ }
-
-# 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
- action_controller/cgi_ext/cgi_methods.rb
- action_controller/cgi_ext/cookie_performance_fix.rb
- action_controller/cgi_ext/raw_post_data_fix.rb
- action_controller/caching.rb
- action_controller/cgi_process.rb
- action_controller/cookies.rb
- action_controller/dependencies.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
- action_controller/response.rb
- action_controller/scaffolding.rb
- action_controller/session/active_record_store.rb
- action_controller/session/drb_server.rb
- action_controller/session/drb_store.rb
- action_controller/session/mem_cache_store.rb
- action_controller/session.rb
- action_controller/templates/rescues/_request_and_response.rhtml
- action_controller/templates/rescues/diagnostics.rhtml
- action_controller/templates/rescues/layout.rhtml
- action_controller/templates/rescues/missing_template.rhtml
- action_controller/templates/rescues/template_error.rhtml
- action_controller/templates/rescues/unknown_action.rhtml
- action_controller/templates/scaffolds/edit.rhtml
- action_controller/templates/scaffolds/layout.rhtml
- action_controller/templates/scaffolds/list.rhtml
- action_controller/templates/scaffolds/new.rhtml
- action_controller/templates/scaffolds/show.rhtml
- action_controller/test_process.rb
- action_controller/url_rewriter.rb
- action_view.rb
- action_view/base.rb
- action_view/helpers/active_record_helper.rb
- action_view/helpers/date_helper.rb
- action_view/helpers/debug_helper.rb
- action_view/helpers/form_helper.rb
- action_view/helpers/form_options_helper.rb
- action_view/helpers/text_helper.rb
- action_view/helpers/tag_helper.rb
- action_view/helpers/url_helper.rb
- action_view/partials.rb
- action_view/template_error.rb
- action_view/vendor/builder.rb
- action_view/vendor/builder/blankslate.rb
- action_view/vendor/builder/xmlbase.rb
- action_view/vendor/builder/xmlevents.rb
- action_view/vendor/builder/xmlmarkup.rb
--
-
 # the acual gruntwork
 Dir.chdir("lib")
-# File::safe_unlink *deprecated.collect{|f| File.join($sitedir, f.split(/\//))}
-files.each {|f| 
-  File::install(f, File.join($sitedir, *f.split(/\//)), 0644, true)
-}
+
+Find.find("action_controller", "action_controller.rb", "action_view", "action_view.rb") { |f|
+  if f[-3..-1] == ".rb"
+    File::install(f, File.join($sitedir, *f.split(/\//)), 0644, true)
+  else
+    File::makedirs(File.join($sitedir, *f.split(/\//)))
+  end
+}

data/lib/action_controller/assertions.rb

@@ -0,0 +1,203 @@
+require 'test/unit'
+require 'test/unit/assertions'
+require 'rexml/document'
+
+module Test #:nodoc:
+  module Unit #:nodoc:
+    # In addition to these specific assertions, you also have easy access to various collections that the regular test/unit assertions
+    # can be used against. These collections are:
+    #
+    # * assigns: Instance variables assigned in the action that's available for the view.
+    # * session: Objects being saved in the session.
+    # * flash: The flash objects being currently in the session.
+    # * cookies: Cookies being sent to the user on this request.
+    # 
+    # These collections can be used just like any other hash:
+    #
+    #   assert_not_nil assigns[:person] # makes sure that a @person instance variable was set
+    #   assert_equal "Dave", cookies[:name] # makes sure that a cookie called :name was set as "Dave"
+    #   assert flash.empty? # makes sure that there's nothing in the flash
+    #
+    # On top of the collections, you have the complete url that a given action redirected to available in redirect_to_url.
+    #
+    # For redirects within the same controller, you can even call follow_redirect and the redirect will be follow triggering another
+    # action call which can then be asserted against.
+    module Assertions
+      # Asserts that the response is one of the following types:
+      # 
+      # * <tt>:success</tt>: Status code was 200
+      # * <tt>:redirect</tt>: Status code was in the 300-399 range
+      # * <tt>:missing</tt>: Status code was 404
+      # * <tt>:error</tt>:  Status code was in the 500-599 range
+      #
+      # You can also pass an explicit status code number as the type, like assert_response(501)
+      def assert_response(type, message = nil)
+        if [ :success, :missing, :redirect, :error ].include?(type) && @response.send("#{type}?")
+          assert_block("") { true } # to count the assertion
+        elsif type.is_a?(Fixnum) && @response.response_code == type
+          assert_block("") { true } # to count the assertion
+        else
+          assert_block(build_message(message, "Expected response to be a <?>, but was <?>", type, @response.response_code)) { false }
+        end
+      end
+
+      # Assert that the redirection options passed in match those of the redirect called in the latest action. This match can be partial,
+      # such at assert_redirected_to(:controller => "weblog") will also match the redirection of 
+      # redirect_to(:controller => "weblog", :action => "show") and so on.
+      def assert_redirected_to(options = {}, message=nil)
+        assert_redirect(message)
+
+        msg = build_message(message, "response is not a redirection to all of the options supplied (redirection is <?>)", @response.redirected_to)
+        assert_block(msg) do
+          if options.is_a?(Symbol)
+            @response.redirected_to == options
+          else
+            options.keys.all? do |k| 
+              options[k] == (@response.redirected_to[k].respond_to?(:to_param) ? @response.redirected_to[k].to_param : @response.redirected_to[k] if @response.redirected_to[k])
+            end
+          end
+        end
+      end
+
+      # Asserts that the request was rendered with the appropriate template file.
+      def assert_template(expected = nil, message=nil)
+        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 == rendered
+          end
+        end
+      end
+
+      # Asserts that the routing of the given path is handled correctly and that the parsed options match.
+      def assert_recognizes(expected_options, path, extras={}, message=nil)
+        # Load routes.rb if it hasn't been loaded.
+        ActionController::Routing::Routes.reload if ActionController::Routing::Routes.empty? 
+      
+        # Assume given controller
+        request = ActionController::TestRequest.new({}, {}, nil)
+        request.path = path
+        ActionController::Routing::Routes.recognize!(request)
+      
+        expected_options = expected_options.clone
+        extras.each_key { |key| expected_options.delete key } unless extras.nil?
+      
+        msg = build_message(message, "The recognized options <?> did not match <?>", 
+            request.path_parameters, expected_options)
+        assert_block(msg) { request.path_parameters == expected_options }
+      end
+
+      # Asserts that the provided options can be used to generate the provided path.
+      def assert_generates(expected_path, options, defaults={}, extras = {}, message=nil)
+        # Load routes.rb if it hasn't been loaded.
+        ActionController::Routing::Routes.reload if ActionController::Routing::Routes.empty? 
+      
+        # Assume given controller
+        request = ActionController::TestRequest.new({}, {}, nil)
+        request.path_parameters = (defaults or {}).clone
+        request.path_parameters[:controller] ||= options[:controller]
+      
+        generated_path, found_extras = ActionController::Routing::Routes.generate(options, request)
+        generated_path = generated_path.join('/')
+        msg = build_message(message, "found extras <?>, not <?>", found_extras, extras)
+        assert_block(msg) { found_extras == extras }
+      
+        msg = build_message(message, "The generated path <?> did not match <?>", generated_path, 
+            expected_path)
+        assert_block(msg) { expected_path == generated_path }
+      end
+
+      # asserts that path and options match both ways, in other words, the URL generated from 
+      # options is same as path, and also that the options recognized from path are same as options
+      def assert_routing(path, options, defaults={}, extras={}, message=nil)
+        assert_recognizes(options, path, extras, message)
+        assert_generates(path, options, defaults, extras, message)
+      end
+
+      # Asserts that there is a tag/node/element in the body of the response
+      # that meets all of the given conditions. The +conditions+ parameter must
+      # be a hash of any of the following keys (all are optional):
+      #
+      # * <tt>:tag</tt>: the node type must match the corresponding value
+      # * <tt>:attributes</tt>: a hash. The node's attributes must match the
+      #   corresponding values in the hash.
+      # * <tt>:parent</tt>: a hash. The node's parent must match the
+      #   corresponding hash.
+      # * <tt>:child</tt>: a hash. At least one of the node's immediate children
+      #   must meet the criteria described by the hash.
+      # * <tt>:ancestor</tt>: a hash. At least one of the node's ancestors must
+      #   meet the criteria described by the hash.
+      # * <tt>:descendant</tt>: a hash. At least one of the node's descendants
+      #   must meet the criteria described by the hash.
+      # * <tt>:children</tt>: a hash, for counting children of a node. Accepts
+      #   the keys:
+      #   * <tt>:count</tt>: either a number or a range which must equal (or
+      #     include) the number of children that match.
+      #   * <tt>:less_than</tt>: the number of matching children must be less
+      #     than this number.
+      #   * <tt>:greater_than</tt>: the number of matching children must be
+      #     greater than this number.
+      #   * <tt>:only</tt>: another hash consisting of the keys to use
+      #     to match on the children, and only matching children will be
+      #     counted.
+      # * <tt>:content</tt>: (text nodes only). The content of the node must
+      #   match the given value.
+      #
+      # Conditions are matched using the following algorithm:
+      #
+      # * if the condition is a string, it must be a substring of the value.
+      # * if the condition is a regexp, it must match the value.
+      # * if the condition is a number, the value must match number.to_s.
+      # * if the condition is +true+, the value must not be +nil+.
+      # * if the condition is +false+ or +nil+, the value must be +nil+.
+      #
+      # Usage:
+      #
+      #   # assert that there is a "span" tag
+      #   assert_tag :tag => "span"
+      #
+      #   # assert that there is a "span" inside of a "div"
+      #   assert_tag :tag => "span", :parent => { :tag => "div" }
+      #
+      #   # assert that there is a "span" somewhere inside a table
+      #   assert_tag :tag => "span", :ancestor => { :tag => "table" }
+      #
+      #   # assert that there is a "span" with at least one "em" child
+      #   assert_tag :tag => "span", :child => { :tag => "em" }
+      #
+      #   # assert that there is a "span" containing a (possibly nested)
+      #   # "strong" tag.
+      #   assert_tag :tag => "span", :descendant => { :tag => "strong" }
+      #
+      #   # assert that there is a "span" containing between 2 and 4 "em" tags
+      #   # as immediate children
+      #   assert_tag :tag => "span",
+      #              :children => { :count => 2..4, :only => { :tag => "em" } } 
+      #
+      #   # get funky: assert that there is a "div", with an "ul" ancestor
+      #   # and an "li" parent (with "class" = "enum"), and containing a 
+      #   # "span" descendant that contains text matching /hello world/
+      #   assert_tag :tag => "div",
+      #              :ancestor => { :tag => "ul" },
+      #              :parent => { :tag => "li",
+      #                           :attributes => { :class => "enum" } },
+      #              :descendant => { :tag => "span",
+      #                               :child => /hello world/ }
+      def assert_tag(opts)
+        tag = find_tag(opts)
+        assert tag, "expected tag, but no tag found matching #{opts.inspect} in:\n#{@response.body.inspect}"
+      end
+      
+      # Identical to #assert_tag, but asserts that a matching tag does _not_
+      # exist. (See #assert_tag for a full discussion of the syntax.)
+      def assert_no_tag(opts)
+        tag = find_tag(opts)
+        assert !tag, "expected no tag, but found tag matching #{opts.inspect} in:\n#{@response.body.inspect}"
+      end
+    
+    end
+  end
+end

data/lib/action_controller/base.rb

@@ -242,7 +242,7 @@ module ActionController #:nodoc:
     cattr_accessor :ignore_missing_templates
 
     # Holds the request object that's primarily used to get environment variables through access like
-    # <tt>@request.env["REQUEST_URI"]</tt>.
+    # <tt>request.env["REQUEST_URI"]</tt>.
     attr_accessor :request
     
     # Holds a hash of all the GET, POST, and Url parameters passed to the action. Accessed like <tt>@params["post_id"]</tt>
@@ -250,16 +250,16 @@ module ActionController #:nodoc:
     attr_accessor :params
     
     # Holds the response object that's primarily used to set additional HTTP headers through access like 
-    # <tt>@response.headers["Cache-Control"] = "no-cache"</tt>. Can also be used to access the final body HTML after a template
-    # has been rendered through @response.body -- useful for <tt>after_filter</tt>s that wants to manipulate the output,
+    # <tt>response.headers["Cache-Control"] = "no-cache"</tt>. Can also be used to access the final body HTML after a template
+    # has been rendered through response.body -- useful for <tt>after_filter</tt>s that wants to manipulate the output,
     # such as a OutputCompressionFilter.
     attr_accessor :response
     
-    # Holds a hash of objects in the session. Accessed like <tt>@session["person"]</tt> to get the object tied to the "person"
+    # Holds a hash of objects in the session. Accessed like <tt>session[:person]</tt> to get the object tied to the "person"
     # key. The session will hold any type of object as values, but the key should be a string.
     attr_accessor :session
     
-    # Holds a hash of header names and values. Accessed like <tt>@headers["Cache-Control"]</tt> to get the value of the Cache-Control
+    # Holds a hash of header names and values. Accessed like <tt>headers["Cache-Control"]</tt> to get the value of the Cache-Control
     # directive. Values should always be specified as strings.
     attr_accessor :headers
     
@@ -489,11 +489,19 @@ module ActionController #:nodoc:
         @template.render_file(template_name)
       end
       
-      def render_partial(partial_path, object = nil, local_assigns = {}) #:doc:
+      # 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))
@@ -776,7 +784,7 @@ module ActionController #:nodoc:
 
         @headers.update(
           'Content-Length'            => options[:length],
-          'Content-Type'              => options[:type],
+          'Content-Type'              => options[:type].strip,  # fixes a problem with extra '\r' with some browsers
           'Content-Disposition'       => disposition,
           'Content-Transfer-Encoding' => 'binary'
         );