Changeset 6731

Timestamp:

05/14/07 17:30:35 (2 years ago)

Author:

david

Message:

Added record identifications to FormHelper#form_for and PrototypeHelper#remote_form_for [DHH]

Files:

• trunk/actionpack/CHANGELOG (modified) (1 diff)
• trunk/actionpack/lib/action_controller/base.rb (modified) (2 diffs)
• trunk/actionpack/lib/action_controller/polymorphic_routes.rb (modified) (1 diff)
• trunk/actionpack/lib/action_controller/record_identifier.rb (modified) (1 diff)
• trunk/actionpack/lib/action_view/helpers/form_helper.rb (modified) (2 diffs)
• trunk/actionpack/lib/action_view/helpers/prototype_helper.rb (modified) (1 diff)
• trunk/actionpack/lib/action_view/helpers/record_identification_helper.rb (modified) (1 diff)
• trunk/actionpack/lib/action_view/helpers/record_tag_helper.rb (modified) (1 diff)
• trunk/actionpack/test/controller/record_identifier_test.rb (modified) (4 diffs)
• trunk/actionpack/test/template/form_helper_test.rb (modified) (4 diffs)
• trunk/actionpack/test/template/prototype_helper_test.rb (modified) (5 diffs)

trunk/actionpack/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Added record identifications to FormHelper#form_for and PrototypeHelper#remote_form_for [DHH]. Examples:
+
+    <% form_for(@post) do |f| %>
+      ...
+    <% end %>
+  
+  This will expand to be the same as:
+  
+    <% form_for :post, @post, :url => post_path(@post), :html => { :method => :put, :class => "edit_post", :id => "edit_post_45" } do |f| %>
+      ...
+    <% end %>
+  
+  And for new records:
+  
+    <% form_for(Post.new) do |f| %>
+      ...
+    <% end %>
+  
+  This will expand to be the same as:
+  
+    <% form_for :post, @post, :url => posts_path, :html => { :class => "new_post", :id => "new_post" } do |f| %>
+      ...
+    <% end %>
-
-* Rationalize route path escaping according to RFC 2396 section 3.3.  #7544, #8307. [Jeremy Kemper, chrisroos, begemot, jugend]

trunk/actionpack/lib/action_controller/base.rb

@@ -1000 +1000 @@
-      #
-      # * <tt>Hash</tt>: The URL will be generated by calling url_for with the +options+.
+      # * <tt>Record</tt>: The URL will be generated by calling url_for with the +options+, which will reference a named URL for that record.
-      # * <tt>String starting with protocol:// (like http://)</tt>: Is passed straight through as the target for redirection.
-      # * <tt>String not containing a protocol</tt>: The current protocol and host is prepended to the string.
@@ -1007 +1008 @@
-      # Examples:
-      #   redirect_to :action => "show", :id => 5
+      #   redirect_to post
-      #   redirect_to "http://www.rubyonrails.org"
-      #   redirect_to "/images/screenshot.jpg"

trunk/actionpack/lib/action_controller/polymorphic_routes.rb

@@ -8 +8 @@
-      case
-      when options[:action] == "new"
-
+
+
+
-
-      when record.respond_to?(:new_record?) && record.new_record?
-
+
+
+
-
-      else

trunk/actionpack/lib/action_controller/record_identifier.rb

@@ -64 +64 @@
-    #   dom_class(Post.new(:id => 45), :edit) # => "edit_post_45"
-    def dom_id(record, prefix = nil) 
- 
+
-      [ prefix, singular_class_name(record), record.id ].compact * '_'
-    end

trunk/actionpack/lib/action_view/helpers/form_helper.rb

