react_on_rails 16.4.0.rc.6 → 16.4.0.rc.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e2eb14c4503b061f7391a7a72c677ae86a960e895a8549055bcb657f8be9ddc
-  data.tar.gz: 056d77c9579b70ec0a5afad57cf7b9d38709031852ce693a29a60f7b7dde1a27
+  metadata.gz: a834e70a65aa260461effa652dcea303bc28acb1888b8f81176b190a1234359b
+  data.tar.gz: 11c61171bcc86b52fa4b376550183f28916894f84e212395a6ad88777195bd0b
 SHA512:
-  metadata.gz: 5a4855b3d19061720c333f4bea3bf25b8987906551758dde4b4a549032353280b111a636e79b2d00299cd6d9d0f511310880ed60d4da89c41d2133bf5c004433
-  data.tar.gz: 2da99325513c8b7b85d9f9121c95168757f855a1adfe0eca7d4ab164a0481159968544355c79662453aac28aa64d3a18cb70dee6468cbe31453c29c4d91856a3
+  metadata.gz: 42b6d70052957bda4047e034a44aaffdafe78fae4190f141b9c624294be1e685f0e4a1833b41db17605771bbca917ca05e78d22bd02090ac8cd56dee77065e0a
+  data.tar.gz: 158a713f868d6563a1f89eb0c4e2ddf355bbda5c6341df447648681588e1164ae93ca1941e8aa8a4844a8a57661bae4cbb31845aa9855229fff5559e134db432

data/Gemfile.development_dependencies

@@ -2,7 +2,7 @@
 
 eval_gemfile File.expand_path("../Gemfile.shared_dev_dependencies", __dir__)
 
-gem "shakapacker", "9.5.0"
+gem "shakapacker", "9.6.1"
 gem "bootsnap", require: false
 gem "rails", "~> 7.1.0"
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    react_on_rails (16.4.0.rc.6)
+    react_on_rails (16.4.0.rc.7)
       addressable
       connection_pool
       execjs (~> 2.5)
@@ -138,7 +138,7 @@ GEM
     drb (2.2.3)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    erb (6.0.1)
+    erb (6.0.2)
     erubi (1.13.1)
     execjs (2.9.1)
     ffi (1.16.3)
@@ -153,8 +153,9 @@ GEM
       concurrent-ruby (~> 1.0)
     interception (0.5)
     io-console (0.8.2)
-    irb (1.16.0)
+    irb (1.17.0)
       pp (>= 0.6.0)
+      prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     jbuilder (2.12.0)
@@ -188,7 +189,8 @@ GEM
     method_source (1.1.0)
     mini_mime (1.1.5)
     mini_portile2 (2.8.9)
-    minitest (6.0.1)
+    minitest (6.0.2)
+      drb (~> 2.0)
       prism (~> 1.5)
     msgpack (1.7.2)
     mutex_m (0.3.0)
@@ -202,7 +204,7 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.5)
-    nokogiri (1.19.0)
+    nokogiri (1.19.1)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     ostruct (0.6.1)
@@ -214,7 +216,7 @@ GEM
     pp (0.6.3)
       prettyprint
     prettyprint (0.2.0)
-    prism (1.8.0)
+    prism (1.9.0)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -236,7 +238,7 @@ GEM
     puma (6.6.1)
       nio4r (~> 2.0)
     racc (1.8.1)
-    rack (3.2.4)
+    rack (3.2.5)
     rack-proxy (0.7.7)
       rack
     rack-session (2.1.1)
@@ -264,8 +266,8 @@ GEM
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.2)
-      loofah (~> 2.21)
+    rails-html-sanitizer (1.7.0)
+      loofah (~> 2.25)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
     railties (7.1.6)
       actionpack (= 7.1.6)
@@ -284,7 +286,7 @@ GEM
       ffi (~> 1.0)
     rbs (3.9.5)
       logger
-    rdoc (7.1.0)
+    rdoc (7.2.0)
       erb
       psych (>= 4.0.0)
       tsort
@@ -359,8 +361,8 @@ GEM
       rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2, < 3.0)
       websocket (~> 1.0)
-    semantic_range (3.1.0)
-    shakapacker (9.5.0)
+    semantic_range (3.1.1)
+    shakapacker (9.6.1)
       activesupport (>= 5.2)
       package_json
       rack-proxy (>= 0.6.1)
