bitclust-core 1.6.0 → 1.7.0

data/theme/default/js/version_switcher.js

@@ -0,0 +1,147 @@
+// Version switcher for statichtml pages served under a /ja/<version>/ tree.
+//
+// Renders a <select> into the #version-switcher slot in the top bar. Picking
+// a version navigates to the same page under that version; if the page does
+// not exist there, it falls back to the newest version that has it, and as a
+// last resort to that version's top page. On the first interaction every
+// other version is probed with a HEAD request and missing ones are disabled.
+//
+// Pages not served under a versioned path (local previews, /ja/search/) get
+// no switcher: attach() is a no-op there.
+(function () {
+  'use strict';
+
+  // 公開済みの版(新しい順)。doctree の Rakefile の
+  // SUPPORTED_VERSIONS / OLD_VERSIONS と揃える。
+  var RELEASED_VERSIONS = [
+    '4.0', '3.4', '3.3', '3.2', '3.1', '3.0',
+    '2.7.0', '2.6.0', '2.5.0', '2.4.0', '2.3.0', '2.2.0', '2.1.0', '2.0.0',
+    '1.9.3', '1.8.7'
+  ];
+  var EDGE_VERSION = 'master';
+  var ALIASES = ['latest', EDGE_VERSION];
+
+  function knownVersion(version) {
+    return RELEASED_VERSIONS.indexOf(version) !== -1 ||
+      ALIASES.indexOf(version) !== -1;
+  }
+
+  function parsePath(pathname) {
+    var m = /^(.*\/ja\/)([^\/]+)(\/.+)$/.exec(pathname);
+    if (!m || !knownVersion(m[2])) return null;
+    return { base: m[1], version: m[2], rest: m[3] };
+  }
+
+  function targetUrl(parsed, version) {
+    return parsed.base + version + parsed.rest;
+  }
+
+  function optionVersions(currentVersion) {
+    var versions = [EDGE_VERSION].concat(RELEASED_VERSIONS);
+    if (versions.indexOf(currentVersion) === -1) {
+      versions.unshift(currentVersion);
+    }
+    return versions;
+  }
+
+  // true: exists / false: does not exist / null: unknown (network error)
+  function checkExists(url) {
+    return fetch(url, { method: 'HEAD' })
+      .then(function (res) { return res.ok; })
+      .catch(function () { return null; });
+  }
+
+  // Resolve where picking `version` should go. Unknown existence keeps the
+  // target so an offline or CORS-restricted page still just navigates.
+  function resolveTarget(parsed, version, exists) {
+    var target = targetUrl(parsed, version);
+    return exists(target).then(function (ok) {
+      if (ok !== false) return target;
+      var candidates = RELEASED_VERSIONS.filter(function (v) {
+        return v !== version;
+      });
+      var tryNext = function (i) {
+        if (i >= candidates.length) return parsed.base + version + '/';
+        var url = targetUrl(parsed, candidates[i]);
+        return exists(url).then(function (found) {
+          return found === true ? url : tryNext(i + 1);
+        });
+      };
+      return tryNext(0);
+    });
+  }
+
+  function attach(deps) {
+    var doc = deps.document;
+    var slot = doc.getElementById('version-switcher');
+    var parsed = parsePath(deps.location.pathname);
+    if (!slot || !parsed) return false;
+    var exists = deps.checkExists || checkExists;
+
+    var select = doc.createElement('select');
+    select.setAttribute('aria-label', '他のバージョンの同じページを表示');
+    optionVersions(parsed.version).forEach(function (version) {
+      var option = doc.createElement('option');
+      option.value = version;
+      option.textContent = version;
+      option.selected = version === parsed.version;
+      select.appendChild(option);
+    });
+    select.value = parsed.version;
+
+    var probed = false;
+    var probe = function () {
+      if (probed) return;
+      probed = true;
+      Array.prototype.forEach.call(select.children, function (option) {
+        if (option.value === parsed.version) return;
+        exists(targetUrl(parsed, option.value)).then(function (ok) {
+          if (ok === false) option.disabled = true;
+        });
+      });
+    };
+    select.addEventListener('focus', probe);
+    select.addEventListener('mousedown', probe);
+    select.addEventListener('touchstart', probe);
+
+    select.addEventListener('change', function () {
+      var version = select.value;
+      if (version === parsed.version) return;
+      resolveTarget(parsed, version, exists).then(function (url) {
+        deps.setHref(url);
+      });
+    });
+
+    slot.appendChild(select);
+    return true;
+  }
+
+  var api = {
+    RELEASED_VERSIONS: RELEASED_VERSIONS,
+    EDGE_VERSION: EDGE_VERSION,
+    parsePath: parsePath,
+    targetUrl: targetUrl,
+    optionVersions: optionVersions,
+    checkExists: checkExists,
+    resolveTarget: resolveTarget,
+    attach: attach
+  };
+  if (typeof globalThis !== 'undefined') {
+    globalThis.RuremaVersionSwitcher = api;
+  }
+
+  if (typeof document !== 'undefined' && typeof location !== 'undefined') {
+    var init = function () {
+      attach({
+        document: document,
+        location: location,
+        setHref: function (url) { location.href = url; }
+      });
+    };
+    if (document.readyState === 'loading') {
+      document.addEventListener('DOMContentLoaded', init);
+    } else {
+      init();
+    }
+  }
+})();

