bitclust-core 1.3.0 → 1.6.0

data/data/bitclust/template.offline/class

@@ -120,7 +120,11 @@
      [_('Instance Methods'),          ents.instance_methods           ],
      [_('Private Singleton Methods'), ents.private_singleton_methods  ],
      [_('Private Instance Methods'),  ents.private_instance_methods   ],
+     [_('Protected Instance Methods'),ents.protected_instance_methods ],
      [_('Module Functions'),          ents.module_functions           ],
+     [_('Added Methods'),             ents.added                      ],
+     [_('Redefined Methods'),         ents.redefined                  ],
+     [_('Undefined Methods for Explanation'), ents.nomethod           ],
      [_('Constants'),                 ents.constants                  ],
      [_('Special Variables'),         ents.special_variables          ,'$']] %>
 <%= headline(_("Index")) %>
@@ -146,17 +150,38 @@
 
 <%
 _myself, *ancestors = @entry.ancestors.reject { |c| %w[Object Kernel BasicObject].include?(c.name) }
-displayed_methods = Set.new(ents.instance_methods.flat_map(&:names))
+displayed_instance_methods = Set.new((ents.instance_methods + ents.redefined.select(&:instance_method?)).flat_map(&:names))
+displayed_singleton_methods = Set.new((ents.singleton_methods + ents.redefined.select(&:singleton_method?)).flat_map(&:names))
+undefined_methods = @entry.partitioned_entries.undefined
+undefined_instance_methods = undefined_methods.select(&:instance_method?)
+undefined_singleton_methods = undefined_methods.select(&:singleton_method?)
 %>
 
 <% unless ancestors.empty? %>
   <%= headline(_("Ancestor Methods")) %>
 <dl>
+  <%# Singleton methods are inherited only through the superclass chain, not from included modules. %>
+  <% ancestors.select(&:class?).each do |c|
+       methods = c.partitioned_entries(@alevel).singleton_methods
+         .flat_map { |m| m.names.map { |n| [n, m] } }
+         .reject { |name,| displayed_singleton_methods.include?(name) }
+         .reject { |name,| undefined_singleton_methods.any? { |m| m.names.include?(name) } }
+         .sort
+       next if methods.empty? %>
+<dt><%= _('Ancestor Singleton Methods %s', c.name) %></dt>
+<dd>
+  <ul class="class-toc">
+    <% methods.each do |name, m| %>
+      <li><%= method_link(m.spec_string, name) %></li>
+      <% displayed_singleton_methods << name %>
+    <% end %>
+  </ul>
+</dd>
+  <% end %>
   <% ancestors.each do |c|
-       undefined_instance_methods = @entry.partitioned_entries.undefined.select(&:instance_method?)
        methods = c.partitioned_entries(@alevel).instance_methods
          .flat_map { |m| m.names.map { |n| [n, m] } }
-         .reject { |name,| displayed_methods.include?(name) }
+         .reject { |name,| displayed_instance_methods.include?(name) }
          .reject { |name,| undefined_instance_methods.any? { |m| m.names.include?(name) } }
          .sort
        next if methods.empty? %>
@@ -165,7 +190,7 @@ displayed_methods = Set.new(ents.instance_methods.flat_map(&:names))
   <ul class="class-toc">
     <% methods.each do |name, m| %>
       <li><%= method_link(m.spec_string, name) %></li>
-      <% displayed_methods << name %>
+      <% displayed_instance_methods << name %>
     <% end %>
   </ul>
 </dd>
@@ -174,6 +199,25 @@ displayed_methods = Set.new(ents.instance_methods.flat_map(&:names))
 end %>
 </dl>
 
+<%
+    dyninc_groups = @entry.dynamically_included_entries.group_by(&:klass)
+%>
+<% unless dyninc_groups.empty? %>
+  <%= headline(_("Methods Added by Dynamic Include")) %>
+<dl>
+  <% dyninc_groups.each do |mod, mod_entries| %>
+<dt><%= mod.name %> (by <%= mod.library.name %>)</dt>
+<dd>
+  <ul class="class-toc">
+    <% mod_entries.each do |m| %>
+      <li><%= method_link(m.spec_string, m.name) %></li>
+    <% end %>
+  </ul>
+</dd>
+  <% end %>
+</dl>
+<% end %>
+
 <%
     items.each do |label, entries|
       unless entries.empty? %>

