react_on_rails 16.1.2 → 16.2.0

data/Steepfile

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Steepfile - Configuration for Steep type checker
+# See https://github.com/soutaro/steep for documentation
+#
+# IMPORTANT: This file lists only the files that are ready for type checking.
+# We use a positive list (explicit check statements) rather than checking all files
+# because not all files have RBS signatures yet.
+#
+# Files/directories intentionally excluded (no RBS signatures yet):
+# - lib/generators/**/*           - Rails generators (complex Rails integration)
+# - lib/react_on_rails/engine.rb  - Rails engine setup
+# - lib/react_on_rails/doctor.rb  - Diagnostic tool
+# - lib/react_on_rails/locales/**/* - I18n files
+# - lib/react_on_rails/props_js_builder.rb - TODO: Add signature
+# - lib/react_on_rails/shakapacker/**/* - Shakapacker integration (complex)
+#
+# To add a new file to type checking:
+# 1. Create corresponding RBS signature in sig/react_on_rails/filename.rbs
+# 2. Add `check "lib/react_on_rails/filename.rb"` below
+# 3. Run `bundle exec rake rbs:steep` to verify
+# 4. Fix any type errors before committing
+
+D = Steep::Diagnostic
+
+target :lib do
+  # Core files with RBS signatures (alphabetically ordered for easy maintenance)
+  check "lib/react_on_rails.rb"
+  check "lib/react_on_rails/configuration.rb"
+  check "lib/react_on_rails/controller.rb"
+  check "lib/react_on_rails/dev/file_manager.rb"
+  check "lib/react_on_rails/dev/pack_generator.rb"
+  check "lib/react_on_rails/dev/process_manager.rb"
+  check "lib/react_on_rails/dev/server_manager.rb"
+  check "lib/react_on_rails/dev/service_checker.rb"
+  check "lib/react_on_rails/git_utils.rb"
+  check "lib/react_on_rails/helper.rb"
+  check "lib/react_on_rails/packer_utils.rb"
+  check "lib/react_on_rails/server_rendering_pool.rb"
+  check "lib/react_on_rails/test_helper.rb"
+  check "lib/react_on_rails/utils.rb"
+  check "lib/react_on_rails/version_checker.rb"
+
+  # Specify RBS signature directories
+  signature "sig"
+
+  # Configure libraries (gems) - Steep will load their RBS signatures
+  configure_code_diagnostics(D::Ruby.default)
+
+  # Library configuration - standard library gems used by checked files
+  library "pathname"
+  library "singleton"
+  library "logger"
+  library "monitor"
+  library "securerandom"
+end

data/lib/generators/react_on_rails/base_generator.rb

@@ -4,10 +4,12 @@ require "rails/generators"
 require "fileutils"
 require_relative "generator_messages"
 require_relative "generator_helper"
+require_relative "js_dependency_manager"
 module ReactOnRails
   module Generators
     class BaseGenerator < Rails::Generators::Base
       include GeneratorHelper
+      include JsDependencyManager
 
       Rails::Generators.hide_namespace(namespace)
       source_root(File.expand_path("templates", __dir__))
@@ -19,6 +21,12 @@ module ReactOnRails
                    desc: "Install Redux package and Redux version of Hello World Example",
                    aliases: "-R"
 
+      # --rspack
+      class_option :rspack,
+                   type: :boolean,
+                   default: false,
+                   desc: "Use Rspack instead of Webpack as the bundler"
+
       def add_hello_world_route
         route "get 'hello_world', to: 'hello_world#index'"
       end
@@ -37,12 +45,17 @@ module ReactOnRails
                         app/views/layouts/hello_world.html.erb
                         Procfile.dev
                         Procfile.dev-static-assets
-                        Procfile.dev-prod-assets]
+                        Procfile.dev-prod-assets
+                        .dev-services.yml.example
+                        bin/shakapacker-precompile-hook]
         base_templates = %w[config/initializers/react_on_rails.rb]
         base_files.each { |file| copy_file("#{base_path}#{file}", file) }
         base_templates.each do |file|
           template("#{base_path}/#{file}.tt", file)
         end
