react_on_rails 11.1.4 → 12.0.0

data/lib/react_on_rails/locales/base.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module ReactOnRails
+  module Locales
+    def self.compile
+      if ReactOnRails.configuration.i18n_output_format&.downcase == "js"
+        ReactOnRails::Locales::ToJs.new
+      else
+        ReactOnRails::Locales::ToJson.new
+      end
+    end
+
+    class Base
+      def initialize
+        return if i18n_dir.nil?
+        return unless obsolete?
+
+        @translations, @defaults = generate_translations
+        convert
+      end
+
+      private
+
+      def file_format; end
+
+      def obsolete?
+        return true if exist_files.empty?
+
+        files_are_outdated
+      end
+
+      def exist_files
+        @exist_files ||= files.select(&File.method(:exist?))
+      end
+
+      def files_are_outdated
+        latest_yml = locale_files.map(&File.method(:mtime)).max
+        earliest = exist_files.map(&File.method(:mtime)).min
+        latest_yml > earliest
+      end
+
+      def file_names
+        %w[translations default]
+      end
+
+      def files
+        @files ||= file_names.map { |n| file(n) }
+      end
+
+      def file(name)
+        "#{i18n_dir}/#{name}.#{file_format}"
+      end
+
+      def locale_files
+        @locale_files ||= begin
+          if i18n_yml_dir.present?
+            Dir["#{i18n_yml_dir}/**/*.yml"]
+          else
+            ReactOnRails::Utils.truthy_presence(
+              Rails.application && Rails.application.config.i18n.load_path
+            ).presence
+          end
+        end
+      end
+
+      def i18n_dir
+        @i18n_dir ||= ReactOnRails.configuration.i18n_dir
+      end
+
+      def i18n_yml_dir
+        @i18n_yml_dir ||= ReactOnRails.configuration.i18n_yml_dir
+      end
+
+      def default_locale
+        @default_locale ||= I18n.default_locale.to_s || "en"
+      end
+
+      def convert
+        file_names.each do |name|
+          template = send("template_#{name}")
+          path = file(name)
+          generate_file(template, path)
+        end
+      end
+
+      def generate_file(template, path)
+        result = ERB.new(template).result()
+        File.open(path, "w") do |f|
+          f.write(result)
+        end
+      end
+
+      def generate_translations
+        translations = {}
+        defaults = {}
+        locale_files.each do |f|
+          translation = YAML.safe_load(File.open(f))
+          key = translation.keys[0]
+          val = flatten(translation[key])
+          translations = translations.deep_merge(key => val)
+          defaults = defaults.deep_merge(flatten_defaults(val)) if key == default_locale
+        end
+        [translations.to_json, defaults.to_json]
+      end
+
+      def format(input)
+        input.to_s.tr(".", "_").camelize(:lower).to_sym
+      end
+
+      def flatten_defaults(val)
+        flatten(val).each_with_object({}) do |(k, v), h|
+          key = format(k)
+          h[key] = { id: k, defaultMessage: v }
+        end
+      end
+
+      def flatten(translations)
+        translations.each_with_object({}) do |(k, v), h|
+          if v.is_a? Hash
+            flatten(v).map { |hk, hv| h["#{k}.#{hk}".to_sym] = hv }
+          elsif v.is_a?(String)
+            h[k] = v.gsub("%{", "{")
+          elsif !v.is_a?(Array)
+            h[k] = v
+          end
+        end
+      end
+
+      def template_translations
+        <<-JS.strip_heredoc
+          export const translations = #{@translations};
+        JS
+      end
+
+      def template_default
+        <<-JS.strip_heredoc
+          import { defineMessages } from 'react-intl';
+
+          const defaultLocale = \'#{default_locale}\';
+
+          const defaultMessages = defineMessages(#{@defaults});
+
+          export { defaultMessages, defaultLocale };
+        JS
+      end
+    end
+  end
+end

data/lib/react_on_rails/locales/to_js.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module ReactOnRails
+  module Locales
+    class ToJs < Base
+      def initialize
+        super
+      end
+
+      private
+
+      def file_format
+        "js"
+      end
+
+      def template_translations
+        <<-JS.strip_heredoc
+          export const translations = #{@translations};
+        JS
+      end
+
+      def template_default
+        <<-JS.strip_heredoc
+          import { defineMessages } from 'react-intl';
+
+          const defaultLocale = \'#{default_locale}\';
+
+          const defaultMessages = defineMessages(#{@defaults});
+
+          export { defaultMessages, defaultLocale };
+        JS
+      end
+    end
+  end
+end

data/lib/react_on_rails/locales/to_json.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module ReactOnRails
+  module Locales
+    class ToJson < Base
+      def initialize
+        super
+      end
+
+      private
+
+      def file_format
+        "json"
+      end
+
+      def template_translations
+        @translations
+      end
+
+      def template_default
+        @defaults
+      end
+    end
+  end
+end

data/lib/react_on_rails/prerender_error.rb

@@ -48,33 +48,29 @@ module ReactOnRails
     def calc_message(component_name, console_messages, err, js_code, props)
       message = "ERROR in SERVER PRERENDERING\n".dup
       if err
-        # rubocop:disable Layout/IndentHeredoc
-        message << <<-MSG
-Encountered error: \"#{err}\"
+        message << <<~MSG
+          Encountered error: \"#{err}\"
         MSG
-        # rubocop:enable Layout/IndentHeredoc
+
         backtrace = err.backtrace.join("\n")
       else
         backtrace = nil
       end
-      # rubocop:disable Layout/IndentHeredoc
-      message << <<-MSG
-when prerendering #{component_name} with props: #{Utils.smart_trim(props, MAX_ERROR_SNIPPET_TO_LOG)}
+      message << <<~MSG
+        when prerendering #{component_name} with props: #{Utils.smart_trim(props, MAX_ERROR_SNIPPET_TO_LOG)}
 
-code:
+        code:
 
-#{Utils.smart_trim(js_code, MAX_ERROR_SNIPPET_TO_LOG)}
+        #{Utils.smart_trim(js_code, MAX_ERROR_SNIPPET_TO_LOG)}
 
       MSG
-      # rubocop:enable Layout/IndentHeredoc
 
       if console_messages
-        # rubocop:disable Layout/IndentHeredoc
-        message << <<-MSG
-console messages:
-#{console_messages}
+        message << <<~MSG
+          console messages:
+          #{console_messages}
         MSG
-        # rubocop:enable Layout/IndentHeredoc
+
       end
       [backtrace, message]
     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

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 require "open-uri"
+require "execjs"
 
 module ReactOnRails
   module ServerRenderingPool
+    # rubocop:disable Metrics/ClassLength
     class RubyEmbeddedJavaScript
+      # rubocop:enable Metrics/ClassLength
       class << self
         def reset_pool
           options = {
@@ -17,12 +20,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 +80,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,30 +104,37 @@ module ReactOnRails
           end
         end
 
-        def create_js_context
-          return if ReactOnRails.configuration.server_bundle_js_file.blank?
-
+        def read_bundle_js_code
           server_js_file = ReactOnRails::Utils.server_bundle_js_file_path
-
-          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 "\
+          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
-          # rubocop:disable Layout/IndentHeredoc
-          base_js_code = <<-JS
-#{console_polyfill}
-#{execjs_timer_polyfills}
-#{bundle_js_code};
+          raise ReactOnRails::Error, msg
+        end
+
+        def create_js_context
+          return if ReactOnRails.configuration.server_bundle_js_file.blank?
+
+          bundle_js_code = read_bundle_js_code
+          base_js_code = <<~JS
+            #{console_polyfill}
+            #{execjs_timer_polyfills}
+            #{bundle_js_code};
           JS
-          # rubocop:enable Layout/IndentHeredoc
+
           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
@@ -134,33 +150,31 @@ module ReactOnRails
         end
 
         def execjs_timer_polyfills
-          # rubocop:disable Layout/IndentHeredoc
-          <<-JS
-function getStackTrace () {
-  var stack;
-  try {
-    throw new Error('');
-  }
-  catch (error) {
-    stack = error.stack || '';
-  }
-  stack = stack.split('\\n').map(function (line) { return line.trim(); });
-  return stack.splice(stack[0] == 'Error' ? 2 : 1);
-}
-
-function setInterval() {
-  #{undefined_for_exec_js_logging('setInterval')}
-}
-
-function setTimeout() {
-  #{undefined_for_exec_js_logging('setTimeout')}
-}
-
-function clearTimeout() {
-  #{undefined_for_exec_js_logging('clearTimeout')}
-}
+          <<~JS
+            function getStackTrace () {
+              var stack;
+              try {
+                throw new Error('');
+              }
+              catch (error) {
+                stack = error.stack || '';
+              }
+              stack = stack.split('\\n').map(function (line) { return line.trim(); });
+              return stack.splice(stack[0] == 'Error' ? 2 : 1);
+            }
+
+            function setInterval() {
+              #{undefined_for_exec_js_logging('setInterval')}
+            }
+
+            function setTimeout() {
+              #{undefined_for_exec_js_logging('setTimeout')}
+            }
+
+            function clearTimeout() {
+              #{undefined_for_exec_js_logging('clearTimeout')}
+            }
           JS
-          # rubocop:enable Layout/IndentHeredoc
         end
 
         def undefined_for_exec_js_logging(function_name)
@@ -174,20 +188,31 @@ function clearTimeout() {
 
         # Reimplement console methods for replaying on the client
         def console_polyfill
-          # rubocop:disable Layout/IndentHeredoc
-          <<-JS
-var console = { history: [] };
-['error', 'log', 'info', 'warn'].forEach(function (level) {
-  console[level] = function () {
-    var argArray = Array.prototype.slice.call(arguments);
-    if (argArray.length > 0) {
-      argArray[0] = '[SERVER] ' + argArray[0];
-    }
-    console.history.push({level: level, arguments: argArray});
-  };
-});
+          <<~JS
+            var console = { history: [] };
+            ['error', 'log', 'info', 'warn'].forEach(function (level) {
+              console[level] = function () {
+                var argArray = Array.prototype.slice.call(arguments);
+                if (argArray.length > 0) {
+                  argArray[0] = '[SERVER] ' + argArray[0];
+                }
+                console.history.push({level: level, arguments: argArray});
+              };
+            });
           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

data/lib/react_on_rails/test_helper/ensure_assets_compiled.rb

@@ -5,6 +5,7 @@ module ReactOnRails
     class EnsureAssetsCompiled
       class << self
         attr_accessor :has_been_run
+
         @has_been_run = false
       end
 
@@ -29,7 +30,7 @@ module ReactOnRails
         # Be sure we don't do this again.
         self.class.has_been_run = true
 
-        ReactOnRails::LocalesToJs.new
+        ReactOnRails::Locales.compile
 
         stale_gen_files = webpack_assets_status_checker.stale_generated_webpack_files
 
@@ -43,17 +44,15 @@ module ReactOnRails
       end
 
       def puts_start_compile_check_message(stale_files)
-        # rubocop:disable Layout/IndentHeredoc
-        puts <<-MSG
+        puts <<~MSG
 
-Detected the following stale generated files:
-  #{stale_files.join("\n  ")}
+          Detected the following stale generated files:
+            #{stale_files.join("\n  ")}
 
-React on Rails will ensure your JavaScript generated files are up to date, using your
-`#{ReactOnRails::Utils.prepend_cd_node_modules_directory(ReactOnRails.configuration.build_test_command)}` command.
+          React on Rails will ensure your JavaScript generated files are up to date, using your
+          `#{ReactOnRails::Utils.prepend_cd_node_modules_directory(ReactOnRails.configuration.build_test_command)}` command.
 
         MSG
-        # rubocop:enable Layout/IndentHeredoc
       end
     end
   end

data/lib/react_on_rails/test_helper/webpack_assets_compiler.rb

@@ -6,6 +6,23 @@ module ReactOnRails
   module TestHelper
     class WebpackAssetsCompiler
       def compile_assets
+        if ReactOnRails.configuration.build_test_command.blank?
+          msg = <<~MSG
+            You are using the React on Rails test helper. 
+            Either you used:
+              ReactOnRails::TestHelper.configure_rspec_to_compile_assets or
+              ReactOnRails::TestHelper.ensure_assets_compiled
+            but you did not specify the config.build_test_command
+
+            React on Rails is aborting your test run
+
+            If you wish to use the config/webpacker.yml compile option for tests
+            them remove your call to the ReactOnRails test helper.
+          MSG
+          puts Rainbow(msg).red
+          exit!(1)
+        end
+
         puts "\nBuilding Webpack assets..."
 
         cmd = ReactOnRails::Utils.prepend_cd_node_modules_directory(

data/lib/react_on_rails/utils.rb

@@ -8,7 +8,7 @@ require "active_support/core_ext/string"
 
 module ReactOnRails
   module Utils
-    TRUNCATION_FILLER = "\n... TRUNCATED ...\n".freeze
+    TRUNCATION_FILLER = "\n... TRUNCATED ...\n"
 
     # https://forum.shakacode.com/t/yak-of-the-week-ruby-2-4-pathname-empty-changed-to-look-at-file-size/901
     # return object if truthy, else return nil
@@ -24,13 +24,12 @@ module ReactOnRails
     # Pass in the msg and color as a symbol.
     def self.wrap_message(msg, color = :red)
       wrapper_line = ("=" * 80).to_s
-      # rubocop:disable Layout/IndentHeredoc
-      fenced_msg = <<-MSG
-#{wrapper_line}
-#{msg.strip}
-#{wrapper_line}
+      fenced_msg = <<~MSG
+        #{wrapper_line}
+        #{msg.strip}
+        #{wrapper_line}
       MSG
-      # rubocop:enable Layout/IndentHeredoc
+
       Rainbow(fenced_msg).color(color)
     end
 
@@ -48,14 +47,13 @@ module ReactOnRails
       unless status.success?
         stdout_msg = stdout.present? ? "\nstdout:\n#{stdout.strip}\n" : ""
         stderr_msg = stderr.present? ? "\nstderr:\n#{stderr.strip}\n" : ""
-        # rubocop:disable Layout/IndentHeredoc
-        msg = <<-MSG
-React on Rails FATAL ERROR!
-#{failure_message}
-cmd: #{cmd}
-exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
+        msg = <<~MSG
+          React on Rails FATAL ERROR!
+          #{failure_message}
+          cmd: #{cmd}
+          exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
         MSG
-        # rubocop:enable Layout/IndentHeredoc
+
         puts wrap_message(msg)
 
         # Rspec catches exit without! in the exit callbacks
@@ -64,15 +62,16 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
       [stdout, stderr, status]
     end
 
+    def self.server_bundle_path_is_http?
+      server_bundle_js_file_path =~ %r{https?://}
+    end
+
     def self.server_bundle_js_file_path
       # Either:
       # 1. Using same bundle for both server and client, so server bundle will be hashed in manifest
       # 2. Using a different bundle (different Webpack config), so file is not hashed, and
-      #    bundle_js_path will throw.
-      # 3. Not using webpacker, and bundle_js_path always returns
-
-      # Note, server bundle should not be in the manifest
-      # If using webpacker gem per https://github.com/rails/webpacker/issues/571
+      #    bundle_js_path will throw so the default path is used without a hash.
+      # 3. Not using webpacker, and this method returns the bundle_js_file_path
       return @server_bundle_path if @server_bundle_path && !Rails.env.development?
 
       bundle_name = ReactOnRails.configuration.server_bundle_js_file
@@ -92,7 +91,7 @@ exitstatus: #{status.exitstatus}#{stdout_msg}#{stderr_msg}
 
     def self.bundle_js_file_path(bundle_name)
       if ReactOnRails::WebpackerUtils.using_webpacker? && bundle_name != "manifest.json"
-        ReactOnRails::WebpackerUtils.bundle_js_file_path_from_webpacker(bundle_name)
+        ReactOnRails::WebpackerUtils.bundle_js_uri_from_webpacker(bundle_name)
       else
         # Default to the non-hashed name in the specified output directory, which, for legacy
         # React on Rails, this is the output directory picked up by the asset pipeline.

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "11.1.4".freeze
+  VERSION = "12.0.0"
 end