react_on_rails 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47bf68c00a2b017047097d27b50e92d6f417b071
-  data.tar.gz: 9eca8eecbee44ad2c857680735b44e61027f365c
+  metadata.gz: 4a68c1b72267dce9d0864c0e21429df7e89011e8
+  data.tar.gz: 1bbf750bdf7b128fba4c393a7716b2eef962674e
 SHA512:
-  metadata.gz: 566649c85b68a57e26d9ac79bcd9f2b23802c288eb15c4032542fdbe96bf79b6fd9121ced75bb73fe28e1d20ba235e0b155e10d00ac5ae63a64d8db6aa2e4781
-  data.tar.gz: 4ca24d4f09242dd39d0c7842a3c9383c47f9515720bb78a5dd6e575ec0657d293ab2f343000db7d6a4df4306a159374e77d9e67a7afd67650bae3d7d14b7a3b4
+  metadata.gz: 82077ea1833158fb45c76c6ab5de0235e42f753257ff7f9a254938db05b2fe9a4262a126f729224a1be1f838139866111e0cefd6a4068f075c96b32dbb3ee616
+  data.tar.gz: b0f8347d48219798ceffede4bd9d83c5eeb9b8f0509913fac16a6ab22a5b5dc2eb6d9bff094ce1ce7a23f2bcbf6555245dcbc43c388cb335dc91edc3c8536321

data/README.md

@@ -102,6 +102,7 @@ Params are:
   * **prerender**: <true/false> set to false when debugging!
   * **trace**: <true/false> set to true to print additional debugging information in the browser default is true for development, off otherwise 
   * **replay_console**: <true/false> Default is true. False will disable echoing server rendering logs, which can make troubleshooting server rendering difficult.
+  * Any other options are passed to the content tag, including the id. 
 
 ## JavaScript
 
@@ -157,6 +158,7 @@ ReactOnRails.configure do |config|
 
   # For server rendering. This can be set to false so that server side messages are discarded.
   config.replay_console = true # Default is true. Be cautious about turning this off.
