actionpack 0.9.5 → 1.0.0

data/CHANGELOG

@@ -1,3 +1,180 @@
+*1.0*
+
+* Added that controllers will now attempt to require a model dependency with their name and in a singular attempt for their name.
+  So both PostController and PostsController will automatically have the post.rb model required. If no model is found, no error is raised,
+  as it is then expected that no match is available and the programmer will have included his own models.
+
+* Fixed DateHelper#date_select so that you can pass include_blank as an option even if you don't use start_year and end_year #59 [what-a-day]
+
+* Added that controllers will now search for a layout in $template_root/layouts/$controller_name.r(html|xml), so PostsController will look
+  for layouts/posts.rhtml or layouts/posts.rxml and automatically configure this layout if found #307 [Marcel]
+
+* Added FormHelper#radio_button to work with radio buttons like its already possible with check boxes [Michael Koziarski]
+
+* Added TemplateError#backtrace that makes it much easier to debug template errors from unit and functional tests
+
+* Added display of error messages with scaffolded form pages
+
+* Added option to ERB templates to swallow newlines by using <% if something -%> instead of just <% if something %>. Example:
+
+    class SomeController < ApplicationController
+    <% if options[:scaffold] %>
+      scaffold :<%= singular_name %>
+    <% end %>
+      helper :post
+  
+  ...produces this on post as singular_name:
+
+    class SomeController < ApplicationController
+    
+      scaffold :post
+    
+      helper :post
+  
+  ...where as:
+
+    class SomeController < ApplicationController
+    <% if options[:scaffold] -%>
+      scaffold :<%= singular_name %>
+    <% end -%>
+      helper :post
+  
+  ...produces:
+
+    class SomeController < ApplicationController
+      scaffold :post
+      helper :post
+  
+  [This undocumented gem for ERb was uncovered by bitsweat]
+
+* Fixed CgiRequest so that it'll now accept session options with Symbols as keys (as the documentation points out) [Suggested by Andreas]
+
+* Added that render_partial will always by default include a counter with value 1 unless there is a counter passed in via the 
+  local_assigns hash that overrides it. As a result, render_collection_of_partials can still be written in terms of render_partial
+  and partials that make use of a counter can be called without problems from both render_collection_of_partials as well as
+  render_partial #295 [marcel]
+
+* Fixed CgiRequest#out to fall back to #write if $stdout doesn't have #syswrite [bitsweat]
+
+* Fixed all helpers so that they use XHTML compliant double quotes for values instead of single quotes [htonl/bitsweat]
+
+* Added link_to_image(src, options = {}, html_options = {}, *parameters_for_method_reference). Documentation:
+
+    Creates a link tag to the image residing at the +src+ using an URL created by the set of +options+. See the valid options in
+    link:classes/ActionController/Base.html#M000021. It's also possible to pass a string instead of an options hash to
+    get a link tag that just points without consideration. The <tt>html_options</tt> works jointly for the image and ahref tag by
+    letting the following special values enter the options on the image and the rest goes to the ahref:
+    
+    ::alt: If no alt text is given, the file name part of the +src+ is used (capitalized and without the extension)
+    ::size: Supplied as "XxY", so "30x45" becomes width="30" and height="45"
+    ::align: Sets the alignment, no special features
+    
+    The +src+ can be supplied as a... 
+    * full path, like "/my_images/image.gif"
+    * file name, like "rss.gif", that gets expanded to "/images/rss.gif"
+    * file name without extension, like "logo", that gets expanded to "/images/logo.png"
+
+* Fixed to_input_field_tag so it no longer explicitly uses InstanceTag.value if value was specified in the options hash [evl]
+
+* Added the possibility of having validate be protected for assert_(in)valid_column #263 [Tobias Luetke]
+
+* Added that ActiveRecordHelper#form now calls url_for on the :action option.
+
+* Added all the HTTP methods as alternatives to the generic "process" for functional testing #276 [Tobias Luetke]. Examples:
+
+    # Calls Controller#miletone with a GET request
+    process :milestone
+    
+    # Calls Controller#miletone with a POST request that has parameters
+    post :milestone, { "name" => "David" }
+    
+    # Calls Controller#milestone with a HEAD request that has both parameters and session data
+    head :milestone, { "id" => 1 }, { "user_id" => 23 }
+
+  This is especially useful for testing idiomatic REST web services.
+
+* Added proper handling of HEAD requests, so that content isn't returned (Request#head? added as well) #277 [Eric Hodel]
+
+* Added indifference to whether @headers["Content-Type"], @headers["Content-type"], or @headers["content-type"] is used.
+
+* Added TestSession#session_id that returns an empty string to make it easier to functional test applications that doesn't use 
+  cookie-based sessions #275 [jcf]
+
+* Fixed that cached template loading would still check the file system to see if the file existed #258 [Andreas Schwarz]
+
+* Added options to tailor header tag, div id, and div class on ActiveRecordHelper#error_messages_for [josh]
+
+* Added graceful handling of non-alphanumeric names and misplaced brackets in input parameters [bitsweat]
+
+* Added a new container for cookies that makes them more intuative to use. The old methods of cookie and @cookies have been deprecated.
+
+  Examples for writing:
+
+    cookies["user_name"] = "david" # => Will set a simple session cookie
+    cookies["login"] = { "value" => "XJ-122", "expires" => Time.now + 360} # => Will set a cookie that expires in 1 hour
+    
+  Examples for reading:
+  
+    cookies["user_name"] # => "david"
+    cookies.size         # => 2
+
+  Read more in ActionController::Cookies
+
+  NOTE: If you were using the old accessor (cookies instead of @cookies), this could potentially break your code -- if you expect a full cookie object!
+
+* Added the opportunity to defined method_missing on a controller which will handle all requests for actions not otherwise defined #223 [timb]
+
+* Fixed AbstractRequest#remote_ip for users going through proxies - Patch #228 [Eric Hodel]
+
+* Added Request#ssl? which is shorthand for @request.protocol == "https://"
+
+* Added the choice to call form_tag with no arguments (resulting in a form posting to current action) [bitsweat]
+
+* Upgraded to Builder 1.2.1
+
+* Added :module as an alias for :controller_prefix to url_for and friends, so you can do redirect_to(:module => "shop", :controller => "purchases")
+  and go to /shop/purchases/
+
+* Added support for controllers in modules through @params["module"].
+
+* Added reloading for dependencies under cached environments like FastCGI and mod_ruby. This makes it possible to use those environments for development.
+  This is turned on by default, but can be turned off with ActionController::Base.reload_dependencies = false in production environments.
+
+  NOTE: This will only have an effect if you use the new model, service, and observer class methods to mark dependencies. All libraries loaded through
+  require will be "forever" cached. You can, however, use ActionController::Base.load_or_require("library") to get this behavior outside of the new
+  dependency style.
+
+* Added that controllers will automatically require their own helper if possible. So instead of doing:
+
+    class MsgController < ApplicationController
+      helper :msg
+    end
+    
+  ...you can just do:
+  
+    class MsgController < ApplicationController
+    end
+
+* Added dependencies_on(layer) to query the dependencies of a controller. Examples:
+  
+    MsgController.dependencies_on(:model)    # => [ :post, :comment, :attachment ]
+    MsgController.dependencies_on(:service)  # => [ :notification_service ]
+    MsgController.dependencies_on(:observer) # => [ :comment_observer ]
+
+* Added a new dependency model with the class methods model, service, and observer. Example:
+
+    class MsgController < ApplicationController
+      model    :post, :comment, :attachment
+      service  :notification_service
+      observer :comment_observer
+    end
+
+  These new "keywords" remove the need for explicitly calling 'require' in most cases. The observer method even instantiates the
+  observer as well as requiring it.
+
+* Fixed that link_to would escape & in the url again after url_for already had done so
+
+
 *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]

