react_on_rails 16.3.0 → 16.4.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ace0aef17c3665d3f573612c0fb1298834237fab6c25c67dc609fcd844efacf
-  data.tar.gz: 9768eec151936531996266b8635cfa9431014a98219b76c6a501ccba63a42ab2
+  metadata.gz: e73e8a4df085484ab44226919e7e642d67b609b03375b34845ea43f896e2ca43
+  data.tar.gz: c94d4c27cd4ae57c9b382b80327686d918ad2906f561879c04cc90817f89d195
 SHA512:
-  metadata.gz: c1f027af8612019f38ab829a9b99ca50f869112f9b6f0f47fd0af27aa4bf6cabfb1ab45121ce7c4607d12f364292cecc21e8aba863b791f52d6fa557231e9fa2
-  data.tar.gz: 4d6549c75f9615433be29f67d7ea68963e2f7480ad4468f86a9da2f50d1d490f5311ce188ddac3fb422e52cf20aaffa1d24b175214cd4321574fe616b21f42bc
+  metadata.gz: 5eac27c292bd94ffbdb2c61a3d64d0021b39320c7b82778df631c4e231cfafa190a943101a41d57cf053a0b52f948b3dd0f8c0db5d48cc4a7f9e12177043c770
+  data.tar.gz: ab3b3beeda1c9ae9d5bf21b2e6ba946d1ead835ed9e0b6fc7b3017e3cdfdb8c101aab5f25a3fd35f6486c0f2dfdd4e68927f9b0a9d0a9020e709f9e33d0a29bb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    react_on_rails (16.3.0)
+    react_on_rails (16.4.0.rc.0)
       addressable
       connection_pool
       execjs (~> 2.5)

data/Steepfile

@@ -28,6 +28,7 @@ target :lib do
   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/database_checker.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"

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -47,11 +47,18 @@ module ReactOnRails
         File.open(hello_world_index, "w+") { |f| f.puts new_hello_world_contents }
       end
 
-      def add_yarn_relative_install_script_in_package_json
+      def add_react_on_rails_as_file_dependency
+        # Add react-on-rails as a file dependency pointing to the local package
+        # This allows testing with the local npm package without needing yalc
         package_json = File.join(destination_root, "package.json")
         contents = JSON.parse(File.read(package_json))
-        contents["scripts"] ||= {}
-        contents["scripts"]["postinstall"] = "yalc link react-on-rails"
+        contents["dependencies"] ||= {}
+
+        # Calculate relative path from the generated example to the npm package
+        # Generated examples are in gen-examples/examples/<name>/
+        # The npm package is in packages/react-on-rails/
+        contents["dependencies"]["react-on-rails"] = "file:../../../packages/react-on-rails"
+
         File.open(package_json, "w+") { |f| f.puts JSON.pretty_generate(contents) }
       end
     end

data/lib/generators/react_on_rails/install_generator.rb

@@ -2,6 +2,7 @@
 
 require "rails/generators"
 require "json"
+require "bundler"
 require_relative "generator_helper"
 require_relative "generator_messages"
 require_relative "js_dependency_manager"
@@ -218,10 +219,10 @@ module ReactOnRails
       end
 
       def shakapacker_in_lockfile?(gem_name)
