Merge pull request #196 from znz/fix/issue-194-special-variable-search

znz · web-flow · commit 4af72c373ad0 · 2026-06-26T10:30:36.000+09:00
特殊変数を「$;」形式のクエリで検索できるようにする (#194)
diff --git a/lib/bitclust/search_index_generator.rb b/lib/bitclust/search_index_generator.rb
@@ -89,8 +89,16 @@ def method_entries(db)
           next if seen[path]
 
           seen[path] = true
-          full_name = (tmark == '$' ? '' : cname) + tmark + mname
-          result << { name: mname, full_name: full_name, type: type, path: path }
+          if tmark == '$'
+            # A special variable has no owning class to qualify it; its "$"
+            # sigil is the only thing distinguishing it, so keep it in +name+
+            # too (not just +full_name+) or a "$;"-style query can't match it.
+            name = full_name = tmark + mname
+          else
+            name = mname
+            full_name = cname + tmark + mname
+          end
+          result << { name: name, full_name: full_name, type: type, path: path }
         end
       end
       result
diff --git a/test/test_search_index_generator.rb b/test/test_search_index_generator.rb
@@ -77,6 +77,36 @@ def test_constant_entry
     assert_equal 'method/-foo/c/-a-a-a.html', e[:path]
   end
 
+  def test_special_variable_keeps_its_sigil_in_name
+    # A special variable's "$" is part of how it is written and is the only
+    # thing distinguishing it (there is no owning class to qualify it), so it
+    # must stay in +name+ for a "$;"-style query to match. See issue #194.
+    #
+    # The +name+/+type+ assertions below are what issue #194 is about. The
+    # +path+ assertion is secondary and filesystem-dependent: @gen defaults to
+    # fs_casesensitive: false, so the path is built by encodename_fs ("Kernel"
+    # -> "-kernel", ";" -> "=3b"). It is fine to ignore ONLY the path failure if
+    # it broke because the fs encoding scheme changed or a case-sensitive build
+    # (fs_casesensitive: true, giving "method/Kernel/v/...") is in use -- as long
+    # as name/type still hold. A name/type failure is a real regression.
+    index = @gen.build_index(@db)
+    e = find_entry(index, '$;')
+    assert_not_nil e
+    assert_equal '$;', e[:name]
+    assert_equal 'variable', e[:type]
+    assert_equal 'method/-kernel/v/=3b.html', e[:path],
+                 'filesystem-encoded path (fs_casesensitive: false); ' \
+                 'ignore only this failure if just the fs encoding/casing changed'
+  end
+
+  def test_special_variable_word_name_keeps_its_sigil
+    index = @gen.build_index(@db)
+    e = find_entry(index, '$stdout')
+    assert_not_nil e
+    assert_equal '$stdout', e[:name]
+    assert_equal 'variable', e[:type]
+  end
+
   def test_same_method_name_in_two_classes
     index = @gen.build_index(@db)
     assert_not_nil find_entry(index, 'Foo#foo')
@@ -135,6 +165,11 @@ def setup_files
 == Module Functions
 --- at_exit{ ... } -> Proc
 aaa
+== Special Variables
+--- $; -> String | nil
+区切り文字。
+--- $stdout -> IO
+標準出力。
 
 HERE
     end
diff --git a/theme/default/js/search_init.js b/theme/default/js/search_init.js
@@ -13,6 +13,27 @@
  *                       set inline in the page <head> by the layout template.
  */
 (function() {
+  // BitClust extension (the vendored Aliki files above are kept verbatim).
+  //
+  // RDoc's parseQuery() rewrites "." to "::" (its class-method separator) and
+  // matches "::"/"."/"#" queries against full_name instead of name. Ruby's
+  // special variables are indexed with their "$" sigil in full_name, and one of
+  // them ($.) contains a literal "." — so a "$." query would become "$::" and
+  // never match. Wrap parseQuery so that any "$"-prefixed (special variable)
+  // query keeps its literal text and is matched against full_name.
+  // See https://github.com/rurema/bitclust/issues/194
+  if (typeof parseQuery === 'function') {
+    var alikiParseQuery = parseQuery;
+    parseQuery = function(query) {
+      var q = alikiParseQuery(query);
+      if (query.charAt(0) === '$') {
+        q.normalized = query.toLowerCase();  // undo the "." -> "::" rewrite
+        q.matchesFullName = true;            // the "$" sigil lives in full_name
+      }
+      return q;
+    };
+  }
+
   function createSearchInstance(input, result) {
     if (!input || !result) return null;
 
