Permalink
Browse files

Moved ActionController::Macros::InPlaceEditing into the in_place_edit…

…or plugin on the official Rails svn (closes #9513) [lifofifo]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@7442 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
dhh committed Sep 10, 2007
1 parent ddf385a commit 2807ccc69a54805e3914bcc21716f9bafbebef39
View
@@ -1,5 +1,7 @@
*SVN*
+* Moved ActionController::Macros::InPlaceEditing into the in_place_editor plugin on the official Rails svn #9513 [lifofifo]
+
* Removed deprecated form of calling xml_http_request/xhr without the first argument being the http verb [DHH]
* Removed deprecated methods [DHH]:
@@ -55,7 +55,6 @@
require 'action_controller/components'
require 'action_controller/record_identifier'
require 'action_controller/macros/auto_complete'
-require 'action_controller/macros/in_place_editing'
require 'action_view'
ActionController::Base.template_class = ActionView::Base
@@ -77,5 +76,4 @@
include ActionController::Components
include ActionController::RecordIdentifier
include ActionController::Macros::AutoComplete
- include ActionController::Macros::InPlaceEditing
end
@@ -1,33 +0,0 @@
-module ActionController
- module Macros
- module InPlaceEditing #:nodoc:
- def self.included(base) #:nodoc:
- base.extend(ClassMethods)
- end
-
- # DEPRECATION WARNING: This method will become a separate plugin when Rails 2.0 ships.
- #
- # Example:
- #
- # # Controller
- # class BlogController < ApplicationController
- # in_place_edit_for :post, :title
- # end
- #
- # # View
- # <%= in_place_editor_field :post, 'title' %>
- #
- # For help on defining an in place editor in the browser,
- # see ActionView::Helpers::JavaScriptHelper.
- module ClassMethods
- def in_place_edit_for(object, attribute, options = {})
- define_method("set_#{object}_#{attribute}") do
- @item = object.to_s.camelize.constantize.find(params[:id])
- @item.update_attribute(attribute, params[:value])
- render :text => @item.send(attribute)
- end
- end
- end
- end
- end
-end
@@ -6,83 +6,7 @@ module Helpers
# larger units. These macros also rely on counterparts in the controller that provide them with their backing. The in-place
# editing relies on ActionController::Base.in_place_edit_for and the autocompletion relies on
# ActionController::Base.auto_complete_for.
- module JavaScriptMacrosHelper
- # DEPRECATION WARNING: This method will become a separate plugin when Rails 2.0 ships.
- #
- # Makes an HTML element specified by the DOM ID +field_id+ become an in-place
- # editor of a property.
- #
- # A form is automatically created and displayed when the user clicks the element,
- # something like this:
- # <form id="myElement-in-place-edit-form" target="specified url">
- # <input name="value" text="The content of myElement"/>
- # <input type="submit" value="ok"/>
- # <a onclick="javascript to cancel the editing">cancel</a>
- # </form>
- #
- # The form is serialized and sent to the server using an AJAX call, the action on
- # the server should process the value and return the updated value in the body of
- # the reponse. The element will automatically be updated with the changed value
- # (as returned from the server).
- #
- # Required +options+ are:
- # <tt>:url</tt>:: Specifies the url where the updated value should
- # be sent after the user presses "ok".
- #
- # Addtional +options+ are:
- # <tt>:rows</tt>:: Number of rows (more than 1 will use a TEXTAREA)
- # <tt>:cols</tt>:: Number of characters the text input should span (works for both INPUT and TEXTAREA)
- # <tt>:size</tt>:: Synonym for :cols when using a single line text input.
- # <tt>:cancel_text</tt>:: The text on the cancel link. (default: "cancel")
- # <tt>:save_text</tt>:: The text on the save link. (default: "ok")
- # <tt>:loading_text</tt>:: The text to display while the data is being loaded from the server (default: "Loading...")
- # <tt>:saving_text</tt>:: The text to display when submitting to the server (default: "Saving...")
- # <tt>:external_control</tt>:: The id of an external control used to enter edit mode.
- # <tt>:load_text_url</tt>:: URL where initial value of editor (content) is retrieved.
- # <tt>:options</tt>:: Pass through options to the AJAX call (see prototype's Ajax.Updater)
- # <tt>:with</tt>:: JavaScript snippet that should return what is to be sent
- # in the AJAX call, +form+ is an implicit parameter
- # <tt>:script</tt>:: Instructs the in-place editor to evaluate the remote JavaScript response (default: false)
- # <tt>:click_to_edit_text</tt>::The text shown during mouseover the editable text (default: "Click to edit")
- def in_place_editor(field_id, options = {})
- function = "new Ajax.InPlaceEditor("
- function << "'#{field_id}', "
- function << "'#{url_for(options[:url])}'"
-
- js_options = {}
- js_options['cancelText'] = %('#{options[:cancel_text]}') if options[:cancel_text]
- js_options['okText'] = %('#{options[:save_text]}') if options[:save_text]
- js_options['loadingText'] = %('#{options[:loading_text]}') if options[:loading_text]
- js_options['savingText'] = %('#{options[:saving_text]}') if options[:saving_text]
- js_options['rows'] = options[:rows] if options[:rows]
- js_options['cols'] = options[:cols] if options[:cols]
- js_options['size'] = options[:size] if options[:size]
- js_options['externalControl'] = "'#{options[:external_control]}'" if options[:external_control]
- js_options['loadTextURL'] = "'#{url_for(options[:load_text_url])}'" if options[:load_text_url]
- js_options['ajaxOptions'] = options[:options] if options[:options]
- js_options['evalScripts'] = options[:script] if options[:script]
- js_options['callback'] = "function(form) { return #{options[:with]} }" if options[:with]
- js_options['clickToEditText'] = %('#{options[:click_to_edit_text]}') if options[:click_to_edit_text]
- function << (', ' + options_for_javascript(js_options)) unless js_options.empty?
-
- function << ')'
-
- javascript_tag(function)
- end
-
- # DEPRECATION WARNING: This method will become a separate plugin when Rails 2.0 ships.
- #
- # Renders the value of the specified object and method with in-place editing capabilities.
- #
- # See the RDoc on ActionController::InPlaceEditing to learn more about this.
- def in_place_editor_field(object, method, tag_options = {}, in_place_editor_options = {})
- tag = ::ActionView::Helpers::InstanceTag.new(object, method, self)
- tag_options = {:tag => "span", :id => "#{object}_#{method}_#{tag.object.id}_in_place_editor", :class => "in_place_editor_field"}.merge!(tag_options)
- in_place_editor_options[:url] = in_place_editor_options[:url] || url_for({ :action => "set_#{object}_#{method}", :id => tag.object.id })
- tag.to_content_tag(tag_options.delete(:tag), tag_options) +
- in_place_editor(tag_options[:id], in_place_editor_options)
- end
-
+ module JavaScriptMacrosHelper
# DEPRECATION WARNING: This method will become a separate plugin when Rails 2.0 ships.
#
# Adds AJAX autocomplete functionality to the text input field with the
@@ -64,48 +64,4 @@ def test_text_field_with_auto_complete
text_field_with_auto_complete(:message, :recipient, {}, :skip_style => true)
end
- def test_in_place_editor_external_control
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Ajax.InPlaceEditor('some_input', 'http://www.example.com/inplace_edit', {externalControl:'blah'})\n//]]>\n</script>),
- in_place_editor('some_input', {:url => {:action => 'inplace_edit'}, :external_control => 'blah'})
- end
-
- def test_in_place_editor_size
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Ajax.InPlaceEditor('some_input', 'http://www.example.com/inplace_edit', {size:4})\n//]]>\n</script>),
- in_place_editor('some_input', {:url => {:action => 'inplace_edit'}, :size => 4})
- end
-
- def test_in_place_editor_cols_no_rows
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Ajax.InPlaceEditor('some_input', 'http://www.example.com/inplace_edit', {cols:4})\n//]]>\n</script>),
- in_place_editor('some_input', {:url => {:action => 'inplace_edit'}, :cols => 4})
- end
-
- def test_in_place_editor_cols_with_rows
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Ajax.InPlaceEditor('some_input', 'http://www.example.com/inplace_edit', {cols:40, rows:5})\n//]]>\n</script>),
- in_place_editor('some_input', {:url => {:action => 'inplace_edit'}, :rows => 5, :cols => 40})
- end
-
- def test_inplace_editor_loading_text
- assert_dom_equal %(<script type=\"text/javascript\">\n//<![CDATA[\nnew Ajax.InPlaceEditor('some_input', 'http://www.example.com/inplace_edit', {loadingText:'Why are we waiting?'})\n//]]>\n</script>),
- in_place_editor('some_input', {:url => {:action => 'inplace_edit'}, :loading_text => 'Why are we waiting?'})
- end
-
- def test_in_place_editor_url
- assert_match "Ajax.InPlaceEditor('id-goes-here', 'http://www.example.com/action_to_set_value')",
- in_place_editor( 'id-goes-here', :url => { :action => "action_to_set_value" })
- end
-
- def test_in_place_editor_load_text_url
- assert_match "Ajax.InPlaceEditor('id-goes-here', 'http://www.example.com/action_to_set_value', {loadTextURL:'http://www.example.com/action_to_get_value'})",
- in_place_editor( 'id-goes-here',
- :url => { :action => "action_to_set_value" },
- :load_text_url => { :action => "action_to_get_value" })
- end
-
- def test_in_place_editor_eval_scripts
- assert_match "Ajax.InPlaceEditor('id-goes-here', 'http://www.example.com/action_to_set_value', {evalScripts:true})",
- in_place_editor( 'id-goes-here',
- :url => { :action => "action_to_set_value" },
- :script => true )
- end
-
end

0 comments on commit 2807ccc

Please sign in to comment.