@@ -103 +103 @@
-      # The above form will then have the <tt>id</tt> attribute with the value </tt>person_form</tt>, which you can then
-      # style with CSS or manipulate with JavaScript.
+      #
+      # === Relying on record identification
+      #
+      # In addition to manually configuring the form_for call, you can also rely on record identification, which will use
+      # the conventions and named routes of that approach. Examples:
+      #
+      #   <% form_for(@post) do |f| %>
+      #     ...
+      #   <% end %>
+      #
+      # This will expand to be the same as:
+      #
+      #   <% form_for :post, @post, :url => post_path(@post), :html => { :method => :put, :class => "edit_post", :id => "edit_post_45" } do |f| %>
+      #     ...
+      #   <% end %>
+      #
+      # And for new records:
+      #
+      #   <% form_for(Post.new) do |f| %>
+      #     ...
+      #   <% end %>
+      #
+      # This will expand to be the same as:
+      #
+      #   <% form_for :post, @post, :url => posts_path, :html => { :class => "new_post", :id => "new_post" } do |f| %>
+      #     ...
+      #   <% end %>
+      #
+      # You can also overwrite the individual conventions, like this:
+      #
+      #   <% form_for(@post, :url => super_post_path(@post)) do |f| %>
+      #     ...
+      #   <% end %>
+      #
+      # === Customized form builders
-      #
-      # You can also build forms using a customized FormBuilder class. Subclass FormBuilder and override or define some more helpers,
@@ -121 +156 @@
-      #
-      # If you don't need to attach a form to a model instance, then check out FormTagHelper#form_tag.
-object
+record_or
-        raise ArgumentError, "Missing block" unless block_given?
+
-        options = args.last.is_a?(Hash) ? args.pop : {}
+
+        case record_or_name
+        when String, Symbol
+          object_name = record_or_name
+        else
+          object      = record_or_name
+          object_name = ActionController::RecordIdentifier.singular_class_name(record_or_name)
+          apply_form_for_options!(object, options)
+        end
+
-        concat(form_tag(options.delete(:url) || {}, options.delete(:html) || {}), proc.binding)
-        fields_for(object_name, *(args << options), &proc)
-        concat('</form>', proc.binding)
+      end
+      
+      def apply_form_for_options!(object, options) #:nodoc:
+        html_options = if object.respond_to?(:new_record?) && object.new_record?
+          { :class  => dom_class(object, :new),  :id => dom_id(object), :method => :post }
+        else
+          { :class  => dom_class(object, :edit), :id => dom_id(object, :edit), :method => :put }
+        end
+        
+        options[:html] ||= {}
+        options[:html].reverse_merge!(html_options)
+
+        options[:url] ||= polymorphic_path(object, self)        
-      end
-

trunk/actionpack/lib/action_view/helpers/prototype_helper.rb

@@ -182 +182 @@
-
-      # Works like form_remote_tag, but uses form_for semantics.
-object
+record_or
-        options = args.last.is_a?(Hash) ? args.pop : {}
+
+        case record_or_name
+        when String, Symbol
+          object_name = record_or_name
+        else
+          object      = record_or_name
+          object_name = ActionController::RecordIdentifier.singular_class_name(record_or_name)
+          apply_form_for_options!(object, options)
+        end
+
-        concat(form_remote_tag(options), proc.binding)
-        fields_for(object_name, *(args << options), &proc)

trunk/actionpack/lib/action_view/helpers/record_identification_helper.rb

@@ -1 @@
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
-
+    
+    
+    
+    
-
-
-
-
+
+
+
+
+
-  end
-end

trunk/actionpack/lib/action_view/helpers/record_tag_helper.rb

@@ -1 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  end
-end

trunk/actionpack/test/controller/record_identifier_test.rb

