bitclust-core 1.3.0 → 1.6.0

data/test/test_methodsince_command.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+require 'test/unit'
+require 'bitclust'
+require 'bitclust/methoddatabase'
+require 'bitclust/subcommands/methodsince_command'
+require 'stringio'
+require 'tmpdir'
+require 'fileutils'
+
+# methodsince サブコマンド(bitclust#132 P2)。
+#
+# テストリスト:
+# [x] グローバル --database 不要(needs_database? が false)
+# [x] --update が無いとエラー
+# [x] ラダー DB を走査して --update 対象に since/until が書き込まれる
+#     (フロアのメソッドには付かず、ゲート付きメソッドには付く)
+# [x] 統計行が "basename (version V): entries_updated=.. since_filled=..
+#     until_filled=.. floor_skipped=.." の形式で出力される
+# [x] --update は複数指定でき、対象ごとに統計行が出力される
+# [x] --update に無い位置引数の DB はラダーには参加するが書き込まれない
+# [x] --dry-run は統計を表示するだけで実DBファイルには一切書き込まない
+# [x] Runner に登録されている(bitclust methodsince として呼べる)
+class TestMethodsinceCommand < Test::Unit::TestCase
+  def setup
+    @tmpdir = "methodsince_test_tmp"
+    FileUtils.rm_rf(@tmpdir)
+    @db10 = build_db('1.0', <<~'RD')
+      description
+
+      = class Foo < Object
+      == Instance Methods
+      --- old
+
+      説明
+    RD
+    @db20 = build_db('2.0', <<~'RD')
+      description
+
+      = class Foo < Object
+      == Instance Methods
+      --- old
+
+      説明
+
+      #@since 2.0
+      --- newone
+
+      説明
+      #@end
+    RD
+  end
+
+  def teardown
+    FileUtils.rm_rf(@tmpdir)
+  end
+
+  def build_db(version, builtin_rd)
+    root = "#{@tmpdir}/tree-#{version}/refm/api/src"
+    FileUtils.mkdir_p("#{root}/_builtin")
+    File.write("#{root}/LIBRARIES", "_builtin\n")
+    File.write("#{root}/_builtin.rd", builtin_rd)
+    prefix = "#{@tmpdir}/db-#{version}"
+    db = BitClust::MethodDatabase.new(prefix)
+    db.init
+    db.transaction do
+      db.propset('version', version)
+      db.propset('encoding', 'utf-8')
+    end
+    db.transaction do
+      db.update_by_stdlibtree(root)
+    end
+    prefix
+  end
+
+  def run_command(argv)
+    cmd = BitClust::Subcommands::MethodsinceCommand.new
+    cmd.parse(argv)
+    out = StringIO.new
+    orig_stdout = $stdout
+    $stdout = out
+    begin
+      cmd.exec(argv, { prefix: nil, capi: false })
+    ensure
+      $stdout = orig_stdout
+    end
+    out.string
+  end
+
+  def find_entry(prefix, name)
+    db = BitClust::MethodDatabase.new(prefix)
+    db.get_class('Foo').entries.find {|m| m.name?(name) }
+  end
+
+  def test_needs_no_global_database_option
+    cmd = BitClust::Subcommands::MethodsinceCommand.new
+    assert_false cmd.needs_database?
+  end
+
+  def test_no_update_is_an_error
+    cmd = BitClust::Subcommands::MethodsinceCommand.new
+    argv = [@db10, @db20]
+    cmd.parse(argv)
+    assert_raise(SystemExit) do
+      capture_stderr { cmd.exec(argv, { prefix: nil, capi: false }) }
+    end
+  end
+
+  def test_fills_since_into_update_target
+    run_command([@db10, "--update=#{@db20}"])
+    assert_nil find_entry(@db20, 'old').since_of('old')
+    assert_equal '2.0', find_entry(@db20, 'newone').since_of('newone')
+  end
+
+  def test_prints_one_stats_line_per_target
+    out = run_command([@db10, "--update=#{@db20}"])
+    assert_match(
+      /\Adb-2\.0 \(version 2\.0\): entries_updated=\d+ since_filled=\d+ until_filled=\d+ floor_skipped=\d+\n\z/,
+      out)
+  end
+
+  def test_multiple_update_targets_each_get_a_stats_line
+    out = run_command(["--update=#{@db10}", "--update=#{@db20}"])
+    lines = out.lines
+    assert_equal 2, lines.size
+    assert_match(/\Adb-1\.0 /, lines[0])
+    assert_match(/\Adb-2\.0 /, lines[1])
+  end
+
+  def test_positional_ladder_db_is_not_written_to
+    before = File.read(property_file_path(@db10, 'old'))
+    run_command([@db10, "--update=#{@db20}"])
+    after = File.read(property_file_path(@db10, 'old'))
+    assert_equal before, after
+  end
+
+  def test_dry_run_leaves_real_database_untouched
+    run_command([@db10, "--update=#{@db20}", '--dry-run'])
+    assert_nil find_entry(@db20, 'newone').since_of('newone')
+  end
+
+  def test_dry_run_still_prints_computed_stats
+    out = run_command([@db10, "--update=#{@db20}", '--dry-run'])
+    assert_match(/since_filled=1\b/, out)
+  end
+
+  def test_registered_in_runner
+    require 'bitclust/runner'
+    runner = BitClust::Runner.new
+    runner.prepare
+    subcommands = runner.instance_variable_get(:@subcommands)
+    assert_kind_of(BitClust::Subcommands::MethodsinceCommand, subcommands['methodsince'])
+  end
+
+  private
+
+  def property_file_path(prefix, name)
+    id = BitClust::NameUtils.build_method_id('_builtin', 'Foo', :instance_method, name)
+    File.join(prefix, BitClust::NameUtils.encodeid("method/#{id}"))
+  end
+
+  def capture_stderr
+    orig = $stderr
+    $stderr = StringIO.new
+    yield
+  ensure
+    $stderr = orig
+  end
+end

