bitclust-core 1.2.6 → 1.6.0

data/lib/bitclust/subcommands/ancestors_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bitclust'
 require 'bitclust/crossrubyutils'
 
@@ -44,10 +45,15 @@ Options:
         }
       end
 
+      # DB はサブコマンド自身の -d/--database オプションで受ける
+      def needs_database?
+        false
+      end
+
       def exec(argv, options)
         classname = argv[0]
-        db = MethodDatabase.new(@prefix)
-        ruby = get_ruby(@version)
+        db = MethodDatabase.new(@prefix || raise)
+        ruby = get_ruby(@version) || raise
         if classname && !@all
           check_ancestors(db, ruby, @requires, classname)
         else
@@ -82,6 +88,7 @@ Options:
         rescue ClassNotFound => ex
           $stderr.puts ex.backtrace
           $stderr.puts "class not found in database : #{classname}"
+          # @type var b: Array[String]
           b = []
         end
         unless a.to_set == b.to_set
@@ -94,6 +101,7 @@ Options:
       end
 
       def check_all_ancestors(db, ruby, requires)
+        # @type var classnames: Array[String]
         classnames = []
         requires.each do |lib|
           classnames.push(*defined_classes(ruby, lib, []))

data/lib/bitclust/subcommands/checklink_command.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# bitclust/subcommands/checklink_command.rb
+#
+# DB 中の全ソースをコンパイル経路で走査し、[[c:]]/[[m:]]/[[lib:]]/[[d:]]/
+# [[f:]] 参照のリンク切れを報告する:
+#
+#   bitclust -d db-3.4 checklink
+#   bitclust -d db-3.4 checklink --capi-database=db-3.4-capi
+#
+# リンク切れが1件でもあれば exit 1(CI 組み込み用)。
+# [[f:]](C API 関数)は --capi-database 指定時のみ検証し、
+# 未指定ならスキップ数だけ報告する。
+
+require 'bitclust'
+require 'bitclust/subcommand'
+require 'bitclust/link_checker'
+
+module BitClust
+  module Subcommands
+    class ChecklinkCommand < Subcommand
+      def initialize
+        super
+        @capi_prefix = nil
+        @parser.banner = "Usage: #{File.basename($0, '.*')} --database=PATH checklink [options]"
+        @parser.on('--capi-database=PATH', 'C API (function) database for [[f:]] refs.') {|path|
+          @capi_prefix = path
+        }
+      end
+
+      def exec(argv, options)
+        super
+        db = @db
+        unless db.is_a?(MethodDatabase)
+          error 'checklink is for method databases (do not use --capi; pass --capi-database instead)'
+        end
+        capi_prefix = @capi_prefix
+        fdb = capi_prefix ? BitClust::FunctionDatabase.new(capi_prefix) : nil
+        checker = LinkChecker.new(db, function_database: fdb)
+        checker.check_all
+        # 同一エントリ内の同一参照の繰り返しは1行にまとめる
+        checker.findings.map {|f| "#{f.location}: [[#{f.ref}]] #{f.message}" }.uniq.each do |line|
+          puts line
+        end
+        if fdb.nil? && checker.skipped_function_refs > 0
+          puts "note: #{checker.skipped_function_refs} [[f:]] refs skipped (no --capi-database)"
+        end
+        version = @db.properties['version']
+        puts "#{checker.broken_count} broken link(s) in #{version ? "db (version #{version})" : 'db'}"
+        exit 1 unless checker.broken_count.zero?
+      end
+    end
+  end
+end

data/lib/bitclust/subcommands/chm_command.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# frozen_string_literal: true
 
 require 'bitclust'
 require 'bitclust/subcommand'
@@ -133,7 +134,7 @@ EOS
         end
 
         def method_url(spec)
-          cname, tmark, mname = *split_method_spec(spec)
+          cname, tmark, mname = split_method_spec(spec)
           "/method/#{encodename_fs(cname)}/#{typemark2char(tmark)}/#{encodename_fs(mname)}.html"
         end
 
@@ -169,6 +170,7 @@ EOS
         manager = ScreenManager.new(@manager_config)
         @html_files = []
         db.transaction do
+          # @type var methods: Hash[String, Array[MethodEntry]]
           methods = {}
           db.methods.each do |entry|
             method_name = entry.klass.name + entry.typemark + entry.name
@@ -183,6 +185,7 @@ EOS
             e = c.is_a?(Array) ? c.sort.first : c
             case e.type_id
             when :library
+              # @type var e: LibraryEntry
               content = Sitemap::Content.new(e.name.to_s, filename)
               if e.name.to_s != '_builtin'
                 @sitemap[:library][1] << content
@@ -190,6 +193,7 @@ EOS
               end
               @index_contents << Sitemap::Content.new(e.name.to_s, filename)
             when :class
+              # @type var e: ClassEntry
               content = Sitemap::Content.new(e.name.to_s, filename)
               if e.library.name.to_s == '_builtin'
                 @sitemap[:library][0] << content
@@ -198,12 +202,15 @@ EOS
               end
               @index_contents << Sitemap::Content.new("#{e.name} (#{e.library.name})", filename)
             when :method
+              # @type var e: MethodEntry
               e.names.each do |e_name|
                 name = e.typename == :special_variable ? "$#{e_name}" : e_name
                 @index_contents <<
                   Sitemap::Content.new("#{name} (#{e.library.name} - #{e.klass.name})", filename)
+                # bitclust#250: CHM の索引(.hhk)に出る表示ラベル。4.0 以降の
+                # ドキュメントでは module function を "?." で表示する
                 @index_contents <<
-                  Sitemap::Content.new("#{e.klass.name}#{e.typemark}#{name} (#{e.library.name})", filename)
+                  Sitemap::Content.new("#{e.klass.name}#{e.display_typemark}#{name} (#{e.library.name})", filename)
               end
             end
             pb.title = align_progress_bar_title(e.name)
@@ -218,7 +225,7 @@ EOS
         create_file(@outputdir + 'library/index.html', manager.library_index_screen(db.libraries.sort, {:database => db}).body)
         create_file(@outputdir + 'class/index.html', manager.class_index_screen(db.classes.sort, {:database => db}).body)
         FileUtils.cp(@manager_config[:themedir] + @manager_config[:css_url],
-                     @outputdir.to_s, {:verbose => true, :preserve => true})
+                     @outputdir.to_s, verbose: true, preserve: true)
       end
 
       private