-        gemfile = ENV["BUNDLE_GEMFILE"] || "Gemfile"
-        lockfile = File.join(File.dirname(gemfile), "Gemfile.lock")
-
-        File.file?(lockfile) && File.foreach(lockfile).any? { |l| l.match?(/^\s{4}#{Regexp.escape(gem_name)}\s\(/) }
+        # Always check the target app's Gemfile.lock, not inherited BUNDLE_GEMFILE
+        # See: https://github.com/shakacode/react_on_rails/issues/2287
+        File.file?("Gemfile.lock") &&
+          File.foreach("Gemfile.lock").any? { |l| l.match?(/^\s{4}#{Regexp.escape(gem_name)}\s\(/) }
       end
 
       def shakapacker_in_bundler_specs?(gem_name)
@@ -232,10 +233,10 @@ module ReactOnRails
       end
 
       def shakapacker_in_gemfile_text?(gem_name)
-        gemfile = ENV["BUNDLE_GEMFILE"] || "Gemfile"
-
-        File.file?(gemfile) &&
-          File.foreach(gemfile).any? { |l| l.match?(/^\s*gem\s+['"]#{Regexp.escape(gem_name)}['"]/) }
+        # Always check the target app's Gemfile, not inherited BUNDLE_GEMFILE
+        # See: https://github.com/shakacode/react_on_rails/issues/2287
+        File.file?("Gemfile") &&
+          File.foreach("Gemfile").any? { |l| l.match?(/^\s*gem\s+['"]#{Regexp.escape(gem_name)}['"]/) }
       end
 
       def cli_exists?(command)
@@ -263,7 +264,9 @@ module ReactOnRails
         return if shakapacker_in_gemfile?
 
         puts Rainbow("📝 Adding Shakapacker to Gemfile...").yellow
-        success = system("bundle add shakapacker --strict")
+        # Use with_unbundled_env to prevent inheriting BUNDLE_GEMFILE from parent process
+        # See: https://github.com/shakacode/react_on_rails/issues/2287
+        success = Bundler.with_unbundled_env { system("bundle add shakapacker --strict") }
         return if success
 
         handle_shakapacker_gemfile_error
@@ -273,15 +276,16 @@ module ReactOnRails
         puts Rainbow("⚙️  Installing Shakapacker (required for webpack integration)...").yellow
 
         # First run bundle install to make shakapacker available
+        # Use with_unbundled_env to prevent inheriting BUNDLE_GEMFILE from parent process
         puts Rainbow("📦 Running bundle install...").yellow
-        bundle_success = system("bundle install")
+        bundle_success = Bundler.with_unbundled_env { system("bundle install") }
         unless bundle_success
           handle_shakapacker_install_error
           return
         end
 
         # Then run the shakapacker installer
-        success = system("bundle exec rails shakapacker:install")
+        success = Bundler.with_unbundled_env { system("bundle exec rails shakapacker:install") }
         return if success
 
         handle_shakapacker_install_error

data/lib/generators/react_on_rails/templates/base/base/bin/dev

@@ -17,6 +17,49 @@
 # 2. Modify this script for project-specific command-line behavior
 # 3. Extend ReactOnRails::Dev classes in your Rails app for advanced customization
 # 4. Use classes directly: ReactOnRails::Dev::ServerManager.start(:development, "Custom.procfile")
+#
+# EXTENSIBLE PRECOMPILE PATTERN (Alternative to precompile_hook)
+# ===============================================================
+# If your project has custom build requirements (e.g., ReScript, TypeScript
+# compilation, custom locale generation), you can handle precompile tasks
+# directly in this script instead of using the precompile_hook mechanism.
+#
+# Benefits of this approach:
+# - Single place to manage all precompile tasks
+# - Direct Ruby API calls (faster, no shell spawning overhead)
+# - Better version manager compatibility (mise, asdf, rbenv)
+# - Clean Procfiles without embedded precompile logic
+#
+# To use this pattern:
+# 1. Uncomment and customize the run_precompile_tasks method below
+# 2. Remove precompile_hook from config/shakapacker.yml if present
+# 3. Uncomment the run_precompile_tasks call near the bottom of this file
+#
+# See documentation: https://www.shakacode.com/react-on-rails/docs/building-features/extensible-precompile-pattern
+#
+# def run_precompile_tasks
+#   require_relative "../config/environment"
+#
+#   puts "📦 Running precompile tasks..."
+#
+#   # Example: Build ReScript files
+#   # print "   ReScript build... "
+#   # unless system("yarn res:build")
+#   #   puts "❌"
+#   #   exit(1)
+#   # end
+#   # puts "✅"
+#
+#   # Example: Generate locales using direct Ruby API (faster than rake task)
+#   # This avoids shell spawning and version manager PATH issues.
+#   # Exceptions (e.g., missing directories) will bubble up and stop the server,
+#   # which is the desired behavior for catching configuration issues early.
+#   print "   Locale generation... "
+#   ReactOnRails::Locales.compile if ReactOnRails.configuration.i18n_dir.present?
+#   puts "✅"
+#
+#   puts ""
+# end
 
 require "bundler/setup"
 require "react_on_rails/dev"
@@ -31,4 +74,10 @@ DEFAULT_ROUTE = "hello_world"
 argv_with_defaults = ARGV.dup
 argv_with_defaults.push("--route=#{DEFAULT_ROUTE}") unless argv_with_defaults.any? { |arg| arg.start_with?("--route") }
 
+# Uncomment to run custom precompile tasks before starting the server
+# Only run for server start commands (not kill/help)
+# unless ARGV.include?("kill") || ARGV.include?("-h") || ARGV.include?("--help") || ARGV.include?("help")
+#   run_precompile_tasks
+# end
+
 ReactOnRails::Dev::ServerManager.run_from_command_line(argv_with_defaults)

data/lib/generators/react_on_rails/templates/base/base/bin/shakapacker-precompile-hook

@@ -1,6 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# Self-guard: skip if bin/dev already ran precompile tasks.
+# This prevents duplicate execution in HMR mode (two webpack processes)
+# regardless of Shakapacker version.
+exit 0 if ENV["SHAKAPACKER_SKIP_PRECOMPILE_HOOK"] == "true"
+
 # Shakapacker precompile hook for React on Rails
 #
 # This script runs before webpack compilation to generate pack files

data/lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb.tt

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # React on Rails configuration
-# See https://github.com/shakacode/react_on_rails/blob/master/docs/configuration/configuration.md
+# See https://github.com/shakacode/react_on_rails/blob/master/docs/configuration/README.md
 # for complete documentation of all configuration options.
 
 ReactOnRails.configure do |config|
@@ -43,7 +43,7 @@ ReactOnRails.configure do |config|
   # ALTERNATIVE APPROACH: Uncomment below AND configure ReactOnRails::TestHelper
   # - Provides explicit control over test asset compilation timing
   # - Requires adding ReactOnRails::TestHelper to spec/rails_helper.rb
-  # - See: https://github.com/shakacode/react_on_rails/blob/master/docs/guides/testing-configuration.md
+  # - See: https://github.com/shakacode/react_on_rails/blob/master/docs/building-features/testing-configuration.md
   #
   config.build_test_command = "RAILS_ENV=test bin/shakapacker"
 
@@ -62,5 +62,5 @@ ReactOnRails.configure do |config|
   # - Custom rendering extensions
   # - And more...
   #
-  # See: https://github.com/shakacode/react_on_rails/blob/master/docs/configuration/configuration.md
+  # See: https://github.com/shakacode/react_on_rails/blob/master/docs/configuration/README.md
 end

data/lib/react_on_rails/configuration.rb

@@ -58,6 +58,7 @@ module ReactOnRails
       same_bundle_for_client_and_server: false,
       i18n_output_format: nil,
       components_subdirectory: nil,
+      stores_subdirectory: nil,
       make_generated_server_bundle_the_entrypoint: false,
       defer_generated_component_packs: false,
       # Maximum time in milliseconds to wait for client-side component registration after page load.
@@ -66,7 +67,11 @@ module ReactOnRails
       component_registry_timeout: DEFAULT_COMPONENT_REGISTRY_TIMEOUT,
       generated_component_packs_loading_strategy: nil,
       server_bundle_output_path: DEFAULT_SERVER_BUNDLE_OUTPUT_PATH,
-      enforce_private_server_bundles: false
+      enforce_private_server_bundles: false,
+      # Whether to check database connectivity before starting bin/dev.
+      # Set to false to disable (saves ~1-2 seconds startup time).
+      # Can also be disabled via SKIP_DATABASE_CHECK=true or bin/dev --skip-database-check
+      check_database_on_dev_start: true
     )
   end
 
@@ -75,6 +80,7 @@ module ReactOnRails
                   :trace, :development_mode, :logging_on_server, :server_renderer_pool_size,
                   :server_renderer_timeout, :skip_display_none, :raise_on_prerender_error,
                   :generated_assets_dirs, :generated_assets_dir, :components_subdirectory,
+                  :stores_subdirectory,
                   :webpack_generated_files, :rendering_extension, :build_test_command,
                   :build_production_command, :i18n_dir, :i18n_yml_dir, :i18n_output_format,
                   :i18n_yml_safe_load_options, :defer_generated_component_packs,
@@ -83,7 +89,8 @@ module ReactOnRails
                   :make_generated_server_bundle_the_entrypoint,
                   :generated_component_packs_loading_strategy,
                   :component_registry_timeout,
-                  :server_bundle_output_path, :enforce_private_server_bundles
+                  :server_bundle_output_path, :enforce_private_server_bundles,
+                  :check_database_on_dev_start
 
     # Class instance variable and mutex to track if deprecation warning has been shown
     # Using mutex to ensure thread-safety in multi-threaded environments
@@ -143,8 +150,9 @@ module ReactOnRails
                    same_bundle_for_client_and_server: nil,
                    i18n_dir: nil, i18n_yml_dir: nil, i18n_output_format: nil, i18n_yml_safe_load_options: nil,
                    random_dom_id: nil, server_render_method: nil, rendering_props_extension: nil,
-                   components_subdirectory: nil, auto_load_bundle: nil,
-                   component_registry_timeout: nil, server_bundle_output_path: nil, enforce_private_server_bundles: nil)
+                   components_subdirectory: nil, stores_subdirectory: nil, auto_load_bundle: nil,
+                   component_registry_timeout: nil, server_bundle_output_path: nil, enforce_private_server_bundles: nil,
+                   check_database_on_dev_start: nil)
       self.node_modules_location = node_modules_location.present? ? node_modules_location : Rails.root
       self.generated_assets_dirs = generated_assets_dirs
       self.generated_assets_dir = generated_assets_dir
@@ -181,12 +189,14 @@ module ReactOnRails
 
       self.server_render_method = server_render_method
       self.components_subdirectory = components_subdirectory
+      self.stores_subdirectory = stores_subdirectory
       self.auto_load_bundle = auto_load_bundle
       self.make_generated_server_bundle_the_entrypoint = make_generated_server_bundle_the_entrypoint
       self.defer_generated_component_packs = defer_generated_component_packs
       self.generated_component_packs_loading_strategy = generated_component_packs_loading_strategy
       self.server_bundle_output_path = server_bundle_output_path
       self.enforce_private_server_bundles = enforce_private_server_bundles
+      self.check_database_on_dev_start = check_database_on_dev_start.nil? ? true : check_database_on_dev_start
     end
     # rubocop:enable Metrics/AbcSize
 

data/lib/react_on_rails/dev/database_checker.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require "open3"
+require "rainbow"
+
+module ReactOnRails
+  module Dev
+    # DatabaseChecker validates that the Rails database is properly set up
+    # before starting the development server.
+    #
+    # This prevents confusing errors when running bin/dev on a fresh checkout
+    # or after database cleanup.
+    #
+    # Checks performed:
+    # 1. Database exists and is accessible
+    # 2. Migrations are up to date (optional warning)
+    #
+    # Can be disabled via:
+    # - Environment variable: SKIP_DATABASE_CHECK=true
+    # - CLI flag: bin/dev --skip-database-check
+    # - Configuration: ReactOnRails.configure { |c| c.check_database_on_dev_start = false }
+    #
+    # Note: This check spawns a Rails runner process which adds ~1-2 seconds to startup.
+    # Disable it if this overhead is unacceptable for your workflow.
+    #
+    class DatabaseChecker
+      class << self
+        # Check if the database is set up and accessible
+        #
+        # @param skip [Boolean] if true, skip the check entirely
+        # @return [Boolean] true if database is ready (or check was skipped), false otherwise
+        def check_database(skip: false)
+          return true if should_skip_check?(skip)
+
+          print_checking_message
+          result = run_database_check
+
+          case result[:status]
+          when :ok
+            print_database_ok
+            check_pending_migrations
+            true
+          when :error
+            print_database_error(result[:error])
+            false
+          when :not_rails_app
+            print_skipped_message("bin/rails not found — skipping database check")
+            true
+          else
+            print_skipped_message(result[:error] || "unexpected status: #{result[:status]}")
+            true
+          end
+        end
+
+        private
+
+        def should_skip_check?(skip_flag)
+          # 1. CLI flag takes highest priority
+          return true if skip_flag
+
+          # 2. Environment variable
+          return true if ENV["SKIP_DATABASE_CHECK"] == "true"
+
+          # 3. ReactOnRails configuration (if available)
+          return true if defined?(ReactOnRails) &&
+                         ReactOnRails.respond_to?(:configuration) &&
+                         ReactOnRails.configuration.check_database_on_dev_start == false
+
+          false
+        end
+
+        def run_database_check
+          check_script = <<~RUBY
+            unless defined?(ActiveRecord)
+              puts 'DATABASE_OK' # No ActiveRecord = no database to check
+              exit
+            end
+            begin
+              ActiveRecord::Base.connection.execute('SELECT 1')
+              puts 'DATABASE_OK'
+            rescue StandardError => e
+              puts 'DATABASE_ERROR'
+              puts e.message
+            end
+          RUBY
+
+          # SECURITY: Using array form of Open3.capture3 is safe from command injection.
+          # The check_script is hardcoded above and never includes user input.
+          stdout, stderr, status = Open3.capture3("bin/rails", "runner", check_script)
+          parse_check_result(stdout, stderr, status)
+        rescue Errno::ENOENT
+          { status: :not_rails_app }
+        rescue StandardError => e
+          { status: :unknown_error, error: e.message }
+        end
+
+        def parse_check_result(stdout, stderr, status)
+          return { status: :error, error: "#{stdout}\n#{stderr}".strip } unless status.success?
+
+          lines = stdout.strip.split("\n")
+
+          # Empty output with successful exit means the process completed without error.
+          # This can happen when ActiveRecord is not loaded or when Rails runner
+          # exits cleanly without printing anything.
+          return { status: :ok } if lines.empty?
+
+          case lines.first
+          when "DATABASE_OK" then { status: :ok }
+          when "DATABASE_ERROR" then { status: :error, error: lines[1..].join("\n") }
+          else
+            if lines.any? { |line| line.strip == "DATABASE_OK" }
+              { status: :ok }
+            else
+              { status: :error, error: "#{stdout}\n#{stderr}".strip }
+            end
+          end
+        end
+
+        def check_pending_migrations
+          stdout, _stderr, status = Open3.capture3("bin/rails", "db:migrate:status")
+          return unless status.success? && stdout.include?(" down ")
+
+          print_pending_migrations_warning
+        rescue StandardError => e
+          # Ignore errors - this is just a helpful warning.
+          # Common case: schema_migrations table doesn't exist yet on brand new databases.
+          warn "[ReactOnRails] Migration check failed: #{e.message}" if ENV["DEBUG"] == "1"
+          nil
+        end
+
+        def print_checking_message
+          puts "\n#{Rainbow('Checking database setup...').cyan}"
+        end
+
+        def print_database_ok
+          puts Rainbow("   Database is accessible").green
+        end
+
+        def print_skipped_message(reason)
+          puts Rainbow("   #{reason}").yellow
+        end
+
+        def print_pending_migrations_warning
+          puts Rainbow("   Pending migrations detected").yellow
+          puts Rainbow("     Run: bin/rails db:migrate").yellow
+        end
+
+        def print_database_error(error)
+          puts Rainbow("   Database check failed").red
+          puts ""
+          puts "#{Rainbow("   Error: #{truncate_error(error)}").red}\n" if error && !error.empty?
+          puts Rainbow("To fix, run:").yellow
+          puts ""
+          puts "   #{Rainbow('bin/rails db:prepare').green}  # Creates database if needed and runs pending migrations"
+          puts ""
+          puts Rainbow("Then run bin/dev again.").blue
+          puts ""
+        end
+
+        def truncate_error(error)
+          return error if error.length <= 500
+
+          "#{error[0, 500]}...\n   (Set DEBUG=1 to see full error)"
+        end
+      end
+    end
+  end
+end