bitclust-core 1.3.0 → 1.6.0

data/test/test_entity_splitter.rb

@@ -0,0 +1,231 @@
+# frozen_string_literal: true
+
+require 'test/unit'
+
+require 'bitclust/entity_splitter'
+require 'bitclust/include_graph'
+
+# EntitySplitter: マルチエンティティ RD をエンティティ単位に分割する（O3）。
+# 2段階:
+# 1. resolve_header_gates — スコープ定数（常に真/偽）の版ゲートのうち、最初の内容行が
+#    エンティティ H1 のブロックを解決する（活きている枝を残しゲートを外す）。
+#    版で改名されたエンティティ（thread/Mutex, Net::HTTPURITooLong 等）の H1 ペアが
+#    スコープ内の単一 H1 に収束し、旧名は活き枝の alias 行として残る。
+# 2. segments — 深さ0の H1（またはスコープ内ゲート付き H1 ブロック）を境界に分割。
+#    セグメント間の内容は直前のエンティティに帰属。連結すると入力に一致する。
+#
+# テストリスト:
+# [x] resolve: 常真 since + #@else 改名ペア → 活き枝のみ（thread/Mutex パターン）
+# [x] resolve: 常偽 until + #@else → else 枝のみ
+# [x] resolve: 常真ゲートがエンティティ全体を包む（else なし）→ unwrap（EarlyHints パターン）
+# [x] resolve: 常偽ゲートがエンティティ全体を包む（else なし）→ ブロックごと除去
+# [x] resolve: スコープ内ゲート（since 3.2 等）→ 据え置き
+# [x] resolve: 散文を包むゲート（最初の内容行が H1 でない）→ 据え置き
+# [x] resolve: ブロック内にネストした #@ があっても対応を取る
+# [x] resolve: 活き枝に複数エンティティがあってもそのまま残す（base64 パターン）
+# [x] segments: 裸 H1 で分割、内容は直前エンティティへ、連結=入力
+# [x] segments: スコープ内ゲート付き H1 ブロックは丸ごと1セグメント
+# [x] segments: #@samplecode 内の「= class」風の行は境界にしない
+# [x] segments: 先頭に H1 以外の内容がある場合は nil
+# [x] entity_filename: :: → __、. は保持
+class TestEntitySplitter < Test::Unit::TestCase
+  def scope
+    BitClust::IncludeGraph::Scope.new("3.0", "4.2")
+  end
+
+  def resolve(src)
+    BitClust::EntitySplitter.resolve_header_gates(src, scope)
+  end
+
+  def segments(src)
+    BitClust::EntitySplitter.segments(src)
+  end
+
+  # ---- resolve_header_gates ----
+
+  def test_resolve_renamed_entity_keeps_active_branch
+    # thread/Mutex: #@since 2.3.0（常真）で改名された H1 ペア
+    src = <<~RRD
+      \#@since 2.3.0
+      = class Thread::Mutex < Object
+      alias Mutex
+      \#@else
+      = class Mutex < Object
+      \#@end
+
+      本文。
+    RRD
+    expected = <<~RRD
+      = class Thread::Mutex < Object
+      alias Mutex
+
+      本文。
+    RRD
+    assert_equal expected, resolve(src)
+  end
+
+  def test_resolve_never_until_with_else_keeps_else_branch
+    src = "\#@until 2.3.0\n= class Old < Object\n\#@else\n= class New < Object\n\#@end\n本文。\n"
+    assert_equal "= class New < Object\n本文。\n", resolve(src)
+  end
+
+  def test_resolve_unwraps_wholly_gated_entity
+    # Net::HTTPEarlyHints: #@since 2.6.0（常真）がエンティティ全体を包む
+    src = "= class A < B\n\n\#@since 2.6.0\n= class C < D\n説明。\n\#@end\n\n= class E < F\n"
+    assert_equal "= class A < B\n\n= class C < D\n説明。\n\n= class E < F\n", resolve(src)
+  end
+
+  def test_resolve_drops_never_gated_entity
+    src = "= class A < B\n\n\#@until 2.4.0\n= class Dead < B\n説明。\n\#@end\n\n= class E < F\n"
+    assert_equal "= class A < B\n\n= class E < F\n", resolve(src)
+  end
+
+  def test_resolve_keeps_in_scope_gate
+    src = "\#@since 3.2\n= class New < Object\n説明。\n\#@end\n"
+    assert_equal src, resolve(src)
+  end
+
+  def test_resolve_keeps_prose_gates
+    src = "= class A < B\n\#@since 2.3.0\n新しい説明。\n\#@else\n古い説明。\n\#@end\n"
+    assert_equal src, resolve(src)
+  end
+
+  def test_resolve_provably_true_if_gate_with_entities
+    # digest.rd: #@if(version >= "1.8.6")（常真）がエンティティ構造ごと包む
+    src = "\#@if(version >= \"1.8.6\")\n= class A < Object\n\n= class B < A\ninclude I\n\#@else\n= class B < Object\n\#@end\n共通。\n"
+    assert_equal "= class A < Object\n\n= class B < A\ninclude I\n共通。\n", resolve(src)
+  end
+
+  def test_resolve_constant_gate_containing_h1_after_prose
+    # syslog.rd: 常真ゲートが散文の後にエンティティ H1 を含む
+    src = "= module C\n\n\#@since 2.0.0\n散文。\n= module D\nD。\n\#@end\n"
+    assert_equal "= module C\n\n散文。\n= module D\nD。\n", resolve(src)
+  end
+
+  def test_resolve_keeps_relation_only_constant_gate
+    # H1 を含まない定数ゲート（gated relations）は front matter の #@ 表現に任せる
+    src = "= module C\n\#@since 2.0.0\ninclude X\n\#@end\n"
+    assert_equal src, resolve(src)
+  end
+
+  def test_resolve_ignores_h1_like_lines_inside_samplecode
+    src = "\#@since 2.0.0\n散文。\n\#@samplecode\n= class Fake < Object\n\#@end\n\#@end\n"
+    assert_equal src, resolve(src)
+  end
+
+  def test_resolve_handles_quoted_version
+    # Preprocessor は #@since "1.8.5" のクォート形式も受理する（_builtin/Process に実在）
+    src = "\#@since \"1.8.5\"\n= class A < B\n本文。\n\#@end\n"
+    assert_equal "= class A < B\n本文。\n", resolve(src)
+  end
+
+  def test_resolve_handles_nested_blocks
+    src = <<~RRD
+      \#@since 1.9.1
+      = class A < B
+      \#@since 2.0.0
+      版分岐の説明。
+      \#@end
+      \#@end
+    RRD
+    expected = <<~RRD
+      = class A < B
+      \#@since 2.0.0
+      版分岐の説明。
+      \#@end
+    RRD
+    assert_equal expected, resolve(src)
+  end
+
+  def test_resolve_keeps_multi_entity_active_branch
+    # base64/Base64: 常真ゲートの枝に複数エンティティ
+    src = "\#@since 1.9.1\n= module Base64\n\n= reopen Kernel\n\#@else\n= module Base64\n\#@end\n"
+    assert_equal "= module Base64\n\n= reopen Kernel\n", resolve(src)
+  end
+
+  # ---- segments ----
+
+  def test_segments_split_at_bare_h1
+    src = "= class A < Object\ninclude Foo\n\nA の説明。\n\n= class B < Object\nB の説明。\n"
+    segs = segments(src)
+    assert_equal ["A", "B"], segs.map(&:first)
+    assert_equal "= class A < Object\ninclude Foo\n\nA の説明。\n\n", segs[0][1]
+    assert_equal "= class B < Object\nB の説明。\n", segs[1][1]
+    assert_equal src, segs.map(&:last).join
+  end
+
+  def test_segments_in_scope_gated_block_is_one_segment
+    src = "= class A < Object\n\n\#@since 3.2\n= class New < Object\n説明。\n\#@end\n"
+    segs = segments(src)
+    assert_equal ["A", "New"], segs.map(&:first)
+    assert_equal "\#@since 3.2\n= class New < Object\n説明。\n\#@end\n", segs[1][1]
+  end
+
+  def test_segments_partial_gate_around_h1_is_not_a_boundary
+    # syslog の旧構造: H1 と見出しだけがゲートされ、定数群はゲートの外にある。
+    # 単独ファイル化するとゲートが偽の版で自立パースできない
+    # （旧世界では直前エンティティに付く）ので分割境界にしない
+    src = "= class A < Object\n\n" \
+          "\#@since 2.0.0\n= module B\n説明。\n== Constants\n\#@end\n" \
+          "--- CONST -> Integer\n"
+    segs = segments(src)
+    assert_equal ["A"], segs.map(&:first)
+    assert_equal src, segs[0][1]
+  end
+
+  def test_segments_gated_boundary_allows_trailing_blanks
+    src = "= class A < Object\n\n" \
+          "\#@since 3.2\n= class New < Object\n説明。\n\#@end\n\n"
+    segs = segments(src)
+    assert_equal ["A", "New"], segs.map(&:first)
+  end
+
+  def test_segments_ignores_h1_like_lines_in_samplecode
+    src = "= class A < Object\n\#@samplecode\n= class B < Object\n\#@end\n"
+    segs = segments(src)
+    assert_equal ["A"], segs.map(&:first)
+  end
+
+  def test_segments_leading_content_becomes_base_segment
+    # ライブラリファイルのインライン・エンティティ: 先頭のライブラリ概要部は
+    # name=nil のベースセグメントになる
+    src = "category Cat\n\n概要。\n\n= class A < Object\nA の説明。\n"
+    segs = segments(src)
+    assert_equal [nil, "A"], segs.map(&:first)
+    assert_equal "category Cat\n\n概要。\n\n", segs[0][1]
+    assert_equal src, segs.map(&:last).join
+  end
+
+  def test_segments_single_entity
+    src = "= class A < Object\n説明。\n"
+    assert_equal [["A", src]], segments(src)
+  end
+
+  # ---- header_relations? ----
+
+  def test_header_relations_detects_relation_after_h1
+    assert_true BitClust::EntitySplitter.header_relations?(
+      "= class A < Object\ninclude Foo\n\n説明。\n")
+    assert_true BitClust::EntitySplitter.header_relations?(
+      "= class A < Object\n\n説明。\n\n= class B < Object\nalias C\n")
+  end
+
+  def test_header_relations_ignores_body_and_samplecode
+    # 本文到達後の include 風の行（コード例等）は数えない
+    assert_false BitClust::EntitySplitter.header_relations?(
+      "= module Math\n\n説明。\n\n\#@samplecode\ninclude Math\n\#@end\n")
+  end
+
+  def test_header_relations_counts_gated_relations
+    assert_true BitClust::EntitySplitter.header_relations?(
+      "= class A < Object\n\#@since 2.6.0\nalias B\n\#@end\n\n説明。\n")
+  end
+
+  # ---- entity_filename ----
+
+  def test_entity_filename
+    assert_equal "Net__HTTPOK", BitClust::EntitySplitter.entity_filename("Net::HTTPOK")
+    assert_equal "ARGF.class", BitClust::EntitySplitter.entity_filename("ARGF.class")
+    assert_equal "Time", BitClust::EntitySplitter.entity_filename("Time")
+  end
+end

