kramdown-ansi 0.4.1 → 0.6.0

data/spec/kramdown/ansi/width_spec.rb

@@ -1,6 +1,8 @@
-require 'spec_helper'
-
 describe Kramdown::ANSI::Width do
+  let :ansi do
+    Term::ANSIColor
+  end
+
   before do
     allow(Tins::Terminal).to receive(:columns).and_return 80
   end
@@ -60,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
@@ -78,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

data/spec/kramdown/ansi_golden_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'Kramdown::ANSI golden files' do
+  before do
+    allow(Tins::Terminal).to receive(:columns).and_return 80
+  end
+
+  Dir[File.join(__dir__, '../assets/*.md')].each do |md|
+    name = File.basename(md, '.md')
+    expected_path = md.sub('.md', '.ansi')
+
+    it "renders #{name} matching golden file" do
+      skip "no golden file at #{expected_path}" unless File.exist?(expected_path)
+      expected = File.read(expected_path)
+      actual   = Kramdown::ANSI.parse(File.read(md))
+      expect(actual).to eq(expected)
+    end
+  end
+end

data/spec/kramdown/ansi_spec.rb

@@ -1,7 +1,8 @@
-require 'spec_helper'
-require 'pathname'
-
 describe Kramdown::ANSI do
+  before do
+    allow(Tins::Terminal).to receive(:columns).and_return 80
+  end
+
   let :source  do
     File.read(Pathname.new(__dir__) + '..' + '..' + 'README.md')
   end
@@ -11,9 +12,9 @@ describe Kramdown::ANSI do
       ansi = described_class.parse(source)
       expect(ansi).to include("\e[1m\e[4mDescription\e[0m\e[0m")
       expect(ansi).to include("\e[1mKramdown::ANSI\e[0m")
-      expect(ansi).to include("\e[3min the terminal\e[0m")
       expect(ansi).to include("\e[34mgem install kramdown-ansi\n\e[0m")
       expect(ansi).to include("\e[34mbundle install\e[0m")
+      expect(ansi).to include("Dialog:\n “\e[2mWhat's that, Fluffy?\n  ‘That's my new friend.’\e[0m”")
       expect(ansi).to include("This is the end.")
       output.puts ansi
     end
@@ -26,14 +27,15 @@ describe Kramdown::ANSI do
         strong: %i[ green ],
         em:     %i[ yellow ],
         code:   %i[ bold color208 ],
+        blockquote: %i[ magenta ],
       )
       ansi = described_class.parse(source, ansi_styles:)
       expect(ansi).to include("\e[31m\e[4mDescription\e[0m\e[0")
       expect(ansi).to include("\e[32mKramdown::ANSI\e[0m")
-      expect(ansi).to include("\e[33min the terminal\e[0m")
       expect(ansi).to include("\e[1m\e[38;5;208mgem install kramdown-ansi\n\e[0m\e[0m")
-      expect(ansi).to include("\e[1m\e[38;5;208mbundle install\e[0m\e[0m")
+      expect(ansi).to include("Dialog:\n “\e[35mWhat's that, Fluffy?\n  ‘That's my new friend.’\e[0m”")
       expect(ansi).to include("This is the end.")
+      output.puts ansi
     end
   end
 end

data/spec/kramdown/ansi_table_spec.rb

