bitclust-core 1.3.0 → 1.6.0

data/lib/bitclust/completion.rb

@@ -10,7 +10,7 @@
 
 module BitClust
 
-  # Provides completion search methods like _search_classes, _search_methods. 
+  # Provides completion search methods like _search_classes, _search_methods.
   # Included by MethodDatabase and FunctionDatabase.
   module Completion
 
@@ -21,18 +21,20 @@ module BitClust
     #
 
     def _search_classes(pattern)
+      # @type self: MethodDatabase
       expand_ic(classes(), pattern)
     end
 
     def _search_methods(pattern)
+      # @type self: MethodDatabase
       case
       when pattern.empty?
         recordclass = SearchResult::Record
         SearchResult.new(self, pattern, classes(),
-            methods().map {|m| s = m.spec; recordclass.new(s, s, m) })
+            methods().map {|m| s = m.spec; recordclass.new(self, s, s, m) })
       when pattern.special_variable?
         c = fetch_class('Kernel')
-        SearchResult.new(self, pattern, [c], search_svar(c, pattern.method))
+        SearchResult.new(self, pattern, [c], search_svar(c, pattern.method || raise))
       when pattern.class?
         search_methods_from_cname(pattern)
       else
@@ -54,22 +56,25 @@ GC.enable; GC.start; x
     end
 
     def _search_functions(pattern)
+      # @type self: FunctionDatabase
       expand_ic(functions(), pattern)
     end
 
     def search_svar(c, pattern)
+      # @type self: MethodDatabase
       expand(c.special_variables, pattern)\
           .map {|m| SearchResult::Record.new(self, m.spec, m.spec, m) }
     end
 
     def search_methods_from_cname(pattern)
