bitclust-core 1.3.0 → 1.6.0

data/test/test_rrdparser.rb

@@ -29,8 +29,7 @@ HERE
 = module Dummy
 == Instance Methods
 --- test_undef
-
-@undef
+{: undef}
 
 このメソッドは利用できない
 
@@ -39,4 +38,298 @@ HERE
     test_undef_spec = BitClust::MethodSpec.parse('Dummy#test_undef')
     assert_equal(:undefined, methoddatabase.get_method(test_undef_spec).kind)
   end
+
+  def test_nomethod
+    result = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_nomethod
+{: nomethod}
+
+説明のためここに記載しているメソッド
+
+HERE
+    _library, methoddatabase = result
+    test_nomethod_spec = BitClust::MethodSpec.parse('Dummy#test_nomethod')
+    assert_equal(:nomethod, methoddatabase.get_method(test_nomethod_spec).kind)
+  end
+
+  def test_unknown_method_attribute
+    assert_raise(BitClust::ParseError) do
+      BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_typo
+{: nomthod}
+
+typo したフラグはエラーになる
+
+HERE
+    end
+  end
+
+  def test_since_attribute_sets_since_of_name
+    _library, db = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_since
+{: since="2.5"}
+
+説明
+
+HERE
+    entry = db.get_method(BitClust::MethodSpec.parse('Dummy#test_since'))
+    assert_equal('2.5', entry.since_of('test_since'))
+    assert_nil(entry.until_of('test_since'))
+  end
+
+  # {: since=""}(空値)は「明示的に不明」の指定(bitclust#132)。メソッド自体は
+  # 昔からあるのにドキュメント追加が遅れ、ラダー算出が誤った版を出す場合に
+  # バッジを抑止する(空文字が記録され、算出値で上書きされず、表示もされない)
+  def test_empty_since_attribute_means_explicitly_unknown
+    _library, db = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_unknown
+{: since=""}
+
+説明
+
+HERE
+    entry = db.get_method(BitClust::MethodSpec.parse('Dummy#test_unknown'))
+    assert_equal('', entry.since_of('test_unknown'))
+    assert_nil(entry.until_of('test_unknown'))
+  end
+
+  def test_empty_until_attribute_is_also_accepted
+    _library, db = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_unknown_until
+{: until=""}
+
+説明
+
+HERE
+    entry = db.get_method(BitClust::MethodSpec.parse('Dummy#test_unknown_until'))
+    assert_equal('', entry.until_of('test_unknown_until'))
+  end
+
+  def test_until_attribute_sets_until_of_name
+    _library, db = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_until
+{: until="3.0"}
+
+説明
+
+HERE
+    entry = db.get_method(BitClust::MethodSpec.parse('Dummy#test_until'))
+    assert_equal('3.0', entry.until_of('test_until'))
+    assert_nil(entry.since_of('test_until'))
+  end
+
+  # bitclust#132: 特殊変数のシグネチャ名は "$PROGRAM_NAME" のように $ 付き
+  # だが、エントリの names は $ を剥がした形で格納される。since_by_name の
+  # キーは names に合わせる(正規化しないと黙って参照されない値になる)
+  def test_since_attribute_on_special_variable_uses_entry_name
+    _library, db = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Kernel
+== Special Variables
+--- $0
+--- $PROGRAM_NAME
+{: since="1.9.1"}
+
+説明
+
+HERE
+    entry = db.get_class('Kernel').entries.first || raise
+    assert_equal(['0', 'PROGRAM_NAME'], entry.names.sort)
+    assert_equal('1.9.1', entry.since_of('PROGRAM_NAME'))
+    assert_nil(entry.since_of('0'))
+  end
+
+  def test_malformed_since_attribute_is_rejected
+    ['since=2.5', 'since="3,2"', 'since="abc"', 'foo="1"'].each do |token|
+      assert_raise(BitClust::ParseError, token) do
+        BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_since
+{: #{token}}
+
+説明
+
+HERE
+      end
+    end
+  end
+
+  def test_duplicate_since_attribute_on_one_signature_is_rejected
+    assert_raise(BitClust::ParseError) do
+      BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_since
+{: since="1.0" since="2.0"}
+
+説明
+
+HERE
+    end
+  end
+
+  def test_instance_methods
+    result = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+
+== Instance Methods
+--- im
+
+== Private Methods
+
+--- pvi
+
+== Protected Instance Methods
+
+--- pti
+
+HERE
+    _library, methoddatabase = result
+
+    test_undef_spec = BitClust::MethodSpec.parse('Dummy#im')
+    assert_equal(true, methoddatabase.get_method(test_undef_spec).public?)
+
+    test_undef_spec = BitClust::MethodSpec.parse('Dummy#pvi')
+    assert_equal(true, methoddatabase.get_method(test_undef_spec).private?)
+
+    test_undef_spec = BitClust::MethodSpec.parse('Dummy#pti')
+    assert_equal(true, methoddatabase.get_method(test_undef_spec).protected?)
+  end
+end
+
+class TestRRDParserMethodAttributeBinding < Test::Unit::TestCase
+  # {: ...} は直前のシグネチャ行のみに束縛される(kramdown の Block IAL と同じ)。
+  # kind はエントリ単位なので、別名エントリでは全シグネチャに同じ属性が必要
+  def test_attribute_on_every_alias_signature
+    result = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_foo
+{: nomethod}
+--- test_bar
+{: nomethod}
+
+説明のためのエントリ
+
+HERE
+    _library, db = result
+    foo = db.get_method(BitClust::MethodSpec.parse('Dummy#test_foo'))
+    assert_equal(:nomethod, foo.kind)
+    assert_equal(['test_bar', 'test_foo'], foo.names)
+  end
+
+  def test_attribute_missing_on_some_alias_signature_is_rejected
+    assert_raise(BitClust::ParseError) do
+      BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_foo
+{: nomethod}
+--- test_bar
+
+説明のためのエントリ
+
+HERE
+    end
+  end
+
+  def test_since_attribute_differs_per_alias_signature
+    # since=/until= はシグネチャ単位で束縛され、nomethod/undef と違って
+    # エイリアスごとに異なる値を持てる(全シグネチャ一致は要求しない)
+    result = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_foo
+{: since="2.0.0"}
+--- test_bar
+{: since="3.0"}
+
+説明のためのエントリ
+
+HERE
+    _library, db = result
+    entry = db.get_method(BitClust::MethodSpec.parse('Dummy#test_foo'))
+    assert_equal(['test_bar', 'test_foo'], entry.names)
+    assert_equal('2.0.0', entry.since_of('test_foo'))
+    assert_equal('3.0', entry.since_of('test_bar'))
+  end
+
+  def test_since_attribute_on_only_one_alias_signature_is_allowed
+    result = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_foo
+{: since="2.0.0"}
+--- test_bar
+
+説明のためのエントリ
+
+HERE
+    _library, db = result
+    entry = db.get_method(BitClust::MethodSpec.parse('Dummy#test_foo'))
+    assert_equal('2.0.0', entry.since_of('test_foo'))
+    assert_nil(entry.since_of('test_bar'))
+  end
+
+  def test_undef_and_since_mixed_on_same_signature_line
+    result = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_foo
+{: undef since="3.0"}
+
+説明のためのエントリ
+
+HERE
+    _library, db = result
+    entry = db.get_method(BitClust::MethodSpec.parse('Dummy#test_foo'))
+    assert_equal(:undefined, entry.kind)
+    assert_equal('3.0', entry.since_of('test_foo'))
+  end
+
+  def test_bare_attribute_uniformity_still_enforced_when_since_present
+    # since= はシグネチャ単位で例外的に一致要求から外れるが、
+    # undef/nomethod のエントリ単位の一致要求はそのまま生きている
+    assert_raise(BitClust::ParseError) do
+      BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_foo
+{: undef since="3.0"}
+--- test_bar
+{: since="3.0"}
+
+説明のためのエントリ
+
+HERE
+    end
+  end
+
+  def test_detached_attribute_line_is_not_a_method_attribute
+    # 空行を挟んだ {: ...} はシグネチャに束縛されない(ただの本文)
+    result = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_foo
+
+{: nomethod}
+
+説明
+
+HERE
+    _library, db = result
+    assert_equal(:defined, db.get_method(BitClust::MethodSpec.parse('Dummy#test_foo')).kind)
+  end
 end

data/test/test_run_ruby_wasm.rb

@@ -0,0 +1,54 @@
+require 'test/unit'
+require 'bitclust'
+require 'bitclust/screen'
+
+class TestRunRubyWasm < Test::Unit::TestCase
+  SRC = <<'HERE'
+= class Hoge
+hoge class
+== Instance Methods
+--- foo
+foo method
+HERE
+
+  WASM_URL = 'https://cdn.jsdelivr.net/npm/@ruby/3.4-wasm-wasi@2.9.3-2.9.4/dist/ruby+stdlib.wasm'
+  META_TAG = %Q(<meta name="rurema-run-ruby-wasm" content="#{WASM_URL}">)
+
+  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.4'
+    }.merge(manager_options))
+    db = BitClust::MethodDatabase.dummy('version' => '3.4')
+    manager.class_screen(lib.fetch_class('Hoge'), :database => db).body
+  end
+
+  def test_run_script_is_loaded_when_enabled
+    html = render(:run_ruby_wasm => WASM_URL)
+    assert_include(html, META_TAG)
+    assert_include(html, 'js/run.js')
+  end
+
+  def test_run_script_is_not_loaded_by_default
+    html = render({})
+    assert_not_include(html, 'rurema-run-ruby-wasm')
+    assert_not_include(html, 'run.js')
+  end
+
+  def test_wasm_url_is_html_escaped
+    html = render(:run_ruby_wasm => 'https://example.com/ruby.wasm?a=1&b="x"')
+    assert_include(html, 'content="https://example.com/ruby.wasm?a=1&amp;b=&quot;x&quot;"')
+  end
+
+  def test_coexists_with_eol_warning
+    html = render(:run_ruby_wasm => WASM_URL, :eol_warning => true)
+    assert_include(html, META_TAG)
+    assert_include(html, 'class="eol-warning"')
+  end
+end