data/theme/default/search.css

@@ -26,6 +26,27 @@
   text-overflow: ellipsis;
 }
 
+/* Version switcher: sits next to the brand; the auto margin keeps the
+   search box pinned to the right. The slot is empty until
+   version_switcher.js fills it (only on /ja/<version>/ pages). */
+#version-switcher {
+  flex: 0 0 auto;
+  margin-right: auto;
+}
+
+#version-switcher:empty {
+  display: none;
+}
+
+#version-switcher select {
+  font-size: 0.9em;
+  padding: 0.2em 0.3em;
+  border: 1px solid #99a;
+  border-radius: 4px;
+  background: #fff;
+  color: inherit;
+}
+
 #search-section {
   position: relative;
   flex: 0 0 auto;

data/theme/default/style.css

@@ -273,6 +273,25 @@ pre.highlight.ruby[data-editing="true"] > code:focus {
   left: -1000px;
 }
 
+/* for ?(RUN のヘルプページへのリンク。highlight__button-group の中で
+   COPY の右に入る)。ボタン(RUN・COPY)と違いページ遷移するリンクなので、
+   色・ホバーはサイト共通のリンクの見た目(a のスタイル)に任せて、
+   ここでは丸囲みの形と配置だけ整える */
+.highlight__help-link {
+  display: inline-block;
+  box-sizing: border-box;
+  width: 1.5em;
+  height: 1.5em;
+  line-height: calc(1.5em - 2px);
+  text-align: center;
+  /* ただの ? だとクリックできると気付きにくいので、丸囲みはてなにして
+     ヘルプアイコンらしくする。枠は currentColor なので、リンク色にも
+     ホバーの反転(白文字+#33a 背景)にもそのまま追従する */
+  border: 1px solid currentColor;
+  border-radius: 50%;
+  margin: 0 0.25em 0.25em 0.5em;
+}
+
 /* サンプルコードのキャプション。pre の上に密着したタブとして表示する
    (上だけ角丸でタブらしく)。script.js がツールバー行の左端に取り込む。
    下のコード部分と同じ背景色にして「つながったタブ」に見せる(ヘッダー
@@ -329,26 +348,57 @@ dd {
     margin: 0.3em 0em 1em 4em;
 }
 
+/* 表の基本スタイルは本文中のコンテンツ表(Markdown のテーブル)向け:
+   セルに罫線と余白を付けて読みやすくする。text-align はセルの
+   インラインスタイル(列揃え指定)が上書きする。
+   メソッド一覧などのカード状レイアウト表は後続の .entries 系の
+   上書きで従来の見た目を維持する */
 table {
     border-collapse: collapse;
+    margin: 0.5em 0 1em;
 }
 