@@ -0,0 +1,51 @@
+describe 'Kramdown::ANSI table' do
+  before do
+    allow(Tins::Terminal).to receive(:columns).and_return 80
+  end
+
+  lorem_cell = -> seed do
+    LoremIpsum.generate(paragraphs: 1, words_per_sentence: 5, seed:).strip
+  end
+
+  ansi_lorem_cell = -> seed do
+    lorem_cell.(seed).gsub(/\S+/) { |word|
+      Term::ANSIColor.send(%i[ bold italic color208 color248 ].sample) { word }
+    }
+  end
+
+  let(:no_ansi_markdown) do
+    <<~EOT
+      | Header 1 | Header 2 | Header 3 |
+      |----------|----------|----------|
+      | #{lorem_cell.(23)} | #{lorem_cell.(42)} | #{lorem_cell.(25)} |
+    EOT
+  end
+
+  let(:ansi_markdown) do
+    <<~EOT
+      | Header 1 | Header 2 | Header 3 |
+      |----------|----------|----------|
+      | #{ansi_lorem_cell.(23)} | #{ansi_lorem_cell.(42)} | #{ansi_lorem_cell.(25)} |
+    EOT
+  end
+
+  it 'renders a table w/o ANSI styling and correct borders' do
+    no_ansi = Kramdown::ANSI.parse(no_ansi_markdown)
+    # The table should contain the table separator character
+    expect(no_ansi).to match(/─/)
+    # The generated LoremIpsum text should appear in the output
+    expect(no_ansi).to include(lorem_cell.(23)[0, 10])
+    # No raw markdown markers should remain
+    expect(no_ansi).not_to include('|')
+  end
+
+  it 'renders a table with ANSI styling and correct borders' do
+    ansi = Kramdown::ANSI.parse(ansi_markdown)
+    # The table should contain the table separator character
+    expect(ansi).to match(/─/)
+    # The generated LoremIpsum text should appear in the output
+    expect(ansi).to include(lorem_cell.(23)[0, 10])
+    # No raw markdown markers should remain
+    expect(ansi).not_to include('|')
+  end
+end

data/spec/kramdown/render_spec.rb

@@ -0,0 +1,156 @@
+require 'spec_helper'
+
+describe 'Kramdown::ANSI rendering' do
+  before do
+    allow(Tins::Terminal).to receive(:columns).and_return 80
+  end
+
+  subject(:render) { Kramdown::ANSI.parse(md) }
+
+  describe 'headers' do
+    context 'level 1' do
+      let(:md) { "# Hello\n" }
+      it 'applies bold+underline' do
+        expect(render).to eq "\e[1m\e[4mHello\e[0m\e[0m\n"
+      end
+    end
+
+    context 'level 2' do
+      let(:md) { "## World\n" }
+      it 'applies bold+underline' do
+        expect(render).to eq "\e[1m\e[4mWorld\e[0m\e[0m\n"
+      end
+    end
+
+    context 'level 3' do
+      let(:md) { "### Deep\n" }
+      it 'applies bold+underline' do
+        expect(render).to eq "\e[1m\e[4mDeep\e[0m\e[0m\n"
+      end
+    end
+  end
+
+  describe 'inline emphasis' do
+    context 'strong' do
+      let(:md) { "This is **bold** text.\n" }
+      it 'wraps in bold' do
+        expect(render).to eq "This is \e[1mbold\e[0m text.\n"
+      end
+    end
+
+    context 'emphasis' do
+      let(:md) { "This is *italic* text.\n" }
+      it 'wraps in italic' do
+        expect(render).to eq "This is \e[3mitalic\e[0m text.\n"
+      end
+    end
+
+    context 'strikethrough' do
+      let(:md) { "This is ~~gone~~ text.\n" }
+      it 'wraps in strikethrough' do
+        expect(render).to eq "This is \e[9mgone\e[0m text.\n"
+      end
+    end
+
+    context 'code span' do
+      let(:md) { "Use `puts` here.\n" }
+      it 'wraps in blue' do
+        expect(render).to eq "Use \e[34mputs\e[0m here.\n"
+      end
+    end
+
+    context 'mixed inline' do
+      let(:md) { "A **bold** and *em* and `code` word.\n" }
+      it 'applies each style independently' do
+        expect(render).to eq(
+          "A \e[1mbold\e[0m and \e[3mem\e[0m and \e[34mcode\e[0m word.\n"
+        )
+      end
+    end
+  end
+
+  describe 'code blocks' do
+    context 'fenced with language' do
+      let(:md) { "```ruby\nputs \"hi\"\n```\n" }
+      it 'applies code style to content' do
+        expect(render).to eq "\e[34mputs \"hi\"\n\e[0m"
+      end
+    end
+
+    context 'fenced without language' do
+      let(:md) { "```\nplain code\n```\n" }
+      it 'applies code style to content' do
+        expect(render).to eq "\e[34mplain code\n\e[0m"
+      end
+    end
+  end
+
+  describe 'blockquotes' do
+    context 'single level' do
+      let(:md) { "> quoted line\n" }
+      it 'wraps in faint + double quotes' do
+        expect(render).to eq " “\e[2mquoted line\e[0m”\n"
+      end
+    end
+
+    context 'nested' do
+      let(:md) { "> > nested\n" }
+      it 'cycles to single quotes for inner level' do
+        expect(render).to eq " “\e[2m‘nested’\e[0m”\n"
+      end
+    end
+  end
+
+  describe 'horizontal rule' do
+    let(:md) { "---\n" }
+    it 'renders full-width unicode line' do
+      expect(render).to eq((?─ * 80) + "\n")
+    end
+  end
+
+  describe 'lists' do
+    context 'unordered' do
+      let(:md) { "- one\n- two\n" }
+      it 'prefixes with bullet' do
+        expect(render).to eq "· one\n\n· two\n\n"
+      end
+    end
+
+    context 'ordered' do
+      let(:md) { "1. first\n2. second\n" }
+      it 'prefixes with sequential numbers' do
+        expect(render).to eq "1. first\n\n2. second\n\n"
+      end
+    end
+
+    context 'nested unordered' do
+      let(:md) { "- one\n  - sub\n- two\n" }
+      it 'indents nested items by 2 spaces' do
+        expect(render).to eq "· one\n\n  · sub\n  \n\n· two\n\n"
+      end
+    end
+  end
+
+  describe 'links' do
+    let(:md) { "[click](https://example.com)\n" }
+    it 'emits OSC 8 hyperlink' do
+      expect(render).to eq "\e]8;;https://example.com\e\\click\e]8;;\e\\\n"
+    end
+  end
+
+  describe 'images' do
+    let(:md) { "![kitten](kitten.jpg)\n" }
+    it 'prepends emoji and emits OSC 8 hyperlink' do
+      expect(render).to eq "\e]8;;kitten.jpg\e\\🖼 kitten\e]8;;\e\\\n"
+    end
+  end
+
+  describe 'paragraph' do
+    context 'plain text' do
+      let(:md) { "Just a paragraph.\n" }
+      it 'outputs verbatim with trailing newline' do
+        expect(render).to eq "Just a paragraph.\n"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,6 +7,102 @@ rescue LoadError
 end
 require 'kramdown/ansi'
 
