Merge pull request #680 from reactjs/controller-preprender-false

Controller preprender: false

Author: rmosolgo

README.md

@@ -224,7 +224,7 @@ end
 
 This custom renderer behaves the same as a normal view renderer and accepts the usual arguments - `content_type`, `layout`, `location` and `status`.
 By default, your current layout will be used and the component, rather than a view, will be rendered in place of `yield`. Custom data-* attributes
-can be passed like `data: {remote: true}`.
+can be passed like `data: {remote: true}`. Prerendering is set to `true` by default, but can be turned off like any other option: `prerender: false`.
 
 ### Component generator
 

lib/react/rails/controller_renderer.rb

@@ -3,7 +3,8 @@ module Rails
     # A renderer class suitable for `ActionController::Renderers`.
     # It is associated to `:component` in the Railtie.
     #
-    # It is prerendered with {React::ServerRendering}.
+    # It is prerendered by default with {React::ServerRendering}.
+    # Set options[:prerender] to `false` to disable prerendering.
     #
     # @example Rendering a component from a controller
     #   class TodosController < ApplicationController
@@ -24,12 +25,18 @@ def initialize(options={})
         @__react_component_helper = controller.__react_component_helper
       end
 
-      # @return [String] Prerendered HTML for `component_name` with `options[:props]`
+      # @return [String] HTML for `component_name` with `options[:props]`
       def call(component_name, options, &block)
         props = options.fetch(:props, {})
-        options = options.slice(:data, :aria, :tag, :class, :id).merge(prerender: true)
+        options = default_options.merge(options.slice(:data, :aria, :tag, :class, :id, :prerender))
         react_component(component_name, props, options, &block)
       end
+
+      private
+
+      def default_options
+        { prerender: true }
+      end
     end
   end
 end

test/dummy/app/controllers/server_controller.rb

@@ -15,12 +15,24 @@ def console_example_suppressed
     @todos = %w{todo1 todo2 todo3}
   end
 
-  def inline_component
-    render component: 'TodoList',
-           props: { todos: ['Render this inline'] },
-           tag: 'span',
-           class: 'custom-class',
-           id: 'custom-id',
-           data: { remote: true }
+  def inline_component_prerender_true
+    render(component_options)
+  end
+
+  def inline_component_prerender_false
+    render(component_options.merge(prerender: false))
+  end
+
+  private
+
+  def component_options
+    {
+      component: 'TodoList',
+      props: { todos: ['Render this inline'] },
+      tag: 'span',
+      class: 'custom-class',
+      id: 'custom-id',
+      data: { remote: true }
+    }
   end
 end

test/dummy/config/routes.rb

@@ -4,7 +4,8 @@
     collection do
       get :console_example
       get :console_example_suppressed
-      get :inline_component
+      get :inline_component_prerender_true
+      get :inline_component_prerender_false
     end
   end
 end

test/server_rendered_html_test.rb

@@ -53,8 +53,8 @@ def wait_to_ensure_asset_pipeline_detects_changes
       assert_no_match(/console.error/, response.body)
     end
 
-    test 'react inline component rendering' do
-      get '/server/inline_component'
+    test 'react inline component rendering (pre-rendered)' do
+      get '/server/inline_component_prerender_true'
       rendered_html = response.body
       assert_match(/<span.*data-react-class=\"TodoList\"/, rendered_html)
       # make sure that the items are prerendered
@@ -67,5 +67,12 @@ def wait_to_ensure_asset_pipeline_detects_changes
       assert_match(/id=\"custom-id\"/, rendered_html)
       assert_match(/data-remote=\"true\"/, rendered_html)
     end
+
+    test 'react inline component rendering (not pre-rendered)' do
+      get '/server/inline_component_prerender_false'
+      rendered_html = response.body
+      # make sure the tag closes immediately:
+      assert_match(/<span.*data-react-class=\"TodoList\"[^<]*><\/span>/, rendered_html)
+    end
   end
 end