-th {
+th,
+td {
     text-align: left;
     vertical-align: top;
-    background-color: #AAC;
-    border: 3px solid white;
-    padding: 0.3em;
+    border: 1px solid #bbb;
+    padding: 0.3em 0.8em;
 }
 
-td {
-    text-align: left;
-    vertical-align: top;
+th {
+    background-color: #dde;
+}
+
+tbody tr:nth-child(even) {
+    background-color: #f5f5f5;
 }
 
 table.entries {
     width: 100%;
     height: 100%;
+    margin: 0;
+}
+
+/* セルの打ち消しは .entries 前置で書く。td.signature 等の個別ルール
+   (このファイルの後方)と同格の詳細度に抑えて、後勝ちでそちらを
+   優先させるため(table.entries td だと個別ルールより強くなる) */
+.entries th {
+    background-color: #AAC;
+    border: 3px solid white;
+    padding: 0.3em;
+}
+
+.entries td {
+    border: none;
+    padding: 0;
+}
+
+/* tbody はテンプレートでは書かれないがブラウザが補うため、
+   コンテンツ表向けの縞がここにも当たるのを打ち消す
+   (セル自身の背景で見えないが明示的に無効化しておく) */
+.entries tr:nth-child(even) {
+    background-color: transparent;
 }
 
 table.entries tr {
@@ -586,3 +636,29 @@ span.method-until-badge {
 }
 span.method-since-badge { background-color: #e6f2e6; color: #2d6a2d; }
 span.method-until-badge { background-color: #f7e6e6; color: #aa3333; }
+
+/* RBS 型シグネチャ(rbssig サブコマンドが 4.0 以降の DB に書き込み、
+   メソッド見出しの <dt> 群の直後に 1 オーバーロード 1 行の
+   <dt class="rbs-signature"> として出る)。参考情報なので rdoc の型表示の
+   ように小さく・薄く・少し字下げして、メソッド定義の見出しと明確に
+   区別する。行の大半はクラスへのリンクなので、リンクの太字(a の既定)と
+   リンク色もここで打ち消さないと見出しと同じ太字の青になってしまう。
+   インラインコードのチップ背景も外す */
+dt.rbs-signature {
+    font-weight: normal;
+    font-size: 80%;
+    color: #999;
+    line-height: 1.4;
+    margin-left: 2em;
+}
+dt.rbs-signature code {
+    background-color: transparent;
+    padding: 0;
+    border-radius: 0;
+    font-size: 100%;  /* code の 90% 縮小と二重に掛けない(実効 80%) */
+}
+dt.rbs-signature a:link,
+dt.rbs-signature a:visited {
+    font-weight: normal;
+    color: #8895b5;
+}

data/theme/lillia/style.css

@@ -317,6 +317,32 @@ span.method-until-badge {
 span.method-since-badge { background-color: #e6f2e6; color: #2d6a2d; }
 span.method-until-badge { background-color: #f7e6e6; color: #aa3333; }
 
+/* RBS 型シグネチャ(rbssig サブコマンドが 4.0 以降の DB に書き込み、
+   メソッド見出しの <dt> 群の直後に 1 オーバーロード 1 行の
+   <dt class="rbs-signature"> として出る)。参考情報なので rdoc の型表示の
+   ように小さく・薄く・少し字下げして、メソッド定義の見出しと明確に
+   区別する。行の大半はクラスへのリンクなので、リンクの太字(a の既定)と
+   リンク色もここで打ち消さないと見出しと同じ太字の青になってしまう。
+   インラインコードのチップ背景も外す */
+dt.rbs-signature {
+  font-weight: normal;
+  font-size: 80%;
+  color: #999;
+  line-height: 1.4;
+  margin-left: 2em;
+}
+dt.rbs-signature code {
+  background-color: transparent;
+  padding: 0;
+  border-radius: 0;
+  font-size: 100%;  /* code の縮小と二重に掛けない(実効 80%) */
+}
+dt.rbs-signature a:link,
+dt.rbs-signature a:visited {
+  font-weight: normal;
+  color: #8895b5;
+}
+
 .method-description{
   padding-bottom: 10px;
   margin-bottom: 90px ; 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitclust-core
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - https://github.com/rurema
@@ -155,6 +155,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.10'
 description: |
   Rurema is a Japanese ruby documentation project, and
   bitclust is a rurema document processor.
@@ -215,6 +229,7 @@ files:
 - data/bitclust/template/method
 - data/bitclust/template/opensearchdescription
 - data/bitclust/template/search
+- lib/bitclust-irb.rb
 - lib/bitclust.rb
 - lib/bitclust/app.rb
 - lib/bitclust/capi_converter.rb
@@ -236,10 +251,12 @@ files:
 - lib/bitclust/include_graph.rb
 - lib/bitclust/include_pruner.rb
 - lib/bitclust/interface.rb
+- lib/bitclust/irb.rb
 - lib/bitclust/libraryentry.rb
 - lib/bitclust/lineinput.rb
 - lib/bitclust/link_checker.rb
 - lib/bitclust/markdown_bridge.rb
+- lib/bitclust/markdown_exporter.rb
 - lib/bitclust/markdown_orchestrator.rb
 - lib/bitclust/markdown_to_rrd.rb
 - lib/bitclust/markdown_tree.rb
@@ -255,6 +272,9 @@ files:
 - lib/bitclust/parseutils.rb
 - lib/bitclust/preprocessor.rb
 - lib/bitclust/progress_bar.rb
+- lib/bitclust/rbs_overload_matcher.rb
+- lib/bitclust/rbs_sig_importer.rb
+- lib/bitclust/rbs_signatures.rb
 - lib/bitclust/rdcompiler.rb
 - lib/bitclust/refsdatabase.rb
 - lib/bitclust/reloadable_request_handler.rb
@@ -285,6 +305,7 @@ files:
 - lib/bitclust/subcommands/preproc_command.rb
 - lib/bitclust/subcommands/property_command.rb
 - lib/bitclust/subcommands/query_command.rb
+- lib/bitclust/subcommands/rbssig_command.rb
 - lib/bitclust/subcommands/searchpage_command.rb
 - lib/bitclust/subcommands/server_command.rb
 - lib/bitclust/subcommands/setup_command.rb
@@ -309,10 +330,12 @@ files:
 - test/test_functionreferenceparser.rb
 - test/test_include_graph.rb
 - test/test_include_pruner.rb
+- test/test_irb_plugin.rb
 - test/test_libraryentry.rb
 - test/test_link_checker.rb
 - test/test_lookup_command.rb
 - test/test_markdown_bridge.rb
+- test/test_markdown_exporter.rb
 - test/test_markdown_orchestrator.rb
 - test/test_markdown_to_rrd.rb
 - test/test_markdown_tree.rb
@@ -326,6 +349,9 @@ files:
 - test/test_methodsince_command.rb
 - test/test_nameutils.rb
 - test/test_preprocessor.rb
+- test/test_rbs_overload_matcher.rb
+- test/test_rbs_sig_importer.rb
+- test/test_rbssig_command.rb
 - test/test_rdcompiler.rb
 - test/test_refsdatabase.rb
 - test/test_rrd_to_markdown.rb
@@ -337,6 +363,7 @@ files:
 - test/test_search_screen.rb
 - test/test_searcher.rb
 - test/test_searchpage_command.rb
+- test/test_setup_command.rb
 - test/test_simplesearcher.rb
 - test/test_statichtml_command.rb
 - test/test_syntax_highlighter.rb
@@ -350,6 +377,7 @@ files:
 - theme/default/js/search_navigation.js
 - theme/default/js/search_page.js
 - theme/default/js/search_ranker.js
+- theme/default/js/version_switcher.js
 - theme/default/rurema.png
 - theme/default/rurema.svg
 - theme/default/script.js
@@ -400,10 +428,12 @@ test_files:
 - test/test_functionreferenceparser.rb
 - test/test_include_graph.rb
 - test/test_include_pruner.rb
+- test/test_irb_plugin.rb
 - test/test_libraryentry.rb
 - test/test_link_checker.rb
 - test/test_lookup_command.rb
 - test/test_markdown_bridge.rb
+- test/test_markdown_exporter.rb
 - test/test_markdown_orchestrator.rb
 - test/test_markdown_to_rrd.rb
 - test/test_markdown_tree.rb
@@ -417,6 +447,9 @@ test_files:
 - test/test_methodsince_command.rb
 - test/test_nameutils.rb
 - test/test_preprocessor.rb
+- test/test_rbs_overload_matcher.rb
+- test/test_rbs_sig_importer.rb
+- test/test_rbssig_command.rb
 - test/test_rdcompiler.rb
 - test/test_refsdatabase.rb
 - test/test_rrd_to_markdown.rb
@@ -428,6 +461,7 @@ test_files:
 - test/test_search_screen.rb
 - test/test_searcher.rb
 - test/test_searchpage_command.rb
+- test/test_setup_command.rb
 - test/test_simplesearcher.rb
 - test/test_statichtml_command.rb
 - test/test_syntax_highlighter.rb