refactor(BundleRenderer) rename SprocketsRenderer -> BundleRenderer since it also supports webpacker

Author: rmosolgo

README.md

@@ -288,7 +288,7 @@ MyApp::Application.configure do
   # Settings for the pool of renderers:
   config.react.server_renderer_pool_size  ||= 1  # ExecJS doesn't allow more than one on MRI
   config.react.server_renderer_timeout    ||= 20 # seconds
-  config.react.server_renderer = React::ServerRendering::SprocketsRenderer
+  config.react.server_renderer = React::ServerRendering::BundleRenderer
   config.react.server_renderer_options = {
     files: ["server_rendering.js"],       # files to load for prerendering
     replay_console: true,                 # if true, console.* will be replayed client-side
@@ -306,14 +306,14 @@ end
 - `#initialize(options={})`, which accepts the hash from `config.react.server_renderer_options`
 - `#render(component_name, props, prerender_options)` to return a string of HTML
 
-`react-rails` provides two renderer classes: `React::ServerRendering::ExecJSRenderer` and `React::ServerRendering::SprocketsRenderer`.
+`react-rails` provides two renderer classes: `React::ServerRendering::ExecJSRenderer` and `React::ServerRendering::BundleRenderer`.
 
 `ExecJSRenderer` offers two other points for extension:
 
 - `#before_render(component_name, props, prerender_options)` to return a string of JavaScript to execute _before_ calling `React.render`
 - `#after_render(component_name, props, prerender_options)` to return a string of JavaScript to execute _after_ calling `React.render`
 
-Any subclass of `ExecJSRenderer` may use those hooks (for example, `SprocketsRenderer` uses them to handle `console.*` on the server).
+Any subclass of `ExecJSRenderer` may use those hooks (for example, `BundleRenderer` uses them to handle `console.*` on the server).
 
 ## Controller Actions
 

lib/react/rails/railtie.rb

@@ -15,8 +15,8 @@ class Railtie < ::Rails::Railtie
       # Server rendering:
       config.react.server_renderer_pool_size  = 1   # increase if you're on JRuby
       config.react.server_renderer_timeout    = 20  # seconds
-      config.react.server_renderer            = nil # defaults to SprocketsRenderer
-      config.react.server_renderer_options    = {}  # SprocketsRenderer provides defaults
+      config.react.server_renderer            = nil # defaults to BundleRenderer
+      config.react.server_renderer_options    = {}  # BundleRenderer provides defaults
       # Changing files with these extensions in these directories will cause the server renderer to reload:
       config.react.server_renderer_directories = ["/app/assets/javascripts/"]
       config.react.server_renderer_extensions = ["jsx"]
@@ -96,7 +96,7 @@ class Railtie < ::Rails::Railtie
 
       config.after_initialize do |app|
         # The class isn't accessible in the configure block, so assign it here if it wasn't overridden:
-        app.config.react.server_renderer ||= React::ServerRendering::SprocketsRenderer
+        app.config.react.server_renderer ||= React::ServerRendering::BundleRenderer
 
         React::ServerRendering.pool_size        = app.config.react.server_renderer_pool_size
         React::ServerRendering.pool_timeout     = app.config.react.server_renderer_timeout

lib/react/server_rendering.rb

@@ -1,6 +1,6 @@
 require 'connection_pool'
 require 'react/server_rendering/exec_js_renderer'
-require 'react/server_rendering/sprockets_renderer'
+require 'react/server_rendering/bundle_renderer'
 
 module React
   module ServerRendering

…t/server_rendering/sprockets_renderer.rb …eact/server_rendering/bundle_renderer.rblib/react/server_rendering/sprockets_renderer.rb renamed to lib/react/server_rendering/bundle_renderer.rb lib/react/server_rendering/sprockets_renderer.rb renamed to lib/react/server_rendering/bundle_renderer.rb

@@ -6,14 +6,14 @@
 module React
   module ServerRendering
     # Extends ExecJSRenderer for the Rails environment
-    # - builds JS code out of the asset pipeline
+    # - fetches JS code from the Rails app (webpacker or sprockets)
     # - stringifies props
     # - implements console replay
-    class SprocketsRenderer < ExecJSRenderer
+    class BundleRenderer < ExecJSRenderer
       # Reimplement console methods for replaying on the client
-      CONSOLE_POLYFILL = File.read(File.join(File.dirname(__FILE__), "sprockets_renderer/console_polyfill.js"))
-      CONSOLE_REPLAY   = File.read(File.join(File.dirname(__FILE__), "sprockets_renderer/console_replay.js"))
-      TIMEOUT_POLYFILL = File.read(File.join(File.dirname(__FILE__), "sprockets_renderer/timeout_polyfill.js"))
+      CONSOLE_POLYFILL = File.read(File.join(File.dirname(__FILE__), "bundle_renderer/console_polyfill.js"))
+      CONSOLE_REPLAY   = File.read(File.join(File.dirname(__FILE__), "bundle_renderer/console_replay.js"))
+      TIMEOUT_POLYFILL = File.read(File.join(File.dirname(__FILE__), "bundle_renderer/timeout_polyfill.js"))
 
       def initialize(options={})
         @replay_console = options.fetch(:replay_console, true)
@@ -54,7 +54,7 @@ class << self
       # default Rails setups.
       #
       # You can provide a custom asset container
-      # with `React::ServerRendering::SprocketsRenderer.asset_container_class = MyAssetContainer`.
+      # with `React::ServerRendering::BundleRenderer.asset_container_class = MyAssetContainer`.
       #
       # @return [#find_asset(logical_path)] An object that returns asset contents by logical path
       def asset_container

…g/sprockets_renderer/console_polyfill.js …ring/bundle_renderer/console_polyfill.jslib/react/server_rendering/sprockets_renderer/console_polyfill.js renamed to lib/react/server_rendering/bundle_renderer/console_polyfill.js lib/react/server_rendering/sprockets_renderer/console_polyfill.js renamed to lib/react/server_rendering/bundle_renderer/console_polyfill.js

@@ -72,7 +72,7 @@ class ComponentMountTest < ActionDispatch::IntegrationTest
       assert(html.include?('data-reactid'), "it includes React properties")
     end
 
-    test '#react_component passes :static to SprocketsRenderer' do
+    test '#react_component passes :static to BundleRenderer' do
       html = @helper.react_component('Todo', {todo: 'render on the server'}.to_json, prerender: :static)
       assert(html.include?('>render on the server</li>'), "it includes rendered HTML")
       assert(!html.include?('data-reactid'), "it DOESNT INCLUDE React properties")

…ing/sprockets_renderer/console_replay.js …dering/bundle_renderer/console_replay.jslib/react/server_rendering/sprockets_renderer/console_replay.js renamed to lib/react/server_rendering/bundle_renderer/console_replay.js lib/react/server_rendering/sprockets_renderer/console_replay.js renamed to lib/react/server_rendering/bundle_renderer/console_replay.js

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 if SprocketsHelpers.available? || WebpackerHelpers.available?
-  class SprocketsRendererTest < ActiveSupport::TestCase
+  class BundleRendererTest < ActiveSupport::TestCase
     CALLBACKS = [:before_render, :after_render]
 
     webpacker_compiled = false
@@ -10,7 +10,7 @@ class SprocketsRendererTest < ActiveSupport::TestCase
         WebpackerHelpers.compile
         webpacker_compiled = true
       end
-      @renderer = React::ServerRendering::SprocketsRenderer.new({})
+      @renderer = React::ServerRendering::BundleRenderer.new({})
     end
 
     CALLBACKS.each do |callback_name|
@@ -56,7 +56,7 @@ class SprocketsRendererTest < ActiveSupport::TestCase
     end
 
     test '#render console messages can be disabled' do
-      no_log_renderer = React::ServerRendering::SprocketsRenderer.new({replay_console: false})
+      no_log_renderer = React::ServerRendering::BundleRenderer.new({replay_console: false})
       result = no_log_renderer.render("TodoListWithConsoleLog", {todos: ["log some messages"]}, nil)
       assert_no_match(/console.log.apply\(console, \["got initial state"\]\)/, result)
       assert_no_match(/console.warn.apply\(console, \["mounted component"\]\)/, result)
@@ -93,14 +93,14 @@ class SprocketsRendererTest < ActiveSupport::TestCase
       test '.new accepts additional code to add to the JS context' do
         additional_code = File.read(File.expand_path("../../../helper_files/WithoutSprockets.js", __FILE__))
 
-        additional_renderer = React::ServerRendering::SprocketsRenderer.new(code: additional_code)
+        additional_renderer = React::ServerRendering::BundleRenderer.new(code: additional_code)
 
         assert_match(/drink more caffeine<\/span>/, additional_renderer.render("WithoutSprockets", {label: "drink more caffeine"}, nil))
       end
 
       # These use cases don't apply to Webpacker since the require.context comes from a pack:
       test '.new accepts any filenames' do
-        limited_renderer = React::ServerRendering::SprocketsRenderer.new(files: ["react-server.js", "react_ujs.js", "components/Todo.js"])
+        limited_renderer = React::ServerRendering::BundleRenderer.new(files: ["react-server.js", "react_ujs.js", "components/Todo.js"])
         assert_match(/get a real job<\/li>/, limited_renderer.render("Todo", {todo: "get a real job"}, nil))
         err = assert_raises React::ServerRendering::PrerenderError do
           limited_renderer.render("TodoList", {todos: []}, nil)
@@ -117,7 +117,7 @@ class SprocketsRendererTest < ActiveSupport::TestCase
 
           Rails.application.config.assets.compile = false
 
-          @renderer = React::ServerRendering::SprocketsRenderer.new(files: legacy_rendering_files)
+          @renderer = React::ServerRendering::BundleRenderer.new(files: legacy_rendering_files)
 
           result = @renderer.render("Todo", {todo: "write tests"}, nil)
           assert_match(/<li.*write tests<\/li>/, result)