react_on_rails 16.4.0 → 16.5.1

data/lib/react_on_rails/git_utils.rb

@@ -1,34 +1,106 @@
 # frozen_string_literal: true
 
 require "English"
+require "open3"
 
 module ReactOnRails
   module GitUtils
+    CI_TRUTHY_VALUES = %w[1 true yes].freeze
+
+    DIRTY_WORKTREE_WARNING = <<~MSG.strip
+      You have uncommitted changes. The generator will continue, but reviewing the
+      generated diff is easier if you commit or stash your current work first.
+    MSG
+
+    MISSING_GIT_WARNING = <<~MSG.strip
+      Git is not installed. The generator will continue, but version control makes it
+      much easier to review the generated changes and back out partial installs.
+    MSG
+
+    NOT_A_GIT_REPOSITORY_WARNING = <<~MSG.strip
+      Git is installed, but this directory is not a Git repository yet. The generator
+      will continue, but initializing Git makes it much easier to review the generated
+      changes and back out partial installs.
+    MSG
+
     def self.uncommitted_changes?(message_handler, git_installed: true)
-      # Skip check in CI environments - CI often makes temporary modifications
-      # (e.g., script/convert for minimum version testing) before running generators
-      return false if ENV["CI"] == "true" || ENV["COVERAGE"] == "true"
-
-      status = `git status --porcelain`
-      return false if git_installed && status&.empty?
-
-      error = if git_installed
-                <<~MSG.strip
-                  You have uncommitted changes. Please commit or stash them before continuing.
-
-                  The React on Rails generator creates many new files and it's important to keep
-                  your existing changes separate from the generated code for easier review.
-                MSG
-              else
-                <<~MSG.strip
-                  Git is not installed. Please install Git and commit your changes before continuing.
-
-                  The React on Rails generator creates many new files and version control helps
-                  track what was generated versus your existing code.
-                MSG
-              end
-      message_handler.add_error(error)
+      report_worktree_issues(message_handler, git_installed: git_installed, as_error: true)
+    end
+
+    def self.warn_if_uncommitted_changes(message_handler, git_installed: true)
+      report_worktree_issues(message_handler, git_installed: git_installed, as_error: false)
+    end
+
+    def self.skip_worktree_check?
+      truthy_env?(ENV.fetch("CI", nil)) || truthy_env?(ENV.fetch("COVERAGE", nil))
+    end
+
+    def self.truthy_env?(value)
+      CI_TRUTHY_VALUES.include?(value.to_s.strip.downcase)
+    end
+
+    def self.worktree_status
+      output, status = Open3.capture2e("git", "status", "--porcelain")
+      return :clean if status.success? && output.strip.empty?
+      # Exit code 128 is git's standard fatal error (e.g., not a git repository)
+      return :not_a_git_repository if status.exitstatus == 128
+
+      :dirty
+    rescue Errno::ENOENT
+      # git binary not found despite passing the cli_exists? check
+      :git_not_installed
+    end
+
+    def self.report_worktree_issues(message_handler, git_installed:, as_error:)
+      return false if skip_worktree_check?
+
+      status = git_installed ? worktree_status : :git_not_installed
+      return false if status == :clean
+
+      msg = worktree_message(status, as_error: as_error)
+      as_error ? message_handler.add_error(msg) : message_handler.add_warning(msg)
       true
     end
+    private_class_method :report_worktree_issues
+
+    def self.worktree_message(status, as_error:)
+      case status
+      when :not_a_git_repository
+        as_error ? not_a_git_repository_error_message : NOT_A_GIT_REPOSITORY_WARNING
+      when :git_not_installed
+        as_error ? missing_git_error_message : MISSING_GIT_WARNING
+      else
+        as_error ? dirty_worktree_error_message : DIRTY_WORKTREE_WARNING
+      end
+    end
+    private_class_method :worktree_message
+
+    def self.dirty_worktree_error_message
+      <<~MSG.strip
+        You have uncommitted changes. Please commit or stash them before continuing.
+
+        The React on Rails generator creates many new files and it's important to keep
+        your existing changes separate from the generated code for easier review.
+      MSG
+    end
+
+    def self.missing_git_error_message
+      <<~MSG.strip
+        Git is not installed. Please install Git and commit your changes before continuing.
+
+        The React on Rails generator creates many new files and version control helps
+        track what was generated versus your existing code.
+      MSG
+    end
+
+    def self.not_a_git_repository_error_message
+      <<~MSG.strip
+        Git is installed, but this directory is not a Git repository yet. Initialize Git
+        and commit or stash your changes before continuing.
+
+        The React on Rails generator creates many new files and version control helps
+        track what was generated versus your existing code.
+      MSG
+    end
   end
 end