+
+        # Make the hook script executable (copy_file guarantees it exists)
+        File.chmod(0o755, File.join(destination_root, "bin/shakapacker-precompile-hook"))
       end
 
       def copy_js_bundle_files
@@ -82,20 +95,23 @@ module ReactOnRails
         if File.exist?(".shakapacker_just_installed")
           puts "Skipping Shakapacker config copy (already installed by Shakapacker installer)"
           File.delete(".shakapacker_just_installed") # Clean up marker
+          configure_rspack_in_shakapacker if options.rspack?
           return
         end
 
         puts "Adding Shakapacker #{ReactOnRails::PackerUtils.shakapacker_version} config"
         base_path = "base/base/"
         config = "config/shakapacker.yml"
-        copy_file("#{base_path}#{config}", config)
+        # Use template to enable version-aware configuration
+        template("#{base_path}#{config}.tt", config)
+        configure_rspack_in_shakapacker if options.rspack?
       end
 
       def add_base_gems_to_gemfile
         run "bundle"
       end
 
-      def update_gitignore_for_generated_bundles
+      def update_gitignore_for_auto_registration
         gitignore_path = File.join(destination_root, ".gitignore")
         return unless File.exist?(gitignore_path)
 
@@ -134,123 +150,6 @@ module ReactOnRails
 
       private
 
-      def setup_js_dependencies
-        add_js_dependencies
-        install_js_dependencies
-      end
-
-      def add_js_dependencies
-        add_react_on_rails_package
-        add_react_dependencies
-        add_css_dependencies
-        add_dev_dependencies
-      end
-
-      def add_react_on_rails_package
-        major_minor_patch_only = /\A\d+\.\d+\.\d+\z/
-
-        # Try to use package_json gem first, fall back to direct npm commands
-        react_on_rails_pkg = if ReactOnRails::VERSION.match?(major_minor_patch_only)
-                               ["react-on-rails@#{ReactOnRails::VERSION}"]
-                             else
-                               puts "Adding the latest react-on-rails NPM module. " \
-                                    "Double check this is correct in package.json"
-                               ["react-on-rails"]
-                             end
-
-        puts "Installing React on Rails package..."
-        return if add_npm_dependencies(react_on_rails_pkg)
-
-        puts "Using direct npm commands as fallback"
-        success = system("npm", "install", *react_on_rails_pkg)
-        handle_npm_failure("react-on-rails package", react_on_rails_pkg) unless success
-      end
-
-      def add_react_dependencies
-        puts "Installing React dependencies..."
-        react_deps = %w[
-          react
-          react-dom
-          @babel/preset-react
-          prop-types
-          babel-plugin-transform-react-remove-prop-types
-          babel-plugin-macros
-        ]
-        return if add_npm_dependencies(react_deps)
-
-        success = system("npm", "install", *react_deps)
-        handle_npm_failure("React dependencies", react_deps) unless success
-      end
-
-      def add_css_dependencies
-        puts "Installing CSS handling dependencies..."
-        css_deps = %w[
-          css-loader
-          css-minimizer-webpack-plugin
-          mini-css-extract-plugin
-          style-loader
-        ]
-        return if add_npm_dependencies(css_deps)
-
-        success = system("npm", "install", *css_deps)
-        handle_npm_failure("CSS dependencies", css_deps) unless success
-      end
-
-      def add_dev_dependencies
-        puts "Installing development dependencies..."
-        dev_deps = %w[
-          @pmmmwh/react-refresh-webpack-plugin
-          react-refresh
-        ]
-        return if add_npm_dependencies(dev_deps, dev: true)
-
-        success = system("npm", "install", "--save-dev", *dev_deps)
-        handle_npm_failure("development dependencies", dev_deps, dev: true) unless success
-      end
-
-      def install_js_dependencies
-        # Detect which package manager to use
-        success = if File.exist?(File.join(destination_root, "yarn.lock"))
-                    system("yarn", "install")
-                  elsif File.exist?(File.join(destination_root, "pnpm-lock.yaml"))
-                    system("pnpm", "install")
-                  elsif File.exist?(File.join(destination_root, "package-lock.json")) ||
-                        File.exist?(File.join(destination_root, "package.json"))
-                    # Use npm for package-lock.json or as default fallback
-                    system("npm", "install")
-                  else
-                    true # No package manager detected, skip
-                  end
-
-        unless success
-          GeneratorMessages.add_warning(<<~MSG.strip)
-            ⚠️  JavaScript dependencies installation failed.
-
-            This could be due to network issues or missing package manager.
-            You can install dependencies manually later by running:
-            • npm install (if using npm)
-            • yarn install (if using yarn)
-            • pnpm install (if using pnpm)
-          MSG
-        end
-
-        success
-      end
-
-      def handle_npm_failure(dependency_type, packages, dev: false)
-        install_command = dev ? "npm install --save-dev" : "npm install"
-        GeneratorMessages.add_warning(<<~MSG.strip)
-          ⚠️  Failed to install #{dependency_type}.
-
-          The following packages could not be installed automatically:
-          #{packages.map { |pkg| "  • #{pkg}" }.join("\n")}
-
-          This could be due to network issues or missing package manager.
-          You can install them manually later by running:
-            #{install_command} #{packages.join(' ')}
-        MSG
-      end
-
       def copy_webpack_main_config(base_path, config)
         webpack_config_path = "config/webpack/webpack.config.js"
 
