react_on_rails 16.6.0.rc.0 → 16.6.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2294c0aab02fdb0995b81b139099a0585b25ee39ebe903d6238e91a40e2a0341
-  data.tar.gz: 76c6b154c56c639566069a5840496e4ba142b6130429f38ab7580f6bb33bbc29
+  metadata.gz: 5c525aa58afae47bf65f4118b11472b00b06649b2b3eba698fa6f7b82a6a6050
+  data.tar.gz: 2fe64e5d5ce2306b56408b26ffef471177ed33319732336f2f4d203b4917b742
 SHA512:
-  metadata.gz: 0521bd2c98262935f0f7bac35e779aec25a6cb8a8039906141ab7e560d27deade2c3b1601d389d4e362ead52ed64b4be0e851ae22a07cb61e15948407e925a69
-  data.tar.gz: bd80ca64b259c5e303111d7f46aeaa2b1e1bcda60af3fcc1873db9e51b39db2bf42bb4f846b9678ea9b8d6b5d4dac0b70183ce6fa30b7953ad2d0a65ee6d7dc4
+  metadata.gz: 8e580e7e342ed62b643a5d89a8b8b9f145a3edb2e51089c240575445824b1b7c5b8d82286e477a6a8457d54ed26d64fb4a05f6a42a9cbca229e3512bfdbeddc8
+  data.tar.gz: 95539a4061db5f32a57c0e0d0e4665ba2fea563de45686ff0fecc10d94ce28f5f043348d29af748acee96f078c9337fd805677f388c903b34b1562c90571c22d

data/Gemfile.lock

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

data/lib/generators/react_on_rails/pro_generator.rb

@@ -147,28 +147,25 @@ module ReactOnRails
 
           base_gem_entry_found = true
 
+          declaration = consume_non_parenthesized_base_gem_declaration(
+            gemfile_lines,
+            line_index,
+            match.end(0)
+          )
+
           unless pro_entry_added
             indentation = match[1]
             quote = match[2]
             updated_lines << build_pro_gem_replacement_line(
               indentation: indentation,
               quote: quote,
-              suffix: line[match.end(0)..],
+              suffix: declaration[:trailing_suffix],
               parenthesized_gem_call: match[0].include?("(")
             )
             pro_entry_added = true
           end
 
-          # Consume multiline gem declarations that continue with trailing commas.
-          line_index += 1
-          current_line = line
-          while line_index < gemfile_lines.length &&
-                line_continues_with_comma?(current_line) &&
-                gem_declaration_continues_on_next_line?(gemfile_lines[line_index])
-            next_line = gemfile_lines[line_index]
-            current_line = next_line unless comment_or_blank_line?(next_line)
-            line_index += 1
-          end
+          line_index = declaration[:next_index]
         end
 
         updated_content = updated_lines.join
@@ -476,17 +473,18 @@ module ReactOnRails
                   pending_multiline_static_import_specifier
                 ) { |line_fragment| yield line_fragment }
               in_multiline_template_literal = updated_template_literal_state
-              in_block_comment = true if unclosed_block_comment_starts?(rewritten_line)
+              in_block_comment = unclosed_block_comment_starts?(rewritten_line)
               rewritten_line
             elsif line_contains_unescaped_backtick
               rewritten_line, pending_multiline_module_call_depth, pending_multiline_static_import_specifier =
                 rewrite_line_before_template_literal_open(
                   line,
                   pending_multiline_module_call_depth,
-                  pending_multiline_static_import_specifier
+                  pending_multiline_static_import_specifier,
+                  in_block_comment: in_block_comment
                 ) { |line_fragment| yield line_fragment }
               in_multiline_template_literal = updated_template_literal_state
-              in_block_comment = true if unclosed_block_comment_starts?(rewritten_line)
+              in_block_comment = unclosed_block_comment_starts?(rewritten_line)
               rewritten_line
             else
               in_multiline_template_literal = updated_template_literal_state
@@ -648,7 +646,7 @@ module ReactOnRails
 
         rewritten_line = yield line_without_inline_templates
         template_placeholders.each do |placeholder, template_literal|
-          rewritten_line = rewritten_line.sub(placeholder, template_literal)
+          rewritten_line = rewritten_line.sub(placeholder) { template_literal }
         end
         rewritten_line
       end
@@ -742,8 +740,13 @@ module ReactOnRails
         ["#{template_literal_prefix}#{rewritten_fragment}", pending_depth, pending_multiline_static_import_specifier]
       end
 
