kramdown-ansi 0.5.0 → 0.7.0

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,4 +1,8 @@
 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
@@ -8,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\nterminal\e[0m") # wrap adds linebreak
       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
@@ -23,13 +27,13 @@ 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\nterminal\e[0m") # wrap adds linebreak
       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

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

@@ -73,3 +73,36 @@ 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.5.0
+  version: 0.7.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
@@ -121,6 +121,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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
@@ -181,14 +195,22 @@ files:
 - lib/kramdown/ansi/styles.rb
 - lib/kramdown/ansi/width.rb
 - lib/kramdown/version.rb
+- scripts/capture-ansi
 - 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
@@ -211,13 +233,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+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