data/test/test_entry.rb

@@ -11,11 +11,11 @@ alias HogeHogeHoge
 --- hoge
 hoge
 --- fuga
-@undef
+{: undef}
 fuga
 == Instance Methods
 --- fugafuga
-@undef
+{: undef}
 fugafuga
 = class Bar < Hoge
 == Class Methods
@@ -62,5 +62,210 @@ HERE
     assert('Exception', @lib.fetch_class("Err").superclass.name)
     assert('Exception', @lib.fetch_class("ErrErr").superclass.name)
   end
+
+  def test_instance_method?
+    bar = @lib.fetch_class("Bar")
+    assert(bar.instance_method?('fugafuga'))
+    assert(!bar.instance_method?('fugafuga', false))
+    hoge = @lib.fetch_class("Hoge")
+    assert(hoge.instance_method?('fugafuga'))
+    assert(hoge.instance_method?('fugafuga', false))
+  end
+end
+
+class TestEntryDescription < Test::Unit::TestCase
+  def parse_class(class_source)
+    lib, = BitClust::RRDParser.parse(class_source, 'hoge')
+    lib.fetch_class('Hoge')
+  end
+
+  def test_description_truncates_newline_between_non_ascii
+    klass = parse_class(<<HERE)
+= class Hoge
+これは1行目で
+あとに続きます。
+
+以降の段落は含まれません。
+HERE
+    assert_equal('これは1行目であとに続きます。', klass.description)
+  end
+
+  def test_description_truncates_consecutive_newlines_between_non_ascii
+    klass = parse_class(<<HERE)
+= class Hoge
+あい
+うえ
+おか。
+HERE
+    assert_equal('あいうえおか。', klass.description)
+  end
+
+  def test_description_converts_newline_to_space_around_ascii
+    klass = parse_class(<<HERE)
+= class Hoge
+first line
+second line
+HERE
+    assert_equal('first line second line', klass.description)
+  end
+
+  def test_description_replaces_bracket_link_with_plain_text
+    klass = parse_class(<<HERE)
+= class Hoge
+自身の hostname を文字列で返します。また、[[m:URI::Generic#host]] が設
+定されていない場合は [[c:Array]] を返します。
+HERE
+    assert_equal('自身の hostname を文字列で返します。また、URI::Generic#host が設定されていない場合は Array を返します。',
+                 klass.description)
+  end
+
+  def test_description_replaces_indexer_bracket_link
+    klass = parse_class(<<HERE)
+= class Hoge
+[[m:String#[] ]] を参照。
+HERE
+    assert_equal('String#[] を参照。', klass.description)
+  end
+
+  def test_method_description_is_plain_text
+    klass = parse_class(<<HERE)
+= class Hoge
+== Instance Methods
+--- fuga
+
+[[c:Array]] を日本語で
+返します。
+
+次の段落。
+HERE
+    method = klass.entries.detect {|m| m.name == 'fuga' }
+    assert_equal('Array を日本語で返します。', method.description)
+  end
 end
 
+class TestEntryNomethod < Test::Unit::TestCase
+  def parse_class(class_source)
+    lib, = BitClust::RRDParser.parse(class_source, 'hoge')
+    lib.fetch_class('Hoge')
+  end
+
+  def test_nomethod_is_partitioned_separately
+    klass = parse_class(<<HERE)
+= class Hoge
+== Instance Methods
+--- fuga
+{: nomethod}
+
+説明のためのエントリです。
+HERE
+    parts = klass.partitioned_entries
+    assert_equal(['fuga'], parts.nomethod.map(&:name))
+    assert_equal([], parts.instance_methods.map(&:name))
+  end
+
+  def test_redefined_is_partitioned_separately
+    klass = parse_class(<<HERE)
+= class Hoge
+== Instance Methods
+--- bar
+
+説明です。
+
+= redefine Hoge
+== Instance Methods
+--- baz
+
+再定義の説明です。
+HERE
+    parts = klass.partitioned_entries
+    assert_equal(['baz'], parts.redefined.map(&:name))
+    assert_equal(['bar'], parts.instance_methods.map(&:name))
+  end
+
+  def test_description_skips_leading_metadata_paragraph
+    klass = parse_class(<<HERE)
+= class Hoge
+== Instance Methods
+--- fuga
+{: nomethod}
+
+説明のためのエントリです。
+HERE
+    method = klass.entries.detect {|m| m.name == 'fuga' }
+    assert_equal('説明のためのエントリです。', method.description)
+  end
+
+  def test_description_is_empty_when_only_metadata
+    klass = parse_class(<<HERE)
+= class Hoge
+== Instance Methods
+--- fuga
+{: undef}
+HERE
+    method = klass.entries.detect {|m| m.name == 'fuga' }
+    assert_equal('', method.description)
+  end
+end
+
+class TestClassEntryDynamicallyIncludedEntries < Test::Unit::TestCase
+  SRC = <<'HERE'
+= module DynMod
+dyn module
+== Instance Methods
+--- dyn_method
+dyn method
+== Private Instance Methods
+--- hidden_dyn_method
+hidden dyn method
+= class Host < Object
+host class
+== Instance Methods
+--- host_method
+host method
+= reopen Host
+include DynMod
+HERE
+
+  def setup
+    @lib, = BitClust::RRDParser.parse(SRC, 'dynlib')
+    @host = @lib.fetch_class('Host')
+  end
+
+  def test_returns_public_instance_methods_of_dynamically_included_modules
+    assert_equal(['dyn_method'], @host.dynamically_included_entries.map(&:name))
+  end
+
+  def test_excludes_private_instance_methods_of_the_dynamically_included_module
+    names = @host.dynamically_included_entries.map(&:name)
+    assert_not_include(names, 'hidden_dyn_method')
+  end
+
+  def test_entries_keep_their_originating_module_and_library
+    entry = @host.dynamically_included_entries.first
+    assert_equal('DynMod', entry.klass.name)
+    assert_equal('dynlib', entry.library.name)
+  end
+
+  def test_does_not_affect_ancestors
+    # dynamic include must not change the MRO/ancestors chain.
+    assert_equal(['Host', 'Object'], @host.ancestors.map(&:name))
+  end
+
+  def test_does_not_affect_entries_or_partitioned_entries
+    assert_not_include(@host.entries.map(&:name), 'dyn_method')
+    parts = @host.partitioned_entries
+    assert_not_include(parts.instance_methods.map(&:name), 'dyn_method')
+    assert_not_include(parts.added.map(&:name), 'dyn_method')
+  end
+
+  def test_is_empty_when_class_has_no_dynamic_include
+    plain, = BitClust::RRDParser.parse(<<'PLAIN', 'dynlib')
+= class Plain < Object
+plain class
+== Instance Methods
+--- plain_method
+plain method
+PLAIN
+    assert_equal([], plain.fetch_class('Plain').dynamically_included_entries)
+  end
+end

data/test/test_eol_warning.rb

@@ -0,0 +1,43 @@
+require 'test/unit'
+require 'bitclust'
+require 'bitclust/screen'
+
+class TestEOLWarning < Test::Unit::TestCase
+  SRC = <<'HERE'
+= class Hoge
+hoge class
+== Instance Methods
+--- foo
+foo method
+HERE
+
+  BANNER_TEXT = 'このマニュアルは既にメンテナンスが終了したバージョンの Ruby を対象としています。'
+  LATEST_URL = 'https://docs.ruby-lang.org/ja/latest/'
+
+  def render(manager_options)
+    lib, = BitClust::RRDParser.parse(SRC, 'testlib')
+    datadir = File.expand_path('../data/bitclust', __dir__)
+    manager = BitClust::ScreenManager.new({
+      :templatedir => "#{datadir}/template.offline",
+      :catalogdir => "#{datadir}/catalog",
+      :encoding => 'utf-8',
+      :default_encoding => 'utf-8',
+      :base_url => '',
+      :target_version => '3.0'
+    }.merge(manager_options))
+    db = BitClust::MethodDatabase.dummy('version' => '3.0')
+    manager.class_screen(lib.fetch_class('Hoge'), :database => db).body
+  end
+
+  def test_eol_warning_banner_is_shown_when_enabled
+    html = render(:eol_warning => true)
+    assert_include(html, BANNER_TEXT)
+    assert_include(html, LATEST_URL)
+  end
+
+  def test_eol_warning_banner_is_hidden_by_default
+    html = render({})
+    assert_not_include(html, BANNER_TEXT)
+    assert_not_include(html, LATEST_URL)
+  end
+end

data/test/test_functionreferenceparser.rb

@@ -48,4 +48,15 @@ HERE
       assert_equal data[:expected], result.collect(&:source)
     }
   end
+
+  # source_location points at the file only; the line number is no longer
+  # recorded (it would only churn the generated diffs).
+  def test_source_location_has_no_line_number
+    @db.transaction {
+      result = @parser.parse_file(@path, "test.c", {"version" => "2.6.0"})
+      location = result.first.source_location
+      assert_equal @path, location.file
+      assert_nil location.line
+    }
+  end
 end