data/lib/react_on_rails/helper.rb

@@ -74,7 +74,7 @@ module ReactOnRails
       when Hash
         msg = <<~MSG
           Use react_component_hash (not react_component) to return a Hash to your ruby view code. See
-          https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
+          https://github.com/shakacode/react_on_rails/blob/main/react_on_rails/spec/dummy/client/app/startup/ReactHelmetApp.server.jsx
           for an example of the necessary javascript configuration.
         MSG
         raise ReactOnRails::Error, msg
@@ -88,7 +88,7 @@ module ReactOnRails
 
           If you're trying to use a Render-Function to return a Hash to your ruby view code, then use
           react_component_hash instead of react_component and see
-          https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
+          https://github.com/shakacode/react_on_rails/blob/main/react_on_rails/spec/dummy/client/app/startup/ReactHelmetApp.server.jsx
           for an example of the JavaScript code.
         MSG
         raise ReactOnRails::Error, msg
@@ -135,7 +135,7 @@ module ReactOnRails
       else
         msg = <<~MSG
           Render-Function used by react_component_hash for #{component_name} is expected to return
-          an Object. See https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/client/app/startup/ReactHelmetServerApp.jsx
+          an Object. See https://github.com/shakacode/react_on_rails/blob/main/react_on_rails/spec/dummy/client/app/startup/ReactHelmetApp.server.jsx
           for an example of the JavaScript code.
           Note, your Render-Function must either take 2 params or have the property
           `.renderFunction = true` added to it to distinguish it from a React Function Component.

data/lib/react_on_rails/packer_utils.rb

@@ -138,7 +138,7 @@ module ReactOnRails
       msg = <<~MSG
         **ERROR** ReactOnRails: `nested_entries` is configured to be disabled in shakapacker. Please update \
         config/shakapacker.yml to enable nested entries. for more information read
-        https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation.md#enable-nested_entries-for-shakapacker
+        https://reactonrails.com/docs/core-concepts/auto-bundling-file-system-based-automated-bundle-generation/#enable-nested_entries-for-shakapacker
       MSG
 
       raise ReactOnRails::Error, msg

data/lib/react_on_rails/packs_generator.rb

@@ -584,7 +584,7 @@ module ReactOnRails
       msg = <<~MSG
         **ERROR** ReactOnRails: client specific definition for Component '#{component_name}' overrides the \
         common definition. Please delete the common definition and have separate server and client files. For more \
-        information, please see https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation.md
+        information, please see https://reactonrails.com/docs/core-concepts/auto-bundling-file-system-based-automated-bundle-generation/
       MSG
 
       raise ReactOnRails::Error, msg
@@ -594,7 +594,7 @@ module ReactOnRails
       msg = <<~MSG
         **ERROR** ReactOnRails: server specific definition for Component '#{component_name}' overrides the \
         common definition. Please delete the common definition and have separate server and client files. For more \
-        information, please see https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation.md
+        information, please see https://reactonrails.com/docs/core-concepts/auto-bundling-file-system-based-automated-bundle-generation/
       MSG
 
       raise ReactOnRails::Error, msg
@@ -603,7 +603,7 @@ module ReactOnRails
     def raise_missing_client_component(component_name)
       msg = <<~MSG
         **ERROR** ReactOnRails: Component '#{component_name}' is missing a client specific file. For more \
-        information, please see https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation.md
+        information, please see https://reactonrails.com/docs/core-concepts/auto-bundling-file-system-based-automated-bundle-generation/
       MSG
 
       raise ReactOnRails::Error, msg

data/lib/react_on_rails/react_component/render_options.rb

@@ -4,11 +4,51 @@ require "react_on_rails/utils"
 
 module ReactOnRails
   module ReactComponent
+    # rubocop:disable Metrics/ClassLength
     class RenderOptions
       include Utils::Required
 
       attr_accessor :request_digest
 
