mahjong-render 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71f71da72cf55e3d1d96688ad782b98d01c34adee322e0694a030027c278bb2d
+  data.tar.gz: 57a54b42c5b6b88f59fb62654ef691612764c7907cda74669174a7b65b0fb0af
+SHA512:
+  metadata.gz: 193c72bd69c349827e920e9aef8421b1be93a8db6748f35082f414be8b207ceb781bd566e55104f11a22c4a59a475b28e2cfcedd52f18c05967a5e50e6c2c55f
+  data.tar.gz: 941dea74ea618f41f7f591026a237cc14891100d4e13dda3b6df0e7eed9784599d9d8118a5fe90a498e7f045ee20e5ffcfdf2a207f706075ccb303d4d4196e1e

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes will be recorded here. Versions follow Semantic Versioning.
+
+## 0.1.0 — 2026-09-24
+
+- Render compact manzu, pinzu, souzu, honor, and red-five notation to self-contained SVG.
+- Support adjustable spacing between tile groups in compact notation.
+- Add an HTML5 block macro for Ruby Asciidoctor.
+- Bundle pinned CC0 tile artwork and record its provenance.
+- Prepare Apache-2.0 project licensing, bilingual documentation, and complete gem metadata for publication.
+- Add manual and tag-triggered RubyGems Trusted Publishing preparation.

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+Bug reports and pull requests are welcome. Describe the notation or AsciiDoc input, the expected result, and the actual result. Include a minimal sample when possible.
+
+Run `bundle exec rake lint test assets:check licenses:check example:build` before submitting a change. Add focused tests for changes to parsing, SVG output, or the Asciidoctor adapter. Document changes to public behavior in the README and CHANGELOG.
+
+Do not add third-party code or artwork without recording its origin, license, redistribution conditions, and any required notices. New artwork must be audited for active SVG content and external references. Keep the core renderer independent of Asciidoctor and of runtime network services.

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) 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
+
+      (d) 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/LICENSES/CC0-1.0.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

data/README.ja.md

