bitclust-core 1.2.6 → 1.6.0

data/lib/bitclust/reloadable_request_handler.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+#
+# bitclust/reloadable_request_handler.rb
+#
+
+require 'bitclust/methoddatabase'
+require 'bitclust/functiondatabase'
+require 'bitclust/requesthandler'
+
+module BitClust
+
+  # `bitclust server` を再起動しなくても `rake generate` で再生成された DB を
+  # 読み直せるようにするラッパー(bitclust#275)。
+  #
+  # MethodDatabase/FunctionDatabase はエントリを一度読むとメモリ上にメモ化
+  # し続けるため、App#initialize で一度だけ生成した RequestHandler をずっと
+  # 使い回す従来の作りでは、DB をディスク上で再生成してもプロセスは古い内容
+  # を返し続けてしまう。
+  #
+  # 新鮮さの判定は DB ディレクトリ直下の "properties" ファイルの mtime で行う。
+  # `rake generate` は対象を rm_rf してから MethodDatabase#init(properties を
+  # touch) → update という手順を踏むため、再生成のたびに properties は必ず
+  # 書き直される。#handle は毎リクエストその mtime を stat するだけなので
+  # コストは無視できる。
+  #
+  # 再生成の途中(rm_rf 直後〜init 前)は properties が一時的に存在しない。
+  # その間は新鮮さを判定できないので、古い RequestHandler をそのまま使い
+  # 続けてリクエストを失敗させない。次のリクエストで改めて判定する。
+  class ReloadableRequestHandler
+
+    def initialize(dbpath, capi, manager, request_handler_class)
+      @dbpath = dbpath
+      @capi = capi
+      @manager = manager
+      @request_handler_class = request_handler_class
+      @properties_mtime = properties_mtime
+      @handler = build_handler
+    end
+
+    def handle(req)
+      reload_if_stale
+      @handler.handle(req)
+    end
+
+    private
+
+    def reload_if_stale
+      mtime = properties_mtime
+      return unless mtime # 再生成中で properties が一時的に無い: 判定を諦めて継続
+      return if @properties_mtime == mtime
+
+      @properties_mtime = mtime
+      @handler = build_handler
+      $bitclust_context_cache = nil # clear cache
+    end
+
+    def properties_mtime
+      File.mtime("#{@dbpath}/properties")
+    rescue Errno::ENOENT
+      nil
+    end
+
+    def build_handler
+      db = BitClust::MethodDatabase.new(@dbpath)
+      if @capi
+        db = [db, BitClust::FunctionDatabase.new(@dbpath)] #: [MethodDatabase, FunctionDatabase]
+      end
+      @request_handler_class.new(db, @manager)
+    end
+
+  end
+end

data/lib/bitclust/requesthandler.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # bitclust/requesthandler.rb
 #
@@ -58,22 +59,25 @@ module BitClust
     end
 
     def handle_library(req)
-      return library_index() unless req.library_name
-      lib = @db.fetch_library(req.library_name)
+      library_name = req.library_name
+      return library_index() unless library_name
+      lib = @db.fetch_library(library_name)
       @screenmanager.library_screen(lib, @conf).response
     end
 
     def handle_class(req)
-      return class_index() unless req.class_name
-      c =  @db.fetch_class(req.class_name)
-      h = @conf.dup
+      class_name = req.class_name
+      return class_index() unless class_name
+      c =  @db.fetch_class(class_name)
+      h = @conf.dup #: RequestHandler::conf_class
       h[:level] = req.ancestors_level
       @screenmanager.class_screen(c, h).response
     end
 
     def handle_method(req)
-      ms = @db.fetch_methods(req.method_spec)
-      raise MethodNotFound.new(req.method_spec.to_s) if ms.nil? || ms.empty?
+      method_spec = req.method_spec or raise RequestError, 'method request but method_spec is nil'
+      ms = @db.fetch_methods(method_spec)
+      raise MethodNotFound.new(method_spec.to_s) if ms.nil? || ms.empty?
       @screenmanager.method_screen(ms, @conf).response
     end
 
@@ -90,13 +94,12 @@ module BitClust
     end
 
     def handle_search(req)
-      ret = []
-      q0 = req.query['q'] || ''
-      q = URI.unescape(q0)
+      q0 = req.query['q'].to_s
+      q = URI.decode_www_form_component(q0)
       start = Time.now.to_i
       ret = SimpleSearcher.search_pattern(@db, q)
       elapsed_time = Time.now.to_f - start.to_f