@@ -435,7 +437,7 @@ GEM
     xpath (3.2.0)
       nokogiri (~> 1.8)
     yard (0.9.36)
-    zeitwerk (2.7.4)
+    zeitwerk (2.7.5)
 
 PLATFORMS
   ruby
@@ -478,7 +480,7 @@ DEPENDENCIES
   sass-rails (~> 6.0)
   sdoc
   selenium-webdriver (= 4.9.0)
-  shakapacker (= 9.5.0)
+  shakapacker (= 9.6.1)
   spring (~> 4.0)
   sprockets (~> 4.0)
   sqlite3 (~> 1.6)

data/lib/generators/react_on_rails/base_generator.rb

@@ -39,6 +39,14 @@ module ReactOnRails
                    default: false,
                    desc: "Setup React Server Components (requires Pro)"
 
+      # Hidden option: signals that Shakapacker was just installed by install_generator.
+      # When true, copy_packer_config uses force: true to overwrite Shakapacker's default config
+      # without prompting, since we know it's a fresh default (not user-customized).
+      class_option :shakapacker_just_installed,
+                   type: :boolean,
+                   default: false,
+                   hide: true
+
       def add_hello_world_route
         # RSC uses HelloServer instead of HelloWorld, but Redux still needs hello_world route
         return if use_rsc? && !options.redux?
@@ -59,6 +67,7 @@ module ReactOnRails
                         Procfile.dev-static-assets
                         Procfile.dev-prod-assets
                         .dev-services.yml.example
+                        .env.example
                         bin/shakapacker-precompile-hook]
 
         # HelloServer uses the hello_world layout so React on Rails can inject generated
@@ -75,7 +84,11 @@ module ReactOnRails
         end
 
         # Make the hook script executable (copy_file guarantees it exists)
-        File.chmod(0o755, File.join(destination_root, "bin/shakapacker-precompile-hook"))
+        if options[:pretend]
+          say_status :pretend, "Skipping chmod on shakapacker-precompile-hook in --pretend mode", :yellow
+        else
+          File.chmod(0o755, File.join(destination_root, "bin/shakapacker-precompile-hook"))
+        end
       end
 
       def copy_js_bundle_files
@@ -91,7 +104,7 @@ module ReactOnRails
       end
 
       def copy_webpack_config