data/test/test_run_worker_prelude.rb

@@ -0,0 +1,83 @@
+require 'test/unit'
+
+# theme/default/js/run-worker.js の PRELUDE(Ruby コード)の検証。
+# Kernel#puts/print/p は $stdout が IO でないとき #write 経由で書き込むが、
+# マニュアルのサンプルは $stderr.puts や $stdout.putc のように IO のメソッドを
+# 直接呼ぶこともある(旧実装の StringIO はそれらを備えていた)。JS ブリッジを
+# スタブした実 Ruby で PRELUDE を eval し、両方の経路の出力を確認する。
+class TestRunWorkerPrelude < Test::Unit::TestCase
+  WORKER_JS = File.expand_path('../theme/default/js/run-worker.js', __dir__)
+
+  module JSStub
+    OUTPUT = []
+    def self.global
+      self
+    end
+
+    def self.call(name, text)
+      raise ArgumentError, "unexpected JS call: #{name}" unless name == :postOutput
+      OUTPUT << text.to_s
+    end
+  end
+
+  def setup
+    src = File.read(WORKER_JS)
+    prelude = src[/export const PRELUDE = `\n(.*?)\n`/m, 1]
+    assert_not_nil(prelude, 'PRELUDE not found in run-worker.js')
+    # ruby.wasm 上でだけ存在する js gem をスタブに差し替える
+    @prelude = prelude.sub(/\Arequire "js"\n/, '')
+    JSStub::OUTPUT.clear
+    Object.const_set(:JS, JSStub)
+  end
+
+  def teardown
+    Object.send(:remove_const, :JS) if Object.const_defined?(:JS)
+    Object.send(:remove_const, :JSStreamIO) if Object.const_defined?(:JSStreamIO)
+  end
+
+  def run_with_prelude
+    orig_stdout = $stdout
+    orig_stderr = $stderr
+    begin
+      eval(@prelude, TOPLEVEL_BINDING)
+      yield
+    ensure
+      $stdout = orig_stdout
+      $stderr = orig_stderr
+    end
+    JSStub::OUTPUT.join
+  end
+
+  def test_kernel_methods_stream_through_post_output
+    out = run_with_prelude do
+      puts 'hello'
+      print 'a', 'b'
+      p 123
+    end
+    assert_equal("hello\nab123\n", out)
+  end
+
+  def test_direct_io_methods_match_old_stringio_behavior
+    out = run_with_prelude do
+      $stdout.puts 'direct'
+      $stderr.puts 'err'
+      $stdout.putc 'XY'
+      $stdout.print 'pr'
+      $stdout.printf('%05d', 42)
+      $stdout << 'chained' << '!'
+      $stdout.flush
+      $stdout.puts ['a', ['b']]
+      $stdout.puts
+    end
+    assert_equal("direct\nerr\nXpr00042chained!a\nb\n\n", out)
+  end
+
+  def test_stream_reports_not_a_tty_and_accepts_sync
+    run_with_prelude do
+      assert_false($stdout.tty?)
+      assert_false($stderr.isatty)
+      assert_true($stdout.sync)
+      $stdout.sync = true
+    end
+  end
+end