-      def rewrite_line_before_template_literal_open(line, pending_depth, pending_multiline_static_import_specifier)
-        opening_index = first_unescaped_backtick_index(line)
+      def rewrite_line_before_template_literal_open(
+        line,
+        pending_depth,
+        pending_multiline_static_import_specifier,
+        in_block_comment: false
+      )
+        opening_index = opening_backtick_index_for_multiline_start(line, in_block_comment: in_block_comment)
         return [line, pending_depth, pending_multiline_static_import_specifier] unless opening_index&.positive?
 
         line_prefix = line[0, opening_index]
@@ -757,17 +760,56 @@ module ReactOnRails
       end
 
       def first_unescaped_backtick_index(line)
+        unescaped_backtick_indexes(line, skip_comments: true).first
+      end
+
+      def opening_backtick_index_for_multiline_start(line, in_block_comment: false)
+        backtick_indexes = unescaped_backtick_indexes(line, in_block_comment: in_block_comment)
+        return nil if backtick_indexes.empty? || backtick_indexes.length.even?
+
+        backtick_indexes.last
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def unescaped_backtick_indexes(line, in_block_comment: false, skip_comments: false)
         quote_state = nil
+        backtick_indexes = []
+
+        scan_index = 0
+        while scan_index < line.length
+          if in_block_comment
+            closing_index = line.index("*/", scan_index)
+            break unless closing_index
+
+            in_block_comment = false
+            scan_index = closing_index + 2
+            next
+          end
 
-        line.each_char.with_index do |char, index|
-          quote_state = next_quote_state(quote_state, char, line, index)
-          next if quote_state
-          return nil if line[index, 2] == "//"
+          char = line[scan_index]
+          quote_state = next_quote_state(quote_state, char, line, scan_index)
+          if quote_state
+            scan_index += 1
+            next
+          end
+
+          unless skip_comments
+            break if line[scan_index, 2] == "//"
+
+            if line[scan_index, 2] == "/*"
+              in_block_comment = true
+              scan_index += 2
+              next
+            end
+          end
 
-          return index if char == "`" && !character_escaped?(line, index)
+          backtick_indexes << scan_index if char == "`" && !character_escaped?(line, scan_index)
+          scan_index += 1
         end
-        nil
+
+        backtick_indexes
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def next_quote_state(current_state, char, line, index)
         if current_state
@@ -830,13 +872,36 @@ module ReactOnRails
       end
       # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
 
