Simplify server caching: remove redundant search index cache

Also update clear_file_contributions for the Hash-based comment_location:
- Add keep_position: keyword for server re-parse (preserves key position)
- Add rebuild_comment_from_location method
- Server passes keep_position: true when re-parsing changed files

Author: st0012

lib/rdoc/code_object/class_module.rb

@@ -747,6 +747,18 @@ def search_snippet
     snippet(first_comment)
   end
 
+  ##
+  # Rebuilds +@comment+ from the current +@comment_location+ entries,
+  # skipping any empty placeholders.
+
+  def rebuild_comment_from_location
+    texts = @comment_location.each_value.flat_map { |comments|
+      comments.filter_map { |c| c.to_s unless c.empty? }
+    }
+    merged = texts.join("\n---\n")
+    @comment = merged.empty? ? '' : RDoc::Comment.new(merged)
+  end
+
   ##
   # Sets the store for this class or module and its contained code objects.
 

lib/rdoc/server.rb

@@ -68,8 +68,8 @@ def initialize(rdoc, port)
     @port = port
 
     @generator = create_generator
+    @template_dir = File.expand_path(@generator.template_dir)
     @page_cache = {}
-    @search_index_cache = nil
     @last_change_time = Time.now.to_f
     @mutex = Mutex.new
     @running = false
@@ -199,9 +199,8 @@ def serve_asset(path)
     rel_path = path.delete_prefix("/")
     asset_path = File.join(@generator.template_dir, rel_path)
     real_asset = File.expand_path(asset_path)
-    real_template = File.expand_path(@generator.template_dir)
 
-    unless real_asset.start_with?("#{real_template}/") && File.file?(real_asset)
+    unless real_asset.start_with?("#{@template_dir}/") && File.file?(real_asset)
       return [404, 'text/plain', "Asset not found: #{rel_path}"]
     end
 
@@ -258,7 +257,7 @@ def generate_page(name)
     when 'table_of_contents.html'
       @generator.generate_table_of_contents
     when 'js/search_data.js'
-      build_search_index
+      "var search_data = #{JSON.generate(index: @generator.build_search_index)};"
     else
       text_name = name.chomp('.html')
       class_name = text_name.gsub('/', '::')
@@ -271,29 +270,13 @@ def generate_page(name)
     end
   end
 
-  ##
-  # Builds the search index JavaScript.
-
-  def build_search_index
-    @search_index_cache ||=
-      "var search_data = #{JSON.generate(index: @generator.build_search_index)};"
-  end
-
   ##
   # Injects the live-reload polling script before +</body>+.
 
   def inject_live_reload(html, last_change_time)
     html.sub('</body>', "#{self.class.live_reload_script(last_change_time)}</body>")
   end
 
-  ##
-  # Clears all cached HTML pages and the search index.
-
-  def invalidate_all_caches
-    @page_cache.clear
-    @search_index_cache = nil
-  end
-
   ##
   # Starts a background thread that polls source file mtimes and triggers
   # re-parsing when changes are detected.
@@ -373,7 +356,7 @@ def reparse_and_refresh(changed_files, removed_files)
         changed_files.each do |f|
           begin
             relative = @rdoc.relative_path_for(f)
-            @store.clear_file_contributions(relative)
+            @store.clear_file_contributions(relative, keep_position: true)
             @rdoc.parse_file(f)
             @file_mtimes[f] = File.mtime(f) rescue nil
           rescue => e
@@ -385,7 +368,7 @@ def reparse_and_refresh(changed_files, removed_files)
       @store.complete(@options.visibility)
 
       @generator.refresh_store_data
-      invalidate_all_caches
+      @page_cache.clear
       @last_change_time = Time.now.to_f
     end
   end

lib/rdoc/store.rb

@@ -220,7 +220,7 @@ def remove_file(relative_name)
   # prevents duplication when the file is re-parsed while preserving
   # shared namespaces like +RDoc+ that span many files.
 
-  def clear_file_contributions(relative_name)
+  def clear_file_contributions(relative_name, keep_position: false)
     top_level = @files_hash[relative_name]
     return unless top_level
 
@@ -245,30 +245,33 @@ def clear_file_contributions(relative_name)
       cm.aliases.reject! { |a| a.file == top_level }
       cm.external_aliases.reject! { |a| a.file == top_level }
 
