react_on_rails 11.1.7 → 11.3.1.beta.0

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -36,6 +36,7 @@ module ReactOnRails
 
       def replace_prerender_if_server_rendering
         return unless options.example_server_rendering
+
         hello_world_index = File.join(destination_root, "app", "views", "hello_world", "index.html.erb")
         hello_world_contents = File.read(hello_world_index)
         new_hello_world_contents = hello_world_contents.gsub(/prerender: false/,

data/lib/generators/react_on_rails/install_generator.rb

@@ -62,6 +62,7 @@ module ReactOnRails
 
       def missing_yarn?
         return false unless ReactOnRails::Utils.running_on_windows? ? `where yarn`.blank? : `which yarn`.blank?
+
         error = "yarn is required. Please install it before continuing. https://yarnpkg.com/en/docs/install"
         GeneratorMessages.add_error(error)
         true
@@ -69,6 +70,7 @@ module ReactOnRails
 
       def missing_node?
         return false unless ReactOnRails::Utils.running_on_windows? ? `where node`.blank? : `which node`.blank?
+
         error = "** nodejs is required. Please install it before continuing. https://nodejs.org/en/"
         GeneratorMessages.add_error(error)
         true

data/lib/react_on_rails.rb

@@ -11,6 +11,7 @@ require "react_on_rails/version"
 require "react_on_rails/version_checker"
 require "react_on_rails/configuration"
 require "react_on_rails/server_rendering_pool"
+require "react_on_rails/server_rendering_js_code"
 require "react_on_rails/engine"
 require "react_on_rails/react_component/render_options"
 require "react_on_rails/version_syntax_converter"

data/lib/react_on_rails/assets_precompile.rb

@@ -64,6 +64,7 @@ module ReactOnRails
       # references from webpack's CSS would be invalid. The fix is to symlink the double-digested
       # file back to the original digested name, and make a similar symlink for the gz version.
       return unless @symlink_non_digested_assets_regex
+
       manifest_glob = Dir.glob(@assets_path.join(".sprockets-manifest-*.json")) +
                       Dir.glob(@assets_path.join("manifest-*.json")) +
                       Dir.glob(@assets_path.join("manifest.yml"))
@@ -86,6 +87,7 @@ module ReactOnRails
       manifest_data.each do |original_filename, rails_digested_filename|
         # TODO: we should remove any original_filename that is NOT in the webpack deploy folder.
         next unless original_filename =~ @symlink_non_digested_assets_regex
+
         # We're symlinking from the digested filename back to the original filename which has
         # already been symlinked by Webpack
         symlink_file(rails_digested_filename, original_filename)
@@ -100,6 +102,7 @@ module ReactOnRails
     def delete_broken_symlinks
       Dir.glob(@assets_path.join("*")).each do |filename|
         next unless File.lstat(filename).symlink?
+
         begin
           target = File.readlink(filename)
         rescue StandardError

data/lib/react_on_rails/configuration.rb

@@ -21,7 +21,7 @@ module ReactOnRails
       prerender: false,
       replay_console: true,
       logging_on_server: true,
-      raise_on_prerender_error: false,
+      raise_on_prerender_error: Rails.env.development?,
       trace: Rails.env.development?,
       development_mode: Rails.env.development?,
       server_renderer_pool_size: DEFAULT_POOL_SIZE,
@@ -218,6 +218,7 @@ module ReactOnRails
 
     def configure_skip_display_none_deprecation
       return if skip_display_none.nil?
+
       Rails.logger.warn "[DEPRECATION] ReactOnRails: remove skip_display_none from configuration."
     end
   end

data/lib/react_on_rails/git_utils.rb

@@ -6,8 +6,10 @@ module ReactOnRails
   module GitUtils
     def self.uncommitted_changes?(message_handler)
       return false if ENV["COVERAGE"] == "true"
+
       status = `git status --porcelain`
       return false if $CHILD_STATUS.success? && status.empty?
+
       error = if !$CHILD_STATUS.success?
                 "You do not have Git installed. Please install Git, and commit your changes before continuing"
               else

data/lib/react_on_rails/helper.rb

@@ -136,7 +136,7 @@ module ReactOnRails
     # It is exactly like react_component except for the following:
     # 1. prerender: true is automatically added, as this method doesn't make sense for client only
     #    rendering.
-    # 2. Your JavaScript for server rendering must return an Object for the key server_rendered_html.
+    # 2. Your JavaScript generator function for server rendering must return an Object rather than a React component.
     # 3. Your view code must expect an object and not a string.
     #
     # Here is an example of the view code:
@@ -206,6 +206,7 @@ module ReactOnRails
     # that contains a data props.
     def redux_store_hydration_data
       return if @registered_stores_defer_render.blank?
+
       @registered_stores_defer_render.reduce("".dup) do |accum, redux_store_data|
         accum << render_redux_store_data(redux_store_data)
       end.html_safe
@@ -265,6 +266,7 @@ module ReactOnRails
 
     def json_safe_and_pretty(hash_or_string)
       return "{}" if hash_or_string.nil?
+
       unless hash_or_string.is_a?(String) || hash_or_string.is_a?(Hash)
         raise ReactOnRails::Error, "#{__method__} only accepts String or Hash as argument "\
             "(#{hash_or_string.class} given)."
@@ -275,6 +277,59 @@ module ReactOnRails
       ReactOnRails::JsonOutput.escape(json_value)
     end
 
+    # This is the definitive list of the default values used for the rails_context, which is the
+    # second parameter passed to both component and store generator functions.
+    # This method can be called from views and from the controller, as `helpers.rails_context`
+    #
+    # rubocop:disable Metrics/AbcSize
+    def rails_context(server_side: true)
+      @rails_context ||= begin
+        result = {
+          railsEnv: Rails.env,
+          inMailer: in_mailer?,
+          # Locale settings
+          i18nLocale: I18n.locale,
+          i18nDefaultLocale: I18n.default_locale,
+          rorVersion: ReactOnRails::VERSION,
+          rorPro: ReactOnRails::Utils.react_on_rails_pro?
+        }
+        if defined?(request) && request.present?
+          # Check for encoding of the request's original_url and try to force-encoding the
+          # URLs as UTF-8. This situation can occur in browsers that do not encode the
+          # entire URL as UTF-8 already, mostly on the Windows platform (IE11 and lower).
+          original_url_normalized = request.original_url
+          if original_url_normalized.encoding.to_s == "ASCII-8BIT"
+            original_url_normalized = original_url_normalized.force_encoding("ISO-8859-1").encode("UTF-8")
+          end
+
+          # Using Addressable instead of standard URI to better deal with
+          # non-ASCII characters (see https://github.com/shakacode/react_on_rails/pull/405)
+          uri = Addressable::URI.parse(original_url_normalized)
+          # uri = Addressable::URI.parse("http://foo.com:3000/posts?id=30&limit=5#time=1305298413")
+
+          result.merge!(
+            # URL settings
+            href: uri.to_s,
+            location: "#{uri.path}#{uri.query.present? ? "?#{uri.query}" : ''}",
+            scheme: uri.scheme, # http
+            host: uri.host, # foo.com
+            port: uri.port,
+            pathname: uri.path, # /posts
+            search: uri.query, # id=30&limit=5
+            httpAcceptLanguage: request.env["HTTP_ACCEPT_LANGUAGE"]
+          )
+        end
+        if ReactOnRails.configuration.rendering_extension
+          custom_context = ReactOnRails.configuration.rendering_extension.custom_context(self)
+          result.merge!(custom_context) if custom_context
+        end
+        result
+      end
+
+      @rails_context.merge(serverSide: server_side)
+    end
+    # rubocop:enable Metrics/AbcSize
+
     private
 
     def build_react_component_result_for_server_rendered_string(
@@ -284,9 +339,15 @@ module ReactOnRails
       render_options: required("render_options")
     )
       content_tag_options = render_options.html_options
+      if content_tag_options.key?(:tag)
+        content_tag_options_html_tag = content_tag_options[:tag]
+        content_tag_options.delete(:tag)
+      else
+        content_tag_options_html_tag = "div"
+      end
       content_tag_options[:id] = render_options.dom_id
 
-      rendered_output = content_tag(:div,
+      rendered_output = content_tag(content_tag_options_html_tag.to_sym,
                                     server_rendered_html.html_safe,
                                     content_tag_options)
 
@@ -431,22 +492,13 @@ module ReactOnRails
       #
       # Read more here: http://timelessrepo.com/json-isnt-a-javascript-subset
 
-      # rubocop:disable Layout/IndentHeredoc
-      js_code = <<-JS
-(function() {
-  var railsContext = #{rails_context(server_side: true).to_json};
-#{initialize_redux_stores}
-  var props = #{props_string(props).gsub("\u2028", '\u2028').gsub("\u2029", '\u2029')};
-  return ReactOnRails.serverRenderReactComponent({
-    name: '#{react_component_name}',
-    domNodeId: '#{render_options.dom_id}',
-    props: props,
-    trace: #{render_options.trace},
-    railsContext: railsContext
-  });
-})()
-      JS
-      # rubocop:enable Layout/IndentHeredoc
+      js_code = ReactOnRails::ServerRenderingJsCode.server_rendering_component_js_code(
+        props_string: props_string(props).gsub("\u2028", '\u2028').gsub("\u2029", '\u2029'),
+        rails_context: rails_context(server_side: true).to_json,
+        redux_stores: initialize_redux_stores,
+        react_component_name: react_component_name,
+        render_options: render_options
+      )
 
       begin
         result = ReactOnRails::ServerRenderingPool.server_render_js_with_console_logging(js_code, render_options)
@@ -478,6 +530,7 @@ module ReactOnRails
       JS
 
       return result unless @registered_stores.present? || @registered_stores_defer_render.present?
+
       declarations = "var reduxProps, store, storeGenerator;\n".dup
       all_stores = (@registered_stores || []) + (@registered_stores_defer_render || [])
 
@@ -494,58 +547,6 @@ module ReactOnRails
       result
     end
 
-    # This is the definitive list of the default values used for the rails_context, which is the
-    # second parameter passed to both component and store generator functions.
-    # rubocop:disable Metrics/AbcSize
-    def rails_context(server_side: required("server_side"))
-      @rails_context ||= begin
-        result = {
-          railsEnv: Rails.env,
-          inMailer: in_mailer?,
-          # Locale settings
-          i18nLocale: I18n.locale,
-          i18nDefaultLocale: I18n.default_locale,
-          rorVersion: ReactOnRails::VERSION,
-          rorPro: ReactOnRails::Utils.react_on_rails_pro?
-        }
-        if defined?(request) && request.present?
-          # Check for encoding of the request's original_url and try to force-encoding the
-          # URLs as UTF-8. This situation can occur in browsers that do not encode the
-          # entire URL as UTF-8 already, mostly on the Windows platform (IE11 and lower).
-          original_url_normalized = request.original_url
-          if original_url_normalized.encoding.to_s == "ASCII-8BIT"
-            original_url_normalized = original_url_normalized.force_encoding("ISO-8859-1").encode("UTF-8")
-          end
-
-          # Using Addressable instead of standard URI to better deal with
-          # non-ASCII characters (see https://github.com/shakacode/react_on_rails/pull/405)
-          uri = Addressable::URI.parse(original_url_normalized)
-          # uri = Addressable::URI.parse("http://foo.com:3000/posts?id=30&limit=5#time=1305298413")
-
-          result.merge!(
-            # URL settings
-            href: uri.to_s,
-            location: "#{uri.path}#{uri.query.present? ? "?#{uri.query}" : ''}",
-            scheme: uri.scheme, # http
-            host: uri.host, # foo.com
-            port: uri.port,
-            pathname: uri.path, # /posts
-            search: uri.query, # id=30&limit=5
-            httpAcceptLanguage: request.env["HTTP_ACCEPT_LANGUAGE"]
-          )
-        end
-        if ReactOnRails.configuration.rendering_extension
-          custom_context = ReactOnRails.configuration.rendering_extension.custom_context(self)
-          result.merge!(custom_context) if custom_context
-        end
-        result
-      end
-
-      @rails_context.merge(serverSide: server_side)
-    end
-
-    # rubocop:enable Metrics/AbcSize
-
     def replay_console_option(val)
       val.nil? ? ReactOnRails.configuration.replay_console : val
     end

data/lib/react_on_rails/json_output.rb

@@ -11,7 +11,7 @@ module ReactOnRails
       "\u2028" => '\u2028',
       "\u2029" => '\u2029'
     }.freeze
-    ESCAPE_REGEXP = /[\u2028\u2029&><]/u
+    ESCAPE_REGEXP = /[\u2028\u2029&><]/u.freeze
 
     def self.escape(json)
       return escape_without_erb_util(json) if Utils.rails_version_less_than_4_1_1

data/lib/react_on_rails/locales_to_js.rb

@@ -7,6 +7,7 @@ module ReactOnRails
     def initialize
       return if i18n_dir.nil?
       return unless obsolete?
+
       @translations, @defaults = generate_translations
       convert
     end
@@ -15,6 +16,7 @@ module ReactOnRails
 
     def obsolete?
       return true if exist_js_files.empty?
+
       js_files_are_outdated
     end
 

data/lib/react_on_rails/react_component/render_options.rb

@@ -72,6 +72,10 @@ module ReactOnRails
         "{ react_component_name = #{react_component_name}, options = #{options}, request_digest = #{request_digest}"
       end
 
+      def internal_option(key)
+        options[key]
+      end
+
       private
 
       attr_reader :options

data/lib/react_on_rails/server_rendering_js_code.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ReactOnRails
+  module ServerRenderingJsCode
+    class << self
+      def js_code_renderer
+        @js_code_renderer ||= if ReactOnRails::Utils.react_on_rails_pro?
+                                ReactOnRailsPro::ServerRenderingJsCode
+                              else
+                                self
+                              end
+      end
+
+      def server_rendering_component_js_code(
+        props_string: nil,
+        rails_context: nil,
+        redux_stores: nil,
+        react_component_name: nil,
+        render_options: nil
+      )
+        js_code_renderer.render(props_string, rails_context, redux_stores, react_component_name, render_options)
+      end
+
+      def render(props_string, rails_context, redux_stores, react_component_name, render_options)
+        <<-JS
+        (function() {
+          var railsContext = #{rails_context};
+        #{redux_stores}
+          var props = #{props_string};
+          return ReactOnRails.serverRenderReactComponent({
+            name: '#{react_component_name}',
+            domNodeId: '#{render_options.dom_id}',
+            props: props,
+            trace: #{render_options.trace},
+            railsContext: railsContext
+          });
+        })()
+        JS
+      end
+    end
+  end
+end

data/lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb

@@ -4,7 +4,9 @@ require "open-uri"
 
 module ReactOnRails
   module ServerRenderingPool
+    # rubocop:disable Metrics/ClassLength
     class RubyEmbeddedJavaScript
+      # rubocop:enable Metrics/ClassLength
       class << self
         def reset_pool
           options = {
@@ -17,12 +19,17 @@ module ReactOnRails
         def reset_pool_if_server_bundle_was_modified
           return unless ReactOnRails.configuration.development_mode
 
-          file_mtime = File.mtime(ReactOnRails::Utils.server_bundle_js_file_path)
-          @server_bundle_timestamp ||= file_mtime
-          return if @server_bundle_timestamp == file_mtime
+          if ReactOnRails::Utils.server_bundle_path_is_http?
+            return if @server_bundle_url == ReactOnRails::Utils.server_bundle_js_file_path
 
-          @server_bundle_timestamp = file_mtime
+            @server_bundle_url = ReactOnRails::Utils.server_bundle_js_file_path
+          else
+            file_mtime = File.mtime(ReactOnRails::Utils.server_bundle_js_file_path)
+            @server_bundle_timestamp ||= file_mtime
+            return if @server_bundle_timestamp == file_mtime
 
+            @server_bundle_timestamp = file_mtime
+          end
           ReactOnRails::ServerRenderingPool.reset_pool
         end
 
@@ -72,6 +79,7 @@ module ReactOnRails
 
         def trace_js_code_used(msg, js_code, file_name = "tmp/server-generated.js", force: false)
           return unless ReactOnRails.configuration.trace || force
+
           # Set to anything to print generated code.
           File.write(file_name, js_code)
           msg = <<-MSG.strip_heredoc
@@ -95,19 +103,25 @@ module ReactOnRails
           end
         end
 
+        def read_bundle_js_code
+          server_js_file = ReactOnRails::Utils.server_bundle_js_file_path
+          if ReactOnRails::Utils.server_bundle_path_is_http?
+            file_url_to_string(server_js_file)
+          else
+            File.read(server_js_file)
+          end
+        rescue StandardError => e
+          msg = "You specified server rendering JS file: #{server_js_file}, but it cannot be "\
+                "read. You may set the server_bundle_js_file in your configuration to be \"\" to "\
+                "avoid this warning.\nError is: #{e}"
+          raise ReactOnRails::Error, msg
+        end
+
         def create_js_context
           return if ReactOnRails.configuration.server_bundle_js_file.blank?
 
-          server_js_file = ReactOnRails::Utils.server_bundle_js_file_path
+          bundle_js_code = read_bundle_js_code
 
-          begin
-            bundle_js_code = File.read(server_js_file)
-          rescue StandardError => e
-            msg = "You specified server rendering JS file: #{server_js_file}, but it cannot be "\
-                "read. You may set the server_bundle_js_file in your configuration to be \"\" to "\
-                "avoid this warning.\nError is: #{e}"
-            raise ReactOnRails::Error, msg
-          end
           # rubocop:disable Layout/IndentHeredoc
           base_js_code = <<-JS
 #{console_polyfill}
@@ -118,7 +132,10 @@ module ReactOnRails
           file_name = "tmp/base_js_code.js"
           begin
             if ReactOnRails.configuration.trace
-              Rails.logger.info { "[react_on_rails] Created JavaScript context with file #{server_js_file}" }
+              Rails.logger.info do
+                "[react_on_rails] Created JavaScript context with file "\
+                "#{ReactOnRails::Utils.server_bundle_js_file_path}"
+              end
             end
             ExecJS.compile(base_js_code)
           rescue StandardError => e
@@ -189,6 +206,19 @@ var console = { history: [] };
           JS
           # rubocop:enable Layout/IndentHeredoc
         end
+
+        private
+
+        def file_url_to_string(url)
+          response = Net::HTTP.get_response(URI.parse(url))
+          content_type_header = response["content-type"]
+          match = content_type_header.match(/\A.*; charset=(?<encoding>.*)\z/)
+          encoding_type = match[:encoding]
+          response.body.force_encoding(encoding_type)
+        rescue StandardError => e
+          msg = "file_url_to_string #{url} failed\nError is: #{e}"
+          raise ReactOnRails::Error, msg
+        end
       end
     end
   end