bitclust-core 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31e60901f080112247e8bb929f914fdb65133ab75299a7a2c131439b51834a8b
-  data.tar.gz: 06cc3117a5652403207d78d42c40ee90e392a609887ffd0c2bc0dd5b77042ff9
+  metadata.gz: ea74921a9df5a9e7009ee4d7b4219ab4bf9f28fa369c1e8fd558a4ee5b661fdf
+  data.tar.gz: 35847d933f8ca3a73a60c2333f084555b301d46d790187020f79830749a60b60
 SHA512:
-  metadata.gz: f1d6c5f6848e7aabc1f6c953f81eebca321985ca76db32af3dd8d054d3d4ae801a7741d2060bc70e9756354ea2cf94d9cd2fbea938aa9b00c631816da623b837
-  data.tar.gz: 60c1147eb9a1b64084518fd16244ac2561236c3d3a61f5de23c437744a6955af7b3c36d83e01092f7c4700a9adce238925154653af7d2795199b0b7cc1093303
+  metadata.gz: 0ebd81dbaf1ccb47c60b46297cae6067a6708e3eb686f47b8d7890b49149f2018ce977cf762e30f5b7dda6c70b793edb5bf688c755c36b25b626e4f2b6b16cf8
+  data.tar.gz: 2fbfddeb46e668c1a3c3e2bcf9b36f844cde0b6c4056c7e38a79863d7a6ee378db7b78093b47031910eb948e6fb2c13f29141cd053366e500a88b6b0f8337ace

data/Gemfile

@@ -1,6 +1,9 @@
 source "https://rubygems.org"
 
 gem "rake"
+gem "steep", "~> 1.9.0", require: false
+
+gem "uri"
 
 # Specify your gem's dependencies in bitclust.gemspec
 gemspec :name => "bitclust-core"

data/README.md