data/README

@@ -325,7 +325,6 @@ methods:
     
     def create
       @post = Post.create(@params["post"])
-      @post.save
       redirect_to :action => "display", :id => @post.id
     end
   end

data/install.rb

@@ -41,6 +41,7 @@ files = %w-
  action_controller/cgi_ext/cgi_ext.rb
  action_controller/cgi_ext/cgi_methods.rb
  action_controller/cgi_process.rb
+ action_controller/cookies.rb
  action_controller/filters.rb
  action_controller/flash.rb
  action_controller/helpers.rb

data/lib/action_controller.rb

@@ -24,6 +24,7 @@
 $:.unshift(File.dirname(__FILE__))
 
 require 'action_controller/support/clean_logger'
+require 'action_controller/support/misc'
 
 require 'action_controller/base'
 require 'action_controller/rescue'
@@ -31,18 +32,22 @@ require 'action_controller/benchmarking'
 require 'action_controller/filters'
 require 'action_controller/layout'
 require 'action_controller/flash'
+require 'action_controller/dependencies'
 require 'action_controller/scaffolding'
 require 'action_controller/helpers'
+require 'action_controller/cookies'
 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::Dependencies
   include ActionController::Scaffolding
+  include ActionController::Helpers
+  include ActionController::Cookies
 end
 
 require 'action_view'