@@ -392,6 +291,30 @@ module ReactOnRails
         search_str = "RSpec.configure do |config|"
         gsub_file(helper_file, search_str, CONFIGURE_RSPEC_TO_COMPILE_ASSETS)
       end
+
+      def configure_rspack_in_shakapacker
+        shakapacker_config_path = "config/shakapacker.yml"
+        return unless File.exist?(shakapacker_config_path)
+
+        puts Rainbow("🔧 Configuring Shakapacker for Rspack...").yellow
+
+        # Parse YAML config properly to avoid fragile regex manipulation
+        # Support both old and new Psych versions
+        config = begin
+          YAML.load_file(shakapacker_config_path, aliases: true)
+        rescue ArgumentError
+          # Older Psych versions don't support the aliases parameter
+          YAML.load_file(shakapacker_config_path)
+        end
+        # Update default section
+        config["default"] ||= {}
+        config["default"]["assets_bundler"] = "rspack"
+        config["default"]["webpack_loader"] = "swc"
+
+        # Write back as YAML
+        File.write(shakapacker_config_path, YAML.dump(config))
+        puts Rainbow("✅ Updated shakapacker.yml for Rspack").green
+      end
     end
   end
 end

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -31,7 +31,8 @@ module ReactOnRails
 
       def add_test_related_gems_to_gemfile
         gem("rspec-rails", group: :test)
-        gem("chromedriver-helper", group: :test)
+        # NOTE: chromedriver-helper was deprecated in 2019. Modern selenium-webdriver (4.x)
+        # and GitHub Actions have built-in driver management, so no driver helper is needed.
         gem("coveralls", require: false)
       end
 

data/lib/generators/react_on_rails/generator_helper.rb

@@ -26,9 +26,9 @@ module GeneratorHelper
 
     begin
       if dev
-        pj.manager.add(packages, type: :dev)
+        pj.manager.add(packages, type: :dev, exact: true)
       else
-        pj.manager.add(packages)
+        pj.manager.add(packages, exact: true)
       end
       true
     rescue StandardError => e
@@ -95,4 +95,104 @@ module GeneratorHelper
   def component_extension(options)
     options.typescript? ? "tsx" : "jsx"
   end