@@ -0,0 +1,65 @@
+# BitClust
+
+BitClust は Ruby リファレンスマニュアル(通称「るりま」)のドキュメント処理
+フレームワークです。ドキュメントソース([rurema/doctree](https://github.com/rurema/doctree))を
+パースしてデータベース化し、HTML(静的サイト・HTTP サーバ)、CHM、EPUB などに
+変換します。生成されたマニュアルは https://docs.ruby-lang.org/ja/ で公開されています。
+
+## ドキュメント
+
+- [doc/usage.md](doc/usage.md) — インストール方法と各サブコマンドの使い方
+- [doctree の docs/](https://github.com/rurema/doctree/tree/master/docs) — るりまプロジェクト全体の文書
+  (ドキュメントの書き方・ビルド方法・チュートリアルなど)
+
+## 開発を始める
+
+```console
+$ git clone https://github.com/rurema/bitclust.git
+$ cd bitclust
+$ bundle install
+```
+
+### テスト
+
+```console
+$ bundle exec rake test        # 全テスト(デフォルトタスク)
+$ ruby test/test_rdcompiler.rb # 単一のテストファイル
+```
+
+### 型定義
+
+RBS 型定義が `sig/` にあります。
+
+```console
+$ bundle exec rake sig     # 型定義の再生成
+$ bundle exec steep check  # 型検査
+```
+
+### doctree と組み合わせて動作確認する
+
+ドキュメント本体のビルドは doctree 側の Rake タスクから行います。
+doctree の `Gemfile` は環境変数 `BITCLUST_PATH` でローカルの bitclust を
+参照できるので、手元の変更を反映したマニュアルを生成して確認できます。
+
+```console
+$ git clone https://github.com/rurema/doctree.git
+$ cd doctree
+$ bundle install                     # ../bitclust があればそれを使う
+$ bundle exec rake generate:3.4      # データベース生成
+$ bundle exec rake statichtml:3.4    # 静的 HTML 生成
+```
+
+詳細は [doctree の docs/](https://github.com/rurema/doctree/tree/master/docs) を
+参照してください。
+
+## 用語集
+
+- **entry** — ドキュメント化の対象。クラス: `Entry` `LibraryEntry` `ClassEntry` `MethodEntry` `DocEntry` `FunctionEntry`
+- **screen** — ビュークラス。BitClust server、`statichtml`、`chm` サブコマンドなどが使う
+- **singleton object** — `ARGF` や `main` など
+- **BitClust server** — ブラウザでリファレンスを見るための HTTP サーバ(`bitclust server`)
+- **Refe server** — `refe --server` で起動する DRb サーバ。BitClust DB を DRuby で公開する
+
+## ライセンス
+
+Ruby License

data/Rakefile

@@ -15,6 +15,38 @@ task :test do
   sh 'ruby test/run_test.rb'
 end
 
+desc "run JS tests (requires qjs / QuickJS)"
+namespace :test do
+  task :js do
+    sh 'qjs', 'test/js/test_run.mjs'
+    sh 'qjs', 'test/js/test_script.mjs'
+    sh 'qjs', 'test/js/test_search.mjs'
+  end
+end
+
+desc "Re-generate sig/prototype"
+task :sig do
+  out_dir = 'sig-prototype'
+  FileUtils.rm_rf out_dir
+  sh "rbs prototype rb --out-dir=#{out_dir} lib"
+  FileUtils.rm "#{out_dir}/bitclust/compat.rbs"
+  sh "rbs subtract --write #{out_dir} sig"
+  FileUtils.rmdir ["#{out_dir}/bitclust/generators", "#{out_dir}/bitclust/subcommands", "#{out_dir}/bitclust", "#{out_dir}"]
+  sh 'rbs validate'
+end
+
+namespace :rbs do
+  desc 'rbs collection install'
+  task :install do
+    sh 'rbs collection install'
+  end
+
+  desc 'rbs collection update'
+  task :update do
+    sh 'rbs collection update'
+  end
+end
+
 Bundler::GemHelper.install_tasks(:name => "bitclust-core")
 Bundler::GemHelper.install_tasks(:name => "bitclust-dev")
 Bundler::GemHelper.install_tasks(:name => "refe2")

data/data/bitclust/catalog/ja_JP.UTF-8

@@ -14,6 +14,8 @@ Ancestor Methods
 継承しているメソッド
 Ancestor Methods %s
 %sから継承しているメソッド
+Ancestor Singleton Methods %s
+%sから継承している特異メソッド
 Builtin
 組み込み
 Builtin Library
@@ -62,10 +64,14 @@ Library
 ライブラリ
 Library Index
 ライブラリ一覧
+Latest version
+最新版のマニュアルへ
 Math
 数学
 Method
 メソッド
+Methods Added by Dynamic Include
+動的includeで追加されるメソッド
 Modules
 モジュール
 Module Functions
@@ -78,6 +84,10 @@ Objects
 オブジェクト
 Private Instance Methods
 privateメソッド
+Protected Instance Methods
+protectedメソッド
+Redefined Methods
+再定義されたメソッド
 Private Singleton Methods
 private特異メソッド
 Required Libraries
@@ -102,8 +112,12 @@ Text
 テキスト
 Thread
 スレッド
+This reference manual is for a version of Ruby that is no longer maintained.
+このマニュアルは既にメンテナンスが終了したバージョンの Ruby を対象としています。
+Undefined Methods for Explanation
+説明のための未定義メソッド
 ancestors
-クラスの継承リスト
+クラス・モジュールの継承リスト
 class %s
 %sクラス
 library %s
@@ -112,3 +126,7 @@ module %s
 %sモジュール
 object %s
 %sオブジェクト
+since Ruby %s
+Ruby %s から
+removed in Ruby %s
+Ruby %s で削除

data/data/bitclust/searchpage/index.html

@@ -0,0 +1,90 @@
+<!DOCTYPE html>
+<html lang="ja">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title>Ruby リファレンスマニュアル検索</title>
+<link rel="stylesheet" href="search.css">
+<style>
+/* 検索ボックス用の search.css を全画面ページ向けに上書きする */
+body {
+  margin: 0;
+  font-family: sans-serif;
+  color: #222;
+  background: #fff;
+}
+a { color: #33a; }
+#searchpage-main {
+  max-width: 46em;
+  margin: 0 auto;
+  padding: 1.5em 1em 3em;
+}
+#searchpage-main h1 {
+  font-size: 1.3em;
+  border-bottom: 2px solid #33a;
+  padding-bottom: 0.3em;
+}
+#searchpage-main h1 a {
+  color: inherit;
+  text-decoration: none;
+}
+#search-section {
+  position: static;
+  width: auto;
+  max-width: none;
+  margin: 1em 0 0.5em;
+}
+#search-field {
+  font-size: 1.1em;
+}
+.search-results {
+  position: static;
+  border: none;
+  box-shadow: none;
+  max-height: none;
+  overflow: visible;
+}
+.search-versions {
+  margin: 0.15em 0 0;
+  font-size: 0.8em;
+  color: #555;
+}
+.search-versions a {
+  display: inline-block;
+  margin-right: 0.35em;
+  padding: 0 0.4em;
+  border: 1px solid #99a;
+  border-radius: 3px;
+  text-decoration: none;
+}
+.searchpage-note {
+  font-size: 0.85em;
+  color: #555;
+}
+</style>
+<script>
+var search_versions = %%SEARCH_VERSIONS%%;
+var search_version_base = "../";
+</script>
+<script src="js/search_data.js"></script>
+<script src="js/search_navigation.js"></script>
+<script src="js/search_ranker.js"></script>
+<script src="js/search_controller.js"></script>
+<script src="js/search_page.js"></script>
+</head>
+<body>
+<main id="searchpage-main">
+<h1><a href="../">Ruby リファレンスマニュアル</a> 検索</h1>
+<div id="search-section" role="search">
+  <input id="search-field" type="text" autocomplete="off" spellcheck="false"
+         placeholder="クラス / メソッド / ライブラリ名で検索 (例: Array#each, String, socket)"
+         aria-label="リファレンス検索">
+  <ul id="search-results" class="search-results" aria-expanded="false"></ul>
+</div>
+<div class="searchpage-note">
+  <p>クラス・モジュール・メソッド・ライブラリ・特殊変数・ドキュメントの<strong>名前</strong>を全バージョン横断で検索します。検索結果のバージョンリンクから各バージョンのページを開けます。</p>
+  <p>本文の全文検索が必要な場合は、検索エンジンで <code>site:docs.ruby-lang.org/ja/ キーワード</code> を利用してください。</p>
+</div>
+</main>
+</body>
+</html>