-        puts "Adding Webpack config"
+        puts "Adding #{using_rspack? ? 'Rspack' : 'Webpack'} config"
         base_path = "base/base"
         base_files = %w[babel.config.js
                         config/webpack/clientWebpackConfig.js
@@ -104,32 +117,38 @@ module ReactOnRails
         config = {
           message: "// The source code including full typescript support is available at:"
         }
-        base_files.each { |file| template("#{base_path}/#{file}.tt", file, config) }
+        base_files.each do |file|
+          template("#{base_path}/#{file}.tt", destination_config_path(file), config)
+        end
 
         # Handle webpack.config.js separately with smart replacement
         copy_webpack_main_config(base_path, config)
       end
 
       def copy_packer_config
-        # Skip copying if Shakapacker was just installed (to avoid conflicts)
-        # Check for a temporary marker file that indicates fresh Shakapacker install
-        if File.exist?(".shakapacker_just_installed")
-          puts "Skipping Shakapacker config copy (already installed by Shakapacker installer)"
-          File.delete(".shakapacker_just_installed") # Clean up marker
+        base_path = "base/base/"
+        config = "config/shakapacker.yml"
+
+        if options.shakapacker_just_installed?
+          puts "Replacing Shakapacker default config with React on Rails version"
+          # Shakapacker's installer just created this file from scratch (no pre-existing config).
+          # Safe to overwrite silently with RoR's version-aware template (e.g., private_output_path).
+          template("#{base_path}#{config}.tt", config, force: true)
         else
           puts "Adding Shakapacker #{ReactOnRails::PackerUtils.shakapacker_version} config"
-          base_path = "base/base/"
-          config = "config/shakapacker.yml"
-          # Use template to enable version-aware configuration
+          # Thor handles the conflict: prompts user interactively, or respects --force/--skip flags.
           template("#{base_path}#{config}.tt", config)
         end
 
         # Configure bundler-specific settings
-        configure_rspack_in_shakapacker if options.rspack?
+        configure_rspack_in_shakapacker if using_rspack?
 
         # Always ensure precompile_hook is configured (Shakapacker 9.0+ only)
-        # This handles all scenarios: fresh install, pre-installed Shakapacker, or user declined overwrite
         configure_precompile_hook_in_shakapacker
+
+        # For SSR bundles, configure Shakapacker private_output_path (9.0+ only)
+        # This keeps Shakapacker and React on Rails server bundle paths in sync.
+        configure_private_output_path_in_shakapacker
       end
 
       def add_base_gems_to_gemfile
@@ -145,11 +164,12 @@ module ReactOnRails
         additions = []
         additions << "**/generated/**" unless gitignore_content.include?("**/generated/**")
         additions << "ssr-generated" unless gitignore_content.include?("ssr-generated")
+        additions << ".env" unless gitignore_content.match?(/^\.env$/)
 
         return if additions.empty?
 
         append_to_file ".gitignore" do
-          lines = ["\n# Generated React on Rails packs"]
+          lines = ["\n# React on Rails (generated and local files)"]
           lines.concat(additions)
           "#{lines.join("\n")}\n"
         end
@@ -176,7 +196,7 @@ module ReactOnRails
       private
 
       def copy_webpack_main_config(base_path, config)
-        webpack_config_path = "config/webpack/webpack.config.js"
+        webpack_config_path = bundler_main_config_path
 
         if File.exist?(webpack_config_path)
           existing_content = File.read(webpack_config_path)
@@ -188,7 +208,7 @@ module ReactOnRails
             # Show what we're doing
             puts "   #{set_color('replace', :green)}  #{webpack_config_path} " \
                  "(auto-upgrading from standard Shakapacker to React on Rails config)"
-            template("#{base_path}/#{webpack_config_path}.tt", webpack_config_path, config)
+            template("#{base_path}/config/webpack/webpack.config.js.tt", webpack_config_path, config)
           elsif react_on_rails_config?(existing_content)
             puts "   #{set_color('identical', :blue)}  #{webpack_config_path} " \
                  "(already React on Rails compatible)"
@@ -198,17 +218,19 @@ module ReactOnRails
           end
         else
           # File doesn't exist, create it
-          template("#{base_path}/#{webpack_config_path}.tt", webpack_config_path, config)
+          template("#{base_path}/config/webpack/webpack.config.js.tt", webpack_config_path, config)
         end
       end
 
       def handle_custom_webpack_config(base_path, config, webpack_config_path)
         # Custom config - ask user
-        puts "\n#{set_color('NOTICE:', :yellow)} Your webpack.config.js appears to be customized."
+        config_file_name = File.basename(webpack_config_path)
+        bundler_name = using_rspack? ? "rspack" : "webpack"
+        puts "\n#{set_color('NOTICE:', :yellow)} Your #{config_file_name} appears to be customized."
         puts "React on Rails needs to replace it with an environment-specific loader."
-        puts "Your current config will be backed up to webpack.config.js.backup"
+        puts "Your current config will be backed up to #{config_file_name}.backup"
 
-        if yes?("Replace webpack.config.js with React on Rails version? (Y/n)")
+        if yes?("Replace #{config_file_name} with React on Rails version? (Y/n)")
           # Create backup
           backup_path = "#{webpack_config_path}.backup"
           if File.exist?(webpack_config_path)
@@ -216,11 +238,19 @@ module ReactOnRails
             puts "   #{set_color('create', :green)}  #{backup_path} (backup of your custom config)"
           end
 
-          template("#{base_path}/#{webpack_config_path}.tt", webpack_config_path, config)
+          template("#{base_path}/config/webpack/webpack.config.js.tt", webpack_config_path, config)
         else
           puts "   #{set_color('skip', :yellow)}  #{webpack_config_path}"
           puts "   #{set_color('WARNING:', :red)} React on Rails may not work correctly " \
-               "without the environment-specific webpack config"
+               "without the environment-specific #{bundler_name} config"
+        end
+      end
+
+      def bundler_main_config_path
+        if using_rspack?
+          "config/rspack/rspack.config.js"
+        else
+          "config/webpack/webpack.config.js"
         end
       end
 
@@ -279,6 +309,22 @@ module ReactOnRails
           module.exports = webpackConfig
         CONFIG
 
+        # Shakapacker v9+ rspack configs (generateRspackConfig function)
+        configs << <<~CONFIG
+          // See the shakacode/shakapacker README and docs directory for advice on customizing your rspackConfig.
+          const { generateRspackConfig } = require('shakapacker/rspack')
+
+          const rspackConfig = generateRspackConfig()
+
+          module.exports = rspackConfig
+        CONFIG
+
+        configs << <<~CONFIG
+          const { generateRspackConfig } = require('shakapacker/rspack')
+          const rspackConfig = generateRspackConfig()
+          module.exports = rspackConfig
+        CONFIG
+
         configs
       end
 
@@ -362,6 +408,46 @@ module ReactOnRails
 
         puts Rainbow("✅ Configured precompile_hook in shakapacker.yml").green
       end
+
+      def configure_private_output_path_in_shakapacker
+        # private_output_path is only supported in Shakapacker 9.0+
+        return unless ReactOnRails::PackerUtils.shakapacker_version_requirement_met?("9.0.0")
+
+        shakapacker_config_path = "config/shakapacker.yml"
+        return unless File.exist?(shakapacker_config_path)
+
+        content = File.read(shakapacker_config_path)
+
+        # A non-empty active value means the app already made an explicit choice.
+        return if content.match?(/^\s+private_output_path:\s*\S+/)
+
+        # Normalize an empty active key before falling back to insertion.
+        gsub_file(
+          shakapacker_config_path,
+          /^(\s*)private_output_path:\s*$/,
+          "\\1private_output_path: ssr-generated"
+        )
+
+        # First try: uncomment an existing private_output_path placeholder line.
+        gsub_file(
+          shakapacker_config_path,
+          /^(\s*)#\s*private_output_path:\s*.*$/,
+          "\\1private_output_path: ssr-generated"
+        )
+
+        # Fallback: insert directly after public_output_path in the same section.
+        unless File.read(shakapacker_config_path).match?(/^\s+private_output_path:\s*ssr-generated/)
+          gsub_file(
+            shakapacker_config_path,
+            /^(\s*)(public_output_path:\s*.*\n)/,
+            "\\1\\2\\1private_output_path: ssr-generated\n"
+          )
+        end
+
+        return unless File.read(shakapacker_config_path).match?(/^\s+private_output_path:\s*ssr-generated/)
+
+        puts Rainbow("✅ Configured private_output_path in shakapacker.yml").green
+      end
     end
   end
 end

data/lib/generators/react_on_rails/generator_helper.rb

@@ -145,6 +145,36 @@ module GeneratorHelper
     options[:rsc]
   end
 
+  # Determine if the project is using rspack as the bundler.
+  #
+  # Detection priority:
+  # 1. Explicit --rspack option (most reliable during fresh installs)
+  # 2. config/shakapacker.yml assets_bundler setting (for standalone generators
+  #    like `rails g react_on_rails:rsc` on an existing rspack project)
+  #
+  # @return [Boolean] true if rspack is the configured bundler
+  def using_rspack?
+    return @using_rspack if defined?(@using_rspack)
+
+    # options.key?(:rspack) is true when the generator declares --rspack (e.g. InstallGenerator),
+    # false when it does not (e.g. RscGenerator, ProGenerator). Using .key? rather than .nil?
+    # check on the value makes the intent explicit and avoids relying on Thor returning nil for
+    # undeclared options.
+    @using_rspack = options.key?(:rspack) ? options[:rspack] : rspack_configured_in_project?
+  end
+
+  # Remap a config path from config/webpack/ to config/rspack/ when using rspack.
+  # Source templates always live under config/webpack/ (template names are stable);
+  # this method handles the destination remapping.
+  #
+  # @param path [String] relative path, e.g. "config/webpack/serverWebpackConfig.js"
+  # @return [String] remapped path when rspack, unchanged otherwise
+  def destination_config_path(path)
+    return path unless using_rspack?
+
+    path.sub(%r{\Aconfig/webpack/}, "config/rspack/")
+  end
+
   # Detect the installed React version from package.json
   # Uses VERSION_PARTS_REGEX pattern from VersionChecker for consistency
   #
@@ -228,8 +258,8 @@ module GeneratorHelper
   #
   # @return [String, nil] relative config path, or nil if neither file exists
   def resolve_server_client_or_both_path
-    new_path = "config/webpack/ServerClientOrBoth.js"
-    old_path = "config/webpack/generateWebpackConfigs.js"
+    new_path = destination_config_path("config/webpack/ServerClientOrBoth.js")
+    old_path = destination_config_path("config/webpack/generateWebpackConfigs.js")
     full_new = File.join(destination_root, new_path)
     full_old = File.join(destination_root, old_path)
 
@@ -238,7 +268,7 @@ module GeneratorHelper
     elsif File.exist?(full_old)
       FileUtils.mv(full_old, full_new)
       %w[development.js production.js test.js].each do |env_file|
-        env_path = "config/webpack/#{env_file}"
+        env_path = destination_config_path("config/webpack/#{env_file}")
         if File.exist?(File.join(destination_root, env_path))
           gsub_file(env_path, /generateWebpackConfigs/, "ServerClientOrBoth")
         end
@@ -249,6 +279,10 @@ module GeneratorHelper
 
   private
 
+  # NOTE: only the `default:` section is inspected — same assumption as
+  # rspack_configured_in_project?. Projects that set `javascript_transpiler`
+  # only in per-environment sections (without a `default:` block) will not be
+  # detected. In practice Shakapacker always places it in `default: &default`.
   def detect_swc_configuration
     shakapacker_yml_path = File.join(destination_root, "config/shakapacker.yml")
 
@@ -296,4 +330,20 @@ module GeneratorHelper
     # If we can't determine version, assume latest (which uses SWC)
     true
   end
+
+  # Detect rspack from config/shakapacker.yml when no explicit --rspack option is available.
+  # Used by standalone generators (RscGenerator, ProGenerator) on existing projects.
+  #
+  # Note: only the `default:` section is inspected. Projects that set `assets_bundler`
+  # only in per-environment sections (without a `default:` block) will not be detected.
+  # This is not a concern in practice: Shakapacker's install template always places
+  # `assets_bundler` inside the `default: &default` block, and our generator writes
+  # it there too via configure_rspack_in_shakapacker.
+  def rspack_configured_in_project?
+    shakapacker_yml_path = File.join(destination_root, "config/shakapacker.yml")
+    return false unless File.exist?(shakapacker_yml_path)
+
+    config = parse_shakapacker_yml(shakapacker_yml_path)
+    config.dig("default", "assets_bundler") == "rspack"
+  end
 end

data/lib/generators/react_on_rails/generator_messages.rb

@@ -38,11 +38,12 @@ module GeneratorMessages
       @output = []
     end
 
-    def helpful_message_after_installation(component_name: "HelloWorld", route: "hello_world", rsc: false)
+    def helpful_message_after_installation(component_name: "HelloWorld", route: "hello_world", rsc: false,
+                                           shakapacker_just_installed: false)
       process_manager_section = build_process_manager_section
       testing_section = build_testing_section
       package_manager = detect_package_manager
-      shakapacker_status = build_shakapacker_status_section
+      shakapacker_status = build_shakapacker_status_section(shakapacker_just_installed: shakapacker_just_installed)
       render_example = build_render_example(component_name: component_name, route: route, rsc: rsc)
       render_label = if rsc
                        "• Streaming server rendering in app/views/#{route}/index.html.erb:"
@@ -142,11 +143,11 @@ module GeneratorMessages
       end
     end
 
-    def build_shakapacker_status_section
+    def build_shakapacker_status_section(shakapacker_just_installed: false)
       version_warning = check_shakapacker_version_warning
 
-      if File.exist?(".shakapacker_just_installed")
-        base_message = <<~SHAKAPACKER
+      if shakapacker_just_installed
+        base = <<~SHAKAPACKER
 
           📦 SHAKAPACKER SETUP:
           ─────────────────────────────────────────────────────────────────────────
@@ -154,7 +155,7 @@ module GeneratorMessages
           #{Rainbow('✓ Installer ran successfully').green}
           #{Rainbow('✓ Webpack integration configured').green}
         SHAKAPACKER
-        base_message + version_warning
+        base.chomp + version_warning
       elsif File.exist?("bin/shakapacker") && File.exist?("bin/shakapacker-dev-server")
         "\n📦 #{Rainbow('Shakapacker already configured ✓').green}#{version_warning}"
       else