@@ -242,15 +249,17 @@ EOS
                     "\u0308" => "\u2025",
                     "\u2014" => "\u2015",
                     "\u2212" => "\uff0d",
-                    "\u301c" => "\uff5e" } 
+                    "\u301c" => "\uff5e" }
 
       def create_html_file(entry, manager, outputdir, db)
         html = manager.entry_screen(entry, {:database => db}).body
         e = entry.is_a?(Array) ? entry.sort.first : entry
         path = case e.type_id
                when :library, :class, :doc
-                 outputdir + e.type_id.to_s + (NameUtils.encodename_fs(e.name) + '.html')
+                # @type var e: LibraryEntry | ClassEntry | DocEntry
+                outputdir + e.type_id.to_s + (NameUtils.encodename_fs(e.name) + '.html')
                when :method
+                # @type var e: MethodEntry
                  outputdir + e.type_id.to_s + NameUtils.encodename_fs(e.klass.name) +
                    e.typechar + (NameUtils.encodename_fs(e.name) + '.html')
                else
@@ -260,7 +269,7 @@ EOS
 
         begin
           new_html = html.gsub(/charset=utf-8/i, 'charset=Windows-31J').
-                     encode('windows-31j', { :fallback => FIX_UNDEF })
+                     encode('windows-31j', fallback: FIX_UNDEF)
           mode = 'w:windows-31j'
         rescue
           new_html = html # write file as it is, utf-8