+# A lightweight Lorem Ipsum generator.
+#
+# The generator uses a small pool of classic Latin words and
+# randomly assembles them into sentences and paragraphs.
+class LoremIpsum
+  # Generates Lorem Ipsum text with the specified number of paragraphs and
+  # average words per sentence.
+  #
+  # @param paragraphs [Integer] the number of paragraphs to generate (default: 3)
+  # @param words_per_sentence [Integer] the average number of words per
+  #   sentence (default: 10)
+  # @return [String] the generated Lorem Ipsum text
+  def self.generate(paragraphs: 3, words_per_sentence: 10, seed: nil)
+    new.generate(paragraphs:, words_per_sentence:, seed:)
+  end
+
+  # Default word pool (classic Lorem Ipsum source)
+  WORDS = %w[
+    lorem ipsum dolor sit amet consectetur adipiscing elit sed do
+    eiusmod tempor incididunt ut labore et dolore magna aliqua
+    enim ad minim veniam quis nostrud exercitation ullamco
+    laboris nisi ut aliquip ex ea commodo consequat duis aute
+    irure dolor in reprehenderit in voluptate velit esse
+    cillum dolore eu fugiat nulla pariatur
+    excepteur sint occaecat cupidatat non proident sunt
+    culpa qui officia deserunt mollit anim id est laborum
+  ].freeze
+
+  # Generate a random word from the pool
+  def random_word
+    WORDS.sample random: @random
+  end
+
+  # Generate a sentence of a given length (in words)
+  # @param words [Integer] number of words in the sentence
+  # @return [String] a sentence ending with a period
+  def sentence(words: 8)
+    words.times.map { random_word }.join(' ').capitalize + '.'
+  end
+
+  # Generate a paragraph of a given number of sentences
+  # @param sentences [Integer] number of sentences in the paragraph
+  # @return [String] a paragraph ending with a newline
+  def paragraph(sentences: 4)
+    sentences.times.map { sentence }.join(' ') + "\n"
+  end
+
+  # Generate a full Lorem Ipsum text
+  #
+  # @param paragraphs [Integer] number of paragraphs
+  # @param words_per_sentence [Integer] average words per sentence
+  # @return [String] the generated text
+  def generate(paragraphs: 3, words_per_sentence: 10, seed: nil)
+    @random = seed ? Random.new(seed) : Random.new
+    paragraphs.times.map do
+      # For a bit of natural variation, pick a random number
+      # of sentences around the requested average.
+      sentences = @random.rand(words_per_sentence / 2..words_per_sentence * 2)
+      paragraph(sentences: sentences)
+    end.join("\n")
+  end
+end
+
 def asset(name)
   File.join(__dir__, 'assets', name)
 end