data/data/bitclust/template/class

@@ -60,7 +60,9 @@
      [_('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           ],
+     [_('Undefined Methods for Explanation'), ents.nomethod           ],
      [_('Constants'),                 ents.constants                  ],
      [_('Special Variables'),         ents.special_variables          ]]\
     .each do |label, entries|
@@ -77,9 +79,7 @@
           foreach_method_chunk(m.source) do |sigs, src| %>
 <tr>
 <td class="signature">
-  <a href="<%=h method_url(m.spec_string) %>"><code>
-  <%= sigs.map {|sig| h(sig.friendly_string) }.join("<br>") %>
-  </code></a>
+  <%= method_row_signature_html(m, sigs) %>
 </td>
 <%          if m.redefined? %>
 <td class="description"><%= compile_rd(src) %></td>
@@ -107,11 +107,44 @@
 <%= headline(_('Inherited Methods')) %>
 <p><code>
 <%    specs.each do |s| %>
-<%=     method_link(s.to_s, (s.type == '#' ? s.method : s.type + s.method)) %>
+<%=     method_link(s.to_s, (s.type == '#' ? s.method : display_typemark(s.type, @target_version) + s.method)) %>
 <%    end %>
 </code></p>
 <%  end %>
 
+<%
+    [[_('Redefined Methods'),      ents.redefined]]\
+    .each do |label, entries|
+      unless entries.empty?  %>
+<%=     headline(label) %>
+<table class="entries methods">
+<tr>
+  <th><%= _('Signature') %></th>
+  <th><%= _('Description') %></th>
+  <th><%= _('Library') %></th>
+</tr>
+<%
+        headline_push
+        entries.each do |m|
+          foreach_method_chunk(m.source) do |sigs, src| %>
+<tr>
+<td class="signature">
+  <%= method_row_signature_html(m, sigs) %>
+</td>
+<td class="description"><%= compile_rd(src) %></td>
+<td class="library"><%= library_link(m.library.name) %></td>
+</tr>
+<%
+          end
+        end
+        headline_pop
+%>
+</table>
+<%
+      end
+    end
+%>
+
 <%
     [[_('Added Methods'),          ents.added]]\
     .each do |label, entries|
@@ -129,9 +162,7 @@
           foreach_method_chunk(m.source) do |sigs, src| %>
 <tr>
 <td class="signature">
-  <a href="<%=h method_url(m.spec_string) %>"><code>
-  <%= sigs.map {|sig| h(sig.friendly_string) }.join("<br>") %>
-  </code></a>
+  <%= method_row_signature_html(m, sigs) %>
 </td>
 <td class="description"><%= compile_rd(src) %></td>
 <td class="library"><%= library_link(m.library.name) %></td>
@@ -145,6 +176,36 @@
 <%
       end
     end
-    headline_pop
 %>
 
+<%
+    dyninc_entries = @entry.dynamically_included_entries
+    unless dyninc_entries.empty?  %>
+<%=   headline(_('Methods Added by Dynamic Include')) %>
+<table class="entries methods">
+<tr>
+  <th><%= _('Signature') %></th>
+  <th><%= _('Description') %></th>
+  <th><%= _('Module') %></th>
+</tr>
+<%
+      headline_push
+      dyninc_entries.each do |m|
+        foreach_method_chunk(m.source) do |sigs, src| %>
+<tr>
+<td class="signature">
+  <%= method_row_signature_html(m, sigs) %>
+</td>
+<td class="description"><%= compile_rd(src) %></td>
+<td class="library"><%= class_link(m.klass.name) + " (by " + library_link(m.library.name) + ")" %></td>
+</tr>
+<%
+        end
+      end
+      headline_pop
+%>
+</table>
+<%
+    end
+    headline_pop
+%>

data/data/bitclust/template/function

@@ -1,5 +1,5 @@
 <%
-   @title = "#{@entry.type_label} #{@entry.label}"
+   @title = "#{@entry.type_label} #{@entry.display_label}"
    @description = @entry.description
 %>
 <p>
@@ -11,7 +11,7 @@
 <%= search_form() %>
 
 <% headline_init %>
-<%= headline("#{@entry.type_label} #{@entry.label}") %>
+<%= headline("#{@entry.type_label} #{@entry.display_label}") %>
 <dl class="functionlist">
 <dt>
   <code><%=h @entry.header %></code>

data/data/bitclust/template/layout

@@ -11,13 +11,21 @@
   <title><%=h @title %> (Ruby <%=h ruby_version %>)</title>
   <meta name="description" content="<%=h @description %>">
   <link rel="search" type="application/opensearchdescription+xml" title="<%= _('Ruby %s Reference Manual', ruby_version()) %>" href="<%=h opensearchdescription_url() %>">
+<% 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 %>
 <%= yield %>
 <div 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>
 </div>
 </body>
 </html>

data/data/bitclust/template/method

@@ -1,6 +1,6 @@
 <%
     entry = @entries.sort.first
-    @title = "#{entry.type_label} #{entry.label}"
+    @title = "#{entry.type_label} #{entry.display_title_labels.join(', ')}"
     @description = entry.description
 %>
 <p>
@@ -15,7 +15,7 @@
 
 
 <% headline_init %>
-<%= headline("#{entry.type_label} #{entry.label}") %>
+<%= headline("#{entry.type_label} #{entry.display_label}") %>
 <% headline_push %>
 <dl class="methodlist">
 <% @entries.sort.each do |ent| %>

data/data/bitclust/template/search

@@ -39,7 +39,7 @@
               else
                 sigs.map {|sig|
                   method_link(e.spec_string,
-                              e.klass.name + e.typemark + sig.to_s)
+                              e.klass.name + e.display_typemark + sig.to_s)
                 }
               end.join("<br>\n") %></td>
 <td class="description"><%= compile_rd(src) %></td>

