red_quilt 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45de1415fe8cc64323b390d8cedc4d6691fa6c0ab17337fac8aa956cef8bd107
-  data.tar.gz: c3392372dd65fe74149678dbb9b5ebc8cc389b6f44ca4b0013e6eadfd565568d
+  metadata.gz: 689739c1f6cf971cbeaacdbb65b50fcf7600cecef38bc25aa607ab5e87a559e5
+  data.tar.gz: 2d57a5a5993bfb8352c18ec8c6da5dc06169d59198e72870399c85d4cc1e1769
 SHA512:
-  metadata.gz: c7f3c0226e9a2e2cac06273147dfd497f45566ba99d766cee30ccd6fbff728669ab1d9ab112c93de33cce405e2cea9c8789e4f431a70c10d546e2bc2309c8c5b
-  data.tar.gz: 69cae77089c64fbf8821cc6340e0c0ad8749004fbf03ec5acf1b55daa388404db5a64a276f48267ab9e58a66a21eb2892b9f120b942e105930862c94e29de7fe
+  metadata.gz: b3f3b90749d7307db9121d9f1af968a72e94cad5aa06a3f9cf54505ff047e482246f5aa2c0fa14f1b74d9b3d03b516629b3f1c4e57e5ecb6cf5d171d4bc2b6f6
+  data.tar.gz: f8a8929d8075e0c9e3ec32145daac57ca4565ff299bed3f119faee01f5253727d44acea4dacac579ee676715138e4f03f16e0555544b4b25ee1e30c779db1de5

