Added in-place editing support in the spirit of auto complete with ActionController::Base.in_place_edit_for, JavascriptHelper#in_place_editor_field, and Javascript support from script.aculo.us #2038 [Jon Tirsen] Moved auto-completion and in-place editing into the Macros module and their helper counterparts into JavaScriptMacrosHelper

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@2191 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

3 files changed, 84 insertions, 47 deletions

diff --git a/actionpack/lib/action_controller/auto_complete.rb b/actionpack/lib/action_controller/auto_complete.rb
deleted file mode 100644
index dc58503eb8..0000000000
--- a/actionpack/lib/action_controller/auto_complete.rb
+++ /dev/null
@@ -1,47 +0,0 @@
-module ActionController
-  module AutoComplete #:nodoc:
-    def self.append_features(base) #:nodoc:
-      super
-      base.extend(ClassMethods)
-    end
-
-    # Example:
-    #
-    #   # Controller
-    #   class BlogController < ApplicationController
-    #     auto_complete_for :post, :title
-    #   end
-    #
-    #   # View
-    #   <%= text_field_with_auto_complete :post, title %>
-    #
-    # By default, auto_complete_for limits the results to 10 entries,
-    # and sorts by the given field.
-    # 
-    # auto_complete_for takes a third parameter, an options hash to
-    # the find method used to search for the records:
-    #
-    #   auto_complete_for :post, :title, :limit => 15, :order => 'created_at DESC'
-    #
-    # For help on defining text input fields with autocompletion, 
-    # see ActionView::Helpers::JavaScriptHelper.
-    #
-    # For more examples, see script.aculo.us:
-    # * http://script.aculo.us/demos/ajax/autocompleter
-    # * http://script.aculo.us/demos/ajax/autocompleter_customized
-    module ClassMethods
-      def auto_complete_for(object, method, options = {})
-        define_method("auto_complete_for_#{object}_#{method}") do
-          find_options = { 
-            :conditions => [ "LOWER(#{method}) LIKE ?", '%' + params[object][method].downcase + '%' ], 
-            :order => "#{method} ASC",
-            :limit => 10 }.merge!(options)
-            
-          @items = object.to_s.camelize.constantize.find(:all, find_options)
-
-          render :inline => "<%= auto_complete_result @items, '#{method}' %>"
-        end
-      end
-    end
-  end
-end
\ No newline at end of file
diff --git a/actionpack/lib/action_controller/macros/auto_complete.rb b/actionpack/lib/action_controller/macros/auto_complete.rb
new file mode 100644
index 0000000000..917f151e03
--- /dev/null
+++ b/actionpack/lib/action_controller/macros/auto_complete.rb
@@ -0,0 +1,52 @@
+module ActionController
+  # Macros are class-level calls that add pre-defined actions to the controller based on the parameters passed in.
+  # Currently, they're used to bridge the JavaScript macros, like autocompletion and in-place editing, with the controller
+  # backing.
+  module Macros
+    module AutoComplete #:nodoc:
+      def self.append_features(base) #:nodoc:
+        super
+        base.extend(ClassMethods)
+      end
+
+      # Example:
+      #
+      #   # Controller
+      #   class BlogController < ApplicationController
+      #     auto_complete_for :post, :title
+      #   end
+      #
+      #   # View
+      #   <%= text_field_with_auto_complete :post, title %>
+      #
+      # By default, auto_complete_for limits the results to 10 entries,
+      # and sorts by the given field.
+      # 
+      # auto_complete_for takes a third parameter, an options hash to
+      # the find method used to search for the records:
+      #
+      #   auto_complete_for :post, :title, :limit => 15, :order => 'created_at DESC'
+      #
+      # For help on defining text input fields with autocompletion, 
+      # see ActionView::Helpers::JavaScriptHelper.
+      #
+      # For more examples, see script.aculo.us:
+      # * http://script.aculo.us/demos/ajax/autocompleter
+      # * http://script.aculo.us/demos/ajax/autocompleter_customized
+      module ClassMethods
+        def auto_complete_for(object, method, options = {})
+          define_method("auto_complete_for_#{object}_#{method}") do
+            find_options = { 
+              :conditions => [ "LOWER(#{method}) LIKE ?", '%' + params[object][method].downcase + '%' ], 
+              :order => "#{method} ASC",
+              :limit => 10 }.merge!(options)
+            
+            @items = object.to_s.camelize.constantize.find(:all, find_options)
+
+            render :inline => "<%= auto_complete_result @items, '#{method}' %>"
+          end
+        end
+      end
+    end
+  end
+end
\ No newline at end of file
diff --git a/actionpack/lib/action_controller/macros/in_place_editing.rb b/actionpack/lib/action_controller/macros/in_place_editing.rb
new file mode 100644
index 0000000000..d096e57e9e
--- /dev/null
+++ b/actionpack/lib/action_controller/macros/in_place_editing.rb
@@ -0,0 +1,32 @@
+module ActionController
+  module Macros
+    module InPlaceEditing #:nodoc:
+      def self.append_features(base) #:nodoc:
+        super
+        base.extend(ClassMethods)
+      end
+
+      # 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