Class: React::ServerRendering::BundleRenderer

Inherits:
ExecJSRenderer show all
Defined in:
lib/react/server_rendering/bundle_renderer.rb

Overview

Extends ExecJSRenderer for the Rails environment

  • fetches JS code from the Rails app (Shakapacker or Sprockets)

  • stringifies props

  • implements console replay

Constant Summary collapse

CONSOLE_POLYFILL =

Reimplement console methods for replaying on the client

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"))
CONSOLE_RESET = 
File.read(File.join(File.dirname(__FILE__), "bundle_renderer/console_reset.js"))
TIMEOUT_POLYFILL = 
File.read(File.join(File.dirname(__FILE__), "bundle_renderer/timeout_polyfill.js"))

Constants inherited from ExecJSRenderer

ExecJSRenderer::GLOBAL_WRAPPER

Class Attribute Summary collapse

Attributes inherited from ExecJSRenderer

#context

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ BundleRenderer

Returns a new instance of BundleRenderer.



21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/react/server_rendering/bundle_renderer.rb', line 21

def initialize(options = {})
  @replay_console = options.fetch(:replay_console, true)
  filenames = options.fetch(:files, ["server_rendering.js"])
  js_code = CONSOLE_POLYFILL.dup
  js_code << TIMEOUT_POLYFILL.dup
  js_code << options.fetch(:code, "")

  filenames.each do |filename|
    js_code << asset_container.find_asset(filename)
  end

  super(options.merge(code: js_code))
end

Class Attribute Details

.asset_container_class ⇒ Object

Returns the value of attribute asset_container_class.



54
55
56
 
# File 'lib/react/server_rendering/bundle_renderer.rb', line 54

def asset_container_class
  @asset_container_class
end

Instance Method Details

#after_render(_component_name, _props, _prerender_options) ⇒ Object 



49
50
51
 
# File 'lib/react/server_rendering/bundle_renderer.rb', line 49

def after_render(_component_name, _props, _prerender_options)
  @replay_console ? CONSOLE_REPLAY : ""
end

#asset_container ⇒ #find_asset(logical_path)

Get an object which exposes assets by their logical path.

Out of the box, it supports a Sprockets::Environment (application.assets) and a Sprockets::Manifest (application.assets_manifest), which covers the default Rails setups.

You can provide a custom asset container with ‘React::ServerRendering::BundleRenderer.asset_container_class = MyAssetContainer`.

Returns:

  • (#find_asset(logical_path)) —

    An object that returns asset contents by logical path



67
68
69
 
# File 'lib/react/server_rendering/bundle_renderer.rb', line 67

def asset_container
  @asset_container ||= asset_container_class.new
end

#before_render(_component_name, _props, _prerender_options) ⇒ Object 



45
46
47
 
# File 'lib/react/server_rendering/bundle_renderer.rb', line 45

def before_render(_component_name, _props, _prerender_options)
  @replay_console ? CONSOLE_RESET : ""
end

#render(component_name, props, prerender_options) ⇒ Object

Prerender options are expected to be a Hash however might also be a symbol. pass prerender: :static to use renderToStaticMarkup pass prerender: true to enable default prerender pass prerender: {} to proxy some custom options



39
40
41
42
43
 
# File 'lib/react/server_rendering/bundle_renderer.rb', line 39

def render(component_name, props, prerender_options)
  t_options = prepare_options(prerender_options)
  t_props = prepare_props(props)
  super(component_name, t_props, t_options)
end