refactor(controller_lifecycle) simplify per-request renderer API; fix tests for all Rails version

Author: rmosolgo

lib/react/rails/component_mount.rb

@@ -49,30 +49,12 @@ def react_component(name, props = {}, options = {}, &block)
         content_tag(html_tag, '', html_options, &block)
       end
 
-      module ControllerHelpers
-        extend ActiveSupport::Concern
-
-        included do
-          # An instance of a server renderer, for use during this request
-          attr_accessor :__prerenderer
-        end
-
-        # If you want a per-request renderer, add this method as an around-action
-        #
-        # @example Having one renderer instance for each controller action
-        #   around_action :per_request_react_prerenderer
-        def per_request_react_prerenderer
-          React::ServerRendering.with_renderer do |renderer|
-            self.__prerenderer = renderer
-            yield
-          end
-        end
-      end
-
       private
 
+      # If this controller has checked out a renderer, use that one.
+      # Otherwise, use {React::ServerRendering} directly (which will check one out for this rendering).
       def prerender_component(component_name, props, prerender_options)
-        renderer = @controller.try(:__prerenderer) || React::ServerRendering
+        renderer = @controller.try(:react_rails_prerenderer) || React::ServerRendering
         renderer.render(component_name, props, prerender_options)
       end
     end

lib/react/rails/controller_lifecycle.rb

@@ -12,6 +12,15 @@ module ControllerLifecycle
         attr_reader :__react_component_helper
       end
 
+      module ClassMethods
+        # Call this in the controller to check out a prerender for the whole request.
+        # You can access the renderer with {#react_rails_prerenderer}.
+        def per_request_react_rails_prerenderer
+          around_action_with_fallback = respond_to?(:around_action) ? :around_action : :around_filter
+          public_send(around_action_with_fallback, :per_request_react_rails_prerenderer)
+        end
+      end
+
       # Instantiate the ViewHelper implementation and call its #setup method
       # then let the controller action run,
       # then call the ViewHelper implementation's #teardown method
@@ -22,6 +31,24 @@ def use_react_component_helper
         yield
         @__react_component_helper.teardown(self)
       end
+
+      # If you want a per-request renderer, add this method as an around-action
+      #
+      # (`.per_request_react_rails_prerenderer` does this for you)
+      # @example Having one renderer instance for each controller action
+      #   around_action :per_request_react_rails_prerenderer
+      def per_request_react_rails_prerenderer
+        React::ServerRendering.with_renderer do |renderer|
+          @__react_rails_prerenderer = renderer
+          yield
+        end
+      end
+
+
+      # An instance of a server renderer, for use during this request
+      def react_rails_prerenderer
+        @__react_rails_prerenderer
+      end
     end
   end
 end

lib/react/rails/railtie.rb

@@ -38,7 +38,6 @@ class Railtie < ::Rails::Railtie
 
         ActiveSupport.on_load(:action_controller) do
           include ::React::Rails::ControllerLifecycle
-          include ::React::Rails::ComponentMount::ControllerHelpers
         end
 
         ActiveSupport.on_load(:action_view) do

test/dummy/app/controllers/pages_controller.rb

@@ -1,10 +1,10 @@
 class PagesController < ApplicationController
-  around_action :per_request_react_prerenderer
+  per_request_react_rails_prerenderer
 
   def show
     @prerender = !!params[:prerender]
     if @prerender
-      js_context = __prerenderer.context
+      js_context = react_rails_prerenderer.context
       # This isn't safe for production, we're just testing the render context:
       greeting_override = params[:greeting] || ""
       setup_code = "global.ctx = {}; global.ctx.greeting = '#{greeting_override}';"

test/react/rails/component_mount_test.rb

@@ -98,12 +98,12 @@ def self.render(component_name, props, prerender_options)
     end
 
     module DummyController
-      def self.__prerenderer
+      def self.react_rails_prerenderer
         DummyRenderer
       end
     end
 
-    test "it uses the controller's __prerenderer, if available" do
+    test "it uses the controller's react_rails_prerenderer, if available" do
       @helper.setup(DummyController)
       rendered_component = @helper.react_component('Foo', {"ok" => true}, prerender: :static)
       assert_equal %|<div>rendered Foo with {&quot;ok&quot;:true}</div>|, rendered_component