react_on_rails 11.0.0 → 12.0.0

data/lib/react_on_rails/configuration.rb

@@ -1,103 +1,17 @@
 # frozen_string_literal: true
 
-# NOTE: ReactOnRails::Utils.using_webpacker? always will return false when called here.
+# rubocop:disable Metrics/ClassLength
 
 module ReactOnRails
   def self.configure
     yield(configuration)
-    setup_config_values
+    configuration.setup_config_values
   end
 
   DEFAULT_GENERATED_ASSETS_DIR = File.join(%w[public webpack], Rails.env).freeze
-
-  def self.setup_config_values
-    ensure_webpack_generated_files_exists
-    configure_generated_assets_dirs_deprecation
-    configure_skip_display_none_deprecation
-    ensure_generated_assets_dir_present
-    ensure_server_bundle_js_file_has_no_path
-    check_i18n_directory_exists
-    check_i18n_yml_directory_exists
-    check_server_render_method_is_only_execjs
-  end
-
-  def self.check_server_render_method_is_only_execjs
-    return if @configuration.server_render_method.blank? ||
-              @configuration.server_render_method == "ExecJS"
-
-    msg = <<-MSG.strip_heredoc
-      Error configuring /config/react_on_rails.rb: invalid value for `config.server_render_method`.
-      If you wish to use a server render method other than ExecJS, contact justin@shakacode.com
-      for details.
-    MSG
-    raise ReactOnRails::Error, msg
-  end
-
-  def self.check_i18n_directory_exists
-    return if @configuration.i18n_dir.nil?
-    return if Dir.exist?(@configuration.i18n_dir)
-
-    msg = <<-MSG.strip_heredoc
-      Error configuring /config/react_on_rails.rb: invalid value for `config.i18n_dir`.
-      Directory does not exist: #{@configuration.i18n_dir}. Set to value to nil or comment it
-      out if not using the React on Rails i18n feature.
-    MSG
-    raise ReactOnRails::Error, msg
-  end
-
-  def self.check_i18n_yml_directory_exists
-    return if @configuration.i18n_yml_dir.nil?
-    return if Dir.exist?(@configuration.i18n_yml_dir)
-
-    msg = <<-MSG.strip_heredoc
-      Error configuring /config/react_on_rails.rb: invalid value for `config.i18n_yml_dir`.
-      Directory does not exist: #{@configuration.i18n_yml_dir}. Set to value to nil or comment it
-      out if not using this i18n with React on Rails, or if you want to use all translation files.
-    MSG
-    raise ReactOnRails::Error, msg
-  end
-
-  def self.ensure_generated_assets_dir_present
-    return if @configuration.generated_assets_dir.present?
-
-    @configuration.generated_assets_dir = DEFAULT_GENERATED_ASSETS_DIR
-    puts "ReactOnRails: Set generated_assets_dir to default: #{DEFAULT_GENERATED_ASSETS_DIR}"
-  end
-
-  def self.configure_generated_assets_dirs_deprecation
-    return if @configuration.generated_assets_dirs.blank?
-
-    puts "[DEPRECATION] ReactOnRails: Use config.generated_assets_dir rather than "\
-        "generated_assets_dirs"
-    if @configuration.generated_assets_dir.blank?
-      @configuration.generated_assets_dir = @configuration.generated_assets_dirs
-    else
-      puts "[DEPRECATION] ReactOnRails. You have both generated_assets_dirs and "\
-          "generated_assets_dir defined. Define ONLY generated_assets_dir"
-    end
-  end
-
-  def self.ensure_webpack_generated_files_exists
-    return unless @configuration.webpack_generated_files.empty?
-
-    files = ["hello-world-bundle.js"]
-    files << @configuration.server_bundle_js_file if @configuration.server_bundle_js_file.present?
-
-    @configuration.webpack_generated_files = files
-  end
-
-  def self.ensure_server_bundle_js_file_has_no_path
-    return unless @configuration.server_bundle_js_file.include?(File::SEPARATOR)
-
-    puts "[DEPRECATION] ReactOnRails: remove path from server_bundle_js_file in configuration. "\
-        "All generated files must go in #{@configuration.generated_assets_dir}"
-    @configuration.server_bundle_js_file = File.basename(@configuration.server_bundle_js_file)
-  end
-
-  def self.configure_skip_display_none_deprecation
-    return if @configuration.skip_display_none.nil?
-    puts "[DEPRECATION] ReactOnRails: remove skip_display_none from configuration."
-  end
+  DEFAULT_SERVER_RENDER_TIMEOUT = 20
+  DEFAULT_POOL_SIZE = 1
+  DEFAULT_RANDOM_DOM_ID = true # for backwards compatability
 
   def self.configuration
     @configuration ||= Configuration.new(
@@ -109,19 +23,21 @@ 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: 1,
-      server_renderer_timeout: 20,
+      server_renderer_pool_size: DEFAULT_POOL_SIZE,
+      server_renderer_timeout: DEFAULT_SERVER_RENDER_TIMEOUT,
       skip_display_none: nil,
       # skip_display_none is deprecated
       webpack_generated_files: %w[manifest.json],
       rendering_extension: nil,
       server_render_method: nil,
-      symlink_non_digested_assets_regex: nil,
       build_test_command: "",
-      build_production_command: ""
+      build_production_command: "",
+      random_dom_id: DEFAULT_RANDOM_DOM_ID,
+      same_bundle_for_client_and_server: false,
+      i18n_output_format: nil
     )
   end
 