@@ -1 +1 @@
-require File.dirname(__FILE__) + '/../abstract_unit'
-
-Pos
+Commen
-  attr_reader :id
-  def save; @id = 1 end
-  def new_record?; @id.nil? end
-  def name
-post' : "pos
+comment' : "commen
-  end
-  class Nested < Post; end
-end
+
+class Comment::Nested < Comment; end
-
-class Test::Unit::TestCase
-  protected
-pos
-pos
+commen
+commen
-    end
-    
-post_url(pos
-posts/#{pos
+comment_url(commen
+comments/#{commen
-    end
-end
@@ -27 +28 @@
-
-  def setup
-Pos
+Commen
-    @record = @klass.new
-pos
-pos
+commen
+commen
-  end
-
@@ -54 +55 @@
-    expected = "#{@plural}/#{@singular}"
-    assert_equal expected, partial_path(@record)
-Pos
+Commen
-  end
-
@@ -89 +90 @@
-class NestedRecordIdentifierTest < RecordIdentifierTest
-  def setup
-Pos
+Commen
-    @record = @klass.new
-pos
-pos
+commen
+commen
-  end
-
-  def test_partial_path
-pos
+commen
-    assert_equal expected, partial_path(@record)
-Pos
+Commen
-  end
-end

trunk/actionpack/test/template/form_helper_test.rb

@@ -1 +1 @@
-require "#{File.dirname(__FILE__)}/../abstract_unit"
+
+silence_warnings do
+  Post = Struct.new(:title, :author_name, :body, :secret, :written_on, :cost)
+  Post.class_eval do
+    alias_method :title_before_type_cast, :title unless respond_to?(:title_before_type_cast)
+    alias_method :body_before_type_cast, :body unless respond_to?(:body_before_type_cast)
+    alias_method :author_name_before_type_cast, :author_name unless respond_to?(:author_name_before_type_cast)
+
+    def new_record=(boolean)
+      @new_record = boolean
+    end
+    
+    def new_record?
+      @new_record
+    end
+  end
+end
-
-class FormHelperTest < Test::Unit::TestCase
@@ -8 +25 @@
-  include ActionView::Helpers::TextHelper
-  include ActionView::Helpers::ActiveRecordHelper
-
-
-
-
-
-
-
-
-
+
-
-  def setup
@@ -547 +556 @@
-
-    expected = "<form action=\"/posts/123\" method=\"post\"></form>"
+    assert_equal expected, _erbout
+  end
+
+  def test_form_for_with_existing_object
+    _erbout = ''
+
+    form_for(@post) do |f| end
+
+    expected = "<form action=\"/posts/123\" class=\"edit_post\" id=\"edit_post_123\" method=\"post\"><div style=\"margin:0;padding:0\"><input name=\"_method\" type=\"hidden\" value=\"put\" /></div></form>"
+    assert_equal expected, _erbout
+  end
+
+  def test_form_for_with_new_object
+    _erbout = ''
+
+    post = Post.new
+    post.new_record = true
+    def post.id() nil end
+
+    form_for(post) do |f| end
+
+    expected = "<form action=\"/posts\" class=\"new_post\" id=\"new_post\" method=\"post\"></form>"
+    assert_equal expected, _erbout
+  end
+
+  def test_form_for_with_existing_object_and_custom_url
+    _erbout = ''
+
+    form_for(@post, :url => "/super_posts") do |f| end
+
+    expected = "<form action=\"/super_posts\" class=\"edit_post\" id=\"edit_post_123\" method=\"post\"><div style=\"margin:0;padding:0\"><input name=\"_method\" type=\"hidden\" value=\"put\" /></div></form>"
+    assert_equal expected, _erbout
-  end
-  
@@ -562 +603 @@
-  protected
-    def polymorphic_path(record, url_writer)
-
+
+
+
+
+
-    end
-end

trunk/actionpack/test/template/prototype_helper_test.rb

@@ -2 +2 @@
-
-Bunny = Struct.new(:Bunny, :id)
+
+class Author
+  attr_reader :id
+  def save; @id = 1 end
+  def new_record?; @id.nil? end
+  def name
+    @id.nil? ? 'new author' : "author ##{@id}"
+  end
+end
+
+class Author::Nested < Author; end
+
-
-module BaseTest
@@ -14 +26 @@
-  include ActionView::Helpers::FormHelper
-  include ActionView::Helpers::CaptureHelper
+  include ActionView::Helpers::RecordIdentificationHelper
-  
-  def setup
@@ -42 +55 @@
-  include BaseTest
-  
+  def setup
+    @record = Author.new
+    super
+  end
+
-  def test_link_to_remote
-post
-post
-post
-post
-post
-post
-post
-post
-post
-post
+author
+author
+author
+author
+author
+author
+author
+author
+author
+author
-  end
-  
@@ -81 +99 @@
-    assert_dom_equal %(<form action=\"http://www.example.com/fast\" method=\"post\" onsubmit=\"new Ajax.Updater('glass_of_beer', 'http://www.example.com/fast', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;\">Hello world!</form>), _erbout
-  end
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  def test_on_callbacks
-    callbacks = [:uninitialized, :loading, :loaded, :interactive, :complete, :success, :failure]
@@ -162 +205 @@
-  end
-
+
+  protected
+    def author_url(record)
+      "/authors/#{record.id}"
+    end
+    
+    def authors_url
+      "/authors"
+    end
+  
+    def polymorphic_path(record, url_writer)
+      if record.new_record?
+        "/authors"
+      else
+        "/authors/#{record.id}"
+      end
+    end
-end
-