mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Removed all helpers from PrototypeHelper that are implemented in AjaxHelper. Modified tests that extended with PrototypeHelper to now extend using AjaxHelper. AjaxHelper is now included by default in view helper
This commit is contained in:
parent
5462caf434
commit
565a696e71
5 changed files with 10 additions and 646 deletions
|
@ -15,7 +15,7 @@ module ActionView #:nodoc:
|
|||
autoload :FormTagHelper, 'action_view/helpers/form_tag_helper'
|
||||
autoload :JavaScriptHelper, 'action_view/helpers/javascript_helper'
|
||||
autoload :NumberHelper, 'action_view/helpers/number_helper'
|
||||
autoload :PrototypeHelper, 'action_view/helpers/prototype_helper'
|
||||
autoload :AjaxHelper, 'action_view/helpers/ajax_helper'
|
||||
autoload :RawOutputHelper, 'action_view/helpers/raw_output_helper'
|
||||
autoload :RecordIdentificationHelper, 'action_view/helpers/record_identification_helper'
|
||||
autoload :RecordTagHelper, 'action_view/helpers/record_tag_helper'
|
||||
|
@ -48,7 +48,7 @@ module ActionView #:nodoc:
|
|||
include FormTagHelper
|
||||
include JavaScriptHelper
|
||||
include NumberHelper
|
||||
include PrototypeHelper
|
||||
include AjaxHelper
|
||||
include RawOutputHelper
|
||||
include RecordIdentificationHelper
|
||||
include RecordTagHelper
|
||||
|
|
|
@ -1,7 +1,9 @@
|
|||
module ActionView
|
||||
module Helpers
|
||||
module AjaxHelper
|
||||
include PrototypeHelper
|
||||
# Included for backwards compatibility / RJS functionality
|
||||
# Rails classes should not be aware of individual JS frameworks
|
||||
include PrototypeHelper
|
||||
|
||||
def remote_form_for(record_or_name_or_array, *args, &proc)
|
||||
options = args.extract_options!
|
||||
|
@ -19,6 +21,7 @@ module ActionView
|
|||
attributes.merge!(options)
|
||||
|
||||
url = attributes.delete("data-url")
|
||||
attributes.delete(:builder)
|
||||
form_tag(attributes.delete(:action) || url, attributes, &block)
|
||||
end
|
||||
|
||||
|
|
|
@ -27,40 +27,6 @@ module ActionView
|
|||
# ActionView::Helpers::JavaScriptHelper for more information on including
|
||||
# this and other JavaScript files in your Rails templates.)
|
||||
#
|
||||
# Now you're ready to call a remote action either through a link...
|
||||
#
|
||||
# link_to_remote "Add to cart",
|
||||
# :url => { :action => "add", :id => product.id },
|
||||
# :update => { :success => "cart", :failure => "error" }
|
||||
#
|
||||
# ...through a form...
|
||||
#
|
||||
# <% form_remote_tag :url => '/shipping' do -%>
|
||||
# <div><%= submit_tag 'Recalculate Shipping' %></div>
|
||||
# <% end -%>
|
||||
#
|
||||
# ...periodically...
|
||||
#
|
||||
# periodically_call_remote(:url => 'update', :frequency => '5', :update => 'ticker')
|
||||
#
|
||||
# ...or through an observer (i.e., a form or field that is observed and calls a remote
|
||||
# action when changed).
|
||||
#
|
||||
# <%= observe_field(:searchbox,
|
||||
# :url => { :action => :live_search }),
|
||||
# :frequency => 0.5,
|
||||
# :update => :hits,
|
||||
# :with => 'query'
|
||||
# %>
|
||||
#
|
||||
# As you can see, there are numerous ways to use Prototype's Ajax functions (and actually more than
|
||||
# are listed here); check out the documentation for each method to find out more about its usage and options.
|
||||
#
|
||||
# === Common Options
|
||||
# See link_to_remote for documentation of options common to all Ajax
|
||||
# helpers; any of the options specified by link_to_remote can be used
|
||||
# by the other helpers.
|
||||
#
|
||||
# == Designing your Rails actions for Ajax
|
||||
# When building your action handlers (that is, the Rails actions that receive your background requests), it's
|
||||
# important to remember a few things. First, whatever your action would normally return to the browser, it will
|
||||
|
@ -116,325 +82,6 @@ module ActionView
|
|||
:form, :with, :update, :script, :type ]).merge(CALLBACKS)
|
||||
end
|
||||
|
||||
# Returns a link to a remote action defined by <tt>options[:url]</tt>
|
||||
# (using the url_for format) that's called in the background using
|
||||
# XMLHttpRequest. The result of that request can then be inserted into a
|
||||
# DOM object whose id can be specified with <tt>options[:update]</tt>.
|
||||
# Usually, the result would be a partial prepared by the controller with
|
||||
# render :partial.
|
||||
#
|
||||
# Examples:
|
||||
# # Generates: <a href="#" onclick="new Ajax.Updater('posts', '/blog/destroy/3', {asynchronous:true, evalScripts:true});
|
||||
# # return false;">Delete this post</a>
|
||||
# link_to_remote "Delete this post", :update => "posts",
|
||||
# :url => { :action => "destroy", :id => post.id }
|
||||
#
|
||||
# # Generates: <a href="#" onclick="new Ajax.Updater('emails', '/mail/list_emails', {asynchronous:true, evalScripts:true});
|
||||
# # return false;"><img alt="Refresh" src="/images/refresh.png?" /></a>
|
||||
# link_to_remote(image_tag("refresh"), :update => "emails",
|
||||
# :url => { :action => "list_emails" })
|
||||
#
|
||||
# You can override the generated HTML options by specifying a hash in
|
||||
# <tt>options[:html]</tt>.
|
||||
#
|
||||
# link_to_remote "Delete this post", :update => "posts",
|
||||
# :url => post_url(@post), :method => :delete,
|
||||
# :html => { :class => "destructive" }
|
||||
#
|
||||
# You can also specify a hash for <tt>options[:update]</tt> to allow for
|
||||
# easy redirection of output to an other DOM element if a server-side
|
||||
# error occurs:
|
||||
#
|
||||
# Example:
|
||||
# # Generates: <a href="#" onclick="new Ajax.Updater({success:'posts',failure:'error'}, '/blog/destroy/5',
|
||||
# # {asynchronous:true, evalScripts:true}); return false;">Delete this post</a>
|
||||
# link_to_remote "Delete this post",
|
||||
# :url => { :action => "destroy", :id => post.id },
|
||||
# :update => { :success => "posts", :failure => "error" }
|
||||
#
|
||||
# Optionally, you can use the <tt>options[:position]</tt> parameter to
|
||||
# influence how the target DOM element is updated. It must be one of
|
||||
# <tt>:before</tt>, <tt>:top</tt>, <tt>:bottom</tt>, or <tt>:after</tt>.
|
||||
#
|
||||
# The method used is by default POST. You can also specify GET or you
|
||||
# can simulate PUT or DELETE over POST. All specified with <tt>options[:method]</tt>
|
||||
#
|
||||
# Example:
|
||||
# # Generates: <a href="#" onclick="new Ajax.Request('/person/4', {asynchronous:true, evalScripts:true, method:'delete'});
|
||||
# # return false;">Destroy</a>
|
||||
# link_to_remote "Destroy", :url => person_url(:id => person), :method => :delete
|
||||
#
|
||||
# By default, these remote requests are processed asynchronous during
|
||||
# which various JavaScript callbacks can be triggered (for progress
|
||||
# indicators and the likes). All callbacks get access to the
|
||||
# <tt>request</tt> object, which holds the underlying XMLHttpRequest.
|
||||
#
|
||||
# To access the server response, use <tt>request.responseText</tt>, to
|
||||
# find out the HTTP status, use <tt>request.status</tt>.
|
||||
#
|
||||
# Example:
|
||||
# # Generates: <a href="#" onclick="new Ajax.Request('/words/undo?n=33', {asynchronous:true, evalScripts:true,
|
||||
# # onComplete:function(request){undoRequestCompleted(request)}}); return false;">hello</a>
|
||||
# word = 'hello'
|
||||
# link_to_remote word,
|
||||
# :url => { :action => "undo", :n => word_counter },
|
||||
# :complete => "undoRequestCompleted(request)"
|
||||
#
|
||||
# The callbacks that may be specified are (in order):
|
||||
#
|
||||
# <tt>:loading</tt>:: Called when the remote document is being
|
||||
# loaded with data by the browser.
|
||||
# <tt>:loaded</tt>:: Called when the browser has finished loading
|
||||
# the remote document.
|
||||
# <tt>:interactive</tt>:: Called when the user can interact with the
|
||||
# remote document, even though it has not
|
||||
# finished loading.
|
||||
# <tt>:success</tt>:: Called when the XMLHttpRequest is completed,
|
||||
# and the HTTP status code is in the 2XX range.
|
||||
# <tt>:failure</tt>:: Called when the XMLHttpRequest is completed,
|
||||
# and the HTTP status code is not in the 2XX
|
||||
# range.
|
||||
# <tt>:complete</tt>:: Called when the XMLHttpRequest is complete
|
||||
# (fires after success/failure if they are
|
||||
# present).
|
||||
#
|
||||
# You can further refine <tt>:success</tt> and <tt>:failure</tt> by
|
||||
# adding additional callbacks for specific status codes.
|
||||
#
|
||||
# Example:
|
||||
# # Generates: <a href="#" onclick="new Ajax.Request('/testing/action', {asynchronous:true, evalScripts:true,
|
||||
# # on404:function(request){alert('Not found...? Wrong URL...?')},
|
||||
# # onFailure:function(request){alert('HTTP Error ' + request.status + '!')}}); return false;">hello</a>
|
||||
# link_to_remote word,
|
||||
# :url => { :action => "action" },
|
||||
# 404 => "alert('Not found...? Wrong URL...?')",
|
||||
# :failure => "alert('HTTP Error ' + request.status + '!')"
|
||||
#
|
||||
# A status code callback overrides the success/failure handlers if
|
||||
# present.
|
||||
#
|
||||
# If you for some reason or another need synchronous processing (that'll
|
||||
# block the browser while the request is happening), you can specify
|
||||
# <tt>options[:type] = :synchronous</tt>.
|
||||
#
|
||||
# You can customize further browser side call logic by passing in
|
||||
# JavaScript code snippets via some optional parameters. In their order
|
||||
# of use these are:
|
||||
#
|
||||
# <tt>:confirm</tt>:: Adds confirmation dialog.
|
||||
# <tt>:condition</tt>:: Perform remote request conditionally
|
||||
# by this expression. Use this to
|
||||
# describe browser-side conditions when
|
||||
# request should not be initiated.
|
||||
# <tt>:before</tt>:: Called before request is initiated.
|
||||
# <tt>:after</tt>:: Called immediately after request was
|
||||
# initiated and before <tt>:loading</tt>.
|
||||
# <tt>:submit</tt>:: Specifies the DOM element ID that's used
|
||||
# as the parent of the form elements. By
|
||||
# default this is the current form, but
|
||||
# it could just as well be the ID of a
|
||||
# table row or any other DOM element.
|
||||
# <tt>:with</tt>:: A JavaScript expression specifying
|
||||
# the parameters for the XMLHttpRequest.
|
||||
# Any expressions should return a valid
|
||||
# URL query string.
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# :with => "'name=' + $('name').value"
|
||||
#
|
||||
# You can generate a link that uses AJAX in the general case, while
|
||||
# degrading gracefully to plain link behavior in the absence of
|
||||
# JavaScript by setting <tt>html_options[:href]</tt> to an alternate URL.
|
||||
# Note the extra curly braces around the <tt>options</tt> hash separate
|
||||
# it as the second parameter from <tt>html_options</tt>, the third.
|
||||
#
|
||||
# Example:
|
||||
# link_to_remote "Delete this post",
|
||||
# { :update => "posts", :url => { :action => "destroy", :id => post.id } },
|
||||
# :href => url_for(:action => "destroy", :id => post.id)
|
||||
def link_to_remote(name, options = {}, html_options = nil)
|
||||
link_to_function(name, remote_function(options), html_options || options.delete(:html))
|
||||
end
|
||||
|
||||
# Creates a button with an onclick event which calls a remote action
|
||||
# via XMLHttpRequest
|
||||
# The options for specifying the target with :url
|
||||
# and defining callbacks is the same as link_to_remote.
|
||||
def button_to_remote(name, options = {}, html_options = {})
|
||||
button_to_function(name, remote_function(options), html_options)
|
||||
end
|
||||
|
||||
# Periodically calls the specified url (<tt>options[:url]</tt>) every
|
||||
# <tt>options[:frequency]</tt> seconds (default is 10). Usually used to
|
||||
# update a specified div (<tt>options[:update]</tt>) with the results
|
||||
# of the remote call. The options for specifying the target with <tt>:url</tt>
|
||||
# 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 },
|
||||
# :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 = {})
|
||||
frequency = options[:frequency] || 10 # every ten seconds by default
|
||||
code = "new PeriodicalExecuter(function() {#{remote_function(options)}}, #{frequency})"
|
||||
javascript_tag(code)
|
||||
end
|
||||
|
||||
# Returns a form tag that will submit using XMLHttpRequest in the
|
||||
# background instead of the regular reloading 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 <tt>params</tt>). The options for
|
||||
# specifying the target with <tt>:url</tt> 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 <tt>:action</tt>/<tt>:method</tt> options on <tt>:html</tt>.
|
||||
#
|
||||
# Example:
|
||||
# # Generates:
|
||||
# # <form action="/some/place" method="post" onsubmit="new Ajax.Request('',
|
||||
# # {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;">
|
||||
# form_remote_tag :html => { :action =>
|
||||
# url_for(:controller => "some", :action => "place") }
|
||||
#
|
||||
# The Hash passed to the <tt>:html</tt> key is equivalent to the options (2nd)
|
||||
# argument in the FormTagHelper.form_tag method.
|
||||
#
|
||||
# By default the fall-through action is the same as the one specified in
|
||||
# the <tt>:url</tt> (and the default method is <tt>:post</tt>).
|
||||
#
|
||||
# form_remote_tag also takes a block, like form_tag:
|
||||
# # Generates:
|
||||
# # <form action="/" method="post" onsubmit="new Ajax.Request('/',
|
||||
# # {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)});
|
||||
# # return false;"> <div><input name="commit" type="submit" value="Save" /></div>
|
||||
# # </form>
|
||||
# <% form_remote_tag :url => '/posts' do -%>
|
||||
# <div><%= submit_tag 'Save' %></div>
|
||||
# <% end -%>
|
||||
def form_remote_tag(options = {}, &block)
|
||||
options[:form] = true
|
||||
|
||||
options[:html] ||= {}
|
||||
options[:html][:onsubmit] =
|
||||
(options[:html][:onsubmit] ? options[:html][:onsubmit] + "; " : "") +
|
||||
"#{remote_function(options)}; return false;"
|
||||
|
||||
form_tag(options[:html].delete(:action) || url_for(options[:url]), options[:html], &block)
|
||||
end
|
||||
|
||||
# Creates a form that will submit using XMLHttpRequest in the background
|
||||
# instead of the regular reloading POST arrangement and a scope around a
|
||||
# specific resource that is used as a base for questioning about
|
||||
# values for the fields.
|
||||
#
|
||||
# === Resource
|
||||
#
|
||||
# Example:
|
||||
# <% remote_form_for(@post) do |f| %>
|
||||
# ...
|
||||
# <% end %>
|
||||
#
|
||||
# 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| %>
|
||||
# ...
|
||||
# <% end %>
|
||||
#
|
||||
# === Nested Resource
|
||||
#
|
||||
# Example:
|
||||
# <% remote_form_for([@post, @comment]) do |f| %>
|
||||
# ...
|
||||
# <% end %>
|
||||
#
|
||||
# This will expand to be the same as:
|
||||
#
|
||||
# <% remote_form_for :comment, @comment, :url => post_comment_path(@post, @comment), :html => { :method => :put, :class => "edit_comment", :id => "edit_comment_45" } do |f| %>
|
||||
# ...
|
||||
# <% end %>
|
||||
#
|
||||
# If you don't need to attach a form to a resource, then check out form_remote_tag.
|
||||
#
|
||||
# See FormHelper#form_for for additional semantics.
|
||||
def remote_form_for(record_or_name_or_array, *args, &proc)
|
||||
options = args.extract_options!
|
||||
|
||||
case record_or_name_or_array
|
||||
when String, Symbol
|
||||
object_name = record_or_name_or_array
|
||||
when Array
|
||||
object = record_or_name_or_array.last
|
||||
object_name = ActionController::RecordIdentifier.singular_class_name(object)
|
||||
apply_form_for_options!(record_or_name_or_array, options)
|
||||
args.unshift object
|
||||
else
|
||||
object = record_or_name_or_array
|
||||
object_name = ActionController::RecordIdentifier.singular_class_name(record_or_name_or_array)
|
||||
apply_form_for_options!(object, options)
|
||||
args.unshift object
|
||||
end
|
||||
|
||||
concat(form_remote_tag(options))
|
||||
fields_for(object_name, *(args << options), &proc)
|
||||
concat('</form>'.html_safe!)
|
||||
end
|
||||
alias_method :form_remote_for, :remote_form_for
|
||||
|
||||
# Returns a button input tag with the element name of +name+ and a value (i.e., display text) of +value+
|
||||
# that will submit form using XMLHttpRequest in the background instead of a regular POST request that
|
||||
# reloads the page.
|
||||
#
|
||||
# # Create a button that submits to the create action
|
||||
# #
|
||||
# # Generates: <input name="create_btn" onclick="new Ajax.Request('/testing/create',
|
||||
# # {asynchronous:true, evalScripts:true, parameters:Form.serialize(this.form)});
|
||||
# # return false;" type="button" value="Create" />
|
||||
# <%= submit_to_remote 'create_btn', 'Create', :url => { :action => 'create' } %>
|
||||
#
|
||||
# # Submit to the remote action update and update the DIV succeed or fail based
|
||||
# # on the success or failure of the request
|
||||
# #
|
||||
# # Generates: <input name="update_btn" onclick="new Ajax.Updater({success:'succeed',failure:'fail'},
|
||||
# # '/testing/update', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this.form)});
|
||||
# # return false;" type="button" value="Update" />
|
||||
# <%= submit_to_remote 'update_btn', 'Update', :url => { :action => 'update' },
|
||||
# :update => { :success => "succeed", :failure => "fail" }
|
||||
#
|
||||
# <tt>options</tt> argument is the same as in form_remote_tag.
|
||||
def submit_to_remote(name, value, options = {})
|
||||
options[:with] ||= 'Form.serialize(this.form)'
|
||||
|
||||
html_options = options.delete(:html) || {}
|
||||
html_options[:name] = name
|
||||
|
||||
button_to_remote(value, options, html_options)
|
||||
end
|
||||
|
||||
# Returns '<tt>eval(request.responseText)</tt>' which is the JavaScript function
|
||||
# that +form_remote_tag+ can call in <tt>:complete</tt> to evaluate a multiple
|
||||
# update return document using +update_element_function+ calls.
|
||||
def evaluate_remote_response
|
||||
"eval(request.responseText)"
|
||||
end
|
||||
|
||||
# Returns the JavaScript needed for a remote function.
|
||||
# Takes the same arguments as link_to_remote.
|
||||
#
|
||||
|
@ -476,99 +123,6 @@ module ActionView
|
|||
return function
|
||||
end
|
||||
|
||||
# Observes the field with the DOM ID specified by +field_id+ and calls a
|
||||
# callback when its contents have changed. The default callback is an
|
||||
# Ajax call. By default the value of the observed field is sent as a
|
||||
# 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})})
|
||||
# <%= observe_field :suggest, :url => { :action => :find_suggestion },
|
||||
# :frequency => 0.25,
|
||||
# :update => :suggest,
|
||||
# :with => 'q'
|
||||
# %>
|
||||
#
|
||||
# Required +options+ are either of:
|
||||
# <tt>:url</tt>:: +url_for+-style options for the action to call
|
||||
# when the field has changed.
|
||||
# <tt>:function</tt>:: Instead of making a remote call to a URL, you
|
||||
# can specify javascript code to be called instead.
|
||||
# Note that the value of this option is used as the
|
||||
# *body* of the javascript function, a function definition
|
||||
# with parameters named element and value will be generated for you
|
||||
# for example:
|
||||
# observe_field("glass", :frequency => 1, :function => "alert('Element changed')")
|
||||
# will generate:
|
||||
# new Form.Element.Observer('glass', 1, function(element, value) {alert('Element changed')})
|
||||
# The element parameter is the DOM element being observed, and the value is its value at the
|
||||
# time the observer is triggered.
|
||||
#
|
||||
# Additional options are:
|
||||
# <tt>:frequency</tt>:: The frequency (in seconds) at which changes to
|
||||
# this field will be detected. Not setting this
|
||||
# option at all or to a value equal to or less than
|
||||
# zero will use event based observation instead of
|
||||
# time based observation.
|
||||
# <tt>:update</tt>:: Specifies the DOM ID of the element whose
|
||||
# innerHTML should be updated with the
|
||||
# XMLHttpRequest response text.
|
||||
# <tt>:with</tt>:: A JavaScript expression specifying the parameters
|
||||
# for the XMLHttpRequest. The default is to send the
|
||||
# key and value of the observed field. Any custom
|
||||
# expressions should return a valid URL query string.
|
||||
# The value of the field is stored in the JavaScript
|
||||
# variable +value+.
|
||||
#
|
||||
# Examples
|
||||
#
|
||||
# :with => "'my_custom_key=' + value"
|
||||
# :with => "'person[name]=' + prompt('New name')"
|
||||
# :with => "Form.Element.serialize('other-field')"
|
||||
#
|
||||
# Finally
|
||||
# :with => 'name'
|
||||
# is shorthand for
|
||||
# :with => "'name=' + value"
|
||||
# This essentially just changes the key of the parameter.
|
||||
#
|
||||
# Additionally, you may specify any of the options documented in the
|
||||
# <em>Common options</em> section at the top of this document.
|
||||
#
|
||||
# Example:
|
||||
#
|
||||
# # Sends params: {:title => 'Title of the book'} when the book_title input
|
||||
# # field is changed.
|
||||
# observe_field 'book_title',
|
||||
# :url => 'http://example.com/books/edit/1',
|
||||
# :with => 'title'
|
||||
#
|
||||
#
|
||||
def observe_field(field_id, options = {})
|
||||
if options[:frequency] && options[:frequency] > 0
|
||||
build_observer('Form.Element.Observer', field_id, options)
|
||||
else
|
||||
build_observer('Form.Element.EventObserver', field_id, options)
|
||||
end
|
||||
end
|
||||
|
||||
# Observes the form with the DOM ID specified by +form_id+ and calls a
|
||||
# callback when its contents have changed. The default callback is an
|
||||
# Ajax call. By default all fields of the observed field are sent as
|
||||
# parameters with the Ajax call.
|
||||
#
|
||||
# The +options+ for +observe_form+ are the same as the options for
|
||||
# +observe_field+. The JavaScript variable +value+ available to the
|
||||
# <tt>:with</tt> option is set to the serialized form by default.
|
||||
def observe_form(form_id, options = {})
|
||||
if options[:frequency]
|
||||
build_observer('Form.Observer', form_id, options)
|
||||
else
|
||||
build_observer('Form.EventObserver', form_id, options)
|
||||
end
|
||||
end
|
||||
|
||||
# All the methods were moved to GeneratorMethods so that
|
||||
# #include_helpers_from_context has nothing to overwrite.
|
||||
class JavaScriptGenerator #:nodoc:
|
||||
|
|
|
@ -1232,7 +1232,7 @@ class FormHelperTest < ActionView::TestCase
|
|||
|
||||
# Perhaps this test should be moved to prototype helper tests.
|
||||
def test_remote_form_for_with_labelled_builder
|
||||
self.extend ActionView::Helpers::PrototypeHelper
|
||||
self.extend ActionView::Helpers::AjaxHelper
|
||||
|
||||
remote_form_for(:post, @post, :builder => LabelledFormBuilder) do |f|
|
||||
concat f.text_field(:title)
|
||||
|
@ -1241,7 +1241,7 @@ class FormHelperTest < ActionView::TestCase
|
|||
end
|
||||
|
||||
expected =
|
||||
%(<form action="http://www.example.com" onsubmit="new Ajax.Request('http://www.example.com', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;" method="post">) +
|
||||
%(<form action="http://www.example.com" data-remote="true" method="post">) +
|
||||
"<label for='title'>Title:</label> <input name='post[title]' size='30' type='text' id='post_title' value='Hello World' /><br/>" +
|
||||
"<label for='body'>Body:</label> <textarea name='post[body]' id='post_body' rows='20' cols='40'>Back to the hill and over it again!</textarea><br/>" +
|
||||
"<label for='secret'>Secret:</label> <input name='post[secret]' type='hidden' value='0' /><input name='post[secret]' checked='checked' type='checkbox' id='post_secret' value='1' /><br/>" +
|
||||
|
@ -1397,10 +1397,10 @@ class FormHelperTest < ActionView::TestCase
|
|||
end
|
||||
|
||||
def test_remote_form_for_with_html_options_adds_options_to_form_tag
|
||||
self.extend ActionView::Helpers::PrototypeHelper
|
||||
self.extend ActionView::Helpers::AjaxHelper
|
||||
|
||||
remote_form_for(:post, @post, :html => {:id => 'some_form', :class => 'some_class'}) do |f| end
|
||||
expected = "<form action=\"http://www.example.com\" class=\"some_class\" id=\"some_form\" method=\"post\" onsubmit=\"new Ajax.Request('http://www.example.com', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;\"></form>"
|
||||
expected = "<form action=\"http://www.example.com\" class=\"some_class\" id=\"some_form\" method=\"post\" data-remote=\"true\"></form>"
|
||||
|
||||
assert_dom_equal expected, output_buffer
|
||||
end
|
||||
|
|
|
@ -82,199 +82,6 @@ class PrototypeHelperTest < PrototypeHelperBaseTest
|
|||
super
|
||||
end
|
||||
|
||||
def test_link_to_remote
|
||||
assert_dom_equal %(<a class=\"fine\" href=\"#\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:true, evalScripts:true}); return false;\">Remote outauthor</a>),
|
||||
link_to_remote("Remote outauthor", { :url => { :action => "whatnot" }}, { :class => "fine" })
|
||||
assert_dom_equal %(<a href=\"#\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:true, evalScripts:true, onComplete:function(request){alert(request.responseText)}}); return false;\">Remote outauthor</a>),
|
||||
link_to_remote("Remote outauthor", :complete => "alert(request.responseText)", :url => { :action => "whatnot" })
|
||||
assert_dom_equal %(<a href=\"#\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:true, evalScripts:true, onSuccess:function(request){alert(request.responseText)}}); return false;\">Remote outauthor</a>),
|
||||
link_to_remote("Remote outauthor", :success => "alert(request.responseText)", :url => { :action => "whatnot" })
|
||||
assert_dom_equal %(<a href=\"#\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:true, evalScripts:true, onFailure:function(request){alert(request.responseText)}}); return false;\">Remote outauthor</a>),
|
||||
link_to_remote("Remote outauthor", :failure => "alert(request.responseText)", :url => { :action => "whatnot" })
|
||||
assert_dom_equal %(<a href=\"#\" onclick=\"new Ajax.Request('http://www.example.com/whatnot?a=10&b=20', {asynchronous:true, evalScripts:true, onFailure:function(request){alert(request.responseText)}}); return false;\">Remote outauthor</a>),
|
||||
link_to_remote("Remote outauthor", :failure => "alert(request.responseText)", :url => { :action => "whatnot", :a => '10', :b => '20' })
|
||||
assert_dom_equal %(<a href=\"#\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:false, evalScripts:true}); return false;\">Remote outauthor</a>),
|
||||
link_to_remote("Remote outauthor", :url => { :action => "whatnot" }, :type => :synchronous)
|
||||
assert_dom_equal %(<a href=\"#\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:true, evalScripts:true, insertion:'bottom'}); return false;\">Remote outauthor</a>),
|
||||
link_to_remote("Remote outauthor", :url => { :action => "whatnot" }, :position => :bottom)
|
||||
end
|
||||
|
||||
def test_link_to_remote_html_options
|
||||
assert_dom_equal %(<a class=\"fine\" href=\"#\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:true, evalScripts:true}); return false;\">Remote outauthor</a>),
|
||||
link_to_remote("Remote outauthor", { :url => { :action => "whatnot" }, :html => { :class => "fine" } })
|
||||
end
|
||||
|
||||
def test_link_to_remote_url_quote_escaping
|
||||
assert_dom_equal %(<a href="#" onclick="new Ajax.Request('http://www.example.com/whatnot\\\'s', {asynchronous:true, evalScripts:true}); return false;">Remote</a>),
|
||||
link_to_remote("Remote", { :url => { :action => "whatnot's" } })
|
||||
end
|
||||
|
||||
def test_button_to_remote
|
||||
assert_dom_equal %(<input class=\"fine\" type=\"button\" value=\"Remote outpost\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:true, evalScripts:true});\" />),
|
||||
button_to_remote("Remote outpost", { :url => { :action => "whatnot" }}, { :class => "fine" })
|
||||
assert_dom_equal %(<input type=\"button\" value=\"Remote outpost\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:true, evalScripts:true, onComplete:function(request){alert(request.reponseText)}});\" />),
|
||||
button_to_remote("Remote outpost", :complete => "alert(request.reponseText)", :url => { :action => "whatnot" })
|
||||
assert_dom_equal %(<input type=\"button\" value=\"Remote outpost\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:true, evalScripts:true, onSuccess:function(request){alert(request.reponseText)}});\" />),
|
||||
button_to_remote("Remote outpost", :success => "alert(request.reponseText)", :url => { :action => "whatnot" })
|
||||
assert_dom_equal %(<input type=\"button\" value=\"Remote outpost\" onclick=\"new Ajax.Request('http://www.example.com/whatnot', {asynchronous:true, evalScripts:true, onFailure:function(request){alert(request.reponseText)}});\" />),
|
||||
button_to_remote("Remote outpost", :failure => "alert(request.reponseText)", :url => { :action => "whatnot" })
|
||||
assert_dom_equal %(<input type=\"button\" value=\"Remote outpost\" onclick=\"new Ajax.Request('http://www.example.com/whatnot?a=10&b=20', {asynchronous:true, evalScripts:true, onFailure:function(request){alert(request.reponseText)}});\" />),
|
||||
button_to_remote("Remote outpost", :failure => "alert(request.reponseText)", :url => { :action => "whatnot", :a => '10', :b => '20' })
|
||||
end
|
||||
|
||||
def test_periodically_call_remote
|
||||
assert_dom_equal %(<script type="text/javascript">\n//<![CDATA[\nnew PeriodicalExecuter(function() {new Ajax.Updater('schremser_bier', 'http://www.example.com/mehr_bier', {asynchronous:true, evalScripts:true})}, 10)\n//]]>\n</script>),
|
||||
periodically_call_remote(:update => "schremser_bier", :url => { :action => "mehr_bier" })
|
||||
end
|
||||
|
||||
def test_periodically_call_remote_with_frequency
|
||||
assert_dom_equal(
|
||||
"<script type=\"text/javascript\">\n//<![CDATA[\nnew PeriodicalExecuter(function() {new Ajax.Request('http://www.example.com/', {asynchronous:true, evalScripts:true})}, 2)\n//]]>\n</script>",
|
||||
periodically_call_remote(:frequency => 2)
|
||||
)
|
||||
end
|
||||
|
||||
def test_form_remote_tag
|
||||
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;\">),
|
||||
form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast })
|
||||
assert_dom_equal %(<form action=\"http://www.example.com/fast\" method=\"post\" onsubmit=\"new Ajax.Updater({success:'glass_of_beer'}, 'http://www.example.com/fast', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;\">),
|
||||
form_remote_tag(:update => { :success => "glass_of_beer" }, :url => { :action => :fast })
|
||||
assert_dom_equal %(<form action=\"http://www.example.com/fast\" method=\"post\" onsubmit=\"new Ajax.Updater({failure:'glass_of_water'}, 'http://www.example.com/fast', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;\">),
|
||||
form_remote_tag(:update => { :failure => "glass_of_water" }, :url => { :action => :fast })
|
||||
assert_dom_equal %(<form action=\"http://www.example.com/fast\" method=\"post\" onsubmit=\"new Ajax.Updater({success:'glass_of_beer',failure:'glass_of_water'}, 'http://www.example.com/fast', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;\">),
|
||||
form_remote_tag(:update => { :success => 'glass_of_beer', :failure => "glass_of_water" }, :url => { :action => :fast })
|
||||
end
|
||||
|
||||
def test_form_remote_tag_with_method
|
||||
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;\"><div style='margin:0;padding:0;display:inline'><input name='_method' type='hidden' value='put' /></div>),
|
||||
form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }, :html => { :method => :put })
|
||||
end
|
||||
|
||||
def test_form_remote_tag_with_block_in_erb
|
||||
__in_erb_template = ''
|
||||
form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }) { concat "Hello world!" }
|
||||
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>), output_buffer
|
||||
end
|
||||
|
||||
def test_remote_form_for_with_record_identification_with_new_record
|
||||
remote_form_for(@record, {:html => { :id => 'create-author' }}) {}
|
||||
|
||||
expected = %(<form action='#{authors_path}' onsubmit="new Ajax.Request('#{authors_path}', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;" class='new_author' id='create-author' method='post'></form>)
|
||||
assert_dom_equal expected, output_buffer
|
||||
end
|
||||
|
||||
def test_remote_form_for_with_record_identification_without_html_options
|
||||
remote_form_for(@record) {}
|
||||
|
||||
expected = %(<form action='#{authors_path}' onsubmit="new Ajax.Request('#{authors_path}', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;" class='new_author' method='post' id='new_author'></form>)
|
||||
assert_dom_equal expected, output_buffer
|
||||
end
|
||||
|
||||
def test_remote_form_for_with_record_identification_with_existing_record
|
||||
@record.save
|
||||
remote_form_for(@record) {}
|
||||
|
||||
expected = %(<form action='#{author_path(@record)}' id='edit_author_1' method='post' onsubmit="new Ajax.Request('#{author_path(@record)}', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;" class='edit_author'><div style='margin:0;padding:0;display:inline'><input name='_method' type='hidden' value='put' /></div></form>)
|
||||
assert_dom_equal expected, output_buffer
|
||||
end
|
||||
|
||||
def test_remote_form_for_with_new_object_in_list
|
||||
remote_form_for([@author, @article]) {}
|
||||
|
||||
expected = %(<form action='#{author_articles_path(@author)}' onsubmit="new Ajax.Request('#{author_articles_path(@author)}', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;" class='new_article' method='post' id='new_article'></form>)
|
||||
assert_dom_equal expected, output_buffer
|
||||
end
|
||||
|
||||
def test_remote_form_for_with_existing_object_in_list
|
||||
@author.save
|
||||
@article.save
|
||||
remote_form_for([@author, @article]) {}
|
||||
|
||||
expected = %(<form action='#{author_article_path(@author, @article)}' id='edit_article_1' method='post' onsubmit="new Ajax.Request('#{author_article_path(@author, @article)}', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this)}); return false;" class='edit_article'><div style='margin:0;padding:0;display:inline'><input name='_method' type='hidden' value='put' /></div></form>)
|
||||
assert_dom_equal expected, output_buffer
|
||||
end
|
||||
|
||||
def test_on_callbacks
|
||||
callbacks = [:uninitialized, :loading, :loaded, :interactive, :complete, :success, :failure]
|
||||
callbacks.each do |callback|
|
||||
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, on#{callback.to_s.capitalize}:function(request){monkeys();}, parameters:Form.serialize(this)}); return false;">),
|
||||
form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }, callback=>"monkeys();")
|
||||
assert_dom_equal %(<form action=\"http://www.example.com/fast\" method=\"post\" onsubmit=\"new Ajax.Updater({success:'glass_of_beer'}, 'http://www.example.com/fast', {asynchronous:true, evalScripts:true, on#{callback.to_s.capitalize}:function(request){monkeys();}, parameters:Form.serialize(this)}); return false;">),
|
||||
form_remote_tag(:update => { :success => "glass_of_beer" }, :url => { :action => :fast }, callback=>"monkeys();")
|
||||
assert_dom_equal %(<form action=\"http://www.example.com/fast\" method=\"post\" onsubmit=\"new Ajax.Updater({failure:'glass_of_beer'}, 'http://www.example.com/fast', {asynchronous:true, evalScripts:true, on#{callback.to_s.capitalize}:function(request){monkeys();}, parameters:Form.serialize(this)}); return false;">),
|
||||
form_remote_tag(:update => { :failure => "glass_of_beer" }, :url => { :action => :fast }, callback=>"monkeys();")
|
||||
assert_dom_equal %(<form action=\"http://www.example.com/fast\" method=\"post\" onsubmit=\"new Ajax.Updater({success:'glass_of_beer',failure:'glass_of_water'}, 'http://www.example.com/fast', {asynchronous:true, evalScripts:true, on#{callback.to_s.capitalize}:function(request){monkeys();}, parameters:Form.serialize(this)}); return false;">),
|
||||
form_remote_tag(:update => { :success => "glass_of_beer", :failure => "glass_of_water" }, :url => { :action => :fast }, callback=>"monkeys();")
|
||||
end
|
||||
|
||||
#HTTP status codes 200 up to 599 have callbacks
|
||||
#these should work
|
||||
100.upto(599) do |callback|
|
||||
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, on#{callback.to_s.capitalize}:function(request){monkeys();}, parameters:Form.serialize(this)}); return false;">),
|
||||
form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }, callback=>"monkeys();")
|
||||
end
|
||||
|
||||
#test 200 and 404
|
||||
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, on200:function(request){monkeys();}, on404:function(request){bananas();}, parameters:Form.serialize(this)}); return false;">),
|
||||
form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }, 200=>"monkeys();", 404=>"bananas();")
|
||||
|
||||
#these shouldn't
|
||||
1.upto(99) do |callback|
|
||||
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;">),
|
||||
form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }, callback=>"monkeys();")
|
||||
end
|
||||
600.upto(999) do |callback|
|
||||
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;">),
|
||||
form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }, callback=>"monkeys();")
|
||||
end
|
||||
|
||||
#test ultimate combo
|
||||
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, on200:function(request){monkeys();}, on404:function(request){bananas();}, onComplete:function(request){c();}, onFailure:function(request){f();}, onLoading:function(request){c1()}, onSuccess:function(request){s()}, parameters:Form.serialize(this)}); return false;\">),
|
||||
form_remote_tag(:update => "glass_of_beer", :url => { :action => :fast }, :loading => "c1()", :success => "s()", :failure => "f();", :complete => "c();", 200=>"monkeys();", 404=>"bananas();")
|
||||
|
||||
end
|
||||
|
||||
def test_submit_to_remote
|
||||
assert_dom_equal %(<input name=\"More beer!\" onclick=\"new Ajax.Updater('empty_bottle', 'http://www.example.com/', {asynchronous:true, evalScripts:true, parameters:Form.serialize(this.form)});\" type=\"button\" value=\"1000000\" />),
|
||||
submit_to_remote("More beer!", 1_000_000, :update => "empty_bottle")
|
||||
end
|
||||
|
||||
def test_observe_field
|
||||
assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Form.Element.Observer('glass', 300, function(element, value) {new Ajax.Request('http://www.example.com/reorder_if_empty', {asynchronous:true, evalScripts:true, parameters:value})})\n//]]>\n</script>),
|
||||
observe_field("glass", :frequency => 5.minutes, :url => { :action => "reorder_if_empty" })
|
||||
end
|
||||
|
||||
def test_observe_field_using_with_option
|
||||
expected = %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Form.Element.Observer('glass', 300, function(element, value) {new Ajax.Request('http://www.example.com/check_value', {asynchronous:true, evalScripts:true, parameters:'id=' + encodeURIComponent(value)})})\n//]]>\n</script>)
|
||||
assert_dom_equal expected, observe_field("glass", :frequency => 5.minutes, :url => { :action => "check_value" }, :with => 'id')
|
||||
assert_dom_equal expected, observe_field("glass", :frequency => 5.minutes, :url => { :action => "check_value" }, :with => "'id=' + encodeURIComponent(value)")
|
||||
end
|
||||
|
||||
def test_observe_field_using_json_in_with_option
|
||||
expected = %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Form.Element.Observer('glass', 300, function(element, value) {new Ajax.Request('http://www.example.com/check_value', {asynchronous:true, evalScripts:true, parameters:{'id':value}})})\n//]]>\n</script>)
|
||||
assert_dom_equal expected, observe_field("glass", :frequency => 5.minutes, :url => { :action => "check_value" }, :with => "{'id':value}")
|
||||
end
|
||||
|
||||
def test_observe_field_using_function_for_callback
|
||||
assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Form.Element.Observer('glass', 300, function(element, value) {alert('Element changed')})\n//]]>\n</script>),
|
||||
observe_field("glass", :frequency => 5.minutes, :function => "alert('Element changed')")
|
||||
end
|
||||
|
||||
def test_observe_form
|
||||
assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Form.Observer('cart', 2, function(element, value) {new Ajax.Request('http://www.example.com/cart_changed', {asynchronous:true, evalScripts:true, parameters:value})})\n//]]>\n</script>),
|
||||
observe_form("cart", :frequency => 2, :url => { :action => "cart_changed" })
|
||||
end
|
||||
|
||||
def test_observe_form_using_function_for_callback
|
||||
assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Form.Observer('cart', 2, function(element, value) {alert('Form changed')})\n//]]>\n</script>),
|
||||
observe_form("cart", :frequency => 2, :function => "alert('Form changed')")
|
||||
end
|
||||
|
||||
def test_observe_field_without_frequency
|
||||
assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Form.Element.EventObserver('glass', function(element, value) {new Ajax.Request('http://www.example.com/', {asynchronous:true, evalScripts:true, parameters:value})})\n//]]>\n</script>),
|
||||
observe_field("glass")
|
||||
end
|
||||
|
||||
def test_update_page
|
||||
old_output_buffer = output_buffer
|
||||
|
||||
|
|
Loading…
Reference in a new issue