@@ -276,7 +285,7 @@ EOS
         $stderr.print("creating #{path} ...")
         str = ERB.new(skel).result(binding).
               gsub(/charset=utf-8/i, 'charset=Windows-31J').
-              encode('windows-31j', { :fallback => FIX_UNDEF } )
+              encode('windows-31j', fallback: FIX_UNDEF)
         path.open('w:windows-31j') do |f|
           f.write(str)
         end

data/lib/bitclust/subcommands/classes_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require 'optparse'
 
@@ -26,6 +27,11 @@ module BitClust
         option_error('wrong number of arguments') unless argv.size == 1
       end
 
+      # システムの ruby を調べるだけで DB を使わない
+      def needs_database?
+        false
+      end
+
       def exec(argv, options)
         lib = argv[0]
         print_crossruby_table {|ruby| defined_classes(ruby, lib, @rejects) }

data/lib/bitclust/subcommands/epub_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 require 'date'
 

data/lib/bitclust/subcommands/extract_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require 'optparse'
 
@@ -16,6 +17,11 @@ module BitClust
         }
       end
 
+      # ソースファイルを処理するだけで DB を使わない
+      def needs_database?
+        false
+      end
+
       def exec(argv, options)
         success = true
         argv.each do |path|

data/lib/bitclust/subcommands/htmlfile_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Copyright (c) 2006-2007 Minero Aoki
 #
 # This program is free software.
@@ -15,13 +16,13 @@ module BitClust
         @target = nil
         @templatedir = srcdir_root + "data/bitclust/template.offline"
         @baseurl = "file://" + srcdir_root.to_s
-        @version = "2.0.0"
+        @version = RUBY_VERSION
         @parser.banner = "Usage: #{File.basename($0, '.*')} htmlfile [options] rdfile"
         @parser.on('--target=NAME', 'Compile NAME to HTML.') {|name|
           @target = name
         }