+      PRERENDER_OVERRIDE_ENV_KEY = "REACT_ON_RAILS_PRERENDER_OVERRIDE"
+      PRERENDER_OVERRIDE_VALUES = { "true" => true, "false" => false }.freeze
+      PRERENDER_OVERRIDE_CACHE_MUTEX = Mutex.new
+      class << self
+        def prerender_env_override
+          PRERENDER_OVERRIDE_CACHE_MUTEX.synchronize do
+            raw_value = ENV.fetch(PRERENDER_OVERRIDE_ENV_KEY, nil)
+            cached_override = @prerender_env_override_cache
+            return cached_override[:value] if cached_override && cached_override[:raw_value] == raw_value
+
+            parsed_value = parse_prerender_env_override(raw_value)
+            @prerender_env_override_cache = { raw_value: raw_value, value: parsed_value }
+            parsed_value
+          end
+        end
+
+        def reset_prerender_env_override_cache!
+          PRERENDER_OVERRIDE_CACHE_MUTEX.synchronize do
+            @prerender_env_override_cache = nil
+          end
+        end
+
+        private
+
+        def parse_prerender_env_override(raw_value)
+          return nil if raw_value.nil?
+
+          normalized_value = raw_value.strip.downcase
+          return PRERENDER_OVERRIDE_VALUES[normalized_value] if PRERENDER_OVERRIDE_VALUES.key?(normalized_value)
+
+          Rails.logger.warn(
+            "[REACT ON RAILS] Ignoring #{PRERENDER_OVERRIDE_ENV_KEY}=#{raw_value.inspect}. " \
+            "Expected 'true' or 'false'."
+          )
+          # Cache invalid values too so we warn once per unique raw env value.
+          nil
+        end
+      end
+
       NO_PROPS = {}.freeze
 
       # TODO: remove the required for named params
@@ -68,6 +108,9 @@ module ReactOnRails
       end
 
       def prerender
+        env_override = prerender_env_override
+        return env_override unless env_override.nil?
+
         retrieve_configuration_value_for(:prerender)
       end
 
@@ -172,6 +215,11 @@ module ReactOnRails
           ReactOnRailsPro.configuration.public_send(key)
         end
       end
+
+      def prerender_env_override
+        self.class.prerender_env_override
+      end
     end
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/react_on_rails/server_rendering_js_code.rb

@@ -25,7 +25,7 @@ module ReactOnRails
             The `prerender` option to allow Server Side Rendering is marked as true but the ReactOnRails configuration
             for `server_bundle_js_file` is nil or not present in `config/initializers/react_on_rails.rb`.
             Set `config.server_bundle_js_file` to your javascript bundle to allow server side rendering.
-            Read more at https://www.shakacode.com/react-on-rails/docs/guides/react-server-rendering/
+            Read more at https://reactonrails.com/docs/core-concepts/react-server-rendering/
           MSG
           raise ReactOnRails::Error, msg
         end

data/lib/react_on_rails/system_checker.rb

@@ -3,14 +3,19 @@
 require "erb"
 require "open3"
 require "yaml"
+require_relative "config_path_resolver"
 
 module ReactOnRails
   # SystemChecker provides validation methods for React on Rails setup
   # Used by install generator and doctor rake task
   # rubocop:disable Metrics/ClassLength
   class SystemChecker
+    include ConfigPathResolver
+
     attr_reader :messages
 
+    SUPPORTED_ASSETS_BUNDLERS = %w[webpack rspack].freeze
+
     def initialize
       @messages = []
     end
@@ -134,7 +139,8 @@ module ReactOnRails
           • bin/shakapacker
           • bin/shakapacker-dev-server
           • config/shakapacker.yml
-          • config/{webpack,rspack}/{webpack,rspack}.config.{js,ts}
+          • config/webpack/webpack.config.{js,ts}
+          • config/rspack/rspack.config.{js,ts}
 
           Run: bundle exec rails shakapacker:install
         MSG
@@ -184,7 +190,7 @@ module ReactOnRails
     end
 
     def check_react_on_rails_npm_package
-      package_json_path = "package.json"
+      package_json_path = resolved_package_json_path
       return unless File.exist?(package_json_path)
 
       package_json = JSON.parse(File.read(package_json_path))
@@ -205,10 +211,11 @@ module ReactOnRails
     end
 
     def check_package_version_sync
-      return unless File.exist?("package.json")
+      package_json_path = resolved_package_json_path
+      return unless File.exist?(package_json_path)
 
       begin
-        package_json = JSON.parse(File.read("package.json"))
+        package_json = JSON.parse(File.read(package_json_path))
         package_name, npm_version = react_on_rails_npm_package_details(package_json)
 
         return unless npm_version && defined?(ReactOnRails::VERSION)
@@ -256,7 +263,7 @@ module ReactOnRails
 
     # React dependencies validation
     def check_react_dependencies
-      return unless File.exist?("package.json")
+      return unless File.exist?(resolved_package_json_path)
 
       package_json = parse_package_json
       return unless package_json
@@ -324,10 +331,13 @@ module ReactOnRails
         return paths_by_bundler[configured_bundler].first
       end
 