data/data/bitclust/template.epub/class

@@ -57,7 +57,10 @@
      [_('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                  ],
      [_('Constants'),                 ents.constants                  ],
      [_('Special Variables'),         ents.special_variables          ,'$']] %>
 <%= headline(_("Index")) %>
@@ -96,6 +99,24 @@
 <%
       end
     end
-    headline_pop
 %>
 
+<%
+    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>
+<%      mod_entries.each do |m| %>
+<li><%= method_link(m.spec_string, m.name) %></li>
+<%      end %>
+</ul>
+</dd>
+<%    end %>
+</dl>
+<%  end
+    headline_pop
+%>

data/data/bitclust/template.epub/function

@@ -1,6 +1,6 @@
 <%
     entry = @entry
-    @title = "#{entry.type_label} #{entry.label}"
+    @title = "#{entry.type_label} #{entry.display_label}"
 %>
 <p>
 <%= manual_home_link() %>
@@ -10,7 +10,7 @@
 </p>
 
 <% headline_init %>
-<%= headline("#{entry.type_label} #{entry.label}") %>
+<%= headline("#{entry.type_label} #{entry.display_label}") %>
 <dl class="functionlist">
 <dt>
   <code><%= entry.header %></code>

data/data/bitclust/template.epub/layout

@@ -11,9 +11,7 @@
 <body>
 <%= yield %>
 <div 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>
 </div>
 </body>
 </html>

data/data/bitclust/template.epub/method

@@ -1,6 +1,6 @@
 <%
     entry = @entries.sort.first
-    @title = "#{entry.type_label} #{entry.label}"
+    @title = "#{entry.type_label} #{entry.display_title_labels.join(', ')}"
 %>
 <p>
 <%= manual_home_link() %>
@@ -12,7 +12,7 @@
 </p>
 
 <% headline_init %>
-<%= headline("#{entry.type_label} #{entry.label}") %>
+<%= headline("#{entry.type_label} #{entry.display_label}") %>
 <dl class="methodlist">
 <%
     headline_push

data/data/bitclust/template.lillia/class

@@ -59,9 +59,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           ],
      [_('Constants'),                 ents.constants                  ],
      [_('Special Variables'),         ents.special_variables          ],