-        @parser.on('--force', '-f', 'Force to use rd_file template.') {|name|
-          @rd_file = true
+        @parser.on('--[no-]force', '-f', 'Force to use rd_file template.') {|bool|
+          @rd_file = bool
         }
         @parser.on('--ruby_version=VER', '--ruby=VER', 'Set Ruby version') {|version|
           @version = version
@@ -34,6 +35,11 @@ module BitClust
         }
       end
 
+      # DB は与えられれば使うが必須ではない (--database は任意)
+      def needs_database?
+        false
+      end
+
       def exec(argv, options)
         db = MethodDatabase.dummy({'version' => @version})
         if options[:prefix]
@@ -41,7 +47,10 @@ module BitClust
         end
         @capi = options[:capi]
         target_file = argv[0]
-        options = { 'version' => @version }
+        if /refm\/doc\// =~ target_file
+          @rd_file = true if @rd_file.nil?
+        end
+        options = { 'version' => @version } #: Database::database_properties
         manager = ScreenManager.new(:templatedir => @templatedir,
                                     :base_url => @baseurl,
                                     :cgi_url => @baseurl,
@@ -58,11 +67,11 @@ module BitClust
               lib = RRDParser.parse_stdlib_file(target_file, options)
             end
             entry = @target ? lookup(lib, @target) : lib
-            puts manager.entry_screen(entry, { :database => db }).body
+            puts manager.entry_screen(entry, { :database => db, :target_version => @version }).body
             return
           rescue ParseError => ex
             $stderr.puts ex.message
-            $stderr.puts ex.backtrace[0], ex.backtrace[1..-1].map{|s| "\tfrom " + s}
+            $stderr.puts ex.backtrace[0], ex.backtrace[1..-1]&.map{|s| "\tfrom " + s}
           end
         end
 
@@ -82,8 +91,12 @@ module BitClust
       def lookup(lib, key)
         case
         when @capi && NameUtils.functionname?(key)
-          lib.find {|func| func.name == key}
+          # @type var lib: Array[FunctionEntry]
+          lib.is_a?(Array) or raise
+          lib.find {|func| func.name == key} or raise
         when NameUtils.method_spec?(key)
+          # @type var lib: LibraryEntry
+          lib.is_a?(LibraryEntry) or raise
           spec = MethodSpec.parse(key)
           if spec.constant?
             begin
@@ -95,6 +108,8 @@ module BitClust
             lib.fetch_methods(spec)
           end
         when NameUtils.classname?(key)
+          # @type var lib: LibraryEntry
+          lib.is_a?(LibraryEntry) or raise
           lib.fetch_class(key)
         else
           raise InvalidKey, "wrong search key: #{key.inspect}"

data/lib/bitclust/subcommands/init_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require 'erb'
 require 'find'
@@ -19,12 +20,15 @@ module BitClust
       STANDARD_PROPERTIES = %w( encoding version )
 
       def exec(argv, options)
-        prefix = options[:prefix]
+        prefix = options[:prefix] || raise
         db = MethodDatabase.new(prefix)
         db.init
         db.transaction {
           argv.each do |kv|
             k, v = kv.split('=', 2)
+            if k.nil? || v.nil?
+              raise "argument must be KEY=VALUE, but #{kv.inspect}"
+            end
             db.propset k, v
           end
         }

data/lib/bitclust/subcommands/list_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require 'erb'
 require 'find'
@@ -40,21 +41,29 @@ module BitClust
         super
         case @mode
         when :library
-          @db.libraries.map {|lib| lib.name }.sort.each do |name|
+          db = @db
+          db.is_a?(MethodDatabase) or raise "invalid database given. Use without --capi option"
+          db.libraries.map {|lib| lib.name }.sort.each do |name|
             puts name
           end
         when :class
-          @db.classes.map {|c| c.name }.sort.each do |name|
+          db = @db
+          db.is_a?(MethodDatabase) or raise "invalid database given. Use without --capi option"
+          db.classes.map {|c| c.name }.sort.each do |name|
             puts name
           end
         when :method
-          @db.classes.sort_by {|c| c.name }.each do |c|
+          db = @db
+          db.is_a?(MethodDatabase) or raise "invalid database given. Use without --capi option"
+          db.classes.sort_by {|c| c.name }.each do |c|
             c.entries.sort_by {|m| m.id }.each do |m|
               puts m.label
             end
           end
         when :function
-          @db.functions.sort_by {|f| f.name }.each do |f|
+          db = @db
+          db.is_a?(FunctionDatabase) or raise "invalid database given. Use with --capi option"
+          db.functions.sort_by {|f| f.name }.each do |f|
             puts f.name
           end
         else

data/lib/bitclust/subcommands/lookup_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require 'erb'
 require 'find'
@@ -50,19 +51,23 @@ module BitClust
 
       def exec(argv, options)
         super
-        entry = fetch_entry(@db, @type, @key)
-        puts fill_template(get_template(@type, @format), entry)
+        entry = fetch_entry(@db, @type, @key || raise)
+        puts fill_template(get_template(@type || raise, @format || raise), entry)
       end
 
       def fetch_entry(db, type, key)
         case type
         when :library
+          # @type var db: MethodDatabase
           db.fetch_library(key)
         when :class
+          # @type var db: MethodDatabase
           db.fetch_class(key)
         when :method
+          # @type var db: MethodDatabase
           db.fetch_method(MethodSpec.parse(key))
         when :function
+          # @type var db: FunctionDatabase
           db.fetch_function(key)
         else
           raise "must not happen: #{type.inspect}"
@@ -95,7 +100,7 @@ module BitClust
            <dt>classes</dt><dd><%= entry.classes.map {|c| c.name }.sort.join(', ') %></dd>
            <dt>methods</dt><dd><%= entry.methods.map {|m| m.name }.sort.join(', ') %></dd>
            </dl>
-           <%= compile_rd(entry.source) %>
+           <%= compile_rd(entry) %>
            End
         },
         :class   => {
@@ -118,7 +123,7 @@ module BitClust
            <dt>singleton_methods</dt><dd><%= entry.singleton_methods.map {|m| m.name }.sort.join(', ') %></dd>
            <dt>instance_methods</dt><dd><%= entry.instance_methods.map {|m| m.name }.sort.join(', ') %></dd>
            </dl>
-           <%= compile_rd(entry.source) %>
+           <%= compile_rd(entry) %>
            End
         },
         :method  => {
@@ -141,7 +146,7 @@ module BitClust
            <dt>kind</dt><dd><%= entry.kind %></dd>
            <dt>library</dt><dd><%= entry.library.name %></dd>
            </dl>
-           <%= compile_rd(entry.source) %>
+           <%= compile_rd(entry) %>
            End
         },
         :function => {
@@ -158,16 +163,31 @@ module BitClust
            <dt>header</dt><dd><%= entry.header %></dd>
            <dt>filename</dt><dd><%= entry.filename %></dd>
            </dl>
-           <%= compile_rd(entry.source) %>
+           <%= compile_rd(entry) %>
            End
         }
       }
 