data/test/test_nameutils.rb

@@ -306,6 +306,28 @@ class TestNameUtils < Test::Unit::TestCase
     assert_equal(expected, typemark2char(target))
   end
 
+  # bitclust#250: Ruby 4.0 以降のドキュメントでは module function の表記を
+  # 独自の「.#」から「?.」に変える。表示だけの変換であり、識別子(typemark
+  # そのもの・typemark2char 等)は一切変えないので、対象は '.#' のみ。
+  # バージョン比較は文字列比較ではなく Gem::Version で行う(例: "10.0" を
+  # 文字列比較すると "4.0" より小さく見えてしまう)。
+  data("module function before 4.0 stays as-is"       => ['.#', '.#', '3.4'],
+       "module function at exactly 4.0 switches"      => ['?.', '.#', '4.0'],
+       "module function after 4.0 switches"           => ['?.', '.#', '4.1'],
+       "module function 4.0.0 counts as 4.0"          => ['?.', '.#', '4.0.0'],
+       "module function double-digit major (10.0)"    => ['?.', '.#', '10.0'],
+       "module function just under 4.0 stays as-is"   => ['.#', '.#', '3.99'],
+       "module function with nil version stays as-is" => ['.#', '.#', nil],
+       "module function with empty version stays"     => ['.#', '.#', ''],
+       "singleton method mark is never rewritten"     => ['.',  '.',  '4.0'],
+       "instance method mark is never rewritten"      => ['#',  '#',  '4.0'],
+       "constant mark is never rewritten"             => ['::', '::', '4.0'],
+       "special variable mark is never rewritten"     => ['$',  '$',  '4.0'])
+  def test_display_typemark(data)
+    expected, mark, version = data
+    assert_equal(expected, display_typemark(mark, version))
+  end
+
   data("s" => [".",  "s"],
        "i" => ["#",  "i"],
        "m" => [".#", "m"],

data/test/test_preprocessor.rb

@@ -1,6 +1,7 @@
 require 'test/unit'
 require 'bitclust/preprocessor'
 require 'stringio'
+require 'tmpdir'
 
 class TestPreprocessor < Test::Unit::TestCase
   include BitClust
@@ -313,4 +314,218 @@ HERE
       assert_equal(expected, ret.join)
     end
   end
+
+  # bitclust#285: GitHub が #@since 等をユーザー mention として解釈してしまう
+  # 問題への対応で、@ を含まない新 prefix #% を導入する。旧 #@ も凍結タグの
+  # 旧ソース再取込のため引き続き受け付ける(両対応)
+  sub_test_case("percent prefix (#285)") do
+
+    def test_percent_eval_cond
+      params = { 'version' => '1.8.7' }
+
+      [
+       ['#%if( version > "1.8.0")',  true ],
+       ['#%if( version < "1.8.0")',  false],
+       ['#%since 1.8.0', true ],
+       ['#%since 1.8.7', true ],
+       ['#%until 1.8.7', false],
+       ['#%until 1.9.0', true ],
+      ].each{|cond, expected_result|
+        s = <<HERE
+#{cond}
+a
+#%else
+b
+#%end
+HERE
+        ret = Preprocessor.wrap(StringIO.new(s), params).to_a
+        if expected_result
+          assert_equal(["a\n"], ret)
+        else
+          assert_equal(["b\n"], ret)
+        end
+      }
+    end
+
+    def test_percent_comment
+      params = { 'version' => '1.8.7' }
+      src = <<HERE
+a
+#%# preprocessor comment
+b
+HERE
+      ret = Preprocessor.wrap(StringIO.new(src), params).to_a
+      assert_equal(["a\n", "b\n"], ret)
+    end
+
+    def test_percent_todo_normalized
+      params = { 'version' => '1.8.7' }
+      src = <<HERE
+--- puts(str) -> String
+#%todo
+description
+HERE
+      expected = <<HERE
+--- puts(str) -> String
+@todo
+description
+HERE
+      ret = Preprocessor.wrap(StringIO.new(src), params).to_a
+      assert_equal(expected, ret.join)
+    end
+
+    def test_percent_samplecode
+      params = { 'version' => '1.9.2' }
+      src = <<HERE
+#%samplecode description
+puts("xxx")
+#%since 1.9.2
+puts("zzz")
+#%end
+#%end
+HERE
+      expected = <<HERE
+//emlist[description][ruby]{
+puts("xxx")
+puts("zzz")
+//}
+HERE
+      ret = Preprocessor.wrap(StringIO.new(src), params).to_a
+      assert_equal(expected, ret.join)
+    end
+
+    def test_mixed_prefixes
+      # 移行期は同一ファイル内で新旧 prefix が混在しうる
+      params = { 'version' => '2.0.0' }
+      src = <<HERE
+#%since 1.9.3
+a
+\#@since 2.4.0
+b
+#%end
+\#@end
+c
+HERE
+      expected = <<HERE
+a
+c
+HERE
+      ret = Preprocessor.wrap(StringIO.new(src), params).to_a
+      assert_equal(expected, ret.join)
+    end
+
+    def test_percent_unknown_directive
+      params = { 'version' => '1.8.7' }
+      src = <<HERE
+#%nosuch
+HERE
+      assert_raise(BitClust::ParseError) do
+        Preprocessor.wrap(StringIO.new(src), params).to_a
+      end
+    end
+
+    def test_percent_include
+      Dir.mktmpdir do |dir|
+        File.write("#{dir}/inc.rd", "included\n")
+        File.write("#{dir}/main.rd", <<~HERE)
+          before
+          #%include(inc.rd)
+          after
+        HERE
+        ret = Preprocessor.process("#{dir}/main.rd", { 'version' => '1.8.7' })
+        assert_equal("before\nincluded\nafter\n", ret.join)
+      end
+    end
+
+    def test_at_include_still_works
+      Dir.mktmpdir do |dir|
+        File.write("#{dir}/inc.rd", "included\n")
+        File.write("#{dir}/main.rd", <<~HERE)
+          before
+          \#@include(inc.rd)
+          after
+        HERE
+        ret = Preprocessor.process("#{dir}/main.rd", { 'version' => '1.8.7' })
+        assert_equal("before\nincluded\nafter\n", ret.join)
+      end
+    end
+  end
+
+  # bitclust#285: 版範囲の省略記法 #%version A...B(半開区間 [A, B))。
+  # Ruby の終端排他 Range リテラルに合わせて3点ドット。
+  # A... は A 以上(#%since 相当)、...B は B 未満(#%until 相当)
+  sub_test_case("version range (#285)") do
+
+    def process(src, version)
+      Preprocessor.wrap(StringIO.new(src), { 'version' => version }).to_a.join
+    end
+
+    def gated(cond)
+      <<HERE
+#{cond}
+in
+#%else
+out
+#%end
+HERE
+    end
+
+    def test_bounded_range
+      src = gated('#%version 3.1...3.4')
+      assert_equal "out\n", process(src, '3.0')
+      assert_equal "in\n",  process(src, '3.1')   # 始端は含む
+      assert_equal "in\n",  process(src, '3.2')
+      assert_equal "out\n", process(src, '3.4')   # 終端は含まない
+      assert_equal "out\n", process(src, '4.0')
+    end
+
+    def test_endless_range
+      src = gated('#%version 3.1...')
+      assert_equal "out\n", process(src, '3.0')
+      assert_equal "in\n",  process(src, '3.1')
+      assert_equal "in\n",  process(src, '4.1')
+    end
+
+    def test_beginless_range
+      src = gated('#%version ...3.1')
+      assert_equal "in\n",  process(src, '3.0')
+      assert_equal "out\n", process(src, '3.1')
+    end
+
+    def test_quoted_versions
+      src = gated('#%version "3.1"..."3.4"')
+      assert_equal "in\n",  process(src, '3.1')
+      assert_equal "out\n", process(src, '3.4')
+    end
+
+    def test_old_prefix
+      src = gated("\#@version 3.1...3.4")
+      assert_equal "in\n", process(src, '3.2')
+    end
+
+    def test_nesting_with_since
+      src = <<HERE
+#%version 3.1...4.0
+#%since 3.3
+both
+#%end
+#%end
+HERE
+      assert_equal "both\n", process(src, '3.3')
+      assert_equal "",       process(src, '3.2')
+      assert_equal "",       process(src, '4.0')
+    end
+
+    def test_two_dot_range_is_error
+      # .. (終端を含む Range)は誤解を招くため受け付けない(#285)
+      assert_raise(BitClust::ParseError) { process(gated('#%version 3.1..3.4'), '3.2') }
+    end
+
+    def test_malformed_ranges_are_error
+      assert_raise(BitClust::ParseError) { process(gated('#%version'), '3.2') }
+      assert_raise(BitClust::ParseError) { process(gated('#%version ...'), '3.2') }
+      assert_raise(BitClust::ParseError) { process(gated('#%version 3.1....3.4'), '3.2') }
+      assert_raise(BitClust::ParseError) { process(gated('#%version 3.1...3.4...4.0'), '3.2') }
+    end
+  end
 end