+      # Default to webpack when shakapacker.yml doesn't declare assets_bundler.
+      # Webpack is the longer-established default; rspack users typically set
+      # assets_bundler explicitly in shakapacker.yml.
       add_warning(
-        "⚠️  Found both webpack and rspack configs. Could not determine active bundler; defaulting to rspack."
+        "⚠️  Found both webpack and rspack configs. Could not determine active bundler; defaulting to webpack."
       )
-      paths_by_bundler["rspack"].first || paths_by_bundler["webpack"].first
+      paths_by_bundler["webpack"].first || paths_by_bundler["rspack"].first
     end
 
     def suggest_webpack_inspection(config_path)
@@ -369,10 +379,11 @@ module ReactOnRails
     end
 
     def bundle_analyzer_available?
-      return false unless File.exist?("package.json")
+      package_json_path = resolved_package_json_path
+      return false unless File.exist?(package_json_path)
 
       begin
-        package_json = JSON.parse(File.read("package.json"))
+        package_json = JSON.parse(File.read(package_json_path))
         all_deps = (package_json["dependencies"] || {}).merge(package_json["devDependencies"] || {})
         all_deps["webpack-bundle-analyzer"]
       rescue StandardError
@@ -519,16 +530,27 @@ module ReactOnRails
     end
 
     def configured_assets_bundler
-      shakapacker_config_path = "config/shakapacker.yml"
-      return nil unless File.exist?(shakapacker_config_path)
+      config = parsed_shakapacker_config
+      return nil unless config
 
-      config_content = File.read(shakapacker_config_path)
-      match = config_content.match(/^\s*assets_bundler:\s*["']?(webpack|rspack)["']?\s*$/)
-      match&.captures&.first
-    rescue StandardError
+      rails_env = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+      bundler_from_shakapacker_section(config, rails_env) || bundler_from_shakapacker_section(config, "default")
+    rescue StandardError, ScriptError
       nil
     end
 
+    def bundler_from_shakapacker_section(config, section_name)
+      section = config[section_name] || config[section_name.to_sym]
+      return nil unless section.is_a?(Hash)
+
+      normalize_assets_bundler(section["assets_bundler"] || section[:assets_bundler])
+    end
+
+    def normalize_assets_bundler(value)
+      normalized = value.to_s.strip.downcase
+      SUPPORTED_ASSETS_BUNDLERS.include?(normalized) ? normalized : nil
+    end
+
     def required_react_dependencies
       deps = {
         "react" => "React library",
@@ -622,8 +644,8 @@ module ReactOnRails
     # rubocop:enable Metrics/CyclomaticComplexity
 
     def parse_package_json
-      JSON.parse(File.read("package.json"))
-    rescue JSON::ParserError
+      JSON.parse(File.read(resolved_package_json_path))
+    rescue Errno::ENOENT, JSON::ParserError
       add_warning("⚠️  Could not parse package.json to check React dependencies")
       nil
     end
@@ -762,10 +784,11 @@ module ReactOnRails
     end
 
     def report_webpack_version
-      return unless File.exist?("package.json")
+      package_json_path = resolved_package_json_path
+      return unless File.exist?(package_json_path)
 
       begin
-        package_json = JSON.parse(File.read("package.json"))
+        package_json = JSON.parse(File.read(package_json_path))
         all_deps = (package_json["dependencies"] || {}).merge(package_json["devDependencies"] || {})
 
         webpack_version = all_deps["webpack"]

data/lib/react_on_rails/test_helper/webpack_assets_compiler.rb

@@ -5,8 +5,7 @@
 module ReactOnRails
   module TestHelper
     class WebpackAssetsCompiler
-      TESTING_DOCS_URL = "https://github.com/shakacode/react_on_rails/blob/master/" \
-                         "docs/oss/building-features/dev-server-and-testing.md"
+      TESTING_DOCS_URL = "https://reactonrails.com/docs/building-features/dev-server-and-testing/"
 
       def compile_assets
         if ReactOnRails.configuration.build_test_command.blank?

data/lib/react_on_rails/utils.rb

@@ -17,7 +17,7 @@ module ReactOnRails
     def self.immediate_hydration_pro_install_warning(name, type = "Component")
       "[REACT ON RAILS] Warning: immediate_hydration: true requires the React on Rails Pro gem to be installed.\n" \
         "#{type} '#{name}' will fall back to standard hydration behavior.\n" \
-        "Visit https://www.shakacode.com/react-on-rails-pro/ for installation details."
+        "Visit https://reactonrails.com/docs/pro/ for installation details."
     end
 
     # Normalizes the immediate_hydration option value, enforcing Pro gem-availability requirements.

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "16.4.0"
+  VERSION = "16.5.1"
 end