cjk_index 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d4df8b57af0d9d2e2755bf87cc9fdb60313d87f68ab17160f5ff4f9f28460d9
+  data.tar.gz: 3bc33035945c48d226c328c58eab9c012f7a93874edde8a3adc2c5a92d9972f3
+SHA512:
+  metadata.gz: 3016fee0464ea949e62360c4d4bfbaf3a4f1a7271c711efe1096b4958ce754b5bf4059566395eb11980fc92a8c55d953989e6562b0fa0429e1e25036a7d277e7
+  data.tar.gz: f7dade68d837d456467e6d1c8fe6e8fbba3335432c7735414df161627942137d626a7a8f270423085957b162e0fa75c3aa709dd7279635e1c4a6c0bb47a9ff2e

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Satoru Nakamura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE-OpenCC

@@ -0,0 +1,56 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+   1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+   2. You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+   3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+   4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+

data/NOTICE

@@ -0,0 +1,7 @@
+cjk_index
+Copyright (c) 2026 Satoru Nakamura. MIT License (see LICENSE).
+
+data/zh-hant-hans.tsv is derived from OpenCC (https://github.com/BYVoid/OpenCC),
+data/dictionary/TSCharacters.txt, Copyright (c) 2010-2026 Carbo Kuo and contributors,
+licensed under the Apache License, Version 2.0 (see LICENSE-OpenCC).
+Changes are described at the top of that file.

data/README.md

@@ -0,0 +1,171 @@
+# cjk_index
+
+Dictionary-free full-text search for Chinese, Japanese and Korean text, in
+pure Ruby. Build the index in Ruby, then query it in Ruby (`CJKIndex::Searcher`)
+or in the browser with a small script that has no dependencies. Both return
+the same results.
+
+[![Demo video: CJK search in CollectionBuilder, before and after cjk_index](https://img.youtube.com/vi/me46kC3JU8Q/hqdefault.jpg)](https://www.youtube.com/watch?v=me46kC3JU8Q)
+
+Demo video (2 min): [English](https://www.youtube.com/watch?v=me46kC3JU8Q) ·
+[日本語](https://www.youtube.com/watch?v=B1PO2l3iPHo).
+Try it: [demo site](https://nakamura196.github.io/cb-ja-demo/) ·
+[stock search vs. cjk_index on the same data](https://nakamura196.github.io/cb-ja-demo/compare.html).
+
+Why: client-side search in many Ruby static sites uses lunr.js with its
+English defaults. lunr's trimmer strips non-`\w` characters from both ends of
+each token, and kanji, kana and hangul are all non-`\w`, so a token made only
+of them becomes empty and a Japanese query returns **0 results**,
+even when it is an exact title. cjk_index instead:
+
+- splits CJK runs into overlapping character bigrams (「鳥瞰図」→ 鳥瞰, 瞰図) and
+  stores their positions, so a query matches only where its bigrams are
+  adjacent and in order: an exact substring match, with no dictionary or
+  native extension (the same idea as [kensaku](https://github.com/whispcat/kensaku));
+- folds variants on both sides: NFKC, lowercase, katakana → hiragana,
+  old-form kanji → modern form (「圖」→「図」), 々 expanded (「佐々木」→「佐佐木」),
+  and optionally Traditional ↔ Simplified Chinese (from OpenCC);
+- ranks with BM25 per field, with field boosts;
+- marks matches in the original text (`highlight`, `excerpt`), even when the
+  query and the text differ only by these variants;
+- matches the last Latin word as a prefix, and Latin words of 5+ letters with
+  one typo;
+- generates the browser script from the same tables as the Ruby code, so
+  indexing and querying cannot drift apart (checked by the test suite under
+  Node; the script also refuses an index built with other tables).
+
+The browser script is about 6.5 KB gzipped with the Japanese table, 24 KB
+with the Chinese table as well.
+
+How this compares with Pagefind, kensaku, lunr.js and others:
+[docs/comparison.md](docs/comparison.md).
+Index size and query time on up to 16,951 works of Aozora Bunko:
+[bench/README.md](bench/README.md).
+
+## Ruby
+
+```ruby
+require "cjk_index"
+
+builder = CJKIndex::Builder.new(fields: %w[title creator], boosts: { "title" => 3 })
+builder.add("item1.html", "title" => "東京帝國大學本部構内及農學部建物鳥瞰圖")
+File.write("search.json", builder.to_json)
+File.write("cjk-index.js", CJKIndex::Runtime.source)
+```
+
+### Search in Ruby
+
+No search server or native extension is needed. `Searcher` takes a
+`Builder`, its `to_h`, or the JSON it wrote, and folds queries with the
+variant tables the index was built with.
+
+```ruby
+searcher = CJKIndex::Searcher.new(builder)   # or CJKIndex::Searcher.load("search.json")
+searcher.search("鳥瞰図")
+# => [{ ref: "item1.html", score: 0.86, fields: ["title"] }]
+searcher.highlight("東京帝國大學", "帝国大学")   # => "東京<mark>帝國大學</mark>"
+searcher.excerpt(long_text, "鳥瞰図", 80)
+```
+
+Matching, BM25 ranking, highlighting and excerpts follow the browser script
+step for step. The test suite runs both on the same index and checks that
+refs, scores, matched fields, highlights and excerpts are identical.
+
+### Without Jekyll
+
+[examples/search_csv.rb](examples/search_csv.rb) searches a CSV catalogue from
+the command line, in about 40 lines of plain Ruby:
+
+```console
+$ ruby examples/search_csv.rb items.csv 实录 --ref objectid --variants ja,zh
+12 results for 实录
+jitsu_51ed985b       宣祖[実録] 第1帙 第1冊 巻2戊辰元年(1568)
+...
+$ ruby examples/search_csv.rb items.csv 帝国大学 --ref objectid
+3 results for 帝国大学
+agri_6d032fb5        東京[帝國大學]農學部建物位置圖
+...
+```
+
+## Browser
+
+```html
+<script src="cjk-index.js"></script>
+<script>
+  CJKIndex.load("search.json").then(function (index) {
+    index.search("鳥瞰図");  // => [{ ref: "item1.html", score: ..., fields: ["title"] }]
+    CJKIndex.highlight("東京帝國大學", "帝国大学"); // => "東京<mark>帝國大學</mark>"
+    CJKIndex.excerpt(longText, "鳥瞰図", 80);    // highlighted window around the first match
+  });
+</script>
+```
+
+## Jekyll
+
+```ruby
+# Gemfile
+group :jekyll_plugins do
+  gem "cjk_index", require: "cjk_index/jekyll"
+end
+```
+
+```yaml
+# _config.yml
+cjk_index:
+  output: assets/cjk-index        # default
+  variants: [ja]                  # default; [ja, zh] adds Traditional/Simplified Chinese
+  indexes:
+    - name: posts                 # -> assets/cjk-index/posts.json
+      collection: posts
+      fields: [title, tags, content]
+      boosts: { title: 3 }
+    - name: items
+      data: metadata              # rows of _data/metadata.csv
+      ref: objectid
+      fields: [title, creator, subject]
+```
+
+The runtime is written to `assets/cjk-index/cjk-index.js`.
+
+### CollectionBuilder
+
+```yaml
+cjk_index:
+  indexes:
+    - name: search
+      preset: collectionbuilder
+```
+
+The preset follows CollectionBuilder's own search settings: fields with
+`index: true` in `_data/config-search.csv`, and child objects only when
+`search-child-objects` is on. Result refs are the same `id` values as in
+`assets/js/lunr-store.js`. A working example:
+https://github.com/nakamura196/cb-ja-demo
+
+## Variant tables
+
+| name | folds | source |
+|---|---|---|
+| `ja` (default) | 291 Japanese old forms → modern forms | written for cjk_index |
+| `zh` | 3,202 Traditional → Simplified Chinese | OpenCC `TSCharacters.txt` (Apache-2.0); ambiguous entries dropped |
+
+With several tables, characters linked by any of them fold to one form,
+preferring the table listed first (`[ja, zh]`: 圖, 図, 图 → 図). The `zh`
+table also merges characters that are distinct in Japanese (後 and 后), so
+it is opt-in.
+
+## Status
+
+0.1, early. Not yet on RubyGems. Planned: index sharding for large sites, a
+Bridgetown adapter, a CLI, and size and speed benchmarks.
+
+## Development
+
+```sh
+bundle install
+bundle exec rake test   # the runtime tests need node
+```
+
+## License
+
+MIT

data/data/ja-kyujitai.tsv

@@ -0,0 +1,292 @@
+# Japanese old form (kyujitai) -> modern form (shinjitai), one character each. Written for cjk_index (MIT).
+乘	乗
+亂	乱
+亞	亜
+佛	仏
+來	来
+倂	併
+傳	伝
+僞	偽
+價	価
+儉	倹
+兒	児
+內	内
+兩	両
+册	冊
+冩	写
+剩	剰
+劍	剣
+劑	剤
+勞	労
+勳	勲
+勵	励
+區	区
+卷	巻
+卽	即
+參	参
+單	単
+嚴	厳
+圈	圏
+國	国
+圍	囲
+圓	円
+圖	図
+團	団
+增	増
+墮	堕
+壓	圧
+壘	塁
+壞	壊
+壯	壮
+壹	壱
+壽	寿
+奧	奥
+奬	奨
+姬	姫
+孃	嬢
+學	学
+寢	寝
+實	実
+寫	写
+寬	寛
+寳	宝
+寶	宝
+將	将
+專	専
+對	対
+屆	届
+屬	属
+峯	峰
+峽	峡
+嶋	島
+巢	巣
+帶	帯
+廢	廃
+廣	広
+廳	庁
+彈	弾
+彌	弥
+彎	湾
+徑	径
+從	従
+徵	徴
+德	徳
+恆	恒
+惠	恵
+惡	悪
+惱	悩
+愼	慎
+慘	惨
+應	応
+懷	懐
+戀	恋
+戰	戦
+戲	戯
+戾	戻
+拂	払
+拔	抜
+拜	拝
+插	挿
+揭	掲
+搖	揺
+搜	捜
+擇	択
+擊	撃
+擧	挙
+擴	拡
+攝	摂
+收	収
+效	効
+敍	叙
+數	数
+斷	断
+晚	晩
+晝	昼
+曆	暦
+曉	暁
+曾	曽
+會	会
+桒	桑
+條	条
+棧	桟
+榮	栄
+槇	槙
+樂	楽
+樞	枢
+樣	様
+橫	横
+檢	検
+櫻	桜
+權	権
+歐	欧
+步	歩
+歷	歴
+殘	残
+殼	殻
+毆	殴
+每	毎
+氣	気
+沒	没
+涉	渉
+淚	涙
+淨	浄
+淸	清
+淺	浅
+渴	渇
+溪	渓
+溫	温
+滯	滞
+滿	満
+潛	潜
+澁	渋
+澤	沢
+濕	湿
+濟	済
+濱	浜
+瀧	滝
+瀨	瀬
+灣	湾
+燈	灯
+燒	焼
+營	営
+爐	炉
+爭	争
+爲	為
+牀	床
+狀	状
+狹	狭
+獨	独
+獵	猟
+獸	獣
+獻	献
+瓣	弁
+甁	瓶
+甞	嘗
+畫	画
+當	当
+疊	畳
+發	発
+盜	盗
+盡	尽
+眞	真
+硏	研
+碎	砕
+祕	秘
+禪	禅
+禮	礼
+稱	称
+稻	稲
+穗	穂
+竝	並
+籐	藤
+粹	粋
+絲	糸
+經	経
+綠	緑
+緖	緒
+緣	縁
+縣	県
+縱	縦
+總	総
+繼	継
+續	続
+纖	繊
+缺	欠
+聯	連
+聰	聡
+聲	声
+聽	聴
+肅	粛
+腦	脳
+臟	臓
+臺	台
+與	与
+舊	旧
+舍	舎
+艷	艶
+莊	荘
+莖	茎
+萠	萌
+萬	万
+薰	薫
+藏	蔵
+藝	芸
+藥	薬
+處	処
+虛	虚
+號	号
+螢	蛍
+蟲	虫
+蠶	蚕
+蠻	蛮
+衞	衛
+裝	装
+覺	覚
+覽	覧
+觸	触
+謠	謡
+譯	訳
+譽	誉
+讀	読
+變	変
+讓	譲
+豐	豊
+豫	予
+貳	弐
+賣	売
+賴	頼
+贊	賛
+踐	践
+輕	軽
+轉	転
+辨	弁
+辭	辞
+辯	弁
+邉	辺
+邊	辺
+郞	郎
+醉	酔
+醫	医
+釀	醸
+釋	釈
+錄	録
+錢	銭
+鎭	鎮
+鐵	鉄
+鑄	鋳
+鑛	鉱
+陷	陥
+隨	随
+險	険
+隱	隠
+雙	双
+雜	雑
+霸	覇
+靈	霊
+靑	青
+靜	静
+顯	顕
+飜	翻
+飮	飲
+餘	余
+餠	餅
+騷	騒
+驅	駆
+驗	験
+驛	駅
+髓	髄
+體	体
+髮	髪
+鷄	鶏
+鹽	塩
+麥	麦
+麵	麺
+黃	黄
+黑	黒
+默	黙
+黨	党
+齊	斉
+齋	斎
+齒	歯
+齡	齢
+龍	竜