@@ -133,8 +49,9 @@ module ReactOnRails
                   :generated_assets_dirs, :generated_assets_dir,
                   :webpack_generated_files, :rendering_extension, :build_test_command,
                   :build_production_command,
-                  :i18n_dir, :i18n_yml_dir,
-                  :server_render_method, :symlink_non_digested_assets_regex
+                  :i18n_dir, :i18n_yml_dir, :i18n_output_format,
+                  :server_render_method, :random_dom_id,
+                  :same_bundle_for_client_and_server
 
     def initialize(node_modules_location: nil, server_bundle_js_file: nil, prerender: nil,
                    replay_console: nil,
@@ -145,17 +62,19 @@ module ReactOnRails
                    generated_assets_dir: nil, webpack_generated_files: nil,
                    rendering_extension: nil, build_test_command: nil,
                    build_production_command: nil,
-                   i18n_dir: nil, i18n_yml_dir: nil,
-                   server_render_method: nil, symlink_non_digested_assets_regex: nil)
+                   same_bundle_for_client_and_server: nil,
+                   i18n_dir: nil, i18n_yml_dir: nil, i18n_output_format: nil,
+                   random_dom_id: nil, server_render_method: nil)
       self.node_modules_location = node_modules_location.present? ? node_modules_location : Rails.root
-      self.server_bundle_js_file = server_bundle_js_file
       self.generated_assets_dirs = generated_assets_dirs
       self.generated_assets_dir = generated_assets_dir
       self.build_test_command = build_test_command
       self.build_production_command = build_production_command
       self.i18n_dir = i18n_dir
       self.i18n_yml_dir = i18n_yml_dir
+      self.i18n_output_format = i18n_output_format
 
+      self.random_dom_id = random_dom_id
       self.prerender = prerender
       self.replay_console = replay_console
       self.logging_on_server = logging_on_server
@@ -169,6 +88,8 @@ module ReactOnRails
       self.skip_display_none = skip_display_none
 
       # Server rendering:
+      self.server_bundle_js_file = server_bundle_js_file
+      self.same_bundle_for_client_and_server = same_bundle_for_client_and_server
       self.server_renderer_pool_size = self.development_mode ? 1 : server_renderer_pool_size
       self.server_renderer_timeout = server_renderer_timeout # seconds
 
@@ -176,7 +97,159 @@ module ReactOnRails
       self.rendering_extension = rendering_extension
 
       self.server_render_method = server_render_method