+     [_('Redefined Methods'),         ents.redefined                  ],
      [_('Added Methods'),             ents.added                      ] ]\
     .each do |label, entries|
       unless entries.empty? %>
@@ -70,7 +72,7 @@
 <%
         headline_push
         entries.each do |m|
-%> 
+%>
 <span id="<%= BitClust::NameUtils.encodename_url(m.name) %>"></span>
 <%=     compile_method(m) %>
 <%
@@ -81,6 +83,25 @@
 <%
       end
     end
+%>
+
+<%
+    dyninc_groups = @entry.dynamically_included_entries.group_by(&:klass)
+    unless dyninc_groups.empty? %>
+<%=   headline(_('Methods Added by Dynamic Include')) %>
+<dl class="rightlist">
+<%    dyninc_groups.each do |mod, mod_entries| %>
+<dt><%= mod.name %> (by <%= mod.library.name %>)</dt>
+<dd>
+<ul>
+<%      mod_entries.each do |m| %>
+<li><%= method_link(m.spec_string, m.name) %></li>
+<%      end %>
+</ul>
+</dd>
+<%    end %>
+</dl>
+<%  end
     headline_pop
 %>
 </div>
@@ -107,11 +128,11 @@
 </form>
 <ul id="index-classes-list">
 <%
-    lib = @entry.library 
-    ((lib.all_classes - lib.all_error_classes).sort + lib.all_error_classes).each do |c| 
-%> 
+    lib = @entry.library
+    ((lib.all_classes - lib.all_error_classes).sort + lib.all_error_classes).each do |c|
+%>
 <li><%= class_link(c.name, "#{c.name}") %></li>
-<%  end  %>    
+<%  end  %>
 </ul>
 </div>
 

data/data/bitclust/template.lillia/layout

@@ -14,9 +14,7 @@
 <body>
 <%= yield %>
 <div 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>
 </div>
 </body>
 </html>

data/data/bitclust/template.lillia/method

@@ -1,6 +1,6 @@
 <%
     entry = @entries.sort.first
-    @title = "#{entry.type_label} #{entry.label}"
+    @title = "#{entry.type_label} #{entry.display_title_labels.join(', ')}"
     @description = entry.description
 %>
 <p>
@@ -13,7 +13,7 @@
 </p>
 
 <% headline_init %>
-<%= headline("#{entry.type_label} #{entry.label}") %>
+<%= headline("#{entry.type_label} #{entry.display_label}") %>
 <dl class="methodlist">
 <%
     headline_push