kramdown-ansi 0.5.0 → 0.7.0

data/spec/assets/tables.ansi

@@ -0,0 +1,345 @@
+╭───┬───╮
+│ A │ B │
+├───┼───┤
+│ 1 │ 2 │
+╰───┴───╯
+
+Case 00 — Table at Document Start
+
+Case 01 — Column Count Mismatch
+
+Header has 3 columns, data rows have 5 and 1.
+
+╭──────────┬───┬───┬───┬───╮
+│    A     │ B │ C │   │   │
+├──────────┼───┼───┼───┼───┤
+│    1     │ 2 │ 3 │ 4 │ 5 │
+├──────────┼───┼───┼───┼───┤
+│ only-one │   │   │   │   │
+├──────────┼───┼───┼───┼───┤
+│    a     │ b │ c │ d │   │
+╰──────────┴───┴───┴───┴───╯
+
+Case 02 — No Leading / Trailing Pipes
+
+GFM allows omitting the outer |. Renderer must still split on inner
+pipes.
+
+╭───┬───┬───╮
+│ A │ B │ C │
+├───┼───┼───┤
+│ 1 │ 2 │ 3 │
+├───┼───┼───┤
+│ 4 │ 5 │ 6 │
+╰───┴───┴───╯
+
+Case 03 — Escaped Pipe in Cell
+
+\| should render as a literal |, not split the column.
+
+╭───────────────────────┬───────╮
+│ Col                   │ Value │
+├───────────────────────┼───────┤
+│ a\|b                  │ 1     │
+├───────────────────────┼───────┤
+│ x \| y                │ 2     │
+├───────────────────────┼───────┤
+│ no-escape-but-literal │ pipe  │
+╰───────────────────────┴───────╯
+
+Case 04 — Empty Cells
+
+╭──────┬─────┬───────╮
+│  A   │  B  │   C   │
+├──────┼─────┼───────┤
+│      │     │       │
+├──────┼─────┼───────┤
+│ left │     │ right │
+├──────┼─────┼───────┤
+│      │ mid │       │
+├──────┼─────┼───────┤
+│      │     │       │
+╰──────┴─────┴───────╯
+
+Case 05 — Single-Column Table
+
+╭───────╮
+│ Only  │
+├───────┤
+│ one   │
+├───────┤
+│ two   │
+├───────┤
+│ three │
+╰───────╯
+
+Case 06 — Header + Alignment Only (No Data Rows)
+
+not a table
+
+| X | Y | Z |
+|:-:|:-:|:-:|
+
+Case 07 — Back-to-Back Tables (No Blank Line)
+
+╭─────┬─────╮
+│ T1a │ T1b │
+├─────┼─────┤
+│ a   │ b   │
+╰─────┴─────╯
+
+╭─────┬─────╮
+│ T2a │ T2b │
+├─────┼─────┤
+│ c   │ d   │
+╰─────┴─────╯
+
+Case 08 — Full-Width / Variable-Width Unicode
+
+CJK, emoji (double-width), combining marks — column widths will lie.
+
+╭─────────┬─────────┬──────────────────────────╮
+│ Char    │ Width   │ Note                     │
+├─────────┼─────────┼──────────────────────────┤
+│ 你      │ 2 cells │ CJK                      │
+├─────────┼─────────┼──────────────────────────┤
+│ 💜      │ 2 cells │ Emoji                    │
+├─────────┼─────────┼──────────────────────────┤
+│ e\u0301 │ 1+0     │ Combining acute          │
+├─────────┼─────────┼──────────────────────────┤
+│ ☝       │ 2 cells │ DBCS symbol              │
+├─────────┼─────────┼──────────────────────────┤
+│ |       │ 1 cell  │ Looks like a pipe, isn't │
+╰─────────┴─────────┴──────────────────────────╯
+
+Case 09 — Markdown Inside Cells
+
+Bold, italic, code, links, strikethrough, nested.
+
+╭───────────────────┬─────────╮
+│ Cell              │ Renders │
+├───────────────────┼─────────┤
+│ **bold**          │ bold    │
+├───────────────────┼─────────┤
+│ *it*              │ it      │
+├───────────────────┼─────────┤
+│ `code`            │ code    │
+├───────────────────┼─────────┤
+│ [link](https://x) │ ]8;;https://x\link]8;;\    │
+├───────────────────┼─────────┤
+│ ~~gone~~          │ gone    │
+├───────────────────┼─────────┤
+│ **_both_**        │ both    │
+╰───────────────────┴─────────╯
+
+Case 10 — Alignment Row Has Wrong Column Count
+
+| A | B | C |
+|:-:|:-:|
+
+Case 11 — Table Split by Blank Line
+
+╭───┬───╮
+│ A │ B │
+├───┼───┤
+│ 1 │ 2 │
+╰───┴───╯
+
+╭───┬───╮
+│ A │ B │
+├───┼───┤
+│ 3 │ 4 │
+╰───┴───╯
+
+Case 12 — Excessive Whitespace Padding
+
+╭───┬───┬───╮
+│ A │ B │ C │
+├───┼───┼───┤
+│ 1 │ 2 │ 3 │
+╰───┴───┴───╯
+
+Case 13 — <br> and HTML in Cells
+
+╭──────┬─────────────────────╮
+│ Cell │ Content             │
+├──────┼─────────────────────┤
+│ br   │ line1line2          │
+├──────┼─────────────────────┤
+│ html │ <span>inline</span> │
+├──────┼─────────────────────┤
+│ both │ bold  italic        │
+╰──────┴─────────────────────╯
+
+Case 14 — Pipe at Both Ends, Nothing Between
+
+╭───╮
+│   │
+├───┤
+│   │
+╰───╯
+
+Case 15 — One Data Row, 10 Columns
+
+╭───┬───┬───┬───┬───┬───┬───┬───┬───┬────╮
+│ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 10 │
+├───┼───┼───┼───┼───┼───┼───┼───┼───┼────┤
+│ a │ b │ c │ d │ e │ f │ g │ h │ i │ j  │
+╰───┴───┴───┴───┴───┴───┴───┴───┴───┴────╯
+
+Case 16 — Alignment Row with Mixed/Invalid Markers
+
+╭───┬───┬───╮
+│ A │ B │ C │
+├───┼───┼───┤
+│ l │ r │ d │
+╰───┴───┴───╯
+
+Case 17 — Table at Document Start, Glued to Following Header
+
+╭───┬───╮
+│ a │ b │
+├───┼───┤
+│ 1 │ 2 │
+╰───┴───╯
+
+next section
+
+Case 18 — Table Glued to Preceding Header
+
+heading
+
+╭───┬───╮
+│ a │ b │
+├───┼───┤
+│ 1 │ 2 │
+╰───┴───╯
+
+Case 19 — Single Column, No Trailing Pipe on Header
+
+╭─────────╮
+│ a table │
+├─────────┤
+│ hi      │
+╰─────────╯
+
+Case 20 — Not a Table: Single Pipe Line
+
+not a table
+
+Case 21 — Not a Table: Header + Sep, No Body, Missing Closing Pipe
+
+|not a table
+|-|
+
+Case 22 — Table After Code Block, Glued
+
+some code
+
+╭───┬───╮
+│ a │ b │
+├───┼───┤
+│ 1 │ 2 │
+╰───┴───╯
+
+Case 23 — Table After List Item, Glued
+
+· item one
+
+· item two
+
+╭───┬───╮
+│ a │ b │
+├───┼───┤
+│ 1 │ 2 │
+╰───┴───╯
+
+Case 24 — No Leading Pipe on Separator
+
+╭───┬───╮
+│ a │ b │
+├───┼───┤
+│ 1 │ 2 │
+╰───┴───╯
+
+Case 25 — No Leading Pipe on Body Row
+
+╭───┬───╮
+│ a │ b │
+├───┼───┤
+│ 1 │ 2 │
+╰───┴───╯
+
+Case 26 — Indented Table Inside Ordered List
+
+1. Flatten it.
+
+╭─────────────┬───────────────┬───────╮
+│ Service     │ Sub           │ Value │
+├─────────────┼───────────────┼───────┤
+│ ollama_chat │ kramdown-ansi │ 🟢    │
+╰─────────────┴───────────────┴───────╯
+
+Case 27 — Not a table just a pipe in a sentence
+
+a | b
+
+────────────────────────────────────────────────────────────────────────────────
+
+╭──────┬────────────────────────────────────────────────────────────────╮
+│ Case │ What It Stresses                                               │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 01   │ Column count validation / overflow / underflow                 │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 02   │ Pipe-stripping logic (leading/trailing optional)               │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 03   │ Escape sequence handling (\|)                                  │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 04   │ Empty-string cell rendering, border alignment                  │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 05   │ Single-column edge (degenerate table)                          │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 06   │ Zero data rows — does it draw a header-only box?               │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 07   │ Consecutive tables — does the second become data of the first? │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 08   │ Unicode width calculation for column sizing                    │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 09   │ Inline markdown rendering inside a table cell                  │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 10   │ Alignment row with fewer columns than header                   │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 11   │ Blank line splitting one table into two                        │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 12   │ Whitespace normalization / trimming                            │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 13   │ Raw HTML + <br> in cell context                                │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 14   │ Cell with only whitespace — empty or not?                      │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 15   │ Very wide table — does it wrap or overflow?                    │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 16   │ Non-standard alignment markers                                 │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 17   │ Table at doc start, glued to following header                  │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 18   │ Table glued to preceding header (no blank before)              │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 19   │ Single col, missing closing pipe on header                     │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 20   │ Not a table: single pipe line                                  │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 21   │ Not a table: header + sep, no body, missing pipe               │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 22   │ Table after code block, no blank between                       │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 23   │ Table after list item, no blank between                        │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 24   │ No leading pipe on separator row                               │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 25   │ No leading pipe on body row                                    │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 26   │ Indented table inside ordered list item                        │
+├──────┼────────────────────────────────────────────────────────────────┤
+│ 27   │ Not a table just a pipe in a sentence                          │
+╰──────┴────────────────────────────────────────────────────────────────╯

data/spec/assets/tables.md

@@ -0,0 +1,241 @@
+| A | B |
+|---|---|
+| 1 | 2 |
+
+## Case 00 — Table at Document Start
+
+## Case 01 — Column Count Mismatch
+
+Header has 3 columns, data rows have 5 and 1.
+
+| A | B | C |
+|:-:|:-:|:-:|
+| 1 | 2 | 3 | 4 | 5 |
+| only-one |
+| a | b | c | d |
+
+## Case 02 — No Leading / Trailing Pipes
+
+GFM allows omitting the outer `|`. Renderer must still split on inner pipes.
+
+| A | B | C
+|:-:|:-:|:-:
+| 1 | 2 | 3
+| 4 | 5 | 6
+
+## Case 03 — Escaped Pipe in Cell
+
+`\|` should render as a literal `|`, not split the column.
+
+| Col | Value |
+|:----|:------|
+| `a\|b` | 1 |
+| `x \| y` | 2 |
+| no-escape-but-literal | pipe |
+
+## Case 04 — Empty Cells
+
+| A | B | C |
+|:-:|:-:|:-:|
+|  |  |  |
+| left |  | right |
+|  | mid |  |
+|    |   |     |
+
+## Case 05 — Single-Column Table
+
+| Only |
+|:-----|
+| one |
+| two |
+| three |
+
+## Case 06 — Header + Alignment Only (No Data Rows)
+
+not a table
+
+| X | Y | Z |
+|:-:|:-:|:-:|
+
+## Case 07 — Back-to-Back Tables (No Blank Line)
+
+| T1a | T1b |
+|:----|:----|
+| a | b |
+| T2a | T2b |
+|:----|:----|
+| c | d |
+
+## Case 08 — Full-Width / Variable-Width Unicode
+
+CJK, emoji (double-width), combining marks — column widths will *lie*.
+
+| Char | Width | Note |
+|:-----|:------|:-----|
+| `你` | 2 cells | CJK |
+| `💜` | 2 cells | Emoji |
+| `e\u0301` | 1+0 | Combining acute |
+| `☝` | 2 cells | DBCS symbol |
+| `|` | 1 cell | Looks like a pipe, isn't |
+
+## Case 09 — Markdown *Inside* Cells
+
+Bold, italic, code, links, strikethrough, nested.
+
+| Cell | Renders |
+|:-----|:--------|
+| `**bold**` | **bold** |
+| `*it*` | *it* |
+| `` `code` `` | `code` |
+| `[link](https://x)` | [link](https://x) |
+| `~~gone~~` | ~~gone~~ |
+| `**_both_**` | **_both_** |
+
+## Case 10 — Alignment Row Has Wrong Column Count
+
+| A | B | C |
+|:-:|:-:|
+
+## Case 11 — Table Split by Blank Line
+
+| A | B |
+|:-:|:-:|
+| 1 | 2 |
+
+| A | B |
+|:-:|:-:|
+| 3 | 4 |
+
+## Case 12 — Excessive Whitespace Padding
+
+|   A   |   B   |   C   |
+| :---: | :---: | :---: |
+|      1      |      2      |      3      |
+
+## Case 13 — `<br>` and HTML in Cells
+
+| Cell | Content |
+|:-----|:--------|
+| br | line1<br>line2 |
+| html | `<span>inline</span>` |
+| both | **bold** <br> *italic* |
+
+## Case 14 — Pipe at Both Ends, Nothing Between
+
+|  |
+|:-:|
+|  |
+
+## Case 15 — One Data Row, 10 Columns
+
+| 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 |
+|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:--:|
+| a | b | c | d | e | f | g | h | i | j |
+
+## Case 16 — Alignment Row with Mixed/Invalid Markers
+
+| A | B | C |
+|:--|--:|---|
+| l | r | d |
+
+## Case 17 — Table at Document Start, Glued to Following Header
+
+| a | b |
+|---|---|
+| 1 | 2 |
+# next section
+
+## Case 18 — Table Glued to Preceding Header
+
+# heading
+| a | b |
+|---|---|
+| 1 | 2 |
+
+## Case 19 — Single Column, No Trailing Pipe on Header
+
+| a table
+|-|
+|hi|
+
+## Case 20 — Not a Table: Single Pipe Line
+
+|not a table
+
+## Case 21 — Not a Table: Header + Sep, No Body, Missing Closing Pipe
+
+|not a table
+|-|
+
+## Case 22 — Table After Code Block, Glued
+
+```
+some code
+```
+| a | b |
+|---|---|
+| 1 | 2 |
+
+## Case 23 — Table After List Item, Glued
+
+- item one
+- item two
+| a | b |
+|---|---|
+| 1 | 2 |
+
+## Case 24 — No Leading Pipe on Separator
+
+| a | b |
+:---|---:
+| 1 | 2 |
+
+## Case 25 — No Leading Pipe on Body Row
+
+| a | b |
+|---|---|
+1 | 2
+
+## Case 26 — Indented Table Inside Ordered List
+
+1. **Flatten it.**
+
+   | Service | Sub | Value |
+   |:--------|:----|:------|
+   | `ollama_chat` | `kramdown-ansi` | 🟢 |
+
+## Case 27 — Not a table just a pipe in a sentence
+
+a | b
+
+---
+
+| Case | What It Stresses |
+|:-----|:-----------------|
+| 01 | Column count validation / overflow / underflow |
+| 02 | Pipe-stripping logic (leading/trailing optional) |
+| 03 | Escape sequence handling (`\|`) |
+| 04 | Empty-string cell rendering, border alignment |
+| 05 | Single-column edge (degenerate table) |
+| 06 | Zero data rows — does it draw a header-only box? |
+| 07 | Consecutive tables — does the second become data of the first? |
+| 08 | Unicode width calculation for column sizing |
+| 09 | Inline markdown rendering *inside* a table cell |
+| 10 | Alignment row with fewer columns than header |
+| 11 | Blank line splitting one table into two |
+| 12 | Whitespace normalization / trimming |
+| 13 | Raw HTML + `<br>` in cell context |
+| 14 | Cell with only whitespace — empty or not? |
+| 15 | Very wide table — does it wrap or overflow? |
+| 16 | Non-standard alignment markers |
+| 17 | Table at doc start, glued to following header |
+| 18 | Table glued to preceding header (no blank before) |
+| 19 | Single col, missing closing pipe on header |
+| 20 | Not a table: single pipe line |
+| 21 | Not a table: header + sep, no body, missing pipe |
+| 22 | Table after code block, no blank between |
+| 23 | Table after list item, no blank between |
+| 24 | No leading pipe on separator row |
+| 25 | No leading pipe on body row |
+| 26 | Indented table inside ordered list item |
+| 27 | Not a table just a pipe in a sentence |

data/spec/kramdown/ansi/width_spec.rb

@@ -1,4 +1,8 @@
 describe Kramdown::ANSI::Width do
+  let :ansi do
+    Term::ANSIColor
+  end
+
   before do
     allow(Tins::Terminal).to receive(:columns).and_return 80
   end
@@ -58,12 +62,52 @@ describe Kramdown::ANSI::Width do
       expect(truncated.size).to eq 64
     end
 
+    it 'can truncate ansi escape sequences with length' do
+      truncated = described_class.truncate([ ansi.red { ?A * 10 }, ansi.green { ?A * 10 } ] * 5 * ' ', length: 64)
+      expect(truncated).to eq(
+        "\e[31mAAAAAAAAAA\e[0m \e[32mAAAAAAAAAA\e[0m \e[31mAAAAAAAAAA\e[0m \e[32mAAAAAAAAAA\e[0m \e[31mAAAAAAAAAA\e[0m \e[32mAAAAAAAA…\e[0m"
+      )
+      expect(Term::ANSIColor.uncolor {truncated }.size).to eq 64
+    end
+
+    it 'can truncate wide emojis with length' do
+      truncated = described_class.truncate('ABC' + ?😍 * 10 + 'DEF', length: 10)
+      expect(truncated).to eq("ABC😍😍😍…")
+      expect(truncated.size).to eq 7
+      expect(described_class.display_width(truncated)).to eq 10
+      truncated = described_class.truncate('AB' + ?😍 * 10 + 'DEF', length: 10)
+      expect(truncated).to eq("AB😍😍😍…")
+      expect(truncated.size).to eq 6
+      expect(described_class.display_width(truncated)).to eq 9
+      truncated = described_class.truncate('A' + ?😍 * 10 + 'DEF', length: 10)
+      expect(truncated).to eq("A😍😍😍😍…")
+      expect(truncated.size).to eq 6
+      expect(described_class.display_width(truncated)).to eq 10
+      truncated = described_class.truncate('A' * 5 + ?😍 + 'B' * 5, length: 10)
+      expect(truncated).to eq("AAAAA😍BB…")
+      expect(truncated.size).to eq 9
+      expect(described_class.display_width(truncated)).to eq 10
+      truncated = described_class.truncate('A' * 3 + ?😍 + 'B' + ?😁 + 'C' * 5, length: 10)
+      expect(truncated).to eq("AAA😍B😁C…")
+      expect(truncated.size).to eq 8
+      expect(described_class.display_width(truncated)).to eq 10
+      truncated = described_class.truncate('A' * 3 + ?😍 + ansi.red { 'B' } + ?😁 + 'C' * 5, length: 10)
+      expect(truncated).to eq("AAA😍\e[31mB\e[0m😁C…\e[0m")
+      expect(truncated.size).to eq 21
+      expect(described_class.display_width(truncated)).to eq 10
+    end
+
     it 'cannot truncate if not necessary' do
       text = [ ?A * 10 ] * 5 * ' '
       truncated = described_class.truncate(text, length: 54)
       expect(truncated).to eq text
     end
 
+    it 'can truncate empty strings' do
+      truncated = described_class.truncate('', length: 23)
+      expect(truncated).to be_empty
+    end
+
     it 'can truncate with length 0' do
       truncated = described_class.truncate([ ?A * 10 ] * 10 * ' ', length: 0)
       expect(truncated).to be_empty
@@ -76,5 +120,51 @@ describe Kramdown::ANSI::Width do
       )
       expect(truncated.size).to eq 64
     end
+
+    it 'keeps pure ANSI strings (no chars)' do
+      truncated = described_class.truncate(ansi.red { '' }, length: 10)
+      expect(truncated).to eq "\e[31m\e[0m"
+      expect(truncated.size).to eq 9
+    end
+
+    it 'handles zero-width characters correctly' do
+      src = "A#{("\u200d"*10)}B"
+      truncated  = described_class.truncate(src, length: 3)
+      expect(described_class.display_width(truncated)).to eq(2)
+      expect(truncated).to match "A.*B"
+    end
+
+    it 'preserves newlines in multi-line text' do
+      truncated = described_class.truncate("hello\nworld", length: 8)
+      expect(truncated).to include("\n")
+      expect(described_class.display_width(truncated)).to eq 8
+    end
+
+    it 'supports multi‑cell ellipsis' do
+      truncated  = described_class.truncate('ABC' + ?😇 * 10, length: 8, ellipsis: '… (more)')
+      expect(truncated).to eq "… (more)"
+      expect(described_class.display_width(truncated)).to eq 8
+      expect(truncated.length).to eq 8
+    end
+
+    it 'appends reset if truncated after an escape that lacks reset' do
+      truncated = described_class.truncate(ansi.red { 'Hello' }, length: 4)
+      expect(truncated).to eq "\e[31mHel…\e[0m"
+      expect(described_class.remove_ansi_escapes(truncated).size).to eq 4
+    end
+
+    it 'appends single reset for nested styles when truncated' do
+      truncated = described_class.truncate(ansi.red { ansi.bold { 'Hi' } }, length: 2)
+      expect(truncated).to eq "\e[31m\e[1mH…\e[0m"
+      expect(described_class.display_width(truncated)).to eq 2
+    end
+
+    it 'omits escapes that fall after the truncation point' do
+      src = "#{ansi.red { 'A' }}B#{ansi.green { 'C' }}D"
+      truncated = described_class.truncate(src, length: 2)
+      expect(truncated).not_to include "\e[32m"
+      expect(truncated).to eq "\e[31mA…\e[0m"
+      expect(described_class.display_width(truncated)).to eq 2
+    end
   end
 end