-      self.symlink_non_digested_assets_regex = symlink_non_digested_assets_regex
+    end
+
+    # on ReactOnRails
+    def setup_config_values
+      ensure_webpack_generated_files_exists
+      configure_generated_assets_dirs_deprecation
+      configure_skip_display_none_deprecation
+      ensure_generated_assets_dir_present
+      check_i18n_directory_exists
+      check_i18n_yml_directory_exists
+      check_server_render_method_is_only_execjs
+      error_if_using_webpacker_and_generated_assets_dir_not_match_public_output_path
+      check_deprecated_settings
+    end
+
+    private
+
+    def check_deprecated_settings
+      if build_production_command.present? &&
+         ReactOnRails::WebpackerUtils.webpacker_webpack_production_config_exists?
+        msg = <<~MSG
+          Setting ReactOnRails configuration for `build_production_command` is
+          not necessary if you have config/webpack/production.js. When that file
+          exists, React on Rails DOES NOT modify the standard assets:precompile.
+          If you want React on Rails to modify to the standard assets:precompile
+          to use your config/initializers/react_on_rails.rb config.build_production_command
+          then delete the config/webpack/production.js.
+        MSG
+        Rails.logger.warn(msg)
+      end
+      #
+      # msg = <<~MSG
+      #   ReactOnRails configuration for `build_production_command` is removed.
+      #   Move this command into `bin/webpack` converting the script to a shell script.
+      # MSG
+      # raise ReactOnRails::Error, msg
+      # Commenting out until v13 when
+      # https://github.com/rails/webpacker/issues/2640 gets resolved
+      # if node_modules_location.present?
+      #   Rails.logger.warn("ReactOnRails configuration for `node_modules_location` is deprecated. "\
+      #    "Instead, prepend a `cd client` (or whichever location) before your test command.")
+      # end
+      #
+      # return unless build_production_command.present?
+      #
+      # msg = <<~MSG
+      #   ReactOnRails configuration for `build_production_command` is removed.
+      #   Move this command into `bin/webpack` converting the script to a shell script.
+      # MSG
+      # raise ReactOnRails::Error, msg
+    end
+
+    def error_if_using_webpacker_and_generated_assets_dir_not_match_public_output_path
+      return unless ReactOnRails::WebpackerUtils.using_webpacker?
+
+      return if generated_assets_dir.blank?
+
+      webpacker_public_output_path = ReactOnRails::WebpackerUtils.webpacker_public_output_path
+
+      if File.expand_path(generated_assets_dir) == webpacker_public_output_path.to_s
+        Rails.logger.warn("You specified generated_assets_dir in `config/initializers/react_on_rails.rb` "\
+        "with Webpacker. Remove this line from your configuration file.")
+      else
+        msg = <<~MSG
+          Error configuring /config/initializers/react_on_rails.rb: You are using webpacker
+          and your specified value for generated_assets_dir = #{generated_assets_dir}
+          that does not match the value for public_output_path specified in
+          webpacker.yml = #{webpacker_public_output_path}. You should remove the configuration
+          value for "generated_assets_dir" from your config/initializers/react_on_rails.rb file.
+        MSG
+        raise ReactOnRails::Error, msg
+      end
+    end
+
+    def check_server_render_method_is_only_execjs
+      return if server_render_method.blank? ||
+                server_render_method == "ExecJS"
+
+      msg = <<-MSG.strip_heredoc
+      Error configuring /config/initializers/react_on_rails.rb: invalid value for `config.server_render_method`.
+      If you wish to use a server render method other than ExecJS, contact justin@shakacode.com
+      for details.
+      MSG
+      raise ReactOnRails::Error, msg
+    end
+
+    def check_i18n_directory_exists
+      return if i18n_dir.nil?
+      return if Dir.exist?(i18n_dir)
+
+      msg = <<-MSG.strip_heredoc
+      Error configuring /config/initializers/react_on_rails.rb: invalid value for `config.i18n_dir`.
+      Directory does not exist: #{i18n_dir}. Set to value to nil or comment it
+      out if not using the React on Rails i18n feature.
+      MSG
+      raise ReactOnRails::Error, msg
+    end
+
+    def check_i18n_yml_directory_exists
+      return if i18n_yml_dir.nil?
+      return if Dir.exist?(i18n_yml_dir)
+
+      msg = <<-MSG.strip_heredoc
+      Error configuring /config/initializers/react_on_rails.rb: invalid value for `config.i18n_yml_dir`.
+      Directory does not exist: #{i18n_yml_dir}. Set to value to nil or comment it
+      out if not using this i18n with React on Rails, or if you want to use all translation files.
+      MSG
+      raise ReactOnRails::Error, msg
+    end
+
+    def ensure_generated_assets_dir_present
+      return if generated_assets_dir.present? || ReactOnRails::WebpackerUtils.using_webpacker?
+
+      self.generated_assets_dir = DEFAULT_GENERATED_ASSETS_DIR
+      Rails.logger.warn "ReactOnRails: Set generated_assets_dir to default: #{DEFAULT_GENERATED_ASSETS_DIR}"
+    end
+
+    def configure_generated_assets_dirs_deprecation
+      return if generated_assets_dirs.blank?
+
+      if ReactOnRails::WebpackerUtils.using_webpacker?
+        webpacker_public_output_path = ReactOnRails::WebpackerUtils.webpacker_public_output_path
+        Rails.logger.warn "Error configuring config/initializers/react_on_rails. Define neither the "\
+        "generated_assets_dirs no the generated_assets_dir when using Webpacker. This is defined by "\
+        "public_output_path specified in webpacker.yml = #{webpacker_public_output_path}."
+        return
+      end
+
+      Rails.logger.warn "[DEPRECATION] ReactOnRails: Use config.generated_assets_dir rather than "\
+        "generated_assets_dirs"
+      if generated_assets_dir.blank?
+        self.generated_assets_dir = generated_assets_dirs
+      else
+        Rails.logger.warn "[DEPRECATION] ReactOnRails. You have both generated_assets_dirs and "\
+          "generated_assets_dir defined. Define ONLY generated_assets_dir if NOT using Webpacker"\
+          " and define neither if using Webpacker"
+      end
+    end
+
+    def ensure_webpack_generated_files_exists
+      return unless webpack_generated_files.empty?
+
+      files = ["manifest.json"]
+      files << server_bundle_js_file if server_bundle_js_file.present?
+
+      self.webpack_generated_files = files
+    end
+
+    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
 end
+# rubocop:enable Metrics/ClassLength

data/lib/react_on_rails/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ReactOnRails
   class Error < StandardError
   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