-      # Remove comment entries from this file and rebuild the comment
+      # Clear or remove comment entries from this file
       if cm.is_a?(RDoc::ClassModule)
-        cm.comment_location.reject! { |(_, loc)| loc == top_level }
-        texts = cm.comment_location.map { |(c, _)| c.to_s }
-        merged = texts.join("\n---\n")
-        cm.instance_variable_set(:@comment,
-          merged.empty? ? '' : RDoc::Comment.new(merged))
+        if keep_position
+          cm.comment_location[top_level] = [] if cm.comment_location.key?(top_level)
+        else
+          cm.comment_location.delete(top_level)
+        end
+        cm.rebuild_comment_from_location
       end
 
-      # Remove this file from the class/module's file list
-      cm.in_files.delete(top_level)
-
-      # If no files contribute to this class/module anymore, remove it
-      # from the store entirely.  This handles file deletion correctly
-      # for classes that are only defined in the deleted file, while
-      # preserving classes that span multiple files.
-      if cm.in_files.empty?
-        if cm.is_a?(RDoc::NormalModule)
-          @modules_hash.delete(cm.full_name)
-        else
-          @classes_hash.delete(cm.full_name)
+      unless keep_position
+        # Remove this file from the class/module's file list
+        cm.in_files.delete(top_level)
+
+        # If no files contribute to this class/module anymore, remove it
+        # from the store entirely.  This handles file deletion correctly
+        # for classes that are only defined in the deleted file, while
+        # preserving classes that span multiple files.
+        if cm.in_files.empty?
+          if cm.is_a?(RDoc::NormalModule)
+            @modules_hash.delete(cm.full_name)
+          else
+            @classes_hash.delete(cm.full_name)
+          end
+          cm.parent&.classes_hash&.delete(cm.name)
+          cm.parent&.modules_hash&.delete(cm.name)
         end
-        cm.parent&.classes_hash&.delete(cm.name)
-        cm.parent&.modules_hash&.delete(cm.name)
       end
     end
 

test/rdoc/rdoc_store_test.rb

@@ -1128,9 +1128,8 @@ def test_clear_file_contributions_multi_file_class
     assert_includes method_names, 'from_b'
 
     # Comment from a.rb is removed, comment from b.rb remains
-    comment_files = klass.comment_location.map { |(_, loc)| loc }
-    assert_not_include comment_files, file_a
-    assert_includes comment_files, file_b
+    assert_not_include klass.comment_location.keys, file_a
+    assert_includes klass.comment_location.keys, file_b
   end
 
   def test_clear_file_contributions_cleans_methods_and_constants
@@ -1219,4 +1218,41 @@ def test_clear_file_contributions_nonexistent_file
     @s.clear_file_contributions 'nonexistent.rb'
   end
 
+  def test_clear_file_contributions_keep_position
+    file_a = @s.add_file 'a.rb'
+    file_b = @s.add_file 'b.rb'
+
+    klass = file_a.add_class RDoc::NormalClass, 'KeepPosClass'
+    klass.record_location file_a
+    klass.record_location file_b
+    file_a.add_to_classes_or_modules klass
+    file_b.add_to_classes_or_modules klass
+
+    klass.add_comment 'comment from a', file_a
+    klass.add_comment 'comment from b', file_b
+
+    @s.clear_file_contributions 'a.rb', keep_position: true
+
+    # Class is preserved
+    assert_includes @s.classes_hash, 'KeepPosClass'
+
+    # comment_location still has two entries (empty placeholder for a.rb)
+    assert_equal 2, klass.comment_location.size
+    assert_equal [file_a, file_b], klass.comment_location.keys
+
+    # The placeholder is an empty array
+    assert_equal [], klass.comment_location[file_a]
+
+    # in_files is not modified
+    assert_includes klass.in_files, file_a
+    assert_includes klass.in_files, file_b
+
+    # Simulate re-parse: add_comment appends to array at existing key position
+    klass.add_comment 'updated comment from a', file_a
+
+    # Order is preserved: a.rb first, b.rb second
+    assert_equal [file_a, file_b], klass.comment_location.keys
+    assert_equal 'updated comment from a', klass.comment_location[file_a].first.to_s
+  end
+
 end