data/data/bitclust/template.offline/function

@@ -1,6 +1,6 @@
 <%
     entry = @entry
-    @title = "#{entry.type_label} #{entry.label}"
+    @title = "#{entry.type_label} #{entry.display_label}"
     @description = @entry.description
     @edit_url = edit_url(@entry.source_location) if @conf[:edit_base_url] && @entry.source_location
 %>
@@ -41,7 +41,7 @@
     </ol>
   </nav>
 <% headline_init %>
-<%= headline("#{entry.type_label} #{entry.label}", edit_url: @edit_url) %>
+<%= headline("#{entry.type_label} #{entry.display_label}", edit_url: @edit_url) %>
 </header>
 
 <main>

data/data/bitclust/template.offline/layout

@@ -7,6 +7,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <link rel="stylesheet" href="<%=h css_url() %>">
 <link rel="stylesheet" href="<%=h custom_css_url("syntax-highlight.css") %>">
+<link rel="stylesheet" href="<%=h custom_css_url("search.css") %>">
 <link rel="icon" type="image/png" href="<%=h favicon_url() %>">
 <% if @conf[:canonical_base_url] %>
 <link rel="canonical" href="<%= canonical_url() %>">
@@ -14,13 +15,36 @@
 <title><%=h @title %> (Ruby <%=h ruby_version %> リファレンスマニュアル)</title>
 <meta name="description" content="<%=h @description %>">
 <script src="<%=h custom_js_url('script.js') %>"></script>
+<script>var index_rel_prefix = "<%=h html_base() %>/";</script>
+<script src="<%=h custom_js_url('js/search_data.js') %>"></script>
+<script src="<%=h custom_js_url('js/search_navigation.js') %>"></script>
+<script src="<%=h custom_js_url('js/search_ranker.js') %>"></script>
+<script src="<%=h custom_js_url('js/search_controller.js') %>"></script>
+<script src="<%=h custom_js_url('js/search_init.js') %>"></script>
+<% if run_ruby_wasm_url %>
+<meta name="rurema-run-ruby-wasm" content="<%=h run_ruby_wasm_url %>">
+<script type="module" src="<%=h custom_js_url('js/run.js') %>"></script>
+<% end %>
 </head>
 <body>
+<% if eol_warning?() %>
+<p class="eol-warning">
+<%= _('This reference manual is for a version of Ruby that is no longer maintained.') %>
+<a href="https://docs.ruby-lang.org/ja/latest/"><%= _('Latest version') %></a>
+</p>
+<% end %>
+<div id="rurema-topbar">
+  <div id="rurema-brand"><%= manual_home_link %></div>
+  <div id="search-section" role="search">
+    <input id="search-field" type="text" autocomplete="off" spellcheck="false"
+           placeholder="クラス・メソッドを検索 (/)"
+           aria-label="検索" aria-autocomplete="list" aria-controls="search-results">
+    <ul id="search-results" class="search-results" aria-expanded="false"></ul>
+  </div>
+</div>
 <%= yield %>
 <footer id="footer">
-  <a rel="license" href="https://creativecommons.org/licenses/by/3.0/">
-    <img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/3.0/88x31.png" />
-  </a>
+  <a rel="license" href="https://creativecommons.org/licenses/by/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/3.0/88x31.png" /></a>
 
   <a href="https://github.com/rurema/doctree/issues/new" id="feedback-link">フィードバックを送る</a>
   <% if defined?(@edit_url) && @edit_url %>

data/data/bitclust/template.offline/method

@@ -1,6 +1,6 @@
 <%
     entry = @entries.sort.first
-    @title = entry.label
+    @title = entry.display_title_labels.join(', ')
     @description = entry.description
     @edit_url = edit_url(entry.source_location) if @conf[:edit_base_url] && entry.source_location
 %>
@@ -55,7 +55,7 @@
     </ol>
   </nav>
 <% headline_init %>
-<%= headline("#{entry.type_label} #{entry.label}") %>
+<%= headline("#{entry.type_label} #{entry.display_label}") %>
 </header>
 
 <main>