-      c = @conf.dup
+      c = @conf.dup #: RequestHandler::conf_search
       c[:q] = q0
       c[:elapsed_time] = elapsed_time
       @screenmanager.search_screen(ret, c).response
@@ -106,10 +109,11 @@ module BitClust
       d = @db.fetch_doc(req.doc_name || 'index' )
       @screenmanager.doc_screen(d, @conf).response
     end
-    
+
     def handle_function(req)
-      return function_index() unless req.function_name
-      f = @cdb.fetch_function(req.function_name)
+      function_name = req.function_name
+      return function_index() unless function_name
+      f = @cdb.fetch_function(function_name)
       @screenmanager.function_screen(f, @conf).response
     end
 
@@ -150,7 +154,7 @@ module BitClust
     end
 
     def doc_name
-      name = path_info.sub(%r!\A/!, '')
+      name = (path_info || raise).sub(%r!\A/!, '')
       name unless name.empty?
     end
 
@@ -187,6 +191,7 @@ module BitClust
       unless typechar?(typechar)
         raise InvalidKey, "invalid method-type ID: #{typechar.inspect}"
       end
+      # @type var typechar: NameUtils::typechar
       cname = classid2name(cid)
       tmark = typechar2mark(typechar)
       mname = decodename_url(mencoded)
@@ -308,7 +313,8 @@ module BitClust
     end
 
     def update(webrick_res)
-      webrick_res.status = @screen.status if @screen.status
+      status = @screen.status
+      webrick_res.status = status if status
       webrick_res['Content-Type'] = @screen.content_type
       # webrick_res['Last-Modified'] = @screen.last_modified
       body = @screen.body

data/lib/bitclust/ridatabase.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rdoc/ri/ri_reader'
 require 'rdoc/ri/ri_cache'
 require 'rdoc/ri/ri_paths'
@@ -168,7 +169,7 @@ module RI
       name = full_name()
       unless /\#/ =~ name
         components = name.split('::')
-        m = components.pop
+        m = components.pop || raise
         components.join('::') + '.' + m
       else
         name
@@ -236,7 +237,7 @@ class Formatter
       line "--- #{m.full_name}#{trim_space(m.params)}"
     else
       m.params.lines.each do |sig|
-        line "--- #{trim_sig(sig)}\#@todo\n"
+        line "--- #{trim_sig(sig)}#%todo\n"
       end
     end
     unless m.aliases.empty?
@@ -258,15 +259,17 @@ class Formatter
     s = trim_space(s)
     s.sub!(/\A[a-z]\w+\./, '')
     s.sub!(/=>/, '->')
+    # steep:ignore:start
     s.sub!(/(->.*)\bstr(ing)?\b/){ $1 + 'String' }
     s.sub!(/(->.*)\bint(eger)?\b/){ $1 + 'Integer' }
     s.sub!(/(->.*)\b(an_)?obj\b/){ $1 + 'object' }
     s.sub!(/(->.*)\b(a_)?hash\b/){ $1 + 'Hash' }
     s.sub!(/(->.*)\b(an_)?array\b/){ $1 + 'Array' }
-    s.sub!(/ or /, ' | ')    
+    # steep:ignore:end
+    s.sub!(/ or /, ' | ')
     s
   end
-  
+
   def format_elements(elems)
     return "" unless elems
     return "" if elems.empty?
@@ -274,6 +277,7 @@ class Formatter
   end
 
   def format_element(e)
+    # steep:ignore:start
     case e
     when SM::Flow::P, SM::Flow::LI
       paragraph(e)
@@ -288,6 +292,7 @@ class Formatter
     else
       raise "unkwnown markup: #{e.class}"
     end
+    # steep:ignore:end
   end
 
   def headline(e)
@@ -305,6 +310,7 @@ class Formatter
   end
 
   def list(e)
+    # steep:ignore:start
     case e.type
     when SM::ListBase::BULLET
       e.contents.map {|item| "* #{format_element(e)}" }.join("\n")
@@ -328,6 +334,7 @@ class Formatter
     else
       raise "unknown list type: #{e.type.inspect}"
     end
+    # steep:ignore:end
   end
 
   def remove_inline(str)