+
+  # Check if Shakapacker 9.0 or higher is available
+  # Returns true if Shakapacker >= 9.0, false otherwise
+  #
+  # This method is used during code generation to determine which configuration
+  # patterns to use in generated files (e.g., config.privateOutputPath vs hardcoded paths).
+  #
+  # @return [Boolean] true if Shakapacker 9.0+ is available or likely to be installed
+  #
+  # @note Default behavior: Returns true when Shakapacker is not yet installed
+  #   Rationale: During fresh installations, we optimistically assume users will install
+  #   the latest Shakapacker version. This ensures new projects get best-practice configs.
+  #   If users later install an older version, the generated webpack config includes
+  #   fallback logic (e.g., `config.privateOutputPath || hardcodedPath`) that prevents
+  #   breakage, and validation warnings guide them to fix any misconfigurations.
+  def shakapacker_version_9_or_higher?
+    return @shakapacker_version_9_or_higher if defined?(@shakapacker_version_9_or_higher)
+
+    @shakapacker_version_9_or_higher = begin
+      # If Shakapacker is not available yet (fresh install), default to true
+      # since we're likely installing the latest version
+      return true unless defined?(ReactOnRails::PackerUtils)
+
+      ReactOnRails::PackerUtils.shakapacker_version_requirement_met?("9.0.0")
+    rescue StandardError
+      # If we can't determine version, assume latest
+      true
+    end
+  end
+
+  # Check if SWC is configured as the JavaScript transpiler in shakapacker.yml
+  #
+  # @return [Boolean] true if SWC is configured or should be used by default
+  #
+  # Detection logic:
+  # 1. If shakapacker.yml exists and specifies javascript_transpiler: parse it
+  # 2. For Shakapacker 9.3.0+, SWC is the default if not specified
+  # 3. Returns true for fresh installations (SWC is recommended default)
+  #
+  # @note This method is used to determine whether to install SWC dependencies
+  #   (@swc/core, swc-loader) instead of Babel dependencies during generation.
+  #
+  # @note Caching: The result is memoized for the lifetime of the generator instance.
+  #   If shakapacker.yml changes during generator execution (unlikely), the cached
+  #   value will not update. This is acceptable since generators run quickly.
+  def using_swc?
+    return @using_swc if defined?(@using_swc)
+
+    @using_swc = detect_swc_configuration
+  end
+
+  private
+
+  def detect_swc_configuration
+    shakapacker_yml_path = File.join(destination_root, "config/shakapacker.yml")
+
+    if File.exist?(shakapacker_yml_path)
+      config = parse_shakapacker_yml(shakapacker_yml_path)
+      transpiler = config.dig("default", "javascript_transpiler")
+
+      # Explicit configuration takes precedence
+      return transpiler == "swc" if transpiler
+
+      # For Shakapacker 9.3.0+, SWC is the default
+      return shakapacker_version_9_3_or_higher?
+    end
+
+    # Fresh install: SWC is recommended default for Shakapacker 9.3.0+
+    shakapacker_version_9_3_or_higher?
+  end
+
+  def parse_shakapacker_yml(path)
+    require "yaml"
+    # Use safe_load_file for security (defense-in-depth, even though this is user's own config)
+    # permitted_classes: [Symbol] allows symbol keys which shakapacker.yml may use
+    # aliases: true allows YAML anchors (&default, *default) commonly used in Rails configs
+    YAML.safe_load_file(path, permitted_classes: [Symbol], aliases: true)
+  rescue ArgumentError
+    # Older Psych versions don't support all parameters - try without aliases
+    begin
+      YAML.safe_load_file(path, permitted_classes: [Symbol])
+    rescue ArgumentError
+      # Very old Psych - fall back to safe_load with File.read
+      YAML.safe_load(File.read(path), permitted_classes: [Symbol]) # rubocop:disable Style/YAMLFileRead
+    end
+  rescue StandardError
+    # If we can't parse the file, return empty config
+    {}
+  end
+
+  # Check if Shakapacker 9.3.0 or higher is available
+  # This version made SWC the default JavaScript transpiler
+  def shakapacker_version_9_3_or_higher?
+    return true unless defined?(ReactOnRails::PackerUtils)
+
+    ReactOnRails::PackerUtils.shakapacker_version_requirement_met?("9.3.0")
+  rescue StandardError
+    # If we can't determine version, assume latest (which uses SWC)
+    true
+  end
 end

data/lib/generators/react_on_rails/install_generator.rb

@@ -4,12 +4,14 @@ require "rails/generators"
 require "json"
 require_relative "generator_helper"
 require_relative "generator_messages"
+require_relative "js_dependency_manager"
 
 module ReactOnRails
   module Generators
     # rubocop:disable Metrics/ClassLength
     class InstallGenerator < Rails::Generators::Base
       include GeneratorHelper
+      include JsDependencyManager
 
       # fetch USAGE file for details generator description
       source_root(File.expand_path(__dir__))
@@ -28,6 +30,12 @@ module ReactOnRails
                    desc: "Generate TypeScript files and install TypeScript dependencies. Default: false",
                    aliases: "-T"
 