-      def compile_rd(src)
+      def compile_rd(entry)
         umap = URLMapper.new(:base_url => 'http://example.com',
                              :cgi_url  => 'http://example.com/view')
-        compiler = RDCompiler.new(umap, 2)
-        compiler.compile(src)
+        if @db.properties['source_format'] == 'markdown'
+          # md ソースの DB は screen.rb と同じく MDCompiler（GFM）で描画する
+          Kernel.require 'bitclust/mdcompiler'
+          compiler = MDCompiler.new(umap, 2, { :gfm => true, :database => @db })
+        else
+          compiler = RDCompiler.new(umap, 2, { :database => @db })
+        end
+        # シグネチャ行の描画（permalink の id 等）はエントリ文脈を要求する
+        # ので、compile ではなくエントリ種別ごとの compile_* を使う
+        case entry
+        when MethodEntry
+          compiler.compile_method(entry)
+        when FunctionEntry
+          compiler.compile_function(entry)
+        else
+          compiler.compile(entry.source)
+        end
       end
     end
   end

data/lib/bitclust/subcommands/methods_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require 'optparse'
 
@@ -45,6 +46,11 @@ module BitClust
         option_error("wrong number of arguments") unless argv.size == 1
       end
 
+      # システムの ruby とリファレンスファイルを比較するだけで DB を使わない
+      def needs_database?
+        false
+      end
+
       def exec(argv, options)
         classname = argv[0]
         case @mode