+      def consume_non_parenthesized_base_gem_declaration(lines, start_index, match_end)
+        line_index = start_index
+        current_line = lines[line_index]
+        declaration_lines = [current_line]
+        line_index += 1
+
+        while line_index < lines.length &&
+              line_continues_with_comma?(current_line) &&
+              gem_declaration_continues_on_next_line?(lines[line_index])
+          next_line = lines[line_index]
+          declaration_lines << next_line
+          current_line = next_line unless comment_or_blank_line?(next_line)
+          line_index += 1
+        end
+
+        trailing_suffix = lines[start_index][match_end..].to_s + declaration_lines.drop(1).join
+        { trailing_suffix: trailing_suffix, next_index: line_index }
+      end
+
       def build_pro_gem_replacement_line(indentation:, quote:, suffix:, parenthesized_gem_call: false)
         normalized_suffix = suffix || "\n"
         normalized_suffix = "#{normalized_suffix}\n" unless normalized_suffix.end_with?("\n")
         version_arg_pattern = /\A(?<prefix>\s*,(?:\s*#.*\n|\s++)*)["'][^"']*["'](?<trailing_comma>\s*,)?/
         loop do
           updated_suffix = normalized_suffix.sub(version_arg_pattern) do
-            Regexp.last_match[:trailing_comma] ? Regexp.last_match[:prefix] : ""
+            if Regexp.last_match[:trailing_comma]
+              Regexp.last_match[:prefix].sub(/\n[ \t]*\z/, "")
+            else
+              ""
+            end
           end
           break if updated_suffix == normalized_suffix
 

data/lib/generators/react_on_rails/rsc_setup.rb

@@ -170,7 +170,7 @@ module ReactOnRails
             ⚠️  Procfile.dev not found. Skipping RSC bundle watcher addition.
 
             You'll need to add the RSC bundle watcher to your process manager manually:
-              rsc-bundle: RSC_BUNDLE_ONLY=yes bin/shakapacker-watch --watch
+              rsc-bundle: RSC_BUNDLE_ONLY=true bin/shakapacker-watch --watch
           MSG
           return
         end
@@ -185,7 +185,7 @@ module ReactOnRails
         rsc_watcher_line = <<~PROCFILE
 
           # React on Rails Pro - RSC bundle watcher
-          rsc-bundle: RSC_BUNDLE_ONLY=yes bin/shakapacker-watch --watch
+          rsc-bundle: RSC_BUNDLE_ONLY=true bin/shakapacker-watch --watch
         PROCFILE
 
         append_to_file("Procfile.dev", rsc_watcher_line)

data/lib/generators/react_on_rails/templates/base/base/Procfile.dev

@@ -6,4 +6,4 @@
 #   SHAKAPACKER_DEV_SERVER_PORT=3036
 rails: bundle exec rails s -p ${PORT:-3000}
 dev-server: bin/shakapacker-dev-server
-server-bundle: SERVER_BUNDLE_ONLY=yes bin/shakapacker-watch --watch
+server-bundle: SERVER_BUNDLE_ONLY=true bin/shakapacker-watch --watch

data/lib/react_on_rails/configuration.rb

@@ -94,51 +94,6 @@ module ReactOnRails
                   :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
-    @immediate_hydration_warned = false
-    @immediate_hydration_mutex = Mutex.new
-
-    class << self
-      attr_accessor :immediate_hydration_warned, :immediate_hydration_mutex
-    end
-
-    # Deprecated: immediate_hydration configuration has been removed
-    def immediate_hydration=(value)
-      warned = false
-      self.class.immediate_hydration_mutex.synchronize do
-        warned = self.class.immediate_hydration_warned
-        self.class.immediate_hydration_warned = true unless warned
-      end
-
-      return if warned
-
-      Rails.logger.warn <<~WARNING
-        [REACT ON RAILS] The 'config.immediate_hydration' configuration option is deprecated and no longer used.
-        Immediate hydration is now automatically enabled for React on Rails Pro users.
-        Please remove 'config.immediate_hydration = #{value}' from your config/initializers/react_on_rails.rb file.
-        See CHANGELOG.md for migration instructions.
-      WARNING
-    end
-
-    def immediate_hydration
-      warned = false
-      self.class.immediate_hydration_mutex.synchronize do
-        warned = self.class.immediate_hydration_warned
-        self.class.immediate_hydration_warned = true unless warned
-      end
-
-      return nil if warned
-
-      Rails.logger.warn <<~WARNING
-        [REACT ON RAILS] The 'config.immediate_hydration' configuration option is deprecated and no longer used.
-        Immediate hydration is now automatically enabled for React on Rails Pro users.
-        Please remove any references to 'config.immediate_hydration' from your config/initializers/react_on_rails.rb file.
-        See CHANGELOG.md for migration instructions.
-      WARNING
-      nil
-    end
-
     # rubocop:disable Metrics/AbcSize
     def initialize(node_modules_location: nil, server_bundle_js_file: nil, prerender: nil,
                    replay_console: nil, make_generated_server_bundle_the_entrypoint: nil,
@@ -257,12 +212,14 @@ module ReactOnRails
         Rails.logger.warn("**WARNING** #{msg}")
         self.generated_component_packs_loading_strategy = :sync
       elsif generated_component_packs_loading_strategy == :async
-        raise ReactOnRails::Error, "**ERROR** #{msg}"
+        raise ReactOnRails::Error, "**ERROR** #{msg}\n\n#{ReactOnRails::DOCTOR_RECOMMENDATION}"
       end
 
       return if %i[async defer sync].include?(generated_component_packs_loading_strategy)
 
-      raise ReactOnRails::Error, "generated_component_packs_loading_strategy must be either :async, :defer, or :sync"
+      raise ReactOnRails::Error,
+            "generated_component_packs_loading_strategy must be either :async, :defer, or :sync. " \
+            "#{ReactOnRails::DOCTOR_RECOMMENDATION}"
     end
 
     def validate_enforce_private_server_bundles
@@ -272,7 +229,8 @@ module ReactOnRails
       if server_bundle_output_path.nil?
         raise ReactOnRails::Error, "enforce_private_server_bundles is set to true, but " \
                                    "server_bundle_output_path is nil. Please set server_bundle_output_path " \
-                                   "to a directory outside of the public directory."
+                                   "to a directory outside of the public directory. " \
+                                   "#{ReactOnRails::DOCTOR_RECOMMENDATION}"
       end
 
       # Check if server_bundle_output_path is inside public directory
@@ -286,7 +244,8 @@ module ReactOnRails
 
       raise ReactOnRails::Error, "enforce_private_server_bundles is set to true, but " \
                                  "server_bundle_output_path (#{server_bundle_output_path}) is inside " \
-                                 "the public directory. Please set it to a directory outside of public."
+                                 "the public directory. Please set it to a directory outside of public. " \
+                                 "#{ReactOnRails::DOCTOR_RECOMMENDATION}"
     end
 
     # Auto-detect server_bundle_output_path from Shakapacker 9.0+ private_output_path
@@ -401,6 +360,8 @@ module ReactOnRails
           that does not match the value for public_output_path specified in
           shakapacker.yml = #{packer_public_output_path}. You should remove the configuration
           value for "generated_assets_dir" from your config/initializers/react_on_rails.rb file.
+
+          #{ReactOnRails::DOCTOR_RECOMMENDATION}
         MSG
         raise ReactOnRails::Error, msg
       end
@@ -465,7 +426,9 @@ module ReactOnRails
       msg = <<~MSG
         **ERROR** ReactOnRails: auto_load_bundle is set to true, yet components_subdirectory is not configured.\
         Please set components_subdirectory to the desired directory.  For more information, please see \
-        https://reactonrails.com/docs/core-concepts/auto-bundling-file-system-based-automated-bundle-generation/
+        https://reactonrails.com/docs/core-concepts/auto-bundling/
+
+        #{ReactOnRails::DOCTOR_RECOMMENDATION}
       MSG
 
       raise ReactOnRails::Error, msg
@@ -482,6 +445,7 @@ module ReactOnRails
         Alternatively, remove the config/react_on_rails.rb config.build_production_command and the
         default bin/shakapacker script will be used for assets:precompile.
 
+        #{ReactOnRails::DOCTOR_RECOMMENDATION}
       MSG
     end
   end

data/lib/react_on_rails/controller.rb

@@ -9,16 +9,22 @@ module ReactOnRails
     #             JavaScript code.
     # props: Named parameter props which is a Ruby Hash or JSON string which contains the properties
     #        to pass to the redux store.
-    # immediate_hydration: React on Rails Pro (licensed) feature. When nil (default), Pro users get
-    #                      immediate hydration, non-Pro users don't. Can be explicitly overridden.
     #
     # Be sure to include view helper `redux_store_hydration_data` at the end of your layout or view
     # or else there will be no client side hydration of your stores.
-    def redux_store(store_name, props: {}, immediate_hydration: nil)
-      immediate_hydration = ReactOnRails::Utils.normalize_immediate_hydration(immediate_hydration, store_name, "Store")
+    def redux_store(store_name, props: {}, **rest)
+      immediate_hydration_present = rest.key?(:immediate_hydration)
+      unknown_keys = rest.keys - [:immediate_hydration]
+      if unknown_keys.any?
+        plural = unknown_keys.one? ? "" : "s"
+        unknown_options = unknown_keys.map { |key| ":#{key}" }.join(", ")
+        raise ArgumentError, "unknown keyword#{plural}: #{unknown_options}"
+      end
+
+      ReactOnRails::Helper.warn_removed_immediate_hydration_option("redux_store") if immediate_hydration_present
+
       redux_store_data = { store_name: store_name,
-                           props: props,
-                           immediate_hydration: immediate_hydration }
+                           props: props }
       @registered_stores_defer_render ||= []
       @registered_stores_defer_render << redux_store_data
     end

data/lib/react_on_rails/dev/server_manager.rb

@@ -290,7 +290,7 @@ module ReactOnRails
 
           env = { "RAILS_ENV" => "test" }
           if resolved_mode == "client-only"
-            env["CLIENT_BUNDLE_ONLY"] = "yes"
+            env["CLIENT_BUNDLE_ONLY"] = "true"
             puts Rainbow("🧪 Starting test watch (client-only mode)...").cyan
             puts Rainbow("   Reusing server bundle from existing watcher if available.").cyan
           else
@@ -320,7 +320,9 @@ module ReactOnRails
         def shakapacker_watch_process_running?
           # Detect existing shakapacker watcher processes (from either bin/dev or bin/dev static).
           # If one is already running, client-only test watch avoids duplicate server-bundle rebuilds.
-          server_only_watchers = find_process_pids("SERVER_BUNDLE_ONLY=yes bin/shakapacker --watch")
+          # Also detect legacy =yes convention during transition
+          server_only_watchers = find_process_pids("SERVER_BUNDLE_ONLY=true bin/shakapacker --watch")
+          server_only_watchers |= find_process_pids("SERVER_BUNDLE_ONLY=yes bin/shakapacker --watch")
           if server_only_watchers.any?
             return true if shared_private_output_paths?