+      # --rspack
+      class_option :rspack,
+                   type: :boolean,
+                   default: false,
+                   desc: "Use Rspack instead of Webpack as the bundler. Default: false"
+
       # --ignore-warnings
       class_option :ignore_warnings,
                    type: :boolean,
@@ -36,7 +44,25 @@ module ReactOnRails
 
       # Removed: --skip-shakapacker-install (Shakapacker is now a required dependency)
 
+      # Main generator entry point
+      #
+      # Sets up React on Rails in a Rails application by:
+      # 1. Validating prerequisites
+      # 2. Installing required packages
+      # 3. Generating configuration files
+      # 4. Setting up example components
+      #
+      # @note Validation Skipping: Sets ENV["REACT_ON_RAILS_SKIP_VALIDATION"] to prevent
+      #   version validation from running during generator execution. The npm package
+      #   isn't installed until midway through the generator, so validation would fail
+      #   if run during Rails initialization. The ensure block guarantees cleanup even
+      #   if the generator fails.
       def run_generators
+        # Set environment variable to skip validation during generator run
+        # This is inherited by all invoked generators and persists through Rails initialization
+        # See lib/react_on_rails/engine.rb for the validation skip logic
+        ENV["REACT_ON_RAILS_SKIP_VALIDATION"] = "true"
+
         if installation_prerequisites_met? || options.ignore_warnings?
           invoke_generators
           add_bin_scripts
@@ -55,6 +81,11 @@ module ReactOnRails
           GeneratorMessages.add_error(error)
         end
       ensure
+        # Always clean up ENV variable, even if generator fails
+        # CRITICAL: ENV cleanup must come first to ensure it executes even if
+        # print_generator_messages raises an exception. This prevents ENV pollution
+        # that could affect subsequent processes.
+        ENV.delete("REACT_ON_RAILS_SKIP_VALIDATION")
         print_generator_messages
       end
 
@@ -73,7 +104,8 @@ module ReactOnRails
           create_css_module_types
           create_typescript_config
         end
-        invoke "react_on_rails:base", [], { typescript: options.typescript? }
+        invoke "react_on_rails:base", [],
+               { typescript: options.typescript?, redux: options.redux?, rspack: options.rspack? }
         if options.redux?
           invoke "react_on_rails:react_with_redux", [], { typescript: options.typescript? }
         else
@@ -83,10 +115,7 @@ module ReactOnRails
       end
 
       def setup_react_dependencies
-        @added_dependencies_to_package_json ||= false
-        @ran_direct_installs ||= false
-        add_js_dependencies
-        install_js_dependencies if @added_dependencies_to_package_json && !@ran_direct_installs
+        setup_js_dependencies
       end
 
       # NOTE: other requirements for existing files such as .gitignore or application.
@@ -336,29 +365,8 @@ module ReactOnRails
 
       def install_typescript_dependencies
         puts Rainbow("📝 Installing TypeScript dependencies...").yellow
-
-        # Install TypeScript and React type definitions
-        typescript_packages = %w[
-          typescript
-          @types/react
-          @types/react-dom
-          @babel/preset-typescript
-        ]
-
-        # Try using GeneratorHelper first (package manager agnostic)
-        return if add_npm_dependencies(typescript_packages, dev: true)
-
-        # Fallback to npm if GeneratorHelper fails
-        success = system("npm", "install", "--save-dev", *typescript_packages)
-        return if success
-
-        warning = <<~MSG.strip
-          ⚠️  Failed to install TypeScript dependencies automatically.
-
-          Please run manually:
-              npm install --save-dev #{typescript_packages.join(' ')}
-        MSG
-        GeneratorMessages.add_warning(warning)
+        # Delegate to shared module for consistent dependency management
+        add_typescript_dependencies
       end
 
       def create_css_module_types
@@ -420,134 +428,6 @@ module ReactOnRails
         puts Rainbow("✅ Created tsconfig.json").green
       end
 