@@ -59,6 +65,7 @@ module BitClust
           c = lib.fetch_class(classname)
           list0 = lib.classes.find_all{|c0| /\A#{classname}\b/o =~ c0.name }
           list0 = c.entries + list0
+          # @type var list: Array[String]
           list = list0.map {|ent| ent.labels.map {|n| expand_mf(n) } }.flatten
           if @content
             ri = @ri_path ? RiDatabase.open(@ri_path, nil) : RiDatabase.open_system_db
@@ -71,7 +78,7 @@ module BitClust
                 puts fmt.method_info(mthd.entry)
               else
                 name = name.sub(/\A\w+#/, '')
-                puts "--- #{name}\n\#@todo\n\n"
+                puts "--- #{name}\n#%todo\n\n"
               end
             end
           else
@@ -83,7 +90,7 @@ module BitClust
             end
           end
         else
-          raise "must not happen: #{mode.inspect}"
+          raise "must not happen: #{@mode.inspect}"
         end
       end
 
@@ -103,6 +110,8 @@ module BitClust
 
       def m_order(m)
         m, t = *m.reverse.split(/(\#|\.|::)/, 2)
+        m or raise
+        t or raise
         [ORDER[t] || 0, m.reverse]
       end
 

data/lib/bitclust/subcommands/methodsince_command.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+#
+# bitclust/subcommands/methodsince_command.rb
+#
+# Fills per-name since/until into method entries by scanning a version
+# ladder of databases:
+#
+#   bitclust methodsince --update=db-3.4 db-1.8.7 db-1.9.3 ... db-3.3 db-3.4
+#
+# Every positional argument and every --update path together form the
+# version ladder used to compute presence; --update paths are additionally
+# written back to (see bitclust/method_since_calculator.rb, bitclust#132 P2).
+#
+
+require 'bitclust'
+require 'bitclust/subcommand'
+require 'bitclust/method_since_calculator'
+require 'tmpdir'
+require 'fileutils'
+
+module BitClust
+  module Subcommands
+    class MethodsinceCommand < Subcommand
+      def initialize
+        super
+        @updates = []
+        @dry_run = false
+        @parser.banner = "Usage: #{File.basename($0, '.*')} methodsince [options] <dbpath>..."
+        @parser.on('--update=PATH', 'Writable target database to fill in-place (repeatable).') {|path|
+          @updates.push path
+        }
+        @parser.on('--dry-run', 'Compute and print stats without saving.') {
+          @dry_run = true
+        }
+      end
+
+      # DB パスは自前の引数(位置引数 + --update)で受けるので、
+      # グローバル --database は不要
+      def needs_database?
+        false
+      end
+
+      def exec(argv, options)
+        error("no --update given (nothing to write to)") if @updates.empty?
+
+        ladder_paths = (argv + @updates).uniq {|path| File.expand_path(path) }
+        calculator = MethodSinceCalculator.new(ladder_paths.map {|path| MethodDatabase.new(path) })
+        calculator.scan
+
+        @updates.each do |path|
+          stats, version = @dry_run ? apply_dry_run(calculator, path) : apply_and_save(calculator, path)
+          puts "#{File.basename(path)} (version #{version}): " \
+               "entries_updated=#{stats[:entries_updated]} since_filled=#{stats[:since_filled]} " \
+               "until_filled=#{stats[:until_filled]} floor_skipped=#{stats[:floor_skipped]}"
+        end
+      end
+
+      private
+
+      def apply_and_save(calculator, path)
+        target = MethodDatabase.new(path)
+        version = target.propget('version') or
+          error("#{path}: no version property (not a bitclust database?)")
+        [calculator.apply(target), version]
+      end
+
+      # --dry-run: 実際のデータベースには一切書き込まず、複製に対して
+      # apply した結果の統計だけを見せる
+      def apply_dry_run(calculator, path)
+        version = MethodDatabase.new(path).propget('version') or
+          error("#{path}: no version property (not a bitclust database?)")
+        Dir.mktmpdir do |tmp|
+          copy = File.join(tmp, 'db')
+          FileUtils.cp_r(path, copy)
+          [calculator.apply(MethodDatabase.new(copy)), version]
+        end
+      end
+    end
+  end
+end

data/lib/bitclust/subcommands/preproc_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require 'optparse'
 
@@ -17,6 +18,11 @@ module BitClust
         }
       end
 
+      # ソースファイルを処理するだけで DB を使わない
+      def needs_database?
+        false
+      end
+
       def exec(argv, options)
         argv.each do |path|
           File.open(path) {|file|

data/lib/bitclust/subcommands/property_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require 'erb'
 require 'find'
@@ -48,7 +49,7 @@ module BitClust
       end
 
       def exec(argv, options)
-        prefix = options[:prefix]
+        prefix = options[:prefix] || raise
         db = MethodDatabase.new(prefix)
         case @mode
         when :list
@@ -61,6 +62,7 @@ module BitClust
           end
         when :set
           key, val = *argv
+          key || raise; val || raise
           db.transaction {
             db.propset key, val
           }

data/lib/bitclust/subcommands/query_command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 require 'erb'
 require 'find'