Changeset 3078

Timestamp:

11/17/05 21:28:59 (3 years ago)

Author:

marcel

Message:

Add support for new rjs templates which wrap an update_page block.

Files:

• trunk/actionpack/CHANGELOG (modified) (1 diff)
• trunk/actionpack/lib/action_view/base.rb (modified) (10 diffs)
• trunk/actionpack/test/controller/new_render_test.rb (modified) (2 diffs)
• trunk/actionpack/test/fixtures/test/delete_with_js.rjs (added)

trunk/actionpack/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Add support for new rjs templates which wrap an update_page block. [Marcel Molina Jr.]
-
-* Rename Version constant to VERSION. #2802 [Marcel Molina Jr.]

trunk/actionpack/lib/action_view/base.rb

@@ -6 +6 @@
-  end
-
-
-
+
+
+
-  # 
-  # = ERb
@@ -74 +75 @@
-  #   xml.em { xml.b("emp & bold") }                    # => <em><b>emph &amp; bold</b></em>
-  #   xml.a("A Link", "href"=>"http://onestepback.org") # => <a href="http://onestepback.org">A Link</a>
-.target("name"=>"compile", "option"=>"fast") 
+l.target("name"=>"compile", "option"=>"fast")
-  #                                                     # NOTE: order of attributes is not specified.
-  # 
@@ -116 +117 @@
-  #
-  # More builder documentation can be found at http://builder.rubyforge.org.
+  #
+  # == JavaScriptGenerator
+  #
+  # JavaScriptGenerator templates end in +.rjs+. Unlike conventional templates which are used to 
+  # render the results of an action, these templates generate instructions on how to modify an already rendered page. This makes it easy to 
+  # modify multiple elements on your page in one declarative Ajax response. Actions with these templates are called in the background with Ajax 
+  # and make updates to the page where the request originated from.
+  # 
+  # An instance of the JavaScriptGenerator object named +page+ is automatically made available to your template, which is implicitly wrapped in an ActionView::Helpers::PrototypeHelper#update_page block. 
+  #
+  # When an .rjs action is called with +link_to_remote+, the generated JavaScript is automatically evaluated.  Example:
+  #
+  #   link_to_remote :url => {:action => 'delete'}
+  #
+  # The subsequently rendered +delete.rjs+ might look like:
+  #
+  #   page.replace_html  'sidebar', :partial => 'sidebar'
+  #   page.remove        "person-#{@person.id}"
+  #   page.visual_effect :highlight, 'user-list' 
+  #
+  # This refreshes the sidebar, removes a person element and highlights the user list.
+  # 
+  # See the ActionView::Helpers::PrototypeHelper::JavaScriptGenerator documentation for more details.
-  class Base
-    include ERB::Util
@@ -274 +298 @@
-      if match = delegate_template_exists?(template_path)
-        match.first
-
-
-
-
+
+
+
-      else
-
+rjs 
-      end
-    end
@@ -294 +317 @@
-      template_exists?(template_path, :rxml)
-    end
+    
+    def javascript_template_exists?(template_path)#:nodoc:
+      template_exists?(template_path, :rjs)
+    end
-
-    def file_exists?(template_path)#:nodoc:
-
+
+
+
-    end
-
@@ -346 +375 @@
-      # Or if the file has changed on disk and checking file mods hasn't been disabled. 
-      def compile_template?(template, file_name, local_assigns)
-
+   
-        render_symbol = @@method_names[method_key]
-
@@ -360 +389 @@
-      # Create source code for given template
-      def create_template_source(extension, template, render_symbol, locals)
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-        else
-          body = ERB.new(template, nil, @@erb_trim_mode).src
@@ -380 +415 @@
-      end
-
+      def template_requires_setup?(extension)
+        templates_requiring_setup.include? extension.to_s
+      end
+
+      def templates_requiring_setup
+        %w(rxml rjs)
+      end
+
-      def assign_method_name(extension, template, file_name)
-        method_name = '_run_'
-
-
-
-
-
-
+
-
-        if file_name
@@ -397 +435 @@
-
-          method_name_file_part = i ? file_path[i+l+1,file_path.length-l-1] : file_path.clone
-|x)ml
+ml|xml|js)
-          method_name_file_part.tr!('/:-', '_')
-          method_name_file_part.gsub!(/[^a-zA-Z0-9_]/){|s| s[0].to_s}
@@ -417 +455 @@
-
-        line_offset = @@template_args[render_symbol].size
-
-
+
+
+
+
+
+
+
-        begin
-          unless file_name.blank?

trunk/actionpack/test/controller/new_render_test.rb

@@ -153 +153 @@
-    def @template.name() nil end
-    render :action => "potential_conflicts"
+  end
+
+  def delete_with_js
+    @project_id = 4
+  end
+
+  def render_js_with_explicit_template
+    @project_id = 4
+    render :template => 'test/delete_with_js'
+  end
+
+  def render_js_with_explicit_action_template
+    @project_id = 4
+    render :action => 'delete_with_js'
-  end
-
@@ -280 +294 @@
-  end
-
+  def test_render_rjs_with_default
+    get :delete_with_js
+    assert_equal %!["person"].each(Element.remove);\nnew Effect.Highlight('project-4',{});!, @response.body
+  end
+
+  def test_render_rjs_template_explicitly
+    get :render_js_with_explicit_template
+    assert_equal %!["person"].each(Element.remove);\nnew Effect.Highlight('project-4',{});!, @response.body
+  end
+
+  def test_rendering_rjs_action_explicitly
+    get :render_js_with_explicit_action_template
+    assert_equal %!["person"].each(Element.remove);\nnew Effect.Highlight('project-4',{});!, @response.body
+  end
+
-  def test_layout_rendering
-    get :layout_test