data/CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Opt-in Mermaid diagram support via the `mermaid:` option on `render_html` /
+  `Document#to_html` and the `--mermaid` CLI flag (off by default). Fenced
+  ` ```mermaid ` code blocks render as `<pre class="mermaid">` containers; in
+  standalone output the mermaid.js runtime is loaded from a CDN and each
+  diagram is made interactive (wheel zoom, drag pan, +/-/reset controls) with
+  svg-pan-zoom.
+
+## [0.7.1] - 2026-06-06
+
+### Added
+
+- `--open` CLI flag: render the Markdown to a standalone HTML file and open it
+  in the default browser (forces `--standalone`; writes under `Dir.tmpdir`
+  when `-o` is not given).
+
 ## [0.7.0] - 2026-05-29
 
 ### Added

data/README.md

@@ -75,14 +75,31 @@ doc.diagnostics.first.severity # => :warning
 ### Heading anchors (opt-in)
 
 `render_html` / `to_html` accept `heading_ids:` to give every heading a
-slugified `id` for anchor links. Slugs follow GitHub's scheme but keep Unicode
-intact, so Japanese headings stay readable; duplicates get `-1`, `-2` suffixes.
+slugified `id` for anchor links.
 
 ```ruby
 RedQuilt.render_html("# Hello World\n\n## はじめに", heading_ids: true)
 # => "<h1 id=\"hello-world\">Hello World</h1>\n<h2 id=\"はじめに\">はじめに</h2>\n"
 ```
 
+### Mermaid diagrams (opt-in)
+
+`render_html` / `to_html` accept `mermaid:` to render ` ```mermaid ` fenced
+code blocks for [mermaid.js](https://mermaid.js.org/).
+In standalone output the mermaid.js runtime is also loaded from a CDN.
+
+```ruby
+RedQuilt.render_html("```mermaid\ngraph LR\n  A --> B\n```", mermaid: true)
+# => "<pre class=\"mermaid\">graph LR\n  A --&gt; B\n</pre>\n"
+
+# Full page that renders the diagram in a browser (CDN script included):
+RedQuilt.parse("```mermaid\ngraph LR\n  A --> B\n```")
+        .to_html(standalone: true, mermaid: true)
+```
+
+In standalone output each diagram is made interactive with
+[svg-pan-zoom](https://github.com/bumbu/svg-pan-zoom) (loaded from a CDN).
+
 ### Tilt integration
 
 RedQuilt ships a [Tilt](https://github.com/jeremyevans/tilt) adapter.
@@ -100,13 +117,13 @@ Native options (`allow_html:`, `footnotes:`, …) pass straight through; Tilt's
 ## Documentation
 
 - [API reference](docs/api.md) — `Document` / `NodeRef` / `SourceSpan`, supported syntax, and usage examples
-- [Architecture overview](docs/architecture.ja.md) (日本語)
-- [Arena usage guide](docs/arena-usage.ja.md) (日本語)
-- [CommonMark conformance notes](docs/commonmark-conformance.ja.md) (日本語)
+- [Architecture overview](docs/architecture.md) ([日本語](docs/architecture.ja.md))
+- [Arena usage guide](docs/arena-usage.md) ([日本語](docs/arena-usage.ja.md))
+- [CommonMark conformance notes](docs/commonmark-conformance.md) ([日本語](docs/commonmark-conformance.ja.md))
 
 ## CommonMark Compatibility
 
-RedQuilt achieves 100% compliance with the CommonMark v0.31.2 specification.
+RedQuilt achieves 100% compliance with the CommonMark v0.31.2 test cases.
 See the [conformance notes](docs/commonmark-conformance.ja.md) for GFM
 extensions and intentional deviations.
 
@@ -137,6 +154,15 @@ redquilt --extended-autolinks --footnotes input.md
 
 # Standalone page with the bare template (no embedded CSS)
 redquilt --theme none input.md
+
+# Write HTML to a file instead of stdout
+redquilt -o output.html input.md
+
+# Render and open the result in the default browser
+redquilt --open input.md
+
+# Render mermaid code blocks as diagrams (loads mermaid.js from a CDN)
+redquilt --mermaid --open input.md
 ```
 
 ### Options
@@ -154,6 +180,12 @@ redquilt --theme none input.md
 --lang LANG              html lang attribute (default: "en")
 --css URL                Add a stylesheet link
 --theme THEME            Embedded stylesheet: default (default) or none
+-o, --output FILE        Write HTML to FILE instead of stdout
+--open                   Write HTML to a file and open it in the default
+                         browser (forces --standalone; uses a file under
+                         Dir.tmpdir when -o is not given)
+--mermaid                Render `mermaid` code blocks as diagrams (loads
+                         mermaid.js from a CDN in standalone output)
 --diagnostics            Print diagnostics to stderr
 --diagnostics-only       Print diagnostics only (suppress output)
 -h, --help               Show help
@@ -206,7 +238,9 @@ RedQuilt.render_html(user_markdown, allow_html: true)
 bundle exec rake spec
 ```
 
-Runs 70+ CommonMark compatibility and feature tests.
+Runs the full CommonMark 0.31.2 conformance suite (all 652 official examples,
+parsed directly from `spec/fixtures/cmark_spec-0.31.2.md`) plus RedQuilt's own
+feature tests — 1000 examples in total.
 
 ### Benchmark
 

data/Rakefile

@@ -6,3 +6,34 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+desc "Report CommonMark spec conformance, broken down by section"
+task :conformance do
+  require_relative "lib/red_quilt"
+  require_relative "spec/support/commonmark_spec_loader"
+
+  examples = CommonMarkSpecLoader.examples
+  sections = examples.each_with_object({}) do |example, acc|
+    stats = acc[example[:section]] ||= { pass: 0, total: 0 }
+    stats[:total] += 1
+    actual = RedQuilt.parse(example[:markdown], allow_html: true).to_html
+    stats[:pass] += 1 if actual == example[:html]
+  end
+
+  total = { pass: sections.values.sum { |s| s[:pass] }, total: examples.size }
+  width = sections.keys.map(&:length).max
+  divider = "  #{'-' * width}  ----------  -------"
+
+  puts "CommonMark #{CommonMarkSpecLoader::VERSION} conformance", ""
+  puts format("  %-#{width}s  %-10s  %s", "Section", "Pass/Total", "Rate")
+  puts divider
+  sections.each do |name, stats|
+    rate = stats[:pass].fdiv(stats[:total]) * 100
+    puts format("  %-#{width}s  %4d / %4d  %5.1f%%", name, stats[:pass], stats[:total], rate)
+  end
+  puts divider
+  rate = total[:pass].fdiv(total[:total]) * 100
+  puts format("  %-#{width}s  %4d / %4d  %5.1f%%", "TOTAL", total[:pass], total[:total], rate)
+
+  abort("\nConformance is below 100%.") unless total[:pass] == total[:total]
+end

data/docs/api.md

@@ -23,6 +23,10 @@ doc.disallow_raw_html? # Check GFM disallowed-raw-HTML filtering setting
 doc.to_html(standalone: true, theme: :default, title: "My Doc", lang: "en")
 # theme: :default (compact, dark-mode-aware stylesheet) or :none (bare).
 # css: "style.css" links an external stylesheet instead.
+
+# Render `mermaid` code blocks as <pre class="mermaid"> diagrams; in
+# standalone mode the mermaid.js runtime is loaded from a CDN too.
+doc.to_html(standalone: true, mermaid: true)
 ```
 
 ## NodeRef (AST node wrapper)

data/docs/architecture.ja.md

@@ -35,7 +35,7 @@ Source (Markdown String)
 ## 各ステージの責務
 
 ### `RedQuilt.normalize_input`
-CommonMark§2.3/2.4の最小前処理。`\r\n`/`\r`→`\n`の行末正規化と、NUL→U+FFFDの置換だけを行う。
+- CommonMark§2.3/2.4の最小前処理。`\r\n`/`\r`→`\n`の行末正規化と、NUL→U+FFFDの置換だけを行う。
 
 ### BlockParser
 - 行分割: sourceを`Line` Struct配列へ。各行はbyte spanで保持する。
@@ -45,11 +45,11 @@ CommonMark§2.3/2.4の最小前処理。`\r\n`/`\r`→`\n`の行末正規化と
 - 桁計算: タブ展開を含むインデント計算は`Indentation`に委譲。
 - 出力: inline未解決のblockノードをArenaに構築する。
 
-### InlinePass / Lexer / Builder
+### InlinePass / Inline::Lexer / Inline::Builder
 - 対象選定: paragraph / heading / table cellの各inline targetを走査して処理。
 - Lexer: targetのbyte span、またはstr1 literalの範囲をスキャンしTokens(parallel array)へ。
-- Builder①linear pass: code span / link / image / autolink / 簡易inlineを解決。
-- Builder②process_emphasis: delimiter stackを畳んでemphasis / strong / strikethroughを確定(CommonMark§6.2、strikethroughはGFM拡張)。
+- Builder① linear_pass: code span / link / image / autolink / 簡易inlineを解決。
+- Builder② process_emphasis: delimiter stackを畳んでemphasis / strong / strikethroughを確定(CommonMark§6.2、strikethroughはGFM拡張)。
 - footnote参照: `[^label]`を`FootnoteRegistry`で解決し、初回参照順に採番して`FOOTNOTE_REFERENCE`を生成。
 
 ### FootnotePass (`footnotes: true`)

data/docs/architecture.md

@@ -0,0 +1,99 @@
+# RedQuilt Architecture Overview
+
+This document gives a high-level view of how RedQuilt is structured.
+
+## Pipeline
+
+```
+Source (Markdown String)
+   │
+   ▼ RedQuilt.normalize_input        (lib/red_quilt.rb)
+   │
+   ▼ BlockParser                     (lib/red_quilt/block_parser.rb)
+   │ dispatch / container parsers / build_lines
+   │     (list.rb, blockquote.rb, reference_definition.rb)
+   │
+   ▼ Arena (raw inline spans)
+   │ The body of each paragraph / heading / table cell is kept
+   │ as a byte span or a str1 literal.
+   │
+   ▼ InlinePass                      (lib/red_quilt/inline_pass.rb)
+   │     ├─ Inline::Lexer            (lib/red_quilt/inline/lexer.rb)
+   │     │  byte scan -> Tokens (parallel array)
+   │     └─ Inline::Builder          (lib/red_quilt/inline/builder.rb)
+   │        linear pass -> process_emphasis (CommonMark §6.2)
+   │
+   ▼ Arena (inline resolved)
+   │
+   ▼  (option) FootnotePass           (footnotes: true)
+   ▼  (option) ExtendedAutolinkPass   (extended_autolinks: true)
+   ▼  (option) LintPass               (lint: true)
+   │
+   ▼ Renderer::HTML                  (lib/red_quilt/renderer/html.rb)
+         walk the arena and append to a mutable String
+```
+
+## Responsibility of each stage
+
+### `RedQuilt.normalize_input`
+- Minimal preprocessing required by CommonMark §2.3 / §2.4. It only normalizes
+  line endings (`\r\n` / `\r` -> `\n`) and replaces NUL with U+FFFD.
+
+### BlockParser
+- Line splitting: turn the source into an array of `Line` structs. Each line is
+  kept as a byte span.
+- Dispatch: decide the block kind from the first byte of the line
+  (`paragraph_only_line?` quickly routes non-block lines).
+- Container delegation: lists and blockquotes are delegated to `List::Parser`
+  and `Blockquote::Parser`, which call `parse_lines` recursively.
+- Collecting and excluding definitions: link reference definitions (the
+  reference table) and opt-in footnote definitions (`FootnoteRegistry`) are
+  pulled out of the body flow and gathered in dedicated collectors.
+- Column calculation: indentation that includes tab expansion is delegated to
+  `Indentation`.
+- Output: build block nodes in the Arena, with inline content still unresolved.
+
+### InlinePass / Inline::Lexer / Inline::Builder
+- Target selection: scan and process each inline target (paragraph / heading /
+  table cell).
+- Lexer: scan the target's byte span, or the range of a str1 literal, into
+  Tokens (a parallel array).
+- Builder, step 1 (linear_pass): resolve code spans, links, images, autolinks,
+  and simple inlines.
+- Builder, step 2 (process_emphasis): collapse the delimiter stack to finalize
+  emphasis / strong / strikethrough (CommonMark §6.2; strikethrough is a GFM
+  extension).
+- Footnote references: resolve `[^label]` through `FootnoteRegistry`, number
+  them in first-reference order, and create a `FOOTNOTE_REFERENCE`.
+
+### FootnotePass (`footnotes: true`)
+- Reordering: sort the definitions under `FOOTNOTES_SECTION` (at the end of the
+  root) into first-reference order.
+- Pruning: detach unreferenced definitions.
+- Section removal: if there are no references at all, remove the section itself.
+
+### Renderer::HTML
+- Walk: walk the arena recursively and append directly with `<<` to a mutable
+  String opened with `+""`.
+- Raw HTML: `allow_html` switches between passing HTML through and escaping it;
+  `disallow_raw_html` filters HTML using GFM "Disallowed Raw HTML".
+- Footnotes: render `FOOTNOTE_REFERENCE` as a sup link, and the trailing
+  `FOOTNOTES_SECTION` as `<section class="footnotes">` with backrefs.
+
+## Where the main subsystems live
+
+| Area | Files |
+|---|---|
+| Entry point / input normalization | `lib/red_quilt.rb` |
+| Public API | `lib/red_quilt/document.rb`, `node_ref.rb` |
+| Arena | `lib/red_quilt/arena.rb` |
+| Block parsing | `block_parser.rb`, `list.rb`, `blockquote.rb`, `indentation.rb` |
+| Reference definitions | `reference_definition.rb` |
+| Footnotes (opt-in) | `footnote_definition.rb`, `footnote_registry.rb`, `footnote_pass.rb` |
+| Inline parsing | `inline.rb`, `inline/lexer.rb`, `inline/tokens.rb`, `inline/flanking.rb`, `inline/builder.rb`, `inline/link_scanner.rb` |
+| Inline entities | `inline/html_entities.rb` |
+| HTML / MDAST output | `renderer/html.rb`, `renderer/mdast.rb` |
+| Extension passes | `inline_pass.rb`, `footnote_pass.rb`, `extended_autolink_pass.rb`, `lint_pass.rb` |
+| Source positions | `source_span.rb`, `source_map.rb` |
+| Diagnostics | `diagnostic.rb` |
+| CLI | `cli.rb`, `exe/redquilt` |

data/docs/arena-usage.ja.md

@@ -92,7 +92,7 @@ ArenaはASTを「オブジェクトのツリー」ではなく[parallel array](h
 - メモリ局所性が良く、GC圧が小さい
 - ノードを「軽い」値として扱えるのでRenderer / Builderをinline化しやすい
 
-###列(column)一覧
+#### 列(column)一覧
 
 |列名|用途|
 |------|------|
@@ -183,7 +183,7 @@ Arenaの公開メソッドは以下の3レイヤーに分けて読むと意図
 
 各NodeTypeがどのint / strスロットを使うかは規約で決まっています。以下が現在の規約です。
 
-### Blockノード
+#### Blockノード
 
 | NodeType | int1 | int2 | int3 | str1 | str2 |
 |----------|------|------|------|------|------|
@@ -202,7 +202,7 @@ Arenaの公開メソッドは以下の3レイヤーに分けて読むと意図
 | `FOOTNOTE_DEFINITION` | - | - | - | 正規化済みlabel | - |
 | `FOOTNOTES_SECTION` | - | - | - | - | - |
 
-### Inlineノード
+#### Inlineノード
 
 | NodeType | int1 | int2 | int3 | str1 | str2 |
 |----------|------|------|------|------|------|
@@ -219,7 +219,7 @@ Arenaの公開メソッドは以下の3レイヤーに分けて読むと意図
 
 > footnoteは`footnotes: true`時のみ生成されます。`FOOTNOTES_SECTION`はroot直下の最後の子として置かれ(span-less、`source_start: -1`)、参照された`FOOTNOTE_DEFINITION`を初回参照順に保持します。backrefの個数はfootnote番号とlabelからrender時に算出します。
 
-### Source spanの慣習
+#### Source spanの慣習
 
 - `source_start` / `source_len`: 元documentのbytes (絶対byte offset)
 - `source_start < 0`: spanなし。leafノードでは内容を`str1`にliteralとして持つことが多いが、container inlineは子ノードだけを持つ場合がある。
@@ -334,7 +334,7 @@ arena.update_span(text_id, 0, 12)
 
 ## 6. パフォーマンス上の注意
 
-####ホットパスでは`each_child`を使う
+#### ホットパスでは`each_child`を使う
 
 ブロック直yieldでEnumerator allocationを避ける。`child_ids`は外部API用