data/lib/bitclust/app.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 require 'bitclust'
 require 'bitclust/interface'
+require 'bitclust/reloadable_request_handler'
 
 module BitClust
 
   # Main class of BitClust server application.
-  # Actual actions are implemneted by RequestHandler.
+  # Actual actions are implemented by RequestHandler.
   #
   # Supports Rack and WEBrick.
   class App
@@ -26,11 +27,8 @@ module BitClust
       @interfaces = {}
       case dbpath
       when String
+        # @type var viewpath: String
         dbpath = File.expand_path(dbpath)
-        db = BitClust::MethodDatabase.new(dbpath)
-        if capi
-          db = [db, BitClust::FunctionDatabase.new(dbpath)]
-        end
         manager = BitClust::ScreenManager.new(
           :base_url => baseurl,
           :cgi_url => File.join(baseurl, viewpath),
@@ -39,25 +37,22 @@ module BitClust
           :theme => options[:theme],
           :encoding => encoding
           )
-        handler = request_handler_class.new(db, manager)
+        handler = BitClust::ReloadableRequestHandler.new(dbpath, capi, manager, request_handler_class)
         @interfaces[viewpath] = BitClust::Interface.new { handler }
       when Array
+        # @type var viewpath: String?
         dbpaths = dbpath
         @versions = []
         dbpaths.each do |dbpath|
           next unless /db-([\d_\.]+)/ =~ dbpath
           dbpath = File.expand_path(dbpath)
-          version = $1.tr("_", ".")
+          version = ($1 || raise).tr("_", ".")
           @versions << version
           if viewpath
             version_viewpath = File.join(version, viewpath)
           else
             version_viewpath = version
           end
-          db = BitClust::MethodDatabase.new(dbpath)
-          if capi
-            db = [db, BitClust::FunctionDatabase.new(dbpath)]
-          end
           manager = BitClust::ScreenManager.new(
             :base_url => baseurl,
             :cgi_url => File.join(baseurl, version_viewpath),
@@ -66,7 +61,7 @@ module BitClust
             :theme => options[:theme],
             :encoding => encoding
             )
-          handler = request_handler_class.new(db, manager)
+          handler = BitClust::ReloadableRequestHandler.new(dbpath, capi, manager, request_handler_class)
           @interfaces[version_viewpath] = BitClust::Interface.new { handler }
           $bitclust_context_cache = nil # clear cache
         end