@@ -0,0 +1,90 @@
+# mahjong-render
+
+[English README](README.md)
+
+`mahjong-render` は、麻雀牌の compact notation から自己完結した SVG を作る Ruby ライブラリです。Ruby 版 Asciidoctor 向けの block macro も使えます。描画時に Node.js、ブラウザ、フォント、ネットワーク接続は不要です。
+
+## 表示例
+
+`405m456p789s12344z` の描画結果です。`405m` の `0m` は赤五萬を表します。
+
+![萬子・筒子・索子と風牌を並べた手牌。2枚目は赤五萬。](examples/hand.png)
+
+このプレビューはライブラリが出力した SVG から生成しています。
+
+## インストールと描画
+
+Ruby 3.2 以上が必要です。RubyGems からインストールします。
+
+```sh
+gem install mahjong-render
+```
+
+このリポジトリのローカルビルドをインストールする場合は、次のコマンドを使います。
+
+```sh
+gem build mahjong-render.gemspec
+gem install --local ./mahjong-render-0.1.0.gem
+```
+
+インストール後、次のコマンドで `hand.svg` を作成できます。
+
+```sh
+ruby -rmahjong_render -e 'print MahjongRender.render("405m456p789s12344z")' > hand.svg
+```
+
+Ruby コードからは次のように呼び出します。
+
+```ruby
+require "mahjong_render"
+
+svg = MahjongRender.render("405m456p789s12344z")
+File.write("hand.svg", svg)
+```
+
+返り値は牌画像をデータ URI で埋め込んだ SVG 文字列です。牌数や和了形の妥当性は判定しません。
+
+## AsciiDoc で使う
+
+Asciidoctor は gem 本体の実行時依存ではないため、別途インストールします。以下は単独の AsciiDoc 文書から `hand.html` を作る例です。
+
+```sh
+gem install asciidoctor
+printf '= Mahjong hand\n\nmahjong::405m456p789s12344z[]\n' > hand.adoc
+asciidoctor -r mahjong_render/asciidoctor hand.adoc
+```
+
+間隔の違う牌列を含む [AsciiDoc の例](examples/basic.adoc) もあります。v0.1.0 の拡張は HTML5 の block macro に対応します。macro 属性、inline macro、PDF 出力には対応しません。
+
+牌のまとまりを少し離して見せるには、完成したグループの間に `|` を入れます。たとえば `mahjong::123m|456p|789s[]` と書きます。`|` は牌幅の4分の1の空白を追加し、`|(0.25)` と同じ幅です。幅を変える場合は `mahjong::123m|(0.5)456p[]` のように書けます。
+
+## 記法とエラー
+
+| 記法 | 意味 |
+| --- | --- |
+| `1m`～`9m` | 萬子 |
+| `1p`～`9p` | 筒子 |
+| `1s`～`9s` | 索子 |
+| `1z`～`4z` | 東・南・西・北 |
+| `5z`～`7z` | 白・發・中 |
+| `0m`、`0p`、`0s` | 各色の赤五 |
+
+同じ色の数字は `123m` のようにまとめられます。`10m` は `1m 0m` の2牌です。空白は完成したグループの間に入れられますが、見た目の間隔は変わりません。通常の牌間は SVG の12単位のままで、`|` は75単位を追加します。`|(0)` は追加幅0です。数値指定には0以上の十進数を使い、区切りは完成したグループの間に置きます。
+
+不正な記法は `MahjongRender::NotationError` になります。`token`、先頭から0起算の文字位置 `position`、理由 `reason` を参照できます。たとえば `8z` は無効です。
+
+## 開発とライセンス
+
+devcontainer、または Ruby 3.2 以上・Bundler・`rsvg-convert` を用意して検証します。
+
+```sh
+bundle install
+bundle exec rake lint test assets:check licenses:check example:build
+gem build mahjong-render.gemspec
+ruby script/check_package.rb mahjong-render-0.1.0.gem
+```
+
+設計の経緯は [既存ライブラリの調査](docs/research/existing-renderers.md) と [ADR](docs/adr/) に記録しています。
+[公開手順](docs/release.md) には、Trusted Publishing の設定と手動・タグによる公開方法を記載しています。
+
+Copyright 2026 Maejima Kenya。Ruby コードとテキスト文書には [Apache-2.0](LICENSE) を適用します。同梱の牌画像と [README のプレビュー](examples/hand.png) は CC0-1.0 です。牌画像は [FluffyStuff/riichi-mahjong-tiles](https://github.com/FluffyStuff/riichi-mahjong-tiles) から採用しました。詳細は [第三者素材の告知](THIRD_PARTY_NOTICES.md)、[素材マニフェスト](assets/manifest.json)、[CC0 のライセンス本文](LICENSES/CC0-1.0.txt) を参照してください。

data/README.md

@@ -0,0 +1,112 @@
+# mahjong-render
+
+[日本語版 README](README.ja.md)
+
+`mahjong-render` is a Ruby library that turns compact riichi mahjong notation into a self-contained SVG. It also provides an optional block macro for Ruby Asciidoctor. Rendering works offline and does not require Node.js, a browser, a font, or a network service.
+
+## Example output
+
+`405m456p789s12344z` renders as:
+
+![A mahjong hand showing three character tiles, three circle tiles, three bamboo tiles, and five wind tiles. The second tile is a red five.](examples/hand.png)
+
+The `0m` in `405m` is a red five. The preview is generated from the library's SVG output.
+
+## Install and render
+
+Requirements: Ruby 3.2 or newer.
+
+Install the published gem from RubyGems:
+
+```sh
+gem install mahjong-render
+```
+
+To install a build from a local checkout:
+
+```sh
+gem build mahjong-render.gemspec
+gem install --local ./mahjong-render-0.1.0.gem
+```
+
+Render a hand from the command line or from Ruby:
+
+```sh
+ruby -rmahjong_render -e 'print MahjongRender.render("405m456p789s12344z")' > hand.svg
+```
+
+```ruby
+require "mahjong_render"
+
+svg = MahjongRender.render("405m456p789s12344z")
+File.write("hand.svg", svg)
+```
+
+The result is one SVG string with tile images embedded as data URIs. It can be saved as a file or inserted into HTML. The tile count is unrestricted; the library draws the sequence and does not check whether it is a legal hand.
+
+## AsciiDoc usage
+
+Install Asciidoctor separately, then load the adapter using the usual Ruby Asciidoctor `-r` option. These commands create `hand.html` from a standalone document:
+
+```sh
+gem install asciidoctor
+printf '= Mahjong hand\n\nmahjong::405m456p789s12344z[]\n' > hand.adoc
+asciidoctor -r mahjong_render/asciidoctor hand.adoc
+```
+
+See [the complete AsciiDoc example](examples/basic.adoc) for hands with and without extra space.
+
+To show separate groups, insert `|` between complete tile groups: `mahjong::123m|456p|789s[]`. Each `|` adds a quarter tile width of empty space, the same as `|(0.25)`. Use `|(0.5)` for half a tile width or `|(1)` for a full tile width, for example `mahjong::123m|(0.5)456p[]`.
+
+The adapter supports the HTML5 backend. Macro attributes, inline macros, and PDF output are not part of v0.1.0. The Ruby rendering API does not load Asciidoctor.
+
+## Supported notation
+
+| Form | Meaning |
+| --- | --- |
+| `1m`–`9m` | Characters (manzu) |
+| `1p`–`9p` | Circles (pinzu) |
+| `1s`–`9s` | Bamboo (souzu) |
+| `1z`–`4z` | East, South, West, North |
+| `5z`–`7z` | White, Green, Red dragon |
+| `0m`, `0p`, `0s` | Red five in the corresponding suit |
+
+Digits can share a suit suffix: `123m` means `1m 2m 3m`, and `405m` means `4m 0m 5m`. Therefore `10m` is two tiles (`1m 0m`), not a rank-ten tile. Whitespace is allowed between complete groups but does not change their spacing. The normal gap remains 12 SVG units; `|` adds 75 units, and `|(0)` adds nothing. Numeric widths must be nonnegative decimal values. Separators must be between complete groups.
+
+Invalid notation raises `MahjongRender::NotationError`, with `token`, zero-based character `position`, and `reason` readers. Examples include `8z`, `123x`, `1m!`, a missing suit, and empty input. For example, `MahjongRender.render("8z")` raises an error with `token == "8z"` and `position == 0`.
+
+## Architecture
+
+```text
+notation → strict Ruby parser → ordered tile codes → SVG composer
+                                               ↑
+                                  pinned CC0 tile artwork
+
+AsciiDoc → Ruby Asciidoctor block macro → MahjongRender.render
+```
+
+The parser and SVG composer are intentionally small. Existing renderers were evaluated before this choice; [the research](docs/research/existing-renderers.md) and [decision records](docs/adr/) explain why they were not used as Ruby runtime dependencies.
+
+## Development
+
+Open this repository in a devcontainer, or use Ruby 3.2 or newer with Bundler and `rsvg-convert` installed:
+
+```sh
+bundle install
+bundle exec rake lint test assets:check licenses:check example:build
+gem build mahjong-render.gemspec
+ruby script/check_package.rb mahjong-render-0.1.0.gem
+```
+
+The example HTML is written to `tmp/basic.html`. The test suite rasterizes a sample SVG to confirm the embedded vector artwork renders.
+The [release guide](docs/release.md) describes the manual and tag-triggered Trusted Publishing workflows.
+
+To regenerate the README preview with `rsvg-convert`:
+
+```sh
+ruby -Ilib -rmahjong_render -e 'print MahjongRender.render("405m456p789s12344z")' | rsvg-convert -w 1200 -o examples/hand.png
+```
+
+## Third-party components and license
+
+Copyright 2026 Maejima Kenya. The project Ruby code and text documentation are licensed under [Apache-2.0](LICENSE). The bundled tile artwork and the [README preview](examples/hand.png) are CC0-1.0. The artwork comes from [FluffyStuff/riichi-mahjong-tiles](https://github.com/FluffyStuff/riichi-mahjong-tiles); see [third-party notices](THIRD_PARTY_NOTICES.md), [the asset manifest](assets/manifest.json), and [the CC0 legal text](LICENSES/CC0-1.0.txt). The gem metadata lists both licenses; each applies to the components described here.

data/SECURITY.md

@@ -0,0 +1,5 @@
+# Security policy
+
+The v0.1.0 release line is supported for security fixes. Report vulnerabilities privately through GitHub's **Report a vulnerability** feature after the repository is published. Do not post exploit details in a public issue.
+
+The renderer accepts only compact tile notation. SVG asset files are pinned and checked for active content and external references. Please include a minimal input and affected version when reporting a security issue.

data/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,17 @@
+# Third-party notices
+
+## Tile artwork
+
+- Component: 37 regular-variant tile-face SVGs and one tile-front SVG
+- Upstream: [FluffyStuff/riichi-mahjong-tiles](https://github.com/FluffyStuff/riichi-mahjong-tiles)
+- Revision: `26e127ba2117f45cdce5ea0225748cc0cfad3169`
+- License: CC0-1.0; see [the upstream declaration](https://github.com/FluffyStuff/riichi-mahjong-tiles/blob/26e127ba2117f45cdce5ea0225748cc0cfad3169/LICENSE.md) and [the legal code](LICENSES/CC0-1.0.txt)
+- Purpose: tile fronts and faces embedded in rendered SVGs
+
+The original file names and SHA-256 hashes are recorded in [the asset manifest](assets/manifest.json). The files are copied without modification.
+
+The README preview at `examples/hand.png` is generated from these CC0 tile images and is also distributed under CC0-1.0. The project Ruby code and text documentation are Apache-2.0; neither license changes the terms of the other component.
+
+## Optional integration and development dependencies
+
+The gem has no runtime dependencies. Asciidoctor is installed separately when the AsciiDoc adapter is used. Development dependencies and their licenses are checked from the locked bundle in CI; they are not bundled with this gem.

data/assets/manifest.json

@@ -0,0 +1,45 @@
+{
+  "source": "https://github.com/FluffyStuff/riichi-mahjong-tiles",
+  "commit": "26e127ba2117f45cdce5ea0225748cc0cfad3169",
+  "license": "CC0-1.0",
+  "files": {
+    "Chun.svg": "7aecefcb257e5278cf3d4d0d9d03b16c3c6e3ba4080d54f60d424c3f35ffd5bb",
+    "Front.svg": "eb74c1e7de77ffed744c345decafe42671e8aadfbac1dd39304195d8070db24b",
+    "Haku.svg": "d6023d8cf3b810b74b2f7c14a4254dd7a65c57b9389e63f90aed8f6cd3607032",
+    "Hatsu.svg": "9197066680636f5d6b43e49b687103e7b347334f5ea838220edb41ec803e3ad9",
+    "Man1.svg": "9b8c52bef39c94b3fac5b1f2a4b6193cd7d8736f79d2c2ae764dd7342f7190b3",
+    "Man2.svg": "db430b747ebe8e3ad8bc152c6381a0a71c40f94da27be702a2a2aa8e8924cd10",
+    "Man3.svg": "6c8b4af104169189305f2c0eb465a0ac98a7d7c70dc7d40a70f840d780bbd92e",
+    "Man4.svg": "a65cde442a6b15e5f33a8dbe753f5d8a30ec1d07f917edc784186e0bdf3abb2e",
+    "Man5-Dora.svg": "8fbe07ba977dbaf7644b13514d89084a41fab9ad828a9b9d7be73066fb84a5be",
+    "Man5.svg": "88687841beb6eda143d2a973aaa9e2af9a8896472a9b0260d5c4d198a160bba5",
+    "Man6.svg": "279df4110edaee428a00df4115df4de7f99829cc9e4f4b259e61036cae8fe0d3",
+    "Man7.svg": "a5a1a19ef1156d4bc33d5ae0551806f683cf959b90b244f9fa90ae1bf6402485",
+    "Man8.svg": "28babd56acfb1f710c78a50e962edc48af5f739035fbf1f5f5ce62da9c196ec5",
+    "Man9.svg": "0b31a26657af8ecfd330332068c22c69516e43ac31a8f3bdfeff19a994088c23",
+    "Nan.svg": "28a3fe9e6226016c09539150bd40c22af6e006ed1ae23ef8f7e8dccd7d891f9b",
+    "Pei.svg": "a8efd3f32aa46c70a04233d499097ab75ec221635bdf68e8ee2817cb0c45d824",
+    "Pin1.svg": "477c6311f8c3e8456a8ca510a6b6ee4d146ecc4ef2d51cb801575e5b55122175",
+    "Pin2.svg": "518a4f1831a7743a12898a81c14b91edad909f264dcd410ff7a074975ee0188a",
+    "Pin3.svg": "0d57651db6c2d96a99d65a44bdd21e5f550336580310edec029428494326759f",
+    "Pin4.svg": "c9231df1f9a83b90ca3e7c333ca56a11bc323a9e765702714a273a58797aaef0",
+    "Pin5-Dora.svg": "39808d4a76fd303b55bf77bdffca8b57049dc4dbea67ca374a1399397544da21",
+    "Pin5.svg": "5574c14b911befee26b821147d54f6d92cafd66f272e1da5c12a63a0143bc213",
+    "Pin6.svg": "38605c2f30a762fada49d4d4ba1b2beb8a707469478ec173b800be06b95562ad",
+    "Pin7.svg": "97efa9eec79944518511a4f461f1468490a95ca13b3d952eff1ca02bb05b4589",
+    "Pin8.svg": "523b82c7c4a7cd8999780a7b3b5a7b6670eaf86eb1a8e9ad1317b43c6d8f81d8",
+    "Pin9.svg": "ffd648051b26c2afd770120c9405d7eec550fdb7f7b42406feadb0969f277087",
+    "Shaa.svg": "10d4b6e7e8cbe8410f376c28b8892ecab5b03c1f8d89db93acf0da2302523577",
+    "Sou1.svg": "2c50459c118560dbbe90f38006d636c1cf83c7e31128fed32e4df30f3c543d6c",
+    "Sou2.svg": "fdc5a6860051ae60f815c4acfaa3ade2b2a067a3b7518b6096f8e9356a650e04",
+    "Sou3.svg": "d0f26555368992a285f0ae3f3588d6229518a25fa212466627134f54cc6a3bac",
+    "Sou4.svg": "c0861613ee9a6eda77f29a7e685068dd0619bc7aefcc6fcd8d7356782043a518",
+    "Sou5-Dora.svg": "b39b163d23b4bbf14ecad232bee7fd09947913a136989b004e44203dfd39b023",
+    "Sou5.svg": "cbd9b02c63976954d44b373966c886c457a5903262a2fb9ea958450d86746144",
+    "Sou6.svg": "cf6489ecb0ff073efd94d76b4281e91711e74e3b5eb14c641f8c5e71c2d335b5",
+    "Sou7.svg": "9afdfc3cef41b3012895d90c1fc34c7c33111171d2a3ea248fbb8ec441009426",
+    "Sou8.svg": "dccec0736c9855c6ccc628238b49afb343f68797302f4129861cb3fc451f8d61",
+    "Sou9.svg": "5a3369477214b72ddc727130abd0a97126cbaf703eb5ad3226a5b1083dc6635b",
+    "Ton.svg": "955eba50b3de787ffad2eaa09a1f7ecaae487bc0afef253fd29e4a93e7dd76df"
+  }
+}