+
+# A module that provides functionality for protecting environment variables
+# during tests.
+#
+# This module ensures that environment variable changes made during test
+# execution are automatically restored to their original values after the test
+# completes. It is designed to prevent side effects between tests that modify
+# environment variables, maintaining a clean testing environment.
+module ProtectEnvVars
+  # The apply method creates a lambda that protects environment variables
+  # during test execution.
+  #
+  # @return [Proc] a lambda that wraps test execution with environment variable
+  #   preservation
+  def self.apply
+    -> example do
+      if example.metadata[:protect_env]
+        begin
+          stored_env = ENV.to_h
+          example.run
+        ensure
+          ENV.replace(stored_env)
+        end
+      else
+        example.run
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.around(&ProtectEnvVars.apply)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-ansi
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.17.0
+        version: 2.20.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.17.0
+        version: 2.20.1
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -113,14 +113,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.61'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.61'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +149,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: unicode-display_width
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: |
   Kramdown::ANSI: A library for rendering Markdown(ish) documents with
   beautiful ANSI escape sequences in the terminal.
@@ -151,6 +179,7 @@ extra_rdoc_files:
 - lib/kramdown/ansi/width.rb
 - lib/kramdown/version.rb
 files:
+- ".utilsrc"
 - CHANGES.md
 - Gemfile
 - LICENSE
@@ -167,12 +196,20 @@ files:
 - lib/kramdown/ansi/width.rb
 - lib/kramdown/version.rb
 - spec/assets/README.ansi
+- spec/assets/html.ansi
+- spec/assets/html.md
 - spec/assets/kitten.jpg
+- spec/assets/tables.ansi
+- spec/assets/tables.md
 - spec/kramdown/ansi/pager_spec.rb
 - spec/kramdown/ansi/styles_spec.rb
 - spec/kramdown/ansi/width_spec.rb
+- spec/kramdown/ansi_golden_spec.rb
 - spec/kramdown/ansi_spec.rb
+- spec/kramdown/ansi_table_spec.rb
+- spec/kramdown/render_spec.rb
 - spec/spec_helper.rb
+- tmp/.gitkeep
 homepage: https://github.com/flori/kramdown-ansi
 licenses:
 - MIT
@@ -195,12 +232,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.22
 specification_version: 4
 summary: Output markdown in the terminal with ANSI escape sequences
 test_files:
 - spec/kramdown/ansi/pager_spec.rb
 - spec/kramdown/ansi/styles_spec.rb
 - spec/kramdown/ansi/width_spec.rb
+- spec/kramdown/ansi_golden_spec.rb
 - spec/kramdown/ansi_spec.rb
+- spec/kramdown/ansi_table_spec.rb
+- spec/kramdown/render_spec.rb
 - spec/spec_helper.rb