+  config.logging_on_server = true # Default is true. Logs server rendering messags to Rails.logger.info
 end
 ```
 
@@ -284,6 +286,10 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 See https://github.com/svenfuchs/gem-release
 
+```bash
+gem bump --tag --release
+```
+
 # Authors
 The Shaka Code team!
 

data/app/helpers/react_on_rails_helper.rb

@@ -30,7 +30,10 @@ module ReactOnRailsHelper
   #    trace: <true/false> set to true to print additional debugging information in the browser
   #           default is true for development, off otherwise
   #    replay_console: <true/false> Default is true. False will disable echoing server rendering
-  #                    logs, which can make troubleshooting server rendering difficult.
+  #                    logs to browser. While this can make troubleshooting server rendering difficult,
+  #                    so long as you have the default configuration of logging_on_server set to
+  #                    true, you'll still see the errors on the server.
+  #  Any other options are passed to the content tag, including the id.
   def react_component(component_name, props = {}, options = {})
     # Create the JavaScript and HTML to allow either client or server rendering of the
     # react_component.
@@ -41,16 +44,21 @@ module ReactOnRailsHelper
     # We use this react_component_index in case we have the same component multiple times on the page.
     react_component_index = next_react_component_index
     react_component_name = component_name.camelize # Not sure if we should be doing this (JG)
-    dom_id = "#{component_name}-react-component-#{react_component_index}"
+    if options[:id].nil?
+      dom_id = "#{component_name}-react-component-#{react_component_index}"
+    else
+      dom_id = options[:id]
+    end
 
     # Setup the page_loaded_js, which is the same regardless of prerendering or not!
     # The reason is that React is smart about not doing extra work if the server rendering did its job.
     data_variable_name = "__#{component_name.camelize(:lower)}Data#{react_component_index}__"
     turbolinks_loaded = Object.const_defined?(:Turbolinks)
     install_render_events = turbolinks_loaded ? turbolinks_bootstrap(dom_id) : non_turbolinks_bootstrap
+    props_string = props.is_a?(String) ? props : props.to_json
     page_loaded_js = <<-JS
 (function() {
-  window.#{data_variable_name} = #{props.to_json};
+  window.#{data_variable_name} = #{props_string};
 #{define_render_if_dom_node_present(react_component_name, data_variable_name, dom_id,
                                     trace(options), generator_function(options))}
 #{install_render_events}
@@ -61,18 +69,23 @@ module ReactOnRailsHelper
 
     # Create the HTML rendering part
     server_rendered_html, console_script =
-      server_rendered_react_component_html(options, props, react_component_name,
+      server_rendered_react_component_html(options, props_string, react_component_name,
                                            data_variable_name, dom_id)
 
+    content_tag_options = options.except(:generator_function, :prerender, :trace,
+                                         :replay_console, :id, :react_component_name,
+                                         :server_side)
+    content_tag_options[:id] = dom_id
+
     rendered_output = content_tag(:div,
                                   server_rendered_html,
-                                  id: dom_id)
+                                  content_tag_options)
 
     # IMPORTANT: Ensure that we mark string as html_safe to avoid escaping.
     <<-HTML.html_safe
 #{data_from_server_script_tag}
 #{rendered_output}
-#{console_script}
+#{replay_console(options) ? console_script : ""}
     HTML
   end
 
@@ -82,12 +95,12 @@ module ReactOnRailsHelper
   end
 
   # Returns Array [0]: html, [1]: script to console log
-  def server_rendered_react_component_html(options, props, react_component_name, data_variable, dom_id)
+  def server_rendered_react_component_html(options, props_string, react_component_name, data_variable, dom_id)
     if prerender(options)
       render_js_expression = <<-JS
 (function(React) {
         #{debug_js(react_component_name, data_variable, dom_id, trace(options))}
-        var reactElement = #{render_js_react_element(react_component_name, props.to_json, generator_function(options))}
+        var reactElement = #{render_js_react_element(react_component_name, props_string, generator_function(options))}
         return React.renderToString(reactElement);
       })(this.React);
       JS
@@ -135,6 +148,10 @@ module ReactOnRailsHelper
     options.fetch(:prerender) { ReactOnRails.configuration.prerender }
   end
 
+  def replay_console(options)
+    options.fetch(:replay_console) { ReactOnRails.configuration.replay_console }
+  end
+
   def debug_js(react_component_name, data_variable, dom_id, trace)
     if trace
       "console.log(\"RENDERED #{react_component_name} with data_variable"\

data/lib/react_on_rails/configuration.rb

@@ -8,16 +8,18 @@ module ReactOnRails
       server_bundle_js_file: "app/assets/javascripts/generated/server.js",
       prerender: false,
       replay_console: true,
+      logging_on_server: true,
       generator_function: false,
-      trace: Rails.env.development?
+      trace: Rails.env.development?,
     )
   end
 
   class Configuration
-    attr_accessor :server_bundle_js_file, :prerender, :replay_console, :generator_function, :trace
+    attr_accessor :server_bundle_js_file, :prerender, :replay_console, :generator_function, :trace,
+                  :logging_on_server
 
     def initialize(server_bundle_js_file: nil, prerender: nil, replay_console: nil,
-                   generator_function: nil, trace: nil)
+                   generator_function: nil, trace: nil, logging_on_server: nil)
       if File.exist?(server_bundle_js_file)
         self.server_bundle_js_file = server_bundle_js_file
       else
@@ -26,6 +28,7 @@ module ReactOnRails
 
       self.prerender = prerender
       self.replay_console = replay_console
+      self.logging_on_server = logging_on_server
       self.generator_function = generator_function
       self.trace = trace.nil? ? Rails.env.development? : trace
     end

data/lib/react_on_rails/react_renderer.rb

@@ -76,7 +76,20 @@ var console = { history: [] };
         json_string = ExecJS.eval(js_code_wrapper)
       end
       # element 0 is the html, element 1 is the script tag for the server console output
-      JSON.parse(json_string)
+      result = JSON.parse(json_string)
+      if ReactOnRails.configuration.logging_on_server
+        console_script = result[1]
+        console_script_lines = console_script.split("\n")
+        console_script_lines = console_script_lines[2..-2]
+        re = /console\.log\.apply\(console, \["\[SERVER\] (?<msg>.*)"\]\);/
+        console_script_lines.each do |line|
+          match = re.match(line)
+          if match
+            Rails.logger.info { "[react_on_rails] #{match[:msg]}"}
+          end
+        end
+      end
+      return result
     end
 
     def self.wrap_code_with_exception_handler(js_code, component_name)
@@ -134,7 +147,7 @@ var console = { history: [] };
     end
 
     def console_replay_js_code
-      @replay_console ? CONSOLE_REPLAY : ""
+      (@replay_console || ReactOnRails.configuration.logging_on_server) ? CONSOLE_REPLAY : ""
     end
 
     def base_js_code(bundle_js_code)

data/lib/react_on_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactOnRails
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Justin Gordon