actionpack 1.6.0 → 1.7.0

data/CHANGELOG

@@ -1,3 +1,42 @@
+*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]
+
+* Fixed "bad environment variable value" exception caused by Safari, Apache, and Ajax calls #918
+
+* Fixed that pagination_helper would ignore :params #947 [Sebastian Kanthak]
+
+* Added :owerwrite_params back to url_for and friends -- it was AWL since the introduction of Routes #921 [raphinou]
+
+* Added :position option to link_to_remote/form_remote_tag that can be either :before, :top, :bottom, or :after and specifies where the return from the method should be inserted #952 [Matthew McCray/Sam Stephenson]
+
+* Added Effect.Highlight to prototype.js to do Yellow Fade Technique (of 37signals' fame) on any container #952 [Sam Stephenson/courtenay]
+
+* Added include_seconds option as the third parameter to distance_of_time_in_words which will render "less than a minute" in higher resolution ("less than 10 seconds" etc) #944 [thomas@fesch.at]
+
+* Added fourth option to process in test cases to specify the content of the flash #949 [Jamis Buck]
+
+* Added Verifications that allows you to specify preconditions to actions in form of statements like <tt>verify :only => :update_post, :params => "admin_privileges", :redirect_to => { :action => "settings" }</tt>, which ensure that the update_post action is only called if admin_privileges is available as a parameter -- otherwise the user is redirected to settings. #897 [Jamis Buck]
+
+* Fixed Form.Serialize for the JavascriptHelper to also seriliaze password fields #934 [dweitzman@gmail.com]
+
+* Added JavascriptHelper#escape_javascript as a public method (was private) and made it escape both single and double quotes and new lines #940 [mortonda@dgrmm.net]
+
+* Added trailing_slash option to url_for, so you can generate urls ending in a slash. Note that is currently not recommended unless you need it for special reasons since it breaks caching #937 [stian@grytoyr.net]
+
+* Added expire_matched_fragments(regular_expression) to clear out a lot of fragment caches at once #927 [technoweenie@gmail.com]
+
+* Fixed the problems with : and ? in file names for fragment caches on Windows #927 [technoweenie@gmail.com]
+
+* Added TextHelper#human_size for formatting file sizes, like human_size(1234567) => 1.2 MB #943 [thomas@fesch.at]
+
+* Fixed link_to :confirm #936 [Nicholas Seckar]
+
+* Improved error reporting especially around never shallowing exceptions. Debugging helpers should be much easier now #980 [Nicholas Seckar]
+
+* Fixed Toggle.display in prototype.js #902 [Lucas Carlson]
+
+
 *1.6.0* (22th March, 2005)
 
 * Added a JavascriptHelper and accompanying prototype.js library that opens the world of Ajax to Action Pack with a large array of options for dynamically interacting with an application without reloading the page #884 [Sam Stephenson/David]

data/lib/action_controller.rb

@@ -46,6 +46,7 @@ require 'action_controller/cookies'
 require 'action_controller/cgi_process'
 require 'action_controller/caching'
 require 'action_controller/components'
+require 'action_controller/verification'
 
 require 'action_view'
 ActionController::Base.template_class = ActionView::Base
@@ -64,4 +65,5 @@ ActionController::Base.class_eval do
   include ActionController::Session
   include ActionController::Caching
   include ActionController::Components
+  include ActionController::Verification
 end

data/lib/action_controller/base.rb

@@ -105,6 +105,13 @@ module ActionController #:nodoc:
   # Any object can be placed in the session (as long as it can be Marshalled). But remember that 1000 active sessions each storing a
   # 50kb object could lead to a 50MB memory overhead. In other words, think carefully about size and caching before resorting to the use
   # of the session.
+  # 
+  # If you store a model in the session, you must also include a line like:
+  #
+  #   model :person
+  #
+  # For that particular controller. In Rails, you can also just add it in your app/controller/application.rb file (so the model is available
+  # for all controllers). This lets Action Pack know to have the model definition loaded before retrieving the object from the session.
   #
   # For removing objects from the session, you can either assign a single key to nil, like <tt>@session[:person] = nil</tt>, or you can
   # remove the entire session with reset_session.
@@ -336,6 +343,8 @@ module ActionController #:nodoc:
       #   <tt>url_for :controller => 'posts', :action => 'show', :id => 10, :anchor => 'comments'</tt> 
       #   will produce "/posts/show/10#comments".
       # * <tt>:only_path</tt> --  if true, returns the absolute URL (omitting the protocol, host name, and port)
+      # * <tt>:trailing_slash</tt> --  if true, adds a trailing slash, as in "/archive/2005/". Note that this
+      #   is currently not recommended since it breaks caching.
       # * <tt>:host</tt> -- overrides the default (current) host if provided
       # * <tt>:protocol</tt> -- overrides the default (current) protocol if provided
       #

data/lib/action_controller/caching.rb

@@ -51,6 +51,11 @@ module ActionController #:nodoc:
     #
     # The cache directory should be the document root for the web server and is set using Base.page_cache_directory = "/document/root".
     # For Rails, this directory has already been set to RAILS_ROOT + "/public".
+    #
+    # == Setting the cache extension
+    #
+    # By default, the cache extension is .html, which makes it easy for the cached files to be picked up by the web server. If you want
+    # something else, like .php or .shtml, just set Base.page_cache_extension.
     module Pages
       def self.append_features(base) #:nodoc:
         super
@@ -58,6 +63,9 @@ module ActionController #:nodoc:
         base.class_eval do
           @@page_cache_directory = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/public" : ""
           cattr_accessor :page_cache_directory
+
+          @@page_cache_extension = '.html'
+          cattr_accessor :page_cache_extension
         end
       end
 
@@ -91,7 +99,7 @@ module ActionController #:nodoc:
         private
           def page_cache_file(path)
             name = ((path.empty? || path == "/") ? "/index" : path)
-            name << '.html' unless (name.split('/').last || name).include? '.'
+            name << @@page_cache_extension unless (name.split('/').last || name).include? '.'
             return name
           end
         
@@ -285,7 +293,12 @@ module ActionController #:nodoc:
         fragment_cache_store.delete(name, options)
         logger.info "Expired fragment: #{name}" unless logger.nil?
       end
-    
+
+      def expire_matched_fragments(re=Regexp.new('/*/'), options = {})
+        fragment_cache_store.delete_matched(re, { :root_path => url_for.split('://').last.split('/').first })
+        logger.info "Expired all fragments matching: #{re} " unless logger.nil?
+      end
+
       class MemoryStore #:nodoc:
         def initialize
           @data, @mutex = { }, Mutex.new
@@ -302,6 +315,10 @@ module ActionController #:nodoc:
         def delete(name, options = {}) #:nodoc:
           @mutex.synchronize { @data.delete(name) }
         end
+
+        def delete_matched(re, options) #:nodoc:
+          @mutex.synchronize { @data.delete_if {|k,v| k.index(options[:root_path]) == 0 and k =~ re} }
+        end
       end
 
       class DRbStore < MemoryStore #:nodoc:
@@ -335,15 +352,37 @@ module ActionController #:nodoc:
         def delete(name, options) #:nodoc:
           File.delete(real_file_path(name)) if File.exist?(real_file_path(name))
         end
+
+        def delete_matched(re, options) #:nodoc:
+          rootPath = real_file_path(options[:root_path])
+          search_dir(@cache_path).each do |f|
+            File.delete(f) if f.index(rootPath) == 0 and f =~ re and File.exist?(f)
+          end
+        end
     
         private
           def real_file_path(name)
-            "#{@cache_path}/#{name}"
+            '%s/%s' % [@cache_path, name.gsub('?', '.').gsub(':', '.')]
           end
         
           def ensure_cache_path(path)
             FileUtils.makedirs(path) unless File.exists?(path)
           end
+
+          def search_dir(dir)
+            require 'pathname'
+            files = []
+            dir = Dir.new(dir)
+            dir.each do |d|
+              unless d == '.' or d == '..'
+                d = File.join(dir.path, d)
+                p = Pathname.new(d)
+                files << p.to_s if p.file?
+                files += search_dir(d) if p.directory?
+              end
+            end
+            files
+          end
       end
     end
 

data/lib/action_controller/cgi_ext/raw_post_data_fix.rb

@@ -37,7 +37,7 @@ class CGI #:nodoc:
           when 'POST'
             stdinput.binmode if stdinput.respond_to?(:binmode)
             content = stdinput.read(Integer(env_table['CONTENT_LENGTH'])) || ''
-            env_table['RAW_POST_DATA'] = content.freeze
+            env_table['RAW_POST_DATA'] = content.split("&_").first.freeze # &_ is a fix for Safari Ajax postings that always append \000
           else
             read_from_cmdline
           end

data/lib/action_controller/dependencies.rb

@@ -71,8 +71,8 @@ module ActionController #:nodoc:
           dependencies.flatten.each do |dependency|
             begin
               require_dependency(dependency.to_s)
-            rescue LoadError
-              raise LoadError, "Missing #{layer} #{dependency}.rb"
+            rescue LoadError => e
+              raise LoadError.new("Missing #{layer} #{dependency}.rb").copy_blame!(e)
             rescue Object => exception
               exception.blame_file! "=> #{layer} #{dependency}.rb"
               raise
@@ -82,13 +82,7 @@ module ActionController #:nodoc:
 
         def inherited(child)
           inherited_without_model(child)
-          return if child.controller_name == "application" # otherwise the ApplicationController in Rails will include itself
-          begin
-            child.model(child.controller_name.singularize)
-          rescue NameError, LoadError
-            # No neither singular or plural model available for this controller
-          end
         end        
     end
   end
-end
+end

data/lib/action_controller/helpers.rb

@@ -52,12 +52,13 @@ module ActionController #:nodoc:
             when String, Symbol
               file_name  = arg.to_s.underscore + '_helper'
               class_name = file_name.camelize
-
+                
               begin
                 require_dependency(file_name)
               rescue LoadError => load_error
                 requiree = / -- (.*?)(\.rb)?$/.match(load_error).to_a[1]
-                raise LoadError, requiree == file_name ? "Missing helper file helpers/#{file_name}.rb" : "Can't load file: #{requiree}"
+                msg = (requiree == file_name) ? "Missing helper file helpers/#{file_name}.rb" : "Can't load file: #{requiree}"
+                raise LoadError.new(msg).copy_blame!(load_error)
               end
 
               add_template_helper(class_name.constantize)
@@ -90,10 +91,9 @@ module ActionController #:nodoc:
       private 
         def inherited(child)
           inherited_without_helper(child)
-          begin
-            child.helper(child.controller_path)
-          rescue ArgumentError, LoadError
-            # No default helper available for this controller
+          begin child.helper(child.controller_path)
+          rescue MissingSourceFile => e
+            raise unless e.is_missing?("helpers/#{child.controller_path}_helper")
           end
         end        
     end

data/lib/action_controller/rescue.rb

@@ -77,8 +77,8 @@ module ActionController #:nodoc:
       def perform_action_with_rescue #:nodoc:
         begin
           perform_action_without_rescue
-        rescue => exception
-          if defined?(Breakpoint) and @params["BP-RETRY"] then
+        rescue Object => exception
+          if defined?(Breakpoint) && @params["BP-RETRY"]
             msg = exception.backtrace.first
             if md = /^(.+?):(\d+)(?::in `(.+)')?$/.match(msg) then
               origin_file, origin_line = md[1], md[2].to_i

data/lib/action_controller/routing.rb

@@ -312,7 +312,7 @@ module ActionController
           route_file = defined?(RAILS_ROOT) ? File.join(RAILS_ROOT, 'config', 'routes') : nil
           require_dependency(route_file) if route_file
         rescue LoadError, ScriptError => e
-          raise RoutingError, "Cannot load config/routes.rb:\n    #{e.message}"
+          raise RoutingError.new("Cannot load config/routes.rb:\n    #{e.message}").copy_blame!(e)
         ensure # Ensure that there is at least one route:
           connect(':controller/:action/:id', :action => 'index', :id => nil) if @routes.empty?
         end

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

@@ -1,22 +1,25 @@
-<% if @exception.blamed_files && !@exception.blamed_files.empty? %>
-  <a href="#" onclick="document.getElementById('blame_trace').style.display='block'; return false;">Show blamed files</a>
-  <pre id="blame_trace" style="display:none"><code><%=h @exception.describe_blame %></code></pre>
+<% unless @exception.blamed_files.blank? %>
+  <% if (hide = @exception.blamed_files.length > 8) %>
+    <a href="#" onclick="document.getElementById('blame_trace').style.display='block'; return false;">Show blamed files</a>
+  <% end %>
+  <pre id="blame_trace" <%='style="display:none"' if hide %>><code><%=h @exception.describe_blame %></code></pre>
 <% end %>
 
 <% if defined?(Breakpoint) %>
   <br /><br />
-  <% begin %><%= form_tag({:params => {}, :only_path => true}, "method" => @request.method) %>
-    <input type="hidden" name="BP-RETRY" value="1" />
+  <% begin %>
+    <%= form_tag(@request.request_uri, "method" => @request.method) %>
+      <input type="hidden" name="BP-RETRY" value="1" />
   
-    <% for key, values in @params %>
-      <% next if key == "BP-RETRY" %>
-      <% for value in Array(values) %>
-        <input type="hidden" name="<%= key %>" value="<%= value %>" />
+      <% for key, values in @params %>
+        <% next if key == "BP-RETRY" %>
+        <% for value in Array(values) %>
+          <input type="hidden" name="<%= key %>" value="<%= value %>" />
+        <% end %>
       <% end %>
-    <% end %>
 
-    <input type="submit" value="Retry with Breakpoint" />
-  </form>
+      <input type="submit" value="Retry with Breakpoint" />
+    </form>
   <% rescue Exception => e %>
     <%=h "Couldn't render breakpoint link due to #{e.class} #{e.message}" %>
   <% end %>

data/lib/action_controller/test_process.rb

@@ -251,12 +251,13 @@ module Test
     class TestCase #:nodoc:
       private  
         # execute the request and set/volley the response
-        def process(action, parameters = nil, session = nil)
+        def process(action, parameters = nil, session = nil, flash = nil)
           @request.env['REQUEST_METHOD'] ||= "GET"
           @request.action = action.to_s
           @request.path_parameters = { :controller => @controller.class.controller_path }
           @request.parameters.update(parameters) unless parameters.nil?
           @request.session = ActionController::TestSession.new(session) unless session.nil?
+          @request.session["flash"] = ActionController::Flash::FlashHash.new.update(flash) if flash
           @controller.process(@request, @response)
         end
     

data/lib/action_controller/url_rewriter.rb

@@ -2,10 +2,9 @@ module ActionController
   # Rewrites URLs for Base.redirect_to and Base.url_for in the controller.
 
   class UrlRewriter #:nodoc:
-    RESERVED_OPTIONS = [:anchor, :params, :only_path, :host, :protocol, :application_prefix]
+    RESERVED_OPTIONS = [:anchor, :params, :only_path, :host, :protocol, :trailing_slash]
     def initialize(request, parameters)
       @request, @parameters = request, parameters
-      @rewritten_path = @request.path ? @request.path.dup : ""
     end
     
     def rewrite(options = {})      
@@ -19,14 +18,14 @@ module ActionController
     alias_method :to_s, :to_str
 
     private
-      def rewrite_url(path, options)        
-      
+      def rewrite_url(path, options)
         rewritten_url = ""
         rewritten_url << (options[:protocol] || @request.protocol) unless options[:only_path]
         rewritten_url << (options[:host] || @request.host_with_port) unless options[:only_path]
 
-        rewritten_url << (options[:application_prefix] || @request.relative_url_root) 
+        rewritten_url << @request.relative_url_root.to_s
         rewritten_url << path
+        rewritten_url << '/' if options[:trailing_slash]
         rewritten_url << "##{options[:anchor]}" if options[:anchor]
 
         return rewritten_url
@@ -34,10 +33,17 @@ module ActionController
 
       def rewrite_path(options)
         options = options.symbolize_keys
-        options.update((options[:params]).symbolize_keys) if options[:params]
+        options.update((options[:params] || {}).symbolize_keys)
         RESERVED_OPTIONS.each {|k| options.delete k}
-        
         path, extras = Routing::Routes.generate(options, @request)
+
+        if extras[:overwrite_params]
+          params_copy = @request.parameters.delete_if { |k,v| ["controller","action"].include? k }
+          params_copy.update extras[:overwrite_params]
+          extras.delete(:overwrite_params)
+          extras.update(params_copy)
+        end
+
         path = "/#{path.join('/')}".chomp '/'
         path = '/' if path.empty?
         path += build_query_string(extras)
@@ -45,46 +51,6 @@ module ActionController
         return path
       end
 
-      def action_name(options, action_prefix = nil, action_suffix = nil)
-        ensure_slash_suffix(options, :action_prefix)
-        ensure_slash_prefix(options, :action_suffix)
-
-        prefix = options[:action_prefix] || action_prefix || ""
-        suffix = options[:action] == "index" ? "" : (options[:action_suffix] || action_suffix || "")
-        name   = (options[:action] == "index" ? "" : options[:action]) || ""
-
-        return prefix + name + suffix
-      end
-      
-      def controller_name(options, controller_prefix)
-        ensure_slash_suffix(options, :controller_prefix)
-
-        controller_name = case options[:controller_prefix]
-          when String:  options[:controller_prefix]
-          when false : ""
-          when nil   : controller_prefix || ""
-        end
-
-        controller_name << (options[:controller] + "/") if options[:controller] 
-        return controller_name
-      end
-      
-      def path_params_in_list(options)
-        options[:path_params].inject("") { |path, pair| path += "/#{pair.last}" }
-      end
-
-      def ensure_slash_suffix(options, key)
-        options[key] = options[key] + "/" if options[key] && !options[key].empty? && options[key][-1..-1] != "/"
-      end
-
-      def ensure_slash_prefix(options, key)
-        options[key] = "/" + options[key] if options[key] && !options[key].empty? && options[key][0..1] != "/"
-      end
-
-      def include_id_in_path_params(options)
-        options[:path_params] = (options[:path_params] || {}).merge({"id" => options[:id]}) if options[:id]
-      end
-
       # Returns a query string with escaped keys and values from the passed hash. If the passed hash contains an "id" it'll
       # be added as a path element instead of a regular parameter pair.
       def build_query_string(hash)

data/lib/action_controller/verification.rb

@@ -0,0 +1,79 @@
+module ActionController #:nodoc:
+
+  # This module provides a class-level method for specifying that certain
+  # actions are guarded against being called without certain prerequisites
+  # being met. This is essentially a special kind of before_filter.
+  #
+  # An action may be guarded against being invoked without certain request
+  # parameters being set, or without certain session values existing.
+  #
+  # When a verification is violated, values may be inserted into the flash, and
+  # a specified redirection is triggered.
+  #
+  # Usage:
+  #
+  #   class GlobalController < ActionController::Base
+  #     # prevent the #update_settings action from being invoked unless
+  #     # the 'admin_privileges' request parameter exists.
+  #     verify :params => "admin_privileges", :only => :update_post,
+  #            :redirect_to => { :action => "settings" }
+  #
+  #     # disallow a post from being updated if there was no information
+  #     # submitted with the post, and if there is no active post in the
+  #     # session, and if there is no "note" key in the flash.
+  #     verify :params => "post", :session => "post", "flash" => "note",
+  #            :only => :update_post,
+  #            :add_flash => { "alert" => "Failed to create your message" },
+  #            :redirect_to => :category_url
+  #
+  module Verification
+    def self.append_features(base) #:nodoc:
+      super
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Verify the given actions so that if certain prerequisites are not met,
+      # the user is redirected to a different action. The +options+ parameter
+      # is a hash consisting of the following key/value pairs:
+      #
+      # * <tt>:params</tt>: a single key or an array of keys that must
+      #   be in the @params hash in order for the action(s) to be safely
+      #   called.
+      # * <tt>:session</tt>: a single key or an array of keys that must
+      #   be in the @session in order for the action(s) to be safely called.
+      # * <tt>:flash</tt>: a single key or an array of keys that must
+      #   be in the flash in order for the action(s) to be safely called.
+      # * <tt>:add_flash</tt>: a hash of name/value pairs that should be merged
+      #   into the session's flash if the prerequisites cannot be satisfied.
+      # * <tt>:redirect_to</tt>: the redirection parameters to be used when
+      #   redirecting if the prerequisites cannot be satisfied.
+      # * <tt>:only</tt>: only apply this verification to the actions specified in
+      #   the associated array (may also be a single value).
+      # * <tt>:except</tt>: do not apply this verification to the actions specified in
+      #   the associated array (may also be a single value).
+      def verify(options={})
+        filter_opts = { :only => options[:only], :except => options[:except] }
+        before_filter(filter_opts) do |c|
+          c.send :verify_action, options
+        end
+      end
+    end
+
+    def verify_action(options) #:nodoc:
+      prereqs_invalid =
+        [*options[:params] ].find { |v| @params[v].nil?  } ||
+        [*options[:session]].find { |v| @session[v].nil? } ||
+        [*options[:flash]  ].find { |v| flash[v].nil?    }
+
+      if prereqs_invalid
+        flash.update(options[:add_flash]) if options[:add_flash]
+        redirect_to(options[:redirect_to])
+        return false
+      end
+
+      true
+    end
+    private :verify_action
+  end
+end