@@ -88,13 +83,15 @@ module BitClust
                          req.path_info
                        end
         if @versions.any?{|version| %r|\A/?#{version}/?\z| =~ request_path }
-          viewpath = File.join(request_path, @options[:viewpath])
+          viewpath = @options[:viewpath]
+          raise unless viewpath.is_a?(String)
+          viewpath = File.join(request_path || raise, viewpath)
           @index = "<html><head><meta http-equiv='Refresh' content='0;URL=#{viewpath}'></head></html>"
         else
           links = "<ul>"
           @interfaces.keys.sort.each do |v|
-            if @options[:viewpath]
-              version = v.sub(@options[:viewpath], '')
+            if (viewpath = @options[:viewpath]).is_a?(String)
+              version = v.sub(viewpath, '')
             else
               version = v
             end
@@ -108,15 +105,17 @@ module BitClust
             @index = "<html><head><title>bitclust</title></head><body>#{links}</body></html>"
           end
         end
+      else
+        raise '[BUG]'
       end
     end
 
-    def get_instance(server)
+    def get_instance(_server, *_)
       self
     end
 
     def service(req, res)
-      unless  %r|/#{File.basename(@options[:baseurl])}/?\z| =~ req.path
+      unless  %r|/#{File.basename(@options[:baseurl] || raise)}/?\z| =~ req.path
         raise WEBrick::HTTPStatus::NotFound
       end
       res.body = index(req)

data/lib/bitclust/capi_converter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bitclust/rrd_to_markdown'
+
+module BitClust
+  # refm/capi（C API リファレンス）の Markdown 変換。
+  #
+  # capi の構造は「--- シグネチャ + 本文」の列のみで、見出し・include・
+  # ライブラリ等のクロスファイル情報が無い（FunctionReferenceParser 参照）。
+  # front matter は使わず、シグネチャは capi モードの変換
+  # 「--- <C sig>」↔「### <C sig>」（def 等のキーワード無し。C の
+  # シグネチャは型から始まるため自己記述的）で表す。本文の記法は api と共通。
+  module CapiConverter
+    module_function
+
+    def convert(rrd)
+      RRDToMarkdown.convert(rrd, capi: true)
+    end
+  end
+end

data/lib/bitclust/classentry.rb

@@ -79,7 +79,7 @@ module BitClust
     end
 
     persistent_properties {
-      property :type,       'Symbol'         # :class | :module | :object
+      property :type,       'Symbol'         ## :class | :module | :object
       property :superclass, 'ClassEntry'
       property :included,   '[ClassEntry]'
       property :extended,   '[ClassEntry]'
@@ -217,8 +217,10 @@ module BitClust
           [ myself, included().map {|m| m.ancestors },
             ancestors ].flatten
         else
+          # steep:ignore:start
           [ self, included().map {|m| m.ancestors },
             superclass() ? superclass().ancestors : [] ].flatten
+          # steep:ignore:end
         end
     end
 
@@ -228,6 +230,24 @@ module BitClust
       list
     end
 
+    # Public instance methods contributed by modules that are dynamically
+    # included into this class (via `# reopen` + `include:`/`include`).
+    #
+    # Unlike +included+, +dynamically_included+ does not affect +ancestors+
+    # or the method resolution order, so these methods are never returned by
+    # +entries+/+partitioned_entries+. This method exists so that screens and
+    # templates can list them separately, attributed to the module (and its
+    # library) that defines them, without disturbing the MRO.
+    #
+    # Only each module's own public instance methods are returned (i.e. its
+    # +entries(0)+ filtered like +public_instance_methods+); methods that the
+    # dynamically included module itself inherits are not followed. If no
+    # module has been dynamically included, this returns an empty array, so
+    # output for classes without dynamic include is unaffected.
+    def dynamically_included_entries
+      dynamically_included().flat_map {|m| m.public_instance_methods(0) }
+    end
+
     def extended_modules
       ancestors().select(&:class?).map(&:extended).flatten
     end
@@ -235,8 +255,8 @@ module BitClust
     def entries(level = 0)
       @entries ||= @db.entries("method/#{@id}")\
           .map {|ent| MethodEntry.new(@db, "#{@id}/#{ent}") }
-      ret = @entries
-      ancestors[1..level].each{|c| ret += c.entries }
+      ret = @entries || raise
+      (ancestors[1..level] || raise).each{|c| ret += c.entries }
       ret
     end
 
@@ -252,26 +272,43 @@ module BitClust
     end
 
     Parts = Struct.new(:singleton_methods, :private_singleton_methods,
-                       :instance_methods,  :private_instance_methods,
+                       :instance_methods,  :private_instance_methods, :protected_instance_methods,
                        :module_functions,
                        :constants, :special_variables,
-                       :added, :undefined)
+                       :redefined,
+                       :added, :undefined, :nomethod)
 
     def partitioned_entries(level = 0)
+      # @type var s: Array[MethodEntry]
+      # @type var spv: Array[MethodEntry]
+      # @type var i: Array[MethodEntry]
+      # @type var ipv: Array[MethodEntry]
+      # @type var ipt: Array[MethodEntry]
+      # @type var mf: Array[MethodEntry]
+      # @type var c: Array[MethodEntry]
+      # @type var v: Array[MethodEntry]
+      # @type var redefined: Array[MethodEntry]
+      # @type var added: Array[MethodEntry]
+      # @type var undefined: Array[MethodEntry]
+      # @type var nomethod: Array[MethodEntry]
       s = []; spv = []
-      i = []; ipv = []
+      i = []; ipv = []; ipt = []
       mf = []
       c = []; v = []
+      redefined = []
       added = []
       undefined = []
+      nomethod = []
       entries(level).sort_by(&:name).each do |m|
         case m.kind
-        when :defined, :redefined
+        when :defined
           case m.type
           when :singleton_method
             (m.public? ? s : spv).push m
           when :instance_method
-            (m.public? ? i : ipv).push m
+            tmp = m.public? ? i : ipv
+            tmp = ipt if m.protected?
+            tmp.push m
           when :module_function
             mf.push m
           when :constant
@@ -281,13 +318,19 @@ module BitClust
           else
             raise "must not happen: m.type=#{m.type.inspect} (#{m.inspect})"
           end
+        when :redefined
+          redefined.push m
         when :added
           added.push m
         when :undefined
           undefined.push m
+        when :nomethod
+          nomethod.push m
         end
       end
-      Parts.new(s,spv, i,ipv, mf, c, v, added, undefined)
+      # steep:ignore:start
+      Parts.new(s,spv, i,ipv,ipt, mf, c, v, redefined, added, undefined, nomethod)
+      # steep:ignore:end
     end
 
     def singleton_methods(level = 0)
@@ -322,6 +365,10 @@ module BitClust
 
     alias private_methods   private_instance_methods
 
+    def protected_instance_methods(level = 0)
+      entries(level).select(&:protected_instance_method?).sort_by(&:sort_key)
+    end
+
     def constants(level = 0)
       entries(level).select(&:constant?).sort_by(&:sort_key)
     end
@@ -334,7 +381,7 @@ module BitClust
       if inherit
         _smap().key?(name)
       else
-        singleton_methods(false).detect {|m| m.name?(name) }
+        singleton_methods(0).detect {|m| m.name?(name) }
       end
     end
 
@@ -342,7 +389,7 @@ module BitClust
       if inherit
         _imap().key?(name)
       else
-        instance_methods(false).detect {|m| m.name?(name) }
+        instance_methods(0).detect {|m| m.name?(name) }
       end
     end
 
@@ -350,7 +397,7 @@ module BitClust
       if inherit
         ancestors().any? {|c| c.constant?(name, false) }
       else
-        constants(false).detect {|m| m.name?(name) }
+        constants(0).detect {|m| m.name?(name) }
       end
     end
 
@@ -383,15 +430,15 @@ module BitClust
 
     def singleton_method_names
       # should remove module functions?
-      _index().keys.select {|name| /\A\./ =~ name }.map {|name| name[1..-1] }
+      _index().keys.select {|name| /\A\./ =~ name }.filter_map {|name| name[1..-1] }
     end
 
     def instance_method_names
-      _index().keys.select {|name| /\A\#/ =~ name }.map {|name| name[1..-1] }
+      _index().keys.select {|name| /\A\#/ =~ name }.filter_map {|name| name[1..-1] }
     end
 
     def constant_names
-      _index().keys.select {|name| /\A\:/ =~ name }.map {|name| name[1..-1] }
+      _index().keys.select {|name| /\A\:/ =~ name }.filter_map {|name| name[1..-1] }
     end
 
     def special_variable_names
@@ -405,7 +452,7 @@ module BitClust
     end
 
     def description
-      source.split(/\n\n+/, 2)[0].strip
+      description_text(source.split(/\n\n+/, 2)[0].strip)
     end
 
     def clear_cache
@@ -434,11 +481,12 @@ module BitClust
         return aliasof().__send__("_#{typechar}map").dup
       end
       s = superclass()
+      # @type var map: Hash[String, String]
       map = s ? s.__send__("_#{typechar}map").dup : {}
       inherited_modules.each do |mod|
         map.update mod.__send__("_#{typechar == 'c' ? 'c' : 'i'}map")
       end
-      defined, undefined = *ents.partition {|m| m.defined? }
+      defined, undefined = ents.partition {|m| m.defined? }
       (undefined + defined).each do |m|
         m.names.each do |name|
           map[name] = m.spec_string
@@ -465,9 +513,11 @@ module BitClust
     def _index
       @_index ||=
           begin
+            # @type var h: Hash[String, String]
             h = {}
             @db.foreach_line("method/#{@id}/=index") do |line|
               name, spec = line.split
+              name || raise; spec || raise
               h[name] = spec
             end
             h

data/lib/bitclust/compat.rb

@@ -38,7 +38,7 @@ end
 def fopen(*args, &block)
   option = args[1]
   if option and !Object.const_defined?(:Encoding)
-    args[1] = option.sub(/:.*\z/, '')
+    args[1] = option.sub(/:.*\z/, '') # steep:ignore
   end
-  File.open(*args, &block)
+  File.open(*args, &block) # steep:ignore
 end