diff --git a/actionpack/lib/action_view/helpers/ajax_helper.rb b/actionpack/lib/action_view/helpers/ajax_helper.rb
index 445e59d3a5..169a803848 100644
--- a/actionpack/lib/action_view/helpers/ajax_helper.rb
+++ b/actionpack/lib/action_view/helpers/ajax_helper.rb
@@ -6,12 +6,11 @@ module ActionView
include PrototypeHelper
# Returns a form that will allow the unobtrusive JavaScript drivers to submit the
- # form the dynamic nature of their choice. The default behaviour is an XMLHttpRequest
- # in the background instead of the regular POST arrangement. Even though it's using
- # JavaScript to serialize the form elements, the form submission will work just like
- # a regular submission as viewed by the receiving side (all elements available in
- # params). The options for specifying the target with :url and
- # defining callbacks is the same as +link_to_remote+.
+ # form dynamically. The default driver behaviour is an XMLHttpRequest in the background
+ # instead of the regular POST arrangement. Even though it's using JavaScript to serialize
+ # the form elements, the form submission will work just like a regular submission as
+ # viewed by the receiving side (all elements available in params). The options
+ # for specifying the target with :url anddefining callbacks is the same as +link_to_remote+.
#
# === Resource
#
@@ -30,7 +29,10 @@ module ActionView
#
# This will expand to be the same as:
#
- # <% remote_form_for :post, @post, :url => post_path(@post), :html => { :method => :put, :class => "edit_post", :id => "edit_post_45" } do |f| %>
+ # <% remote_form_for :post, @post, :url => post_path(@post),
+ # :html => { :method => :put,
+ # :class => "edit_post",
+ # :id => "edit_post_45" } do |f| %>
# ...
# <% end %>
#
@@ -38,22 +40,22 @@ module ActionView
#
# Example:
# # Generates:
- # #
# #
- # <% remote_form_for([@post, @comment]) do |f| %>
+ # <% remote_form_for([@author, @article]) do |f| %>
# ...
# <% end %>
#
# This will expand to be the same as:
#
- # <% remote_form_for :comment, @comment, :url => post_comment_path(@post, @comment),
+ # <% remote_form_for :article, @article, :url => author_article_path(@author, @article),
# :html => { :method => :put,
- # :class => "edit_comment",
- # :id => "edit_comment_45" } do |f| %>
+ # :class => "new_article",
+ # :id => "new_comment" } do |f| %>
# ...
# <% end %>
#
@@ -76,14 +78,13 @@ module ActionView
alias_method :form_remote_for, :remote_form_for
# Returns a form tag that will allow the unobtrusive JavaScript drivers to submit the
- # form via the dynamic behaviour of choice. The default behaviour is an XMLHttpRequest
+ # form dynamically. The default JavaScript driver behaviour is an XMLHttpRequest
# in the background instead of the regular POST arrangement. Even though it's using
# JavaScript to serialize the form elements, the form submission will work just like
# a regular submission as viewed by the receiving side (all elements available in
# params). The options for specifying the target with :url and
# defining callbacks is the same as +link_to_remote+.
#
- #
# A "fall-through" target for browsers that doesn't do JavaScript can be
# specified with the :action/:method options on :html.
#
@@ -93,9 +94,9 @@ module ActionView
# #
# #
- # form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast })
+ # form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }) {}
#
# The Hash passed to the :html key is equivalent to the options (2nd)
# argument in the FormTagHelper.form_tag method.
@@ -105,14 +106,14 @@ module ActionView
#
# form_remote_tag also takes a block, like form_tag:
# # Generates:
- # #
# #
# <% form_remote_tag :url => '/posts' do -%>
- #
<%= submit_tag 'Save' %>
+ # <%= submit_tag 'Save' %>
# <% end -%>
#
# # Generates:
@@ -122,7 +123,7 @@ module ActionView
# # data-update-success="glass_of_beer">Hello world!
# #
# <% form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }) do -%>
- # <% concat "Hello world!" %>
+ # "Hello world!"
# <% end -%>
#
def form_remote_tag(options = {}, &block)
@@ -178,27 +179,38 @@ module ActionView
#
# Example:
# # Generates:
- # # Delete this post
+ # #
+ # # Delete this Post'
# #
# link_to_remote "Delete this post",
- # :url => { :action => "destroy", :id => post.id },
+ # :url => { :action => "destroy"},
# :update => { :success => "posts", :failure => "error" }
#
# Optionally, you can use the options[:position] parameter to
# influence how the target DOM element is updated. It must be one of
# :before, :top, :bottom, or :after.
#
+ # Example:
+ # # Generates:
+ # # Remove Author
+ # #
+ # link_to_remote("Remove Author", :url => { :action => "whatnot" }, :position => :bottom)
+ #
+ #
# The method used is by default POST. You can also specify GET or you
# can simulate PUT or DELETE over POST. All specified with options[:method]
#
# Example:
# # Generates:
- # # Destroy
@@ -215,12 +227,14 @@ module ActionView
#
# Example:
# # Generates:
- # # hello
# #
- # word = 'hello'
- # link_to_remote word,
- # :url => { :action => "undo", :n => word_counter },
+ # # undo
+ # #
+ # link_to_remote "undo",
+ # :url => { :controller => "words", :action => "undo", :n => word_counter },
# :complete => "undoRequestCompleted(request)"
#
# The callbacks that may be specified are (in order):
@@ -290,7 +304,7 @@ module ActionView
#
# :with => "'name=' + $('name').value"
#
- # You can generate a link that uses AJAX in the general case, while
+ # You can generate a link that uses the UJS drivers in the general case, while
# degrading gracefully to plain link behavior in the absence of
# JavaScript by setting html_options[:href] to an alternate URL.
# Note the extra curly braces around the options hash separate
@@ -309,6 +323,7 @@ module ActionView
#
def link_to_remote(name, options, html_options = {})
attributes = {}
+
attributes.merge!(:rel => "nofollow") if options[:method] && options[:method].to_s.downcase == "delete"
attributes.merge!(extract_remote_attributes!(options))
@@ -369,7 +384,7 @@ module ActionView
# # type='button'
# # value='Create'
# # data-remote='true'
- # # data-url='/testing/create' />
+ # # data-url='/create' />
# #
# <%= submit_to_remote 'create_btn', 'Create', :url => { :action => 'create' } %>
#
@@ -380,7 +395,7 @@ module ActionView
# #
@@ -401,34 +416,49 @@ module ActionView
tag(:input, attributes)
end
- # Periodically calls the specified url (options[:url]) every
- # options[:frequency] seconds (default is 10). Usually used to
+ # Periodically provides the UJS driver with the information to call the specified
+ # url (options[:url]) every options[:frequency] seconds (default is 10). Usually used to
# update a specified div (options[:update]) with the results
# of the remote call. The options for specifying the target with :url
# and defining callbacks is the same as link_to_remote.
# Examples:
# # Call get_averages and put its results in 'avg' every 10 seconds
# # Generates:
- # # new PeriodicalExecuter(function() {new Ajax.Updater('avg', '/grades/get_averages',
- # # {asynchronous:true, evalScripts:true})}, 10)
+ # #
+ # #
# periodically_call_remote(:url => { :action => 'get_averages' }, :update => 'avg')
#
# # Call invoice every 10 seconds with the id of the customer
# # If it succeeds, update the invoice DIV; if it fails, update the error DIV
# # Generates:
- # # new PeriodicalExecuter(function() {new Ajax.Updater({success:'invoice',failure:'error'},
- # # '/testing/invoice/16', {asynchronous:true, evalScripts:true})}, 10)
- # periodically_call_remote(:url => { :action => 'invoice', :id => customer.id },
+ # # "
+ # #
+ # periodically_call_remote(:url => { :action => 'invoice', :id => 1 },
# :update => { :success => "invoice", :failure => "error" }
#
# # Call update every 20 seconds and update the new_block DIV
# # Generates:
- # # new PeriodicalExecuter(function() {new Ajax.Updater('news_block', 'update', {asynchronous:true, evalScripts:true})}, 20)
+ # #
+ # #
# periodically_call_remote(:url => 'update', :frequency => '20', :update => 'news_block')
#
def periodically_call_remote(options = {})
attributes = extract_observer_attributes!(options)
attributes["data-periodical"] = true
+ attributes["data-frequency"] ||= 10
# periodically_call_remote does not need data-observe=true
attributes.delete('data-observe')
@@ -442,8 +472,16 @@ module ActionView
# parameter with the Ajax call.
#
# Example:
- # # Generates: new Form.Element.Observer('suggest', 0.25, function(element, value) {new Ajax.Updater('suggest',
- # # '/testing/find_suggestion', {asynchronous:true, evalScripts:true, parameters:'q=' + value})})
+ # # Generates:
+ # # ""
+ # #
# <%= observe_field :suggest, :url => { :action => :find_suggestion },
# :frequency => 0.25,
# :update => :suggest,
@@ -567,7 +605,7 @@ module ActionView
url_options = options.delete(:url)
url_options = url_options.merge(:escape => false) if url_options.is_a?(Hash)
- attributes["data-url"] = escape_javascript(url_for(url_options))
+ attributes["data-url"] = escape_javascript(url_for(url_options)) if url_options
purge_unused_attributes!(attributes)
end
@@ -591,14 +629,14 @@ module ActionView
def extract_observer_attributes!(options)
callback = options.delete(:function)
- frequency = options.delete(:frequency)
+ frequency = options.delete(:frequency) || 10
attributes = extract_remote_attributes!(options)
attributes["data-observe"] = true
attributes["data-observed"] = options.delete(:observed)
attributes["data-onobserve"] = callback if callback
- attributes["data-frequency"] = frequency.to_i if frequency && frequency != 0
+ attributes["data-frequency"] = frequency if frequency && frequency.to_f != 0
attributes.delete("data-remote")
purge_unused_attributes!(attributes)
diff --git a/actionpack/test/template/ajax_helper_test.rb b/actionpack/test/template/ajax_helper_test.rb
index ed020d74f8..c925dbb8f6 100644
--- a/actionpack/test/template/ajax_helper_test.rb
+++ b/actionpack/test/template/ajax_helper_test.rb
@@ -6,8 +6,14 @@ class Author
include ActiveModel::Conversion
attr_reader :id
- def save; @id = 1 end
- def new_record?; @id.nil? end
+ def save
+ @id = 1
+ end
+
+ def new_record?
+ @id.nil?
+ end
+
def name
@id.nil? ? 'new author' : "author ##{@id}"
end
@@ -18,8 +24,16 @@ class Article
include ActiveModel::Conversion
attr_reader :id
attr_reader :author_id
- def save; @id = 1; @author_id = 1 end
- def new_record?; @id.nil? end
+
+ def save
+ @id = 1
+ @author_id = 1
+ end
+
+ def new_record?
+ @id.nil?
+ end
+
def name
@id.nil? ? 'new article' : "article ##{@id}"
end
@@ -36,17 +50,34 @@ class AjaxHelperBaseTest < ActionView::TestCase
super
@template = self
@controller = Class.new do
+
def url_for(options)
- if options.is_a?(String)
- options
- else
- url = "http://www.example.com/"
- url << options[:action].to_s if options and options[:action]
- url << "?a=#{options[:a]}" if options && options[:a]
- url << "&b=#{options[:b]}" if options && options[:a] && options[:b]
- url
+ return optons unless options.is_a?(Hash)
+
+ url = options.delete(:only_path) ? '/' : 'http://www.example.com'
+
+ if controller = options.delete(:controller)
+ url << '/' << controller.to_s
end
+ if action = options.delete(:action)
+ url << '/' << action.to_s
+ end
+
+ if id = options.delete(:id)
+ url << '/' << id.to_s
+ end
+
+ url << hash_to_param(options) if options.any?
+
+ url.gsub!(/\/\/+/,'/')
+
+ url
end
+
+ private
+ def hash_to_param(hash)
+ hash.map { |k,v| "#{k}=#{v}" }.join('&').insert(0,'?')
+ end
end.new
end
@@ -70,24 +101,36 @@ class AjaxHelperTest < AjaxHelperBaseTest
end
test "link_to_remote" do
- assert_dom_equal %(Remote outauthor),
- link_to_remote("Remote outauthor", { :url => { :action => "whatnot" }}, { :class => "fine" })
- assert_dom_equal %(Remote outauthor),
- link_to_remote("Remote outauthor", :complete => "alert(request.responseText)", :url => { :action => "whatnot" })
- assert_dom_equal %(Remote outauthor),
- link_to_remote("Remote outauthor", :success => "alert(request.responseText)", :url => { :action => "whatnot" })
- assert_dom_equal %(Remote outauthor),
- link_to_remote("Remote outauthor", :failure => "alert(request.responseText)", :url => { :action => "whatnot" })
- assert_dom_equal %(Remote outauthor),
- link_to_remote("Remote outauthor", :failure => "alert(request.responseText)", :url => { :action => "whatnot", :a => '10', :b => '20' })
- assert_dom_equal %(Remote outauthor),
- link_to_remote("Remote outauthor", :url => { :action => "whatnot" }, :type => :synchronous)
- assert_dom_equal %(Remote outauthor),
- link_to_remote("Remote outauthor", :url => { :action => "whatnot" }, :position => :bottom)
+ assert_dom_equal %(Remove Author),
+ link_to_remote("Remove Author", { :url => { :action => "whatnot" }}, { :class => "fine" })
+ assert_dom_equal %(Remove Author),
+ link_to_remote("Remove Author", :complete => "alert(request.responseText)", :url => { :action => "whatnot" })
+ assert_dom_equal %(Remove Author),
+ link_to_remote("Remove Author", :success => "alert(request.responseText)", :url => { :action => "whatnot" })
+ assert_dom_equal %(Remove Author),
+ link_to_remote("Remove Author", :failure => "alert(request.responseText)", :url => { :action => "whatnot" })
+ assert_dom_equal %(Remove Author),
+ link_to_remote("Remove Author", :failure => "alert(request.responseText)", :url => { :action => "whatnot", :a => '10', :b => '20' })
+ assert_dom_equal %(Remove Author),
+ link_to_remote("Remove Author", :url => { :action => "whatnot" }, :type => :synchronous)
+ assert_dom_equal %(Remove Author),
+ link_to_remote("Remove Author", :url => { :action => "whatnot" }, :position => :bottom)
end
+ test "link_to_remote with url and oncomplete" do
+ actual = link_to_remote "undo", :url => { :controller => "words", :action => "undo", :n => 5 }, :complete => "undoRequestCompleted(request)"
+ expected = 'undo'
+ assert_dom_equal expected, actual
+ end
+
+ test "link_to_remote with delete" do
+ actual = link_to_remote("Remove Author", { :url => { :action => "whatnot" }, :method => 'delete'}, { :class => "fine" })
+ expected = 'Remove Author'
+ assert_dom_equal expected, actual
+ end
+
test "link_to_remote using both url and href" do
- expected = 'Delete this Post'
+ expected = 'Delete this Post'
assert_dom_equal expected, link_to_remote( "Delete this Post",
{ :update => "posts",
:url => { :action => "destroy" } },
@@ -95,135 +138,162 @@ class AjaxHelperTest < AjaxHelperBaseTest
end
test "link_to_remote with update-success and url" do
- expected = 'Delete this Post'
- assert_dom_equal expected, link_to_remote( "Delete this Post", :url => { :action => "destroy", :id => 5 },
+ expected = 'Delete this Post'
+ assert_dom_equal expected, link_to_remote( "Delete this Post", :url => { :action => "destroy"},
:update => { :success => "posts", :failure => "error" })
end
test "link_to_remote with before/after callbacks" do
- assert_dom_equal %(Remote outauthor),
+ assert_dom_equal %(Remote outauthor),
link_to_remote("Remote outauthor", :url => { :action => "whatnot" }, :before => "before();", :after => "after();")
end
test "link_to_remote using :with expression" do
- expected = %(Remote outauthor)
+ expected = %(Remote outauthor)
assert_dom_equal expected, link_to_remote("Remote outauthor", :url => { :action => "whatnot" }, :with => "id=123")
end
test "link_to_remote using :condition expression" do
- expected = %(Remote outauthor)
+ expected = %(Remote outauthor)
assert_dom_equal expected, link_to_remote("Remote outauthor", :url => { :action => "whatnot" }, :condition => '$(\'foo\').val() == true')
end
test "link_to_remote using explicit :href" do
- expected = %(Remote outauthor)
+ expected = %(Remote outauthor)
assert_dom_equal expected, link_to_remote("Remote outauthor", {:url => { :action => "whatnot" }, :condition => '$(\'foo\').val() == true'}, :href => 'http://www.example.com/testhref')
end
test "link_to_remote using :submit" do
- expected = %(Remote outauthor)
+ expected = %(Remote outauthor)
assert_dom_equal expected, link_to_remote("Remote outauthor", :url => { :action => "whatnot" }, :submit => 'myForm')
end
test "link_to_remote with method delete" do
- assert_dom_equal %(Remote outauthor),
+ assert_dom_equal %(Remote outauthor),
link_to_remote("Remote outauthor", { :url => { :action => "whatnot" }, :method => "delete"}, { :class => "fine" })
end
test "link_to_remote with method delete as symbol" do
- assert_dom_equal %(Remote outauthor),
+ assert_dom_equal %(Remote outauthor),
link_to_remote("Remote outauthor", { :url => { :action => "whatnot" }, :method => :delete}, { :class => "fine" })
end
test "link_to_remote html options" do
- assert_dom_equal %(Remote outauthor),
+ assert_dom_equal %(Remote outauthor),
link_to_remote("Remote outauthor", { :url => { :action => "whatnot" }, :html => { :class => "fine" } })
end
test "link_to_remote url quote escaping" do
- assert_dom_equal %(Remote),
+ assert_dom_equal %(Remote),
link_to_remote("Remote", { :url => { :action => "whatnot's" } })
end
test "link_to_remote with confirm" do
- assert_dom_equal %(Remote confirm),
+ assert_dom_equal %(Remote confirm),
link_to_remote("Remote confirm", { :url => { :action => "whatnot" }, :method => "delete", :confirm => "Are you sure?"}, { :class => "fine" })
end
test "button_to_remote" do
- assert_dom_equal %(),
+ assert_dom_equal %(),
button_to_remote("Remote outpost", { :url => { :action => "whatnot" }}, { :class => "fine" })
- assert_dom_equal %(),
+ assert_dom_equal %(),
button_to_remote("Remote outpost", :complete => "alert(request.reponseText)", :url => { :action => "whatnot" })
- assert_dom_equal %(),
+ assert_dom_equal %(),
button_to_remote("Remote outpost", :success => "alert(request.reponseText)", :url => { :action => "whatnot" })
- assert_dom_equal %(),
+ assert_dom_equal %(),
button_to_remote("Remote outpost", :failure => "alert(request.reponseText)", :url => { :action => "whatnot" })
- assert_dom_equal %(),
+ assert_dom_equal %(),
button_to_remote("Remote outpost", :failure => "alert(request.reponseText)", :url => { :action => "whatnot", :a => '10', :b => '20' })
end
test "button_to_remote with confirm" do
- assert_dom_equal %(),
+ assert_dom_equal %(),
button_to_remote("Remote outpost", { :url => { :action => "whatnot" }, :confirm => "Are you sure?"}, { :class => "fine" })
end
test "button_to_remote with :submit" do
- assert_dom_equal %(),
+ assert_dom_equal %(),
button_to_remote("Remote outpost", { :url => { :action => "whatnot" }, :submit => "myForm"}, { :class => "fine" })
end
test "periodically_call_remote" do
- assert_dom_equal %(),
- periodically_call_remote(:update => "schremser_bier", :url => { :action => "mehr_bier" })
+ expected = ""
+ actual = periodically_call_remote(:update => "schremser_bier", :url => { :action => "mehr_bier" })
+ assert_dom_equal expected, actual
end
test "periodically_call_remote_with_frequency" do
- assert_dom_equal(
- "",
- periodically_call_remote(:frequency => 2)
- )
+ expected = ""
+ actual = periodically_call_remote(:frequency => 2)
+ assert_dom_equal expected, actual
end
test "periodically_call_remote_with_function" do
- assert_dom_equal(
- "",
- periodically_call_remote(:frequency => 2, :function => "alert('test')")
- )
+ expected = ""
+ actual = periodically_call_remote(:frequency => 2, :function => "alert('test')")
+ assert_dom_equal expected, actual
+ end
+
+ test "periodically_call_remote_with_update" do
+ actual = periodically_call_remote(:url => { :action => 'get_averages' }, :update => 'avg')
+ expected = ""
+ assert_dom_equal expected, actual
+ end
+
+ test "periodically_call_remote with update success and failure" do
+ actual = periodically_call_remote(:url => { :action => 'invoice', :id => 1 },:update => { :success => "invoice", :failure => "error" })
+ expected = ""
+ assert_dom_equal expected, actual
+ end
+
+ test "periodically_call_remote with frequency and update" do
+ actual = periodically_call_remote(:url => 'update', :frequency => '20', :update => 'news_block')
+ expected = ""
+ assert_dom_equal expected, actual
end
test "form_remote_tag" do
- assert_dom_equal %("
+ assert_dom_equal expected, output_buffer
+ end
+
test "form_remote_tag with block in erb" do
__in_erb_template = ''
form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }) { concat "Hello world!" }
- assert_dom_equal %(), output_buffer
+ assert_dom_equal %(), output_buffer
end
test "remote_form_for with record identification with new record" do
remote_form_for(@record, {:html => { :id => 'create-author' }}) {}
-
expected = %()
assert_dom_equal expected, output_buffer
end
+ test "remote_form_for with url" do
+ remote_form_for(@record, {:html => { :id => 'create-author' }}) {}
+ expected = ""
+ assert_dom_equal expected, output_buffer
+ end
+
test "remote_form_for with record identification without html options" do
remote_form_for(@record) {}
-
expected = %()
assert_dom_equal expected, output_buffer
end
@@ -236,7 +306,8 @@ class AjaxHelperTest < AjaxHelperBaseTest
assert_dom_equal expected, output_buffer
end
- test "remote_form_for with new object in list" do
+ test "remote_form_for with new nested object and an excisting parent" do
+ @author.save
remote_form_for([@author, @article]) {}
expected = %()
@@ -246,94 +317,119 @@ class AjaxHelperTest < AjaxHelperBaseTest
test "remote_form_for with existing object in list" do
@author.save
@article.save
+
remote_form_for([@author, @article]) {}
- expected = %()
+ expected = %()
assert_dom_equal expected, output_buffer
end
test "on callbacks" do
callbacks = [:uninitialized, :loading, :loaded, :interactive, :complete, :success, :failure]
callbacks.each do |callback|
- assert_dom_equal %(