data/test/test_runner.rb

@@ -94,4 +94,55 @@ class TestRunner < Test::Unit::TestCase
     command.exec(["--list"], {:prefix=>@prefix, :capi => false})
     @runner.run(["property", "--list"])
   end
+
+  def test_run_search_without_database
+    # search (Searcher) は自前で DB を探すので、--database も config も
+    # なしで実行できる
+    command = mock(Object.new)
+    mock(::BitClust::Searcher).new.returns(command)
+    mock(@runner).load_config.returns(nil)
+    command.parse(["String#gsub"])
+    command.exec(["String#gsub"], {:prefix => nil, :capi => false})
+    @runner.run(["search", "String#gsub"])
+  end
+
+  def test_run_database_command_without_database
+    # DB 必須のサブコマンドは、裸の raise ではなく案内付きのエラーで中断する
+    command = mock(Object.new)
+    mock(::BitClust::Subcommands::InitCommand).new.returns(command)
+    mock(@runner).load_config.returns(nil)
+    command.parse([])
+    command.needs_database?.returns(true)
+    original_stderr = $stderr
+    $stderr = StringIO.new
+    assert_raise(SystemExit) { @runner.run(["init"]) }
+    assert_include($stderr.string, "--database")
+  ensure
+    $stderr = original_stderr
+  end
+
+  def test_needs_database
+    # グローバル --database が不要なサブコマンド
+    # (DB を使わない・自前の -d を持つ・DB が任意)
+    [
+      BitClust::Subcommands::SetupCommand,
+      BitClust::Subcommands::PreprocCommand,
+      BitClust::Subcommands::ExtractCommand,
+      BitClust::Subcommands::ClassesCommand,
+      BitClust::Subcommands::MethodsCommand,
+      BitClust::Subcommands::AncestorsCommand,
+      BitClust::Subcommands::HtmlfileCommand,
+      BitClust::Subcommands::SearchpageCommand,
+    ].each do |klass|
+      assert_false(klass.new.needs_database?, klass.name)
+    end
+    # グローバル --database が必須のサブコマンド
+    [
+      BitClust::Subcommands::InitCommand,
+      BitClust::Subcommands::UpdateCommand,
+      BitClust::Subcommands::ListCommand,
+    ].each do |klass|
+      assert_true(klass.new.needs_database?, klass.name)
+    end
+  end
 end