Permalink
Browse files

Added record identifications to FormHelper#form_for and PrototypeHelp…

…er#remote_form_for [DHH]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@6731 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
1 parent 50253ed commit 6e7b593992f8f6f8e783b87e7ab9d1d5a97063f7 @dhh dhh committed May 14, 2007
View
@@ -1,5 +1,29 @@
*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]
* Added record identification with polymorphic routes for ActionController::Base#url_for and ActionView::Base#url_for [DHH]. Examples:
@@ -999,13 +999,15 @@ def default_url_options(options) #:doc:
# Redirects the browser to the target specified in +options+. This parameter can take one of three forms:
#
# * <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.
# * <tt>:back</tt>: Back to the page that issued the request. Useful for forms that are triggered from multiple places.
# Short-hand for redirect_to(request.env["HTTP_REFERER"])
#
# Examples:
# redirect_to :action => "show", :id => 5
+ # redirect_to post
# redirect_to "http://www.rubyonrails.org"
# redirect_to "/images/screenshot.jpg"
# redirect_to :back
@@ -7,10 +7,14 @@ def polymorphic_url(record_or_hash, url_writer, options = {})
case
when options[:action] == "new"
- url_writer.send(action_prefix(options) + RecordIdentifier.singular_class_name(record) + routing_type(options))
+ url_writer.send(
+ action_prefix(options) + RecordIdentifier.singular_class_name(record) + routing_type(options)
+ )
when record.respond_to?(:new_record?) && record.new_record?
- url_writer.send(RecordIdentifier.plural_class_name(record) + routing_type(options))
+ url_writer.send(
+ action_prefix(options) + RecordIdentifier.plural_class_name(record) + routing_type(options)
+ )
else
url_writer.send(
@@ -63,7 +63,7 @@ def dom_class(record_or_class, prefix = nil)
#
# dom_class(Post.new(:id => 45), :edit) # => "edit_post_45"
def dom_id(record, prefix = nil)
- prefix ||= 'new' unless record.id
+ prefix ||= 'new' unless record.id
[ prefix, singular_class_name(record), record.id ].compact * '_'
end
@@ -103,6 +103,41 @@ module FormHelper
# 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,
# then use your custom builder. For example, let's say you made a helper to automatically add labels to form inputs.
#
@@ -120,13 +155,37 @@ module FormHelper
# end
#
# If you don't need to attach a form to a model instance, then check out FormTagHelper#form_tag.
- def form_for(object_name, *args, &proc)
+ def form_for(record_or_name, *args, &proc)
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
# Creates a scope around a specific model object like form_for, but doesn't create the form tags themselves. This makes
# fields_for suitable for specifying additional model objects in the same form:
@@ -181,8 +181,18 @@ def form_remote_tag(options = {}, &block)
end
# Works like form_remote_tag, but uses form_for semantics.
- def remote_form_for(object_name, *args, &proc)
+ def remote_form_for(record_or_name, *args, &proc)
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)
concat('</form>', proc.binding)
@@ -1,16 +1,20 @@
-module RecordIdentificationHelper
- # See ActionController::RecordIdentifier.partial_path -- this is just a delegate to that for convenient access in the view.
- def partial_path(*args, &block)
- ActionController::RecordIdentifier.partial_path(*args, &block)
- end
+module ActionView
+ module Helpers
+ module RecordIdentificationHelper
+ # See ActionController::RecordIdentifier.partial_path -- this is just a delegate to that for convenient access in the view.
+ def partial_path(*args, &block)
+ ActionController::RecordIdentifier.partial_path(*args, &block)
+ end
- # See ActionController::RecordIdentifier.dom_class -- this is just a delegate to that for convenient access in the view.
- def dom_class(*args, &block)
- ActionController::RecordIdentifier.dom_class(*args, &block)
- end
+ # See ActionController::RecordIdentifier.dom_class -- this is just a delegate to that for convenient access in the view.
+ def dom_class(*args, &block)
+ ActionController::RecordIdentifier.dom_class(*args, &block)
+ end
- # See ActionController::RecordIdentifier.dom_id -- this is just a delegate to that for convenient access in the view.
- def dom_id(*args, &block)
- ActionController::RecordIdentifier.dom_id(*args, &block)
+ # See ActionController::RecordIdentifier.dom_id -- this is just a delegate to that for convenient access in the view.
+ def dom_id(*args, &block)
+ ActionController::RecordIdentifier.dom_id(*args, &block)
+ end
+ end
end
end
@@ -1,55 +1,59 @@
-module RecordTagHelper
- # Produces a wrapper DIV element with id and class parameters that
- # relate to the specified ActiveRecord object. Usage example:
- #
- # <% div_for(@person, :class => "foo") do %>
- # <%=h @person.name %>
- # <% end %>
- #
- # produces:
- #
- # <div id="person_123" class="person foo"> Joe Bloggs </div>
- #
- def div_for(record, *args, &block)
- content_tag_for(:div, record, *args, &block)
- end
+module ActionView
+ module Helpers
+ module RecordTagHelper
+ # Produces a wrapper DIV element with id and class parameters that
+ # relate to the specified ActiveRecord object. Usage example:
+ #
+ # <% div_for(@person, :class => "foo") do %>
+ # <%=h @person.name %>
+ # <% end %>
+ #
+ # produces:
+ #
+ # <div id="person_123" class="person foo"> Joe Bloggs </div>
+ #
+ def div_for(record, *args, &block)
+ content_tag_for(:div, record, *args, &block)
+ end
- # content_tag_for creates an HTML element with id and class parameters
- # that relate to the specified ActiveRecord object. For example:
- #
- # <% content_tag_for(:tr, @person) do %>
- # <td><%=h @person.first_name %></td>
- # <td><%=h @person.last_name %></td>
- # <% end %>
- #
- # would produce hthe following HTML (assuming @person is an instance of
- # a Person object, with an id value of 123):
- #
- # <tr id="person_123" class="person">....</tr>
- #
- # If you require the HTML id attribute to have a prefix, you can specify it:
- #
- # <% content_tag_for(:tr, @person, :foo) do %> ...
- #
- # produces:
- #
- # <tr id="foo_person_123" class="person">...
- #
- # content_tag_for also accepts a hash of options, which will be converted to
- # additional HTML attributes. If you specify a +:class+ value, it will be combined
- # with the default class name for your object. For example:
- #
- # <% content_tag_for(:li, @person, :class => "bar") %>...
- #
- # produces:
- #
- # <li id="person_123" class="person bar">...
- #
- def content_tag_for(tag_name, record, *args, &block)
- prefix = args.first.is_a?(Hash) ? nil : args.shift
- options = args.first.is_a?(Hash) ? args.shift : {}
- concat content_tag(tag_name, capture(&block),
- options.merge({ :class => "#{dom_class(record)} #{options[:class]}".strip, :id => dom_id(record, prefix) })),
- block.binding
+ # content_tag_for creates an HTML element with id and class parameters
+ # that relate to the specified ActiveRecord object. For example:
+ #
+ # <% content_tag_for(:tr, @person) do %>
+ # <td><%=h @person.first_name %></td>
+ # <td><%=h @person.last_name %></td>
+ # <% end %>
+ #
+ # would produce hthe following HTML (assuming @person is an instance of
+ # a Person object, with an id value of 123):
+ #
+ # <tr id="person_123" class="person">....</tr>
+ #
+ # If you require the HTML id attribute to have a prefix, you can specify it:
+ #
+ # <% content_tag_for(:tr, @person, :foo) do %> ...
+ #
+ # produces:
+ #
+ # <tr id="foo_person_123" class="person">...
+ #
+ # content_tag_for also accepts a hash of options, which will be converted to
+ # additional HTML attributes. If you specify a +:class+ value, it will be combined
+ # with the default class name for your object. For example:
+ #
+ # <% content_tag_for(:li, @person, :class => "bar") %>...
+ #
+ # produces:
+ #
+ # <li id="person_123" class="person bar">...
+ #
+ def content_tag_for(tag_name, record, *args, &block)
+ prefix = args.first.is_a?(Hash) ? nil : args.shift
+ options = args.first.is_a?(Hash) ? args.shift : {}
+ concat content_tag(tag_name, capture(&block),
+ options.merge({ :class => "#{dom_class(record)} #{options[:class]}".strip, :id => dom_id(record, prefix) })),
+ block.binding
+ end
+ end
end
end
@@ -1,23 +1,24 @@
require File.dirname(__FILE__) + '/../abstract_unit'
-class Post
+class Comment
attr_reader :id
def save; @id = 1 end
def new_record?; @id.nil? end
def name
- @id.nil? ? 'new post' : "post ##{@id}"
+ @id.nil? ? 'new comment' : "comment ##{@id}"
end
- class Nested < Post; end
end
+class Comment::Nested < Comment; end
+
class Test::Unit::TestCase
protected
- def posts_url
- 'http://www.example.com/posts'
+ def comments_url
+ 'http://www.example.com/comments'
end
- def post_url(post)
- "http://www.example.com/posts/#{post.id}"
+ def comment_url(comment)
+ "http://www.example.com/comments/#{comment.id}"
end
end
@@ -26,10 +27,10 @@ class RecordIdentifierTest < Test::Unit::TestCase
include ActionController::RecordIdentifier
def setup
- @klass = Post
+ @klass = Comment
@record = @klass.new
- @singular = 'post'
- @plural = 'posts'
+ @singular = 'comment'
+ @plural = 'comments'
end
def test_dom_id_with_new_record
@@ -53,7 +54,7 @@ def test_dom_id_with_prefix
def test_partial_path
expected = "#{@plural}/#{@singular}"
assert_equal expected, partial_path(@record)
- assert_equal expected, partial_path(Post)
+ assert_equal expected, partial_path(Comment)
end
def test_dom_class
@@ -88,15 +89,15 @@ def method_missing(method, *args)
class NestedRecordIdentifierTest < RecordIdentifierTest
def setup
- @klass = Post::Nested
+ @klass = Comment::Nested
@record = @klass.new
- @singular = 'post_nested'
- @plural = 'post_nesteds'
+ @singular = 'comment_nested'
+ @plural = 'comment_nesteds'
end
def test_partial_path
- expected = "post/nesteds/nested"
+ expected = "comment/nesteds/nested"
assert_equal expected, partial_path(@record)
- assert_equal expected, partial_path(Post::Nested)
+ assert_equal expected, partial_path(Comment::Nested)
end
end
Oops, something went wrong.

0 comments on commit 6e7b593

Please sign in to comment.