-      def add_js_dependencies
-        add_react_on_rails_package
-        add_react_dependencies
-        add_css_dependencies
-        add_dev_dependencies
-      end
-
-      def add_react_on_rails_package
-        major_minor_patch_only = /\A\d+\.\d+\.\d+\z/
-
-        # Try to use package_json gem first, fall back to direct npm commands
-        react_on_rails_pkg = if ReactOnRails::VERSION.match?(major_minor_patch_only)
-                               ["react-on-rails@#{ReactOnRails::VERSION}"]
-                             else
-                               puts "Adding the latest react-on-rails NPM module. " \
-                                    "Double check this is correct in package.json"
-                               ["react-on-rails"]
-                             end
-
-        puts "Installing React on Rails package..."
-        if add_npm_dependencies(react_on_rails_pkg)
-          @added_dependencies_to_package_json = true
-          return
-        end
-
-        puts "Using direct npm commands as fallback"
-        success = system("npm", "install", *react_on_rails_pkg)
-        @ran_direct_installs = true if success
-        handle_npm_failure("react-on-rails package", react_on_rails_pkg) unless success
-      end
-
-      def add_react_dependencies
-        puts "Installing React dependencies..."
-        react_deps = %w[
-          react
-          react-dom
-          @babel/preset-react
-          prop-types
-          babel-plugin-transform-react-remove-prop-types
-          babel-plugin-macros
-        ]
-        if add_npm_dependencies(react_deps)
-          @added_dependencies_to_package_json = true
-          return
-        end
-
-        success = system("npm", "install", *react_deps)
-        @ran_direct_installs = true if success
-        handle_npm_failure("React dependencies", react_deps) unless success
-      end
-
-      def add_css_dependencies
-        puts "Installing CSS handling dependencies..."
-        css_deps = %w[
-          css-loader
-          css-minimizer-webpack-plugin
-          mini-css-extract-plugin
-          style-loader
-        ]
-        if add_npm_dependencies(css_deps)
-          @added_dependencies_to_package_json = true
-          return
-        end
-
-        success = system("npm", "install", *css_deps)
-        @ran_direct_installs = true if success
-        handle_npm_failure("CSS dependencies", css_deps) unless success
-      end
-
-      def add_dev_dependencies
-        puts "Installing development dependencies..."
-        dev_deps = %w[
-          @pmmmwh/react-refresh-webpack-plugin
-          react-refresh
-        ]
-        if add_npm_dependencies(dev_deps, dev: true)
-          @added_dependencies_to_package_json = true
-          return
-        end
-
-        success = system("npm", "install", "--save-dev", *dev_deps)
-        @ran_direct_installs = true if success
-        handle_npm_failure("development dependencies", dev_deps, dev: true) unless success
-      end
-
-      def install_js_dependencies
-        # Detect which package manager to use
-        success = if File.exist?(File.join(destination_root, "yarn.lock"))
-                    system("yarn", "install")
-                  elsif File.exist?(File.join(destination_root, "pnpm-lock.yaml"))
-                    system("pnpm", "install")
-                  elsif File.exist?(File.join(destination_root, "package-lock.json")) ||
-                        File.exist?(File.join(destination_root, "package.json"))
-                    # Use npm for package-lock.json or as default fallback
-                    system("npm", "install")
-                  else
-                    true # No package manager detected, skip
-                  end
-
-        unless success
-          GeneratorMessages.add_warning(<<~MSG.strip)
-            ⚠️  JavaScript dependencies installation failed.
-
-            This could be due to network issues or missing package manager.
-            You can install dependencies manually later by running:
-            • npm install (if using npm)
-            • yarn install (if using yarn)
-            • pnpm install (if using pnpm)
-          MSG
-        end
-
-        success
-      end
-
-      def handle_npm_failure(dependency_type, packages, dev: false)
-        install_command = dev ? "npm install --save-dev" : "npm install"
-        GeneratorMessages.add_warning(<<~MSG.strip)
-          ⚠️  Failed to install #{dependency_type}.
-
-          The following packages could not be installed automatically:
-          #{packages.map { |pkg| "  • #{pkg}" }.join("\n")}
-
-          This could be due to network issues or missing package manager.
-          You can install them manually later by running:
-            #{install_command} #{packages.join(' ')}
-        MSG
-      end
-
       # Removed: Shakapacker auto-installation logic (now explicit dependency)
 
       # Removed: Shakapacker 8+ is now required as explicit dependency