Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Refactored JavaScriptHelper into PrototypeHelper and ScriptaculousHel…

…per. Added PrototypeHelper::JavaScriptGenerator and PrototypeHelper#update_page for easily modifying multiple elements in an Ajax response.

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@3036 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
commit d99ed9bd6a90a01422bee43970930033efdab08d 1 parent fb1efca
@sstephenson sstephenson authored
View
16 actionpack/CHANGELOG
@@ -1,5 +1,21 @@
*SVN*
+* Added PrototypeHelper::JavaScriptGenerator and PrototypeHelper#update_page for easily modifying multiple elements in an Ajax response. [Sam Stephenson] Example:
+
+ update_page do |page|
+ page.insert_html :bottom, 'list', '<li>Last item</li>'
+ page.visual_effect :highlight, 'list'
+ page.hide 'status-indicator', 'cancel-link'
+ end
+
+ generates the following JavaScript:
+
+ new Insertion.Bottom("list", "<li>Last item</li>");
+ new Effect.Highlight("list");
+ ["status-indicator", "cancel-link"].each(Element.hide);
+
+* Refactored JavaScriptHelper into PrototypeHelper and ScriptaculousHelper [Sam Stephenson]
+
* Update to latest script.aculo.us version (as of [3031])
* Updated docs for in_place_editor, fixes a couple bugs and offers extended support for external controls [Justin Palmer]
View
484 actionpack/lib/action_view/helpers/javascript_helper.rb
@@ -2,38 +2,46 @@
module ActionView
module Helpers
- # Provides a set of helpers for calling JavaScript functions and, most importantly, to call remote methods using what has
- # been labelled AJAX[http://www.adaptivepath.com/publications/essays/archives/000385.php]. This means that you can call
- # actions in your controllers without reloading the page, but still update certain parts of it using injections into the
- # DOM. The common use case is having a form that adds a new element to a list without reloading the page.
+ # Provides functionality for working with JavaScript in your views.
+ #
+ # == Ajax, controls and visual effects
+ #
+ # * For information on using Ajax, see
+ # ActionView::Helpers::PrototypeHelper.
+ # * For information on using controls and visual effects, see
+ # ActionView::Helpers::ScriptaculousHelper.
#
- # To be able to use the JavaScript helpers, you must include the Prototype JavaScript Framework and for some functions
- # script.aculo.us (which both come with Rails) on your pages. Choose one of these options:
+ # == Including the JavaScript libraries into your pages
#
- # * Use <tt><%= javascript_include_tag :defaults %></tt> in the HEAD section of your page (recommended):
- # The function will return references to the JavaScript files created by the +rails+ command in your
- # <tt>public/javascripts</tt> directory. Using it is recommended as the browser can then cache the libraries
- # instead of fetching all the functions anew on every request.
- # * Use <tt><%= javascript_include_tag 'prototype' %></tt>: As above, but will only include the Prototype core library,
- # which means you are able to use all basic AJAX functionality. For the script.aculo.us-based JavaScript helpers,
- # like visual effects, autocompletion, drag and drop and so on, you should use the method described above.
- # * Use <tt><%= define_javascript_functions %></tt>: this will copy all the JavaScript support functions within a single
- # script block.
+ # Rails includes the Prototype JavaScript framework and the Scriptaculous
+ # JavaScript controls and visual effects library. If you wish to use
+ # these libraries and their helpers (ActionView::Helpers::PrototypeHelper
+ # and ActionView::Helpers::ScriptaculousHelper), you must do one of the
+ # following:
#
- # For documentation on +javascript_include_tag+ see ActionView::Helpers::AssetTagHelper.
+ # * Use <tt><%= javascript_include_tag :defaults %></tt> in the HEAD
+ # section of your page (recommended): This function will return
+ # references to the JavaScript files created by the +rails+ command in
+ # your <tt>public/javascripts</tt> directory. Using it is recommended as
+ # the browser can then cache the libraries instead of fetching all the
+ # functions anew on every request.
+ # * Use <tt><%= javascript_include_tag 'prototype' %></tt>: As above, but
+ # will only include the Prototype core library, which means you are able
+ # to use all basic AJAX functionality. For the Scriptaculous-based
+ # JavaScript helpers, like visual effects, autocompletion, drag and drop
+ # and so on, you should use the method described above.
+ # * Use <tt><%= define_javascript_functions %></tt>: this will copy all the
+ # JavaScript support functions within a single script block. Not
+ # recommended.
#
- # If you're the visual type, there's an AJAX movie[http://www.rubyonrails.com/media/video/rails-ajax.mov] demonstrating
- # the use of form_remote_tag.
- module JavaScriptHelper
- unless const_defined? :CALLBACKS
- CALLBACKS =
- [:uninitialized, :loading, :loaded, :interactive, :complete, :failure, :success].push((100..599).to_a).flatten
- AJAX_OPTIONS = [ :before, :after, :condition, :url, :asynchronous, :method,
- :insertion, :position, :form, :with, :update, :script ].concat(CALLBACKS)
+ # For documentation on +javascript_include_tag+ see
+ # ActionView::Helpers::AssetTagHelper.
+ module JavaScriptHelper
+ unless const_defined? :JAVASCRIPT_PATH
JAVASCRIPT_PATH = File.join(File.dirname(__FILE__), 'javascripts')
end
- # Returns a link that'll trigger a javascript +function+ using the
+ # Returns a link that'll trigger a JavaScript +function+ using the
# onclick handler and return false after the fact.
#
# Examples:
@@ -46,251 +54,10 @@ def link_to_function(name, function, html_options = {})
)
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
- # either render_partial or render_partial_collection.
- #
- # Examples:
- # link_to_remote "Delete this post", :update => "posts", :url => { :action => "destroy", :id => post.id }
- # link_to_remote(image_tag("refresh"), :update => "emails", :url => { :action => "list_emails" })
- #
- # 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:
- # 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>.
- #
- # 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:
- # 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:
- # 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.
- def link_to_remote(name, options = {}, html_options = {})
- link_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 :url and defining callbacks is the same as link_to_remote.
- 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 @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
- #
- # form_remote_tag :html => { :action => url_for(:controller => "some", :action => "place") }
- # The Hash passed to the :html 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 :url (and the default method is :post).
- def form_remote_tag(options = {})
- options[:form] = true
-
- options[:html] ||= {}
- options[:html][:onsubmit] = "#{remote_function(options)}; return false;"
- options[:html][:action] = options[:html][:action] || url_for(options[:url])
- options[:html][:method] = options[:html][:method] || "post"
-
- tag("form", options[:html], true)
- end
-
- # Returns a button input tag that will submit form using XMLHttpRequest in the background instead of regular
- # reloading POST arrangement. <tt>options</tt> argument is the same as in <tt>form_remote_tag</tt>
- def submit_to_remote(name, value, options = {})
- options[:with] ||= 'Form.serialize(this.form)'
-
- options[:html] ||= {}
- options[:html][:type] = 'button'
- options[:html][:onclick] = "#{remote_function(options)}; return false;"
- options[:html][:name] = name
- options[:html][:value] = value
-
- tag("input", options[:html], false)
- end
-
- # Returns a Javascript function (or expression) that'll update a DOM element according to the options passed.
- #
- # * <tt>:content</tt>: The content to use for updating. Can be left out if using block, see example.
- # * <tt>:action</tt>: Valid options are :update (assumed by default), :empty, :remove
- # * <tt>:position</tt> If the :action is :update, you can optionally specify one of the following positions: :before, :top, :bottom, :after.
- #
- # Examples:
- # <%= javascript_tag(update_element_function(
- # "products", :position => :bottom, :content => "<p>New product!</p>")) %>
- #
- # <% replacement_function = update_element_function("products") do %>
- # <p>Product 1</p>
- # <p>Product 2</p>
- # <% end %>
- # <%= javascript_tag(replacement_function) %>
- #
- # This method can also be used in combination with remote method call where the result is evaluated afterwards to cause
- # multiple updates on a page. Example:
- #
- # # Calling view
- # <%= form_remote_tag :url => { :action => "buy" }, :complete => evaluate_remote_response %>
- # all the inputs here...
- #
- # # Controller action
- # def buy
- # @product = Product.find(1)
- # end
- #
- # # Returning view
- # <%= update_element_function(
- # "cart", :action => :update, :position => :bottom,
- # :content => "<p>New Product: #{@product.name}</p>")) %>
- # <% update_element_function("status", :binding => binding) do %>
- # You've bought a new product!
- # <% end %>
- #
- # Notice how the second call doesn't need to be in an ERb output block since it uses a block and passes in the binding
- # to render directly. This trick will however only work in ERb (not Builder or other template forms).
- def update_element_function(element_id, options = {}, &block)
-
- content = escape_javascript(options[:content] || '')
- content = escape_javascript(capture(&block)) if block
-
- javascript_function = case (options[:action] || :update)
- when :update
- if options[:position]
- "new Insertion.#{options[:position].to_s.camelize}('#{element_id}','#{content}')"
- else
- "$('#{element_id}').innerHTML = '#{content}'"
- end
-
- when :empty
- "$('#{element_id}').innerHTML = ''"
-
- when :remove
- "Element.remove('#{element_id}')"
-
- else
- raise ArgumentError, "Invalid action, choose one of :update, :remove, :empty"
- end
-
- javascript_function << ";\n"
- options[:binding] ? concat(javascript_function, options[:binding]) : javascript_function
- end
-
- # Returns 'eval(request.responseText)' which is the Javascript function that form_remote_tag can call in :complete 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.
- #
- # Example:
- # <select id="options" onchange="<%= remote_function(:update => "options", :url => { :action => :update_options }) %>">
- # <option value="0">Hello</option>
- # <option value="1">World</option>
- # </select>
- def remote_function(options)
- javascript_options = options_for_ajax(options)
-
- update = ''
- if options[:update] and options[:update].is_a?Hash
- update = []
- update << "success:'#{options[:update][:success]}'" if options[:update][:success]
- update << "failure:'#{options[:update][:failure]}'" if options[:update][:failure]
- update = '{' + update.join(',') + '}'
- elsif options[:update]
- update << "'#{options[:update]}'"
- end
-
- function = update.empty? ?
- "new Ajax.Request(" :
- "new Ajax.Updater(#{update}, "
-
- function << "'#{url_for(options[:url])}'"
- function << ", #{javascript_options})"
-
- function = "#{options[:before]}; #{function}" if options[:before]
- function = "#{function}; #{options[:after]}" if options[:after]
- function = "if (#{options[:condition]}) { #{function}; }" if options[:condition]
- function = "if (confirm('#{escape_javascript(options[:confirm])}')) { #{function}; }" if options[:confirm]
-
- return function
- end
-
# Includes the Action Pack JavaScript libraries inside a single <script>
# tag. The function first includes prototype.js and then its core extensions,
# (determined by filenames starting with "prototype").
- # Afterwards, any additional scripts will be included in random order.
+ # Afterwards, any additional scripts will be included in undefined order.
#
# Note: The recommended approach is to copy the contents of
# lib/action_view/helpers/javascripts/ into your application's
@@ -312,142 +79,6 @@ def define_javascript_functions
javascript << '</script>'
end
- # Observes the field with the DOM ID specified by +field_id+ and makes
- # an AJAX call when its contents have changed.
- #
- # Required +options+ are:
- # <tt>:url</tt>:: +url_for+-style options for the action to call
- # when the field has changed.
- #
- # 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. This defaults
- # to 'value', which in the evaluated context
- # refers to the new field value.
- #
- # Additionally, you may specify any of the options documented in
- # link_to_remote.
- def observe_field(field_id, options = {})
- if options[:frequency] and options[:frequency] > 0
- build_observer('Form.Element.Observer', field_id, options)
- else
- build_observer('Form.Element.EventObserver', field_id, options)
- end
- end
-
- # Like +observe_field+, but operates on an entire form identified by the
- # DOM ID +form_id+. +options+ are the same as +observe_field+, except
- # the default value of the <tt>:with</tt> option evaluates to the
- # serialized (request string) value of the form.
- 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
-
- # Returns a JavaScript snippet to be used on the AJAX callbacks for starting
- # visual effects.
- #
- # This method requires the inclusion of the script.aculo.us JavaScript library.
- #
- # Example:
- # <%= link_to_remote "Reload", :update => "posts",
- # :url => { :action => "reload" },
- # :complete => visual_effect(:highlight, "posts", :duration => 0.5 )
- #
- # If no element_id is given, it assumes "element" which should be a local
- # variable in the generated JavaScript execution context. This can be used
- # for example with drop_receiving_element:
- #
- # <%= drop_receving_element (...), :loading => visual_effect(:fade) %>
- #
- # This would fade the element that was dropped on the drop receiving element.
- #
- # You can change the behaviour with various options, see
- # http://script.aculo.us for more documentation.
- def visual_effect(name, element_id = false, js_options = {})
- element = element_id ? "'#{element_id}'" : "element"
- js_options[:queue] = "'#{js_options[:queue]}'" if js_options[:queue]
- "new Effect.#{name.to_s.camelize}(#{element},#{options_for_javascript(js_options)});"
- end
-
- # Makes the element with the DOM ID specified by +element_id+ sortable
- # by drag-and-drop and make an AJAX call whenever the sort order has
- # changed. By default, the action called gets the serialized sortable
- # element as parameters.
- #
- # This method requires the inclusion of the script.aculo.us JavaScript library.
- #
- # Example:
- # <%= sortable_element("my_list", :url => { :action => "order" }) %>
- #
- # In the example, the action gets a "my_list" array parameter
- # containing the values of the ids of elements the sortable consists
- # of, in the current order.
- #
- # You can change the behaviour with various options, see
- # http://script.aculo.us for more documentation.
- def sortable_element(element_id, options = {})
- options[:with] ||= "Sortable.serialize('#{element_id}')"
- options[:onUpdate] ||= "function(){" + remote_function(options) + "}"
- options.delete_if { |key, value| AJAX_OPTIONS.include?(key) }
-
- [:tag, :overlap, :constraint, :handle].each do |option|
- options[option] = "'#{options[option]}'" if options[option]
- end
-
- options[:containment] = array_or_string_for_javascript(options[:containment]) if options[:containment]
- options[:only] = array_or_string_for_javascript(options[:only]) if options[:only]
-
- javascript_tag("Sortable.create('#{element_id}', #{options_for_javascript(options)})")
- end
-
- # Makes the element with the DOM ID specified by +element_id+ draggable.
- #
- # This method requires the inclusion of the script.aculo.us JavaScript library.
- #
- # Example:
- # <%= draggable_element("my_image", :revert => true)
- #
- # You can change the behaviour with various options, see
- # http://script.aculo.us for more documentation.
- def draggable_element(element_id, options = {})
- javascript_tag("new Draggable('#{element_id}', #{options_for_javascript(options)})")
- end
-
- # Makes the element with the DOM ID specified by +element_id+ receive
- # dropped draggable elements (created by draggable_element).
- # and make an AJAX call By default, the action called gets the DOM ID of the
- # element as parameter.
- #
- # This method requires the inclusion of the script.aculo.us JavaScript library.
- #
- # Example:
- # <%= drop_receiving_element("my_cart", :url => { :controller => "cart", :action => "add" }) %>
- #
- # You can change the behaviour with various options, see
- # http://script.aculo.us for more documentation.
- def drop_receiving_element(element_id, options = {})
- options[:with] ||= "'id=' + encodeURIComponent(element.id)"
- options[:onDrop] ||= "function(element){" + remote_function(options) + "}"
- options.delete_if { |key, value| AJAX_OPTIONS.include?(key) }
-
- options[:accept] = array_or_string_for_javascript(options[:accept]) if options[:accept]
- options[:hoverclass] = "'#{options[:hoverclass]}'" if options[:hoverclass]
-
- javascript_tag("Droppables.add('#{element_id}', #{options_for_javascript(options)})")
- end
-
# Escape carrier returns and single and double quotes for JavaScript segments.
def escape_javascript(javascript)
(javascript || '').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
@@ -463,7 +94,7 @@ def javascript_cdata_section(content) #:nodoc:
"\n//#{cdata_section("\n#{content}\n//")}\n"
end
- private
+ protected
def options_for_javascript(options)
'{' + options.map {|k, v| "#{k}:#{v}"}.sort.join(', ') + '}'
end
@@ -476,51 +107,6 @@ def array_or_string_for_javascript(option)
end
js_option
end
-
- def options_for_ajax(options)
- js_options = build_callbacks(options)
-
- js_options['asynchronous'] = options[:type] != :synchronous
- js_options['method'] = method_option_to_s(options[:method]) if options[:method]
- js_options['insertion'] = "Insertion.#{options[:position].to_s.camelize}" if options[:position]
- js_options['evalScripts'] = options[:script].nil? || options[:script]
-
- if options[:form]
- js_options['parameters'] = 'Form.serialize(this)'
- elsif options[:submit]
- js_options['parameters'] = "Form.serialize(document.getElementById('#{options[:submit]}'))"
- elsif options[:with]
- js_options['parameters'] = options[:with]
- end
-
- options_for_javascript(js_options)
- end
-
- def method_option_to_s(method)
- (method.is_a?(String) and !method.index("'").nil?) ? method : "'#{method}'"
- end
-
- def build_observer(klass, name, options = {})
- options[:with] ||= 'value' if options[:update]
- callback = remote_function(options)
- javascript = "new #{klass}('#{name}', "
- javascript << "#{options[:frequency]}, " if options[:frequency]
- javascript << "function(element, value) {"
- javascript << "#{callback}})"
- javascript_tag(javascript)
- end
-
- def build_callbacks(options)
- callbacks = {}
- options.each do |callback, code|
- if CALLBACKS.include?(callback)
- name = 'on' + callback.to_s.capitalize
- callbacks[name] = "function(request){#{code}}"
- end
- end
- callbacks
- end
-
end
JavascriptHelper = JavaScriptHelper unless const_defined? :JavascriptHelper
View
522 actionpack/lib/action_view/helpers/prototype_helper.rb
@@ -0,0 +1,522 @@
+require File.dirname(__FILE__) + '/javascript_helper'
+
+module ActionView
+ module Helpers
+ # Provides a set of helpers for calling Prototype JavaScript functions,
+ # including functionality to call remote methods using
+ # Ajax[http://www.adaptivepath.com/publications/essays/archives/000385.php].
+ # This means that you can call actions in your controllers without
+ # reloading the page, but still update certain parts of it using
+ # injections into the DOM. The common use case is having a form that adds
+ # a new element to a list without reloading the page.
+ #
+ # To be able to use these helpers, you must include the Prototype
+ # JavaScript framework in your pages. See the documentation for
+ # ActionView::Helpers::JavaScriptHelper for more information on including
+ # the necessary JavaScript.
+ #
+ # See link_to_remote for documentation of options common to all Ajax
+ # helpers.
+ #
+ # See also ActionView::Helpers::ScriptaculousHelper for helpers which work
+ # with the Scriptaculous controls and visual effects library.
+ #
+ # See JavaScriptGenerator for information on updating multiple elements
+ # on the page in an Ajax response.
+ module PrototypeHelper
+ unless const_defined? :CALLBACKS
+ CALLBACKS = [ :uninitialized, :loading, :loaded, :interactive,
+ :complete, :failure, :success ] + (100..599).to_a
+ AJAX_OPTIONS = [ :before, :after, :condition, :url, :asynchronous,
+ :method, :insertion, :position, :form, :with, :update,
+ :script ] + 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
+ # either render_partial or render_partial_collection.
+ #
+ # Examples:
+ # link_to_remote "Delete this post", :update => "posts",
+ # :url => { :action => "destroy", :id => post.id }
+ # link_to_remote(image_tag("refresh"), :update => "emails",
+ # :url => { :action => "list_emails" })
+ #
+ # 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:
+ # 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>.
+ #
+ # 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:
+ # 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:
+ # 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.
+ def link_to_remote(name, options = {}, html_options = {})
+ link_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 :url
+ # and defining callbacks is the same as link_to_remote.
+ 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 @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.
+ #
+ # Example:
+ # form_remote_tag :html => { :action =>
+ # url_for(:controller => "some", :action => "place") }
+ #
+ # The Hash passed to the :html 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 :url (and the default method is :post).
+ def form_remote_tag(options = {})
+ options[:form] = true
+
+ options[:html] ||= {}
+ options[:html][:onsubmit] = "#{remote_function(options)}; return false;"
+ options[:html][:action] = options[:html][:action] || url_for(options[:url])
+ options[:html][:method] = options[:html][:method] || "post"
+
+ tag("form", options[:html], true)
+ end
+
+ # Returns a button input tag that will submit form using XMLHttpRequest
+ # in the background instead of regular reloading POST arrangement.
+ # <tt>options</tt> argument is the same as in <tt>form_remote_tag</tt>.
+ def submit_to_remote(name, value, options = {})
+ options[:with] ||= 'Form.serialize(this.form)'
+
+ options[:html] ||= {}
+ options[:html][:type] = 'button'
+ options[:html][:onclick] = "#{remote_function(options)}; return false;"
+ options[:html][:name] = name
+ options[:html][:value] = value
+
+ tag("input", options[:html], false)
+ end
+
+ # Returns a JavaScript function (or expression) that'll update a DOM
+ # element according to the options passed.
+ #
+ # * <tt>:content</tt>: The content to use for updating. Can be left out
+ # if using block, see example.
+ # * <tt>:action</tt>: Valid options are :update (assumed by default),
+ # :empty, :remove
+ # * <tt>:position</tt> If the :action is :update, you can optionally
+ # specify one of the following positions: :before, :top, :bottom,
+ # :after.
+ #
+ # Examples:
+ # <%= javascript_tag(update_element_function("products",
+ # :position => :bottom, :content => "<p>New product!</p>")) %>
+ #
+ # <% replacement_function = update_element_function("products") do %>
+ # <p>Product 1</p>
+ # <p>Product 2</p>
+ # <% end %>
+ # <%= javascript_tag(replacement_function) %>
+ #
+ # This method can also be used in combination with remote method call
+ # where the result is evaluated afterwards to cause multiple updates on
+ # a page. Example:
+ #
+ # # Calling view
+ # <%= form_remote_tag :url => { :action => "buy" },
+ # :complete => evaluate_remote_response %>
+ # all the inputs here...
+ #
+ # # Controller action
+ # def buy
+ # @product = Product.find(1)
+ # end
+ #
+ # # Returning view
+ # <%= update_element_function(
+ # "cart", :action => :update, :position => :bottom,
+ # :content => "<p>New Product: #{@product.name}</p>")) %>
+ # <% update_element_function("status", :binding => binding) do %>
+ # You've bought a new product!
+ # <% end %>
+ #
+ # Notice how the second call doesn't need to be in an ERb output block
+ # since it uses a block and passes in the binding to render directly.
+ # This trick will however only work in ERb (not Builder or other
+ # template forms).
+ #
+ # See also JavaScriptGenerator and update_page.
+ def update_element_function(element_id, options = {}, &block)
+
+ content = escape_javascript(options[:content] || '')
+ content = escape_javascript(capture(&block)) if block
+
+ javascript_function = case (options[:action] || :update)
+ when :update
+ if options[:position]
+ "new Insertion.#{options[:position].to_s.camelize}('#{element_id}','#{content}')"
+ else
+ "$('#{element_id}').innerHTML = '#{content}'"
+ end
+
+ when :empty
+ "$('#{element_id}').innerHTML = ''"
+
+ when :remove
+ "Element.remove('#{element_id}')"
+
+ else
+ raise ArgumentError, "Invalid action, choose one of :update, :remove, :empty"
+ end
+
+ javascript_function << ";\n"
+ options[:binding] ? concat(javascript_function, options[:binding]) : javascript_function
+ end
+
+ # Returns 'eval(request.responseText)' which is the JavaScript function
+ # that form_remote_tag can call in :complete 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.
+ #
+ # Example:
+ # <select id="options" onchange="<%= remote_function(:update => "options",
+ # :url => { :action => :update_options }) %>">
+ # <option value="0">Hello</option>
+ # <option value="1">World</option>
+ # </select>
+ def remote_function(options)
+ javascript_options = options_for_ajax(options)
+
+ update = ''
+ if options[:update] and options[:update].is_a?Hash
+ update = []
+ update << "success:'#{options[:update][:success]}'" if options[:update][:success]
+ update << "failure:'#{options[:update][:failure]}'" if options[:update][:failure]
+ update = '{' + update.join(',') + '}'
+ elsif options[:update]
+ update << "'#{options[:update]}'"
+ end
+
+ function = update.empty? ?
+ "new Ajax.Request(" :
+ "new Ajax.Updater(#{update}, "
+
+ function << "'#{url_for(options[:url])}'"
+ function << ", #{javascript_options})"
+
+ function = "#{options[:before]}; #{function}" if options[:before]
+ function = "#{function}; #{options[:after]}" if options[:after]
+ function = "if (#{options[:condition]}) { #{function}; }" if options[:condition]
+ function = "if (confirm('#{escape_javascript(options[:confirm])}')) { #{function}; }" if options[:confirm]
+
+ return function
+ end
+
+ # Observes the field with the DOM ID specified by +field_id+ and makes
+ # an Ajax call when its contents have changed.
+ #
+ # Required +options+ are:
+ # <tt>:url</tt>:: +url_for+-style options for the action to call
+ # when the field has changed.
+ #
+ # 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. This defaults
+ # to 'value', which in the evaluated context
+ # refers to the new field value.
+ #
+ # Additionally, you may specify any of the options documented in
+ # link_to_remote.
+ def observe_field(field_id, options = {})
+ if options[:frequency] and options[:frequency] > 0
+ build_observer('Form.Element.Observer', field_id, options)
+ else
+ build_observer('Form.Element.EventObserver', field_id, options)
+ end
+ end
+
+ # Like +observe_field+, but operates on an entire form identified by the
+ # DOM ID +form_id+. +options+ are the same as +observe_field+, except
+ # the default value of the <tt>:with</tt> option evaluates to the
+ # serialized (request string) value of the form.
+ 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
+
+ # JavaScriptGenerator generates blocks of JavaScript code that allow you
+ # to change the content and presentation of multiple DOM elements. Use
+ # this in your Ajax response bodies, either in a <script> tag or as plain
+ # JavaScript sent with a Content-type of "text/javascript".
+ #
+ # Create new instances with PrototypeHelper#update_page, then call
+ # #insert_html, #replace_html, #remove, #show, or #hide on the yielded
+ # generator in any order you like to modify the content and appearance of
+ # the current page. (You can also call other helper methods which
+ # return JavaScript, such as
+ # ActionView::Helpers::ScriptaculousHelper#visual_effect.)
+ #
+ # Example:
+ #
+ # update_page do |page|
+ # page.insert_html :bottom, 'list', '<li>Last item</li>'
+ # page.visual_effect :highlight, 'list'
+ # page.hide 'status-indicator', 'cancel-link'
+ # end
+ #
+ # generates the following JavaScript:
+ #
+ # new Insertion.Bottom("list", "<li>Last item</li>");
+ # new Effect.Highlight("list");
+ # ["status-indicator", "cancel-link"].each(Element.hide);
+ #
+ # You can also use PrototypeHelper#update_page_tag instead of
+ # PrototypeHelper#update_page to wrap the generated JavaScript in a
+ # <script> tag.
+ class JavaScriptGenerator
+ def initialize(context) #:nodoc:
+ @context, @lines = context, []
+ yield self
+ end
+
+ def to_s #:nodoc:
+ @lines * $/
+ end
+
+ # Inserts HTML at the specified +position+ relative to the DOM element
+ # identified by the given +id+.
+ #
+ # +position+ may be one of:
+ #
+ # <tt>:top</tt>:: HTML is inserted inside the element, before the
+ # element's existing content.
+ # <tt>:bottom</tt>:: HTML is inserted inside the element, after the
+ # element's existing content.
+ # <tt>:before</tt>:: HTML is inserted immediately preceeding the element.
+ # <tt>:after</tt>:: HTML is inserted immediately following the element.
+ #
+ # +options_for_render+ may be either a string of HTML to insert, or a hash
+ # of options to be passed to ActionView::Base#render. For example:
+ #
+ # # Insert the rendered 'navigation' partial just before the DOM
+ # # element with ID 'content'.
+ # insert_html :before, 'content', :partial => 'navigation'
+ #
+ # # Add a list item to the bottom of the <ul> with ID 'list'.
+ # insert_html :bottom, 'list', '<li>Last item</li>'
+ #
+ def insert_html(position, id, *options_for_render)
+ html = render(*options_for_render)
+ record "new Insertion.#{position.to_s.camelize}(#{id.inspect}, #{html.inspect})"
+ end
+
+ # Replaces the inner HTML of the DOM element with the given +id+.
+ #
+ # +options_for_render+ may be either a string of HTML to insert, or a hash
+ # of options to be passed to ActionView::Base#render. For example:
+ #
+ # # Replace the HTML of the DOM element having ID 'person-45' with the
+ # # 'person' partial for the appropriate object.
+ # replace_html 'person-45', :partial => 'person', :object => @person
+ #
+ def replace_html(id, *options_for_render)
+ html = render(*options_for_render)
+ record "$(#{id.inspect}).innerHTML = #{html.inspect}"
+ end
+
+ # Removes the DOM elements with the given +ids+ from the page.
+ def remove(*ids)
+ record "#{ids.inspect}.each(Element.remove)"
+ end
+
+ # Shows hidden DOM elements with the given +ids+.
+ def show(*ids)
+ record "#{ids.inspect}.each(Element.show)"
+ end
+
+ # Hides the visible DOM elements with the given +ids+.
+ def hide(*ids)
+ record "#{ids.inspect}.each(Element.hide)"
+ end
+
+ private
+ def method_missing(method, *arguments, &block)
+ record @context.send(method, *arguments, &block)
+ end
+
+ def record(line)
+ returning line = "#{line.to_s.chomp.gsub /\;$/, ''};" do
+ @lines << line
+ end
+ end
+
+ def render(*options_for_render)
+ Hash === options_for_render.first ?
+ @context.render(*options_for_render) :
+ options_for_render.first.to_s
+ end
+ end
+
+ # Yields a JavaScriptGenerator and returns the generated JavaScript code.
+ # Use this to update multiple elements on a page in an Ajax response.
+ # See JavaScriptGenerator for more information.
+ def update_page(&block)
+ JavaScriptGenerator.new(@template, &block).to_s
+ end
+
+ # Works like update_page but wraps the generated JavaScript in a <script>
+ # tag. Use this to include generated JavaScript in an ERb template.
+ # See JavaScriptGenerator for more information.
+ def update_page_tag(&block)
+ javascript_tag update_page(&block)
+ end
+
+ protected
+ def options_for_ajax(options)
+ js_options = build_callbacks(options)
+
+ js_options['asynchronous'] = options[:type] != :synchronous
+ js_options['method'] = method_option_to_s(options[:method]) if options[:method]
+ js_options['insertion'] = "Insertion.#{options[:position].to_s.camelize}" if options[:position]
+ js_options['evalScripts'] = options[:script].nil? || options[:script]
+
+ if options[:form]
+ js_options['parameters'] = 'Form.serialize(this)'
+ elsif options[:submit]
+ js_options['parameters'] = "Form.serialize('#{options[:submit]}')"
+ elsif options[:with]
+ js_options['parameters'] = options[:with]
+ end
+
+ options_for_javascript(js_options)
+ end
+
+ def method_option_to_s(method)
+ (method.is_a?(String) and !method.index("'").nil?) ? method : "'#{method}'"
+ end
+
+ def build_observer(klass, name, options = {})
+ options[:with] ||= 'value' if options[:update]
+ callback = remote_function(options)
+ javascript = "new #{klass}('#{name}', "
+ javascript << "#{options[:frequency]}, " if options[:frequency]
+ javascript << "function(element, value) {"
+ javascript << "#{callback}})"
+ javascript_tag(javascript)
+ end
+
+ def build_callbacks(options)
+ callbacks = {}
+ options.each do |callback, code|
+ if CALLBACKS.include?(callback)
+ name = 'on' + callback.to_s.capitalize
+ callbacks[name] = "function(request){#{code}}"
+ end
+ end
+ callbacks
+ end
+ end
+ end
+end
View
105 actionpack/lib/action_view/helpers/scriptaculous_helper.rb
@@ -0,0 +1,105 @@
+require File.dirname(__FILE__) + '/javascript_helper'
+
+module ActionView
+ module Helpers
+ # Provides a set of helpers for calling Scriptaculous JavaScript
+ # functions, including those which create Ajax controls and visual effects.
+ #
+ # To be able to use these helpers, you must include the Prototype
+ # JavaScript framework and the Scriptaculous JavaScript library in your
+ # pages. See the documentation for ActionView::Helpers::JavaScriptHelper
+ # for more information on including the necessary JavaScript.
+ #
+ # The Scriptaculous helpers' behavior can be tweaked with various options.
+ # See the documentation at http://script.aculo.us for more information on
+ # using these helpers in your application.
+ module ScriptaculousHelper
+ # Returns a JavaScript snippet to be used on the Ajax callbacks for
+ # starting visual effects.
+ #
+ # Example:
+ # <%= link_to_remote "Reload", :update => "posts",
+ # :url => { :action => "reload" },
+ # :complete => visual_effect(:highlight, "posts", :duration => 0.5)
+ #
+ # If no element_id is given, it assumes "element" which should be a local
+ # variable in the generated JavaScript execution context. This can be
+ # used for example with drop_receiving_element:
+ #
+ # <%= drop_receving_element (...), :loading => visual_effect(:fade) %>
+ #
+ # This would fade the element that was dropped on the drop receiving
+ # element.
+ #
+ # You can change the behaviour with various options, see
+ # http://script.aculo.us for more documentation.
+ def visual_effect(name, element_id = false, js_options = {})
+ element = element_id ? "'#{element_id}'" : "element"
+ js_options[:queue] = "'#{js_options[:queue]}'" if js_options[:queue]
+ "new Effect.#{name.to_s.camelize}(#{element},#{options_for_javascript(js_options)});"
+ end
+
+ # Makes the element with the DOM ID specified by +element_id+ sortable
+ # by drag-and-drop and make an Ajax call whenever the sort order has
+ # changed. By default, the action called gets the serialized sortable
+ # element as parameters.
+ #
+ # Example:
+ # <%= sortable_element("my_list", :url => { :action => "order" }) %>
+ #
+ # In the example, the action gets a "my_list" array parameter
+ # containing the values of the ids of elements the sortable consists
+ # of, in the current order.
+ #
+ # You can change the behaviour with various options, see
+ # http://script.aculo.us for more documentation.
+ def sortable_element(element_id, options = {})
+ options[:with] ||= "Sortable.serialize('#{element_id}')"
+ options[:onUpdate] ||= "function(){" + remote_function(options) + "}"
+ options.delete_if { |key, value| PrototypeHelper::AJAX_OPTIONS.include?(key) }
+
+ [:tag, :overlap, :constraint, :handle].each do |option|
+ options[option] = "'#{options[option]}'" if options[option]
+ end
+
+ options[:containment] = array_or_string_for_javascript(options[:containment]) if options[:containment]
+ options[:only] = array_or_string_for_javascript(options[:only]) if options[:only]
+
+ javascript_tag("Sortable.create('#{element_id}', #{options_for_javascript(options)})")
+ end
+
+ # Makes the element with the DOM ID specified by +element_id+ draggable.
+ #
+ # Example:
+ # <%= draggable_element("my_image", :revert => true)
+ #
+ # You can change the behaviour with various options, see
+ # http://script.aculo.us for more documentation.
+ def draggable_element(element_id, options = {})
+ javascript_tag("new Draggable('#{element_id}', #{options_for_javascript(options)})")
+ end
+
+ # Makes the element with the DOM ID specified by +element_id+ receive
+ # dropped draggable elements (created by draggable_element).
+ # and make an AJAX call By default, the action called gets the DOM ID
+ # of the element as parameter.
+ #
+ # Example:
+ # <%= drop_receiving_element("my_cart", :url =>
+ # { :controller => "cart", :action => "add" }) %>
+ #
+ # You can change the behaviour with various options, see
+ # http://script.aculo.us for more documentation.
+ def drop_receiving_element(element_id, options = {})
+ options[:with] ||= "'id=' + encodeURIComponent(element.id)"
+ options[:onDrop] ||= "function(element){" + remote_function(options) + "}"
+ options.delete_if { |key, value| PrototypeHelper::AJAX_OPTIONS.include?(key) }
+
+ options[:accept] = array_or_string_for_javascript(options[:accept]) if options[:accept]
+ options[:hoverclass] = "'#{options[:hoverclass]}'" if options[:hoverclass]
+
+ javascript_tag("Droppables.add('#{element_id}', #{options_for_javascript(options)})")
+ end
+ end
+ end
+end
View
155 actionpack/test/template/javascript_helper_test.rb
@@ -9,17 +9,6 @@ class JavaScriptHelperTest < Test::Unit::TestCase
include ActionView::Helpers::FormHelper
include ActionView::Helpers::CaptureHelper
- def setup
- @controller = Class.new do
- def url_for(options, *parameters_for_method_reference)
- url = "http://www.example.com/"
- url << options[:action].to_s if options and options[:action]
- url
- end
- end
- @controller = @controller.new
- end
-
def test_define_javascript_functions
# check if prototype.js is included first
assert_not_nil define_javascript_functions.split("\n")[1].match(/Prototype JavaScript framework/)
@@ -37,148 +26,4 @@ def test_link_to_function
link_to_function("Greeting", "alert('Hello world!')")
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 outpost</a>),
- link_to_remote("Remote outpost", { :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.reponseText)}}); return false;\">Remote outpost</a>),
- link_to_remote("Remote outpost", :complete => "alert(request.reponseText)", :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.reponseText)}}); return false;\">Remote outpost</a>),
- link_to_remote("Remote outpost", :success => "alert(request.reponseText)", :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.reponseText)}}); return false;\">Remote outpost</a>),
- link_to_remote("Remote outpost", :failure => "alert(request.reponseText)", :url => { :action => "whatnot" })
- 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_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_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)}); return false;\" 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})})\n//]]>\n</script>),
- observe_field("glass", :frequency => 5.minutes, :url => { :action => "reorder_if_empty" })
- 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})})\n//]]>\n</script>),
- observe_form("cart", :frequency => 2, :url => { :action => "cart_changed" })
- end
-
- def test_effect
- assert_equal "new Effect.Highlight('posts',{});", visual_effect(:highlight, "posts")
- assert_equal "new Effect.Highlight('posts',{});", visual_effect("highlight", :posts)
- assert_equal "new Effect.Highlight('posts',{});", visual_effect(:highlight, :posts)
- assert_equal "new Effect.Fade('fademe',{duration:4.0});", visual_effect(:fade, "fademe", :duration => 4.0)
- assert_equal "new Effect.Shake(element,{});", visual_effect(:shake)
- assert_equal "new Effect.DropOut('dropme',{queue:'end'});", visual_effect(:drop_out, 'dropme', :queue => :end)
- end
-
- def test_sortable_element
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nSortable.create('mylist', {onUpdate:function(){new Ajax.Request('http://www.example.com/order', {asynchronous:true, evalScripts:true, parameters:Sortable.serialize('mylist')})}})\n//]]>\n</script>),
- sortable_element("mylist", :url => { :action => "order" })
- assert_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nSortable.create('mylist', {constraint:'horizontal', onUpdate:function(){new Ajax.Request('http://www.example.com/order', {asynchronous:true, evalScripts:true, parameters:Sortable.serialize('mylist')})}, tag:'div'})\n//]]>\n</script>),
- sortable_element("mylist", :tag => "div", :constraint => "horizontal", :url => { :action => "order" })
- assert_dom_equal %|<script type=\"text/javascript\">\n//<![CDATA[\nSortable.create('mylist', {constraint:'horizontal', containment:['list1','list2'], onUpdate:function(){new Ajax.Request('http://www.example.com/order', {asynchronous:true, evalScripts:true, parameters:Sortable.serialize('mylist')})}})\n//]]>\n</script>|,
- sortable_element("mylist", :containment => ['list1','list2'], :constraint => "horizontal", :url => { :action => "order" })
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nSortable.create('mylist', {constraint:'horizontal', containment:'list1', onUpdate:function(){new Ajax.Request('http://www.example.com/order', {asynchronous:true, evalScripts:true, parameters:Sortable.serialize('mylist')})}})\n//]]>\n</script>),
- sortable_element("mylist", :containment => 'list1', :constraint => "horizontal", :url => { :action => "order" })
- end
-
- def test_draggable_element
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Draggable('product_13', {})\n//]]>\n</script>),
- draggable_element('product_13')
- assert_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Draggable('product_13', {revert:true})\n//]]>\n</script>),
- draggable_element('product_13', :revert => true)
- end
-
- def test_drop_receiving_element
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nDroppables.add('droptarget1', {onDrop:function(element){new Ajax.Request('http://www.example.com/', {asynchronous:true, evalScripts:true, parameters:'id=' + encodeURIComponent(element.id)})}})\n//]]>\n</script>),
- drop_receiving_element('droptarget1')
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nDroppables.add('droptarget1', {accept:'products', onDrop:function(element){new Ajax.Request('http://www.example.com/', {asynchronous:true, evalScripts:true, parameters:'id=' + encodeURIComponent(element.id)})}})\n//]]>\n</script>),
- drop_receiving_element('droptarget1', :accept => 'products')
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nDroppables.add('droptarget1', {accept:'products', onDrop:function(element){new Ajax.Updater('infobox', 'http://www.example.com/', {asynchronous:true, evalScripts:true, parameters:'id=' + encodeURIComponent(element.id)})}})\n//]]>\n</script>),
- drop_receiving_element('droptarget1', :accept => 'products', :update => 'infobox')
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nDroppables.add('droptarget1', {accept:['tshirts','mugs'], onDrop:function(element){new Ajax.Updater('infobox', 'http://www.example.com/', {asynchronous:true, evalScripts:true, parameters:'id=' + encodeURIComponent(element.id)})}})\n//]]>\n</script>),
- drop_receiving_element('droptarget1', :accept => ['tshirts','mugs'], :update => 'infobox')
- end
-
- def test_update_element_function
- assert_equal %($('myelement').innerHTML = 'blub';\n),
- update_element_function('myelement', :content => 'blub')
- assert_equal %($('myelement').innerHTML = 'blub';\n),
- update_element_function('myelement', :action => :update, :content => 'blub')
- assert_equal %($('myelement').innerHTML = '';\n),
- update_element_function('myelement', :action => :empty)
- assert_equal %(Element.remove('myelement');\n),
- update_element_function('myelement', :action => :remove)
-
- assert_equal %(new Insertion.Bottom('myelement','blub');\n),
- update_element_function('myelement', :position => 'bottom', :content => 'blub')
- assert_equal %(new Insertion.Bottom('myelement','blub');\n),
- update_element_function('myelement', :action => :update, :position => :bottom, :content => 'blub')
-
- _erbout = ""
- assert_equal %($('myelement').innerHTML = 'test';\n),
- update_element_function('myelement') { _erbout << "test" }
-
- _erbout = ""
- assert_equal %($('myelement').innerHTML = 'blockstuff';\n),
- update_element_function('myelement', :content => 'paramstuff') { _erbout << "blockstuff" }
- end
-
end
View
208 actionpack/test/template/prototype_helper_test.rb
@@ -0,0 +1,208 @@
+require File.dirname(__FILE__) + '/../abstract_unit'
+
+module BaseTest
+ include ActionView::Helpers::JavaScriptHelper
+ include ActionView::Helpers::PrototypeHelper
+
+ include ActionView::Helpers::UrlHelper
+ include ActionView::Helpers::TagHelper
+ include ActionView::Helpers::TextHelper
+ include ActionView::Helpers::FormHelper
+ include ActionView::Helpers::CaptureHelper
+
+ def setup
+ @controller = Class.new do
+ def url_for(options, *parameters_for_method_reference)
+ url = "http://www.example.com/"
+ url << options[:action].to_s if options and options[:action]
+ url
+ end
+ end.new
+ end
+
+protected
+ def create_generator
+ block = Proc.new { |*args| yield *args if block_given? }
+ JavaScriptGenerator.new self, &block
+ end
+end
+
+class PrototypeHelperTest < Test::Unit::TestCase
+ include BaseTest
+
+ 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 outpost</a>),
+ link_to_remote("Remote outpost", { :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.reponseText)}}); return false;\">Remote outpost</a>),
+ link_to_remote("Remote outpost", :complete => "alert(request.reponseText)", :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.reponseText)}}); return false;\">Remote outpost</a>),
+ link_to_remote("Remote outpost", :success => "alert(request.reponseText)", :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.reponseText)}}); return false;\">Remote outpost</a>),
+ link_to_remote("Remote outpost", :failure => "alert(request.reponseText)", :url => { :action => "whatnot" })
+ 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_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_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)}); return false;\" 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})})\n//]]>\n</script>),
+ observe_field("glass", :frequency => 5.minutes, :url => { :action => "reorder_if_empty" })
+ 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})})\n//]]>\n</script>),
+ observe_form("cart", :frequency => 2, :url => { :action => "cart_changed" })
+ end
+
+ def test_update_element_function
+ assert_equal %($('myelement').innerHTML = 'blub';\n),
+ update_element_function('myelement', :content => 'blub')
+ assert_equal %($('myelement').innerHTML = 'blub';\n),
+ update_element_function('myelement', :action => :update, :content => 'blub')
+ assert_equal %($('myelement').innerHTML = '';\n),
+ update_element_function('myelement', :action => :empty)
+ assert_equal %(Element.remove('myelement');\n),
+ update_element_function('myelement', :action => :remove)
+
+ assert_equal %(new Insertion.Bottom('myelement','blub');\n),
+ update_element_function('myelement', :position => 'bottom', :content => 'blub')
+ assert_equal %(new Insertion.Bottom('myelement','blub');\n),
+ update_element_function('myelement', :action => :update, :position => :bottom, :content => 'blub')
+
+ _erbout = ""
+ assert_equal %($('myelement').innerHTML = 'test';\n),
+ update_element_function('myelement') { _erbout << "test" }
+
+ _erbout = ""
+ assert_equal %($('myelement').innerHTML = 'blockstuff';\n),
+ update_element_function('myelement', :content => 'paramstuff') { _erbout << "blockstuff" }
+ end
+
+ def test_update_page
+ block = Proc.new { |page| page.replace_html('foo', 'bar') }
+ assert_equal create_generator(&block).to_s, update_page(&block)
+ end
+
+ def test_update_page_tag
+ block = Proc.new { |page| page.replace_html('foo', 'bar') }
+ assert_equal javascript_tag(create_generator(&block).to_s), update_page_tag(&block)
+ end
+end
+
+class JavaScriptGeneratorTest < Test::Unit::TestCase
+ include BaseTest
+
+ def setup
+ super
+ @generator = create_generator
+ end
+
+ def test_insert_html_with_string
+ assert_equal 'new Insertion.Top("element", "<p>This is a test</p>");',
+ @generator.insert_html(:top, 'element', '<p>This is a test</p>')
+ assert_equal 'new Insertion.Bottom("element", "<p>This is a test</p>");',
+ @generator.insert_html(:bottom, 'element', '<p>This is a test</p>')
+ assert_equal 'new Insertion.Before("element", "<p>This is a test</p>");',
+ @generator.insert_html(:before, 'element', '<p>This is a test</p>')
+ assert_equal 'new Insertion.After("element", "<p>This is a test</p>");',
+ @generator.insert_html(:after, 'element', '<p>This is a test</p>')
+ end
+
+ def test_replace_html_with_string
+ assert_equal '$("element").innerHTML = "<p>This is a test</p>";',
+ @generator.replace_html('element', '<p>This is a test</p>')
+ end
+
+ def test_remove
+ assert_equal '["foo"].each(Element.remove);',
+ @generator.remove('foo')
+ assert_equal '["foo", "bar", "baz"].each(Element.remove);',
+ @generator.remove('foo', 'bar', 'baz')
+ end
+
+ def test_show
+ assert_equal '["foo"].each(Element.show);',
+ @generator.show('foo')
+ assert_equal '["foo", "bar", "baz"].each(Element.show);',
+ @generator.show('foo', 'bar', 'baz')
+ end
+
+ def test_hide
+ assert_equal '["foo"].each(Element.hide);',
+ @generator.hide('foo')
+ assert_equal '["foo", "bar", "baz"].each(Element.hide);',
+ @generator.hide('foo', 'bar', 'baz')
+ end
+
+ def test_to_s
+ @generator.insert_html(:top, 'element', '<p>This is a test</p>')
+ @generator.insert_html(:bottom, 'element', '<p>This is a test</p>')
+ @generator.remove('foo', 'bar')
+ @generator.replace_html('baz', '<p>This is a test</p>')
+
+ assert_equal <<-EOS.chomp, @generator.to_s
+new Insertion.Top("element", "<p>This is a test</p>");
+new Insertion.Bottom("element", "<p>This is a test</p>");
+["foo", "bar"].each(Element.remove);
+$("baz").innerHTML = "<p>This is a test</p>";
+ EOS
+ end
+end
View
61 actionpack/test/template/scriptaculous_helper_test.rb
@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/../abstract_unit'
+
+class ScriptaculousHelperTest < Test::Unit::TestCase
+ include ActionView::Helpers::JavaScriptHelper
+ include ActionView::Helpers::PrototypeHelper
+ include ActionView::Helpers::ScriptaculousHelper
+
+ include ActionView::Helpers::UrlHelper
+ include ActionView::Helpers::TagHelper
+ include ActionView::Helpers::TextHelper
+ include ActionView::Helpers::FormHelper
+ include ActionView::Helpers::CaptureHelper
+
+ def setup
+ @controller = Class.new do
+ def url_for(options, *parameters_for_method_reference)
+ url = "http://www.example.com/"
+ url << options[:action].to_s if options and options[:action]
+ url
+ end
+ end.new
+ end
+
+ def test_effect
+ assert_equal "new Effect.Highlight('posts',{});", visual_effect(:highlight, "posts")
+ assert_equal "new Effect.Highlight('posts',{});", visual_effect("highlight", :posts)
+ assert_equal "new Effect.Highlight('posts',{});", visual_effect(:highlight, :posts)
+ assert_equal "new Effect.Fade('fademe',{duration:4.0});", visual_effect(:fade, "fademe", :duration => 4.0)
+ assert_equal "new Effect.Shake(element,{});", visual_effect(:shake)
+ assert_equal "new Effect.DropOut('dropme',{queue:'end'});", visual_effect(:drop_out, 'dropme', :queue => :end)
+ end
+
+ def test_sortable_element
+ assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nSortable.create('mylist', {onUpdate:function(){new Ajax.Request('http://www.example.com/order', {asynchronous:true, evalScripts:true, parameters:Sortable.serialize('mylist')})}})\n//]]>\n</script>),
+ sortable_element("mylist", :url => { :action => "order" })
+ assert_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nSortable.create('mylist', {constraint:'horizontal', onUpdate:function(){new Ajax.Request('http://www.example.com/order', {asynchronous:true, evalScripts:true, parameters:Sortable.serialize('mylist')})}, tag:'div'})\n//]]>\n</script>),
+ sortable_element("mylist", :tag => "div", :constraint => "horizontal", :url => { :action => "order" })
+ assert_dom_equal %|<script type=\"text/javascript\">\n//<![CDATA[\nSortable.create('mylist', {constraint:'horizontal', containment:['list1','list2'], onUpdate:function(){new Ajax.Request('http://www.example.com/order', {asynchronous:true, evalScripts:true, parameters:Sortable.serialize('mylist')})}})\n//]]>\n</script>|,
+ sortable_element("mylist", :containment => ['list1','list2'], :constraint => "horizontal", :url => { :action => "order" })
+ assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nSortable.create('mylist', {constraint:'horizontal', containment:'list1', onUpdate:function(){new Ajax.Request('http://www.example.com/order', {asynchronous:true, evalScripts:true, parameters:Sortable.serialize('mylist')})}})\n//]]>\n</script>),
+ sortable_element("mylist", :containment => 'list1', :constraint => "horizontal", :url => { :action => "order" })
+ end
+
+ def test_draggable_element
+ assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Draggable('product_13', {})\n//]]>\n</script>),
+ draggable_element('product_13')
+ assert_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Draggable('product_13', {revert:true})\n//]]>\n</script>),
+ draggable_element('product_13', :revert => true)
+ end
+
+ def test_drop_receiving_element
+ assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nDroppables.add('droptarget1', {onDrop:function(element){new Ajax.Request('http://www.example.com/', {asynchronous:true, evalScripts:true, parameters:'id=' + encodeURIComponent(element.id)})}})\n//]]>\n</script>),
+ drop_receiving_element('droptarget1')
+ assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nDroppables.add('droptarget1', {accept:'products', onDrop:function(element){new Ajax.Request('http://www.example.com/', {asynchronous:true, evalScripts:true, parameters:'id=' + encodeURIComponent(element.id)})}})\n//]]>\n</script>),
+ drop_receiving_element('droptarget1', :accept => 'products')
+ assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nDroppables.add('droptarget1', {accept:'products', onDrop:function(element){new Ajax.Updater('infobox', 'http://www.example.com/', {asynchronous:true, evalScripts:true, parameters:'id=' + encodeURIComponent(element.id)})}})\n//]]>\n</script>),
+ drop_receiving_element('droptarget1', :accept => 'products', :update => 'infobox')
+ assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nDroppables.add('droptarget1', {accept:['tshirts','mugs'], onDrop:function(element){new Ajax.Updater('infobox', 'http://www.example.com/', {asynchronous:true, evalScripts:true, parameters:'id=' + encodeURIComponent(element.id)})}})\n//]]>\n</script>),
+ drop_receiving_element('droptarget1', :accept => ['tshirts','mugs'], :update => 'infobox')
+ end
+end
Please sign in to comment.
Something went wrong with that request. Please try again.