data/lib/action_controller/assertions/active_record_assertions.rb

@@ -22,7 +22,7 @@ module Test #:nodoc:
       # Assert the template object with the given name is an Active Record descendant and the specified column(s) are valid.
       def assert_valid_column_on_record(key = nil, columns = "", message = nil)
         record = find_record_in_template(key)
-        record.validate
+        record.send(:validate)
 
         cols = glue_columns(columns)
         cols.delete_if { |col| !record.errors.invalid?(col) }
@@ -33,7 +33,7 @@ module Test #:nodoc:
       # Assert the template object with the given name is an Active Record descendant and the specified column(s) are invalid.
       def assert_invalid_column_on_record(key = nil, columns = "", message = nil)
         record = find_record_in_template(key)
-        record.validate
+        record.send(:validate)
 
         cols = glue_columns(columns)
         cols.delete_if { |col| record.errors.invalid?(col) }

data/lib/action_controller/base.rb

@@ -58,7 +58,7 @@ module ActionController #:nodoc:
   # accessing the environment hash, like this:
   #
   #   def hello_ip
-  #     location = @request.env["REMOTE_ADDRESS"]
+  #     location = @request.env["REMOTE_IP"]
   #     render_text "Hello stranger from #{location}"
   #   end
   #
@@ -175,9 +175,10 @@ module ActionController #:nodoc:
     DEFAULT_RENDER_STATUS_CODE = "200 OK"
   
     DEFAULT_SEND_FILE_OPTIONS = {
-      :type => 'application/octet_stream',
+      :type         => 'application/octet_stream',
       :disposition  => 'attachment',
-      :stream => true, :buffer_size  => 4096
+      :stream       => true, 
+      :buffer_size  => 4096
     }
 
 
@@ -228,10 +229,6 @@ module ActionController #:nodoc:
     # directive. Values should always be specified as strings.
     attr_accessor :headers
     
-    # Holds a hash of cookie names and values. Accessed like <tt>@cookies["user_name"]</tt> to get the value of the user_name cookie.
-    # This hash is read-only. You set new cookies using the cookie method.
-    attr_accessor :cookies
-    
     # Holds the hash of variables that are passed on to the template class to be made available to the view. This hash
     # is generated by taking a snapshot of all the instance variables in the current scope just before a template is rendered.
     attr_accessor :assigns
@@ -241,17 +238,27 @@ module ActionController #:nodoc:
       def process(request, response) #:nodoc:
         new.process(request, response)
       end
+      
+      # Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
+      def controller_class_name
+        Inflector.demodulize(name)
+      end
+
+      # Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
+      def controller_name
+        Inflector.underscore(controller_class_name.sub(/Controller/, ""))
+      end
     end
 
     public
       # Extracts the action_name from the request parameters and performs that action.
-      def process(request, response) #:nodoc:
+      def process(request, response, method = :perform_action, *arguments) #:nodoc:
         initialize_template_class(response)
         assign_shortcuts(request, response)
         initialize_current_url
 
         log_processing unless logger.nil?
-        perform_action
+        send(method, *arguments)
         close_session
 
         return @response
@@ -264,10 +271,11 @@ module ActionController #:nodoc:
       #            .---> controller      .--> action
       #   /library/books/ISBN/0743536703/show
       #   '------>      '--------------> action_prefix
-      #    controller_prefix 
+      #    controller_prefix (or module)
       #
       # * <tt>:controller_prefix</tt> - specifies the string before the controller name, which would be "/library" for the example.
       #   Called with "/shop" gives "/shop/books/ISBN/0743536703/show".
+      # * <tt>:module</tt> - serves as a alias to :controller_prefix (overwrites :controller_prefix unless its nil)
       # * <tt>:controller</tt> - specifies a new controller and clears out everything after the controller name (including the action, 
       #   the pre- and suffix, and all params), so called with "settings" gives "/library/settings/".
       # * <tt>:action_prefix</tt> - specifies the string between the controller name and the action name, which would
@@ -290,6 +298,7 @@ module ActionController #:nodoc:
       # Naturally, you can combine multiple options in a single redirect. Examples:
       #
       #   redirect_to(:controller_prefix => "/shop", :controller => "settings")
+      #   redirect_to(:controller_prefix => false, :controller => "settings") # breaks out of the current controller_prefix
       #   redirect_to(:action => "edit", :id => 3425)
       #   redirect_to(:action => "edit", :path_params => { "type" => "XTC" }, :params => { "temp" => 1})
       #   redirect_to(:action => "publish", :action_prefix => "/published", :anchor => "x14")