-      cs = expand_ic(classes(), pattern.klass)
+      # @type self: MethodDatabase
+      cs = expand_ic(classes(), pattern.klass || raise)
       return SearchResult.new(self, pattern, [], []) if cs.empty?
       recs = cs.map {|c|
         c.entries.map {|m|
           if not pattern.type or m.typemark == pattern.type
             s = m.spec
-            SearchResult::Record.new(s, s, m)
+            SearchResult::Record.new(self, s, s, m)
           else
             nil
           end
@@ -79,13 +84,16 @@ GC.enable; GC.start; x
     end
 
     def mspec_from_cref_mname(cref, name)
+      # @type self: MethodDatabase
       m = /\A(#{NameUtils::CLASS_PATH_RE})(#{NameUtils::TYPEMARK_RE})\Z/.match(cref)
-      MethodSpec.new(m[1], m[2], name)
+      m || raise
+      MethodSpec.new(m[1] || raise, _ = m[2], name)
     end
 
     def search_methods_from_mname(pattern)
+      # @type self: MethodDatabase
 #timer_init
-      names = expand_name_narrow(method_names(), pattern.method)
+      names = expand_name_narrow(method_names(), pattern.method || raise)
 #split_time "m expandN (#{names.size})"
       records = names.map {|name|
         crefs = mname2crefs_narrow(name)
@@ -99,14 +107,16 @@ GC.enable; GC.start; x
     end
 
     def search_methods_from_cname_mname(pattern)
+      # @type self: MethodDatabase
 #timer_init
       recs = try(typechars(pattern.type, pattern.method)) {|ts|
-        expand_method_name(pattern.klass, ts, pattern.method)
+        expand_method_name(pattern.klass || raise, ts, pattern.method || raise)
       }
-      SearchResult.new(self, pattern, recs.map {|rec| rec.class_name }, recs)
+      SearchResult.new(self, pattern, recs.map {|rec| rec.class_name }, recs) # steep:ignore
     end
 
     def expand_method_name(c, ts, m)
+      # @type self: MethodDatabase
       names_w = expand_name_wide(method_names(), m)
       return [] if names_w.empty?
 #split_time "m expandW (#{names_w.size})"
@@ -142,18 +152,20 @@ GC.enable; GC.start; x
     end
 
     def count_class(recs)
+      # @type self: MethodDatabase
       recs.map {|rec| rec.class_name }.uniq.size
     end
 
     def make_cm_combination(cpat, ts, mnames)
-      result = []
+      # @type self: MethodDatabase
+      result = [] #: Array[SearchResult::Record]
 $cm_comb_m = 0
       mnames.each do |m|
         crefs = expand_name_narrow(mname2crefs_wide(m), cpat, ts)
         next if crefs.empty?
 $cm_comb_m += 1
         crefs.each do |ref|
-          spec = MethodSpec.new(classid2name(ref.chop), ref[-1,1], m)
+          spec = MethodSpec.new(classid2name(ref.chop), _ = ref[-1,1], m)
           result.push SearchResult::Record.new(self, spec)
         end
       end
@@ -176,7 +188,7 @@ $cm_comb_m += 1
     end
 
     def unify_entries(ents)
-      h = {}
+      h = {} #: Hash[SearchResult::Record, SearchResult::Record]
       ents.each do |ent|
         if ent0 = h[ent]
           ent0.merge ent
@@ -189,6 +201,7 @@ $cm_comb_m += 1
 
     # Case-insensitive search.  Optimized for constant search.
     def expand_ic(xs, pattern)
+      # @type self: MethodDatabase | FunctionDatabase
       re1 = /\A#{Regexp.quote(pattern)}/i
       result1 = xs.select {|x| x.name_match?(re1) }
       return [] if result1.empty?
@@ -201,6 +214,7 @@ $cm_comb_m += 1
     end
 
     def expand(xs, pattern)
+      # @type self: MethodDatabase
       re1 = /\A#{Regexp.quote(pattern)}/i
       result1 = xs.select {|x| x.name_match?(re1) }
       return [] if result1.empty?
@@ -217,12 +231,14 @@ $cm_comb_m += 1
 
     # list up all matched items (without squeezing)
     def expand_name_wide(names, pattern)
+      # @type self: MethodDatabase
       re1 = /\A#{Regexp.quote(pattern)}/i
       names.grep(re1)
     end
 
     # list up matched items (with squeezing)
     def expand_name_narrow(names, pattern, suffixes = nil)
+      # @type self: MethodDatabase
       re1 = /\A#{Regexp.quote(pattern)}/i
       result1 = names.grep(re1)
       return [] if result1.empty?
@@ -232,6 +248,7 @@ $cm_comb_m += 1
 
     # squeeze result of #expand_name_wide
     def squeeze_names(result1, pattern, suffixes = nil)
+      # @type self: MethodDatabase
       regexps =
         [
          /\A#{Regexp.quote(pattern)}.*#{suffix_pattern(suffixes)}\z/i,
@@ -258,6 +275,7 @@ $cm_comb_m += 1
     #
 
     def save_completion_index
+      # @type self: MethodDatabase
       save_class_index
       save_method_index
       save_method_index_narrow
@@ -268,9 +286,9 @@ $cm_comb_m += 1
     end
 
     def intern_table
-      @intern_table ||= 
+      @intern_table ||=
           begin
-            h = {}
+            h = {} #: Hash[String, String]
             classnametable().each do |id, names|
               names.each do |n|
                 h[n] = id
@@ -281,6 +299,7 @@ $cm_comb_m += 1
     end
 
     def save_class_index
+      # @type self: MethodDatabase
       atomic_write_open('class/=index') {|f|
         classes().each do |c|
           #f.puts "#{c.id}\t#{c.names.join(' ')}"  # FIXME: support class alias
@@ -290,11 +309,13 @@ $cm_comb_m += 1
     end
 
     def classnametable
+      # @type self: MethodDatabase
       @classnametable ||=
           begin
-            h = {}
+            h = {} #: Hash[String, Array[String]]
             foreach_line('class/=index') do |line|
               id, *names = line.split
+              id || raise
               h[id] = names
             end
             h
@@ -304,9 +325,10 @@ $cm_comb_m += 1
     end
 
     def save_method_index_narrow
+      # @type self: MethodDatabase
       index =
           begin
-            h = {}
+            h = {} #: Hash[String, Array[String]]
             classes().each do |c|
               c.entries.each do |m|
                 ref = c.id + m.typemark
@@ -325,11 +347,13 @@ $cm_comb_m += 1
     end
 
     def method_index_small
+      # @type self: MethodDatabase
       @method_index_small ||=
           begin
-            h = {}
+            h = {} #: Hash[String, Array[String]]
             foreach_line('method/=sindex') do |line|
               name, *crefs = line.split(nil)
+              name || raise
               h[name] = crefs
             end
             h
@@ -342,13 +366,16 @@ $cm_comb_m += 1
     end
 
     def save_method_index
+      # @type self: MethodDatabase
       index =
           begin
-            h = {}
+            h = {} #: Hash[String, Array[String]]
             classes().each do |c|
               [ ['#', c._imap.keys],
                 ['.', c._smap.keys],
                 [':', c._cmap.keys] ].each do |t, names|
+                # @type var t: String
+                # @type var names: Array[String]
                 ref = c.id + t
                 names.each do |name|
                   (h[name] ||= []).push ref
@@ -371,24 +398,27 @@ $cm_comb_m += 1
     # includes class aliases, includes inherited methods
     def mname2crefs_wide(name)
       tbl = classnametable()
-      mname2crefs_0(name).map {|ref|
-        tbl[ref.chop].map {|c| c + ref[-1,1] }
+      (mname2crefs_0(name) || raise).map {|ref|
+        tbl[ref.chop].map {|c| c + ref[-1,1] } # steep:ignore
       }.flatten
     end
 
     def mname2crefs_0(name)
-      crefs = (@method_index ||= {})[name]
+      crefs = (@method_index ||= {})[name] # steep:ignore
       return crefs if crefs
       crefsstr = method_index_0()[name] or return nil
       @method_index[name] = crefsstr.split(nil)
     end
 
     def method_index_0
+      # @type self: MethodDatabase
       @method_index_0 ||=
           begin
-            h = {}
+            h = {} #: Hash[String, String]
             foreach_line('method/=index') do |line|
               name, cnames = line.split(nil, 2)
+              name || raise
+              cnames.is_a?(String) || raise
               h[name] = cnames
             end
             h
@@ -467,7 +497,7 @@ $cm_comb_m += 1
             begin
               spec = @specs.first
               c = @db.fetch_class(spec.klass)
-              MethodSpec.parse(c.match_entry(spec.type, spec.method))
+              MethodSpec.parse(c.match_entry(spec.type, spec.method) || raise)
             end
       end
 
@@ -476,7 +506,7 @@ $cm_comb_m += 1
       end
 
       def entry
-        @entry ||= @db.get_method(origin())
+        @entry ||= @db.get_method(origin()) || raise
       end
 
       def name
@@ -484,7 +514,8 @@ $cm_comb_m += 1
       end
 
       def names
-        @specs.map {|spec| spec.display_name }
+        version = @db && @db.properties["version"]
+        @specs.map {|spec| spec.display_name(version) }
       end
 
       def class_name
@@ -522,9 +553,9 @@ $cm_comb_m += 1
       def owned_method?
         @specs.any? {|spec| spec.klass == origin().klass }
       end
-      
+
       def method_of_alias_class?
-        @entry.klass.aliases.any?{|aliasclass| aliasclass.name?(class_name())}
+        entry.klass.aliases.any?{|aliasclass| aliasclass.name?(class_name())}
       end
 
       def inherited_method?

data/lib/bitclust/crossrubyutils.rb

@@ -14,7 +14,8 @@ module BitClust
     private
 
     def print_crossruby_table(&block)
-      print_table(*build_crossruby_table(&block))
+      vers, table = build_crossruby_table(&block)
+      print_table(vers, table)
     end
 
     def print_table(vers, table)
@@ -44,7 +45,7 @@ module BitClust
     end
 
     def get_ruby(version)
-      forall_ruby(ENV['PATH']) do |ruby, |
+      forall_ruby(ENV.fetch('PATH')) do |ruby, |
         v = `#{ruby} -e 'print RUBY_VERSION'`
         patch = `#{ruby} -e 'print RUBY_PATCHLEVEL if defined? RUBY_PATCHLEVEL'`
         if version == v or ( version == v.succ and patch == '5000')
@@ -58,9 +59,9 @@ module BitClust
       ENV.delete 'RUBYOPT'
       ENV.delete 'RUBYLIB'
       ENV.delete 'GEM_HOME'
-      vers = []
-      table = {}
-      forall_ruby(ENV['PATH']) do |ruby, ver|
+      vers = [] #: Array[String]
+      table = {} #: table_type
+      forall_ruby(ENV.fetch('PATH')) do |ruby, ver|
         puts "#{version_id(ver)}: #{ver}" if @verbose
         vers.push ver
         yield(ruby).each do |c|
@@ -71,11 +72,13 @@ module BitClust
     end
 
     def forall_ruby(path, &block)
+      # steep:ignore:start
       rubys(path)\
           .map {|ruby| [ruby, `#{ruby} --version`] }\
           .reject {|ruby, verstr| `which #{ruby}`.include?('@') }\
           .sort_by {|ruby, verstr| verstr }\
           .each(&block)
+      # steep:ignore:end
     end
 
     def rubys(path)

data/lib/bitclust/database.rb

@@ -28,9 +28,10 @@ module BitClust
     def Database.connect(uri)
       case uri.scheme
       when 'file'
-        new(uri.path)
+        new(uri.path || raise)
       when 'druby'
-        DRbObject.new_with_uri(uri.to_s)
+        require 'drb'
+        _ = DRbObject.new_with_uri(uri.to_s) #: ::BitClust::Database
       else
         raise InvalidScheme, "unknown database scheme: #{uri.scheme}"
       end
@@ -62,14 +63,32 @@ module BitClust
       yield
       return if dummy?
       if @properties_dirty
-        save_properties 'properties', @properties
+        save_properties 'properties', (@properties || raise)
         @properties_dirty = false
       end
-      commit if dirty?
+      if dirty?
+        commit
+        # 更新完了の合図として properties の mtime を進める(bitclust#275)。
+        # server の自動リロード(ReloadableRequestHandler)は properties の
+        # mtime で新鮮さを判定するため、init 直後〜update 完了前の途中状態を
+        # 読んでしまったプロセスも、ここで mtime が進むことで次のリクエスト
+        # から完成した DB を読み直して収束できる
+        touch_properties
+      end
     ensure
       @in_transaction = false
     end
 
+    # properties の内容は変えず mtime だけ現在時刻に進める。
+    # ファイルが無い場合(異常系)は何もしない
+    def touch_properties
+      path = realpath('properties')
+      now = Time.now
+      File.utime(now, now, path)
+    rescue Errno::ENOENT
+    end
+    private :touch_properties
+
     # abstract dirty?
     # abstract clear_dirty
     # abstract commit
@@ -100,12 +119,12 @@ module BitClust
     end
 
     def propget(key)
-      properties()[key]
+      properties()[key] # steep:ignore
     end
 
     def propset(key, value)
       check_transaction
-      properties()[key] = value
+      properties()[key] = value # steep:ignore
       @properties_dirty = true
     end
 
@@ -126,6 +145,7 @@ module BitClust
       Dir.entries(realpath(rel))\
           .reject {|ent| /\A[\.=]/ =~ ent }\
           .map {|ent| decodeid(ent) }
+          .sort
     rescue Errno::ENOENT
       return []
     end
@@ -135,12 +155,12 @@ module BitClust
     end
 
     def load_properties(rel)
-      h = {}
+      h = {} #: Hash[String, String]
       fopen(realpath(rel), 'r:UTF-8') {|f|
         while line = f.gets
           k, v = line.strip.split('=', 2)
           break unless k
-          h[k] = v
+          h[k] = v || raise
         end
         h['source'] = f.read
       }

data/lib/bitclust/doc_converter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'bitclust/rrd_to_markdown'
+
+module BitClust
+  # refm/doc（散文ページ）の Markdown 変換。
+  #
+  # doc ページにはクロスファイル情報（library 所属等）が無いため、
+  # オーケストレータは不要で、reduce（正規化）+ 単一ファイル変換のみ。
+  # タイトルは H1 が担い、front matter は使わない。
+  #
+  # reduce は意味を変えない表記ゆれを md→rd の再生成形に合わせる正規化と、
+  # クロスツリー include（api 断片の transclude）の manual レイアウトへの
+  # 書き換えを行う。md→rd 変換は reduce の結果を復元する（検証の期待値）。
+  module DocConverter
+    module_function
+
+    def reduce(rrd)
+      RRDToMarkdown.normalize_dlist_colon_spacing(rrd.lines.map { |line|
+        case line
+        when /\A\#@samplecode[ \t]+\n\z/
+          "\#@samplecode\n"                      # ラベル無しの末尾スペース
+        when %r{\A//\}[ \t]+\n\z}
+          "//}\n"
+        when /\A:\s{2,}(.*)/m
+          ": #{$1}"                              # 定義リスト term の余分なスペース
+        when /\A(={1,4}\[a:[^\]]+\])\s{2,}(.*)/m
+          "#{$1} #{$2}"                          # アンカー見出しの余分なスペース
+        when /\A\t+/
+          line.sub(/\A\t+/) { ' ' * ($& || raise).length }  # 行頭タブ（doc の散文1行のみ）
+        when /\A\#@include\((?:\.\.\/)+api\/src\//
+          # 旧レイアウト ../api/src/X → 新レイアウト ../api/X
+          # （manual/ 配下では src 階層が無い。ブリッジが逆変換する）
+          line.sub(%r{((?:\.\./)+)api/src/}, '\1api/')
+        else
+          line
+        end
+      }.join)
+    end
+
+    def convert(rrd)
+      RRDToMarkdown.convert(reduce(rrd))
+    end
+
+    # 変換対象ファイルの一覧（doc ルート相対）。
+    # 旧パイプライン（copy_doc）は **/*.rd だけをページとして読むため、
+    # .rd 以外は doc 内 include から参照される断片のみを対象にし、
+    # 参照されない死にファイル（news/1.8.0.rd-2 等）は凍結側に残す
+    def files(doc_root)
+      all = Dir.glob('**/*', base: doc_root)
+               .select { |f| File.file?(File.join(doc_root, f)) }.sort
+      pages = all.select { |f| f.end_with?('.rd') }
+      referenced = pages.flat_map { |f|
+        base = File.dirname(f)
+        File.read(File.join(doc_root, f))
+            .scan(/^\#@include\((?!(?:\.\.\/)+api\/)(.*?)\)/)
+            .map { |t| File.expand_path(base == '.' ? (t[0] || raise) : File.join(base, t[0] || raise), '/')
+                           .delete_prefix('/') }
+      }
+      (pages + (all & referenced)).sort
+    end
+  end
+end

data/lib/bitclust/docentry.rb

@@ -84,7 +84,7 @@ module BitClust
     end
 
     def description
-      source.split(/\n\n/, 2)[0].strip
+      description_text(source.split(/\n\n/, 2)[0].strip)
     end
   end
 end