@@ -315,14 +324,18 @@ module ActionController #:nodoc:
         end
       end
 
+      def module_name
+        @params["module"]
+      end
+
       # Converts the class name from something like "OneModule::TwoModule::NeatController" to "NeatController".
       def controller_class_name
-        self.class.name.split("::").last
+        self.class.controller_class_name
       end
 
       # Converts the class name from something like "OneModule::TwoModule::NeatController" to "neat".
       def controller_name
-        controller_class_name.sub(/Controller/, "").gsub(/([a-z])([A-Z])/) { |s| $1 + "_" + $2.downcase }.downcase
+        self.class.controller_name
       end
 
       # Returns the name of the action this controller is processing.
@@ -337,14 +350,14 @@ module ActionController #:nodoc:
       # 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>.
       def render(template_name = nil, status = nil) #:doc:
-        render_file(template_name || "#{controller_name}/#{action_name}", status, true)
+        render_file(template_name || default_template_name, status, true)
       end
       
       # Works like render, but instead of requiring a full template name, you can get by with specifying the action name. So calling
       # <tt>render_action "show_many"</tt> in WeblogController#display will render "#{template_root}/weblog/show_many.rhtml" or 
       # "#{template_root}/weblog/show_many.rxml".
       def render_action(action_name, status = nil) #:doc:
-        render "#{controller_name}/#{action_name}", status
+        render default_template_name(action_name), status
       end
       
       # Works like render, but disregards the template_root and requires a full path to the template that needs to be rendered. Can be
@@ -430,11 +443,17 @@ module ActionController #:nodoc:
             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)
+              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
-              rescue EOFError
               end
             end
           end
@@ -517,22 +536,6 @@ module ActionController #:nodoc:
         @performed_redirect = true
       end
 
-      # Creates a new cookie that is sent along-side the next render or redirect command. API is the same as for CGI::Cookie.
-      # Examples:
-      #
-      #   cookie("name", "value1", "value2", ...)
-      #   cookie("name" => "name", "value" => "value")
-      #   cookie('name'    => 'name',
-      #          'value'   => ['value1', 'value2', ...],
-      #          'path'    => 'path',   # optional
-      #          'domain'  => 'domain', # optional
-      #          'expires' => Time.now, # optional
-      #          'secure'  => true      # optional
-      #   )
-      def cookie(*options) #:doc:
-        @response.headers["cookie"] << CGI::Cookie.new(*options)
-      end
-
       # Resets the session by clearsing out all the objects stored within and initializing a new session object.
       def reset_session #:doc:
         @request.reset_session
@@ -540,6 +543,11 @@ module ActionController #:nodoc:
         @response.session = @session
       end
     
+      # Deprecated cookie writer method
+      def cookie(*options)
+        @response.headers["cookie"] << CGI::Cookie.new(*options)
+      end
+
     private
       def initialize_template_class(response)
         begin
@@ -573,7 +581,7 @@ module ActionController #:nodoc:
       end
     
       def perform_action
-        if action_methods.include?(action_name)
+        if action_methods.include?(action_name) || action_methods.include?('method_missing')
           send(action_name)
           render unless @performed_render || @performed_redirect
         elsif template_exists? && template_public?
@@ -620,14 +628,14 @@ module ActionController #:nodoc:
       end
       
       def close_session
-        @session.close  unless @session.nil? || Hash === @session
+        @session.close unless @session.nil? || Hash === @session
       end
       
-      def template_exists?(template_name = "#{controller_name}/#{action_name}")
+      def template_exists?(template_name = default_template_name)
         @template.file_exists?(template_name)
       end
 
-      def template_public?(template_name = "#{controller_name}/#{action_name}")
+      def template_public?(template_name = default_template_name)
         @template.file_public?(template_name)
       end
 
@@ -649,11 +657,15 @@ module ActionController #:nodoc:
         disposition <<= %(; filename="#{options[:filename]}") if options[:filename]
 
         @headers.update(
-          'Content-Length' => options[:length],
-          'Content-Type' => options[:type],
-          'Content-Disposition' => disposition,
+          'Content-Length'            => options[:length],
+          'Content-Type'              => options[:type],
+          'Content-Disposition'       => disposition,
           'Content-Transfer-Encoding' => 'binary'
         );
       end
+
+      def default_template_name(default_action_name = action_name)
+        module_name ? "#{module_name}/#{controller_name}/#{default_action_name}" : "#{controller_name}/#{default_action_name}"
+      end
   end
 end